New Components - wati #14276
New Components - wati #14276
Conversation
luancazarine
added
the
ai-assisted
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
Actions - Add Contact - Send Template Message - Update Contact Attribute Source - New Contact Created - New Incoming Message
Co-authored-by: michelle0927 <[email protected]>
WalkthroughThe pull request introduces significant changes to the WATI components, including the addition of new action modules for adding contacts, sending template messages, and updating contact attributes. It also replaces an existing application file with a new module that encapsulates WATI API functionalities. Additionally, new event handling modules for new contact creation and incoming messages are added, along with updates to the package.json file to reflect version changes and new dependencies. Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 18
🧹 Outside diff range and nitpick comments (9)
components/wati/package.json (1)
15-17: New dependency looks appropriate.The addition of "@pipedream/platform" as a dependency is in line with the PR objectives of adding new components and actions. This suggests that the WATI component now leverages core Pipedream functionality.
Consider updating the component's documentation to reflect any new setup steps or requirements introduced by this dependency, if applicable.
components/wati/sources/new-incoming-message/test-event.mjs (1)
1-26: LGTM! Consider grouping related propertiesThe overall structure of the test event object looks good and appears to align with the WATI API response for a new incoming message. To improve readability and maintainability, consider grouping related properties together.
You could organize the properties as follows:
- Message content properties (text, type, data)
- Message metadata (timestamp, created, id, conversationId, ticketId, eventType)
- User-related properties (owner, avatarUrl, assignedId, operatorName)
- Status-related properties (statusString, localMessageId, failedDetail)
- Additional data properties (contacts, messageProducts, orderProducts, interactiveData, orderDetailsViewModel)
- Reference properties (replySourceMessage, messageReferral, referenceOrderId)
This grouping can make it easier to understand and maintain the test event structure in the future.
components/wati/actions/add-contact/add-contact.mjs (2)
10-31: LGTM: Props are well-defined, with a minor suggestion.The properties for the action are correctly defined and align with the requirements for adding a contact to WATI. The use of
propDefinitionforwhatsappNumberandcustomParamspromotes consistency and reusability.Consider adding a brief description for the
customParamsprop to clarify its purpose and expected format for users.
32-52: LGTM: Run method implementation is solid, with suggestions for improvement.The run method correctly implements the logic for adding a contact to WATI, including proper error handling and success reporting.
Consider the following improvements:
- Add input validation for
whatsappNumberto ensure it's in the correct format before making the API call.- Use object destructuring for cleaner code in the customParams transformation:
customParams: this.customParams && Object.entries(this.customParams).map(([name, value]) => ({ name, value, })),- Consider adding more detailed error handling, possibly distinguishing between different types of errors (e.g., network errors, API errors) for better debugging.
components/wati/actions/send-template-message/send-template-message.mjs (2)
18-25: Consider adding validation for customParams.The
customParamsprop is well-defined, but it could benefit from additional validation or formatting guidelines to ensure users provide the correct structure for the template parameters.Consider adding a validation function or providing an example of the expected object structure in the description. For example:
customParams: { propDefinition: [ wati, "customParams", ], label: "Parameters", description: "An object with template's custom params. Example: { \"1\": \"John\", \"2\": \"Doe\" }", validate: (value) => { if (typeof value !== 'object' || Array.isArray(value)) { throw new Error("customParams must be an object"); } }, },
56-62: LGTM: Good error handling and response processing.The error handling and success message export are well implemented. Returning the full response is a good practice for flexibility.
Consider adding more detailed information to the success message, such as the template name used. For example:
$.export("$summary", `Successfully sent template message "${this.templateName}" to ${this.whatsappNumber}`);This provides more context in the action's execution summary.
components/wati/sources/new-contact-created/new-contact-created.mjs (1)
29-29: Ensureitem.wAidis defined ingetSummaryIn the
getSummarymethod,item.wAidmight beundefinedornull, which would result in a summary likeNew contact created: undefined. To prevent this, consider providing a default value or checking ifitem.wAidexists before including it in the summary.Apply this diff to provide a default value:
- return `New contact created: ${item.wAid}`; + const wAid = item.wAid || "unknown"; + return `New contact created: ${wAid}`;components/wati/actions/update-contact-attribute/update-contact-attribute.mjs (1)
45-46: Consider Adding Unit Tests for the ActionTo ensure reliability and facilitate future maintenance, consider adding unit tests for this action. This will help in verifying that all functionalities work as expected.
components/wati/wati.app.mjs (1)
112-139: Validate pagination logic inpaginatemethodThe pagination logic assigns
hasMore = data.length;and uses it in the loop condition. While this works, it's clearer to convert it to a boolean value.Apply this diff for clarity:
- hasMore = data.length; + hasMore = data.length > 0;
📜 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 (12)
- components/wati/.gitignore (0 hunks)
- components/wati/actions/add-contact/add-contact.mjs (1 hunks)
- components/wati/actions/send-template-message/send-template-message.mjs (1 hunks)
- components/wati/actions/update-contact-attribute/update-contact-attribute.mjs (1 hunks)
- components/wati/app/wati.app.ts (0 hunks)
- components/wati/package.json (1 hunks)
- components/wati/sources/common/base.mjs (1 hunks)
- components/wati/sources/new-contact-created/new-contact-created.mjs (1 hunks)
- components/wati/sources/new-contact-created/test-event.mjs (1 hunks)
- components/wati/sources/new-incoming-message/new-incoming-message.mjs (1 hunks)
- components/wati/sources/new-incoming-message/test-event.mjs (1 hunks)
- components/wati/wati.app.mjs (1 hunks)
💤 Files with no reviewable changes (2)
- components/wati/.gitignore
- components/wati/app/wati.app.ts
🧰 Additional context used
🔇 Additional comments (15)
components/wati/package.json (2)
3-3: Version update looks good.The version increment from 0.0.1 to 0.1.0 aligns with semantic versioning principles and reflects the addition of new features (components and actions) as described in the PR objectives.
1-18: Overall package.json changes align well with PR objectives.The updates to version, main entry point, and dependencies in this package.json file accurately reflect the addition of new WATI components and actions as described in the PR objectives. The changes follow good practices in terms of semantic versioning and dependency management.
To ensure all changes are properly reflected, run the following script:
#!/bin/bash # Description: Verify that all new components mentioned in the PR objectives are present in the codebase. echo "Checking for new WATI components:" fd --type f "wati.*\.(js|mjs|ts)" --exec echo "Found: {}" echo "Checking for specific new components mentioned in PR objectives:" rg --type js "new-contact-created-instant" rg --type js "new-incoming-message-instant" rg --type js "add-contact" rg --type js "send-template-message" rg --type js "update-contact-attribute"components/wati/sources/new-contact-created/test-event.mjs (1)
1-33: Overall structure looks good for testing purposes.The object structure provides a comprehensive representation of a contact entity, which is suitable for testing the new contact creation event. It includes a variety of data types and states (e.g., null values, booleans, arrays) that can help cover different scenarios in tests.
Consider improving property naming consistency.
For better code readability and maintenance, consider standardizing the property naming conventions. For example:
wAidcould be changed towaIdorwhatsappIdfor clarity.isInFlowfollows a different naming pattern compared to other boolean properties likeallowBroadcast. Consider using a consistent style across all boolean properties.Review the necessity of duplicated data in
customParams.The
customParamsarray contains information that is already present in the main object properties (name and phone). While this might be intentional for testing purposes, it's worth considering if this duplication is necessary or if it might lead to confusion in real-world scenarios.To check if this duplication is consistent across the codebase, you can run the following script:
#!/bin/bash # Description: Check for similar patterns of data duplication in custom parameters across the codebase. # Search for patterns where main object properties are duplicated in customParams rg --type javascript -e 'customParams.*name.*phone' -e 'customParams.*firstName.*phone'components/wati/actions/add-contact/add-contact.mjs (2)
1-9: LGTM: Imports and action definition are well-structured.The imports, action key, name, description, and version are correctly defined. The inclusion of the API documentation link in the description is a good practice for maintainability.
1-53: Overall assessment: Well-implemented action with minor improvement opportunities.This new "Add Contact" action for WATI is well-structured and aligns with the PR objectives. It correctly implements the functionality to add a new contact to the WATI platform using their API.
Key strengths:
- Proper use of Pipedream's action structure and best practices.
- Good error handling and success reporting.
- Flexible prop definitions allowing for optional parameters.
Areas for potential improvement:
- Input validation for the WhatsApp number.
- More detailed error handling for better debugging.
- Minor code readability enhancements.
These suggestions aside, the implementation is solid and ready for integration.
components/wati/actions/send-template-message/send-template-message.mjs (2)
1-9: LGTM: Imports and action metadata are well-defined.The imports are appropriate, and the action metadata provides clear information about the purpose and version of the action. Including the API documentation link in the description is a good practice.
38-44: LGTM: Run method initialization is well-structured.The async run method is correctly defined, and the initial structure of the API call looks appropriate. The use of destructuring for $ and the inclusion of whatsappNumber in the params object follow good practices for Pipedream actions.
components/wati/sources/new-contact-created/new-contact-created.mjs (1)
26-26: Verify thatthis.wati.listContactsis definedIn the
getFunctionmethod, you returnthis.wati.listContacts. Ensure thatthis.watiis properly initialized and thatlistContactsis a valid function to prevent runtime errors.Run the following script to verify the existence of
listContacts:components/wati/sources/new-incoming-message/new-incoming-message.mjs (2)
47-47: Confirm the correct property for message content ingetSummary().In the
getSummary()method,item.textis used to extract the message content. Ensure thatitem.textis the correct property from the API response for the message content. If the property is different (e.g.,messageorbody), update it accordingly.
14-19:⚠️ Potential issueVerify the correct usage of
propDefinitionforcontactId.In the
propssection, thecontactIdproperty usespropDefinitionwithcommon.props.watiand"contactId". Ensure thatcommon.props.waticontains the correct definition forcontactId. Misconfigurations here might lead to unexpected behavior when the component is used.components/wati/actions/update-contact-attribute/update-contact-attribute.mjs (3)
1-2: Module Imports are CorrectThe necessary modules are correctly imported, ensuring that the action has access to the required functionalities.
4-25: Action Metadata and Properties are Well-DefinedThe action is properly defined with accurate metadata:
- Key:
"wati-update-contact-attribute"- Name:
"Update Contact Attribute"- Description: Provides a clear explanation with a link to the documentation.
- Version and Type: Correctly specified.
The properties
whatsappNumberandcustomParamsare correctly defined usingpropDefinition, ensuring consistency and reusability.
26-46:runMethod Implementation is Efficient and CorrectThe
runmethod is well-implemented:
- API Call: Correctly invokes
updateContactAttributeswith the necessary parameters.- Data Transformation: Efficiently transforms
customParamsinto the required format for the API by mapping object entries to an array of{ name, value }objects.- Error Handling: Appropriately checks the
response.resultand throws aConfigurationErrorwithresponse.infoif the API indicates failure.- Success Message: Exports a clear summary message upon successful execution.
- Return Value: Returns the full response for further use.
components/wati/wati.app.mjs (2)
105-105: Ensure consistent parameter naming in API pathsIn the
updateContactAttributesmethod, consider verifying thatwhatsappNumberis the correct parameter used in the API endpoint. Depending on the API specification, it might be necessary to usecontactIdor another identifier.
89-89: Confirm correctness of API endpoint parametersIn the
addContactmethod, ensure that thewhatsappNumberparameter in the path is correctly formatted as per the API requirements. It should include the country code and may need validation.
There was a problem hiding this comment.
Actionable comments posted: 5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- components/wati/sources/common/base.mjs (1 hunks)
- components/wati/sources/new-contact-created/new-contact-created.mjs (1 hunks)
- components/wati/sources/new-incoming-message/new-incoming-message.mjs (1 hunks)
- components/wati/wati.app.mjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- components/wati/sources/common/base.mjs
🧰 Additional context used
🔇 Additional comments (13)
components/wati/sources/new-contact-created/new-contact-created.mjs (7)
1-2: LGTM: Import statements are appropriate.The import statements are correctly importing the necessary modules for this component.
4-11: LGTM: Exported object properties are well-defined.The exported object's properties are correctly defined and align with the PR objectives for implementing a new contact created webhook source. The version, type, and dedupe settings are appropriate for this new component.
14-21: LGTM: getPaginateOpts method is well-implemented.The getPaginateOpts method correctly defines the pagination options for listing contacts. It properly uses the maxResults parameter and specifies the relevant fields for pagination.
22-24: LGTM: getDateField method is correctly implemented.The getDateField method correctly returns the "created" field, which is appropriate for date-based operations in this context.
28-30: LGTM: getSummary method is correctly implemented.The getSummary method appropriately generates a summary string for the new contact, using the wAid property as expected.
32-32: LGTM: sampleEmit property is correctly set.The sampleEmit property is appropriately set to the imported value, which is likely used for testing or documentation purposes.
25-27:⚠️ Potential issueHandle potential
NaNresults fromDate.parseThe
checkBreakmethod still doesn't handle potentialNaNresults fromDate.parse(item.created). This issue was previously identified and should be addressed to prevent unexpected behavior.Please refer to the previous comment and consider implementing the suggested fix:
- return Date.parse(item.created) < lastDate; + const itemDate = Date.parse(item.created); + if (isNaN(itemDate)) { + // Handle invalid date + return false; // Adjust based on desired behavior + } + return itemDate < lastDate;components/wati/sources/new-incoming-message/new-incoming-message.mjs (5)
1-11: LGTM: Component definition and imports look good.The component definition is well-structured with appropriate imports, key, name, description, version, type, and deduplication strategy. The use of "unique" for deduplication is suitable for handling incoming messages.
12-20: LGTM: Props definition is correct and well-structured.The component correctly extends common props and adds a specific "contactId" prop using the propDefinition from the wati common props. This approach maintains consistency and provides the necessary customization for this component.
51-52: LGTM: Sample emit export is correctly implemented.The inclusion of a
sampleEmitproperty, imported from "test-event.mjs", is a good practice for testing and documentation purposes. This will help developers understand the expected event format and facilitate testing of the component.
44-46:⚠️ Potential issueHandle invalid or missing
item.timestampincheckBreak().The method
Date.parse(item.timestamp)assumes thatitem.timestampis a valid date string. Ifitem.timestampis undefined or invalid,Date.parse()will returnNaN, causing the comparison to fail. Add a check to handle such cases gracefully.Apply this diff to handle invalid timestamps:
checkBreak(item, lastDate) { - return Date.parse(item.timestamp) < lastDate; + const timestamp = Date.parse(item.timestamp); + return !isNaN(timestamp) && timestamp < lastDate; }Likely invalid or redundant comment.
23-32:⚠️ Potential issueNormalize
contactIdto prevent duplicate '+' signs inwhatsappNumber.When constructing
whatsappNumberingetPaginateOpts(), the code prepends a '+' tothis.contactId. Ifthis.contactIdalready includes a '+', this will result in '++', which might cause API errors. Consider normalizingcontactIdto ensure it doesn't already include the '+' sign.Apply this diff to normalize
contactId:return { fn: this.wati.listContactMessages, - whatsappNumber: `+${this.contactId}`, + whatsappNumber: `${this.contactId.startsWith('+') ? '' : '+'}${this.contactId}`, itemsField: [ "messages", ], optsField: "params", };Likely invalid or redundant comment.
components/wati/wati.app.mjs (1)
1-5: LGTM: Imports and module definitionThe import statement and module definition are correct and follow Pipedream platform conventions.
|
/approve |
Resolves #13213.
Summary by CodeRabbit
New Features
Improvements
Version Update