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

chore(testing): Add experimental console warning on Cypress setup #3395

Conversation

anagstef
Copy link
Member

Description

This PR adds the following console message on the node process that runs the clerkSetup function from @clerk/testing/cypress:

@clerk/testing: Cypress is an experimental project and subject to change in the future.

Checklist

  • npm test runs as expected.
  • npm run 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:

@anagstef anagstef self-assigned this May 16, 2024
Copy link

changeset-bot bot commented May 16, 2024

🦋 Changeset detected

Latest commit: 3a21c15

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@clerk/testing Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Member

@panteliselef panteliselef left a comment

Choose a reason for hiding this comment

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

I am fine with this, but why didn't we lunch this in @clerk/testing/experimental/cypress ?

@anagstef
Copy link
Member Author

anagstef commented May 16, 2024

I am fine with this, but why didn't we lunch this in @clerk/testing/experimental/cypress?

@panteliselef it's a bit complicated. The actual package is not experimental, the Clerk + Cypress integration is.
The log will be easily removed when we validate it's fully supported.

@panteliselef
Copy link
Member

@anagstef
an idea would be to have both

  • @clerk/testing/experimental/cypress
  • @clerk/testing/playwrite

Just because i think warning in tests are usually overlooked

Copy link
Member

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

Let's add a note about this to the README, too

packages/testing/src/cypress/setup.ts Outdated Show resolved Hide resolved
@anagstef anagstef requested a review from LekoArts May 17, 2024 09:39
@anagstef
Copy link
Member Author

@anagstef an idea would be to have both

  • @clerk/testing/experimental/cypress
  • @clerk/testing/playwrite

Just because i think warning in tests are usually overlooked

@panteliselef The point I was trying to make is that when we fully support Cypress, no actions will be needed for this package. This package just implements testing tokens, which works as expected. This warning is just informative about the Cypress support in general.

packages/testing/src/cypress/setup.ts Outdated Show resolved Hide resolved
packages/testing/README.md Outdated Show resolved Hide resolved
@LekoArts LekoArts dismissed their stale review May 17, 2024 11:42

Addressed

anagstef and others added 3 commits May 17, 2024 15:00
Co-authored-by: Lennart <lekoarts@gmail.com>
Co-authored-by: Lennart <lekoarts@gmail.com>
@LekoArts LekoArts merged commit ff52e79 into main May 17, 2024
10 checks passed
@LekoArts LekoArts deleted the stefanos/core-2312-add-console-warning-inside-the-clerktesting-package branch May 17, 2024 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants