Merge pull request #719 from Shopify/jm/liquid_doc_hover_caching

[LiquidDoc] Cache liquidDoc definitions in DocumentManager

Author: jamesmengo

.changeset/dry-donkeys-behave.md

@@ -0,0 +1,6 @@
+---
+'@shopify/theme-language-server-common': minor
+'@shopify/theme-check-common': minor
+---
+
+Cache liquidDoc fetch results

packages/theme-language-server-common/src/documents/DocumentManager.ts

@@ -12,12 +12,14 @@ import {
   IsValidSchema,
   memo,
   Mode,
+  isError,
 } from '@shopify/theme-check-common';
 import { Connection } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { ClientCapabilities } from '../ClientCapabilities';
 import { percent, Progress } from '../progress';
 import { AugmentedSourceCode } from './types';
+import { getSnippetDefinition } from '../liquidDoc';
 
 export class DocumentManager {
   /**
@@ -171,6 +173,12 @@ export class DocumentManager {
             const mode = await this.getModeForUri!(uri);
             return toSchema(mode, uri, sourceCode, this.isValidSchema);
           }),
+          /** Lazy and only computed once per file version */
+          liquidDoc: memo(async (snippetName: string) => {
+            if (isError(sourceCode.ast)) return { name: snippetName };
+
+            return getSnippetDefinition(sourceCode.ast, snippetName);
+          }),
         };
       default:
         return assertNever(sourceCode);

packages/theme-language-server-common/src/documents/types.ts

@@ -6,6 +6,7 @@ import {
   AppBlockSchema,
 } from '@shopify/theme-check-common';
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import { SnippetDefinition } from '../liquidDoc';
 
 /** Util type to add the common `textDocument` property to the SourceCode. */
 type _AugmentedSourceCode<SCT extends SourceCodeType = SourceCodeType> = SourceCode<SCT> & {
@@ -23,6 +24,7 @@ export type AugmentedJsonSourceCode = _AugmentedSourceCode<SourceCodeType.JSON>;
  */
 export type AugmentedLiquidSourceCode = _AugmentedSourceCode<SourceCodeType.LiquidHtml> & {
   getSchema: () => Promise<SectionSchema | ThemeBlockSchema | AppBlockSchema | undefined>;
+  liquidDoc: (snippetName: string) => Promise<SnippetDefinition>;
 };
 
 /**

packages/theme-language-server-common/src/server/startServer.ts

@@ -185,7 +185,7 @@ export function startServer(
       return { name: snippetName };
     }
 
-    return getSnippetDefinition(snippet.ast, snippetName);
+    return snippet.liquidDoc(snippetName);
   };
 
   const snippetFilter = ([uri]: FileTuple) => /\.liquid$/.test(uri) && /snippets/.test(uri);