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

Google analytics functionality for analytics platform #2528

Merged
merged 2 commits into from
Feb 25, 2025

Conversation

Codebmk
Copy link
Member

@Codebmk Codebmk commented Feb 25, 2025

This pull request introduces several changes to the src/platform directory, primarily focused on adding Google authentication and improving user session handling. The most important changes include adding new dependencies, updating the Home page to handle Google redirects, and modifying the login page to include a Google login button.

Authentication and Session Management:

Login Page Enhancements:

Copy link

coderabbitai bot commented Feb 25, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a new dependency, js-cookie, to support cookie management in the application. Additionally, it updates the Home page to include cookie handling, token decoding, retry logic for API calls, and encapsulated session setup logic using Redux actions. The login page has been enhanced with a Google login feature, adding a new button that redirects users to the Google authentication URL while providing error logging.

Changes

File(s) Change Summary
src/platform/package.json Added new dependency "js-cookie": "^3.0.5" for cookie management.
src/platform/src/pages/Home/index.jsx Added imports for cookie handling (Cookies), token decoding (jwt_decode), routing (useRouter), Redux actions, and API calls; defined constants (MAX_RETRIES, RETRY_DELAY); introduced a loading state; implemented retryWithDelay for rate limiting; refactored setupUserSession and updated useEffect.
src/platform/src/pages/account/login/index.jsx Imported GOOGLE_AUTH_URL and added a new asynchronous function handleGoogleLogin to manage Google authentication. Introduced a new Google login button in the JSX with conditional rendering for loading states and error logging.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LoginPage
    participant GoogleAuth
    participant HomePage
    participant API

    User->>LoginPage: Click "Login with Google" button
    LoginPage->>User: Redirect to GoogleAuth URL

    Note over User: User authenticates with Google

    GoogleAuth->>User: Redirect back with token cookie
    User->>HomePage: Loads Home page with cookie
    HomePage->>Cookies: Retrieve token cookie
    HomePage->>jwt_decode: Decode token
    HomePage->>API: Request user details
    API-->>HomePage: Return user data or error (429)
    alt On 429 Rate Limit Error
      HomePage->>HomePage: Execute retryWithDelay logic
      HomePage->>API: Retry API call
    end
    HomePage->>Redux: Dispatch setUserInfo & setSuccess
Loading

Suggested labels

ready for review

Suggested reviewers

  • OchiengPaul442
  • Baalmart

Poem

In lines of code, a breeze so light,
Cookies and tokens take their flight.
Google logins now clear the way,
Retries ensure that errors sway.
Cheers to our change—a coding delight!
🚀 Happy coding, day and night!

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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. (Beta)
  • @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

@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

🧹 Nitpick comments (4)
src/platform/src/pages/account/login/index.jsx (2)

114-121: Add user-facing error feedback.
The handleGoogleLogin function handles errors via console logging, but you might want to show a user-friendly message in case of failure to improve the user experience.


196-207: Consistent button styling and accessibility.
The new "Login with Google" button is straightforward. Confirm that styles match your brand's accessibility guidelines, and consider adding an aria-label for improved screen reader support.

src/platform/src/pages/Home/index.jsx (2)

30-31: Use environment variables for retry constants.
Storing MAX_RETRIES and RETRY_DELAY in environment variables or a config file would allow easy adjustments without redeploying.


103-113: Consider exponential backoff.
retryWithDelay is helpful, but for efficiency and to avoid server strain, consider an exponential backoff strategy rather than a fixed RETRY_DELAY.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7a7ee4 and ee0e231.

⛔ Files ignored due to path filters (1)
  • src/platform/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (3)
  • src/platform/package.json (1 hunks)
  • src/platform/src/pages/Home/index.jsx (3 hunks)
  • src/platform/src/pages/account/login/index.jsx (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test-analytics-platform-changes
  • GitHub Check: build-push-deploy-analytics-platform-preview
  • GitHub Check: check for changes in netmanager
🔇 Additional comments (8)
src/platform/package.json (1)

33-33: Confirm version stability and vulnerability status.
Adding "js-cookie" is beneficial for cookie management, but remember to confirm the version's security posture before deploying.

Do you want to run a vulnerability check or is that handled in your pipeline?

src/platform/src/pages/account/login/index.jsx (1)

21-21: Check environment-based URL usage.
Ensure GOOGLE_AUTH_URL is configured properly. If it often changes, consider storing it in an environment variable or config file for easier maintenance.

src/platform/src/pages/Home/index.jsx (6)

20-28: Consolidate new imports.
Make sure all newly imported modules (Cookies, jwt_decode, useRouter, and Redux actions) are declared in your dependencies and used consistently. Watch out for potential SSR pitfalls with window or document.


75-75: Routing approach looks fine.
Using useRouter() is standard, but be cautious if any SSR logic calls it at build time in Next.js.


83-83: Good practice for loading states.
Setting a dedicated loading state is a clean approach to handle async events and provide user feedback.


115-139: Validate user group presence more robustly.
setupUserSession presumes the first group is valid. If there's a scenario with empty or missing groups, handle it gracefully to avoid potential runtime errors.


141-174: Check Google redirect flow.
The logic for retrieving and validating cookies, then decoding tokens, is correct. However, confirm that your server sets the access_token cookie securely (e.g., HttpOnly) to mitigate security risks.


175-177: Neat loading state fallback.
Rendering HomeSkeleton during loading keeps the UI consistent and improves perceived performance.

Copy link
Contributor

New next-platform changes available for preview here

@Baalmart Baalmart merged commit a69774f into staging Feb 25, 2025
28 of 29 checks passed
@Baalmart Baalmart deleted the feat-google-login branch February 25, 2025 12:13
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.

2 participants