Merge branch '10.0-release' into fix/reporter-styles

Author: Shawn Taylor

circle.yml

@@ -1097,26 +1097,26 @@ jobs:
       - restore_cached_workspace
       - run: yarn test-npm-package-release-script
 
+  lint-types:
+    <<: *defaults
+    parallelism: 1
+    resource_class: medium
+    steps:
+      - restore_cached_workspace
+      - run:
+          command: ls -la types
+          working_directory: cli
+      - run:
+          command: ls -la chai
+          working_directory: cli/types
+      - run:
+          name: "Lint types 🧹"
+          command: yarn workspace cypress dtslint
   # todo(lachlan): do we need this? yarn check-ts does something very similar
-  # lint-types:
-  #   <<: *defaults
-  #   parallelism: 1
-  #   resource_class: medium
-  #   steps:
-  #     - restore_cached_workspace
-  #     - run:
-  #         command: ls -la types
-  #         working_directory: cli
-  #     - run:
-  #         command: ls -la chai
-  #         working_directory: cli/types
-  #     - run:
-  #         name: "Lint types 🧹"
-  #         command: yarn workspace cypress dtslint
   #     - run:
   #         name: "TypeScript check 🧩"
   #         command: yarn type-check --ignore-progress
-  #     - store-npm-logs
+      - store-npm-logs
 
   server-unit-tests:
     <<: *defaults
@@ -2159,10 +2159,9 @@ linux-workflow: &linux-workflow
         required_env_var: PERCY_TOKEN # skips job if not defined (external PR)
         requires:
           - build
-    # todo(lachlan): do we need this? yarn check-ts does something very similar
-    # - lint-types:
-    #     requires:
-    #       - build
+    - lint-types:
+        requires:
+          - build
     # unit, integration and e2e tests
     - cli-visual-tests:
         requires:

cli/scripts/post-install.js

@@ -90,7 +90,7 @@ filesToUncomment.forEach((file) => {
   const str = fs.readFileSync(filePath).toString()
 
   const result = str.split('\n').map((line) => {
-    return line.startsWith('// ') ? line.substring(3) : line
+    return line.startsWith('//z ') ? line.substring(4) : line
   }).join('\n')
 
   fs.writeFileSync(filePath, result)

packages/data-context/src/actions/AppActions.ts

@@ -35,7 +35,13 @@ export class AppActions {
       browser = (await this.ctx._apis.appApi.ensureAndGetByNameOrPath(browserNameOrPath)) as FoundBrowser | undefined
     } catch (err: unknown?) {
       this.ctx.debug('Error getting browser by name or path (%s): %s', browserNameOrPath, err?.stack || err)
-      this.ctx.coreData.wizard.browserErrorMessage = `The browser '${browserNameOrPath}' was not found on your system or is not supported by Cypress. Choose a browser below.`
+      const message = err.details ? `${err.message}\n\n\`\`\`\n${err.details}\n\`\`\`` : err.message
+
+      this.ctx.coreData.wizard.warnings.push({
+        title: 'Warning: Browser Not Found',
+        message,
+        setupStep: 'setupComplete',
+      })
     }
 
     if (browser) {

packages/data-context/src/data/coreDataShape.ts

@@ -1,4 +1,4 @@
-import { BUNDLERS, FoundBrowser, FoundSpec, FullConfig, Preferences, DevicePreferences, devicePreferenceDefaults, Editor } from '@packages/types'
+import { BUNDLERS, FoundBrowser, FoundSpec, FullConfig, Preferences, DevicePreferences, devicePreferenceDefaults, Editor, Warning } from '@packages/types'
 import type { NexusGenEnums, TestingTypeEnum } from '@packages/graphql/src/gen/nxs.gen'
 import type { BrowserWindow } from 'electron'
 import type { ChildProcess } from 'child_process'
@@ -73,7 +73,7 @@ export interface WizardDataShape {
   chosenLanguage: NexusGenEnums['CodeLanguageEnum']
   chosenManualInstall: boolean
   chosenBrowser: FoundBrowser | null
-  browserErrorMessage: string | null
+  warnings: Warning[]
 }
 
 export interface ElectronShape {
@@ -132,7 +132,7 @@ export function makeCoreData (): CoreDataShape {
       allBundlers: BUNDLERS,
       history: ['welcome'],
       chosenBrowser: null,
-      browserErrorMessage: null,
+      warnings: [],
     },
     user: null,
     electron: {

packages/frontend-shared/cypress/support/mock-graphql/clientTestContext.ts

@@ -37,7 +37,7 @@ export interface ClientTestContext {
     allBundlers: WizardBundler[]
     history: WizardStep[]
     chosenBrowser: null
-    browserErrorMessage: null
+    warnings: []
   }
   user: AuthenticatedUserShape | null
   cloudTypes: typeof cloudTypes
@@ -87,7 +87,7 @@ export function makeClientTestContext (): ClientTestContext {
       allBundlers,
       history: ['welcome'],
       chosenBrowser: null,
-      browserErrorMessage: null,
+      warnings: [],
     },
     user: null,
     cloudTypes,

packages/frontend-shared/cypress/support/mock-graphql/stubgql-Wizard.ts

@@ -46,7 +46,7 @@ export const stubWizard: MaybeResolver<Wizard> = {
       ...testNodeId('WizardSampleConfigFile'),
       filePath: 'cypress/fixtures/example.json',
       description: 'Please do the necessary changes to your file',
-      content: dedent`{ 
+      content: dedent`{
         "foo": 1,
         "bar": 42
       }`,
@@ -97,4 +97,5 @@ export const stubWizard: MaybeResolver<Wizard> = {
       isSelected: idx === 0,
     }
   }),
+  warnings: [],
 }

packages/graphql/schemas/schema.graphql

@@ -598,9 +598,6 @@ type ProjectPreferences {
 type Query {
   baseError: BaseError
 
-  """An error related to finding a browser"""
-  browserErrorMessage: String
-
   """Returns an object conforming to the Relay spec"""
   cloudNode(
     """An ID for a Node conforming to the Relay spec"""
@@ -758,6 +755,13 @@ type VersionData {
   latest: Version!
 }
 
+"""A warning"""
+type Warning {
+  message: String!
+  setupStep: String
+  title: String!
+}
+
 """
 The Wizard is a container for any state associated with initial onboarding to Cypress
 """
@@ -809,6 +813,9 @@ type Wizard {
 
   """The title of the page, given the current step of the wizard"""
   title: String
+
+  """A list of warnings"""
+  warnings: [Warning!]!
 }
 
 """Wizard bundler"""

packages/graphql/src/schemaTypes/objectTypes/gql-Query.ts

@@ -48,13 +48,6 @@ export const Query = objectType({
       resolve: (root, args, ctx) => ctx.appData.projects,
     })
 
-    t.string('browserErrorMessage', {
-      description: 'An error related to finding a browser',
-      resolve: (source, args, ctx) => {
-        return ctx.wizardData.browserErrorMessage
-      },
-    })
-
     t.nonNull.boolean('isInGlobalMode', {
       description: 'Whether the app is in global mode or not',
       resolve: (source, args, ctx) => !ctx.currentProject,

packages/graphql/src/schemaTypes/objectTypes/gql-Wizard.ts

@@ -7,6 +7,20 @@ import { TestingTypeEnum, WizardStepEnum } from '../enumTypes/gql-WizardEnums'
 import { WizardCodeLanguage } from './gql-WizardCodeLanguage'
 import { WizardSampleConfigFile } from './gql-WizardSampleConfigFile'
 
+const Warning = objectType({
+  name: 'Warning',
+  description: 'A warning',
+  definition (t) {
+    t.nonNull.string('title')
+    t.nonNull.string('message')
+    t.string('setupStep')
+  },
+  sourceType: {
+    module: '@packages/types',
+    export: 'Warning',
+  },
+})
+
 export const Wizard = objectType({
   name: 'Wizard',
   description: 'The Wizard is a container for any state associated with initial onboarding to Cypress',
@@ -98,6 +112,14 @@ export const Wizard = objectType({
       description: 'The title of the page, given the current step of the wizard',
       resolve: (source, args, ctx) => ctx.wizard.title ?? null,
     })
+
+    t.nonNull.list.nonNull.field('warnings', {
+      type: Warning,
+      description: 'A list of warnings',
+      resolve: (source, args, ctx) => {
+        return ctx.coreData.wizard.warnings
+      },
+    })
   },
   sourceType: {
     module: '@packages/data-context/src/data/coreDataShape',

packages/launchpad/package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "check-ts": "vue-tsc --noEmit",
     "build-prod-ui": "cross-env NODE_ENV=production vite build",
+    "postinstall": "patch-package",
     "clean": "rimraf dist && rimraf ./node_modules/.vite && rimraf dist-e2e && echo 'cleaned'",
     "clean-deps": "rimraf node_modules",
     "test": "yarn cypress:run:ct && yarn types",
@@ -28,6 +29,7 @@
     "@packages/frontend-shared": "0.0.0-development",
     "@percy/cypress": "^3.1.0",
     "@testing-library/cypress": "8.0.0",
+    "@toycode/markdown-it-class": "1.2.4",
     "@urql/core": "2.3.1",
     "@urql/devtools": "2.0.3",
     "@urql/vue": "0.4.3",
@@ -46,6 +48,7 @@
     "graphql-tag": "^2.12.5",
     "gravatar": "1.8.0",
     "javascript-time-ago": "2.3.8",
+    "markdown-it": "12.2.0",
     "rimraf": "3.0.2",
     "rollup-plugin-polyfill-node": "^0.7.0",
     "type-fest": "^2.3.4",
@@ -71,6 +74,11 @@
     "script",
     "src"
   ],
+  "workspaces": {
+    "nohoist": [
+      "@toycode/markdown-it-class"
+    ]
+  },
   "vite": {
     "optimizeDeps": {
       "include": [