test(ui-form-field): add next js to regression tests

Closes: INSTUI-3743, INSTUI-3999

.github/workflows/ssr-regression.yml

@@ -0,0 +1,19 @@
+name: SSR Regression Tests
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the master branch
+  push:
+    branches:
+      - master
+jobs:
+  ssr-regression:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Cypress run
+        uses: cypress-io/github-action@v6
+        with:
+          working-directory: ./regression-test
+          build: npm run build
+          start: npm start

cypress.config.ts

@@ -36,6 +36,7 @@ export default defineConfig({
   },
   screenshotOnRunFailure: false,
   component: {
+    excludeSpecPattern: 'regression-test/**',
     devServer: {
       framework: 'react',
       bundler: 'webpack',

regression-test/.eslintignore

@@ -0,0 +1 @@
+next-env.d.ts

regression-test/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

regression-test/.gitignore

@@ -1,10 +1,36 @@
-dist/
-public/bundle.*
-node_modules/
-.pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/out/
+.
+
+# production
+/build
+/src/.next/
+/.next/
+
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

regression-test/README.md

@@ -4,18 +4,10 @@ This app is a target against our regression testing workflow. It simply renders
 
 The regression testing suite is fairly simple at this point, it will only check a couple of things:
 
-- use the latest snapshot version of instui
-- check whether every component is in a renderable state (simply render them)
-- check whether any error/warning is thrown inside the application
+- use the latest snapshot version of InstUI
+- check components are in a renderable state (simply render them)
 
-## Run the regeression tests locally
-
-Run `prepare.js` to fetch latest snapshot versions
-
-```sh
-# cwd: regression-test
-node ./prepare.js
-```
+## Run the regression tests locally
 
 In order to run the test you have to have it's dependencies installed. (this project is not a workspace of the main instui project)
 
@@ -24,18 +16,18 @@ In order to run the test you have to have it's dependencies installed. (this pro
 npm install
 ```
 
-Then build the project(with `esbuild`):
+Then build the project:
 
 ```sh
 # cwd: regression-test
-npm run build:esbuild
+npm run build
 ```
 
-The regression testing tool (`testcafe`) will test the app in a real browser, so we have to have a server serving our application:
+The regression testing tool will test the app in a real browser, so we have to have a server serving our application:
 
 ```sh
 # cwd: regression-test
-npm run serve
+npm run start
 ```
 
 Now you can run the test suite:

regression-test/cypress.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'cypress'
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    }
+  }
+})

regression-test/cypress/e2e/spec.cy.ts

@@ -0,0 +1,31 @@
+describe('regression test', () => {
+  it('open dialog subpage', () => {
+    cy.visit('http://localhost:3000')
+    cy.get('a').contains('dialog').click()
+    cy.get('button').click()
+    cy.get('body').should('contain', 'Full name')
+    cy.get('[class$="closeButton"]').click()
+  })
+
+  it('open alert subpage', () => {
+    cy.visit('http://localhost:3000')
+    cy.get('a').contains('alert').click()
+    // cy.get('button').click()
+    cy.get('body').should('contain', 'Sample info text')
+    // cy.get('[class$="closeButton"]').click()
+  })
+
+  it('open breadcrumb subpage', () => {
+    cy.visit('http://localhost:3000')
+    cy.get('a').contains('breadcrumb').click()
+    cy.get('body').should('contain', 'Rabbit Is Rich')
+    cy.get('body').contains('The Rabbit Novels').click()
+    const redirect = 'https://instructure.design'
+    cy.origin(redirect, { args: { redirect } }, ({ redirect }) => {
+      cy.log(redirect)
+      cy.location().should((loc) => {
+        loc.href.includes(redirect)
+      })
+    })
+  })
+})

regression-test/cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

regression-test/cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

regression-test/next.config.mjs

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default nextConfig;