Improves user experience inside Stateful Cloud Playgrounds (#1786)

* Add trusted domains

* Auto Open New terminal

* Removes TrustedDomains Dialog

* Auto open new terminal once

* Consolidate UX features into HostedPlayground

Merged AutoOpenTerminal and AddTrustedDomains into a single feature flag: HostedPlayground, per code review feedback.

* Not a user-setting, make sure it's always default false

* Check feature status top and inside feature for clarity

---------

Co-authored-by: Sebastian Tiedtke <[email protected]>

package.json

@@ -59,6 +59,15 @@
   "main": "./out/extension.js",
   "runme": {
     "features": {
+      "HostedPlayground": {
+        "enabled": false,
+        "conditions": {
+          "enabledForExtensions": {
+            "stateful.platform": false,
+            "stateful.runme": true
+          }
+        }
+      },
       "NewTreeProvider": {
         "enabled": false,
         "conditions": {

src/extension/extension.ts

@@ -94,6 +94,7 @@ import getLogger from './logger'
 import { EnvironmentManager } from './environment/manager'
 import ContextState from './contextState'
 import { RunmeIdentity } from './grpc/serializerTypes'
+import * as features from './features'
 
 export class RunmeExtension {
   protected serializer?: SerializerBase
@@ -532,6 +533,12 @@ export class RunmeExtension {
         })
       }
     })
+
+    // only ever enabled in hosted playground
+    if (features.isOnInContextState(FeatureName.HostedPlayground)) {
+      await features.addTrustedDomains()
+      await features.autoOpenTerminal()
+    }
   }
 
   protected handleMasking(kernel: Kernel, maskingIsOn: boolean): (e: NotebookUiEvent) => void {

src/extension/features/addTrustedDomains.ts

@@ -0,0 +1,37 @@
+import { Uri, workspace } from 'vscode'
+import { parse as jsoncParse } from 'jsonc-parser'
+
+import { FeatureName } from '../../types'
+import getLogger from '../logger'
+
+import { isOnInContextState } from '.'
+
+const logger = getLogger('AddTrustedDomains')
+const trustedDomain = 'https://*.stateful.com'
+
+export async function addTrustedDomains() {
+  if (!isOnInContextState(FeatureName.HostedPlayground)) {
+    return
+  }
+
+  try {
+    const uri = Uri.parse('trustedDomains:/Trusted Domains')
+    const bytes = await workspace.fs.readFile(uri)
+    const json = jsoncParse(Buffer.from(bytes).toString('utf8')) as string[]
+    const isTrusted = json.some((entry) => entry === trustedDomain)
+
+    if (!isTrusted) {
+      json.push(trustedDomain)
+      await workspace.fs.writeFile(uri, Buffer.from(JSON.stringify(json)))
+    }
+  } catch (error) {
+    let message
+    if (error instanceof Error) {
+      message = error.message
+    } else {
+      message = JSON.stringify(error)
+    }
+
+    logger.error(message)
+  }
+}

src/extension/features/autoOpenTerminal.ts

@@ -0,0 +1,17 @@
+import { commands } from 'vscode'
+
+import { FeatureName } from '../../types'
+import ContextState from '../contextState'
+
+import { isOnInContextState } from '.'
+
+export async function autoOpenTerminal() {
+  if (!isOnInContextState(FeatureName.HostedPlayground)) {
+    return
+  }
+
+  if (!ContextState.getKey<boolean>(`${FeatureName.HostedPlayground}.autoOpenTerminal`)) {
+    await commands.executeCommand('workbench.action.terminal.new')
+    await ContextState.addKey(`${FeatureName.HostedPlayground}.autoOpenTerminal`, true)
+  }
+}

src/extension/features.ts → src/extension/features/index.ts

@@ -1,7 +1,9 @@
-import features, { FEATURES_CONTEXT_STATE_KEY } from '../features'
-import { FeatureName } from '../types'
+export * from './addTrustedDomains'
+export * from './autoOpenTerminal'
 
-import ContextState from './contextState'
+import features, { FEATURES_CONTEXT_STATE_KEY } from '../../features'
+import { FeatureName } from '../../types'
+import ContextState from '../contextState'
 
 export function isOnInContextState(featureName: FeatureName): boolean {
   const snapshot = ContextState.getKey<string>(FEATURES_CONTEXT_STATE_KEY)
@@ -14,10 +16,6 @@ export function isOnInContextState(featureName: FeatureName): boolean {
   return features.isOn(featureName, featureState$)
 }
 
-export default {
-  isOnInContextState,
-}
-
 export function getFeaturesContext() {
   const snapshot = ContextState.getKey<string>(FEATURES_CONTEXT_STATE_KEY)
   if (!snapshot) {
@@ -28,3 +26,7 @@ export function getFeaturesContext() {
 
   return featureState$.getValue().context
 }
+
+export default {
+  isOnInContextState,
+}

src/types.ts

@@ -772,6 +772,7 @@ export enum FeatureName {
   RequireStatefulAuth = 'RequireStatefulAuth',
   CopySelectionToClipboard = 'CopySelectionToClipboard',
   NewTreeProvider = 'NewTreeProvider',
+  HostedPlayground = 'HostedPlayground',
 }
 
 export type Feature = {

tests/extension/features.test.ts

@@ -190,3 +190,33 @@ describe('Feature Store', () => {
     expect(features.isOn(FeatureName.Gist, featureState$)).toBe(true)
   })
 })
+
+describe('Hosted Playground', () => {
+  let featureState$: FeatureObserver
+
+  beforeEach(() => {
+    featureState$ = features.loadState(packageJSON, {
+      os: 'linux',
+    })
+  })
+
+  it('should always be default disabled in Runme', () => {
+    const initialContext: FeatureContext = {
+      extensionId: ExtensionName.StatefulRunme,
+    }
+
+    features.updateState(featureState$, initialContext)
+
+    expect(features.isOn(FeatureName.HostedPlayground, featureState$)).toBe(false)
+  })
+
+  it('should always be default disabled in Stateful', () => {
+    const initialContext: FeatureContext = {
+      extensionId: ExtensionName.StatefulPlatform,
+    }
+
+    features.updateState(featureState$, initialContext)
+
+    expect(features.isOn(FeatureName.HostedPlayground, featureState$)).toBe(false)
+  })
+})