Skip to content

Fireflies - error handling #16024

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

Merged
merged 5 commits into from
Mar 26, 2025
Merged

Fireflies - error handling #16024

merged 5 commits into from
Mar 26, 2025

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Mar 25, 2025

Add configuration errors to Fireflies actions.

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in meeting actions to ensure required IDs are provided, delivering clearer feedback when issues occur.
    • Enhanced error reporting for meeting queries to better communicate API errors.
  • Chores

    • Updated version numbers and upgraded dependencies for enhanced stability and reliability.

Copy link

vercel bot commented Mar 25, 2025

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) Visit Preview Mar 26, 2025 3:16pm
pipedream-docs ⬜️ Ignored (Inspect) Mar 26, 2025 3:16pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Mar 26, 2025 3:16pm

Copy link
Contributor

coderabbitai bot commented Mar 25, 2025

Walkthrough

This pull request enhances error handling in several fireflies actions by validating the presence of required parameters and checking API responses for errors. The find-meeting-by-id action ensures that a meeting ID is provided, while the find-recent-meeting action checks for a user ID. Both actions throw a ConfigurationError for missing parameters or when errors are found in the API response. Additionally, the version numbers for these actions have been incremented from 0.0.1 to 0.0.2. The package’s version and dependency (@pipedream/platform) in package.json have also been updated.

Changes

File(s) Change Summary
components/fireflies/actions/.../find-meeting-by-id.mjs
components/fireflies/actions/.../find-recent-meeting.mjs
Added parameter validation (meetingId/userId) and error handling using ConfigurationError. Throws errors if a required parameter is missing or if the API response contains errors. Version updated from 0.0.1 to 0.0.2 in both files.
components/fireflies/package.json Package version updated from 0.1.0 to 0.1.1 and dependency @pipedream/platform upgraded from ^1.6.2 to ^3.0.3.
components/fireflies/actions/.../upload-audio.mjs
components/fireflies/sources/.../new-meeting-created.mjs
Version updated from 0.0.1 to 0.0.2 in both files without functional changes.
components/fireflies/fireflies.app.mjs Made the query method asynchronous and added error handling for API responses using ConfigurationError.

Possibly related PRs

  • Hubspot - Search CRM #15417: The changes in the main PR related to error handling for the meetingId property are similar to the error handling enhancements for the searchProperty in the retrieved PR, as both introduce checks that throw ConfigurationError for missing or invalid parameters.

Suggested labels

action, User submitted

Suggested reviewers

  • GTFalcao

Poem

Oh, I hopped through lines of code,
With checks and errors neatly stowed.
Parameters now are in sight,
Ensuring everything runs just right!
From rabbit hops to code so bright, 🐇✨
I celebrate these changes with delight!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/fireflies/actions/find-meeting-by-id/find-meeting-by-id.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

components/fireflies/actions/find-recent-meeting/find-recent-meeting.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

components/fireflies/fireflies.app.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

  • 2 others

📜 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 ea0ddf2 and 73e75eb.

📒 Files selected for processing (5)
  • components/fireflies/actions/find-meeting-by-id/find-meeting-by-id.mjs (3 hunks)
  • components/fireflies/actions/find-recent-meeting/find-recent-meeting.mjs (4 hunks)
  • components/fireflies/actions/upload-audio/upload-audio.mjs (1 hunks)
  • components/fireflies/fireflies.app.mjs (2 hunks)
  • components/fireflies/sources/new-meeting-created/new-meeting-created.mjs (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • components/fireflies/sources/new-meeting-created/new-meeting-created.mjs
  • components/fireflies/actions/upload-audio/upload-audio.mjs
🚧 Files skipped from review as they are similar to previous changes (2)
  • components/fireflies/actions/find-recent-meeting/find-recent-meeting.mjs
  • components/fireflies/actions/find-meeting-by-id/find-meeting-by-id.mjs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (2)
components/fireflies/fireflies.app.mjs (2)

1-3: Good addition of ConfigurationError import.

Adding ConfigurationError from @pipedream/platform is appropriate for handling configuration-related errors in your GraphQL API interactions.


75-83: Improved error handling in the query method.

The changes to make the query method async and add proper error handling are excellent improvements:

  1. Making the method async allows for cleaner handling of the promise returned by _makeRequest
  2. Checking for errors in the GraphQL response and throwing a ConfigurationError with a descriptive message provides better error reporting to users
  3. Explicitly returning the response makes the code more readable

This implementation will properly surface API errors to users in a more understandable way.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

jcortes
jcortes previously approved these changes Mar 25, 2025
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!

@jcortes jcortes moved this from Ready for PR Review to Ready for QA in Component (Source and Action) Backlog Mar 25, 2025
@@ -26,6 +31,11 @@ export default {
},
},
});

if (meeting.errors?.length) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

So, minor coding style nit here, but rather than requiring all callers of proxy handle these errors, which can be error prone, it might be more consistent to have the base function detect an error response (e.g. by finding an error key in the json response), and raising the ConfigurationError at that point. That way upload-audio any future actions, as well as async options can all benefit from the same error handling. Does that make sense?

@vunguyenhung vunguyenhung moved this from Ready for QA to Ready for Release in Component (Source and Action) Backlog Mar 26, 2025
@vunguyenhung
Copy link
Collaborator

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

Test report
https://vunguyenhung.notion.site/Fireflies-error-handling-1c1bf548bb5e81d9a6a6f69f6232c426

@michelle0927
Copy link
Collaborator Author

/approve

@michelle0927 michelle0927 merged commit eb127e5 into master Mar 26, 2025
11 checks passed
@michelle0927 michelle0927 deleted the fireflies-error-handling branch March 26, 2025 15:42
@github-project-automation github-project-automation bot moved this from Ready for Release to Done in Component (Source and Action) Backlog Mar 26, 2025
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.

4 participants