[FEATURE] New prop to Gong action #14690
Conversation
|
@jcortes is attempting to deploy a commit to the Pipedreamers Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request includes updates to several files within the Gong application, primarily focusing on version increments from "0.0.1" to "0.0.2" for multiple actions and components. Notably, the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
components/gong/gong.app.mjs (1)
69-73: LGTM! Consider minor description formatting improvement.The property definition is well-structured and the type is appropriate for the use case. The description clearly explains the fallback behavior.
Consider using backticks for the parameter names in the description for consistency:
-description: "List of calls Ids to be filtered. If not supplied, returns all calls between **From Date Time** and **To Date Time**.", +description: "List of calls Ids to be filtered. If not supplied, returns all calls between `From Date Time` and `To Date Time`.",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (6)
components/gong/actions/add-new-call/add-new-call.mjs(1 hunks)components/gong/actions/list-calls/list-calls.mjs(1 hunks)components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs(3 hunks)components/gong/gong.app.mjs(1 hunks)components/gong/package.json(2 hunks)components/gong/sources/new-call/new-call.mjs(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- components/gong/actions/add-new-call/add-new-call.mjs
- components/gong/actions/list-calls/list-calls.mjs
- components/gong/sources/new-call/new-call.mjs
🔇 Additional comments (6)
components/gong/package.json (1)
13-13: Verify compatibility with @pipedream/platform v3
The major version update of @pipedream/platform (1.x.x → 3.x.x) might introduce breaking changes. Please ensure all platform API usage has been updated accordingly.
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (4)
8-8: LGTM! Version bump is appropriate.
The version increment from 0.0.1 to 0.0.2 correctly reflects the addition of a new feature (callIds prop).
60-60: LGTM! Improved message formatting.
The addition of a period improves the grammatical correctness of the success message.
32-37:
Consider semantic version bump to 0.1.0
Adding a required property is a breaking change as it affects backward compatibility. According to semantic versioning, this should warrant a minor version bump (0.1.0) rather than a patch version bump (0.0.2).
Also, let's verify the prop definition in the app module:
Line range hint 40-46: Verify API endpoint compatibility with callIds filter
The implementation spreads the filter object (including callIds) into the request data. Let's verify this matches the Gong API documentation referenced in the component description.
Also applies to: 51-57
✅ Verification successful
API endpoint implementation appears correct for filter usage
The implementation aligns with the expected behavior:
- The Gong README confirms the API supports retrieving transcripts as a core functionality
- The code correctly structures the request by:
- Using the
/calls/transcriptendpoint - Passing the filter object in the request data, which is the standard way to send filtering parameters
- Using the
- The implementation follows the pattern seen in the usage example where the filter is passed within the data object
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Find API documentation references and usage examples
# Check for API documentation or examples
rg -A 5 'calls/transcript' --type md
rg -A 5 'callIds.*filter' --type js
Length of output: 74
Script:
#!/bin/bash
# Let's try a broader search for API documentation and usage patterns
# Search for any documentation files related to Gong API
fd -e md -e txt . | xargs rg -l "gong.*api|api.*gong" -i
# Search for any references to transcript endpoints
rg -i "transcript.*endpoint|endpoint.*transcript"
# Look for similar implementations or test files
ast-grep --pattern 'post({
path: "/calls/transcript",
$$$
})'
# Search for any configuration or constant files that might contain API documentation
fd -e js -e mjs | xargs rg -l "GONG_API|gong.*config" -i
Length of output: 705
Script:
#!/bin/bash
# Let's check the Gong README and any related files for API usage details
# Display content of Gong README
cat components/gong/README.md
# Look for any test files or examples related to transcript retrieval
fd -e test.mjs -e spec.mjs -e test.js -e spec.js | xargs rg -l "transcript"
# Search for any usage examples of the transcript endpoint
rg -A 5 "retrieveTranscriptsOfCalls"
Length of output: 7978
components/gong/gong.app.mjs (1)
69-83: Verify integration with retrieve-transcripts-of-calls action.
The property is marked as optional here but required in the retrieve-transcripts-of-calls action according to the AI summary. Let's verify this integration.
WHY
Resolves #14683
Summary by CodeRabbit
Release Notes
New Features
callIdsproperty to filter calls by their IDs in relevant actions.Version Updates
Dependency Updates
@pipedream/platformto version^3.0.3.