Merge branch 'main' into v4-6

dimaMachina · dimaMachina · commit 190130b3596d · 2025-05-20T20:46:35.000+02:00
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -36,11 +36,9 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     needs: [install]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-
       - id: cache-modules
         uses: actions/cache@v4
         with:
@@ -109,18 +107,15 @@ jobs:
     name: Vitest Unit Tests
     runs-on: ubuntu-latest
     needs: [build]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-
       - id: cache-modules
         uses: actions/cache@v4
         with:
           path: |
             **/node_modules
           key: modules-${{ github.sha }}
-
       - uses: actions/cache@v4
         with:
           key: build-${{ github.sha }}
@@ -131,11 +126,9 @@ jobs:
     name: ESLint
     runs-on: ubuntu-latest
     needs: [build]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-
       - id: cache-modules
         uses: actions/cache@v4
         with:
@@ -148,11 +141,29 @@ jobs:
           path: ${{ env.BUILD-CACHE-LIST }}
       - run: yarn eslint
 
+  types-check:
+    name: Types Check
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - id: cache-modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            **/node_modules
+          key: modules-${{ github.sha }}
+      - uses: actions/cache@v4
+        with:
+          key: build-${{ github.sha }}
+          path: ${{ env.BUILD-CACHE-LIST }}
+      - run: yarn types:check
+
   e2e:
     name: Cypress
     runs-on: ubuntu-latest
     needs: [build]
-
     steps:
       - uses: actions/checkout@v4
       - id: cache-modules
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -11,5 +11,6 @@
     "coverage.xml",
     "jacoco.xml",
     "coverage.cobertura.xml"
-  ]
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib"
 }
diff --git a/packages/cm6-graphql/package.json b/packages/cm6-graphql/package.json
@@ -3,6 +3,7 @@
   "version": "0.2.1",
   "description": "GraphQL language support for CodeMirror 6",
   "scripts": {
+    "types:check": "tsc --noEmit",
     "build": "cm-buildhelper src/index.ts",
     "prepare": "yarn build",
     "test": "vitest run"
diff --git a/packages/codemirror-graphql/package.json b/packages/codemirror-graphql/package.json
@@ -35,6 +35,7 @@
     "!jest.config.js"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "build": "node ../../scripts/renameFileExtensions.js './esm/{**,!**/__tests__/}/*.js' . .esm.js",
     "test": "vitest"
   },
diff --git a/packages/graphiql-plugin-code-exporter/package.json b/packages/graphiql-plugin-code-exporter/package.json
@@ -27,11 +27,10 @@
     ".": "./dist/index.js"
   },
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build && UMD=true vite build",
-    "prebuild": "yarn types:check",
-    "postbuild": "cp src/graphiql-code-exporter.d.ts dist/graphiql-code-exporter.d.ts",
-    "types:check": "tsc --noEmit"
+    "postbuild": "cp src/graphiql-code-exporter.d.ts dist/graphiql-code-exporter.d.ts"
   },
   "dependencies": {
     "graphiql-code-exporter": "^3.0.3"
diff --git a/packages/graphiql-plugin-doc-explorer/package.json b/packages/graphiql-plugin-doc-explorer/package.json
@@ -30,10 +30,10 @@
     "dist"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build",
-    "test": "vitest",
-    "types:check": "tsc --noEmit"
+    "test": "vitest"
   },
   "peerDependencies": {
     "react": "^18 || ^19",
diff --git a/packages/graphiql-plugin-doc-explorer/src/components/__tests__/doc-explorer.spec.tsx b/packages/graphiql-plugin-doc-explorer/src/components/__tests__/doc-explorer.spec.tsx
@@ -1,7 +1,6 @@
 import { act, render } from '@testing-library/react';
 import { GraphQLInt, GraphQLObjectType, GraphQLSchema } from 'graphql';
 import { FC, useEffect } from 'react';
-import type { SchemaContextType } from '@graphiql/react';
 import {
   DocExplorerContextProvider,
   useDocExplorer,
@@ -29,22 +28,17 @@ function makeSchema(fieldName = 'field') {
   });
 }
 
-const defaultSchemaContext: SchemaContextType = {
-  fetchError: null,
+const defaultSchemaContext = {
+  ...schemaStore.getInitialState(),
   introspect() {},
-  isFetching: false,
   schema: makeSchema(),
-  validationErrors: [],
 };
 
-const withErrorSchemaContext: SchemaContextType = {
+const withErrorSchemaContext = {
+  ...schemaStore.getInitialState(),
   fetchError: 'Error fetching schema',
   introspect() {},
-  isFetching: false,
   schema: new GraphQLSchema({ description: 'GraphQL Schema for testing' }),
-  validationErrors: [],
-  schemaReference: null!,
-  setSchemaReference: null!,
 };
 
 const DocExplorerWithContext: FC = () => {
diff --git a/packages/graphiql-plugin-doc-explorer/src/context.ts b/packages/graphiql-plugin-doc-explorer/src/context.ts
@@ -154,7 +154,7 @@ export const docExplorerStore = createStore<DocExplorerContextType>(
         set(state => {
           const oldNavStack = state.explorerNavStack;
           if (oldNavStack.length === 1) {
-            return oldNavStack;
+            return state;
           }
           // Spread is needed
           const newNavStack: DocExplorerNavStack = [...INITIAL_NAV_STACK];
diff --git a/packages/graphiql-plugin-explorer/package.json b/packages/graphiql-plugin-explorer/package.json
@@ -26,11 +26,10 @@
     ".": "./dist/index.js"
   },
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build && UMD=true vite build",
-    "postbuild": "cp src/graphiql-explorer.d.ts dist/graphiql-explorer.d.ts",
-    "prebuild": "yarn types:check",
-    "types:check": "tsc --noEmit"
+    "postbuild": "cp src/graphiql-explorer.d.ts dist/graphiql-explorer.d.ts"
   },
   "dependencies": {
     "graphiql-explorer": "^0.9.0"
diff --git a/packages/graphiql-plugin-history/package.json b/packages/graphiql-plugin-history/package.json
@@ -29,10 +29,10 @@
     "dist"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build",
-    "test": "vitest",
-    "types:check": "tsc --noEmit"
+    "test": "vitest"
   },
   "peerDependencies": {
     "react": "^18 || ^19",
diff --git a/packages/graphiql-react/package.json b/packages/graphiql-react/package.json
@@ -30,10 +30,10 @@
     "font"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build",
-    "test": "vitest",
-    "types:check": "tsc --noEmit"
+    "test": "vitest"
   },
   "peerDependencies": {
     "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0",
diff --git a/packages/graphiql-react/src/storage.tsx b/packages/graphiql-react/src/storage.tsx
@@ -27,13 +27,18 @@ export const StorageContextProvider: FC<StorageContextProviderProps> = ({
   storage,
   children,
 }) => {
-  const $storage = useStorage();
+  const isMounted = useStorageStore(store => Boolean(store.storage));
 
   useEffect(() => {
     storageStore.setState({ storage: new StorageAPI(storage) });
   }, [storage]);
 
-  return $storage && (children as ReactElement);
+  if (!isMounted) {
+    // Ensure storage was initialized
+    return null;
+  }
+
+  return children as ReactElement;
 };
 
 const useStorageStore = createBoundedUseStore(storageStore);
diff --git a/packages/graphiql-toolkit/package.json b/packages/graphiql-toolkit/package.json
@@ -19,10 +19,9 @@
   "module": "dist/esm/index.js",
   "typings": "dist/esm/index.d.mts",
   "scripts": {
+    "types:check": "tsc --noEmit",
     "build": "tsup",
     "dev": "tsup --watch",
-    "prebuild": "yarn types:check",
-    "types:check": "tsc --noEmit",
     "test": "vitest run"
   },
   "dependencies": {
diff --git a/packages/graphiql/package.json b/packages/graphiql/package.json
@@ -36,7 +36,6 @@
     ".": "./dist/index.js"
   },
   "scripts": {
-    "prebuild": "yarn types:check",
     "types:check": "tsc --noEmit",
     "build": "vite build && UMD=true vite build",
     "cypress-open": "yarn dev 'cypress open --browser electron'",
diff --git a/packages/graphql-language-service-cli/package.json b/packages/graphql-language-service-cli/package.json
@@ -25,6 +25,7 @@
     "src"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "test": "vitest"
   },
   "keywords": [
diff --git a/packages/graphql-language-service-server/CHANGELOG.md b/packages/graphql-language-service-server/CHANGELOG.md
@@ -1,5 +1,11 @@
 # graphql-language-service-server
 
+## 2.14.6
+
+### Patch Changes
+
+- [#3954](https://github.com/graphql/graphiql/pull/3954) [`8ec7a77`](https://github.com/graphql/graphiql/commit/8ec7a77e77078f7cb3826263518c8df6ab16bc24) Thanks [@dimaMachina](https://github.com/dimaMachina)! - [lsp] Fix parsing of relay style locations in locateCommand results
+
 ## 2.14.5
 
 ### Patch Changes
diff --git a/packages/graphql-language-service-server/README.md b/packages/graphql-language-service-server/README.md
@@ -180,7 +180,7 @@ module.exports = {
         );
         return { uri: path, range }; // range.start.line/range.end.character/etc, base 1
         // you can also return relay LSP style
-        // return '/path/to/file.py:20:23'; // (range: 20:1 )
+        // return '/path/to/file.py:20:1'; // (range: 20:1 20:1 )
         // return '/path/to/file.py'; // (range: 1:1 1:1)
       },
     },
diff --git a/packages/graphql-language-service-server/package.json b/packages/graphql-language-service-server/package.json
@@ -1,6 +1,6 @@
 {
   "name": "graphql-language-service-server",
-  "version": "2.14.5",
+  "version": "2.14.6",
   "description": "Server process backing the GraphQL Language Service",
   "contributors": [
     "Greg Hurrell <greg@hurrell.net> (https://greg.hurrell.net)",
@@ -30,6 +30,9 @@
     "svelte",
     "typescript"
   ],
+  "scripts": {
+    "types:check": "tsc --noEmit"
+  },
   "main": "dist/index.js",
   "module": "esm/index.js",
   "typings": "esm/index.d.ts",
diff --git a/packages/graphql-language-service-server/src/MessageProcessor.ts b/packages/graphql-language-service-server/src/MessageProcessor.ts
@@ -913,12 +913,14 @@ export class MessageProcessor {
         project,
       });
       if (typeof locateResult === 'string') {
-        const [uri, startLine = '1', endLine = '1'] = locateResult.split(':');
+        const [uri, line = '1', character = '1'] = locateResult.split(':');
+        const startLine = Math.max(parseInt(line, 10) - 1, 0);
+        const startCharacter = Math.max(parseInt(character, 10) - 1, 0);
         return {
           uri,
           range: new Range(
-            new Position(parseInt(startLine, 10), 0),
-            new Position(parseInt(endLine, 10), 0),
+            new Position(startLine, startCharacter),
+            new Position(startLine, startCharacter),
           ),
         };
       }
diff --git a/packages/graphql-language-service-server/src/__tests__/MessageProcessor.test.ts b/packages/graphql-language-service-server/src/__tests__/MessageProcessor.test.ts
@@ -465,10 +465,10 @@ describe('MessageProcessor', () => {
       () => 'hello:2:4',
     );
     expect(customResult2.uri).toEqual('hello');
-    expect(customResult2.range.start.line).toEqual(2);
-    expect(customResult2.range.start.character).toEqual(0);
-    expect(customResult2.range.end.line).toEqual(4);
-
+    expect(customResult2.range.start.line).toEqual(1);
+    expect(customResult2.range.start.character).toEqual(3);
+    expect(customResult2.range.end.line).toEqual(1);
+    expect(customResult2.range.end.character).toEqual(3);
     const customResult3 = messageProcessor._getCustomLocateResult(
       project,
       { definitions: result, printedName: 'example' },
@@ -496,9 +496,10 @@ describe('MessageProcessor', () => {
       },
     }));
     const result2 = await messageProcessor.handleDefinitionRequest(test);
-    expect(result2[0].range.start.line).toBe(3);
-    expect(result2[0].range.end.line).toBe(4);
-    expect(result2[0].range.end.character).toBe(0);
+    expect(result2[0].range.start.line).toBe(2);
+    expect(result2[0].range.start.character).toBe(3);
+    expect(result2[0].range.end.line).toBe(2);
+    expect(result2[0].range.end.character).toBe(3);
     messageProcessor._graphQLCache.getProjectForFile = oldGetProject;
   });
   it('runs hover requests', async () => {
diff --git a/packages/graphql-language-service-server/src/types.ts b/packages/graphql-language-service-server/src/types.ts
@@ -27,12 +27,17 @@ type AdditionalLocateInfo = {
   project: GraphQLProjectConfig;
 };
 
+type LineNumber = string;
+type CharacterNumber = string;
 type RelayLSPLocateCommand = (
   // either Type, Type.field or Type.field(argument)
   projectName: string,
   typeName: string,
   info: AdditionalLocateInfo,
-) => `${string}:${string}:${string}` | `${string}:${string}` | string;
+) =>
+  | `${string}:${LineNumber}:${CharacterNumber}`
+  | `${string}:${LineNumber}`
+  | string;
 
 type GraphQLLocateCommand = (
   projectName: string,
diff --git a/packages/graphql-language-service/package.json b/packages/graphql-language-service/package.json
@@ -53,6 +53,7 @@
     "typescript": "^4.6.3"
   },
   "scripts": {
+    "types:check": "tsc --noEmit",
     "benchmark": "ts-node benchmark/index.ts",
     "test": "vitest"
   }
diff --git a/packages/monaco-graphql/package.json b/packages/monaco-graphql/package.json
@@ -63,6 +63,7 @@
     "src"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "test": "vitest run"
   },
   "dependencies": {
diff --git a/packages/vscode-graphql-execution/package.json b/packages/vscode-graphql-execution/package.json
@@ -82,6 +82,7 @@
   },
   "homepage": "https://github.com/graphql/graphiql/blob/main/packages/vscode-graphql-execution/README.md",
   "scripts": {
+    "types:check": "tsc --noEmit",
     "compile": "node esbuild.js",
     "build-bundles": "yarn run compile",
     "vsce:package": "yarn compile && vsce package --yarn",
diff --git a/packages/vscode-graphql-syntax/package.json b/packages/vscode-graphql-syntax/package.json
@@ -159,6 +159,7 @@
   },
   "homepage": "https://github.com/graphql/graphiql/blob/main/packages/vscode-graphql-syntax/README.md",
   "scripts": {
+    "types:check": "tsc --noEmit",
     "vsce:package": "vsce package --yarn",
     "vsce:prepublish": "npm run vsce:package",
     "vsce:publish": "vsce publish --yarn",
diff --git a/packages/vscode-graphql/package.json b/packages/vscode-graphql/package.json

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@`
`11`	`11`	`"coverage.xml",`
`12`	`12`	`"jacoco.xml",`
`13`	`13`	`"coverage.cobertura.xml"`
`14`		`- ]`
	`14`	`+ ],`
	`15`	`+ "typescript.tsdk": "node_modules/typescript/lib"`
`15`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ export const docExplorerStore = createStore<DocExplorerContextType>(`
`154`	`154`	`set(state => {`
`155`	`155`	`const oldNavStack = state.explorerNavStack;`
`156`	`156`	`if (oldNavStack.length === 1) {`
`157`		`- return oldNavStack;`
	`157`	`+ return state;`
`158`	`158`	`}`
`159`	`159`	`// Spread is needed`
`160`	`160`	`const newNavStack: DocExplorerNavStack = [...INITIAL_NAV_STACK];`