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

feat: add record event support for redis destination #3124

Closed
wants to merge 5 commits into from

Conversation

yashasvibajpai
Copy link
Contributor

What are the changes introduced in this PR?

Add record event support for redis destination

What is the related Linear task?

Resolves INT-978

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 generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review


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?

  • Is the PR limited to 10 file changes?

  • Is the PR limited to one linear task?

  • Are relevant unit and component test-cases added?

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.

@yashasvibajpai yashasvibajpai self-assigned this Feb 25, 2024
Copy link
Contributor

coderabbitai bot commented Feb 25, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@devops-github-rudderstack
Copy link
Contributor

Copy link

codecov bot commented Feb 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.90%. Comparing base (28752cb) to head (02ab0e1).
Report is 114 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3124      +/-   ##
===========================================
+ Coverage    84.51%   84.90%   +0.39%     
===========================================
  Files          493      496       +3     
  Lines        27301    27384      +83     
  Branches      6569     6591      +22     
===========================================
+ Hits         23073    23250     +177     
+ Misses        3771     3681      -90     
+ Partials       457      453       -4     

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

// },
// }

function handleRecordEventsForRedis(message, destination, metadata) {
Copy link
Member

Choose a reason for hiding this comment

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

There is no need to add "Redis" in the name. It's part of the Redis directory, so it's understood.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed

Copy link
Member

Choose a reason for hiding this comment

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

Maybe you haven't pushed the changes to upstream.

@@ -35,7 +36,10 @@ const transformSubEventTypeProfiles = (message, workspaceId, destinationId) => {
// form the hash
const hash = `${workspaceId}:${destinationId}:${message.context.sources.profiles_entity}:${message.context.sources.profiles_id_type}:${message.userId}`;
const key = `${message.context.sources.profiles_model}`;
const value = JSON.stringify(message.traits);
let value = JSON.stringify(message.traits);
Copy link
Member

Choose a reason for hiding this comment

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

We should not JSON stringify traits by default if it is possible to not use them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It was being stringified before also, should I remove the stringification?

Copy link
Member

Choose a reason for hiding this comment

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

The implementation should have looked something like this,

if event type is record {
  // do record specific logic
} else {
  // stringify traits
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right now the flow is
event -

  • if event is a record type event

    • handle insert/delete action related logic
  • if event is having profiles' contextual data

    • it is a profiles-identify event (backward compatible, only insertion supported)
  • for none of the above
    -- it is a standard redis destination's identify event

Copy link
Member

Choose a reason for hiding this comment

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

I don't think you're getting it.

I meant that you should not stringify traits by default. Instead, do it only for non-record type of event flows.

@@ -0,0 +1,45 @@
const { transformSubEventTypeProfiles } = require('./transform');
Copy link
Member

Choose a reason for hiding this comment

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

Do we really need a "v2" file? It doesn't seem like a convention.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed it to a utils.js file name

@yashasvibajpai yashasvibajpai marked this pull request as ready for review February 27, 2024 20:52
@yashasvibajpai yashasvibajpai requested a review from a team as a code owner February 27, 2024 20:52
@yashasvibajpai yashasvibajpai requested review from sivashanmukh and a team as code owners February 28, 2024 18:34
Copy link
Contributor

@koladilip koladilip left a comment

Choose a reason for hiding this comment

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

I am thinking of adding action to all cases and base the rudder-server logic on that

@yashasvibajpai
Copy link
Contributor Author

I am thinking of adding action to all cases and base the rudder-server logic on that
@koladilip
But if we mandate action in all events by default, in case of non-profiles standard identify events, older implementation of using HMSET to replace the whole hash would become redundant

@koladilip
Copy link
Contributor

I am thinking of adding action to all cases and base the rudder-server logic on that
@koladilip
But if we mandate action in all events by default, in case of non-profiles standard identify events, older implementation of using HMSET to replace the whole hash would become redundant

Lets discuss over all with @saikumarrs

Copy link

sonarqubecloud bot commented Mar 1, 2024

@devops-github-rudderstack
Copy link
Contributor

This PR is considered to be stale. It has been open for 20 days with no further activity thus it is going to be closed in 7 days. To avoid such a case please consider removing the stale label manually or add a comment to the PR.

@devops-github-rudderstack devops-github-rudderstack deleted the feat.support.record.events.for.redis branch May 31, 2024 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants