feat: add upload/download for sas content (#550)

**Summary** This makes a few changes around uploading/downloading files in the sas extension: - This adds an `Upload` context menu item to SAS content: This feature allows a user to upload one or more files to sas content - This adds a `Download` context menu item to SAS content: This allows you to download one or more files or folders, and specify where to save them - **NOTE**: This doesn't allow you to specify file name when you are specifying a single file to download. This is to make it such that we have consistency between downloading a single file or multiple files. The single file will be persisted with the same name from SAS content - This adds a `Download` context menu item to the results pane. Clicking this will allow the user to save the results as an html file - This introduces `ResultsPanelSubscriptionProvider` which is responsible for handling commands against the results panel **Testing** - [x] Tested uploading single and multiple files - [x] Tested downloading single files, files + folder, files + folder + a subset of children in the folder - [x] Tested downloading results (tested w/ tables & sgplots)
sassoftware · Nov 1, 2023 · 15d0f11 · 15d0f11
1 parent 6650015
commit 15d0f11
Show file tree

Hide file tree

Showing 13 changed files with 323 additions and 37 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). If you introduce breaking changes, please group them together in the "Changed" section using the **BREAKING:** prefix.
 
+## [Unreleased]
+
+### Added
+
+- Added the ability to upload and download sas content using the context menu ([#547](https://github.com/sassoftware/vscode-sas-extension/issues/547))
+- Added the ability to download results as an html file ([#546](https://github.com/sassoftware/vscode-sas-extension/issues/546))
+
 ## [v1.5.0] - 2023-10-27
 
 ### Added

diff --git a/client/src/commands/run.ts b/client/src/commands/run.ts
@@ -13,7 +13,7 @@ import {
 import type { BaseLanguageClient } from "vscode-languageclient";
 
 import { LogFn as LogChannelFn } from "../components/LogChannel";
-import { showResult } from "../components/ResultPanel";
+import { showResult } from "../components/ResultPanel/ResultPanel";
 import {
   assign_SASProgramFile,
   wrapCodeWithOutputHtml,

diff --git a/client/src/components/ContentNavigator/ContentDataProvider.ts b/client/src/components/ContentNavigator/ContentDataProvider.ts
@@ -30,9 +30,10 @@ import {
   l10n,
   languages,
   window,
+  workspace,
 } from "vscode";
 
-import { lstat, readFile, readdir } from "fs";
+import { lstat, lstatSync, readFile, readdir } from "fs";
 import { basename, join } from "path";
 import { promisify } from "util";
 
@@ -60,6 +61,7 @@ import {
   getResourceIdFromItem,
   getTypeName,
   getUri,
+  isContainer,
   isItemInRecycleBin,
   isReference,
   resourceType,
@@ -492,6 +494,77 @@ class ContentDataProvider
     });
   }
 
+  public async uploadUrisToTarget(
+    uris: Uri[],
+    target: ContentItem,
+  ): Promise<void> {
+    const failedUploads = [];
+    for (let i = 0; i < uris.length; ++i) {
+      const uri = uris[i];
+      const fileName = basename(uri.fsPath);
+      if (lstatSync(uri.fsPath).isDirectory()) {
+        const success = await this.handleFolderDrop(target, uri.fsPath, false);
+        !success && failedUploads.push(fileName);
+      } else {
+        const file = await workspace.fs.readFile(uri);
+        const newUri = await this.createFile(target, fileName, file);
+        !newUri && failedUploads.push(fileName);
+      }
+    }
+
+    if (failedUploads.length > 0) {
+      this.handleCreationResponse(
+        target,
+        undefined,
+        l10n.t(Messages.FileUploadError),
+      );
+    }
+  }
+
+  public async downloadContentItems(
+    folderUri: Uri,
+    selections: ContentItem[],
+    allSelections: readonly ContentItem[],
+  ): Promise<void> {
+    for (let i = 0; i < selections.length; ++i) {
+      const selection = selections[i];
+      if (isContainer(selection)) {
+        const newFolderUri = Uri.joinPath(folderUri, selection.name);
+        const selectionsWithinFolder = await this.childrenSelections(
+          selection,
+          allSelections,
+        );
+        await workspace.fs.createDirectory(newFolderUri);
+        await this.downloadContentItems(
+          newFolderUri,
+          selectionsWithinFolder,
+          allSelections,
+        );
+      } else {
+        await workspace.fs.writeFile(
+          Uri.joinPath(folderUri, selection.name),
+          await this.readFile(getUri(selection)),
+        );
+      }
+    }
+  }
+
+  private async childrenSelections(
+    selection: ContentItem,
+    allSelections: readonly ContentItem[],
+  ): Promise<ContentItem[]> {
+    const foundSelections = allSelections.filter(
+      (foundSelection) => foundSelection.parentFolderUri === selection.uri,
+    );
+    if (foundSelections.length > 0) {
+      return foundSelections;
+    }
+
+    // If we don't have any child selections, then the folder must have been
+    // closed and therefore, we expect to select _all_ children
+    return this.getChildren(selection);
+  }
+
   private async handleContentItemDrop(
     target: ContentItem,
     item: ContentItem,
@@ -518,7 +591,7 @@ class ContentDataProvider
     }
 
     if (!success) {
-      await window.showErrorMessage(
+      window.showErrorMessage(
         l10n.t(message, {
           name: item.name,
         }),
@@ -529,15 +602,17 @@ class ContentDataProvider
   private async handleFolderDrop(
     target: ContentItem,
     path: string,
+    displayErrorMessages: boolean = true,
   ): Promise<boolean> {
     const folder = await this.model.createFolder(target, basename(path));
     let success = true;
     if (!folder) {
-      await window.showErrorMessage(
-        l10n.t(Messages.FileDropError, {
-          name: basename(path),
-        }),
-      );
+      displayErrorMessages &&
+        window.showErrorMessage(
+          l10n.t(Messages.FileDropError, {
+            name: basename(path),
+          }),
+        );
 
       return false;
     }
@@ -561,11 +636,12 @@ class ContentDataProvider
           );
           if (!fileCreated) {
             success = false;
-            await window.showErrorMessage(
-              l10n.t(Messages.FileDropError, {
-                name,
-              }),
-            );
+            displayErrorMessages &&
+              window.showErrorMessage(
+                l10n.t(Messages.FileDropError, {
+                  name,
+                }),
+              );
           }
         }
       }),
@@ -604,7 +680,7 @@ class ContentDataProvider
         );
 
         if (!fileCreated) {
-          await window.showErrorMessage(
+          window.showErrorMessage(
             l10n.t(Messages.FileDropError, {
               name,
             }),

diff --git a/client/src/components/ContentNavigator/ContentModel.ts b/client/src/components/ContentNavigator/ContentModel.ts
@@ -241,7 +241,6 @@ export class ContentModel {
     }
 
     const fileLink: Link | null = getLink(createdResource.links, "GET", "self");
-
     const memberAdded = await this.addMember(
       fileLink?.uri,
       getLink(item.links, "POST", "addMember")?.uri,
@@ -250,7 +249,6 @@ export class ContentModel {
         contentType,
       },
     );
-
     if (!memberAdded) {
       return;
     }

diff --git a/client/src/components/ContentNavigator/const.ts b/client/src/components/ContentNavigator/const.ts
@@ -62,6 +62,7 @@ export const Messages = {
   FileDropError: l10n.t('Unable to drop item "{name}".'),
   FileOpenError: l10n.t("The file type is unsupported."),
   FileRestoreError: l10n.t("Unable to restore file."),
+  FileUploadError: l10n.t("Unable to upload files."),
   FileValidationError: l10n.t("Invalid file name."),
   FolderDeletionError: l10n.t("Unable to delete folder."),
   FolderRestoreError: l10n.t("Unable to restore folder."),

diff --git a/client/src/components/ContentNavigator/index.ts b/client/src/components/ContentNavigator/index.ts
@@ -4,6 +4,7 @@ import {
   ConfigurationChangeEvent,
   Disposable,
   ExtensionContext,
+  OpenDialogOptions,
   ProgressLocation,
   Uri,
   commands,
@@ -305,6 +306,56 @@ class ContentNavigator implements SubscriptionProvider {
           );
         },
       ),
+      commands.registerCommand(
+        "SAS.downloadResource",
+        async (resource: ContentItem) => {
+          const selections = this.treeViewSelections(resource);
+          const uris = await window.showOpenDialog({
+            title: l10n.t("Choose where to save your files."),
+            openLabel: l10n.t("Save"),
+            canSelectFolders: true,
+            canSelectFiles: false,
+            canSelectMany: false,
+          });
+          const uri = uris && uris.length > 0 ? uris[0] : undefined;
+
+          if (!uri) {
+            return;
+          }
+
+          await window.withProgress(
+            {
+              location: ProgressLocation.Notification,
+              title: l10n.t("Downloading files..."),
+            },
+            async () => {
+              await this.contentDataProvider.downloadContentItems(
+                uri,
+                selections,
+                this.contentDataProvider.treeView.selection,
+              );
+            },
+          );
+        },
+      ),
+      // Below, we have three commands to upload files. Mac is currently the only
+      // platform that supports uploading both files and folders. So, for any platform
+      // that isn't Mac, we list a distinct upload file(s) or upload folder(s) command.
+      // See the `OpenDialogOptions` interface for more information.
+      commands.registerCommand(
+        "SAS.uploadResource",
+        async (resource: ContentItem) => this.uploadResource(resource),
+      ),
+      commands.registerCommand(
+        "SAS.uploadFileResource",
+        async (resource: ContentItem) =>
+          this.uploadResource(resource, { canSelectFolders: false }),
+      ),
+      commands.registerCommand(
+        "SAS.uploadFolderResource",
+        async (resource: ContentItem) =>
+          this.uploadResource(resource, { canSelectFiles: false }),
+      ),
       workspace.onDidChangeConfiguration(
         async (event: ConfigurationChangeEvent) => {
           if (event.affectsConfiguration("SAS.connectionProfiles")) {
@@ -318,6 +369,31 @@ class ContentNavigator implements SubscriptionProvider {
     ];
   }
 
+  private async uploadResource(
+    resource: ContentItem,
+    openDialogOptions: Partial<OpenDialogOptions> = {},
+  ) {
+    const uris: Uri[] = await window.showOpenDialog({
+      canSelectFolders: true,
+      canSelectMany: true,
+      canSelectFiles: true,
+      ...openDialogOptions,
+    });
+    if (!uris) {
+      return;
+    }
+
+    await window.withProgress(
+      {
+        location: ProgressLocation.Notification,
+        title: l10n.t("Uploading files..."),
+      },
+      async () => {
+        await this.contentDataProvider.uploadUrisToTarget(uris, resource);
+      },
+    );
+  }
+
   private viyaEndpoint(): string {
     const activeProfile = profileConfig.getProfileByName(
       profileConfig.getActiveProfile(),
@@ -329,19 +405,6 @@ class ContentNavigator implements SubscriptionProvider {
       : "";
   }
 
-  private async handleCreationResponse(
-    resource: ContentItem,
-    newUri: Uri | undefined,
-    errorMessage: string,
-  ): Promise<void> {
-    if (!newUri) {
-      window.showErrorMessage(errorMessage);
-      return;
-    }
-
-    this.contentDataProvider.reveal(resource);
-  }
-
   private treeViewSelections(item: ContentItem): ContentItem[] {
     const items =
       this.contentDataProvider.treeView.selection.length > 1

diff --git a/client/src/components/ContentNavigator/utils.ts b/client/src/components/ContentNavigator/utils.ts
@@ -81,6 +81,10 @@ export const resourceType = (item: ContentItem): string | undefined => {
     actions.push("convertNotebookToFlow");
   }
 
+  if (!isContainer(item)) {
+    actions.push("allowDownload");
+  }
+
   if (actions.length === 0) {
     return;
   }

diff --git a/client/src/components/ResultPanel.ts → ...src/components/ResultPanel/ResultPanel.ts b/client/src/components/ResultPanel.ts → ...src/components/ResultPanel/ResultPanel.ts
@@ -2,28 +2,52 @@
 // SPDX-License-Identifier: Apache-2.0
 import { Uri, ViewColumn, WebviewPanel, l10n, window } from "vscode";
 
-import { isSideResultEnabled, isSinglePanelEnabled } from "./utils/settings";
+import { v4 } from "uuid";
+
+import { isSideResultEnabled, isSinglePanelEnabled } from "../utils/settings";
 
 let resultPanel: WebviewPanel | undefined;
+export const resultPanels: Record<string, WebviewPanel> = {};
 
 export const showResult = (html: string, uri?: Uri, title?: string) => {
+  html = html
+    // Inject vscode context into our results html body
+    .replace(
+      "<body ",
+      `<body data-vscode-context='${JSON.stringify({
+        preventDefaultContextMenuItems: true,
+      })}' `,
+    )
+    // Make sure the html and body take up the full height of the parent
+    // iframe so that the context menu is clickable anywhere on the page
+    .replace(
+      "</head>",
+      "<style>html,body { height: 100% !important; }</style></head>",
+    );
   const sideResult = isSideResultEnabled();
   const singlePanel = isSinglePanelEnabled();
   if (!title) {
     title = l10n.t("Result");
   }
 
   if (!singlePanel || !resultPanel) {
+    const resultPanelId = `SASResultPanel-${v4()}`;
     resultPanel = window.createWebviewPanel(
-      "SASSession", // Identifies the type of the webview. Used internally
+      resultPanelId, // Identifies the type of the webview. Used internally
       title, // Title of the panel displayed to the user
       {
         preserveFocus: true,
         viewColumn: sideResult ? ViewColumn.Beside : ViewColumn.Active,
       }, // Editor column to show the new webview panel in.
       {}, // Webview options. More on these later.
     );
-    resultPanel.onDidDispose(() => (resultPanel = undefined));
+    resultPanel.onDidDispose(
+      ((id) => () => {
+        delete resultPanels[id];
+        resultPanel = undefined;
+      })(resultPanelId),
+    );
+    resultPanels[resultPanelId] = resultPanel;
   } else {
     const editor = uri
       ? window.visibleTextEditors.find(