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

Submissions endpoint stores additional metadata #16727

Closed
3 tasks
jack-h-wang opened this issue Dec 5, 2024 · 1 comment
Closed
3 tasks

Submissions endpoint stores additional metadata #16727

jack-h-wang opened this issue Dec 5, 2024 · 1 comment
Labels
platform Platform Team

Comments

@jack-h-wang
Copy link
Collaborator

jack-h-wang commented Dec 5, 2024

User Story

As a sender onboarded to ReportStream, I want all data associated with my submission to be handled as expected.

Description/Use Case

Senders using the submission endpoint may include optional metadata in their submission, such as a payloadname. The reports/waters API currently populates the receive step with this metadata, and it is possible to look it up at any point in the pipeline by tracing back to the report tied to receive. As of #16409 the convert step will be recognized as the root report for submissions originating from the submissions endpoint, and this metadata will not be present. This metadata needs to be preserved and retrievable in a manner similar to how it is currently handled by the UP receive step.

Risks/Impacts/Considerations

Dev Notes

  • This is largely needed for the sendOriginal feature, which needs to retrieve the submission file as it was received, as well as a payloadname if one was provided by the sender. The original design of the feature is that the translate step retrieves the root report (assuming it will be receive) to obtain this information. If the receive step is no longer the root report, an alternate means of storing this information and for the translate step to retrieve it is needed. See the documentation for this feature.
  • The convert step is not an ideal or logical location for storing this metadata, but it is possible to use it in this manner; the original bodyURL can likely be retrieved from action_params and there is no currently known use for the external_name database column for this step.

Acceptance Criteria

  • Submissions originating from the submissions endpoint have any sender-supplied metadata stored.
  • Confirm sendOriginal is still able to retrieve a sender-supplied payload name when using the submissions endpoint.
  • Confirm sendOriginal is still able to retrieve the original submission blob when using the submissions endpoint.
@jack-h-wang jack-h-wang added the platform Platform Team label Dec 5, 2024
@jack-h-wang
Copy link
Collaborator Author

The work specified in this ticket is completed by #16723.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform Platform Team
Projects
None yet
Development

No branches or pull requests

1 participant