feat: prepare AWS S3 upload for avatars #1747
Conversation
There was a problem hiding this comment.
SonarQube analysis found issues:
Including the following issue(s) which could not be reported in line:
Code Smell: Refactor this function to reduce its Cognitive Complexity from 16 to the 15 allowed. (more)
app/Console/Commands/MoveAvatars.php
Outdated
| use Illuminate\Console\Command; | ||
| use Illuminate\Console\ConfirmableTrait; | ||
|
|
||
| class MoveAvatars extends Command |
There was a problem hiding this comment.
This is something that should be done only once, right? Maybe we could indicate it in the description.
There was a problem hiding this comment.
As you know, the location of an avatar is stored in Contact -> avatar_location property. The MoveAvatars command aims to move avatars (contacts with has_avatar to true) from current location to the - possibly different - default driver, as config('filesystems.default'). This way, you can run the commands multiple times: if the current location of the avatar is the default one, it's not touched.
There was a problem hiding this comment.
But will we have to run the commands multiple times?
There was a problem hiding this comment.
We will have to run the command one time for this migration, but it could be run multiple times, every time you update the default filesystem store.
app/Console/Commands/MoveAvatars.php
Outdated
| $filename = pathinfo($contact->avatar_file_name, PATHINFO_FILENAME); | ||
| $extension = pathinfo($contact->avatar_file_name, PATHINFO_EXTENSION); | ||
|
|
||
| $avatar_file_name = 'avatars/'.$filename.'.'.$extension; |
There was a problem hiding this comment.
$avatar_file_name -> $avatarFileName for PRS4 compliance.
app/Console/Kernel.php
Outdated
| @@ -19,6 +19,7 @@ class Kernel extends ConsoleKernel | |||
| 'App\Console\Commands\ImportCSV', | |||
| 'App\Console\Commands\ImportVCards', | |||
| 'App\Console\Commands\LangGenerate', | |||
| 'App\Console\Commands\MoveAvatars', | |||
There was a problem hiding this comment.
Perhaps we could put the commands that should only be done once if a proper folder, like Commands\OneTime or something.
app/Models/Contact/Contact.php
Outdated
| @@ -937,14 +938,50 @@ public function getAvatarURL($size = 110) | |||
| return $this->avatar_external_url; | |||
| } | |||
|
|
|||
| $original_avatar_url = Storage::disk($this->avatar_location)->url($this->avatar_file_name); | |||
| $original_avatar_url = $this->avatar_file_name; | |||
app/Models/Contact/Contact.php
Outdated
| /** | ||
| * Delete avatars files. | ||
| */ | ||
| public function deleteAvatars() |
There was a problem hiding this comment.
I don't understand why we need to create a function in Contact object just for this, especially if this process will only happen once for this migration. Is it really useful? Can we move this function elsewhere ?
There was a problem hiding this comment.
When a contact already has an avatar (not gravatar), if you update the image, today the old image stays in the store forever. I'm not sure it's a voluntary behavior. I've created this function to remove the old image, but we can imagine an other behavior...
There was a problem hiding this comment.
And today a user can flood us by uploading as much as images he can, and they will stay in the store...
There was a problem hiding this comment.
This is true. Thanks for the explanation.
I wonder if we should create a service for this method instead, like what I've been started to do here: https://github.com/monicahq/monica/pull/1629/files#diff-b3c40f0913df027e06af970085f889ed
The idea: have a class called, for instance, deleteAvatarForContact. This is explained here.
What do you think?
There was a problem hiding this comment.
After a bit reflexion: this does not apply here, even I think Services are great, but it's used for Controller, to handle request the same way for htpp and api. In this case, I already have the $contact object, and I just pass it to the Service: there is no interest.
|
👍 |
|
This pull request has been automatically locked since there |
Fix the feature of upload files to AWS S3 for avatars.
This is linked to #1742