Skip to content

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Nov 15, 2024

If retrieving history with the existing startHistoryId throws an error, fall back to the retrievedHistoryId retrieved in the webhook payload and emit recent messages to avoid skipping any messages.

Summary by CodeRabbit

  • New Features
    • Enhanced New Email Received component with improved error handling and a new method for retrieving email history.
  • Version Updates
    • Updated version numbers for the Gmail component and the New Email Received functionality.

Copy link

vercel bot commented Nov 15, 2024

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) Nov 15, 2024 10:07pm
pipedream-docs ⬜️ Ignored (Inspect) Nov 15, 2024 10:07pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Nov 15, 2024 10:07pm

Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The pull request includes updates to the @pipedream/gmail component, specifically modifying the version numbers in both the package.json and the new-email-received.mjs files. The package.json version is updated from 0.1.10 to 0.1.11, while the new-email-received.mjs file sees its version incremented from 0.1.7 to 0.1.8. Additionally, a new method for retrieving email history is introduced, and error handling in the run method is improved to enhance functionality.

Changes

File Path Change Summary
components/gmail/package.json Version updated from 0.1.10 to 0.1.11.
components/gmail/sources/new-email-received.mjs Version updated from 0.1.7 to 0.1.8. New method getHistoryResponse added. Enhanced error handling in run method.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • jcortes

🐰 In the garden, I hop with glee,
New versions sprout, just wait and see!
With methods fresh and errors tamed,
Our Gmail's bright, no longer blamed.
So let’s rejoice, a leap we take,
For every change, a new path we make! 🌼


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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
components/gmail/sources/new-email-received/new-email-received.mjs (2)

422-430: Add JSDoc documentation for better maintainability

Good extraction of the history retrieval logic into a reusable method. Consider adding JSDoc documentation to describe the parameters and return value.

+/**
+ * Retrieves email history from Gmail API
+ * @param {string} startHistoryId - The starting point for history retrieval
+ * @returns {Promise<Object>} History response from Gmail API
+ */
 getHistoryResponse(startHistoryId) {
   return this.gmail.listHistory({
     startHistoryId,
     historyTypes: [
       "messageAdded",
     ],
     labelId: this.label,
   });
 },

491-511: Enhance error handling specificity and variable declaration

The error handling implementation successfully addresses the PR objective of handling invalid/expired startHistoryId. Consider these improvements:

  1. Be more specific about the error type being caught
  2. Use object destructuring for cleaner variable declaration
-      let startHistoryId = Math.min(
-        parseInt(lastProcessedHistoryId),
-        parseInt(receivedHistoryId),
-      );
+      const startHistoryId = Math.min(
+        parseInt(lastProcessedHistoryId),
+        parseInt(receivedHistoryId),
+      );
       console.log("Using startHistoryId:", startHistoryId);

-      let historyResponse;
       try {
-        historyResponse = await this.getHistoryResponse(startHistoryId);
+        const historyResponse = await this.getHistoryResponse(startHistoryId);
-      } catch {
+      } catch (error) {
+        // Check if error is due to invalid/expired historyId
+        if (error.code !== 404) {
+          throw error; // Re-throw unexpected errors
+        }
         // catch error thrown if startHistoryId is invalid or expired

         // emit recent messages to attempt to avoid missing any messages
         await this.emitRecentMessages();

         // set startHistoryId to the historyId received from the webhook
-        startHistoryId = parseInt(receivedHistoryId);
+        const fallbackHistoryId = parseInt(receivedHistoryId);
         console.log("Using startHistoryId:", startHistoryId);
-        historyResponse = await this.getHistoryResponse(startHistoryId);
+        return await this.getHistoryResponse(fallbackHistoryId);
       }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 973f4f2 and 4299cbf.

📒 Files selected for processing (2)
  • components/gmail/package.json (1 hunks)
  • components/gmail/sources/new-email-received/new-email-received.mjs (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/gmail/package.json
🔇 Additional comments (1)
components/gmail/sources/new-email-received/new-email-received.mjs (1)

18-18: LGTM: Version bump is appropriate

Version increment from 0.1.7 to 0.1.8 aligns with the scope of changes being introduced.

@vunguyenhung
Copy link
Collaborator

Hi everyone, all test cases are passed! Ready for release!

Test report
https://vunguyenhung.notion.site/Gmail-new-email-received-trigger-updates-142bf548bb5e81d692e6fdc40c73eda8

@michelle0927 michelle0927 merged commit 3440c62 into master Nov 18, 2024
12 checks passed
@michelle0927 michelle0927 deleted the gmail-new-email-received-updates branch November 18, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants