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.

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

Improve errors reporting in edit modal #4404

Merged
merged 4 commits into from
Jan 24, 2024

Conversation

FidalMathew
Copy link
Contributor

@FidalMathew FidalMathew commented Jan 18, 2024

Summary

Description of the change(s) you made

The approach used to improve error reporting in the edit modal is by getting all the errors list. Mapping that errorsList with their names and reference objects. Using that reference object we'll be using scrollIntoView to allow the user to direct themselves to the required input left blank.

Manual verification steps performed

  1. Click on a channel
  2. Access and edit resources
  3. The Edit details tab will open

Screenshots (if applicable)

image

Does this introduce any tech-debt items?

Some changes that needs to add to the current PR are:

  • Some CSS properties need to be added to the list of errors such as hover cursor, and underlining.
  • The scrollIntoView moves into view a bit below the actual input element.
  • If there is only 1 issue then the scrollIntoView will scroll to that one target element.

Reference

The PR is in reference with issue: #2924


Reviewer guidance

How can a reviewer test these changes?

  1. Click on a channel
  2. Access and edit resources
  3. The Edit details tab will open

Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@FidalMathew
Copy link
Contributor Author

@vkWeb @MisRob Could you take a look at the PR? It has some changes still left to go as mentioned above.

Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Hi @FidalMathew! 👋

This is pretty exciting, we'll finally have more specific error messages in the edit view 🎉. The code overall looks good! I have left you some comments to take into account small details.

@rtibbles rtibbles added this to the Studio: Q1-24 Patch milestone Jan 20, 2024
@FidalMathew
Copy link
Contributor Author

@AlexVelezLl thank you for the review and quick response. I have made the changes, could you review them?

Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Hi! @FidalMathew Thank you! Code looks good to me! And I think the scroll behavior is as expected.

Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

LGTM!

@AlexVelezLl AlexVelezLl merged commit cd70492 into learningequality:unstable Jan 24, 2024
11 checks passed
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants