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

feat(web): Auto open livechat if query param present #17223

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Dec 13, 2024

Auto open livechat if query param present

What

For the IBM Watson web chat we've got a way so that it auto opens if wa_lid=t10|t11 is present in the url. Here we are adding similar functionality for livechat

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced control over the initialization of the chat widget based on specific URL query parameters.
  • Bug Fixes

    • Improved logic to prevent widget initialization under certain conditions, ensuring a more streamlined user experience.

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Dec 13, 2024
@RunarVestmann RunarVestmann requested a review from a team as a code owner December 13, 2024 10:20
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

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.

warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning jest > @jest/core > jest-config > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-runtime > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > tempy > del > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning react-native > @react-native/codegen > [email protected]: Glob versions prior to v9 are no longer supported
warning react-native > @react-native/community-cli-plugin > [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning react-native > @react-native/community-cli-plugin > @react-native/dev-middleware > @rnx-kit/chromium-edge-launcher > [email protected]: Rimraf versions prior to v4 are no longer supported
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-numeric-separator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-catch-binding instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-logical-assignment-operators instead.
warning next-auth > [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning next-auth > [email protected]: this version is no longer supported
warning next-auth > @next-auth/typeorm-legacy-adapter > typeorm > [email protected]: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > stylus > [email protected]: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > webpack-dev-server > [email protected]: Rimraf versions prior to v4 are no longer supported
warning @nx/next > @nx/webpack > fork-ts-checker-webpack-plugin > [email protected]: this will be v4
warning @nx/next > @nx/webpack > webpack-dev-server > webpack-dev-middleware > [email protected]: this will be v4
warning workspace-aggregator-60f23b17-58cc-4445-bb7a-b24613bfa3c3 > [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.

Walkthrough

The changes in this pull request modify the LiveChatIncChatPanel component by updating the logic within the useEffect hook. A new variable, queryParam, is introduced to extract the wa_lid query parameter from the URL. The initialization of the chat widget is now contingent on the values of hasButtonBeenClicked, showLauncher, and queryParam, preventing the widget from initializing under certain conditions.

Changes

File Change Summary
apps/web/components/ChatPanel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx Modified useEffect to include queryParam for widget initialization logic based on URL parameters.

Possibly related PRs

Suggested reviewers

  • mannipje

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>, 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. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

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.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 13, 2024

Datadog Report

Branch report: feature/web-livechat-auto-open
Commit report: f3d9c30
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 24.72s Total Time
➡️ Test Sessions change in coverage: 1 no change

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: 1

🧹 Outside diff range and nitpick comments (2)
apps/web/components/ChatPanel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx (2)

41-46: Refactor complex condition for better readability

The current condition is complex and uses double negation. Consider extracting the logic into a more readable form.

-    const queryParam = new URLSearchParams(window.location.search).get('wa_lid')
-    if (
-      !hasButtonBeenClicked &&
-      !showLauncher &&
-      !(queryParam && ['t10', 't11'].includes(queryParam))
-    ) {
+    const queryParam = new URLSearchParams(window.location.search).get('wa_lid')
+    const shouldAutoOpenChat = queryParam && ['t10', 't11'].includes(queryParam)
+    const shouldInitializeWidget = hasButtonBeenClicked || showLauncher || shouldAutoOpenChat
+    
+    if (!shouldInitializeWidget) {

41-46: Add TypeScript type safety for query parameter values

Define a type for the allowed query parameter values to ensure type safety throughout the component.

+type AutoOpenQueryValue = 't10' | 't11'
+const AUTO_OPEN_VALUES: AutoOpenQueryValue[] = ['t10', 't11']
+
 export const LiveChatIncChatPanel = ({
   license,
   group,
   showLauncher,
   pushUp,
 }: LiveChatIncChatPanelProps) => {

Then use these types in the condition:

-    !(queryParam && ['t10', 't11'].includes(queryParam))
+    !(queryParam && AUTO_OPEN_VALUES.includes(queryParam as AutoOpenQueryValue))
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3719969 and 005cc4c.

📒 Files selected for processing (1)
  • apps/web/components/ChatPanel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/components/ChatPanel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (1)
apps/web/components/ChatPanel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx (1)

41-46: Verify the query parameter handling

Let's verify that the query parameter handling works as expected across different pages and routing scenarios.

✅ Verification successful

Let me generate another script to check for the specific usage pattern and context around the wa_lid parameter.


Query parameter handling is consistent and properly implemented

The verification shows that the wa_lid parameter is consistently handled across chat components (LiveChatIncChatPanel and WatsonChatPanel) and is used as intended for specific chat functionality. The parameter is used to:

  • Control chat visibility based on specific link IDs ('t10', 't11')
  • Configure page link behavior in Watson chat
  • Handle chat initialization in the Utlendingastofnun theme

The implementation in LiveChatIncChatPanel.tsx aligns with these established patterns and follows the same URL parameter handling approach used throughout the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent query parameter handling across the codebase

# Check if the query parameter is used elsewhere
echo "Checking for other uses of wa_lid parameter:"
rg -l "wa_lid" --type ts --type tsx

# Check for other URL parameter handling patterns
echo "Checking for other URL parameter handling patterns:"
ast-grep --pattern 'new URLSearchParams($$$)'

Length of output: 16017


Script:

#!/bin/bash
# Check for the specific pattern of wa_lid usage with context
echo "Checking wa_lid usage patterns with context:"
rg "wa_lid" -B 2 -A 2 --type-add "tsx:*.tsx" --type tsx

# Check for any test files related to these components
echo -e "\nChecking for related test files:"
fd "LiveChatIncChatPanel|WatsonChatPanel" -e test.tsx -e spec.tsx

Length of output: 2582

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 35.75%. Comparing base (c13fd91) to head (918623f).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...anel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx 0.00% 5 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17223   +/-   ##
=======================================
  Coverage   35.74%   35.75%           
=======================================
  Files        6937     6935    -2     
  Lines      148167   148115   -52     
  Branches    42250    42236   -14     
=======================================
- Hits        52969    52952   -17     
+ Misses      95198    95163   -35     
Flag Coverage Δ
web 2.42% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...anel/LiveChatIncChatPanel/LiveChatIncChatPanel.tsx 0.00% <0.00%> (ø)

... and 7 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c13fd91...918623f. Read the comment docs.

@kodiakhq kodiakhq bot merged commit 231b35f into main Dec 13, 2024
34 checks passed
@kodiakhq kodiakhq bot deleted the feature/web-livechat-auto-open branch December 13, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants