Skip to content

Commit

Permalink
fix: cypress component testing - fixes #50283 (#50303)
Browse files Browse the repository at this point in the history
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation or adding/fixing Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md



## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
### What?

Fixing the cypress component testing example, since it breaks the
next.js build process.

### Why?

The default example is not working regarding this issue:
#50283

Because there's a cypress test file (`*.cy.tsx`) inside the `/pages`
directory.

### How?


In this pull request, I made the following changes:

- Removed the new Cypress component test file from the /pages directory
to resolve conflicts with the build process.
- Created a dedicated directory for components, and created a new
example component.
- Moved the test file to the new component directory to ensure it works
as expected.

Build works:


![image](https://github.com/vercel/next.js/assets/987947/f79cc585-ad32-4780-ba56-a5f28259c69c)

Starting the new component testing works:


![image](https://github.com/vercel/next.js/assets/987947/032cff8f-5d1f-4aa2-b6b6-c95b5739e838)

Cypress Component Testing starts correctly:


![image](https://github.com/vercel/next.js/assets/987947/dff446b7-533b-4f6a-8f6c-09066866ba41)

The Component Test is there and ready to test:


![image](https://github.com/vercel/next.js/assets/987947/c235e1bb-9097-47b9-a625-a71b2ef5e129)

The Component Test passed as expected:


![image](https://github.com/vercel/next.js/assets/987947/fbaeaa18-5b63-4de6-9953-486bd7959703)

---------

Co-authored-by: JJ Kasper <jj@jjsweb.site>
  • Loading branch information
ciruz and ijjk committed Jun 14, 2023
1 parent a59c1f0 commit 6f9c9ad
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
import AboutComponent from './about-component'
/* eslint-disable */
// Disable ESLint to prevent failing linting inside the Next.js repo.
// If you're using ESLint on your project, we recommend installing the ESLint Cypress plugin instead:
// https://github.com/cypress-io/eslint-plugin-cypress

import About from './about'

// Cypress Component Test
describe('<AboutPage />', () => {
describe('<AboutComponent />', () => {
it('should render and display expected content', () => {
// Mount the React component for the About page
cy.mount(<About />)
cy.mount(<AboutComponent />)

// The new page should contain an h1 with "About page"
cy.get('h1').contains('About Page')
Expand Down
14 changes: 14 additions & 0 deletions examples/with-cypress/components/about-component.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import Link from 'next/link'
import React from 'react'
import styles from '../styles/Home.module.css'

export default function AboutComponent() {
return (
<>
<h1>About Page</h1>
<p className={styles.description}>
<Link href="/">&larr; Go Back</Link>
</p>
</>
)
}
7 changes: 2 additions & 5 deletions examples/with-cypress/pages/about.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
import AboutComponent from '../components/about-component'
import styles from '../styles/Home.module.css'
import Link from 'next/link'

export default function About() {
return (
<div className={styles.container}>
<main className={styles.main}>
<h1>About Page</h1>
<p className={styles.description}>
<Link href="/">&larr; Go Back</Link>
</p>
<AboutComponent />
</main>
</div>
)
Expand Down

0 comments on commit 6f9c9ad

Please sign in to comment.