Skip to content

chore(e2e): Fix flaky tests for multi-session with tasks #6306

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

Merged
merged 2 commits into from
Jul 14, 2025

Conversation

LauraBeatris
Copy link
Member

@LauraBeatris LauraBeatris commented Jul 14, 2025

Description

This PR temporarily skips the multi-session test for Next.js 14. I don't know the root cause yet, due to not having been able to run Cypress locally with debug mode against Next.js 14.

We made tests on a Next.js 14 app using the latest @clerk/nextjs and the feature works correctly.

For Next.js 15: Tests were flaky before due to a race condition where we were awaiting for the SignIn component to be mounted, by the time the client-side navigation to the/tasks route was happening.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Tests
    • Improved reliability of session-switching navigation tests by adding explicit waits for UI state and navigation changes.
    • Activated a previously skipped test with adjustments for compatibility across different Next.js versions.

@LauraBeatris LauraBeatris self-assigned this Jul 14, 2025
Copy link

changeset-bot bot commented Jul 14, 2025

⚠️ No Changeset found

Latest commit: 54c0f69

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jul 14, 2025

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

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 14, 2025 7:33pm

@LauraBeatris LauraBeatris marked this pull request as ready for review July 14, 2025 12:48
@LauraBeatris LauraBeatris force-pushed the laura/fix-flaky-tests-tasks-multi-session branch 2 times, most recently from 4b6bf18 to 7eb1978 Compare July 14, 2025 12:49
Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

📝 Walkthrough

Walkthrough

The test "when switching sessions, navigate to task" in the integration test suite was unskipped and refactored from an afterEach hook to a standalone test. The test now includes a conditional skip for Next.js version 14. Additional synchronization steps were added: after switching user accounts, the test waits for the user button popover to close, waits for the sign-in component to mount, and ensures the page URL matches a task-related pattern before proceeding. The test concludes by signing out and clearing cookies. No changes were made to exported or public entity declarations.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 88af358 and 54c0f69.

📒 Files selected for processing (1)
  • integration/tests/session-tasks-multi-session.test.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • integration/tests/session-tasks-multi-session.test.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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 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
Contributor

coderabbitai bot commented Jul 14, 2025

Caution

Review failed

The head commit changed during the review from b951a1a to 7eb1978.


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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 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

pkg-pr-new bot commented Jul 14, 2025

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6306

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6306

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6306

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6306

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6306

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6306

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6306

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6306

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6306

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6306

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6306

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6306

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6306

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6306

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6306

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6306

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6306

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6306

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6306

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6306

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6306

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6306

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6306

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6306

commit: 54c0f69

@LauraBeatris
Copy link
Member Author

The multi-session test is failing on Next.js 14 inconsistently. I'm not sure if this is related with server-state.

I'm struggling to get it running locally with the E2E pointing to Next.js 14 so I'll link the app-router playground and try to reproduce any bug related to it, otherwise, might be some race condition on the assertions still.

@LauraBeatris LauraBeatris force-pushed the laura/fix-flaky-tests-tasks-multi-session branch from 7eb1978 to fd40f3b Compare July 14, 2025 17:17
@LauraBeatris LauraBeatris force-pushed the laura/fix-flaky-tests-tasks-multi-session branch 2 times, most recently from 947ac11 to e412dc7 Compare July 14, 2025 18:02
@LauraBeatris
Copy link
Member Author

I'm running after-auth with multi-session on an app running Next.js 14.2.25 and @clerk/nextjs 6.24.0, it's working just fine...

I still couldn't run Cypress with the debug mode to see why the assertions are failing to navigate to tasks on 14.

@LauraBeatris LauraBeatris force-pushed the laura/fix-flaky-tests-tasks-multi-session branch from 88af358 to 54c0f69 Compare July 14, 2025 19:32
@LauraBeatris LauraBeatris merged commit 53983db into main Jul 14, 2025
65 of 66 checks passed
@LauraBeatris LauraBeatris deleted the laura/fix-flaky-tests-tasks-multi-session branch July 14, 2025 19:53
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.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy