Merge pull request #63 from davelopez/add_wf_tests_document_support

Add basic support for Workflow Test Files '*-test.yml'

.vscode/launch.json

@@ -31,7 +31,11 @@
       "sourceMaps": true,
       "preLaunchTask": {
         "type": "npm",
-        "script": "compile"
+        "script": "watch"
+      },
+      "resolveSourceMapLocations": ["${workspaceFolder}/client/dist/**/*.js"],
+      "sourceMapPathOverrides": {
+        "webpack://?:*/*": "${workspaceFolder}/client/*"
       }
     },
     {

client/src/browser/extension.ts

@@ -9,11 +9,11 @@ let gxFormat2LanguageClient: LanguageClient;
 
 export function activate(context: ExtensionContext): void {
   nativeLanguageClient = createWebWorkerLanguageClient(
-    Constants.NATIVE_WORKFLOW_LANGUAGE_ID,
+    [Constants.NATIVE_WORKFLOW_LANGUAGE_ID],
     Uri.joinPath(context.extensionUri, "server/gx-workflow-ls-native/dist/web/nativeServer.js")
   );
   gxFormat2LanguageClient = createWebWorkerLanguageClient(
-    Constants.GXFORMAT2_WORKFLOW_LANGUAGE_ID,
+    [Constants.GXFORMAT2_WORKFLOW_LANGUAGE_ID, Constants.GXFORMAT2_WORKFLOW_TESTS_LANGUAGE_ID],
     Uri.joinPath(context.extensionUri, "server/gx-workflow-ls-format2/dist/web/gxFormat2Server.js")
   );
 
@@ -25,9 +25,14 @@ export async function deactivate(): Promise<void> {
   await gxFormat2LanguageClient?.stop();
 }
 
-function createWebWorkerLanguageClient(languageId: string, serverUri: Uri): LanguageClient {
-  const documentSelector = [{ language: languageId }];
+function createWebWorkerLanguageClient(languageIds: string[], serverUri: Uri): LanguageClient {
+  const documentSelector = languageIds.map((languageId) => ({ language: languageId }));
   const clientOptions: LanguageClientOptions = buildBasicLanguageClientOptions(documentSelector);
   const worker = new Worker(serverUri.toString());
-  return new LanguageClient(`${languageId}-language-client`, `Galaxy Workflows (${languageId})`, clientOptions, worker);
+  return new LanguageClient(
+    `${languageIds}-language-client`,
+    `Galaxy Workflows (${languageIds})`,
+    clientOptions,
+    worker
+  );
 }

client/src/commands/cleanWorkflow.ts

@@ -1,6 +1,6 @@
 import { window } from "vscode";
-import { CleanWorkflowDocumentParams, CleanWorkflowDocumentRequest } from "../common/requestsDefinitions";
 import { CustomCommand, getCommandFullIdentifier } from ".";
+import { CleanWorkflowDocumentParams, CleanWorkflowDocumentResult, LSRequestIdentifiers } from "../languageTypes";
 
 /**
  * Command to 'clean' the selected workflow document.
@@ -17,7 +17,10 @@ export class CleanWorkflowCommand extends CustomCommand {
     const { document } = window.activeTextEditor;
 
     const params: CleanWorkflowDocumentParams = { uri: this.client.code2ProtocolConverter.asUri(document.uri) };
-    const result = await this.client.sendRequest(CleanWorkflowDocumentRequest.type, params);
+    const result = await this.client.sendRequest<CleanWorkflowDocumentResult>(
+      LSRequestIdentifiers.CLEAN_WORKFLOW_DOCUMENT,
+      params
+    );
     if (!result) {
       throw new Error("Cannot clean the requested document. The server returned no result.");
     }

client/src/common/constants.ts

@@ -2,5 +2,6 @@
 export namespace Constants {
   export const NATIVE_WORKFLOW_LANGUAGE_ID = "galaxyworkflow";
   export const GXFORMAT2_WORKFLOW_LANGUAGE_ID = "gxformat2";
+  export const GXFORMAT2_WORKFLOW_TESTS_LANGUAGE_ID = "gxwftests";
   export const CLEAN_WORKFLOW_DOCUMENT_SCHEME = "galaxy-clean-workflow";
 }

client/src/common/index.ts

@@ -5,6 +5,7 @@ import { CleanWorkflowDocumentProvider } from "../providers/cleanWorkflowDocumen
 import { CleanWorkflowProvider } from "../providers/cleanWorkflowProvider";
 import { GitProvider } from "../providers/git";
 import { BuiltinGitProvider } from "../providers/git/gitProvider";
+import { setupRequests } from "../requests/gxworkflows";
 
 export function buildBasicLanguageClientOptions(documentSelector: DocumentSelector): LanguageClientOptions {
   // Options to control the language client
@@ -30,6 +31,8 @@ export function initExtension(
 
   // Setup gxformat2 language features
   startLanguageClient(context, gxFormat2Client);
+
+  setupRequests(context, nativeClient, gxFormat2Client);
 }
 
 function initGitProvider(context: ExtensionContext): BuiltinGitProvider {

client/src/common/utils.ts

@@ -5,7 +5,7 @@ import { OutputChannel, Uri, workspace } from "vscode";
  * @returns true if the workspace is not mounted on a regular filesystem.
  */
 export function isVirtualWorkspace(): boolean {
-  return workspace.workspaceFolders && workspace.workspaceFolders.every((f) => f.uri.scheme !== "file");
+  return (workspace.workspaceFolders ?? []).every((f) => f.uri.scheme !== "file");
 }
 
 /**
@@ -45,3 +45,31 @@ export function debugPrintCommandArgs(command: string, args: unknown[], outputCh
   }
   outputChannel.appendLine(`---\n`);
 }
+
+export function isWorkflowTestsDocument(uri: Uri): boolean {
+  return uri.path.endsWith("-test.yml") || uri.path.endsWith("-tests.yml");
+}
+
+export function isNativeWorkflowDocument(uri: Uri): boolean {
+  return uri.path.endsWith(".ga");
+}
+
+export async function getAssociatedWorkflowUriFromTestsUri(workflowTestsDocumentUri: Uri): Promise<Uri | undefined> {
+  const format2WorkflowUri = Uri.parse(
+    workflowTestsDocumentUri.toString().replace("-test.yml", ".gxwf.yml").replace("-tests.yml", ".gxwf.yml")
+  );
+  try {
+    await workspace.fs.stat(format2WorkflowUri);
+    return format2WorkflowUri;
+  } catch {
+    const nativeWorkflowUri = Uri.parse(
+      workflowTestsDocumentUri.toString().replace("-test.yml", ".ga").replace("-tests.yml", ".ga")
+    );
+    try {
+      await workspace.fs.stat(nativeWorkflowUri);
+      return nativeWorkflowUri;
+    } catch {
+      return undefined;
+    }
+  }
+}

client/src/extension.ts

@@ -10,11 +10,11 @@ let gxFormat2LanguageClient: LanguageClient;
 
 export function activate(context: ExtensionContext): void {
   nativeLanguageClient = buildNodeLanguageClient(
-    Constants.NATIVE_WORKFLOW_LANGUAGE_ID,
+    [Constants.NATIVE_WORKFLOW_LANGUAGE_ID],
     buildNativeServerOptions(context)
   );
   gxFormat2LanguageClient = buildNodeLanguageClient(
-    Constants.GXFORMAT2_WORKFLOW_LANGUAGE_ID,
+    [Constants.GXFORMAT2_WORKFLOW_LANGUAGE_ID, Constants.GXFORMAT2_WORKFLOW_TESTS_LANGUAGE_ID],
     buildGxFormat2ServerOptions(context)
   );
 
@@ -26,12 +26,12 @@ export async function deactivate(): Promise<void> {
   await gxFormat2LanguageClient?.stop();
 }
 
-function buildNodeLanguageClient(languageId: string, serverOptions: ServerOptions): LanguageClient {
-  const documentSelector = [{ language: languageId }];
+function buildNodeLanguageClient(languageIds: string[], serverOptions: ServerOptions): LanguageClient {
+  const documentSelector = languageIds.map((languageId) => ({ language: languageId }));
   const clientOptions: LanguageClientOptions = buildBasicLanguageClientOptions(documentSelector);
   return new LanguageClient(
-    `${languageId}-language-client`,
-    `Galaxy Workflows (${languageId})`,
+    `${languageIds}-language-client`,
+    `Galaxy Workflows (${languageIds})`,
     serverOptions,
     clientOptions
   );

client/src/languageTypes.ts

@@ -0,0 +1,21 @@
+import {
+  CleanWorkflowContentsParams,
+  CleanWorkflowContentsResult,
+  CleanWorkflowDocumentParams,
+  CleanWorkflowDocumentResult,
+  GetWorkflowInputsResult,
+  GetWorkflowOutputsResult,
+  LSRequestIdentifiers,
+  TargetWorkflowDocumentParams,
+} from "../../shared/src/requestsDefinitions";
+
+export {
+  CleanWorkflowContentsParams,
+  CleanWorkflowContentsResult,
+  CleanWorkflowDocumentParams,
+  CleanWorkflowDocumentResult,
+  GetWorkflowInputsResult,
+  GetWorkflowOutputsResult,
+  LSRequestIdentifiers,
+  TargetWorkflowDocumentParams,
+};

client/src/providers/cleanWorkflowProvider.ts

@@ -1,7 +1,7 @@
 import { Uri, window, workspace } from "vscode";
 import { BaseLanguageClient } from "vscode-languageclient";
-import { CleanWorkflowContentsParams, CleanWorkflowContentsRequest } from "../common/requestsDefinitions";
 import { getWorkspaceScheme, replaceUriScheme } from "../common/utils";
+import { CleanWorkflowContentsParams, CleanWorkflowContentsResult, LSRequestIdentifiers } from "../languageTypes";
 import { GitProvider } from "./git";
 
 /**
@@ -56,7 +56,10 @@ export class CleanWorkflowProvider {
     const params: CleanWorkflowContentsParams = {
       contents: contents,
     };
-    const result = await this.languageClient.sendRequest(CleanWorkflowContentsRequest.type, params);
+    const result = await this.languageClient.sendRequest<CleanWorkflowContentsResult>(
+      LSRequestIdentifiers.CLEAN_WORKFLOW_CONTENTS,
+      params
+    );
     if (!result) {
       throw new Error("Cannot clean the requested document contents. The server returned no content");
     }

client/src/requests/gxworkflows.ts

@@ -0,0 +1,57 @@
+import { ExtensionContext, Uri, workspace } from "vscode";
+import { BaseLanguageClient } from "vscode-languageclient";
+import {
+  getAssociatedWorkflowUriFromTestsUri,
+  isNativeWorkflowDocument,
+  isWorkflowTestsDocument,
+} from "../common/utils";
+import {
+  GetWorkflowInputsResult,
+  GetWorkflowOutputsResult,
+  LSRequestIdentifiers,
+  TargetWorkflowDocumentParams,
+} from "../languageTypes";
+
+export function setupRequests(
+  context: ExtensionContext,
+  nativeWorkflowClient: BaseLanguageClient,
+  gxFormat2Client: BaseLanguageClient
+): void {
+  function createRequestHandler<TResult>(requestIdentifier: string) {
+    return async (params: TargetWorkflowDocumentParams) => {
+      let targetUri: Uri | undefined = Uri.parse(params.uri);
+      if (isWorkflowTestsDocument(targetUri)) {
+        // If the target is a test file, we need to find the associated workflow file
+        targetUri = await getAssociatedWorkflowUriFromTestsUri(targetUri);
+      }
+      if (!targetUri) {
+        console.debug("No associated workflow file found for:", params.uri);
+        return undefined;
+      }
+      // Open the file to include it in the document cache
+      await workspace.openTextDocument(targetUri);
+
+      let languageClient = gxFormat2Client;
+      if (isNativeWorkflowDocument(targetUri)) {
+        languageClient = nativeWorkflowClient;
+      }
+      const requestParams: TargetWorkflowDocumentParams = { uri: targetUri.toString() };
+      const result = await languageClient.sendRequest<TResult>(requestIdentifier, requestParams);
+      return result;
+    };
+  }
+
+  context.subscriptions.push(
+    gxFormat2Client.onRequest(
+      LSRequestIdentifiers.GET_WORKFLOW_INPUTS,
+      createRequestHandler<GetWorkflowInputsResult>(LSRequestIdentifiers.GET_WORKFLOW_INPUTS)
+    )
+  );
+
+  context.subscriptions.push(
+    gxFormat2Client.onRequest(
+      LSRequestIdentifiers.GET_WORKFLOW_OUTPUTS,
+      createRequestHandler<GetWorkflowOutputsResult>(LSRequestIdentifiers.GET_WORKFLOW_OUTPUTS)
+    )
+  );
+}