commit aa5b67dcdb7e788b2fa8a9183980b570e01707cb · kitten.sh/graphqlsp

.changeset/sixty-walls-mix.md

···

       1
       1
       +
       ---

     

       2
       2
       +
       '@0no-co/graphqlsp': patch

     

       3
       3
       +
       ---

     

       4
       4
       +
       

     

       5
       5
       +
       Switch to loading the schema with `@gql.tada/internal` utilities

+2 -2

packages/graphqlsp/package.json

···

       46
       46
        
           "@sindresorhus/fnv1a": "^2.0.0",

     

       47
       47
        
           "@types/node": "^18.15.11",

     

       48
       48
        
           "@types/node-fetch": "^2.6.3",

     

       49
       49
       -
           "graphql": "^16.8.1",

     

       50
       49
        
           "graphql-language-service": "^5.2.0",

     

       51
       50
        
           "lru-cache": "^10.0.1",

     

       52
       51
        
           "typescript": "^5.3.3"

     

       53
       52
        
         },

     

       54
       53
        
         "dependencies": {

     

       55
       55
       -
           "@gql.tada/internal": "^0.1.0",

     

       54
       54
       +
           "@gql.tada/internal": "^0.1.2",

     

       55
       55
       +
           "graphql": "^16.8.1",

     

       56
       56
        
           "node-fetch": "^2.0.0"

     

       57
       57
        
         },

     

       58
       58
        
         "peerDependencies": {

+54 -141

packages/graphqlsp/src/graphql/getSchema.ts

···

       1
       1
       -
       import {

     

       2
       2
       -
         GraphQLSchema,

     

       3
       3
       -
         buildSchema,

     

       4
       4
       -
         buildClientSchema,

     

       5
       5
       -
         getIntrospectionQuery,

     

       6
       6
       -
         IntrospectionQuery,

     

       7
       7
       -
         introspectionFromSchema,

     

       8
       8
       -
       } from 'graphql';

     

       9
       1
        
       import path from 'path';

     

       10
       10
       -
       import fetch from 'node-fetch';

     

       11
       2
        
       import fs from 'fs';

     

       3
       3
       +
       

     

       4
       4
       +
       import type { GraphQLSchema, IntrospectionQuery } from 'graphql';

     

       5
       5
       +
       

     

       12
       6
        
       import {

     

       7
       7
       +
         type SchemaOrigin,

     

       8
       8
       +
         type SchemaLoaderResult,

     

       9
       9
       +
         load,

     

       13
       10
        
         resolveTypeScriptRootDir,

     

       14
       11
        
         minifyIntrospection,

     

       15
       12
        
         outputIntrospectionFile,

     
···

       19
       16
        
       import { Logger } from '../index';

     

       20
       17
        
       

     

       21
       18
        
       async function saveTadaIntrospection(

     

       22
       22
       -
         root: string,

     

       23
       23
       -
         schema: GraphQLSchema | IntrospectionQuery,

     

       19
       19
       +
         introspection: IntrospectionQuery,

     

       24
       20
        
         tadaOutputLocation: string,

     

       25
       21
        
         disablePreprocessing: boolean,

     

       26
       22
        
         logger: Logger

     

       27
       23
        
       ) {

     

       28
       28
       -
         const introspection = !('__schema' in schema)

     

       29
       29
       -
           ? introspectionFromSchema(schema, { descriptions: false })

     

       30
       30
       -
           : schema;

     

       31
       31
       -
       

     

       32
       24
        
         const minified = minifyIntrospection(introspection);

     

       33
       33
       -
       

     

       34
       34
       -
         const contents = await outputIntrospectionFile(minified, {

     

       25
       25
       +
         const contents = outputIntrospectionFile(minified, {

     

       35
       26
        
           fileType: tadaOutputLocation,

     

       36
       27
        
           shouldPreprocess: !disablePreprocessing,

     

       37
       28
        
         });

     

       38
       29
        
       

     

       39
       39
       -
         let output = path.resolve(root, tadaOutputLocation);

     

       30
       30
       +
         let output = tadaOutputLocation;

     

       40
       31
        
         let stat: fs.Stats | undefined;

     

       41
       32
        
       

     

       42
       33
        
         try {

     
···

       67
       58
        
         logger(`Introspection saved to path @ ${output}`);

     

       68
       59
        
       }

     

       69
       60
        
       

     

       70
       70
       -
       export type SchemaOrigin = {

     

       71
       71
       -
         url: string;

     

       72
       72
       -
         headers: Record<string, unknown>;

     

       73
       73
       -
       };

     

       61
       61
       +
       export interface SchemaRef {

     

       62
       62
       +
         current: GraphQLSchema | null;

     

       63
       63
       +
         version: number;

     

       64
       64
       +
       }

     

       74
       65
        
       

     

       75
       66
        
       export const loadSchema = (

     

       67
       67
       +
         // TODO: abstract info away

     

       76
       68
        
         info: ts.server.PluginCreateInfo,

     

       77
       77
       -
         schema: SchemaOrigin | string,

     

       78
       78
       -
         tadaOutputLocation: string | undefined,

     

       69
       69
       +
         origin: SchemaOrigin,

     

       79
       70
        
         logger: Logger

     

       80
       80
       -
       ): { current: GraphQLSchema | null; version: number } => {

     

       81
       81
       -
         const root =

     

       82
       82
       -
           resolveTypeScriptRootDir(

     

       83
       83
       -
             path => info.project.readFile(path),

     

       84
       84
       -
             info.project.getProjectName()

     

       85
       85
       -
           ) || path.dirname(info.project.getProjectName());

     

       86
       86
       -
         logger('Got root-directory to resolve schema from: ' + root);

     

       87
       87
       -
         const ref: {

     

       88
       88
       -
           current: GraphQLSchema | null;

     

       89
       89
       -
           version: number;

     

       90
       90
       -
           prev: string | null;

     

       91
       91
       -
         } = {

     

       92
       92
       -
           current: null,

     

       93
       93
       -
           version: 0,

     

       94
       94
       -
           prev: null,

     

       95
       95
       -
         };

     

       96
       96
       -
         let url: URL | undefined;

     

       97
       97
       -
         let config: { headers: Record<string, unknown> } | undefined;

     

       71
       71
       +
       ): SchemaRef => {

     

       72
       72
       +
         let loaderResult: SchemaLoaderResult | null = null;

     

       73
       73
       +
         const ref: SchemaRef = { current: null, version: 0 };

     

       98
       74
        
       

     

       99
       99
       -
         try {

     

       100
       100
       -
           if (typeof schema === 'object') {

     

       101
       101
       -
             url = new URL(schema.url);

     

       102
       102
       -
             config = { headers: schema.headers };

     

       103
       103
       -
           } else {

     

       104
       104
       -
             url = new URL(schema);

     

       105
       105
       -
           }

     

       106
       106
       -
         } catch (e) {}

     

       75
       75
       +
         (async () => {

     

       76
       76
       +
           const rootPath =

     

       77
       77
       +
             (await resolveTypeScriptRootDir(info.project.getProjectName())) ||

     

       78
       78
       +
             path.dirname(info.project.getProjectName());

     

       79
       79
       +
           const tadaDisablePreprocessing =

     

       80
       80
       +
             info.config.tadaDisablePreprocessing ?? false;

     

       81
       81
       +
           const tadaOutputLocation =

     

       82
       82
       +
             info.config.tadaOutputLocation &&

     

       83
       83
       +
             path.resolve(rootPath, info.config.tadaOutputLocation);

     

       107
       84
        
       

     

       108
       108
       -
         if (url) {

     

       109
       109
       -
           const pollSchema = () => {

     

       110
       110
       -
             logger(`Fetching introspection from ${url!.toString()}`);

     

       111
       111
       -
             fetch(url!.toString(), {

     

       112
       112
       -
               method: 'POST',

     

       113
       113
       -
               headers: config

     

       114
       114
       -
                 ? {

     

       115
       115
       -
                     ...(config.headers || {}),

     

       116
       116
       -
                     'Content-Type': 'application/json',

     

       117
       117
       -
                   }

     

       118
       118
       -
                 : {

     

       119
       119
       -
                     'Content-Type': 'application/json',

     

       120
       120
       -
                   },

     

       121
       121
       -
               body: JSON.stringify({

     

       122
       122
       -
                 query: getIntrospectionQuery({

     

       123
       123
       -
                   descriptions: true,

     

       124
       124
       -
                   schemaDescription: false,

     

       125
       125
       -
                   inputValueDeprecation: false,

     

       126
       126
       -
                   directiveIsRepeatable: false,

     

       127
       127
       -
                   specifiedByUrl: false,

     

       128
       128
       -
                 }),

     

       129
       129
       -
               }),

     

       130
       130
       -
             })

     

       131
       131
       -
               .then(response => {

     

       132
       132
       -
                 logger(`Got response ${response.statusText} ${response.status}`);

     

       133
       133
       -
                 if (response.ok) return response.json();

     

       134
       134
       -
                 else return response.text();

     

       135
       135
       -
               })

     

       136
       136
       -
               .then(result => {

     

       137
       137
       -
                 if (typeof result === 'string') {

     

       138
       138
       -
                   logger(`Got error while fetching introspection ${result}`);

     

       139
       139
       -
                 } else if (result.data) {

     

       140
       140
       -
                   const introspection = (result as { data: IntrospectionQuery }).data;

     

       141
       141
       -
                   const currentStringified = JSON.stringify(introspection);

     

       142
       142
       -
                   if (ref.prev && ref.prev === currentStringified) {

     

       143
       143
       -
                     return;

     

       144
       144
       -
                   }

     

       85
       85
       +
           logger('Got root-directory to resolve schema from: ' + rootPath);

     

       86
       86
       +
           logger('Resolving schema from "schema" config: ' + JSON.stringify(origin));

     

       145
       87
        
       

     

       146
       146
       -
                   ref.prev = currentStringified;

     

       147
       147
       -
                   try {

     

       148
       148
       -
                     if (tadaOutputLocation) {

     

       149
       149
       -
                       saveTadaIntrospection(

     

       150
       150
       -
                         root,

     

       151
       151
       -
                         introspection,

     

       152
       152
       -
                         tadaOutputLocation,

     

       153
       153
       -
                         info.config.tadaDisablePreprocessing ?? false,

     

       154
       154
       -
                         logger

     

       155
       155
       -
                       );

     

       156
       156
       -
                     }

     

       88
       88
       +
           const loader = load({ origin, rootPath });

     

       157
       89
        
       

     

       158
       158
       -
                     ref.current = buildClientSchema(introspection);

     

       159
       159
       -
                     ref.version = ref.version + 1;

     

       160
       160
       -
                     logger(`Got schema for ${url!.toString()}`);

     

       161
       161
       -
                   } catch (e: any) {

     

       162
       162
       -
                     logger(`Got schema error for ${e.message}`);

     

       163
       163
       -
                   }

     

       164
       164
       -
                 } else {

     

       165
       165
       -
                   logger(`Got invalid response ${JSON.stringify(result)}`);

     

       166
       166
       -
                 }

     

       167
       167
       -
               });

     

       90
       90
       +
           try {

     

       91
       91
       +
             logger(`Loading schema from "${origin}"`);

     

       92
       92
       +
             loaderResult = await loader.load();

     

       93
       93
       +
           } catch (error) {

     

       94
       94
       +
             logger(`Failed to load schema: ${error}`);

     

       95
       95
       +
           }

     

       168
       96
        
       

     

       169
       169
       -
             setTimeout(() => {

     

       170
       170
       -
               pollSchema();

     

       171
       171
       -
             }, 1000 * 60);

     

       172
       172
       -
           };

     

       173
       173
       -
       

     

       174
       174
       -
           pollSchema();

     

       175
       175
       -
         } else if (typeof schema === 'string') {

     

       176
       176
       -
           const isJson = path.extname(schema) === '.json';

     

       177
       177
       -
           const resolvedPath = path.resolve(root, schema);

     

       178
       178
       -
           logger(`Getting schema from ${resolvedPath}`);

     

       179
       179
       -
       

     

       180
       180
       -
           async function readSchema() {

     

       181
       181
       -
             const contents = fs.readFileSync(resolvedPath, 'utf-8');

     

       182
       182
       -
       

     

       183
       183
       -
             const schemaOrIntrospection = isJson

     

       184
       184
       -
               ? (JSON.parse(contents) as IntrospectionQuery)

     

       185
       185
       -
               : buildSchema(contents);

     

       186
       186
       -
       

     

       187
       187
       -
             ref.version = ref.version + 1;

     

       188
       188
       -
             ref.current =

     

       189
       189
       -
               '__schema' in schemaOrIntrospection

     

       190
       190
       -
                 ? buildClientSchema(schemaOrIntrospection)

     

       191
       191
       -
                 : schemaOrIntrospection;

     

       192
       192
       -
       

     

       97
       97
       +
           if (loaderResult) {

     

       98
       98
       +
             ref.current = loaderResult && loaderResult.schema;

     

       99
       99
       +
             ref.version++;

     

       193
       100
        
             if (tadaOutputLocation) {

     

       194
       101
        
               saveTadaIntrospection(

     

       195
       195
       -
                 root,

     

       196
       196
       -
                 schemaOrIntrospection,

     

       102
       102
       +
                 loaderResult.introspection,

     

       197
       103
        
                 tadaOutputLocation,

     

       198
       198
       -
                 info.config.tadaDisablePreprocessing ?? false,

     

       104
       104
       +
                 tadaDisablePreprocessing,

     

       199
       105
        
                 logger

     

       200
       106
        
               );

     

       201
       107
        
             }

     

       202
       108
        
           }

     

       203
       109
        
       

     

       204
       204
       -
           readSchema();

     

       205
       205
       -
           fs.watchFile(resolvedPath, () => {

     

       206
       206
       -
             readSchema();

     

       110
       110
       +
           loader.notifyOnUpdate(result => {

     

       111
       111
       +
             logger(`Got schema for origin "${origin}"`);

     

       112
       112
       +
             ref.current = (loaderResult = result).schema;

     

       113
       113
       +
             ref.version++;

     

       114
       114
       +
             if (tadaOutputLocation) {

     

       115
       115
       +
               saveTadaIntrospection(

     

       116
       116
       +
                 loaderResult.introspection,

     

       117
       117
       +
                 tadaOutputLocation,

     

       118
       118
       +
                 tadaDisablePreprocessing,

     

       119
       119
       +
                 logger

     

       120
       120
       +
               );

     

       121
       121
       +
             }

     

       207
       122
        
           });

     

       208
       208
       -
       

     

       209
       209
       -
           logger(`Got schema and initialized watcher for ${schema}`);

     

       210
       210
       -
         }

     

       123
       123
       +
         })();

     

       211
       124
        
       

     

       212
       125
        
         return ref;

     

       213
       126
        
       };

+7 -13

packages/graphqlsp/src/index.ts

···

       1
       1
       +
       import type { SchemaOrigin } from '@gql.tada/internal';

     

       2
       2
       +
       

     

       1
       3
        
       import { ts, init as initTypeScript } from './ts';

     

       2
       2
       -
       import { SchemaOrigin, loadSchema } from './graphql/getSchema';

     

       4
       4
       +
       import { loadSchema } from './graphql/getSchema';

     

       3
       5
        
       import { getGraphQLCompletions } from './autoComplete';

     

       4
       6
        
       import { getGraphQLQuickInfo } from './quickInfo';

     

       5
       7
        
       import { ALL_DIAGNOSTICS, getGraphQLDiagnostics } from './diagnostics';

     
···

       20
       22
        
       

     

       21
       23
        
       export type Logger = (msg: string) => void;

     

       22
       24
        
       

     

       23
       23
       -
       type Config = {

     

       24
       24
       -
         schema: SchemaOrigin | string;

     

       25
       25
       +
       interface Config {

     

       26
       26
       +
         schema: SchemaOrigin;

     

       25
       27
        
         tadaDisablePreprocessing?: boolean;

     

       26
       28
        
         templateIsCallExpression?: boolean;

     

       27
       29
        
         shouldCheckForColocatedFragments?: boolean;

     

       28
       30
        
         template?: string;

     

       29
       31
        
         trackFieldUsage?: boolean;

     

       30
       32
        
         tadaOutputLocation?: string;

     

       31
       31
       -
       };

     

       33
       33
       +
       }

     

       32
       34
        
       

     

       33
       35
        
       function create(info: ts.server.PluginCreateInfo) {

     

       34
       36
        
         const logger: Logger = (msg: string) =>

     
···

       49
       51
        
       

     

       50
       52
        
         const proxy = createBasicDecorator(info);

     

       51
       53
        
       

     

       52
       52
       -
         const schema = loadSchema(

     

       53
       53
       -
           info,

     

       54
       54
       -
           config.schema,

     

       55
       55
       -
           // TODO: either we check here for the client having a package.json

     

       56
       56
       -
           // with gql.tada and use a default file loc or we use a config

     

       57
       57
       -
           // option with a location

     

       58
       58
       -
           config.tadaOutputLocation,

     

       59
       59
       -
           logger

     

       60
       60
       -
         );

     

       54
       54
       +
         const schema = loadSchema(info, config.schema, logger);

     

       61
       55
        
       

     

       62
       56
        
         proxy.getSemanticDiagnostics = (filename: string): ts.Diagnostic[] => {

     

       63
       57
        
           const originalDiagnostics =

+28 -6

pnpm-lock.yaml

···

       169
       169
        
         packages/graphqlsp:

     

       170
       170
        
           dependencies:

     

       171
       171
        
             '@gql.tada/internal':

     

       172
       172
       -
               specifier: ^0.1.0

     

       173
       173
       -
               version: 0.1.0

     

       172
       172
       +
               specifier: ^0.1.2

     

       173
       173
       +
               version: 0.1.2(graphql@16.8.1)(typescript@5.3.3)

     

       174
       174
       +
             graphql:

     

       175
       175
       +
               specifier: ^16.8.1

     

       176
       176
       +
               version: 16.8.1

     

       174
       177
        
             node-fetch:

     

       175
       178
        
               specifier: ^2.0.0

     

       176
       179
        
               version: 2.6.7

     
···

       187
       190
        
             '@types/node-fetch':

     

       188
       191
        
               specifier: ^2.6.3

     

       189
       192
        
               version: 2.6.3

     

       190
       190
       -
             graphql:

     

       191
       191
       -
               specifier: ^16.8.1

     

       192
       192
       -
               version: 16.8.1

     

       193
       193
        
             graphql-language-service:

     

       194
       194
        
               specifier: ^5.2.0

     

       195
       195
        
               version: 5.2.0(graphql@16.8.1)

     
···

       283
       283
        
       

     

       284
       284
        
         /@0no-co/graphql.web@1.0.4(graphql@16.8.1):

     

       285
       285
        
           resolution: {integrity: sha512-W3ezhHGfO0MS1PtGloaTpg0PbaT8aZSmmaerL7idtU5F7oCI+uu25k+MsMS31BVFlp4aMkHSrNRxiD72IlK8TA==}

     

       286
       286
       +
           peerDependencies:

     

       287
       287
       +
             graphql: ^14.0.0 || ^15.0.0 || ^16.0.0

     

       288
       288
       +
           peerDependenciesMeta:

     

       289
       289
       +
             graphql:

     

       290
       290
       +
               optional: true

     

       291
       291
       +
           dependencies:

     

       292
       292
       +
             graphql: 16.8.1

     

       293
       293
       +
       

     

       294
       294
       +
         /@0no-co/graphql.web@1.0.6(graphql@16.8.1):

     

       295
       295
       +
           resolution: {integrity: sha512-KZ7TnwMcQJcFgzjoY623AVxtlDQonkqp3rSz0wb15/jHPyU1v5gynUibEpuutDeoyGJ5Tp+FwxjGyDGDwq3vIw==}

     

       286
       296
        
           peerDependencies:

     

       287
       297
        
             graphql: ^14.0.0 || ^15.0.0 || ^16.0.0

     

       288
       298
        
           peerDependenciesMeta:

     
···

       1323
       1333
        
         /@gql.tada/internal@0.1.0:

     

       1324
       1334
        
           resolution: {integrity: sha512-FTvBVXVvt0xUo8hvRlwFoyeNXpUDqc+e20MzFkF8ozbsa5PoYb/gksmmnHMjUphsIq1H3Hq8o4RGstFN5LKH4w==}

     

       1325
       1335
        
           dependencies:

     

       1336
       1336
       +
             graphql: 16.8.1

     

       1337
       1337
       +
             typescript: 5.3.3

     

       1338
       1338
       +
           dev: false

     

       1339
       1339
       +
       

     

       1340
       1340
       +
         /@gql.tada/internal@0.1.2(graphql@16.8.1)(typescript@5.3.3):

     

       1341
       1341
       +
           resolution: {integrity: sha512-8I4Z1zxYYGK66FWdB3yIZBn3cITLPnciEgjChp3K2+Ha1e/AEBGtZv9AUlodraO/RZafDMkpFhoi+tMpluBjeg==}

     

       1342
       1342
       +
           peerDependencies:

     

       1343
       1343
       +
             graphql: ^16.8.1

     

       1344
       1344
       +
             typescript: ^5.3.3

     

       1345
       1345
       +
           dependencies:

     

       1346
       1346
       +
             '@0no-co/graphql.web': 1.0.6(graphql@16.8.1)

     

       1326
       1347
        
             graphql: 16.8.1

     

       1327
       1348
        
             typescript: 5.3.3

     

       1328
       1349
        
       

     
···

       6187
       6208
        
           peerDependencies:

     

       6188
       6209
        
             typescript: ^5.0.0

     

       6189
       6210
        
           dependencies:

     

       6190
       6190
       -
             '@gql.tada/internal': 0.1.0

     

       6211
       6211
       +
             '@gql.tada/internal': 0.1.2(graphql@16.8.1)(typescript@5.3.3)

     

       6212
       6212
       +
             graphql: 16.8.1

     

       6191
       6213
        
             node-fetch: 2.6.7

     

       6192
       6214
        
             typescript: 5.3.3

     

       6193
       6215
        
           transitivePeerDependencies: