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

Zoho Survey - Update per feedback from their team #12457

Merged
merged 6 commits into from
Jun 21, 2024
Merged

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Jun 17, 2024

Resolves #12438

Summary by CodeRabbit

  • New Features

    • Enhanced survey response processing to decode HTML entities in labels, improving the readability of survey results.
  • Bug Fixes

    • Improved handling of response IDs for better accuracy in tracking survey responses.
  • Chores

    • Updated versions for components and added a new dependency (html-entities-decoder) for enhanced label processing.

Copy link

vercel bot commented Jun 17, 2024

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

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 20, 2024 2:40am
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
pipedream-docs ⬜️ Ignored (Inspect) Jun 20, 2024 2:40am
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 20, 2024 2:40am

Copy link
Contributor

coderabbitai bot commented Jun 17, 2024

Walkthrough

The recent updates to the Zoho Survey component include a version upgrade, handling of HTML entity decoding, improved response ID management, enhanced label processing using the html-entities-decoder library, and the utilization of survey field "key" instead of "label" for better stability.

Changes

File/Directory Change Summary
`components/zoho_survey/actions/send-email-invitation/... Version updated from "0.0.2" to "0.0.3".
components/zoho_survey/package.json Version updated from "0.1.1" to "0.1.2". Added dependency on "html-entities-decoder": "^1.0.5".
components/zoho_survey/sources/new-survey-response/... Updated version, improved response ID handling, enhanced label processing, refined variable extraction.
components/zoho_survey/zoho_survey.app.mjs Added html-entities-decoder to decode HTML entities in labels.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ZohoSurveyApp
    participant HTMLEntitiesDecoder
    User ->> ZohoSurveyApp: Requests new survey response
    ZohoSurveyApp ->> HTMLEntitiesDecoder: Decode labels
    HTMLEntitiesDecoder -->> ZohoSurveyApp: Decoded labels
    ZohoSurveyApp -->> User: Returns decoded survey data
Loading

Assessment against linked issues

Objective Addressed Explanation
An extra field "Others" is displayed for every survey event (12438) Unclear if this objective was addressed. No specific changes mentioned.
Decode HTML entities in all API responses such as portal list, survey list, etc. (12438)
Process events based on the "key" using the "Get survey fields/variables" API (12438)

Poem

In the field of code so bright,
Updates bring new features to light.
Zoho Surveys now refined,
With keys in mind, stability you'll find.
Labels decoded, HTML entities freed,
Enhanced responses, just what you need!


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c40f0cd and efc0764.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (4)
  • components/zoho_survey/actions/send-email-invitation/send-email-invitation.mjs (1 hunks)
  • components/zoho_survey/package.json (2 hunks)
  • components/zoho_survey/sources/new-survey-response/new-survey-response.mjs (4 hunks)
  • components/zoho_survey/zoho_survey.app.mjs (6 hunks)
Files skipped from review due to trivial changes (2)
  • components/zoho_survey/actions/send-email-invitation/send-email-invitation.mjs
  • components/zoho_survey/package.json
Additional comments not posted (7)
components/zoho_survey/sources/new-survey-response/new-survey-response.mjs (5)

2-2: Added import of html-entities-decoder.

This is in line with the PR's objective to decode HTML entities in API responses.


10-10: Version updated from "0.0.2" to "0.0.3".

This reflects the functional enhancements made in this update.


21-22: Updated the handling of RESPONSE_ID for consistency.

Ensure that all references to Response ID in your project are updated to RESPONSE_ID to maintain consistency.


32-32: Enhanced label processing by incorporating both key and label in collectFieldLabels.

This change supports the more robust handling of survey fields as outlined in the PR objectives.


47-72: Decoding HTML entities in labels and values to ensure proper display of characters.

This change is crucial for correctly displaying characters that might otherwise be misinterpreted by HTML.

components/zoho_survey/zoho_survey.app.mjs (2)

2-2: Import added for html-entities-decoder.

This supports the functionality to decode HTML entities across the application.


19-19: Decoded labels in various properties to handle HTML entities correctly.

This ensures that all labels displayed in the UI are correctly processed to show meaningful characters instead of HTML codes.

Also applies to: 34-34, 60-60, 80-80, 104-104

luancazarine
luancazarine previously approved these changes Jun 18, 2024
Copy link
Collaborator

@luancazarine luancazarine 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, thanks for your contribution! LGTM!

Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between efc0764 and ae92ef4.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (1)
  • components/zoho_survey/sources/new-survey-response/new-survey-response.mjs (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • components/zoho_survey/sources/new-survey-response/new-survey-response.mjs

Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ae92ef4 and a5e3673.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (1)
  • components/zoho_survey/sources/new-survey-response/new-survey-response.mjs (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • components/zoho_survey/sources/new-survey-response/new-survey-response.mjs

@michelle0927
Copy link
Collaborator Author

/approve

@michelle0927 michelle0927 merged commit 18907e1 into master Jun 21, 2024
11 checks passed
@michelle0927 michelle0927 deleted the issue-12438 branch June 21, 2024 18:45
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.

[FEATURE] Update Zoho Survey per feedback from their team
2 participants