refactor: remove concept of liveMutation (#19528)

* refactor: remove the concept of liveMutation

* fix types

* Fix types

* add missing cache key

Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com>

Author: tgriesser

packages/app/src/composables/usePreferences.ts

@@ -1,12 +1,15 @@
 import { useRunnerUiStore, RunnerUiState } from '../store'
 import { useMutation, gql } from '@urql/vue'
-import { Preferences_SetPreferencesDocument } from '@packages/data-context/src/gen/all-operations.gen'
+import { Preferences_SetPreferencesDocument } from '@packages/app/src/generated/graphql'
 
 const runnerUiStore = useRunnerUiStore()
 
 gql`
 mutation Preferences_SetPreferences ($value: String!) {
-  setPreferences (value: $value)
+  setPreferences (value: $value) {
+    ...TestingPreferences
+    ...SpecRunner_Preferences
+  }
 }`
 
 export function usePreferences () {

packages/app/src/runner/SpecRunner.vue

@@ -107,13 +107,7 @@ import { runnerConstants } from './runner-constants'
 const { height: windowHeight, width: windowWidth } = useWindowSize()
 
 gql`
-fragment SpecRunner on Query {
-  ...Specs_InlineSpecList
-  currentProject {
-    id
-    ...SpecRunnerHeader
-  }
-  ...ChooseExternalEditor
+fragment SpecRunner_Preferences on Query {
   localSettings {
     preferences {
       isSpecsListOpen
@@ -125,6 +119,18 @@ fragment SpecRunner on Query {
 }
 `
 
+gql`
+fragment SpecRunner on Query {
+  ...Specs_InlineSpecList
+  currentProject {
+    id
+    ...SpecRunnerHeader
+  }
+  ...ChooseExternalEditor
+  ...SpecRunner_Preferences
+}
+`
+
 gql`
 mutation OpenFileInIDE ($input: FileDetailsInput!) {
   openFileInIDE (input: $input)

packages/app/src/runner/SpecRunnerHeader.vue

@@ -114,7 +114,9 @@ mutation SpecRunnerHeader_SetBrowser($browserId: ID!, $specPath: String!) {
       isSelected
     }
   }
-  launchOpenProject(specPath: $specPath)
+  launchOpenProject(specPath: $specPath) {
+    id
+  }
 }
 `
 

packages/app/src/settings/device/ExternalEditorSettings.vue

@@ -25,7 +25,9 @@ import { useMutation } from '@urql/vue'
 
 gql`
 mutation ExternalEditorSettings_SetPreferredEditorBinary ($value: String!) {
-  setPreferences (value: $value)
+  setPreferences (value: $value) {
+    ...ExternalEditorSettings
+  }
 }`
 
 const { t } = useI18n()

packages/app/src/settings/device/TestingPreferences.vue

@@ -51,7 +51,9 @@ fragment TestingPreferences on Query {
 
 gql`
 mutation SetTestingPreferences($value: String!) {
-  setPreferences (value: $value)
+  setPreferences (value: $value) {
+    ...TestingPreferences
+  }
 }`
 
 const setPreferences = useMutation(SetTestingPreferencesDocument)

packages/data-context/src/util/urqlCacheKeys.ts

@@ -13,6 +13,7 @@ export const urqlCacheKeys: Partial<CacheExchangeOpts> = {
     App: (data) => data.__typename,
     DevState: (data) => data.__typename,
     Wizard: (data) => data.__typename,
+    Migration: (data) => data.__typename,
     Warning: (data) => null,
     CloudRunCommitInfo: () => null,
     GitInfo: () => null,

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

@@ -9,14 +9,14 @@ export const stubMutation: MaybeResolver<Mutation> = {
   addProject (source, args, ctx) {
     ctx.projects.push(createTestGlobalProject(path.basename(args.path)))
 
-    return true
+    return {}
   },
   setCurrentProject (source, args, ctx) {
     const project = ctx.projects.find((p) => p.projectRoot === args.path)
 
     ctx.currentProject = project ? createTestCurrentProject(project.title) : null
 
-    return true
+    return {}
   },
   clearCurrentProject (source, args, ctx) {
     ctx.currentProject = null
@@ -26,7 +26,7 @@ export const stubMutation: MaybeResolver<Mutation> = {
   removeProject (source, args, ctx) {
     ctx.projects = ctx.projects.filter((p) => p.projectRoot !== args.path)
 
-    return true
+    return {}
   },
   hideBrowserWindow (source, args, ctx) {
     return true

packages/frontend-shared/src/gql-components/Auth.vue

@@ -67,13 +67,17 @@ fragment Auth on Query {
 
 gql`
 mutation Logout {
-  logout 
+  logout {
+    ...Auth
+  }
 }
 `
 
 gql`
 mutation Login {
-  login 
+  login {
+    ...Auth
+  }
 }
 `
 

packages/frontend-shared/src/gql-components/ChooseExternalEditorModal.vue

@@ -59,7 +59,13 @@ fragment ChooseExternalEditorModal on Query {
 
 gql`
 mutation ChooseExternalEditorModal_SetPreferredEditorBinary ($value: String!) {
-  setPreferences (value: $value)
+  setPreferences (value: $value) {
+    localSettings {
+      preferences {
+        preferredEditorBinary
+      }
+    }
+  }
 }`
 
 const setPreferredBinaryEditor = useMutation(ChooseExternalEditorModal_SetPreferredEditorBinaryDocument)

packages/frontend-shared/src/gql-components/topnav/TopNav.vue

@@ -278,8 +278,10 @@ fragment TopNav on Query {
 `
 
 gql`
-mutation TopNav_LaunchOpenProject  {
-  launchOpenProject
+mutation TopNav_LaunchOpenProject {
+  launchOpenProject {
+    id
+  }
 }
 `
 

packages/graphql/schemas/schema.graphql

@@ -610,10 +610,7 @@ type Mutation {
     """Whether to open the project when added"""
     open: Boolean
     path: String!
-  ): Boolean
-
-  """Create an Index HTML file for a new component testing project"""
-  appCreateComponentIndexHtml(template: String!): Boolean
+  ): Query
 
   """Clears the currently active project"""
   clearCurrentProject: Query
@@ -641,7 +638,7 @@ type Mutation {
   internal_clearProjectPreferencesCache(projectTitle: String!): Boolean
 
   """Launches project from open_project global singleton"""
-  launchOpenProject(specPath: String): Boolean
+  launchOpenProject(specPath: String): CurrentProject
 
   """Sets the active browser"""
   launchpadSetBrowser(
@@ -650,10 +647,10 @@ type Mutation {
   ): CurrentProject
 
   """Auth with Cypress Cloud"""
-  login: Boolean
+  login: Query
 
   """Log out of Cypress Cloud"""
-  logout: Boolean
+  logout: Query
 
   """Open a path in preferred IDE"""
   openDirectoryInIDE(path: String!): Boolean
@@ -669,30 +666,27 @@ type Mutation {
   reconfigureProject: Boolean!
 
   """Remove project from projects array and cache"""
-  removeProject(path: String!): Boolean
+  removeProject(path: String!): Query
 
   """Reset the Wizard to the starting position"""
   resetWizard: Boolean!
   scaffoldIntegration: [CodeGenResultWithFileParts!]!
   scaffoldTestingType: Query
 
   """Set active project to run tests on"""
-  setCurrentProject(path: String!): Boolean
+  setCurrentProject(path: String!): Query
   setCurrentTestingType(testingType: TestingTypeEnum!): Query
 
   """
   Update local preferences (also known as  appData). The payload, `value`, should be a `JSON.stringified()` object of the new values you'd like to persist. Example: `setPreferences (value: JSON.stringify({ lastOpened: Date.now() }))`
   """
-  setPreferences(value: String!): Boolean
+  setPreferences(value: String!): Query
 
   """Save the projects preferences to cache"""
   setProjectPreferences(browserPath: String!, testingType: TestingTypeEnum!): Query!
 
-  """show the launchpad at the browser picker step"""
-  showElectronOnAppExit: Boolean
-
   """Updates the different fields of the wizard data store"""
-  wizardUpdate(input: WizardUpdateInput!): Boolean
+  wizardUpdate(input: WizardUpdateInput!): Wizard
 }
 
 """Implements the Relay Node spec"""

packages/graphql/src/plugins/index.ts

@@ -1,5 +1,4 @@
 /* eslint-disable padding-line-between-statements */
 // created by autobarrel, do not modify directly
 
-export * from './nexusLiveMutation'
 export * from './nexusNodePlugin'

packages/graphql/src/plugins/nexusLiveMutation.ts

@@ -4,7 +4,6 @@ import { makeSchema, connectionPlugin } from 'nexus'
 import * as schemaTypes from './schemaTypes/'
 import { nodePlugin } from './plugins/nexusNodePlugin'
 import { remoteSchemaWrapped } from './stitching/remoteSchemaWrapped'
-import { NexusLiveMutationPlugin } from './plugins/nexusLiveMutation'
 
 const isCodegen = Boolean(process.env.CYPRESS_INTERNAL_NEXUS_CODEGEN)
 
@@ -36,7 +35,6 @@ export const graphqlSchema = makeSchema({
       },
     }),
     nodePlugin,
-    NexusLiveMutationPlugin,
   ],
   formatTypegen (content, type) {
     if (type === 'schema') {