[BUG] SFTP: behavior has not changed according to user

[jcortes]

WHY

Resolves #15005

Summary by CodeRabbit

• New Features

  • Updated versions of SFTP components to enhance stability.

• Bug Fixes

  • Simplified the return statement in the event ID generation method for the SFTP remote directory watcher, improving efficiency.

• Chores

  • Version updates for the @pipedream/sftp and @pipedream/sftp_password_based_auth packages.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)			Dec 17, 2024 9:33pm
pipedream-docs	⬜️ Ignored (Inspect)			Dec 17, 2024 9:33pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Dec 17, 2024 9:33pm

[coderabbitai]

Walkthrough

This pull request involves version updates for SFTP-related components. Specifically, the version numbers have been incremented for two packages (@pipedream/sftp and @pipedream/sftp_password_based_auth) from 0.4.0 to 0.4.1, and their corresponding watch-remote-directory source files from 0.1.0 to 0.1.1. The primary change is a simplification of the getEventId method in the SFTP remote directory watcher component, which now directly returns an MD5 hash of the path and modification time.

Changes

File	Change Summary
components/sftp/package.json	Version bumped from 0.4.0 to 0.4.1
components/sftp/sources/watch-remote-directory/watch-remote-directory.mjs	Version updated to 0.1.1, getEventId method simplified to return MD5 hash directly
components/sftp_password_based_auth/package.json	Version bumped from 0.4.0 to 0.4.1
components/sftp_password_based_auth/sources/watch-remote-directory/watch-remote-directory.mjs	Version updated to 0.1.1

Assessment against linked issues

Objective	Addressed	Explanation
Resolve SFTP behavior issue [#15005]	❓	Unable to definitively confirm if the changes fully address the user-reported behavior without more context

Suggested reviewers

• lcaresia
• GTFalcao

Poem

🐰 Hop, hop, through SFTP's domain,
A version bump, a method's refrain,
MD5 dancing light and free,
Simplicity's sweet melody,
Code hops forward with rabbit's glee! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6782fe0 and f6e04d2.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (4)

• components/sftp/package.json (1 hunks)
• components/sftp/sources/watch-remote-directory/watch-remote-directory.mjs (2 hunks)
• components/sftp_password_based_auth/package.json (1 hunks)
• components/sftp_password_based_auth/sources/watch-remote-directory/watch-remote-directory.mjs (1 hunks)

✅ Files skipped from review due to trivial changes (3)

• components/sftp_password_based_auth/package.json
• components/sftp_password_based_auth/sources/watch-remote-directory/watch-remote-directory.mjs
• components/sftp/package.json

🔇 Additional comments (2)

components/sftp/sources/watch-remote-directory/watch-remote-directory.mjs (2)

9-9: LGTM: Version bump is appropriate

The minor version increment (0.1.0 → 0.1.1) aligns with the nature of the bug fix and maintains consistency with related package updates.

---

125-127: Verify impact of event ID changes

While the simplified ID generation is more efficient, this change modifies the event ID format which could affect:

1. Deduplication behavior
2. Existing integrations relying on the previous ID format

Let's verify the usage of these event IDs:

For future consideration:

1. Consider using a more robust hashing algorithm (e.g., SHA-256) for better collision resistance
2. Add a version prefix to the ID to handle format changes gracefully

 getEventId(event) {
-  return createHash("md5")
+  return "v2_" + createHash("sha256")
     .update(event.path + event.modifyTime)
     .digest("hex");
 }

✅ Verification successful

Event ID changes are safe to proceed

The simplified event ID implementation is safe because:

1. The ID is only used internally for deduplication within this component
2. The event ID format is an implementation detail that's not exposed to external integrations
3. The component is configured with dedupe: "unique", ensuring events are properly deduplicated regardless of ID format

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any direct references to or parsing of event IDs
rg -l "getEventId|emit.*id:|id.*:.*digest" --type js --type ts

# Search for potential ID format dependencies
rg -l "\.digest\(.*\)" --type js --type ts

Length of output: 211

---

Script:

#!/bin/bash
# Let's check the actual implementation and usage of getEventId in the file
rg -A 5 -B 5 "getEventId" components/sftp/sources/watch-remote-directory/watch-remote-directory.mjs

# Check if there are any event emitters or consumers in the SFTP component
rg -A 3 "emit\(" components/sftp/sources/watch-remote-directory/watch-remote-directory.mjs

# Check how the event ID is used in deduplication
rg -A 3 "dedup" components/sftp/sources/watch-remote-directory/watch-remote-directory.mjs

Length of output: 1289

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[luancazarine]

Hi @jcortes, LGTM! Ready for QA!