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: onboard new custom destination: wunderkind #4798

Merged
merged 17 commits into from
Jul 17, 2024
Merged

Conversation

Gauravudia
Copy link
Contributor

@Gauravudia Gauravudia commented Jun 12, 2024

Description

Onboard new custom destination wunderkind

  • This is the custom destination which invokes the wunderkind lambda with the client payload and wunderkind lambda creds.
  • This destination uses wunderkind lambda creds from env.

Linear Ticket

Resolves INT-2276
https://linear.app/rudderstack/issue/INT-2276/creating-custom-destination-in-rudder-server

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Copy link
Contributor

coderabbitai bot commented Jun 12, 2024

Important

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

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

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.

@Gauravudia Gauravudia self-assigned this Jun 13, 2024
Copy link

github-actions bot commented Jul 4, 2024

This PR is considered to be stale. It has been open 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.

@github-actions github-actions bot added the Stale label Jul 4, 2024
@Gauravudia Gauravudia added enhancement New feature or request and removed Stale labels Jul 4, 2024
@Gauravudia Gauravudia marked this pull request as ready for review July 4, 2024 09:21
Copy link

codecov bot commented Jul 4, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 14 lines in your changes missing coverage. Please review.

Project coverage is 74.45%. Comparing base (f9a8d13) to head (74dfca2).

Files Patch % Lines
...ices/streammanager/wunderkind/wunderkindmanager.go 82.08% 7 Missing and 5 partials ⚠️
services/streammanager/streammanager.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4798      +/-   ##
==========================================
+ Coverage   74.42%   74.45%   +0.02%     
==========================================
  Files         427      428       +1     
  Lines       49658    49727      +69     
==========================================
+ Hits        36959    37022      +63     
+ Misses      10271    10259      -12     
- Partials     2428     2446      +18     

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

Comment on lines 40 to 43

func init() {
pkgLogger = logger.NewLogger().Child("streammanager").Child(lambda.ServiceName)
}
Copy link
Member

Choose a reason for hiding this comment

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

Can we avoid the use init and the global here?

Is it possible to inject logger into the struct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

statusCode := 400
respStatus := "Failure"
responseMessage := string(response.Payload)
pkgLogger.Errorf("[Wunderkind] Function execution error :: %d : %s : %s", statusCode, respStatus, responseMessage)
Copy link
Member

Choose a reason for hiding this comment

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

Prefix should not be needed since it was added using Child

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

}

var invokeInput lambda.InvokeInput
wunderKindLambda := config.GetEnv(WUNDERKIND_LAMBDA)
Copy link
Member

Choose a reason for hiding this comment

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

DI config

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you provide some more clarification on this?

Copy link
Member

Choose a reason for hiding this comment

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

You would need to take config as a parameter in the constructor and store it as part of Producer struct. Later you can us it producer.conf.GetString(WunderkindLambda, "")

// NewProducer creates a producer based on destination config
func NewProducer(conf *config.Config) (*Producer, error) {
	awsSession, err := awsutil.CreateSession(&awsutil.SessionConfig{
		Region:        conf.GetString(WunderkindRegion, ""),
		IAMRoleARN:    conf.GetString(WunderkindIamRoleArn, ""),
		ExternalID:    conf.GetString(WunderkindExternalId, ""),
		RoleBasedAuth: true,
	})
	if err != nil {
		return nil, fmt.Errorf("creating session: %w", err)
	}

	return &Producer{
		conf:   conf,
		logger: logger.NewLogger().Child("streammanager").Child("wunderkind"),
		client: lambda.New(awsSession),
	}, nil
}

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.
I have used config.default in caller function of NewProducer

ctrl := gomock.NewController(t)
mockClient := mock_lambda.NewMockLambdaClient(ctrl)
producer := &WunderkindProducer{client: mockClient}
mockLogger := mock_logger.NewMockLogger(ctrl)
Copy link
Member

Choose a reason for hiding this comment

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

Use mem logger instead, much more maintainable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

@achettyiitr achettyiitr Jul 15, 2024

Choose a reason for hiding this comment

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

@lvrach We don't have mem logger implementation. But in this particular case, we can simply asssert for returned variables, Don't see much of a value in asserting if we are logging or not?

@Gauravudia Gauravudia requested a review from lvrach July 15, 2024 07:50
services/streammanager/wunderkind/wunderkindmanager.go Outdated Show resolved Hide resolved
services/streammanager/wunderkind/wunderkindmanager.go Outdated Show resolved Hide resolved
services/streammanager/wunderkind/wunderkindmanager.go Outdated Show resolved Hide resolved
services/streammanager/wunderkind/wunderkindmanager.go Outdated Show resolved Hide resolved
services/streammanager/wunderkind/wunderkindmanager.go Outdated Show resolved Hide resolved
services/streammanager/wunderkind/wunderkindmanager.go Outdated Show resolved Hide resolved
ctrl := gomock.NewController(t)
mockClient := mock_lambda.NewMockLambdaClient(ctrl)
producer := &WunderkindProducer{client: mockClient}
mockLogger := mock_logger.NewMockLogger(ctrl)
Copy link
Member

@achettyiitr achettyiitr Jul 15, 2024

Choose a reason for hiding this comment

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

@lvrach We don't have mem logger implementation. But in this particular case, we can simply asssert for returned variables, Don't see much of a value in asserting if we are logging or not?

@Gauravudia Gauravudia merged commit 8aa0e49 into master Jul 17, 2024
52 checks passed
This was referenced Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants