Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add proper message to created share not found #26688

Merged
merged 2 commits into from
Oct 13, 2021
Merged

Add proper message to created share not found #26688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18f8fab
Add proper message to created share not found
skjnldsv Apr 22, 2021
e3fa686
Default message for ShareNotFound exception
skjnldsv Apr 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/private/Share20/DefaultShareProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ public function create(\OCP\Share\IShare $share) {
$cursor->closeCursor();

if ($data === false) {
throw new ShareNotFound();
throw new ShareNotFound('Newly created share could not be found');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this returned to the end user? Or is this just for the logs? I'm asking because of the potential need to translate this.

This comment was marked as resolved.

Sign in to view

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah no, this is actually read for the end user too.
But this is technical, if we reach this error the admin must know

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmmmh ... but even then it should either be "there was an error - reach out to the admin" or a localized error message if the user can do something.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But yeah - it was untranslated before. So I will not block this because of the refined message. But we should look into this, because it is a HintException which will show the hint to the end user and print the message to the logs. (if no hint provided it uses the message)

So maybe we could add a generic and translated "Something broke" as hint and give this detailed message as internal message.

}

$mailSendValue = $share->getMailSend();
Expand Down
14 changes: 14 additions & 0 deletions lib/public/Share/Exceptions/ShareNotFound.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,18 @@
* @since 9.0.0
*/
class ShareNotFound extends GenericShareException {

/**
* @param string $message
* @param string $hint
* @param int $code
* @param \Exception|null $previous
* @since 9.0.0
*/
public function __construct($message = '', ...$arguments) {
if (empty($message)) {
$message = 'Share not found';
}
parent::__construct($message, ...$arguments);
}
}