Move task file generation to worker thread to fix bug

Author: znorman-harris

CHANGELOG.md

@@ -22,12 +22,14 @@ IDL 9.1 introduces new, command-line based progress bars. We have a first-pass o
 
 Fixed an issue with the IDL Webview that showed a blank tab when opened. This affect things like the profiler in the extension.
 
-If there are unexpected errors in the webview, we now try to catch them and alert the user. Errors should be printed to the logs and a button will appear to make it easy to report an issue.
+If there are unexpected errors in the webview, we now try to catch them and alert the user. Errors should be printed to the logs and a button will appear to make it easy to report an issue if this happens in the future.
 
 Added basic support for symbolic links and managing files that have symbolic links. This includes tests for baseline user experience as well.
 
 When we encounter a file with a symbolic link, we report problems for the true file on disk (not the path including the link). This means you won't see problems actively reported for the file if you edit it as a link.
 
+Resolved an issue where task file generation wouldn't update your original code with a main level program if you didn't have one.
+
 ## 4.7.0 - November 2024
 
 Added the ability to statically determine the return types for functions and function methods that don't have documentation. This means that, for the following example, we properly detect that we return an IDL Long (because of `compile_opt idl2`):

apps/parsing-worker/src/main.ts

@@ -1,5 +1,14 @@
 import { AssembleWithIndex } from '@idl/assembler';
 import { Migrator } from '@idl/assembling/migrators';
+import {
+  GenerateENVITask,
+  GenerateENVITaskMainLevelProgram,
+} from '@idl/generators/envi-task';
+import {
+  GenerateIDLTask,
+  GenerateIDLTaskMainLevelProgram,
+} from '@idl/generators/idl-task';
+import { GenerateTaskResult } from '@idl/generators/tasks-shared';
 import { IDL_WORKER_THREAD_CONSOLE, LogManager } from '@idl/logger';
 import { PrepareNotebookCell } from '@idl/notebooks/idl-index';
 import { ParseFileSync } from '@idl/parser';
@@ -17,6 +26,7 @@ import {
   IParsedLightWeight,
   RemoveScopeDetail,
 } from '@idl/parsing/syntax-tree';
+import { TOKEN_NAMES } from '@idl/tokenizer';
 import { IDL_TRANSLATION } from '@idl/translation';
 import {
   ChangeDetectionResponse,
@@ -215,6 +225,75 @@ client.on(LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAN_UP, async (message) => {
   await WORKER_INDEX.cleanUp();
 });
 
+/**
+ * Handle requests to make a task file
+ */
+client.on(
+  LSP_WORKER_THREAD_MESSAGE_LOOKUP.GENERATE_TASK,
+  async (message, cancel) => {
+    // index the file
+    const parsed = await GetParsedPROCode(
+      WORKER_INDEX,
+      message.fsPath,
+      message.code,
+      cancel,
+      {
+        postProcess: true,
+      }
+    );
+
+    /**
+     * Do we write to disk or not?
+     */
+    const WRITE_TASK = true;
+
+    /**
+     * Make our task
+     */
+    const result =
+      message.type === 'envi'
+        ? await GenerateENVITask(
+            message.fsPath,
+            parsed,
+            message.config,
+            WRITE_TASK
+          )
+        : await GenerateIDLTask(
+            message.fsPath,
+            parsed,
+            message.config,
+            WRITE_TASK
+          );
+
+    /** Return value for PRO code */
+    let proCode: string;
+
+    // if we made a task, then make PRO code
+    if (result.success) {
+      // check of we have a main level program
+      if (parsed.tree[parsed.tree.length - 1].name !== TOKEN_NAMES.MAIN_LEVEL) {
+        const mainAdd =
+          message.type === 'envi'
+            ? GenerateENVITaskMainLevelProgram(
+                result as GenerateTaskResult<true>
+              )
+            : GenerateIDLTaskMainLevelProgram(
+                result as GenerateTaskResult<true>
+              );
+
+        // make new text
+        proCode = message.code + '\n' + mainAdd;
+      }
+    }
+
+    // return
+    return {
+      result,
+      proCode,
+    };
+  }
+);
+
 /**
  * Get auto complete for files we manage
  */

libs/vscode/server/src/lib/events/custom-events/on-generate-task.ts

@@ -1,25 +1,15 @@
-import { CancellationToken } from '@idl/cancellation-tokens';
-import {
-  GenerateENVITask,
-  GenerateENVITaskMainLevelProgram,
-} from '@idl/generators/envi-task';
-import {
-  GenerateIDLTask,
-  GenerateIDLTaskMainLevelProgram,
-} from '@idl/generators/idl-task';
 import { GenerateTaskResult } from '@idl/generators/tasks-shared';
 import { IDL_LSP_LOG } from '@idl/logger';
-import { GetParsedPROCode } from '@idl/parsing/index';
-import { GetFSPath, IDLFileHelper, Sleep } from '@idl/shared';
-import { TOKEN_NAMES } from '@idl/tokenizer';
+import { IDLFileHelper, Sleep } from '@idl/shared';
 import { IDL_TRANSLATION } from '@idl/translation';
 import {
   GenerateTaskMessage,
   LanguageServerPayload,
 } from '@idl/vscode/events/messages';
+import { LSP_WORKER_THREAD_MESSAGE_LOOKUP } from '@idl/workers/parsing';
 
-import { GetFileStrings } from '../../helpers/get-file-strings';
 import { GetFormattingConfigForFile } from '../../helpers/get-formatting-config-for-file';
+import { ResolveFSPathAndCodeForURI } from '../../helpers/resolve-fspath-and-code-for-uri';
 import { UpdateDocument } from '../../helpers/update-document';
 import { IDL_LANGUAGE_SERVER_LOGGER } from '../../initialize-server';
 import { IDL_INDEX } from '../initialize-document-manager';
@@ -41,56 +31,53 @@ export const ON_GENERATE_TASK = async (
   await SERVER_INITIALIZED;
   try {
     /**
-     * File we want to make a task for
+     * Resolve the fspath to our cell and retrieve code
      */
-    const fsPath = GetFSPath(payload.uri);
+    const info = await ResolveFSPathAndCodeForURI(payload.uri);
 
-    // return if not PRO code
-    if (!IDLFileHelper.isPROCode(fsPath)) {
-      return;
+    // return if nothing found
+    if (info === undefined) {
+      return undefined;
+    }
+
+    // do nothing
+    if (!IDLFileHelper.isPROCode(info.fsPath)) {
+      return undefined;
     }
 
+    /** Formatting config for info.fsPath */
+    const config = GetFormattingConfigForFile(info.fsPath);
+
     IDL_LANGUAGE_SERVER_LOGGER.log({
       log: IDL_LSP_LOG,
       type: 'info',
-      content: `Init/update task for file: "${fsPath}"`,
+      content: `Init/update task for file: "${info.fsPath}"`,
     });
 
-    /** Formatting config for file */
-    const config = GetFormattingConfigForFile(fsPath);
-
-    /** Content of our PRO file */
-    const proCode = await GetFileStrings(payload.uri, fsPath);
-
-    // re-index the file
-    const parsed = await GetParsedPROCode(
-      IDL_INDEX,
-      fsPath,
-      proCode,
-      new CancellationToken(),
-      {
-        postProcess: true,
-      }
-    );
-
     /**
-     * Make our task
+     * Formatted code
      */
-    const result =
-      payload.type === 'envi'
-        ? await GenerateENVITask(fsPath, parsed, config, WRITE_TASK)
-        : await GenerateIDLTask(fsPath, parsed, config, WRITE_TASK);
+    const response = await IDL_INDEX.indexerPool.workerio.postAndReceiveMessage(
+      IDL_INDEX.getWorkerID(info.fsPath),
+      LSP_WORKER_THREAD_MESSAGE_LOOKUP.GENERATE_TASK,
+      {
+        ...payload,
+        fsPath: info.fsPath,
+        code: info.code,
+        config,
+      }
+    ).response;
 
     // check for error
-    if (!result.success) {
+    if (!response.result.success) {
       IDL_LANGUAGE_SERVER_LOGGER.log({
         log: IDL_LSP_LOG,
         type: 'error',
         content: [
           'Error while initializing/updating task file',
-          (result as GenerateTaskResult<false>).failureReason,
+          (response.result as GenerateTaskResult<false>).failureReason,
         ],
-        alert: (result as GenerateTaskResult<false>).failureReason,
+        alert: (response.result as GenerateTaskResult<false>).failureReason,
       });
       return;
     }
@@ -115,28 +102,19 @@ export const ON_GENERATE_TASK = async (
     IDL_LANGUAGE_SERVER_LOGGER.log({
       log: IDL_LSP_LOG,
       type: 'info',
-      content: `Initialized/updated task for file: "${fsPath}"`,
+      content: `Initialized/updated task for file: "${info.fsPath}"`,
       alert: IDL_TRANSLATION.commands.notifications.initTask.created,
       alertMeta: {
-        openFile: (result as GenerateTaskResult<true>).taskFile,
+        openFile: (response.result as GenerateTaskResult<true>).taskFile,
       },
     });
 
     // slight pause, to allow server to parse task file
     await Sleep(200);
 
-    // check of we have a main level program
-    if (parsed.tree[parsed.tree.length - 1].name !== TOKEN_NAMES.MAIN_LEVEL) {
-      const mainAdd =
-        payload.type === 'envi'
-          ? GenerateENVITaskMainLevelProgram(result as GenerateTaskResult<true>)
-          : GenerateIDLTaskMainLevelProgram(result as GenerateTaskResult<true>);
-
-      // make new text
-      const newContent = proCode + '\n' + mainAdd;
-
-      // send content
-      await UpdateDocument(payload.uri, newContent);
+    // update main level program if needed
+    if (response.proCode) {
+      await UpdateDocument(payload.uri, response.proCode);
     }
   } catch (err) {
     IDL_LANGUAGE_SERVER_LOGGER.log({

libs/workers/parsing/src/lib/lsp-worker-thread.messages.interface.ts

@@ -1,5 +1,6 @@
 import { FormatterType, IAssemblerOptions } from '@idl/assembling/config';
 import { MigrationType } from '@idl/assembling/migrators-types';
+import { GenerateTaskResult } from '@idl/generators/tasks-shared';
 import { ILogOptions } from '@idl/logger';
 import { IDLNotebookDocument } from '@idl/notebooks/shared';
 import { IParsedLightWeight, ParsedType } from '@idl/parsing/syntax-tree';
@@ -11,7 +12,10 @@ import {
 } from '@idl/types/core';
 import { IDisabledProblems, SyntaxProblems } from '@idl/types/problem-codes';
 import { PositionArray } from '@idl/types/tokenizer';
-import { PrepareNotebookCellMessage } from '@idl/vscode/events/messages';
+import {
+  IGenerateTaskPayload,
+  PrepareNotebookCellMessage,
+} from '@idl/vscode/events/messages';
 import { IDLExtensionConfig } from '@idl/vscode/extension-config';
 import { WorkerIOBaseMessage } from '@idl/workers/workerio';
 import {
@@ -123,6 +127,35 @@ export type CleanUpPayload = {
  */
 export type CleanUpResponse = void;
 
+/**
+ * Message to generate a task file
+ */
+export type GenerateTaskMessage = 'generate-task';
+
+/**
+ * Payload on cleanup
+ */
+export type GenerateTaskPayload = {
+  /** FS path on disk */
+  fsPath: string;
+  /** Code for the file */
+  code: string;
+  /** Formatting config */
+  config: IAssemblerOptions<FormatterType>;
+} & IGenerateTaskPayload;
+
+/**
+ * Response from cleanup
+ */
+export type GenerateTaskResponse = {
+  /** Type for return from generating a task */
+  result: GenerateTaskResult<boolean>;
+  /**
+   * New PRO code to save, if we have main level program
+   */
+  proCode?: string;
+};
+
 /**
  * Message when we want to get auto complete for a file
  */
@@ -506,6 +539,7 @@ export type LSPWorkerThreadMessage =
   | AutoCompleteRecipeMessage
   | ChangeDetectionMessage
   | CleanUpMessage
+  | GenerateTaskMessage
   | GetAutoCompleteMessage
   | GetHoverHelpLookupMessage
   | GetNotebookCellMessage
@@ -549,6 +583,10 @@ interface ILSPWorkerThreadMessageLookup {
    * Message to clean up
    */
   CLEAN_UP: CleanUpMessage;
+  /**
+   * Generate a task file
+   */
+  GENERATE_TASK: GenerateTaskMessage;
   /**
    * Message when we want to get auto complete for a file
    */
@@ -632,6 +670,7 @@ export const LSP_WORKER_THREAD_MESSAGE_LOOKUP: ILSPWorkerThreadMessageLookup = {
   AUTO_COMPLETE_RECIPE: 'auto-complete-recipe',
   CHANGE_DETECTION: 'change-detection',
   CLEAN_UP: 'clean-up',
+  GENERATE_TASK: 'generate-task',
   GET_AUTO_COMPLETE: 'get-auto-complete',
   GET_HOVER_HELP_LOOKUP: 'get-hover-help-lookup',
   GET_NOTEBOOK_CELL: 'get-notebook-cell',

libs/workers/parsing/src/lib/lsp-worker-thread.payloads.interface.ts

@@ -26,6 +26,9 @@ import {
   CleanUpMessage,
   CleanUpPayload,
   CleanUpResponse,
+  GenerateTaskMessage,
+  GenerateTaskPayload,
+  GenerateTaskResponse,
   GetAutoCompleteMessage,
   GetAutoCompletePayload,
   GetAutoCompleteResponse,
@@ -91,6 +94,8 @@ export type PayloadToLSPWorker<T extends LSPWorkerThreadMessage> =
     ? ChangeDetectionPayload
     : T extends CleanUpMessage
     ? CleanUpPayload
+    : T extends GenerateTaskMessage
+    ? GenerateTaskPayload
     : T extends GetAutoCompleteMessage
     ? GetAutoCompletePayload
     : T extends GetHoverHelpLookupMessage
@@ -145,6 +150,8 @@ export type PayloadFromLSPWorker<T extends LSPWorkerThreadMessage> =
     ? ChangeDetectionResponse
     : T extends CleanUpMessage
     ? CleanUpResponse
+    : T extends GenerateTaskMessage
+    ? GenerateTaskResponse
     : T extends GetAutoCompleteMessage
     ? GetAutoCompleteResponse
     : T extends GetHoverHelpLookupMessage