add description for mutation and update default prefernces

cypress-io · Nov 29, 2021 · 6b83406 · 6b83406
1 parent 2db7d5a
commit 6b83406
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/packages/data-context/src/actions/LocalSettingsActions.ts b/packages/data-context/src/actions/LocalSettingsActions.ts
@@ -1,4 +1,4 @@
-import type { AllowedState, Editor } from '@packages/types'
+import { AllowedState, defaultPreferences, Editor } from '@packages/types'
 import pDefer from 'p-defer'
 
 import type { DataContext } from '..'
@@ -38,8 +38,11 @@ export class LocalSettingsActions {
     const availableEditors = await this.ctx._apis.localSettingsApi.getAvailableEditors()
 
     this.ctx.coreData.localSettings.availableEditors = availableEditors
-    this.ctx.coreData.localSettings.preferences = await this.ctx._apis.localSettingsApi.getPreferences()
+    this.ctx.coreData.localSettings.preferences = {
+      ...defaultPreferences,
+      ...(await this.ctx._apis.localSettingsApi.getPreferences()),
+    }
 
-    dfd.resolve(availableEditors)
+    dfd.resolve()
   }
 }
diff --git a/packages/data-context/src/data/coreDataShape.ts b/packages/data-context/src/data/coreDataShape.ts
@@ -1,4 +1,4 @@
-import { BUNDLERS, FoundBrowser, FoundSpec, FullConfig, Preferences, defaultPreferences, Editor, Warning, AllowedState } from '@packages/types'
+import { BUNDLERS, FoundBrowser, FoundSpec, FullConfig, Preferences, Editor, Warning, AllowedState } 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'
@@ -117,7 +117,7 @@ export function makeCoreData (): CoreDataShape {
     },
     localSettings: {
       availableEditors: [],
-      preferences: defaultPreferences,
+      preferences: {},
       refreshing: null,
     },
     isAuthBrowserOpened: false,

diff --git a/packages/graphql/src/schemaTypes/objectTypes/gql-Mutation.ts b/packages/graphql/src/schemaTypes/objectTypes/gql-Mutation.ts
@@ -299,8 +299,15 @@ export const mutation = mutationType({
 
     t.liveMutation('setPreferences', {
       type: 'Boolean',
+      description: `
+        Update local preferences (also known as  appData).
+        The payload, \`value\`, should be a JSON.stirngified
+        object of the new values you'd like to persist.
+
+        Example usage:
+          mutation setPreferences (value: JSON.stringify({ firstTimeOpening: Date.now(), specListOpen: true })
+      `,
       args: {
-        // Stringify JSON, eg JSON.stringify({ firstTimeOpening: Date.now() })
         value: nonNull(stringArg()),
       },
       resolve: async (_, args, ctx) => {