Moodle

Amazon S3 invalid JSON string error could be improved

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 2.2.5, 2.3
  • Fix Version/s: 2.3.4, 2.4.1
  • Component/s: Repositories
  • Labels:
  • Testing Instructions:
    Hide
    1. Go to repositories and enable the Amazon S3 service.
    2. Enter in '1234' for the Access key and Secret Key
    3. Visit a course and click to add a file resource.
    4. Click on 'Add' under 'Select files' to open the file manager
    5. Click on Amazon S3
    6. Make sure a nice error appear instead of a bad JSON error
    7. Try with JS off, and Make sure you get an exception message.
    Show
    Go to repositories and enable the Amazon S3 service. Enter in '1234' for the Access key and Secret Key Visit a course and click to add a file resource. Click on 'Add' under 'Select files' to open the file manager Click on Amazon S3 Make sure a nice error appear instead of a bad JSON error Try with JS off, and Make sure you get an exception message.
  • Affected Branches:
    MOODLE_22_STABLE, MOODLE_23_STABLE
  • Fixed Branches:
    MOODLE_23_STABLE, MOODLE_24_STABLE
  • Pull from Repository:
  • Pull 2.4 Branch:
  • Pull 2.4 Diff URL:
  • Pull Master Branch:
    MDL-36456-master
  • Pull Master Diff URL:

Description

  1. Go to repositories and enable the Amazon S3 service.
  2. Enter in '1234' for the Access key and Secret Key
  3. Visit a course and click to add a file resource.
  4. Click on 'Add' under 'Select files' to open the file manager
  5. Click on Amazon S3

Expected result: You should see a friendly message like "Could not connect with current setup information"

Actual result: You get an invalid JSON string error

Issue Links

discovered while testing

Sub-task - Issues are sometimes broken into multiple sub-tasks. MDL-34572 Add label for select and text input elements in repository

  • Minor - Minor loss of function where workaround is possible
  • Closed - The issue is considered finished, the resolution is correct. Issues which are closed should not be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Frédéric Massart added a comment -

This is error handling related, each repository should handle them better. We might have to create a meta issue for that purpose. Most repositories will badly fail if the access keys are wrong.

Show
Frédéric Massart added a comment - This is error handling related, each repository should handle them better. We might have to create a meta issue for that purpose. Most repositories will badly fail if the access keys are wrong.
Hide
Permalink
Mark Nelson added a comment -

Hi Michael, I don't think it should be could be improved, but rather should be.

The error is as follows:

Invalid JSON string

Warning: S3::listBuckets(): [InvalidAccessKeyId] The AWS Access Key Id you provided does not exist in our records. in /var/www/mstorage/im/moodle/repository/s3/S3.php on line 222

Warning: Invalid argument supplied for foreach() in /var/www/mstorage/im/moodle/repository/s3/lib.php on line 101
{"list":[],"path":[

{"name":"Amazon S3","path":"","icon":"http:\/\/localhost\/im\/theme\/image.php\/standard\/core\/1352436185\/f\/folder-24"}

],"manage":false,"dynload":true,"nologin":true,"nosearch":true,"repo_id":12}

Show
Mark Nelson added a comment - Hi Michael, I don't think it should be could be improved, but rather should be. The error is as follows: Invalid JSON string Warning: S3::listBuckets(): [InvalidAccessKeyId] The AWS Access Key Id you provided does not exist in our records. in /var/www/mstorage/im/moodle/repository/s3/S3.php on line 222 Warning: Invalid argument supplied for foreach() in /var/www/mstorage/im/moodle/repository/s3/lib.php on line 101 {"list":[],"path":[ {"name":"Amazon S3","path":"","icon":"http:\/\/localhost\/im\/theme\/image.php\/standard\/core\/1352436185\/f\/folder-24"} ],"manage":false,"dynload":true,"nologin":true,"nosearch":true,"repo_id":12}
Hide
Permalink
Mark Nelson added a comment -

There is also a disruptive pop-up. It is not a valid error message to show a user, so it's not like we could improve it by simply wording it better. It needs to be handled correctly.

Show
Mark Nelson added a comment - There is also a disruptive pop-up. It is not a valid error message to show a user, so it's not like we could improve it by simply wording it better. It needs to be handled correctly.
Hide
Permalink
Frédéric Massart added a comment -

No drama Mark, I will work on that

Show
Frédéric Massart added a comment - No drama Mark, I will work on that
Hide
Permalink
Frédéric Massart added a comment - - edited

I have created a new generic string which can tell the user that there was a problem while communicating with the plugin. Unfortunately we cannot identify the real problem during the communication with S3, or it would require some logic which might be a bit too much just to display a nice error.

Another option would have been to display the exception from S3, which tells us that the information provided to login are incorrect, that way there is no need to create a new lang string, but I was not convinced that this would be nice enough for the user.

Also I changed the die(json_encode()) because now the repositories handle exception properly.

Show
Frédéric Massart added a comment - - edited I have created a new generic string which can tell the user that there was a problem while communicating with the plugin. Unfortunately we cannot identify the real problem during the communication with S3, or it would require some logic which might be a bit too much just to display a nice error. Another option would have been to display the exception from S3, which tells us that the information provided to login are incorrect, that way there is no need to create a new lang string, but I was not convinced that this would be nice enough for the user. Also I changed the die(json_encode()) because now the repositories handle exception properly.
Hide
Permalink
Mark Nelson added a comment -

Looks great to me. Submitting for integration.

Show
Mark Nelson added a comment - Looks great to me. Submitting for integration.
Hide
Permalink
Dan Poltawski added a comment -

Integrated to master 24 and 23, thanks Fred.

Show
Dan Poltawski added a comment - Integrated to master 24 and 23, thanks Fred.
Hide
Permalink
David Monllaó added a comment -

It passes, tested in 23 and master

Show
David Monllaó added a comment - It passes, tested in 23 and master
Hide
Permalink
Eloy Lafuente (stronk7) added a comment -

And your fantastic code has met core, hope they become good friends for a long period.

Closing, thanks!

Show
Eloy Lafuente (stronk7) added a comment - And your fantastic code has met core, hope they become good friends for a long period. Closing, thanks!

People

Vote (0)
Watch (3)

Dates

  • Created:
    Updated:
    Resolved: