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

Mava customer support #1734

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Mava customer support #1734

wants to merge 1 commit into from

Conversation

jaybuidl
Copy link
Member

@jaybuidl jaybuidl commented Nov 4, 2024

PR-Codex overview

This PR introduces user identification and integration with the Mava widget in the AtlasProvider, along with minor adjustments in the index.html file to include the Mava script.

Detailed summary

  • In web/src/context/AtlasProvider.tsx:
    • Added user identification with Mava if the user is verified and has an email.
  • In web/src/index.html:
    • Added a <script> tag to include the Mava widget.
    • Updated the <meta> tag for keywords to a self-closing format.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features

    • Enhanced user tracking by integrating with the Mava service, allowing identification via email and wallet address.
    • Added Mava Web Chat widget to the application for improved user interaction.
  • Bug Fixes

    • Improved error handling to accurately reflect user verification state during authentication errors.
  • Chores

    • Removed unnecessary <meta> tag for keywords in the HTML document.

Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes in this pull request involve modifications to the AtlasProvider component and the index.html file. In AtlasProvider, logic was added to the fetchUser function to initialize the Mava service after user data retrieval, enhancing user tracking. Additionally, error handling was improved to correctly set the isVerified state during authentication errors. In index.html, a <meta> tag was removed, and a new <script> tag was added to include the Mava Web Chat widget, consolidating its attributes for configuration.

Changes

File Change Summary
web/src/context/AtlasProvider.tsx - Added logic in fetchUser to initialize Mava service with user email and wallet address.
- Updated error handling in fetchWithAuthErrorHandling to set isVerified to false on specific errors.
web/src/index.html - Removed <meta> tag for keywords.
- Added <script> tag for Mava Web Chat widget with various attributes.

Possibly related PRs

Suggested labels

Type: Enhancement :sparkles:, Package: Web

Suggested reviewers

  • alcercu
  • fcanela

Poem

In the land of code, where rabbits play,
New features hop in, brightening the day.
With Mava's charm, we fetch with delight,
Errors managed well, everything feels right.
So here’s to the changes, a joyful cheer,
For a smoother experience, we hold dear! 🐇✨


🪧 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 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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

netlify bot commented Nov 4, 2024

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit de304f3
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/6728f87545bd4900080044e3
😎 Deploy Preview https://deploy-preview-1734--kleros-v2-testnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit de304f3
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/6728f87545bd4900080044e7
😎 Deploy Preview https://deploy-preview-1734--kleros-v2-neo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for kleros-v2-university ready!

Name Link
🔨 Latest commit de304f3
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/6728f875a1bc310008bf643b
😎 Deploy Preview https://deploy-preview-1734--kleros-v2-university.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codeclimate bot commented Nov 4, 2024

Code Climate has analyzed commit de304f3 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category Count
Style 1

View more on Code Climate.

Copy link

sonarcloud bot commented Nov 4, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarCloud

Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for kleros-v2-testnet-devtools ready!

Name Link
🔨 Latest commit de304f3
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/6728f87576fe9e00088f36e9
😎 Deploy Preview https://deploy-preview-1734--kleros-v2-testnet-devtools.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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

🧹 Outside diff range and nitpick comments (1)
web/src/context/AtlasProvider.tsx (1)

138-142: Improve testability by abstracting Mava integration.

Direct usage of window.Mava makes the code harder to test and maintain.

Consider creating a service layer:

// services/mava.ts
export interface MavaService {
  initialize(): void;
  identifyUser(email: string, walletAddress: string): void;
}

export class MavaServiceImpl implements MavaService {
  private initialized = false;

  initialize(): void {
    if (!window.Mava || this.initialized) return;
    
    try {
      window.Mava.initialize();
      this.initialized = true;
    } catch (error) {
      console.error('Failed to initialize Mava:', error);
    }
  }

  identifyUser(email: string, walletAddress: string): void {
    if (!window.Mava || !this.initialized) return;
    
    try {
      window.Mava.identify({ 
        emailAddress: email,
        customAttributes: [{ label: "Wallet Address", value: walletAddress }]
      });
    } catch (error) {
      console.error('Failed to identify user in Mava:', error);
    }
  }
}

This allows for:

  1. Better testing through dependency injection
  2. Centralized error handling
  3. Single responsibility principle
  4. Easy mocking in tests
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b6b7c17 and de304f3.

📒 Files selected for processing (2)
  • web/src/context/AtlasProvider.tsx (1 hunks)
  • web/src/index.html (1 hunks)
🧰 Additional context used
🪛 Gitleaks
web/src/index.html

19-19: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (3)
web/src/index.html (2)

10-10: LGTM! Good cleanup.

Removing the keywords meta tag is appropriate as it's no longer relevant for SEO purposes.


13-20: Verify Mava widget configuration

The script configuration looks standard, but please verify:

  1. Is "v2" the latest stable version of the widget?
  2. Are there any recommended CSP (Content Security Policy) headers we should add for mava.app?
  3. Does the widget require any additional configuration for error tracking or analytics?

Let's check the current CSP configuration:

🧰 Tools
🪛 Gitleaks

19-19: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

web/src/context/AtlasProvider.tsx (1)

138-142: Consider privacy implications of sharing PII with Mava.

The code shares user email and wallet address with a third-party service without explicit user consent.

Let's check if there's a privacy policy or consent mechanism in place:

Consider:

  1. Adding a user consent mechanism before initializing Mava
  2. Documenting data sharing in the privacy policy
  3. Implementing a data deletion mechanism for GDPR compliance

widget-version="v2"
id="MavaWebChat"
enable-sdk="true"
data-token="1fea31aa0b93836faca36269f324468e08cc26f0298f8d8e6c5b089d0d58eb1c"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Security concern: Exposed API token

The Mava token is currently exposed in the HTML source, making it visible to anyone who views the page source. If this token provides access to sensitive operations or customer data, it should be handled more securely.

Consider:

  1. Using environment variables and server-side injection of the token
  2. Implementing token rotation mechanisms
  3. Adding appropriate CORS and domain restrictions in the Mava dashboard

Would you like assistance in implementing a more secure token handling solution?

🧰 Tools
🪛 Gitleaks

19-19: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

Comment on lines +138 to +142
if (user?.email && window.Mava) {
window.Mava.initialize();
window.Mava.identify({ emailAddress: user.email });
window.Mava.identify({ customAttributes: [{ label: "Wallet Address", value: address }] });
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add type safety for window.Mava integration.

The code assumes window.Mava is globally available without proper TypeScript declarations. This could lead to runtime errors.

Add a type declaration file (e.g., mava.d.ts):

interface MavaIdentifyOptions {
  emailAddress?: string;
  customAttributes?: Array<{
    label: string;
    value: string;
  }>;
}

interface MavaSDK {
  initialize(): void;
  identify(options: MavaIdentifyOptions): void;
}

declare global {
  interface Window {
    Mava?: MavaSDK;
  }
}

⚠️ Potential issue

Add error handling for Mava initialization.

The Mava integration lacks error handling which could cause silent failures.

Consider wrapping the Mava calls in a try-catch:

-        if (user?.email && window.Mava) {
-          window.Mava.initialize();
-          window.Mava.identify({ emailAddress: user.email });
-          window.Mava.identify({ customAttributes: [{ label: "Wallet Address", value: address }] });
-        }
+        if (user?.email && window.Mava) {
+          try {
+            window.Mava.initialize();
+            window.Mava.identify({ 
+              emailAddress: user.email,
+              customAttributes: [{ label: "Wallet Address", value: address }]
+            });
+          } catch (error) {
+            console.error('Failed to initialize Mava:', error);
+          }
+        }
📝 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.

Suggested change
if (user?.email && window.Mava) {
window.Mava.initialize();
window.Mava.identify({ emailAddress: user.email });
window.Mava.identify({ customAttributes: [{ label: "Wallet Address", value: address }] });
}
if (user?.email && window.Mava) {
try {
window.Mava.initialize();
window.Mava.identify({
emailAddress: user.email,
customAttributes: [{ label: "Wallet Address", value: address }]
});
} catch (error) {
console.error('Failed to initialize Mava:', error);
}
}

🛠️ Refactor suggestion

Optimize Mava initialization.

Currently, Mava is initialized on every user fetch, which might be inefficient.

Consider moving the initialization to a more appropriate lifecycle:

+  // Track if Mava has been initialized
+  const [isMavaInitialized, setIsMavaInitialized] = useState(false);
+
+  // Initialize Mava once when the component mounts
+  useEffect(() => {
+    if (window.Mava && !isMavaInitialized) {
+      try {
+        window.Mava.initialize();
+        setIsMavaInitialized(true);
+      } catch (error) {
+        console.error('Failed to initialize Mava:', error);
+      }
+    }
+  }, [isMavaInitialized]);

   const {
     data: user,
     isLoading: isFetchingUser,
     refetch: refetchUser,
   } = useQuery({
     queryKey: [`UserSettings`],
     enabled: isVerified && !isUndefined(address),
     queryFn: async () => {
       try {
         if (!isVerified || isUndefined(address)) return undefined;
         const user = await fetchUser(atlasGqlClient);
 
-        if (user?.email && window.Mava) {
-          window.Mava.initialize();
+        if (user?.email && window.Mava && isMavaInitialized) {
           window.Mava.identify({ 
             emailAddress: user.email,
             customAttributes: [{ label: "Wallet Address", value: address }]
           });
         }
 
         return user;
📝 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.

Suggested change
if (user?.email && window.Mava) {
window.Mava.initialize();
window.Mava.identify({ emailAddress: user.email });
window.Mava.identify({ customAttributes: [{ label: "Wallet Address", value: address }] });
}
// Track if Mava has been initialized
const [isMavaInitialized, setIsMavaInitialized] = useState(false);
// Initialize Mava once when the component mounts
useEffect(() => {
if (window.Mava && !isMavaInitialized) {
try {
window.Mava.initialize();
setIsMavaInitialized(true);
} catch (error) {
console.error('Failed to initialize Mava:', error);
}
}
}, [isMavaInitialized]);
const {
data: user,
isLoading: isFetchingUser,
refetch: refetchUser,
} = useQuery({
queryKey: [`UserSettings`],
enabled: isVerified && !isUndefined(address),
queryFn: async () => {
try {
if (!isVerified || isUndefined(address)) return undefined;
const user = await fetchUser(atlasGqlClient);
if (user?.email && window.Mava && isMavaInitialized) {
window.Mava.identify({
emailAddress: user.email,
customAttributes: [{ label: "Wallet Address", value: address }]
});
}
return user;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant