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

Log additional backlog events #1332

Merged
merged 5 commits into from
Dec 7, 2024
Merged

Conversation

ktuite
Copy link
Member

@ktuite ktuite commented Dec 6, 2024

Changed submission.reprocess event to submission.backlog.reprocess and removed the actor ID on that event because it's more of a system thing? Maybe I need that actor ID though and should add it back.

Added

  • submission.backlog.hold for when things to into the backlog
  • submission.backlog.force for when submissions are force-processed from the backlog
  • submission.backlog.reprocess when a submission's processing is triggered by a previous submission in a branch, which isn't quite the same as being "forced"

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

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

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?

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

Before submitting this PR, please make sure you have:

  • run make test 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 force-pushed the ktuite/logMoreEntityBacklogEvents branch from cb66cac to 1fec647 Compare December 6, 2024 00:36
@ktuite ktuite marked this pull request as ready for review December 6, 2024 01:07
@ktuite ktuite requested a review from matthew-white December 6, 2024 01:07
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

lib/model/query/audits.js Outdated Show resolved Hide resolved
lib/model/query/audits.js Outdated Show resolved Hide resolved
Comment on lines +634 to +648
const logBacklogEvent = (action, event, submissionId, submissionDefId) => ({ Audits }) =>
Audits.log({ id: event.actorId }, `submission.backlog.${action}`, { acteeId: event.acteeId }, { submissionId, submissionDefId });
Copy link
Member Author

Choose a reason for hiding this comment

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

Some day we might want to include entityUuid in here, too, but we're not sure what that would look like so we won't do it now.

test/integration/api/audits.js Outdated Show resolved Hide resolved
test/integration/api/offline-entities.js Outdated Show resolved Hide resolved
@ktuite ktuite force-pushed the ktuite/logMoreEntityBacklogEvents branch from 9c2c2e9 to 7bbb155 Compare December 7, 2024 02:30
@ktuite ktuite merged commit db45aef into master Dec 7, 2024
6 checks passed
@ktuite ktuite deleted the ktuite/logMoreEntityBacklogEvents branch December 7, 2024 03:03
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.

2 participants