Refactor execution results

src/api.proposed.kernelApi.d.ts

@@ -11,6 +11,11 @@ declare module './api' {
         >;
     }
     export interface Kernels {
+        /**
+         * Whether the access to the Kernels has been revoked.
+         * This happens when the user has not provided consent to the API being used by the requesting extension.
+         */
+        isRevoked: boolean;
         /**
          * Finds a kernel for a given resource.
          * For instance if the resource is a notebook, then look for a kernel associated with the given Notebook document.

src/api.proposed.kernelApiAccess.d.ts

@@ -5,12 +5,11 @@
 import type { CancellationToken } from 'vscode';
 
 declare module './api' {
-    /**
-     * Provides access to the Jupyter Kernel API.
-     * As Kernels can be used to execute code on local or remote machines, this poses a threat to security.
-     * As a result users will be prompted to allow access to the Kernel API.
-     */
     export interface Jupyter {
-        getKernelApi(): Promise<Kernels | undefined>;
+        /**
+         * Request access to Kernels.
+         * As Kernels can be used to execute code on local or remote machines, user consent will be required.
+         */
+        requestKernelAccess(): Thenable<Kernels>;
     }
 }

src/api.proposed.kernelCodeExecution.d.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import type { CancellationToken, Event } from 'vscode';
+import type { CancellationToken } from 'vscode';
 
 declare module './api' {
     interface OutputItem {
@@ -14,28 +14,16 @@ declare module './api' {
          */
         data: Uint8Array;
     }
-
-    interface ExecutionResult {
-        /**
-         * Resolves when the execution has completed.
-         */
-        done: Promise<void>;
-
-        /**
-         * Event fired with the output items emitted as a result of the execution.
-         */
-        onDidEmitOutput: Event<OutputItem[]>;
-    }
     export interface Kernel {
         /**
          * Executes code in the kernel.
          * The code executed will not result in changes to the execution count
          * & will not show up in the Kernel execution history.
          *
-         * @param {string} code Code to be executed.
-         * @param {CancellationToken} token Triggers the cancellation of the execution.
-         * @return {*}  {ExecutionResult}
+         * @param code Code to be executed.
+         * @param token Triggers the cancellation of the execution.
+         * @returns Async iterable of output items, that completes when the execution is complete.
          */
-        executeCode(code: string, token: CancellationToken): ExecutionResult;
+        executeCode(code: string, token: CancellationToken): AsyncIterable<OutputItem[]>;
     }
 }

src/extension.node.ts

@@ -140,7 +140,7 @@ export async function activate(context: IExtensionContext): Promise<IExtensionAp
             createJupyterServerCollection: () => {
                 throw new Error('Not Implemented');
             },
-            getKernelApi: () => Promise.resolve(undefined)
+            requestKernelAccess: () => Promise.reject(new Error('Not Implemented'))
         };
     }
 }

src/extension.web.ts

@@ -144,7 +144,7 @@ export async function activate(context: IExtensionContext): Promise<IExtensionAp
             createJupyterServerCollection: () => {
                 throw new Error('Not Implemented');
             },
-            getKernelApi: () => Promise.resolve(undefined)
+            requestKernelAccess: () => Promise.reject(new Error('Not Implemented'))
         };
     }
 }

src/kernels/api/api.ts

@@ -20,6 +20,7 @@ export function getKernelsApi(extensionId: string): Kernels {
     }
 
     api = {
+        isRevoked: false,
         findKernel(query: { uri: Uri }) {
             const kernelProvider = ServiceContainer.instance.get<IKernelProvider>(IKernelProvider);
             const notebooks = ServiceContainer.instance.get<IVSCodeNotebook>(IVSCodeNotebook);

src/kernels/api/api.vscode.common.test.ts

@@ -24,10 +24,10 @@ import {
 } from '../../test/datascience/notebook/helper';
 import { getKernelsApi } from './api';
 import { raceTimeoutError } from '../../platform/common/utils/async';
-import { ExecutionResult } from '../../api';
 import { dispose } from '../../platform/common/utils/lifecycle';
 import { IKernel, IKernelProvider } from '../types';
 import { IControllerRegistration, IVSCodeNotebookController } from '../../notebooks/controllers/types';
+import { OutputItem } from '../../api';
 
 suiteMandatory('Kernel API Tests @python', function () {
     const disposables: IDisposable[] = [];
@@ -127,29 +127,28 @@ suiteMandatory('Kernel API Tests @python', function () {
         );
     });
 
-    async function waitForOutput(executionResult: ExecutionResult, expectedOutput: string, expectedMimetype: string) {
+    async function waitForOutput(
+        executionResult: AsyncIterable<OutputItem[]>,
+        expectedOutput: string,
+        expectedMimetype: string
+    ) {
         const disposables: IDisposable[] = [];
         const outputsReceived: string[] = [];
-        const outputPromise = new Promise<void>((resolve, reject) => {
-            executionResult.onDidEmitOutput(
-                (e) => {
-                    traceInfo(`Output received ${e.length} & mime types are ${e.map((item) => item.mime).join(', ')}}`);
-                    e.forEach((item) => {
-                        if (item.mime === expectedMimetype) {
-                            const output = new TextDecoder().decode(item.data).trim();
-                            if (output === expectedOutput.trim()) {
-                                resolve();
-                            } else {
-                                reject(new Error(`Unexpected output ${output}`));
-                            }
+        const outputPromise = new Promise<void>(async (resolve, reject) => {
+            for await (const items of executionResult) {
+                items.forEach((item) => {
+                    if (item.mime === expectedMimetype) {
+                        const output = new TextDecoder().decode(item.data).trim();
+                        if (output === expectedOutput.trim()) {
+                            resolve();
                         } else {
-                            outputsReceived.push(`${item.mime} ${new TextDecoder().decode(item.data).trim()}`);
+                            reject(new Error(`Unexpected output ${output}`));
                         }
-                    });
-                },
-                undefined,
-                disposables
-            );
+                    } else {
+                        outputsReceived.push(`${item.mime} ${new TextDecoder().decode(item.data).trim()}`);
+                    }
+                });
+            }
         });
 
         await raceTimeoutError(

src/kernels/api/kernel.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { l10n, CancellationToken, Event, EventEmitter, ProgressLocation, extensions, window, Disposable } from 'vscode';
-import { ExecutionResult, Kernel } from '../../api';
+import { l10n, CancellationToken, ProgressLocation, extensions, window, Disposable, Event } from 'vscode';
+import { Kernel, OutputItem } from '../../api';
 import { ServiceContainer } from '../../platform/ioc/container';
 import { IKernel, IKernelProvider, INotebookKernelExecution } from '../types';
 import { getDisplayNameOrNameOfKernelConnection } from '../helpers';
@@ -123,7 +123,7 @@ class WrappedKernelPerExtension implements Kernel {
         once(kernel.onDisposed)(() => this.progress.dispose());
     }
 
-    executeCode(code: string, token: CancellationToken): ExecutionResult {
+    async *executeCode(code: string, token: CancellationToken): AsyncGenerator<OutputItem[], void, unknown> {
         this.previousProgress?.dispose();
         let completed = false;
         const measures = {
@@ -156,16 +156,14 @@ class WrappedKernelPerExtension implements Kernel {
         if (!this.kernel.session?.kernel) {
             properties.failed = true;
             sendApiExecTelemetry(this.kernel, measures, properties).catch(noop);
-            if (this.status === 'dead' || this.status === 'terminating') {
+            if (this.kernel.status === 'dead' || this.kernel.status === 'terminating') {
                 throw new Error('Kernel is dead or terminating');
             }
             throw new Error('Kernel connection not available to execute 3rd party code');
         }
 
         const disposables: IDisposable[] = [];
         const done = createDeferred<void>();
-        const onDidEmitOutput = new EventEmitter<{ mime: string; data: Uint8Array }[]>();
-        disposables.push(onDidEmitOutput);
         disposables.push({
             dispose: () => {
                 measures.duration = stopwatch.elapsedTime;
@@ -179,6 +177,8 @@ class WrappedKernelPerExtension implements Kernel {
         const kernelExecution = ServiceContainer.instance
             .get<IKernelProvider>(IKernelProvider)
             .getKernelExecution(this.kernel);
+        const outputs: OutputItem[][] = [];
+        let outputsReceieved = createDeferred<void>();
         kernelExecution
             .executeCode(code, this.extensionId, token)
             .then((codeExecution) => {
@@ -206,7 +206,7 @@ class WrappedKernelPerExtension implements Kernel {
                 codeExecution.onDidEmitOutput(
                     (e) => {
                         e.forEach((item) => mimeTypes.add(item.mime));
-                        onDidEmitOutput.fire(e);
+                        outputs.push(e);
                     },
                     this,
                     disposables
@@ -232,10 +232,18 @@ class WrappedKernelPerExtension implements Kernel {
             this,
             disposables
         );
-        return {
-            done: done.promise,
-            onDidEmitOutput: onDidEmitOutput.event
-        };
+        while (true) {
+            await Promise.race([outputsReceieved.promise, done.promise]);
+            if (outputsReceieved.completed) {
+                outputsReceieved = createDeferred<void>();
+            }
+            while (outputs.length) {
+                yield outputs.shift()!;
+            }
+            if (done.completed) {
+                break;
+            }
+        }
     }
 }
 

src/standalone/api/api.ts

@@ -213,8 +213,8 @@ export function buildApi(
                 extensions.determineExtensionFromCallStack().extensionId
             );
         },
-        getKernelApi() {
-            return Promise.resolve(undefined);
+        requestKernelAccess() {
+            return Promise.reject(new Error('Not Implemeted'));
         }
     };