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

chore: enable hashing by default for amazon audience #1761

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

utsabc
Copy link
Member

@utsabc utsabc commented Oct 23, 2024

What are the changes introduced in this PR?

Enabling the hasing option by default for amazon audience destiantion

What is the related Linear task?

Resolves INT-XXX

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new checks got introduced or modified in test suites. Please explain the changes.

N/A


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • I have executed schemaGenerator tests and updated schema if needed

  • Are sensitive fields marked as secret in definition config?

  • My test cases and placeholders use only masked/sample values for sensitive fields

  • Is the PR limited to 10 file changes & one task?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

  • New Features

    • Updated the default setting for user data hashing to enabled for Amazon Audience configuration.
  • Bug Fixes

    • No bug fixes were introduced in this release.

Copy link

coderabbitai bot commented Oct 23, 2024

Walkthrough

The changes involve an update to the ui-config.json file for the Amazon Audience destination configuration. The key modification is the alteration of the default value for the enableHash setting from false to true. This adjustment affects how user data is hashed prior to transmission to Amazon Audience, while maintaining the overall structure and integrity of the existing configuration settings.

Changes

File Path Change Summary
src/configurations/destinations/amazon_audience/ui-config.json Updated enableHash default value from false to true.

Possibly related PRs

Suggested reviewers

  • lvrach
  • am6010
  • AchuthaSourabhC
  • ssbeefeater
  • debanjan97
  • cisse21
  • ruchiramoitra
  • 1abhishekpandey
  • ItsSudip
  • sandeepdsvs
  • shrouti1507

🐰 In the forest, where data flows,
A change was made that surely shows.
Hashing now is set to true,
For Amazon's audience, fresh and new.
With every byte, a secret kept,
In the rabbit's burrow, the data's adept! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9e2d536 and 040d368.

📒 Files selected for processing (1)
  • src/configurations/destinations/amazon_audience/ui-config.json (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
src/configurations/destinations/amazon_audience/ui-config.json (1)

84-84: LGTM! Enabling hashing by default improves security.

This change aligns with security best practices by ensuring user data is hashed by default before being sent to Amazon Audience. The existing note properly warns users about potential double hashing if they already pass hashed data.

Let's verify this aligns with other Amazon destinations:

✅ Verification successful

Let me try a different approach to verify the hashing configurations across Amazon destinations.

This should help us find and examine all Amazon-related UI configuration files and their hashing settings.


Let me check if there are other Amazon-related destinations to ensure we have a complete picture.


Based on the verification results, I can now provide the final response:

Enabling hashing by default for Amazon Audience is appropriate and self-contained

The verification confirms that:

  • Amazon Audience is the only Amazon destination that implements hashing functionality
  • The change is properly documented in the UI config with clear warnings about double hashing
  • The feature is consistently referenced across related files (ui-config.json, schema.json, and db-config.json)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if other Amazon destinations have similar hashing configurations
# and verify if they also default to true for consistency

rg -U --json "enableHash.*default.*(?:true|false)" | jq -r 'select(.data.lines.text | contains("enableHash")) | .data.path'

Length of output: 227


Script:

#!/bin/bash
# Search for all JSON files under amazon destinations
fd -e json -p 'amazon.*ui-config.json$'

# Then let's examine their content
fd -e json -p 'amazon.*ui-config.json$' -x cat {} \; | grep -A 5 -B 5 "enableHash"

Length of output: 644


Script:

#!/bin/bash
# List all Amazon-related destination directories
fd -t d 'amazon' src/configurations/destinations/

# Then let's look for any other hashing-related configurations in these directories
fd -t d 'amazon' src/configurations/destinations/ -x rg -i 'hash' {} \;

Length of output: 883


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9e2d536) to head (040d368).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1761   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           53        53           
  Branches         7         7           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@utsabc utsabc merged commit 70b81c3 into develop Oct 23, 2024
12 checks passed
@utsabc utsabc deleted the chore.update-hashing-to-default-amazon-audience branch October 23, 2024 08:22
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