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 generic destination sftp #4601

Merged
merged 25 commits into from
May 3, 2024

Conversation

Gauravudia
Copy link
Contributor

@Gauravudia Gauravudia commented Apr 22, 2024

Description

  • Onboard new generic destination SFTP.
  • Utilized the library built within the go-kit repository, ref here: rudderlabs/rudder-go-kit/sftp.
  • SFTP serves as a generic destination leveraging the SFTP protocol for file uploads.
  • This destination operates without the need for polling or the GetUpload status method. To accommodate this, an additional interface, AsyncUploadAndTransformManager, was created.
  • Using the record event type as this is a generic destination that don't have any predefined schema.
  • Bypass the transfromer call for transformation and handling it directly on the server side due to straightforward transformation.

Linear Ticket

Resolves INT-1923
https://linear.app/rudderstack/issue/INT-1923/sftp-destination-development-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 Apr 22, 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.

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.

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.
  • 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 changed the base branch from feat.sftp-destination-brt to master April 22, 2024 12:34
@Gauravudia Gauravudia self-assigned this Apr 25, 2024
@Gauravudia Gauravudia marked this pull request as ready for review April 29, 2024 04:52
Copy link

codecov bot commented Apr 29, 2024

Codecov Report

Attention: Patch coverage is 50.15015% with 166 lines in your changes are missing coverage. Please review.

Project coverage is 74.55%. Comparing base (566f430) to head (8d64238).

❗ Current head 8d64238 differs from pull request most recent head 49408e5. Consider uploading reports for the commit 49408e5 to get more accurate results

Files Patch % Lines
.../batchrouter/asyncdestinationmanager/sftp/utils.go 70.94% 28 Missing and 24 partials ⚠️
router/batchrouter/handle_async.go 0.00% 27 Missing ⚠️
...tchrouter/asyncdestinationmanager/common/common.go 7.40% 25 Missing ⚠️
...atchrouter/asyncdestinationmanager/sftp/manager.go 51.06% 22 Missing and 1 partial ⚠️
...ter/batchrouter/asyncdestinationmanager/manager.go 0.00% 13 Missing ⚠️
router/batchrouter/handle_lifecycle.go 0.00% 8 Missing and 2 partials ⚠️
router/batchrouter/util.go 50.00% 4 Missing ⚠️
.../asyncdestinationmanager/bing-ads/bulk_uploader.go 0.00% 2 Missing ⚠️
...chrouter/asyncdestinationmanager/common/manager.go 0.00% 2 Missing ⚠️
...er/asyncdestinationmanager/eloqua/bulk_uploader.go 0.00% 2 Missing ⚠️
... and 4 more
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4601      +/-   ##
==========================================
- Coverage   74.66%   74.55%   -0.11%     
==========================================
  Files         409      412       +3     
  Lines       48417    48703     +286     
==========================================
+ Hits        36150    36311     +161     
- Misses       9929    10014      +85     
- Partials     2338     2378      +40     

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

@@ -43,3 +25,21 @@ func NewManager(destination *backendconfig.DestinationT, backendConfig backendco
}
return nil, errors.New("invalid destination type")
}

func NewSFTPManager(destination *backendconfig.DestinationT, backendConfig backendconfig.BackendConfig) (common.AsyncDestinationManager, error) {
Copy link
Member

@lvrach lvrach Apr 29, 2024

Choose a reason for hiding this comment

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

Are we planning to have more SFTP based destinations ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, Klaviyo and Salesforce also supports SFTP based file uploads. Targeting it for next quarter

@Gauravudia Gauravudia changed the title feat: onboard new destination sftp feat: onboard new generic destination sftp Apr 29, 2024
AuthMethod string `json:"authMethod"`
Username string `json:"username"`
Host string `json:"host"`
Port string `json:"port"`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Port string `json:"port"`
Port int `json:"port"`

Suggesting changing to int to avoid converting the string back to int again

Copy link
Contributor Author

Choose a reason for hiding this comment

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

JSON.unmarhsal is not giving the desired output for string to int conversion.

router/batchrouter/worker.go Outdated Show resolved Hide resolved
router/batchrouter/util.go Outdated Show resolved Hide resolved
router/batchrouter/handle_async.go Outdated Show resolved Hide resolved
router/batchrouter/asyncdestinationmanager/sftp/utils.go Outdated Show resolved Hide resolved
router/batchrouter/asyncdestinationmanager/sftp/utils.go Outdated Show resolved Hide resolved
router/batchrouter/asyncdestinationmanager/sftp/utils.go Outdated Show resolved Hide resolved
Copy link
Member

@achettyiitr achettyiitr left a comment

Choose a reason for hiding this comment

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

Some more minor comments.

@@ -17,13 +24,13 @@ func (f *InvalidManager) Upload(asyncDestStruct *AsyncDestinationStruct) AsyncUp
}
}

func (f *InvalidManager) Poll(_ AsyncPoll) PollStatusResponse {
func (*InvalidManager) Poll(_ AsyncPoll) PollStatusResponse {
return PollStatusResponse{
StatusCode: 400,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
StatusCode: 400,
StatusCode: http.StatusBadRequest,

return PollStatusResponse{
StatusCode: 400,
}
}

func (f *InvalidManager) GetUploadStats(_ GetUploadStatsInput) GetUploadStatsResponse {
func (*InvalidManager) GetUploadStats(_ GetUploadStatsInput) GetUploadStatsResponse {
return GetUploadStatsResponse{
StatusCode: 400,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
StatusCode: 400,
StatusCode: http.StatusBadRequest,


func newDefaultManager(fileManager sftp.FileManager) *defaultManager {
return &defaultManager{
FileManager: fileManager,
Copy link
Member

Choose a reason for hiding this comment

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

Does it needs to be exported?

Suggested change
FileManager: fileManager,
fileManager: fileManager,


var (
json = jsoniter.ConfigCompatibleWithStandardLibrary
re = regexp.MustCompile(`{([^}]+)}`)
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 name it better? Something like placeholderRegex?

}
}

func generateJSONFile(filePath string) (string, error) {
Copy link
Member

Choose a reason for hiding this comment

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

Adding some context around error branches would be helpful?

return tmpFilePath, nil
}

func generateCSVFile(filePath string) (string, error) {
Copy link
Member

Choose a reason for hiding this comment

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

Adding some context around error branches would be helpful?

@Gauravudia Gauravudia merged commit c6a28bb into master May 3, 2024
50 checks passed
@Gauravudia Gauravudia deleted the feat.sftp-destination-brt-patch branch May 3, 2024 06:45
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.

None yet

7 participants