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

Gmail - updates to new-email-received trigger #14364

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Oct 19, 2024

  • Set initialHistoryId to this._getLastHistoryId() (set in the deploy hook) if this.initialHistoryId is null.
  • Run source once per hour and renew watch request if no new emails have been received in the last hour
  • Respond to incoming events with status 200.

Summary by CodeRabbit

  • New Features

    • Improved email notification handling with enhanced logic for renewing notifications based on expiration and last received time.
    • New properties added to manage expiration and initial history ID for notifications.
  • Version Updates

    • Updated version numbers for the Gmail component and new email received source.

@michelle0927 michelle0927 self-assigned this Oct 19, 2024
Copy link

vercel bot commented Oct 19, 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) Oct 19, 2024 7:17pm
pipedream-docs ⬜️ Ignored (Inspect) Oct 19, 2024 7:17pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Oct 19, 2024 7:17pm

Copy link
Contributor

coderabbitai bot commented Oct 19, 2024

Walkthrough

The pull request includes updates to the package.json and new-email-received.mjs files for the @pipedream/gmail component. The version number in package.json is incremented from 0.1.9 to 0.1.10. In new-email-received.mjs, the version is updated from 0.1.6 to 0.1.7, with modifications to properties and methods for enhanced email notification handling, including changes to polling frequency and the structure of returned responses.

Changes

File Path Change Summary
components/gmail/package.json Version updated from 0.1.9 to 0.1.10.
components/gmail/sources/new-email-received.mjs Version updated from 0.1.6 to 0.1.7. Added properties: expiration, initialHistoryId. Added methods: _getExpiration, _setExpiration, _getLastReceivedTime, _setLastReceivedTime. Adjusted polling interval from 24 * 60 * 60 seconds to 60 * 60 seconds. Modified return value of setupGmailNotifications to include the entire response object.

Possibly related PRs

Suggested reviewers

  • jcortes
  • lcaresia

Poem

🐇 In the garden of code, we hop with glee,
A version updated, as bright as can be!
With properties new and methods refined,
Our email notifications are now well-defined.
So let’s celebrate this change, oh so sweet,
For in every line, our progress is neat! 🎉


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 (1)
components/gmail/sources/new-email-received/new-email-received.mjs (1)

Line range hint 12-24: Suggestion: Modularize State Management Methods

To enhance maintainability and readability, consider modularizing the state management methods (e.g., _getExpiration, _setExpiration, _getLastReceivedTime, _setLastReceivedTime) into a separate utility or base class if they are used across multiple components. This promotes reusability and reduces code duplication.

Also applies to: 125-127, 131-131, 209-211, 217-221, 292-303, 438-448, 531-532

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1c4a740 and ade9e83.

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

124-127: Enhancement: Utilize customResponse for HTTP Interface

The addition of customResponse: true in the http property allows for custom handling of HTTP responses. This change enables the source to send specific status codes and responses back to Gmail, which is essential for proper webhook acknowledgment.


131-131: Adjustment: Change Timer Interval to 1 Hour

The polling interval is adjusted to run once every hour (intervalSeconds: 60 * 60). This change ensures that the watch request is renewed if no new emails have been received within the last hour, improving the component's efficiency.


209-211: Set Initial History ID and Expiration Values

Storing historyId and expiration from setupGmailNotifications ensures the component has a valid starting point for tracking email history and knows when to renew the watch.


217-221: Addition of expiration Property

Adding the expiration property to the component's props allows the component to keep track of when the Gmail push notification subscription expires, which is crucial for timely renewals.


292-303: New Methods for Managing Expiration and Received Time

The addition of _getExpiration, _setExpiration, _getLastReceivedTime, and _setLastReceivedTime methods enhances the component's ability to manage state related to the expiration of notifications and the timestamp of the last received email.


363-363: Clarification: Return Watch Response Directly

Returning the entire watchResponse in setupGmailNotifications provides immediate access to both historyId and expiration, simplifying state management for these values.


438-448: Logic Enhancement: Conditional Renewal of Gmail Push Notifications

The conditional check ensures that Gmail push notifications are renewed either if they are about to expire within the next hour or if no email has been received in the last hour. This proactive approach maintains the reliability of the email monitoring service.


460-463: Respond to Gmail Webhook with 200 Status Code

By sending a 200 status code in response to Gmail webhook events, the component acknowledges the receipt of the notification, which is required by Gmail to consider the message successfully delivered.


531-532: Update Last Received Time After Processing Messages

Setting the last received time to the current timestamp after processing new messages ensures accurate tracking for future conditional checks regarding notification renewals.


18-18: Version Update: Ensure Consistency Across Related Files

The version is updated from 0.1.6 to 0.1.7. Confirm that all related files, including package.json, reflect this version change to maintain consistency across the component.

Run the following script to check for inconsistent version numbers:

✅ Verification successful

Version consistency confirmed across related files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all files referencing the version have been updated to 0.1.7

# Search for files containing the old version number
rg 'version: "0\.1\.6"' --type js

# Search for files containing the new version number
rg 'version: "0\.1\.7"' --type js

Length of output: 71


Script:

#!/bin/bash
# Description: Verify that all files referencing the version have been updated to 0.1.7

# Search for files containing the old version number
rg 'version: "0\.1\.6"' --type js --type json

# Search for files containing the new version number
rg 'version: "0\.1\.7"' --type js --type json

Length of output: 95

Copy link
Collaborator

@jcortes jcortes left a comment

Choose a reason for hiding this comment

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

HI @michelle0927 lgtm! Ready for QA!

@vunguyenhung
Copy link
Collaborator

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

Test report
https://vunguyenhung.notion.site/Gmail-updates-to-new-email-received-trigger-126bf548bb5e817ba1e4c4a187e7200a

@michelle0927 michelle0927 merged commit 78d91e2 into master Oct 22, 2024
12 checks passed
@michelle0927 michelle0927 deleted the gmail-trigger-updates branch October 22, 2024 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants