Rewire autosave (#1077)

* Remove persistence experiment * Fix autosave status * Fix share button status and stop generating sessions when disabled * Respect configured settings for auto-save * Rewire auto-save and output persistence * Prevent sign in badge, separate auto-save from output persistence * Prevent output persistence if auto-save is disabled * Add saveExecution test
stateful · Jan 29, 2024 · 14325b0 · 14325b0
1 parent fd3047d
commit 14325b0
Show file tree

Hide file tree

Showing 17 changed files with 578 additions and 50 deletions.
diff --git a/__mocks__/vscode.ts b/__mocks__/vscode.ts
@@ -24,6 +24,12 @@ export class Uri extends URI {
   static parse = vi.fn(super.parse)
 
   static joinPath = vi.fn((uri: Uri, ...paths: string[]) => {
+    /**
+     * Allow testing against http endpoints
+     */
+    if (uri.authority?.includes('.runme.dev')) {
+      return  `https://testing.runme.dev${path.join(...paths)}`
+    }
     return super.file(path.join(uri.fsPath, ...paths))
   })
 }
@@ -280,7 +286,8 @@ export enum TaskScope {
 export const ShellExecution = vi.fn()
 export const Task = vi.fn()
 export const authentication = {
-  getSession: vi.fn()
+  getSession: vi.fn(),
+  onDidChangeSessions: vi.fn()
 }
 
 export class WorkspaceEdit {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -223,6 +223,11 @@
         "title": "Reset Session including Environment Variables",
         "icon": "$(search-refresh)",
         "shortTitle": "Reset Session"
+      },
+      {
+        "command": "runme.resetLoginPrompt",
+        "category": "Runme",
+        "title": "Reset login prompt when asking to Signin with GitHub"
       }
     ],
     "menus": {
@@ -339,7 +344,7 @@
         },
         {
           "command": "runme.resetRunnerSession",
-          "when": "notebookType == runme && notebookHasRunmeOutputs",
+          "when": "notebookType == runme",
           "group": "navigation"
         },
         {
@@ -460,12 +465,6 @@
             "default": true,
             "markdownDescription": "If set to `true`, the extension will bring up the GRPC server."
           },
-          "runme.experiments.outputPersistence": {
-            "type": "boolean",
-            "scope": "window",
-            "default": false,
-            "markdownDescription": "If set to `true`, the notebook's outputs are stored inside a full copy of the original file per session."
-          },
           "runme.checkout.projectDir": {
             "type": "string",
             "scope": "machine",
@@ -673,6 +672,12 @@
             ],
             "default": "no",
             "markdownDescription": "Automatically save cell execution output"
+          },
+          "runme.app.sessionOutputs": {
+            "type": "boolean",
+            "scope": "window",
+            "default": true,
+            "markdownDescription": "If set to `true`, the notebook's outputs are stored inside a full copy of the original file per session."
           }
         }
       }
@@ -924,6 +929,7 @@
     "expect-webdriverio": "^4.2.7",
     "fork-ts-checker-webpack-plugin": "^9.0.0",
     "husky": "^8.0.3",
+    "msw": "^2.1.5",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.2.4",
     "runme": "^3.1.0",

diff --git a/src/client/components/terminal/index.ts b/src/client/components/terminal/index.ts
@@ -456,6 +456,15 @@ export class TerminalView extends LitElement {
               if (e.output.hasErrors) {
                 return postClientMessage(ctx, ClientMessages.errorMessage, e.output.data)
               }
+
+              if (
+                e.output.data.hasOwnProperty('displayShare') &&
+                e.output.data.displayShare === false
+              ) {
+                this.shareText = this.saveText
+                return
+              }
+
               const { data } = e.output.data
               if (data.createCellExecution) {
                 const {
@@ -515,7 +524,7 @@ export class TerminalView extends LitElement {
               return
             }
             this.shareText = this.isAutoSaveEnabled ? this.shareEnabledText : this.saveText
-            return this.#shareCellOutput()
+            return this.#shareCellOutput(false)
           }
         }
       }),
@@ -717,7 +726,14 @@ export class TerminalView extends LitElement {
     })
   }
 
-  async #shareCellOutput(): Promise<boolean | void | undefined> {
+  async #triggerShareCellOutput(): Promise<boolean | void | undefined> {
+    return this.#shareCellOutput(true)
+  }
+
+  /**
+   * @param isUserAction Indicates if the user clicked the save button directly
+   */
+  async #shareCellOutput(isUserAction: boolean): Promise<boolean | void | undefined> {
     const ctx = getContext()
     if (!ctx.postMessage) {
       return
@@ -744,6 +760,7 @@ export class TerminalView extends LitElement {
       await postClientMessage(ctx, ClientMessages.cloudApiRequest, {
         data: {
           stdout: contentWithAnsi,
+          isUserAction,
         },
         id: this.id!,
         method: APIMethod.CreateCellExecution,
@@ -788,7 +805,7 @@ export class TerminalView extends LitElement {
               ?disabled=${this.isCloudApiLoading}
               ?displayShareIcon=${this.isShareReady}
               shareText="${this.isCloudApiLoading ? 'Saving ...' : this.shareText}"
-              @onShare="${this.#shareCellOutput}"
+              @onShare="${this.#triggerShareCellOutput}"
             >
             </share-cell>`,
           () => html``,

diff --git a/src/constants.ts b/src/constants.ts
@@ -1069,3 +1069,5 @@ export enum WebViews {
 export const CATEGORY_SEPARATOR = ','
 export const EXECUTION_CELL_STORAGE_KEY = 'executionCell'
 export const EXECUTION_CELL_CREATION_DATE_STORAGE_KEY = 'executionCellCreationDate'
+export const SAVE_CELL_LOGIN_CONSENT_STORAGE_KEY = 'loginConsent'
+export const CLOUD_USER_SIGNED_IN = 'userSignedIn'