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

Rename reportId variables #1601

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Rename reportId variables #1601

wants to merge 11 commits into from

Conversation

pluckyswan
Copy link
Contributor

@pluckyswan pluckyswan commented Nov 20, 2024

Description

Rename variables, like (sent/received)SubmissionId and (sent/received)MessageId to be (inbound/outbound)ReportId, and any related functions. The naming, inbound and outbound, is from the perspective of TI. The id that we were receiving from ReportStream is now the inbound id while the id we were sending to ReportStream is now the outbound id.

Issue

#1404

Checklist

  • I have added tests to cover my changes
  • I have added logging where useful (with appropriate log level)
  • I have added JavaDocs where required
  • I have updated the documentation accordingly

Note: You may remove items that are not applicable

Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Consistency Check
Ensure that the renaming of variables from 'receivedSubmissionId' to 'inboundReportId' maintains consistency across all related methods and classes, especially where method signatures and return types might be affected.

Copy link

PR Code Suggestions ✨

No code suggestions found for the PR.

Copy link
Contributor

@basiliskus basiliskus left a comment

Choose a reason for hiding this comment

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

I reviewed a few of the changes and added a couple of comments. I'll continue reviewing later

Copy link
Contributor

@basiliskus basiliskus left a comment

Choose a reason for hiding this comment

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

Left one comment. Otherwise looking great!

@pluckyswan
Copy link
Contributor Author

Left one comment. Otherwise looking great!

Did we want to change recordId to reportId? Or is that a different card?

@basiliskus
Copy link
Contributor

Did we want to change recordId to reportId? Or is that a different card?

That would be a different card. It involves changes in RS, so we need to coordinate to make those changes in TI and RS at the same time

Copy link
Member

@halprin halprin left a comment

Choose a reason for hiding this comment

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

Wow, this is great work. If you're going keep the modifications in DatabasePartnerMetadataStorage.java, then you'll need to also add a database migration in this PR, so that everything works when this PR is merged.

Copy link

sonarcloud bot commented Nov 22, 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.

3 participants