WIP: Format workspace pipes

Author: znorman-harris

libs/vscode/client/src/lib/helpers/vscode-display-progress.ts

@@ -0,0 +1,68 @@
+import * as vscode from 'vscode';
+
+/**
+ * Track known dialogs
+ */
+const dialogs: {
+  [key: string]: {
+    progress: vscode.Progress<{
+      message?: string;
+      increment?: number;
+    }>;
+    token: vscode.CancellationToken;
+    resolve: (value: unknown) => void;
+  };
+} = {};
+
+/**
+ * Shows progress messages and.or updates progress for dialogs that exist
+ */
+export function VSCodeDisplayOrUpdateProgress(
+  id: string,
+  message: string,
+  increment: number,
+  finished?: boolean
+) {
+  // check for known progress
+  if (id in dialogs) {
+    // if finished, then close
+    if (finished) {
+      dialogs[id].resolve(null);
+      delete dialogs[id];
+    } else {
+      // update progress
+      dialogs[id].progress.report({ message, increment });
+    }
+    return;
+  } else {
+    // return if we have progress that is finished that we dont know
+    if (finished) {
+      return;
+    }
+  }
+
+  /**
+   * Create new progress dialog
+   */
+  vscode.window.withProgress(
+    {
+      location: vscode.ProgressLocation.Notification,
+      title: message,
+    },
+    (progress, token) => {
+      // get reference to callback for completion
+      let resolver: (value: unknown) => void;
+
+      // create promise to resolve when we are complete
+      const prom = new Promise((res, rej) => {
+        resolver = res;
+      });
+
+      // save as pending dialog
+      dialogs[id] = { progress, token, resolve: resolver };
+
+      // return overall promise
+      return prom;
+    }
+  );
+}

libs/vscode/client/src/lib/start-language-server.ts

@@ -30,6 +30,7 @@ import {
 } from 'vscode-languageclient/node';
 
 import { ON_INDEX } from './events/indexing/on-index';
+import { VSCodeDisplayOrUpdateProgress } from './helpers/vscode-display-progress';
 import { IDL_CLIENT_OUTPUT_CHANNEL, IDL_LOGGER } from './initialize-client';
 import { START_LANGUAGE_SERVER_CONFIG } from './start-language-server.interface';
 
@@ -240,6 +241,19 @@ export async function StartLanguageServer(ctx: ExtensionContext) {
     }
   );
 
+  // listen for log messages from the server
+  LANGUAGE_SERVER_MESSENGER.onNotification(
+    LANGUAGE_SERVER_MESSAGE_LOOKUP.PROGRESS,
+    (payload) => {
+      VSCodeDisplayOrUpdateProgress(
+        payload.progressId,
+        payload.title,
+        payload.increment,
+        payload.finished
+      );
+    }
+  );
+
   // listen for usage metrics
   LANGUAGE_SERVER_MESSENGER.onNotification(
     LANGUAGE_SERVER_MESSAGE_LOOKUP.USAGE_METRIC,

libs/vscode/events/messages/src/lib/messages/progress.message.interface.ts

@@ -8,7 +8,9 @@ export interface ProgressMessagePayload {
   /** ID of the progress we are sending a message for */
   progressId: string;
   /** Progress message percentage from 0 to 100 */
-  percent: number;
+  increment: number;
   /** Title of the progress message */
   title: string;
+  /** If set, the indicated progress message is finished */
+  finished?: boolean;
 }

libs/vscode/server/src/lib/events/custom-events/on-format-workspace.ts

@@ -1,11 +1,12 @@
 import { IDL_LSP_LOG } from '@idl/logger';
-import { IDL_NOTEBOOK_EXTENSION } from '@idl/shared';
+import { IDL_JSON_URI, IDL_NOTEBOOK_EXTENSION, Sleep } from '@idl/shared';
 import { IDL_TRANSLATION } from '@idl/translation';
 import {
   FormatWorkspacePayload,
   FormatWorkspaceResponse,
   LANGUAGE_SERVER_MESSAGE_LOOKUP,
 } from '@idl/vscode/events/messages';
+import { writeFile } from 'fs/promises';
 import { nanoid } from 'nanoid';
 import { URI } from 'vscode-uri';
 
@@ -29,12 +30,19 @@ export const ON_FORMAT_WORKSPACE = async (
 ): Promise<FormatWorkspaceResponse> => {
   await SERVER_INITIALIZED;
 
+  /** ID for progress bar */
+  const id = nanoid();
+
   try {
     /**
      * Find files and exclude notebooks
      */
     const files = (await IDL_INDEX.findFiles(event.folders)).filter(
-      (file) => !file.toLowerCase().endsWith(IDL_NOTEBOOK_EXTENSION)
+      (file) =>
+        !(
+          file.toLowerCase().endsWith(IDL_NOTEBOOK_EXTENSION) ||
+          file.toLowerCase().endsWith(IDL_JSON_URI)
+        )
     );
 
     /** Track file failures */
@@ -45,15 +53,12 @@ export const ON_FORMAT_WORKSPACE = async (
       return { failures };
     }
 
-    // init progress
-    const id = nanoid();
-
     // send message to start progress
     SERVER_EVENT_MANAGER.sendNotification(
       LANGUAGE_SERVER_MESSAGE_LOOKUP.PROGRESS,
       {
         progressId: id,
-        percent: 0,
+        increment: 0,
         title: IDL_TRANSLATION.lsp.progress.formatWorkspace,
       }
     );
@@ -97,8 +102,16 @@ export const ON_FORMAT_WORKSPACE = async (
           continue;
         }
 
+        console.log(formatted);
+
         // update the doc in VSCode
-        await UpdateDocument(info.uri, formatted, info.doc);
+        if (info.doc !== undefined) {
+          await UpdateDocument(info.uri, formatted, info.doc);
+        } else {
+          await writeFile(info.fsPath, formatted, 'utf-8');
+        }
+
+        await Sleep(1000);
       } catch (err) {
         IDL_LANGUAGE_SERVER_LOGGER.log({
           log: IDL_LSP_LOG,
@@ -116,12 +129,23 @@ export const ON_FORMAT_WORKSPACE = async (
         LANGUAGE_SERVER_MESSAGE_LOOKUP.PROGRESS,
         {
           progressId: id,
-          percent: 100 * Math.floor((i + 1) / files.length),
+          increment: 100 * (1 / files.length),
           title: IDL_TRANSLATION.lsp.progress.formatWorkspace,
         }
       );
     }
 
+    // update progress
+    SERVER_EVENT_MANAGER.sendNotification(
+      LANGUAGE_SERVER_MESSAGE_LOOKUP.PROGRESS,
+      {
+        progressId: id,
+        increment: 1 / files.length,
+        title: IDL_TRANSLATION.lsp.progress.formatWorkspace,
+        finished: true,
+      }
+    );
+
     return {
       failures,
     };
@@ -132,5 +156,16 @@ export const ON_FORMAT_WORKSPACE = async (
       content: [`Error trying to format code in workspace`, err],
       alert: IDL_TRANSLATION.lsp.events.onWorkspaceFormatting,
     });
+
+    // update progress
+    SERVER_EVENT_MANAGER.sendNotification(
+      LANGUAGE_SERVER_MESSAGE_LOOKUP.PROGRESS,
+      {
+        progressId: id,
+        increment: 1,
+        title: IDL_TRANSLATION.lsp.progress.formatWorkspace,
+        finished: true,
+      }
+    );
   }
 };

libs/vscode/server/src/lib/events/initialize-custom-event-handler.ts

@@ -43,7 +43,7 @@ export function InitializeCustomEventHandler() {
   );
 
   // listen for workspace formatting
-  SERVER_EVENT_MANAGER.onNotification(
+  SERVER_EVENT_MANAGER.onRequest(
     LANGUAGE_SERVER_MESSAGE_LOOKUP.FORMAT_WORKSPACE,
     ON_FORMAT_WORKSPACE
   );