[Components] z_api #10837 #16555
[Components] z_api #10837 #16555
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
|
""" WalkthroughThis update introduces a comprehensive integration for the "z_api" WhatsApp API. It adds new action modules for sending text messages, retrieving contacts, and modifying chats. A set of constants for chat actions is centralized, and the main app module is significantly expanded to include property definitions, dynamic property options, and encapsulated HTTP request logic using axios. The app now provides methods for interacting with contacts, chats, and messages, and the package metadata is updated to include a new dependency and version bump. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ActionModule
participant ZApiApp
participant ZApiAPI
User->>ActionModule: Trigger action (e.g., Send Text, Get Contacts, Modify Chat)
ActionModule->>ZApiApp: Call corresponding method (sendText, getContacts, modifyChat)
ZApiApp->>ZApiAPI: Make HTTP request via _makeRequest
ZApiAPI-->>ZApiApp: Return API response
ZApiApp-->>ActionModule: Return result
ActionModule-->>User: Export summary and data
Suggested labels
Suggested reviewers
Poem
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
components/z_api/actions/get-contacts/get-contacts.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/z_api/actions/send-text/send-text.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (3)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (4)
components/z_api/actions/get-contacts/get-contacts.mjs (1)
32-32: Check array access for safetyThe summary message assumes
responseis always an array with alengthproperty. Consider adding a check to handle cases where the API might return a different structure.- $.export("$summary", `Successfully retrieved ${response.length} contacts`); + const contactCount = Array.isArray(response) ? response.length : 'unknown number of'; + $.export("$summary", `Successfully retrieved ${contactCount} contacts`);components/z_api/actions/send-text/send-text.mjs (1)
32-33: String concatenation produces “Successfully sent text to5511999…” – insert a space & use template literals- $.export("$summary", "Successfully sent text to" + this.phone); + $.export("$summary", `Successfully sent text to ${this.phone}`);components/z_api/z_api.app.mjs (2)
38-48:chatprop’s options ignorepageSizeand silently default to 50If the user supplies a custom
pageSize, their preference isn’t respected. Forward it (with a sensible default) so the dropdown matches expectations.- const response = await this.getChats({ - pageNum, - }); + const response = await this.getChats({ + pageNum, + pageSize: this.pageSize ?? 50, + });
52-54: Consider URL-encoding auth parts to avoid path‐injection edge-casesIf any of the auth fields ever contain “/” or other reserved chars the request path could be corrupted.
- return `https://api.z-api.io/instances/${this.$auth.instance_id}/token/${this.$auth.token_id}`; + const enc = encodeURIComponent; + return `https://api.z-api.io/instances/${enc(this.$auth.instance_id)}/token/${enc(this.$auth.token_id)}`;
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (6)
components/z_api/actions/get-contacts/get-contacts.mjs(1 hunks)components/z_api/actions/modify-chat/modify-chat.mjs(1 hunks)components/z_api/actions/send-text/send-text.mjs(1 hunks)components/z_api/common/constants.mjs(1 hunks)components/z_api/package.json(2 hunks)components/z_api/z_api.app.mjs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Verify TypeScript components
- GitHub Check: pnpm publish
- GitHub Check: Publish TypeScript components
- GitHub Check: Lint Code Base
🔇 Additional comments (8)
components/z_api/common/constants.mjs (1)
1-36: Well-organized action constants structureThis file provides a clean, centralized way to define chat action options that can be reused across the application. The consistent format (label/value pairs) makes it easy to maintain and extend.
components/z_api/package.json (2)
3-3: Version bump reflects new functionalityBumping the version from 0.0.1 to 0.1.0 is appropriate given the substantial new functionality being added in this PR.
14-16: Dependency addition looks appropriateAdding @pipedream/platform as a dependency makes sense for this integration as it provides necessary platform utilities.
components/z_api/actions/modify-chat/modify-chat.mjs (2)
1-8: Action metadata and documentation link look goodThe action is well documented with a clear name, description, and link to the API documentation.
9-32: Props are well structured with appropriate dependenciesThe props are properly defined with references to the app's prop definitions, and the chat prop correctly depends on pageNum for pagination.
components/z_api/actions/get-contacts/get-contacts.mjs (2)
1-8: Action metadata and documentation link look goodThe action is well documented with a clear name, description, and link to the API documentation.
9-23: Props are well structured with pagination supportThe props correctly include pagination parameters (page and pageSize) which are important for handling potentially large contact lists.
components/z_api/z_api.app.mjs (1)
55-69: Defaulting$tothismay break axios instrumentationIn Pipedream components the first argument to
axiosshould be the step context ($) so logs and metrics attach to the correct invocation.
When callers omit$, the code falls back to the app object, losing this linkage.Consider making
$mandatory or at least warning when it’s missing.- const { - $ = this, + const { + $, path, headers, ...otherOpts } = opts; + if (!$) { + throw new Error("A Pipedream context ($) is required when calling _makeRequest"); + }
| action: { | ||
| type: "string", | ||
| label: "Action", | ||
| description: "The action to be performed on the chat", | ||
| options: constants.ACTION_OPTIONS, | ||
| }, | ||
| pageNum: { | ||
| type: "string", | ||
| label: "Page", | ||
| description: "Used to paginate the results", | ||
| }, | ||
| pageSize: { | ||
| type: "string", | ||
| label: "Page Size", | ||
| description: "The number of chats to be retrieved", | ||
| }, |
There was a problem hiding this comment.
🛠️ Refactor suggestion
pageNum / pageSize should be numeric to prevent accidental string concatenation
Both props are declared as string, yet they’re passed to the API as query params where numeric semantics are expected.
Changing the type to "integer" avoids surprises (e.g., "1" + 1 === "11").
- pageNum: {
- type: "string",
+ pageNum: {
+ type: "integer",
...
- pageSize: {
- type: "string",
+ pageSize: {
+ type: "integer",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| action: { | |
| type: "string", | |
| label: "Action", | |
| description: "The action to be performed on the chat", | |
| options: constants.ACTION_OPTIONS, | |
| }, | |
| pageNum: { | |
| type: "string", | |
| label: "Page", | |
| description: "Used to paginate the results", | |
| }, | |
| pageSize: { | |
| type: "string", | |
| label: "Page Size", | |
| description: "The number of chats to be retrieved", | |
| }, | |
| action: { | |
| type: "string", | |
| label: "Action", | |
| description: "The action to be performed on the chat", | |
| options: constants.ACTION_OPTIONS, | |
| }, | |
| pageNum: { | |
| type: "integer", | |
| label: "Page", | |
| description: "Used to paginate the results", | |
| }, | |
| pageSize: { | |
| type: "integer", | |
| label: "Page Size", | |
| description: "The number of chats to be retrieved", | |
| }, |
WHY
Summary by CodeRabbit