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

FMWK-312 Cleanup for configuration and documentation #691

Merged
merged 2 commits into from
Jan 23, 2024

Conversation

agrgr
Copy link

@agrgr agrgr commented Jan 23, 2024

  • Align sendKey fields in ClientPolicy configuration
  • Cleanup for documentation and tests

@agrgr agrgr requested review from roimenashe and reugn January 23, 2024 10:46
Copy link
Member

@roimenashe roimenashe left a comment

Choose a reason for hiding this comment

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

Looks good, just curious about changing the default sendKey for few more policies:

...
clientPolicy.batchWritePolicyDefault.sendKey = sendKey;
clientPolicy.queryPolicyDefault.sendKey = sendKey;
clientPolicy.scanPolicyDefault.sendKey = sendKey;

Did that introduced any problems with the existing tests? does it consider a breaking change? default behavior of sendKey changed, can it affect an existing user when upgrading?

Edit: @agrgr didn't notice that its a draft PR, ping me when its ready for a review and I'll have another look

@agrgr
Copy link
Author

agrgr commented Jan 23, 2024

Did that introduced any problems with the existing tests? does it consider a breaking change? default behavior of sendKey changed, can it affect an existing user when upgrading?

The tests are ok. We agreed to move forward with this change because sendKey has already been true by default, so decided to align it for all default policies. What it does is bringing the primary key along with other bins in results.

@agrgr agrgr marked this pull request as ready for review January 23, 2024 11:24
@agrgr agrgr merged commit 1f555ba into main Jan 23, 2024
10 checks passed
@agrgr agrgr deleted the FMWK-312-cleanup-documentation-and-config branch January 23, 2024 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants