chore: port notebooks to markdown

BREAKING CHANGE: removes support for JSON notebooks

Author: starpit

packages/core/src/api/Util.ts

@@ -24,3 +24,6 @@ export { isHTML, isPromise } from '../util/types'
 // pretty printing
 export { prettyPrintTime } from '../webapp/util/time'
 export { default as prettyPrintBytes } from '../webapp/util/bytes'
+
+// gzip+base64
+export { base64PlusGzip, decodeBase64PlusGzip } from '../util/gzip'

packages/core/src/core/events.ts

@@ -37,14 +37,10 @@ export type StatusStripeChangeEvent = {
 }
 
 export type SnapshotRequestEvent = {
-  cb: (snapshot: Buffer) => void
-  filter?: (evt: CommandStartEvent) => boolean
-  opts?: {
-    name?: string
-    description?: string
-    preferReExecute?: boolean
-    shallow?: boolean
-  }
+  /** Capture just one block? */
+  execUUID?: string
+
+  cb?: (snapshot: Buffer) => void
 }
 
 export type TabLayoutChangeEvent = { isSidecarNowHidden: boolean; isWidthConstrained?: boolean }
@@ -77,12 +73,6 @@ export interface NewTabRequestEvent {
     /** Execute the command line with qexec or pexec? Default: pexec. */
     exec?: 'pexec' | 'qexec'
 
-    /** Optionally open a snapshot file in the new tab */
-    snapshot?: Buffer
-
-    /** Replace the contents of the current tab with that of the given snapshot? */
-    replaceCurrentTab?: boolean
-
     /** Optionally execute a command when the tab is closed */
     onClose?: string
   }[]

packages/core/src/index.ts

@@ -124,7 +124,7 @@ export { splitIntoPipeStages } from './repl/pipe-stages'
 export { ReplEval, DirectReplEval } from './repl/types'
 export { default as encodeComponent } from './repl/encode'
 export { exec as internalBeCarefulExec, pexec as internalBeCarefulPExec, setEvaluatorImpl, doEval } from './repl/exec'
-export { CommandStartEvent, CommandCompleteEvent, Notebook, isNotebook, SnapshottedEvent } from './repl/events'
+export { CommandStartEvent, CommandCompleteEvent, SnapshottedEvent } from './repl/events'
 
 // Tabs
 export {

packages/core/src/main/open.ts

@@ -16,7 +16,7 @@
 
 import { replay } from './notebooks'
 
-export const filters = [{ name: 'Kui snapshot', extensions: ['kui', 'json'] }]
+export const filters = [{ name: 'Kui snapshot', extensions: ['md'] }]
 
 /**
  * Open a file and replay its session.

packages/core/src/main/save.ts

@@ -14,28 +14,12 @@
  * limitations under the License.
  */
 
-import { filters } from './open'
 import tellRendererToExecute from './tell'
-import encodeComponent from '../repl/encode'
-
-let previousChoice: string
 
 /**
  * Save the current tab as a Notebook
  *
  */
 export default async function saveAsNotebook() {
-  const { dialog } = await import('electron')
-
-  const resp = await dialog.showSaveDialog({
-    title: 'Save as Notebook',
-    filters,
-    defaultPath: previousChoice
-  })
-
-  if (!resp.canceled) {
-    const thisChoice = resp.filePath
-    previousChoice = thisChoice
-    tellRendererToExecute(`snapshot ${encodeComponent(thisChoice)}`, 'pexec')
-  }
+  tellRendererToExecute(`snapshot`, 'pexec')
 }

packages/core/src/models/CommentaryResponse.ts

@@ -24,6 +24,9 @@ export type CommentaryResponse = {
     /** Content rendered inside the CardTitle */
     title?: string
 
+    /** Source filepath */
+    filepath?: string
+
     /** Body of the Card. It will be passed through as the source <Markdown source="..." /> */
     children: string
 

packages/core/src/models/entity.ts

@@ -194,9 +194,10 @@ export function isRawResponse<Content extends RawContent>(entity: Entity<Content
   return raw.mode === 'raw' && raw.content !== undefined
 }
 
-type RandomErrorResponse1 = { code: string }
+type RandomErrorResponse1 = { code: string | number; message?: string }
 export function isRandomErrorResponse1(response: Entity): response is RandomErrorResponse1 {
-  return typeof (response as RandomErrorResponse1).code === 'string'
+  const code = (response as RandomErrorResponse1).code
+  return typeof code === 'string' || typeof code === 'number'
 }
 
 type RandomErrorResponse2 = { errno: string | number }

packages/core/src/repl/events.ts

@@ -68,19 +68,3 @@ export type CommandCompleteHandler<R extends KResponse = KResponse, T extends Re
 export type SnapshottedEvent<E extends CommandStartEvent | CommandCompleteEvent> = Omit<E, 'tab'> & {
   tab: E['tab']['uuid']
 }
-
-export interface Notebook {
-  apiVersion: 'kui-shell/v1'
-  kind: 'Notebook'
-  metadata?: {
-    name?: string
-    description?: string
-    preferReExecute?: boolean
-  }
-}
-
-/** @return wether or not the given `raw` json is an instance of Notebook */
-export function isNotebook(raw: Record<string, any>): raw is Notebook {
-  const model = raw as Notebook
-  return model.apiVersion === 'kui-shell/v1' && model.kind === 'Notebook'
-}

packages/core/src/util/gzip.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { gunzipSync, gzipSync } from 'zlib'
+
+/**
+ * @return a base64-encoded and gzip-compressed version of the given
+ * `plaintext`
+ *
+ */
+export function base64PlusGzip(plaintext: string, compress = true): string {
+  if (!compress) {
+    return Buffer.from(plaintext).toString('base64')
+  }
+
+  return Buffer.from(gzipSync(plaintext)).toString('base64')
+}
+
+/** @return the reverse of `base64PlusGzip` */
+export function decodeBase64PlusGzip(data: string, compressed = true): Buffer {
+  if (!compressed) {
+    return Buffer.from(data, 'base64')
+  } else {
+    return gunzipSync(Buffer.from(data, 'base64'))
+  }
+}

plugins/plugin-bash-like/fs/src/vfs/TrieVFS.ts

@@ -186,12 +186,12 @@ export abstract class TrieVFS<D extends any, L extends Leaf<D> = Leaf<D>> implem
   public cp(_, srcFilepaths: string[], dstFilepath: string): Promise<string> {
     return Promise.all(
       srcFilepaths.map(srcFilepath => {
-        const match1 = srcFilepath.match(/^plugin:\/\/plugin-(.*)\/notebooks\/(.*)\.json$/)
-        const match2 = srcFilepath.match(/^plugin:\/\/client\/notebooks\/(.*)\.json$/)
+        const match1 = srcFilepath.match(/^plugin:\/\/plugin-(.*)\/notebooks\/(.*)\.md$/)
+        const match2 = srcFilepath.match(/^plugin:\/\/client\/notebooks\/(.*)\.md$/)
         const match3 = srcFilepath.match(/^plugin:\/\/client\/(.*)\.md$/)
         const match = match1 || match2 || match3
         if (match) {
-          const extension = match1 || match2 ? '.json' : '.md'
+          const extension = '.md'
 
           const dir = dirname(dstFilepath)
           if (!this.trieGet(dir)) {
@@ -202,7 +202,7 @@ export abstract class TrieVFS<D extends any, L extends Leaf<D> = Leaf<D>> implem
             this.trie.map(mountPath, { mountPath, data: { srcFilepath } })
           }
         } else {
-          throw new Error(`Unable to copy given source into the notebooks VFS: ${srcFilepath}`)
+          throw new Error(`Unable to copy given source into the VFS: ${srcFilepath}`)
         }
       })
     ).then(() => 'ok')