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

Migrate entity.create.error audit action to entity.error #1027

Merged
merged 3 commits into from
Oct 17, 2023

Conversation

ktuite
Copy link
Member

@ktuite ktuite commented Oct 13, 2023

Closes getodk/central#520

Migrate entity.create.error to entity.error and add new 404.8 Problem with descriptive error about entity UUID not found. Example:

The entity with UUID (12345678-1234-4123-8234-123456789abc) specified in the submission does not exist in the dataset (people).

What has been done to verify that this works as intended?

Tests, trying it in frontend.

Why is this the best possible solution? Were any other approaches considered?

It makes the most sense to have a generic entity processing error, so all previous entity.create.error error events, which were the only possible processing errors before updates, have been migrated to entity.error.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Makes clearer errors. I don't think there are regression risks.

Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.

Did make a small change the one place this error was mentioned in the documentation.

Before submitting this PR, please make sure you have:

  • run make test-full and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

@ktuite ktuite marked this pull request as ready for review October 16, 2023 23:21
Copy link
Member Author

@ktuite ktuite left a comment

Choose a reason for hiding this comment

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

interactive review

docs/api.yaml Outdated Show resolved Hide resolved
test/integration/worker/entity.js Show resolved Hide resolved
@ktuite ktuite merged commit 430ddba into master Oct 17, 2023
5 checks passed
@ktuite ktuite deleted the ktuite/entity-error branch October 17, 2023 23:12
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.

Entity update submission processing errors get logged as create errors by worker
2 participants