Files
languageservices/languageservice/src/utils/workflow-cache.ts
T
eric sciple 656a821a94 ESM migration: Add .js extensions for node16 moduleResolution (#257)
Migrate expressions, workflow-parser, and languageservice packages to use
proper ESM imports with .js extensions that work with node16 moduleResolution.

Changes:
- Update tsconfig.build.json in each package to use module: node16 and
  moduleResolution: node16
- Add .js extensions to all relative import paths (Option B approach)
- Fix yaml internal type imports in workflow-parser by defining local types
- Add skipLibCheck to handle @types/node compatibility issues
- Add TypeScript 5.8.3 override in root package.json
- Add ESM migration plan documentation

The languageserver package is deferred due to test hang issues that need
further investigation.

Related #154 - Upgrade moduleResolution from node to node16 or nodenext
Related #110 - Published ESM code has imports without file extensions
Related #64 - expressions: ERR_MODULE_NOT_FOUND attempting to run example
Related #146 - Can not import @actions/workflow-parser

Test results:
- expressions: 1068 tests passed
- workflow-parser: 292 tests passed
- languageservice: 452 tests passed

* docs: update ESM migration plan with findings

- Update languageserver blocker: vscode-languageserver v8.0.2 lacks ESM
  exports (not a test hang issue)
- Document that Option B (manual .js extensions) was chosen over Option A
  due to ts-jest compatibility issues
- Add workaround for yaml package internal types (LinePos, NodeBase)
- Update migration status table with accurate reason for deferral
- Add skipLibCheck note for @types/node compatibility
2025-12-18 13:35:48 -06:00

71 lines
2.5 KiB
TypeScript

import {convertWorkflowTemplate, parseWorkflow, ParseWorkflowResult, WorkflowTemplate} from "@actions/workflow-parser";
import {WorkflowTemplateConverterOptions} from "@actions/workflow-parser/model/convert";
import {TemplateContext} from "@actions/workflow-parser/templates/template-context";
import {TemplateToken} from "@actions/workflow-parser/templates/tokens/template-token";
import {File} from "@actions/workflow-parser/workflows/file";
import {CompletionConfig} from "../complete.js";
import {nullTrace} from "../nulltrace.js";
const parsedWorkflowCache = new Map<string, ParseWorkflowResult>();
const workflowTemplateCache = new Map<string, WorkflowTemplate>();
export function clearCacheEntry(uri: string) {
parsedWorkflowCache.delete(uri);
parsedWorkflowCache.delete(workflowKey(uri, true));
workflowTemplateCache.delete(uri);
workflowTemplateCache.delete(workflowKey(uri, true));
}
export function clearCache() {
parsedWorkflowCache.clear();
workflowTemplateCache.clear();
}
/**
* Parses a workflow file and caches the result
* @param transformed Indicates whether the workflow has been transformed before parsing
* @returns the {@link ParseWorkflowResult}
*/
export function fetchOrParseWorkflow(file: File, uri: string, transformed = false): ParseWorkflowResult {
const key = workflowKey(uri, transformed);
const cachedResult = parsedWorkflowCache.get(key);
if (cachedResult) {
return cachedResult;
}
const result = parseWorkflow(file, nullTrace);
parsedWorkflowCache.set(key, result);
return result;
}
/**
* Converts a workflow template and caches the result
* @param transformed Indicates whether the workflow has been transformed before parsing
* @returns the converted {@link WorkflowTemplate}
*/
export async function fetchOrConvertWorkflowTemplate(
context: TemplateContext,
template: TemplateToken,
uri: string,
config?: CompletionConfig,
options?: WorkflowTemplateConverterOptions,
transformed = false
): Promise<WorkflowTemplate> {
const key = workflowKey(uri, transformed);
const cachedTemplate = workflowTemplateCache.get(key);
if (cachedTemplate) {
return cachedTemplate;
}
const workflowTemplate = await convertWorkflowTemplate(context, template, config?.fileProvider, options);
workflowTemplateCache.set(key, workflowTemplate);
return workflowTemplate;
}
// Use a separate cache key for transformed workflows
function workflowKey(uri: string, transformed: boolean): string {
if (transformed) {
return `transformed-${uri}`;
}
return uri;
}