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

As a node operator, I want actionable, user-friendly error messages for registry schema failures #110

Closed
tloubrieu-jpl opened this issue Mar 12, 2021 · 3 comments
Assignees
Labels
p.must-have requirement the current issue is a requirement

Comments

@tloubrieu-jpl
Copy link
Member

tloubrieu-jpl commented Mar 12, 2021

We can think of 2 steps in the development:

  1. improve error message, e.g. describing where to download and the command line to launch to update the schema
  2. prepare a repository/database of the LDDs and "automate" the download and update of the schema.

Acceptance criteria

When LDD schema required is when metadata is loaded with registry-mgr but not available in the registry (e.g. metadata using orex namespace).
Then: the error message contains a pointer to the online documentation which helps to solve the error

@tloubrieu-jpl tloubrieu-jpl added enhancement New feature or request requirement the current issue is a requirement labels Mar 12, 2021
@tloubrieu-jpl
Copy link
Member Author

@tdddblog @jordanpadams For step 1 I just had an example of user friendly message for pyproj library:

lon, lat = pyproj.transform(fromproj, toproj, x, y)
<input>:1: DeprecationWarning: This function is deprecated. See: https://pyproj4.github.io/pyproj/stable/gotchas.html#upgrading-to-pyproj-2-from-pyproj-1

We could have a link to our mvn site published on github, to the specific page, section which details how to add a new LDD.

@jordanpadams jordanpadams changed the title As a user, I don't want to have difficulties to update the registry schema when I load new data As a node operator, I want actionable, user-friendly error messages for schema update requests Mar 27, 2021
@jordanpadams jordanpadams changed the title As a node operator, I want actionable, user-friendly error messages for schema update requests As a node operator, I want actionable, user-friendly error messages for registry schema failures Mar 27, 2021
@jordanpadams jordanpadams added p.must-have and removed enhancement New feature or request needs:triage labels Mar 27, 2021
@jordanpadams
Copy link
Member

already within past merged PR

@jordanpadams
Copy link
Member

updated error message:

Updating schema with fields from C:\tmp\harvest\out\fields.txt
[ERROR] Could not find datatype for field 'abcd123'.
See 'https://nasa-pds.github.io/pds-registry-app/operate/common-ops.html#Load' for more information.

@jordanpadams jordanpadams transferred this issue from nasa-pds-engineering-node/pds-registry-app Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p.must-have requirement the current issue is a requirement
Projects
None yet
Development

No branches or pull requests

3 participants