notebook image cleaning automation

extensions/ipynb/.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}"
+            ],
+            "name": "Launch Extension",
+            "outFiles": [
+                "${workspaceFolder}/out/**/*.js"
+            ],
+            "request": "launch",
+            "type": "extensionHost"
+        }
+    ]
+}

extensions/ipynb/package.json

@@ -9,7 +9,7 @@
 		"vscode": "^1.57.0"
 	},
 	"enabledApiProposals": [
-    "documentPaste"
+		"documentPaste"
 	],
 	"activationEvents": [
 		"*"
@@ -27,21 +27,21 @@
 		}
 	},
 	"contributes": {
-    "configuration":[
-      {
-        "properties": {
-          "ipynb.experimental.pasteImages.enabled":{
-            "type": "boolean",
-            "scope": "resource",
-            "markdownDescription": "%ipynb.experimental.pasteImages.enabled%",
-            "default": false,
-            "tags": [
-              "experimental"
-            ]
-          }
-        }
-      }
-    ],
+		"configuration": [
+			{
+				"properties": {
+					"ipynb.experimental.pasteImages.enabled": {
+						"type": "boolean",
+						"scope": "resource",
+						"markdownDescription": "%ipynb.experimental.pasteImages.enabled%",
+						"default": false,
+						"tags": [
+							"experimental"
+						]
+					}
+				}
+			}
+		],
 		"commands": [
 			{
 				"command": "ipynb.newUntitledIpynb",
@@ -52,6 +52,10 @@
 			{
 				"command": "ipynb.openIpynbInNotebookEditor",
 				"title": "Open ipynb file in notebook editor"
+			},
+			{
+				"command": "ipynb.cleanInvalidImageAttachment",
+				"title": "Clean invalid image attachment reference"
 			}
 		],
 		"notebooks": [
@@ -66,16 +70,16 @@
 				"priority": "default"
 			}
 		],
-    "notebookRenderer": [
-      {
-        "id": "vscode.markdown-it-cell-attachment-renderer",
-        "displayName": "Markdown it ipynb Cell Attachment renderer",
-        "entrypoint": {
-          "extends": "vscode.markdown-it-renderer",
-          "path": "./notebook-out/cellAttachmentRenderer.js"
-        }
-      }
-    ],
+		"notebookRenderer": [
+			{
+				"id": "vscode.markdown-it-cell-attachment-renderer",
+				"displayName": "Markdown it ipynb Cell Attachment renderer",
+				"entrypoint": {
+					"extends": "vscode.markdown-it-renderer",
+					"path": "./notebook-out/cellAttachmentRenderer.js"
+				}
+			}
+		],
 		"menus": {
 			"file/newFile": [
 				{
@@ -90,6 +94,10 @@
 				{
 					"command": "ipynb.openIpynbInNotebookEditor",
 					"when": "false"
+				},
+				{
+					"command": "ipynb.cleanInvalidImageAttachment",
+					"when": "false"
 				}
 			]
 		}

extensions/ipynb/src/constants.ts

@@ -3,4 +3,9 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import * as vscode from 'vscode';
+
 export const defaultNotebookFormat = { major: 4, minor: 2 };
+export const ATTACHMENT_CLEANUP_COMMANDID = 'ipynb.cleanInvalidImageAttachment';
+
+export const JUPYTER_NOTEBOOK_MARKDOWN_SELECTOR: vscode.DocumentSelector = { notebookType: 'jupyter-notebook', language: 'markdown' };

extensions/ipynb/src/helper.ts

@@ -0,0 +1,137 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export function deepClone<T>(obj: T): T {
+	if (!obj || typeof obj !== 'object') {
+		return obj;
+	}
+	if (obj instanceof RegExp) {
+		// See https://github.com/microsoft/TypeScript/issues/10990
+		return obj as any;
+	}
+	const result: any = Array.isArray(obj) ? [] : {};
+	Object.keys(<any>obj).forEach((key: string) => {
+		if ((<any>obj)[key] && typeof (<any>obj)[key] === 'object') {
+			result[key] = deepClone((<any>obj)[key]);
+		} else {
+			result[key] = (<any>obj)[key];
+		}
+	});
+	return result;
+}
+
+// from https://github.com/microsoft/vscode/blob/43ae27a30e7b5e8711bf6b218ee39872ed2b8ef6/src/vs/base/common/objects.ts#L117
+export function objectEquals(one: any, other: any) {
+	if (one === other) {
+		return true;
+	}
+	if (one === null || one === undefined || other === null || other === undefined) {
+		return false;
+	}
+	if (typeof one !== typeof other) {
+		return false;
+	}
+	if (typeof one !== 'object') {
+		return false;
+	}
+	if ((Array.isArray(one)) !== (Array.isArray(other))) {
+		return false;
+	}
+
+	let i: number;
+	let key: string;
+
+	if (Array.isArray(one)) {
+		if (one.length !== other.length) {
+			return false;
+		}
+		for (i = 0; i < one.length; i++) {
+			if (!objectEquals(one[i], other[i])) {
+				return false;
+			}
+		}
+	} else {
+		const oneKeys: string[] = [];
+
+		for (key in one) {
+			oneKeys.push(key);
+		}
+		oneKeys.sort();
+		const otherKeys: string[] = [];
+		for (key in other) {
+			otherKeys.push(key);
+		}
+		otherKeys.sort();
+		if (!objectEquals(oneKeys, otherKeys)) {
+			return false;
+		}
+		for (i = 0; i < oneKeys.length; i++) {
+			if (!objectEquals(one[oneKeys[i]], other[oneKeys[i]])) {
+				return false;
+			}
+		}
+	}
+
+	return true;
+}
+
+interface Options<T> {
+	callback: (value: T) => void;
+
+	merge?: (input: T[]) => T;
+	delay?: number;
+}
+
+
+export class DebounceTrigger<T> {
+
+	private _isPaused = 0;
+	protected _queue: T[] = [];
+	private _callbackFn: (value: T) => void;
+	private _mergeFn?: (input: T[]) => T;
+	private readonly _delay: number;
+	private _handle: any | undefined;
+
+	constructor(options: Options<T>) {
+		this._callbackFn = options.callback;
+		this._mergeFn = options.merge;
+		this._delay = options.delay ?? 100;
+	}
+
+	private pause(): void {
+		this._isPaused++;
+	}
+
+	private resume(): void {
+		if (this._isPaused !== 0 && --this._isPaused === 0) {
+			if (this._mergeFn) {
+				const items = Array.from(this._queue);
+				this._queue = [];
+				this._callbackFn(this._mergeFn(items));
+
+			} else {
+				while (!this._isPaused && this._queue.length !== 0) {
+					this._callbackFn(this._queue.shift()!);
+				}
+			}
+		}
+	}
+
+	trigger(item: T): void {
+		if (!this._handle) {
+			this.pause();
+			this._handle = setTimeout(() => {
+				this._handle = undefined;
+				this.resume();
+			}, this._delay);
+		}
+
+		if (this._isPaused !== 0) {
+			this._queue.push(item);
+		} else {
+			this._callbackFn(item);
+		}
+	}
+}

extensions/ipynb/src/ipynbMain.ts

@@ -4,9 +4,10 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import { ensureAllNewCellsHaveCellIds } from './cellIdService';
 import { NotebookSerializer } from './notebookSerializer';
-import * as NotebookImagePaste from './notebookImagePaste';
+import { ensureAllNewCellsHaveCellIds } from './cellIdService';
+import { notebookImagePasteSetup } from './notebookImagePaste';
+import { AttachmentCleaner } from './notebookAttachmentCleaner';
 
 // From {nbformat.INotebookMetadata} in @jupyterlab/coreutils
 type NotebookMetadata = {
@@ -78,7 +79,13 @@ export function activate(context: vscode.ExtensionContext) {
 		await vscode.window.showNotebookDocument(document);
 	}));
 
-	context.subscriptions.push(NotebookImagePaste.imagePasteSetup());
+	context.subscriptions.push(notebookImagePasteSetup());
+
+	const enabled = vscode.workspace.getConfiguration('ipynb').get('experimental.pasteImages.enabled', false);
+	if (enabled) {
+		const cleaner = new AttachmentCleaner();
+		context.subscriptions.push(cleaner);
+	}
 
 	// Update new file contribution
 	vscode.extensions.onDidChange(() => {