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

Functions: Handle "charge.updated" events to process updated balance transactions from Stripe #1007

Merged
merged 2 commits into from
Jan 12, 2025

Conversation

mkue
Copy link
Contributor

@mkue mkue commented Jan 11, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced Stripe webhook handling to support additional charge event types.
    • Improved contribution storage with more robust merging of Firestore documents.
    • Added new environment variables for local Firebase configuration.
  • Bug Fixes

    • Refined charge event processing to handle scenarios with missing balance transaction information.
  • Refactor

    • Simplified charge event data handling.
    • Improved code readability in Stripe event processing logic.
    • Introduced a setup step in tests to ensure a clean state before each execution.

Copy link

vercel bot commented Jan 11, 2025

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

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
public ⬜️ Ignored (Inspect) Visit Preview Jan 12, 2025 11:11am

Copy link

coderabbitai bot commented Jan 11, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the Stripe webhook handler and event processing logic. The changes focus on expanding event handling capabilities, specifically for 'charge.updated' events, and refining how charge information is processed and stored. The updates improve the robustness of charge event management by adding more flexible event processing and ensuring comprehensive data handling.

Changes

File Change Summary
functions/src/webhooks/stripe/index.ts - Added handling for 'charge.updated' event
- Removed intermediate charge variable
- Directly use event.data.object for charge processing
shared/src/stripe/StripeEventHandler.ts - Refactored charge event handling logic
- Separated user retrieval from condition checking
- Modified contribution storage to use set(..., { merge: true })
shared/.env.sample - Added environment variables: GCLOUD_PROJECT, FIRESTORE_EMULATOR_HOST, FIREBASE_AUTH_EMULATOR_HOST
shared/src/stripe/StripeEventHandler.test.ts - Added beforeEach to clear Firestore data before tests
- Minor adjustments in test case variable usage
shared/tests/utils.ts - Introduced clearFirestoreData function for cleaning Firestore data

Sequence Diagram

sequenceDiagram
    participant Stripe
    participant WebhookHandler
    participant StripeEventHandler
    participant Firestore

    Stripe->>WebhookHandler: Send webhook event
    WebhookHandler->>StripeEventHandler: Process event
    alt Charge Event
        StripeEventHandler->>Firestore: Retrieve User
        StripeEventHandler->>Firestore: Store Contribution (Merged)
    end
Loading

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 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.

Copy link

github-actions bot commented Jan 11, 2025

Visit the preview URL for this PR (updated for commit 148849d):

https://si-admin-staging--pr1007-michael-stripe-charg-ak0zjc5n.web.app

(expires Sun, 19 Jan 2025 11:15:12 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: b7b0969384059dce6ea8fad1ee1d1737e54e6676

Copy link

@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

🧹 Nitpick comments (3)
shared/tests/utils.ts (1)

3-11: Add error handling and logging for deletion failures.

The function should catch and log any errors during deletion to help with debugging test failures.

 export async function clearFirestoreData(firestoreAdmin: FirestoreAdmin) {
+  try {
     const collections = await firestoreAdmin.firestore.listCollections();
     const deletePromises = collections.map(async (collection) => {
       const documents = await collection.listDocuments();
       const deleteDocPromises = documents.map((doc) => firestoreAdmin.firestore.recursiveDelete(doc));
       await Promise.all(deleteDocPromises);
     });
     await Promise.all(deletePromises);
+  } catch (error) {
+    console.error('Failed to clear Firestore data:', error);
+    throw error;
+  }
 }
shared/src/stripe/StripeEventHandler.test.ts (1)

35-35: Consider adding error case tests.

The tests only cover successful scenarios. Add tests for:

  • Invalid charge data
  • Firestore write failures
  • Missing customer data

Also applies to: 56-56, 66-66, 78-78

shared/.env.sample (1)

1-4: Add validation instructions for environment setup.

Consider adding:

  • Instructions for verifying emulator connectivity
  • Required Firebase emulator versions
  • Commands to start emulators with these ports
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1089964 and 148849d.

📒 Files selected for processing (4)
  • shared/.env.sample (1 hunks)
  • shared/src/stripe/StripeEventHandler.test.ts (6 hunks)
  • shared/src/stripe/StripeEventHandler.ts (2 hunks)
  • shared/tests/utils.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • shared/src/stripe/StripeEventHandler.ts
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Test shared code
  • GitHub Check: Test functions
  • GitHub Check: Test admin
  • GitHub Check: Test website
  • GitHub Check: Prettify
  • GitHub Check: Security checks (typescript)
🔇 Additional comments (2)
shared/src/stripe/StripeEventHandler.test.ts (2)

18-20: LGTM! Good test isolation practice.

Adding clearFirestoreData in beforeEach ensures clean state for each test.


Line range hint 83-85: Implement the TODO for checkout session test.

The missing test for handleCheckoutSessionCompletedEvent should be implemented to ensure complete coverage.

Would you like me to help implement this test case?

@mkue mkue merged commit 656d242 into main Jan 12, 2025
19 checks passed
@mkue mkue deleted the michael/stripe-charge-event branch January 12, 2025 11:17
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.

1 participant