commit fa956f9e41715e19e8db06459b12b0ad1b773765 · kitten.sh/graphqlsp

+115

packages/graphqlsp/src/checkImports.ts

···

       1
       1
       +
       import ts from 'typescript/lib/tsserverlibrary';

     

       2
       2
       +
       import { Kind, parse } from 'graphql';

     

       3
       3
       +
       

     

       4
       4
       +
       import { findAllImports, findAllTaggedTemplateNodes } from './ast';

     

       5
       5
       +
       import { resolveTemplate } from './ast/resolve';

     

       6
       6
       +
       

     

       7
       7
       +
       export const MISSING_FRAGMENT_CODE = 52003;

     

       8
       8
       +
       

     

       9
       9
       +
       export const checkImportsForFragments = (

     

       10
       10
       +
         source: ts.SourceFile,

     

       11
       11
       +
         info: ts.server.PluginCreateInfo

     

       12
       12
       +
       ) => {

     

       13
       13
       +
         const imports = findAllImports(source);

     

       14
       14
       +
       

     

       15
       15
       +
         const shouldCheckForColocatedFragments =

     

       16
       16
       +
           info.config.shouldCheckForColocatedFragments ?? false;

     

       17
       17
       +
         const tsDiagnostics: ts.Diagnostic[] = [];

     

       18
       18
       +
         if (imports.length && shouldCheckForColocatedFragments) {

     

       19
       19
       +
           const typeChecker = info.languageService.getProgram()?.getTypeChecker();

     

       20
       20
       +
           imports.forEach(imp => {

     

       21
       21
       +
             if (!imp.importClause) return;

     

       22
       22
       +
       

     

       23
       23
       +
             const importedNames: string[] = [];

     

       24
       24
       +
             if (imp.importClause.name) {

     

       25
       25
       +
               importedNames.push(imp.importClause?.name.text);

     

       26
       26
       +
             }

     

       27
       27
       +
       

     

       28
       28
       +
             if (

     

       29
       29
       +
               imp.importClause.namedBindings &&

     

       30
       30
       +
               ts.isNamespaceImport(imp.importClause.namedBindings)

     

       31
       31
       +
             ) {

     

       32
       32
       +
               // TODO: we might need to warn here when the fragment is unused as a namespace import

     

       33
       33
       +
               return;

     

       34
       34
       +
             } else if (

     

       35
       35
       +
               imp.importClause.namedBindings &&

     

       36
       36
       +
               ts.isNamedImportBindings(imp.importClause.namedBindings)

     

       37
       37
       +
             ) {

     

       38
       38
       +
               imp.importClause.namedBindings.elements.forEach(el => {

     

       39
       39
       +
                 importedNames.push(el.name.text);

     

       40
       40
       +
               });

     

       41
       41
       +
             }

     

       42
       42
       +
       

     

       43
       43
       +
             const symbol = typeChecker?.getSymbolAtLocation(imp.moduleSpecifier);

     

       44
       44
       +
             if (!symbol) return;

     

       45
       45
       +
       

     

       46
       46
       +
             const moduleExports = typeChecker?.getExportsOfModule(symbol);

     

       47
       47
       +
             if (!moduleExports) return;

     

       48
       48
       +
       

     

       49
       49
       +
             const missingImports = moduleExports

     

       50
       50
       +
               .map(exp => {

     

       51
       51
       +
                 if (importedNames.includes(exp.name)) {

     

       52
       52
       +
                   return;

     

       53
       53
       +
                 }

     

       54
       54
       +
       

     

       55
       55
       +
                 const declarations = exp.getDeclarations();

     

       56
       56
       +
                 const declaration = declarations?.find(x => {

     

       57
       57
       +
                   // TODO: check whether the sourceFile.fileName resembles the module

     

       58
       58
       +
                   // specifier

     

       59
       59
       +
                   return true;

     

       60
       60
       +
                 });

     

       61
       61
       +
       

     

       62
       62
       +
                 if (!declaration) return;

     

       63
       63
       +
       

     

       64
       64
       +
                 const [template] = findAllTaggedTemplateNodes(declaration);

     

       65
       65
       +
                 if (template) {

     

       66
       66
       +
                   let node = template;

     

       67
       67
       +
                   if (

     

       68
       68
       +
                     ts.isNoSubstitutionTemplateLiteral(node) ||

     

       69
       69
       +
                     ts.isTemplateExpression(node)

     

       70
       70
       +
                   ) {

     

       71
       71
       +
                     if (ts.isTaggedTemplateExpression(node.parent)) {

     

       72
       72
       +
                       node = node.parent;

     

       73
       73
       +
                     } else {

     

       74
       74
       +
                       return;

     

       75
       75
       +
                     }

     

       76
       76
       +
                   }

     

       77
       77
       +
       

     

       78
       78
       +
                   const text = resolveTemplate(

     

       79
       79
       +
                     node,

     

       80
       80
       +
                     node.getSourceFile().fileName,

     

       81
       81
       +
                     info

     

       82
       82
       +
                   ).combinedText;

     

       83
       83
       +
                   try {

     

       84
       84
       +
                     const parsed = parse(text, { noLocation: true });

     

       85
       85
       +
                     if (

     

       86
       86
       +
                       parsed.definitions.every(

     

       87
       87
       +
                         x => x.kind === Kind.FRAGMENT_DEFINITION

     

       88
       88
       +
                       )

     

       89
       89
       +
                     ) {

     

       90
       90
       +
                       return `'${exp.name}'`;

     

       91
       91
       +
                     }

     

       92
       92
       +
                   } catch (e) {

     

       93
       93
       +
                     return;

     

       94
       94
       +
                   }

     

       95
       95
       +
                 }

     

       96
       96
       +
               })

     

       97
       97
       +
               .filter(Boolean);

     

       98
       98
       +
       

     

       99
       99
       +
             if (missingImports.length) {

     

       100
       100
       +
               tsDiagnostics.push({

     

       101
       101
       +
                 file: source,

     

       102
       102
       +
                 length: imp.getText().length,

     

       103
       103
       +
                 start: imp.getStart(),

     

       104
       104
       +
                 category: ts.DiagnosticCategory.Message,

     

       105
       105
       +
                 code: MISSING_FRAGMENT_CODE,

     

       106
       106
       +
                 messageText: `Missing Fragment import(s) ${missingImports.join(

     

       107
       107
       +
                   ', '

     

       108
       108
       +
                 )} from ${imp.moduleSpecifier.getText()}.`,

     

       109
       109
       +
               });

     

       110
       110
       +
             }

     

       111
       111
       +
           });

     

       112
       112
       +
         }

     

       113
       113
       +
       

     

       114
       114
       +
         return tsDiagnostics;

     

       115
       115
       +
       };

+2 -404

packages/graphqlsp/src/diagnostics.ts

···

       7
       7
        
         OperationDefinitionNode,

     

       8
       8
        
         parse,

     

       9
       9
        
         print,

     

       10
       10
       -
         visit,

     

       11
       10
        
       } from 'graphql';

     

       12
       11
        
       import { LRUCache } from 'lru-cache';

     

       13
       12
        
       import fnv1a from '@sindresorhus/fnv1a';

     

       14
       13
        
       

     

       15
       14
        
       import {

     

       16
       15
        
         findAllCallExpressions,

     

       17
       17
       -
         findAllImports,

     

       18
       16
        
         findAllTaggedTemplateNodes,

     

       19
       19
       -
         findNode,

     

       20
       17
        
         getSource,

     

       21
       18
        
         isFileDirty,

     

       22
       19
        
       } from './ast';

     

       23
       20
        
       import { resolveTemplate } from './ast/resolve';

     

       24
       21
        
       import { generateTypedDocumentNodes } from './graphql/generateTypes';

     

       25
       25
       -
       import { Logger } from '.';

     

       22
       22
       +
       import { checkFieldUsageInFile } from './fieldUsage';

     

       23
       23
       +
       import { checkImportsForFragments } from './checkImports';

     

       26
       24
        
       

     

       27
       25
        
       const clientDirectives = new Set([

     

       28
       26
        
         'populate',

     
···

       41
       39
        
       

     

       42
       40
        
       export const SEMANTIC_DIAGNOSTIC_CODE = 52001;

     

       43
       41
        
       export const MISSING_OPERATION_NAME_CODE = 52002;

     

       44
       44
       -
       export const MISSING_FRAGMENT_CODE = 52003;

     

       45
       42
        
       export const USING_DEPRECATED_FIELD_CODE = 52004;

     

       46
       46
       -
       export const UNUSED_FIELD_CODE = 52005;

     

       47
       43
        
       

     

       48
       44
        
       let isGeneratingTypes = false;

     

       49
       45
        
       

     
···

       317
       313
        
           : checkImportsForFragments(source, info);

     

       318
       314
        
       

     

       319
       315
        
         return [...tsDiagnostics, ...importDiagnostics];

     

       320
       320
       -
       };

     

       321
       321
       -
       

     

       322
       322
       -
       const getVariableDeclaration = (start: ts.NoSubstitutionTemplateLiteral) => {

     

       323
       323
       -
         let node: any = start;

     

       324
       324
       -
         let counter = 0;

     

       325
       325
       -
         while (!ts.isVariableDeclaration(node) && node.parent && counter < 5) {

     

       326
       326
       -
           node = node.parent;

     

       327
       327
       -
           counter++;

     

       328
       328
       -
         }

     

       329
       329
       -
         return node;

     

       330
       330
       -
       };

     

       331
       331
       -
       

     

       332
       332
       -
       const traverseDestructuring = (

     

       333
       333
       -
         node: ts.ObjectBindingPattern,

     

       334
       334
       -
         originalWip: Array<string>,

     

       335
       335
       -
         allFields: Array<string>,

     

       336
       336
       -
         source: ts.SourceFile,

     

       337
       337
       -
         info: ts.server.PluginCreateInfo

     

       338
       338
       -
       ): Array<string> => {

     

       339
       339
       -
         const results = [];

     

       340
       340
       -
         for (const binding of node.elements) {

     

       341
       341
       -
           if (ts.isObjectBindingPattern(binding.name)) {

     

       342
       342
       -
             const wip = [...originalWip];

     

       343
       343
       -
             if (

     

       344
       344
       -
               binding.propertyName &&

     

       345
       345
       -
               allFields.includes(binding.propertyName.getText()) &&

     

       346
       346
       -
               !originalWip.includes(binding.propertyName.getText())

     

       347
       347
       -
             ) {

     

       348
       348
       -
               wip.push(binding.propertyName.getText());

     

       349
       349
       -
             }

     

       350
       350
       -
             const traverseResult = traverseDestructuring(

     

       351
       351
       -
               binding.name,

     

       352
       352
       -
               wip,

     

       353
       353
       -
               allFields,

     

       354
       354
       -
               source,

     

       355
       355
       -
               info

     

       356
       356
       -
             );

     

       357
       357
       -
       

     

       358
       358
       -
             results.push(...traverseResult);

     

       359
       359
       -
           } else if (ts.isIdentifier(binding.name)) {

     

       360
       360
       -
             const wip = [...originalWip];

     

       361
       361
       -
             if (

     

       362
       362
       -
               binding.propertyName &&

     

       363
       363
       -
               allFields.includes(binding.propertyName.getText()) &&

     

       364
       364
       -
               !originalWip.includes(binding.propertyName.getText())

     

       365
       365
       -
             ) {

     

       366
       366
       -
               wip.push(binding.propertyName.getText());

     

       367
       367
       -
             } else {

     

       368
       368
       -
               wip.push(binding.name.getText());

     

       369
       369
       -
             }

     

       370
       370
       -
       

     

       371
       371
       -
             const crawlResult = crawlScope(

     

       372
       372
       -
               binding.name,

     

       373
       373
       -
               wip,

     

       374
       374
       -
               allFields,

     

       375
       375
       -
               source,

     

       376
       376
       -
               info

     

       377
       377
       -
             );

     

       378
       378
       -
       

     

       379
       379
       -
             results.push(...crawlResult);

     

       380
       380
       -
           }

     

       381
       381
       -
         }

     

       382
       382
       -
       

     

       383
       383
       -
         return results;

     

       384
       384
       -
       };

     

       385
       385
       -
       

     

       386
       386
       -
       const crawlScope = (

     

       387
       387
       -
         node: ts.Identifier | ts.BindingName,

     

       388
       388
       -
         originalWip: Array<string>,

     

       389
       389
       -
         allFields: Array<string>,

     

       390
       390
       -
         source: ts.SourceFile,

     

       391
       391
       -
         info: ts.server.PluginCreateInfo

     

       392
       392
       -
       ): Array<string> => {

     

       393
       393
       -
         let results: string[] = [];

     

       394
       394
       -
       

     

       395
       395
       -
         const references = info.languageService.getReferencesAtPosition(

     

       396
       396
       -
           source.fileName,

     

       397
       397
       -
           node.getStart()

     

       398
       398
       -
         );

     

       399
       399
       -
       

     

       400
       400
       -
         if (!references) return results;

     

       401
       401
       -
       

     

       402
       402
       -
         // Go over all the references tied to the result of

     

       403
       403
       -
         // accessing our equery and collect them as fully

     

       404
       404
       -
         // qualified paths (ideally ending in a leaf-node)

     

       405
       405
       -
         results = references.flatMap(ref => {

     

       406
       406
       -
           // If we get a reference to a different file we can bail

     

       407
       407
       -
           if (ref.fileName !== source.fileName) return [];

     

       408
       408
       -
           // We don't want to end back at our document so we narrow

     

       409
       409
       -
           // the scope.

     

       410
       410
       -
           if (

     

       411
       411
       -
             node.getStart() <= ref.textSpan.start &&

     

       412
       412
       -
             node.getEnd() >= ref.textSpan.start + ref.textSpan.length

     

       413
       413
       -
           )

     

       414
       414
       -
             return [];

     

       415
       415
       -
       

     

       416
       416
       -
           let foundRef = findNode(source, ref.textSpan.start);

     

       417
       417
       -
           if (!foundRef) return [];

     

       418
       418
       -
       

     

       419
       419
       -
           const pathParts = [...originalWip];

     

       420
       420
       -
           // In here we'll start crawling all the accessors of result

     

       421
       421
       -
           // and try to determine the total path

     

       422
       422
       -
           // - result.data.pokemon.name --> pokemon.name this is the easy route and never accesses

     

       423
       423
       -
           //   any of the recursive functions

     

       424
       424
       -
           // - const pokemon = result.data.pokemon --> this initiates a new crawl with a renewed scope

     

       425
       425
       -
           // - const { pokemon } = result.data --> this initiates a destructuring traversal which will

     

       426
       426
       -
           //   either end up in more destructuring traversals or a scope crawl

     

       427
       427
       -
           while (

     

       428
       428
       -
             ts.isIdentifier(foundRef) ||

     

       429
       429
       -
             ts.isPropertyAccessExpression(foundRef) ||

     

       430
       430
       -
             ts.isElementAccessExpression(foundRef) ||

     

       431
       431
       -
             ts.isVariableDeclaration(foundRef) ||

     

       432
       432
       -
             ts.isBinaryExpression(foundRef)

     

       433
       433
       -
           ) {

     

       434
       434
       -
             if (ts.isVariableDeclaration(foundRef)) {

     

       435
       435
       -
               if (ts.isIdentifier(foundRef.name)) {

     

       436
       436
       -
                 // We have already added the paths because of the right-hand expression,

     

       437
       437
       -
                 // const pokemon = result.data.pokemon --> we have pokemon as our path,

     

       438
       438
       -
                 // now re-crawling pokemon for all of its accessors should deliver us the usage

     

       439
       439
       -
                 // patterns... This might get expensive though if we need to perform this deeply.

     

       440
       440
       -
                 return crawlScope(foundRef.name, pathParts, allFields, source, info);

     

       441
       441
       -
               } else if (ts.isObjectBindingPattern(foundRef.name)) {

     

       442
       442
       -
                 // First we need to traverse the left-hand side of the variable assignment,

     

       443
       443
       -
                 // this could be tree-like as we could be dealing with

     

       444
       444
       -
                 // - const { x: { y: z }, a: { b: { c, d }, e: { f } } } = result.data

     

       445
       445
       -
                 // Which we will need several paths for...

     

       446
       446
       -
                 // after doing that we need to re-crawl all of the resulting variables

     

       447
       447
       -
                 // Crawl down until we have either a leaf node or an object/array that can

     

       448
       448
       -
                 // be recrawled

     

       449
       449
       -
                 return traverseDestructuring(

     

       450
       450
       -
                   foundRef.name,

     

       451
       451
       -
                   pathParts,

     

       452
       452
       -
                   allFields,

     

       453
       453
       -
                   source,

     

       454
       454
       -
                   info

     

       455
       455
       -
                 );

     

       456
       456
       -
               }

     

       457
       457
       -
             } else if (

     

       458
       458
       -
               ts.isIdentifier(foundRef) &&

     

       459
       459
       -
               allFields.includes(foundRef.text) &&

     

       460
       460
       -
               !pathParts.includes(foundRef.text)

     

       461
       461
       -
             ) {

     

       462
       462
       -
               pathParts.push(foundRef.text);

     

       463
       463
       -
             } else if (

     

       464
       464
       -
               ts.isPropertyAccessExpression(foundRef) &&

     

       465
       465
       -
               allFields.includes(foundRef.name.text) &&

     

       466
       466
       -
               !pathParts.includes(foundRef.name.text)

     

       467
       467
       -
             ) {

     

       468
       468
       -
               pathParts.push(foundRef.name.text);

     

       469
       469
       -
             } else if (

     

       470
       470
       -
               ts.isElementAccessExpression(foundRef) &&

     

       471
       471
       -
               ts.isStringLiteral(foundRef.argumentExpression) &&

     

       472
       472
       -
               allFields.includes(foundRef.argumentExpression.text) &&

     

       473
       473
       -
               !pathParts.includes(foundRef.argumentExpression.text)

     

       474
       474
       -
             ) {

     

       475
       475
       -
               pathParts.push(foundRef.argumentExpression.text);

     

       476
       476
       -
             }

     

       477
       477
       -
       

     

       478
       478
       -
             foundRef = foundRef.parent;

     

       479
       479
       -
           }

     

       480
       480
       -
       

     

       481
       481
       -
           return pathParts.join('.');

     

       482
       482
       -
         });

     

       483
       483
       -
       

     

       484
       484
       -
         return results;

     

       485
       485
       -
       };

     

       486
       486
       -
       

     

       487
       487
       -
       const checkFieldUsageInFile = (

     

       488
       488
       -
         source: ts.SourceFile,

     

       489
       489
       -
         nodes: ts.NoSubstitutionTemplateLiteral[],

     

       490
       490
       -
         info: ts.server.PluginCreateInfo

     

       491
       491
       -
       ) => {

     

       492
       492
       -
         const logger: Logger = (msg: string) =>

     

       493
       493
       -
           info.project.projectService.logger.info(`[GraphQLSP] ${msg}`);

     

       494
       494
       -
         const diagnostics: ts.Diagnostic[] = [];

     

       495
       495
       -
         const shouldTrackFieldUsage = info.config.trackFieldUsage ?? false;

     

       496
       496
       -
         if (!shouldTrackFieldUsage) return diagnostics;

     

       497
       497
       -
       

     

       498
       498
       -
         nodes.forEach(node => {

     

       499
       499
       -
           const nodeText = node.getText();

     

       500
       500
       -
           // Bailing for mutations/subscriptions as these could have small details

     

       501
       501
       -
           // for normalised cache interactions

     

       502
       502
       -
           if (nodeText.includes('mutation') || nodeText.includes('subscription'))

     

       503
       503
       -
             return;

     

       504
       504
       -
       

     

       505
       505
       -
           const variableDeclaration = getVariableDeclaration(node);

     

       506
       506
       -
           if (!ts.isVariableDeclaration(variableDeclaration)) return;

     

       507
       507
       -
       

     

       508
       508
       -
           const references = info.languageService.getReferencesAtPosition(

     

       509
       509
       -
             source.fileName,

     

       510
       510
       -
             variableDeclaration.name.getStart()

     

       511
       511
       -
           );

     

       512
       512
       -
           if (!references) return;

     

       513
       513
       -
       

     

       514
       514
       -
           references.forEach(ref => {

     

       515
       515
       -
             if (ref.fileName !== source.fileName) return;

     

       516
       516
       -
       

     

       517
       517
       -
             let found = findNode(source, ref.textSpan.start);

     

       518
       518
       -
             while (found && !ts.isVariableStatement(found)) {

     

       519
       519
       -
               found = found.parent;

     

       520
       520
       -
             }

     

       521
       521
       -
       

     

       522
       522
       -
             if (!found || !ts.isVariableStatement(found)) return;

     

       523
       523
       -
       

     

       524
       524
       -
             const [output] = found.declarationList.declarations;

     

       525
       525
       -
       

     

       526
       526
       -
             if (output.name.getText() === variableDeclaration.name.getText()) return;

     

       527
       527
       -
       

     

       528
       528
       -
             const inProgress: string[] = [];

     

       529
       529
       -
             const allPaths: string[] = [];

     

       530
       530
       -
             const allFields: string[] = [];

     

       531
       531
       -
             const reserved = ['id', '__typename'];

     

       532
       532
       -
             const fieldToLoc = new Map<string, { start: number; length: number }>();

     

       533
       533
       -
             // This visitor gets all the leaf-paths in the document

     

       534
       534
       -
             // as well as all fields that are part of the document

     

       535
       535
       -
             // We need the leaf-paths to check usage and we need the

     

       536
       536
       -
             // fields to validate whether an access on a given reference

     

       537
       537
       -
             // is valid given the current document...

     

       538
       538
       -
             visit(parse(node.getText().slice(1, -1)), {

     

       539
       539
       -
               Field: {

     

       540
       540
       -
                 enter: node => {

     

       541
       541
       -
                   if (!reserved.includes(node.name.value)) {

     

       542
       542
       -
                     allFields.push(node.name.value);

     

       543
       543
       -
                   }

     

       544
       544
       -
       

     

       545
       545
       -
                   if (!node.selectionSet && !reserved.includes(node.name.value)) {

     

       546
       546
       -
                     let p;

     

       547
       547
       -
                     if (inProgress.length) {

     

       548
       548
       -
                       p = inProgress.join('.') + '.' + node.name.value;

     

       549
       549
       -
                     } else {

     

       550
       550
       -
                       p = node.name.value;

     

       551
       551
       -
                     }

     

       552
       552
       -
                     allPaths.push(p);

     

       553
       553
       -
       

     

       554
       554
       -
                     fieldToLoc.set(p, {

     

       555
       555
       -
                       start: node.name.loc!.start,

     

       556
       556
       -
                       length: node.name.loc!.end - node.name.loc!.start,

     

       557
       557
       -
                     });

     

       558
       558
       -
                   } else if (node.selectionSet) {

     

       559
       559
       -
                     inProgress.push(node.name.value);

     

       560
       560
       -
                   }

     

       561
       561
       -
                 },

     

       562
       562
       -
                 leave: node => {

     

       563
       563
       -
                   if (node.selectionSet) {

     

       564
       564
       -
                     inProgress.pop();

     

       565
       565
       -
                   }

     

       566
       566
       -
                 },

     

       567
       567
       -
               },

     

       568
       568
       -
             });

     

       569
       569
       -
       

     

       570
       570
       -
             let temp = output.name;

     

       571
       571
       -
             // Supported cases:

     

       572
       572
       -
             // - const result = await client.query() || useFragment()

     

       573
       573
       -
             // - const [result] = useQuery() --> urql

     

       574
       574
       -
             // - const { data } = useQuery() --> Apollo

     

       575
       575
       -
             // - const { field } = useFragment()

     

       576
       576
       -
             // - const [{ data }] = useQuery()

     

       577
       577
       -
             // - const { data: { pokemon } } = useQuery()

     

       578
       578
       -
             if (

     

       579
       579
       -
               ts.isArrayBindingPattern(temp) &&

     

       580
       580
       -
               ts.isBindingElement(temp.elements[0])

     

       581
       581
       -
             ) {

     

       582
       582
       -
               temp = temp.elements[0].name;

     

       583
       583
       -
             }

     

       584
       584
       -
       

     

       585
       585
       -
             let allAccess: string[] = [];

     

       586
       586
       -
             if (ts.isObjectBindingPattern(temp)) {

     

       587
       587
       -
               allAccess = traverseDestructuring(temp, [], allFields, source, info);

     

       588
       588
       -
             } else {

     

       589
       589
       -
               allAccess = crawlScope(temp, [], allFields, source, info);

     

       590
       590
       -
             }

     

       591
       591
       -
       

     

       592
       592
       -
             const unused = allPaths.filter(x => !allAccess.includes(x));

     

       593
       593
       -
             unused.forEach(unusedField => {

     

       594
       594
       -
               const loc = fieldToLoc.get(unusedField);

     

       595
       595
       -
               if (!loc) return;

     

       596
       596
       -
       

     

       597
       597
       -
               diagnostics.push({

     

       598
       598
       -
                 file: source,

     

       599
       599
       -
                 length: loc.length,

     

       600
       600
       -
                 start: node.getStart() + loc.start + 1,

     

       601
       601
       -
                 category: ts.DiagnosticCategory.Warning,

     

       602
       602
       -
                 code: UNUSED_FIELD_CODE,

     

       603
       603
       -
                 messageText: `Field '${unusedField}' is not used.`,

     

       604
       604
       -
               });

     

       605
       605
       -
             });

     

       606
       606
       -
           });

     

       607
       607
       -
         });

     

       608
       608
       -
       

     

       609
       609
       -
         return diagnostics;

     

       610
       610
       -
       };

     

       611
       611
       -
       

     

       612
       612
       -
       const checkImportsForFragments = (

     

       613
       613
       -
         source: ts.SourceFile,

     

       614
       614
       -
         info: ts.server.PluginCreateInfo

     

       615
       615
       -
       ) => {

     

       616
       616
       -
         const imports = findAllImports(source);

     

       617
       617
       -
       

     

       618
       618
       -
         const shouldCheckForColocatedFragments =

     

       619
       619
       -
           info.config.shouldCheckForColocatedFragments ?? false;

     

       620
       620
       -
         const tsDiagnostics: ts.Diagnostic[] = [];

     

       621
       621
       -
         if (imports.length && shouldCheckForColocatedFragments) {

     

       622
       622
       -
           const typeChecker = info.languageService.getProgram()?.getTypeChecker();

     

       623
       623
       -
           imports.forEach(imp => {

     

       624
       624
       -
             if (!imp.importClause) return;

     

       625
       625
       -
       

     

       626
       626
       -
             const importedNames: string[] = [];

     

       627
       627
       -
             if (imp.importClause.name) {

     

       628
       628
       -
               importedNames.push(imp.importClause?.name.text);

     

       629
       629
       -
             }

     

       630
       630
       -
       

     

       631
       631
       -
             if (

     

       632
       632
       -
               imp.importClause.namedBindings &&

     

       633
       633
       -
               ts.isNamespaceImport(imp.importClause.namedBindings)

     

       634
       634
       -
             ) {

     

       635
       635
       -
               // TODO: we might need to warn here when the fragment is unused as a namespace import

     

       636
       636
       -
               return;

     

       637
       637
       -
             } else if (

     

       638
       638
       -
               imp.importClause.namedBindings &&

     

       639
       639
       -
               ts.isNamedImportBindings(imp.importClause.namedBindings)

     

       640
       640
       -
             ) {

     

       641
       641
       -
               imp.importClause.namedBindings.elements.forEach(el => {

     

       642
       642
       -
                 importedNames.push(el.name.text);

     

       643
       643
       -
               });

     

       644
       644
       -
             }

     

       645
       645
       -
       

     

       646
       646
       -
             const symbol = typeChecker?.getSymbolAtLocation(imp.moduleSpecifier);

     

       647
       647
       -
             if (!symbol) return;

     

       648
       648
       -
       

     

       649
       649
       -
             const moduleExports = typeChecker?.getExportsOfModule(symbol);

     

       650
       650
       -
             if (!moduleExports) return;

     

       651
       651
       -
       

     

       652
       652
       -
             const missingImports = moduleExports

     

       653
       653
       -
               .map(exp => {

     

       654
       654
       -
                 if (importedNames.includes(exp.name)) {

     

       655
       655
       -
                   return;

     

       656
       656
       -
                 }

     

       657
       657
       -
       

     

       658
       658
       -
                 const declarations = exp.getDeclarations();

     

       659
       659
       -
                 const declaration = declarations?.find(x => {

     

       660
       660
       -
                   // TODO: check whether the sourceFile.fileName resembles the module

     

       661
       661
       -
                   // specifier

     

       662
       662
       -
                   return true;

     

       663
       663
       -
                 });

     

       664
       664
       -
       

     

       665
       665
       -
                 if (!declaration) return;

     

       666
       666
       -
       

     

       667
       667
       -
                 const [template] = findAllTaggedTemplateNodes(declaration);

     

       668
       668
       -
                 if (template) {

     

       669
       669
       -
                   let node = template;

     

       670
       670
       -
                   if (

     

       671
       671
       -
                     ts.isNoSubstitutionTemplateLiteral(node) ||

     

       672
       672
       -
                     ts.isTemplateExpression(node)

     

       673
       673
       -
                   ) {

     

       674
       674
       -
                     if (ts.isTaggedTemplateExpression(node.parent)) {

     

       675
       675
       -
                       node = node.parent;

     

       676
       676
       -
                     } else {

     

       677
       677
       -
                       return;

     

       678
       678
       -
                     }

     

       679
       679
       -
                   }

     

       680
       680
       -
       

     

       681
       681
       -
                   const text = resolveTemplate(

     

       682
       682
       -
                     node,

     

       683
       683
       -
                     node.getSourceFile().fileName,

     

       684
       684
       -
                     info

     

       685
       685
       -
                   ).combinedText;

     

       686
       686
       -
                   try {

     

       687
       687
       -
                     const parsed = parse(text, { noLocation: true });

     

       688
       688
       -
                     if (

     

       689
       689
       -
                       parsed.definitions.every(

     

       690
       690
       -
                         x => x.kind === Kind.FRAGMENT_DEFINITION

     

       691
       691
       -
                       )

     

       692
       692
       -
                     ) {

     

       693
       693
       -
                       return `'${exp.name}'`;

     

       694
       694
       -
                     }

     

       695
       695
       -
                   } catch (e) {

     

       696
       696
       -
                     return;

     

       697
       697
       -
                   }

     

       698
       698
       -
                 }

     

       699
       699
       -
               })

     

       700
       700
       -
               .filter(Boolean);

     

       701
       701
       -
       

     

       702
       702
       -
             if (missingImports.length) {

     

       703
       703
       -
               tsDiagnostics.push({

     

       704
       704
       -
                 file: source,

     

       705
       705
       -
                 length: imp.getText().length,

     

       706
       706
       -
                 start: imp.getStart(),

     

       707
       707
       -
                 category: ts.DiagnosticCategory.Message,

     

       708
       708
       -
                 code: MISSING_FRAGMENT_CODE,

     

       709
       709
       -
                 messageText: `Missing Fragment import(s) ${missingImports.join(

     

       710
       710
       -
                   ', '

     

       711
       711
       -
                 )} from ${imp.moduleSpecifier.getText()}.`,

     

       712
       712
       -
               });

     

       713
       713
       -
             }

     

       714
       714
       -
           });

     

       715
       715
       -
         }

     

       716
       716
       -
       

     

       717
       717
       -
         return tsDiagnostics;

     

       718
       316
        
       };

     

       719
       317
        
       

     

       720
       318
        
       const runTypedDocumentNodes = (

+294

packages/graphqlsp/src/fieldUsage.ts

···

       1
       1
       +
       import ts from 'typescript/lib/tsserverlibrary';

     

       2
       2
       +
       import { parse, visit } from 'graphql';

     

       3
       3
       +
       

     

       4
       4
       +
       import { findNode } from './ast';

     

       5
       5
       +
       

     

       6
       6
       +
       export const UNUSED_FIELD_CODE = 52005;

     

       7
       7
       +
       

     

       8
       8
       +
       const getVariableDeclaration = (start: ts.NoSubstitutionTemplateLiteral) => {

     

       9
       9
       +
         let node: any = start;

     

       10
       10
       +
         let counter = 0;

     

       11
       11
       +
         while (!ts.isVariableDeclaration(node) && node.parent && counter < 5) {

     

       12
       12
       +
           node = node.parent;

     

       13
       13
       +
           counter++;

     

       14
       14
       +
         }

     

       15
       15
       +
         return node;

     

       16
       16
       +
       };

     

       17
       17
       +
       

     

       18
       18
       +
       const traverseDestructuring = (

     

       19
       19
       +
         node: ts.ObjectBindingPattern,

     

       20
       20
       +
         originalWip: Array<string>,

     

       21
       21
       +
         allFields: Array<string>,

     

       22
       22
       +
         source: ts.SourceFile,

     

       23
       23
       +
         info: ts.server.PluginCreateInfo

     

       24
       24
       +
       ): Array<string> => {

     

       25
       25
       +
         const results = [];

     

       26
       26
       +
         for (const binding of node.elements) {

     

       27
       27
       +
           if (ts.isObjectBindingPattern(binding.name)) {

     

       28
       28
       +
             const wip = [...originalWip];

     

       29
       29
       +
             if (

     

       30
       30
       +
               binding.propertyName &&

     

       31
       31
       +
               allFields.includes(binding.propertyName.getText()) &&

     

       32
       32
       +
               !originalWip.includes(binding.propertyName.getText())

     

       33
       33
       +
             ) {

     

       34
       34
       +
               wip.push(binding.propertyName.getText());

     

       35
       35
       +
             }

     

       36
       36
       +
             const traverseResult = traverseDestructuring(

     

       37
       37
       +
               binding.name,

     

       38
       38
       +
               wip,

     

       39
       39
       +
               allFields,

     

       40
       40
       +
               source,

     

       41
       41
       +
               info

     

       42
       42
       +
             );

     

       43
       43
       +
       

     

       44
       44
       +
             results.push(...traverseResult);

     

       45
       45
       +
           } else if (ts.isIdentifier(binding.name)) {

     

       46
       46
       +
             const wip = [...originalWip];

     

       47
       47
       +
             if (

     

       48
       48
       +
               binding.propertyName &&

     

       49
       49
       +
               allFields.includes(binding.propertyName.getText()) &&

     

       50
       50
       +
               !originalWip.includes(binding.propertyName.getText())

     

       51
       51
       +
             ) {

     

       52
       52
       +
               wip.push(binding.propertyName.getText());

     

       53
       53
       +
             } else {

     

       54
       54
       +
               wip.push(binding.name.getText());

     

       55
       55
       +
             }

     

       56
       56
       +
       

     

       57
       57
       +
             const crawlResult = crawlScope(

     

       58
       58
       +
               binding.name,

     

       59
       59
       +
               wip,

     

       60
       60
       +
               allFields,

     

       61
       61
       +
               source,

     

       62
       62
       +
               info

     

       63
       63
       +
             );

     

       64
       64
       +
       

     

       65
       65
       +
             results.push(...crawlResult);

     

       66
       66
       +
           }

     

       67
       67
       +
         }

     

       68
       68
       +
       

     

       69
       69
       +
         return results;

     

       70
       70
       +
       };

     

       71
       71
       +
       

     

       72
       72
       +
       const crawlScope = (

     

       73
       73
       +
         node: ts.Identifier | ts.BindingName,

     

       74
       74
       +
         originalWip: Array<string>,

     

       75
       75
       +
         allFields: Array<string>,

     

       76
       76
       +
         source: ts.SourceFile,

     

       77
       77
       +
         info: ts.server.PluginCreateInfo

     

       78
       78
       +
       ): Array<string> => {

     

       79
       79
       +
         let results: string[] = [];

     

       80
       80
       +
       

     

       81
       81
       +
         const references = info.languageService.getReferencesAtPosition(

     

       82
       82
       +
           source.fileName,

     

       83
       83
       +
           node.getStart()

     

       84
       84
       +
         );

     

       85
       85
       +
       

     

       86
       86
       +
         if (!references) return results;

     

       87
       87
       +
       

     

       88
       88
       +
         // Go over all the references tied to the result of

     

       89
       89
       +
         // accessing our equery and collect them as fully

     

       90
       90
       +
         // qualified paths (ideally ending in a leaf-node)

     

       91
       91
       +
         results = references.flatMap(ref => {

     

       92
       92
       +
           // If we get a reference to a different file we can bail

     

       93
       93
       +
           if (ref.fileName !== source.fileName) return [];

     

       94
       94
       +
           // We don't want to end back at our document so we narrow

     

       95
       95
       +
           // the scope.

     

       96
       96
       +
           if (

     

       97
       97
       +
             node.getStart() <= ref.textSpan.start &&

     

       98
       98
       +
             node.getEnd() >= ref.textSpan.start + ref.textSpan.length

     

       99
       99
       +
           )

     

       100
       100
       +
             return [];

     

       101
       101
       +
       

     

       102
       102
       +
           let foundRef = findNode(source, ref.textSpan.start);

     

       103
       103
       +
           if (!foundRef) return [];

     

       104
       104
       +
       

     

       105
       105
       +
           const pathParts = [...originalWip];

     

       106
       106
       +
           // In here we'll start crawling all the accessors of result

     

       107
       107
       +
           // and try to determine the total path

     

       108
       108
       +
           // - result.data.pokemon.name --> pokemon.name this is the easy route and never accesses

     

       109
       109
       +
           //   any of the recursive functions

     

       110
       110
       +
           // - const pokemon = result.data.pokemon --> this initiates a new crawl with a renewed scope

     

       111
       111
       +
           // - const { pokemon } = result.data --> this initiates a destructuring traversal which will

     

       112
       112
       +
           //   either end up in more destructuring traversals or a scope crawl

     

       113
       113
       +
           while (

     

       114
       114
       +
             ts.isIdentifier(foundRef) ||

     

       115
       115
       +
             ts.isPropertyAccessExpression(foundRef) ||

     

       116
       116
       +
             ts.isElementAccessExpression(foundRef) ||

     

       117
       117
       +
             ts.isVariableDeclaration(foundRef) ||

     

       118
       118
       +
             ts.isBinaryExpression(foundRef)

     

       119
       119
       +
           ) {

     

       120
       120
       +
             if (ts.isVariableDeclaration(foundRef)) {

     

       121
       121
       +
               if (ts.isIdentifier(foundRef.name)) {

     

       122
       122
       +
                 // We have already added the paths because of the right-hand expression,

     

       123
       123
       +
                 // const pokemon = result.data.pokemon --> we have pokemon as our path,

     

       124
       124
       +
                 // now re-crawling pokemon for all of its accessors should deliver us the usage

     

       125
       125
       +
                 // patterns... This might get expensive though if we need to perform this deeply.

     

       126
       126
       +
                 return crawlScope(foundRef.name, pathParts, allFields, source, info);

     

       127
       127
       +
               } else if (ts.isObjectBindingPattern(foundRef.name)) {

     

       128
       128
       +
                 // First we need to traverse the left-hand side of the variable assignment,

     

       129
       129
       +
                 // this could be tree-like as we could be dealing with

     

       130
       130
       +
                 // - const { x: { y: z }, a: { b: { c, d }, e: { f } } } = result.data

     

       131
       131
       +
                 // Which we will need several paths for...

     

       132
       132
       +
                 // after doing that we need to re-crawl all of the resulting variables

     

       133
       133
       +
                 // Crawl down until we have either a leaf node or an object/array that can

     

       134
       134
       +
                 // be recrawled

     

       135
       135
       +
                 return traverseDestructuring(

     

       136
       136
       +
                   foundRef.name,

     

       137
       137
       +
                   pathParts,

     

       138
       138
       +
                   allFields,

     

       139
       139
       +
                   source,

     

       140
       140
       +
                   info

     

       141
       141
       +
                 );

     

       142
       142
       +
               }

     

       143
       143
       +
             } else if (

     

       144
       144
       +
               ts.isIdentifier(foundRef) &&

     

       145
       145
       +
               allFields.includes(foundRef.text) &&

     

       146
       146
       +
               !pathParts.includes(foundRef.text)

     

       147
       147
       +
             ) {

     

       148
       148
       +
               pathParts.push(foundRef.text);

     

       149
       149
       +
             } else if (

     

       150
       150
       +
               ts.isPropertyAccessExpression(foundRef) &&

     

       151
       151
       +
               allFields.includes(foundRef.name.text) &&

     

       152
       152
       +
               !pathParts.includes(foundRef.name.text)

     

       153
       153
       +
             ) {

     

       154
       154
       +
               pathParts.push(foundRef.name.text);

     

       155
       155
       +
             } else if (

     

       156
       156
       +
               ts.isElementAccessExpression(foundRef) &&

     

       157
       157
       +
               ts.isStringLiteral(foundRef.argumentExpression) &&

     

       158
       158
       +
               allFields.includes(foundRef.argumentExpression.text) &&

     

       159
       159
       +
               !pathParts.includes(foundRef.argumentExpression.text)

     

       160
       160
       +
             ) {

     

       161
       161
       +
               pathParts.push(foundRef.argumentExpression.text);

     

       162
       162
       +
             }

     

       163
       163
       +
       

     

       164
       164
       +
             foundRef = foundRef.parent;

     

       165
       165
       +
           }

     

       166
       166
       +
       

     

       167
       167
       +
           return pathParts.join('.');

     

       168
       168
       +
         });

     

       169
       169
       +
       

     

       170
       170
       +
         return results;

     

       171
       171
       +
       };

     

       172
       172
       +
       

     

       173
       173
       +
       export const checkFieldUsageInFile = (

     

       174
       174
       +
         source: ts.SourceFile,

     

       175
       175
       +
         nodes: ts.NoSubstitutionTemplateLiteral[],

     

       176
       176
       +
         info: ts.server.PluginCreateInfo

     

       177
       177
       +
       ) => {

     

       178
       178
       +
         const diagnostics: ts.Diagnostic[] = [];

     

       179
       179
       +
         const shouldTrackFieldUsage = info.config.trackFieldUsage ?? false;

     

       180
       180
       +
         if (!shouldTrackFieldUsage) return diagnostics;

     

       181
       181
       +
       

     

       182
       182
       +
         nodes.forEach(node => {

     

       183
       183
       +
           const nodeText = node.getText();

     

       184
       184
       +
           // Bailing for mutations/subscriptions as these could have small details

     

       185
       185
       +
           // for normalised cache interactions

     

       186
       186
       +
           if (nodeText.includes('mutation') || nodeText.includes('subscription'))

     

       187
       187
       +
             return;

     

       188
       188
       +
       

     

       189
       189
       +
           const variableDeclaration = getVariableDeclaration(node);

     

       190
       190
       +
           if (!ts.isVariableDeclaration(variableDeclaration)) return;

     

       191
       191
       +
       

     

       192
       192
       +
           const references = info.languageService.getReferencesAtPosition(

     

       193
       193
       +
             source.fileName,

     

       194
       194
       +
             variableDeclaration.name.getStart()

     

       195
       195
       +
           );

     

       196
       196
       +
           if (!references) return;

     

       197
       197
       +
       

     

       198
       198
       +
           references.forEach(ref => {

     

       199
       199
       +
             if (ref.fileName !== source.fileName) return;

     

       200
       200
       +
       

     

       201
       201
       +
             let found = findNode(source, ref.textSpan.start);

     

       202
       202
       +
             while (found && !ts.isVariableStatement(found)) {

     

       203
       203
       +
               found = found.parent;

     

       204
       204
       +
             }

     

       205
       205
       +
       

     

       206
       206
       +
             if (!found || !ts.isVariableStatement(found)) return;

     

       207
       207
       +
       

     

       208
       208
       +
             const [output] = found.declarationList.declarations;

     

       209
       209
       +
       

     

       210
       210
       +
             if (output.name.getText() === variableDeclaration.name.getText()) return;

     

       211
       211
       +
       

     

       212
       212
       +
             const inProgress: string[] = [];

     

       213
       213
       +
             const allPaths: string[] = [];

     

       214
       214
       +
             const allFields: string[] = [];

     

       215
       215
       +
             const reserved = ['id', '__typename'];

     

       216
       216
       +
             const fieldToLoc = new Map<string, { start: number; length: number }>();

     

       217
       217
       +
             // This visitor gets all the leaf-paths in the document

     

       218
       218
       +
             // as well as all fields that are part of the document

     

       219
       219
       +
             // We need the leaf-paths to check usage and we need the

     

       220
       220
       +
             // fields to validate whether an access on a given reference

     

       221
       221
       +
             // is valid given the current document...

     

       222
       222
       +
             visit(parse(node.getText().slice(1, -1)), {

     

       223
       223
       +
               Field: {

     

       224
       224
       +
                 enter: node => {

     

       225
       225
       +
                   if (!reserved.includes(node.name.value)) {

     

       226
       226
       +
                     allFields.push(node.name.value);

     

       227
       227
       +
                   }

     

       228
       228
       +
       

     

       229
       229
       +
                   if (!node.selectionSet && !reserved.includes(node.name.value)) {

     

       230
       230
       +
                     let p;

     

       231
       231
       +
                     if (inProgress.length) {

     

       232
       232
       +
                       p = inProgress.join('.') + '.' + node.name.value;

     

       233
       233
       +
                     } else {

     

       234
       234
       +
                       p = node.name.value;

     

       235
       235
       +
                     }

     

       236
       236
       +
                     allPaths.push(p);

     

       237
       237
       +
       

     

       238
       238
       +
                     fieldToLoc.set(p, {

     

       239
       239
       +
                       start: node.name.loc!.start,

     

       240
       240
       +
                       length: node.name.loc!.end - node.name.loc!.start,

     

       241
       241
       +
                     });

     

       242
       242
       +
                   } else if (node.selectionSet) {

     

       243
       243
       +
                     inProgress.push(node.name.value);

     

       244
       244
       +
                   }

     

       245
       245
       +
                 },

     

       246
       246
       +
                 leave: node => {

     

       247
       247
       +
                   if (node.selectionSet) {

     

       248
       248
       +
                     inProgress.pop();

     

       249
       249
       +
                   }

     

       250
       250
       +
                 },

     

       251
       251
       +
               },

     

       252
       252
       +
             });

     

       253
       253
       +
       

     

       254
       254
       +
             let temp = output.name;

     

       255
       255
       +
             // Supported cases:

     

       256
       256
       +
             // - const result = await client.query() || useFragment()

     

       257
       257
       +
             // - const [result] = useQuery() --> urql

     

       258
       258
       +
             // - const { data } = useQuery() --> Apollo

     

       259
       259
       +
             // - const { field } = useFragment()

     

       260
       260
       +
             // - const [{ data }] = useQuery()

     

       261
       261
       +
             // - const { data: { pokemon } } = useQuery()

     

       262
       262
       +
             if (

     

       263
       263
       +
               ts.isArrayBindingPattern(temp) &&

     

       264
       264
       +
               ts.isBindingElement(temp.elements[0])

     

       265
       265
       +
             ) {

     

       266
       266
       +
               temp = temp.elements[0].name;

     

       267
       267
       +
             }

     

       268
       268
       +
       

     

       269
       269
       +
             let allAccess: string[] = [];

     

       270
       270
       +
             if (ts.isObjectBindingPattern(temp)) {

     

       271
       271
       +
               allAccess = traverseDestructuring(temp, [], allFields, source, info);

     

       272
       272
       +
             } else {

     

       273
       273
       +
               allAccess = crawlScope(temp, [], allFields, source, info);

     

       274
       274
       +
             }

     

       275
       275
       +
       

     

       276
       276
       +
             const unused = allPaths.filter(x => !allAccess.includes(x));

     

       277
       277
       +
             unused.forEach(unusedField => {

     

       278
       278
       +
               const loc = fieldToLoc.get(unusedField);

     

       279
       279
       +
               if (!loc) return;

     

       280
       280
       +
       

     

       281
       281
       +
               diagnostics.push({

     

       282
       282
       +
                 file: source,

     

       283
       283
       +
                 length: loc.length,

     

       284
       284
       +
                 start: node.getStart() + loc.start + 1,

     

       285
       285
       +
                 category: ts.DiagnosticCategory.Warning,

     

       286
       286
       +
                 code: UNUSED_FIELD_CODE,

     

       287
       287
       +
                 messageText: `Field '${unusedField}' is not used.`,

     

       288
       288
       +
               });

     

       289
       289
       +
             });

     

       290
       290
       +
           });

     

       291
       291
       +
         });

     

       292
       292
       +
       

     

       293
       293
       +
         return diagnostics;

     

       294
       294
       +
       };