@jupyterlab/console 4.0.0-alpha.9 → 4.0.0-beta.1

package/src/history.ts

@@ -0,0 +1,370 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { ISessionContext } from '@jupyterlab/apputils';
+import { CodeEditor } from '@jupyterlab/codeeditor';
+import { KernelMessage } from '@jupyterlab/services';
+import { IDisposable } from '@lumino/disposable';
+import { Signal } from '@lumino/signaling';
+
+/**
+ * The definition of a console history manager object.
+ */
+export interface IConsoleHistory extends IDisposable {
+  /**
+   * The session context used by the foreign handler.
+   */
+  readonly sessionContext: ISessionContext | null;
+
+  /**
+   * The current editor used by the history widget.
+   */
+  editor: CodeEditor.IEditor | null;
+
+  /**
+   * The placeholder text that a history session began with.
+   */
+  readonly placeholder: string;
+
+  /**
+   * Get the previous item in the console history.
+   *
+   * @param placeholder - The placeholder string that gets temporarily added
+   * to the history only for the duration of one history session. If multiple
+   * placeholders are sent within a session, only the first one is accepted.
+   *
+   * @returns A Promise for console command text or `undefined` if unavailable.
+   */
+  back(placeholder: string): Promise<string>;
+
+  /**
+   * Get the next item in the console history.
+   *
+   * @param placeholder - The placeholder string that gets temporarily added
+   * to the history only for the duration of one history session. If multiple
+   * placeholders are sent within a session, only the first one is accepted.
+   *
+   * @returns A Promise for console command text or `undefined` if unavailable.
+   */
+  forward(placeholder: string): Promise<string>;
+
+  /**
+   * Add a new item to the bottom of history.
+   *
+   * @param item The item being added to the bottom of history.
+   *
+   * #### Notes
+   * If the item being added is undefined or empty, it is ignored. If the item
+   * being added is the same as the last item in history, it is ignored as well
+   * so that the console's history will consist of no contiguous repetitions.
+   */
+  push(item: string): void;
+
+  /**
+   * Reset the history navigation state, i.e., start a new history session.
+   */
+  reset(): void;
+}
+
+/**
+ * A console history manager object.
+ */
+export class ConsoleHistory implements IConsoleHistory {
+  /**
+   * Construct a new console history object.
+   */
+  constructor(options: ConsoleHistory.IOptions) {
+    const { sessionContext } = options;
+    if (sessionContext) {
+      this.sessionContext = sessionContext;
+      void this._handleKernel();
+      this.sessionContext.kernelChanged.connect(this._handleKernel, this);
+    }
+  }
+
+  /**
+   * The client session used by the foreign handler.
+   */
+  readonly sessionContext: ISessionContext | null;
+
+  /**
+   * The current editor used by the history manager.
+   */
+  get editor(): CodeEditor.IEditor | null {
+    return this._editor;
+  }
+  set editor(value: CodeEditor.IEditor | null) {
+    if (this._editor === value) {
+      return;
+    }
+
+    const prev = this._editor;
+    if (prev) {
+      prev.edgeRequested.disconnect(this.onEdgeRequest, this);
+      prev.model.sharedModel.changed.disconnect(this.onTextChange, this);
+    }
+
+    this._editor = value;
+
+    if (value) {
+      value.edgeRequested.connect(this.onEdgeRequest, this);
+      value.model.sharedModel.changed.connect(this.onTextChange, this);
+    }
+  }
+
+  /**
+   * The placeholder text that a history session began with.
+   */
+  get placeholder(): string {
+    return this._placeholder;
+  }
+
+  /**
+   * Get whether the console history manager is disposed.
+   */
+  get isDisposed(): boolean {
+    return this._isDisposed;
+  }
+
+  /**
+   * Dispose of the resources held by the console history manager.
+   */
+  dispose(): void {
+    this._isDisposed = true;
+    this._history.length = 0;
+    Signal.clearData(this);
+  }
+
+  /**
+   * Get the previous item in the console history.
+   *
+   * @param placeholder - The placeholder string that gets temporarily added
+   * to the history only for the duration of one history session. If multiple
+   * placeholders are sent within a session, only the first one is accepted.
+   *
+   * @returns A Promise for console command text or `undefined` if unavailable.
+   */
+  back(placeholder: string): Promise<string> {
+    if (!this._hasSession) {
+      this._hasSession = true;
+      this._placeholder = placeholder;
+      // Filter the history with the placeholder string.
+      this.setFilter(placeholder);
+      this._cursor = this._filtered.length - 1;
+    }
+
+    --this._cursor;
+    this._cursor = Math.max(0, this._cursor);
+    const content = this._filtered[this._cursor];
+    return Promise.resolve(content);
+  }
+
+  /**
+   * Get the next item in the console history.
+   *
+   * @param placeholder - The placeholder string that gets temporarily added
+   * to the history only for the duration of one history session. If multiple
+   * placeholders are sent within a session, only the first one is accepted.
+   *
+   * @returns A Promise for console command text or `undefined` if unavailable.
+   */
+  forward(placeholder: string): Promise<string> {
+    if (!this._hasSession) {
+      this._hasSession = true;
+      this._placeholder = placeholder;
+      // Filter the history with the placeholder string.
+      this.setFilter(placeholder);
+      this._cursor = this._filtered.length;
+    }
+
+    ++this._cursor;
+    this._cursor = Math.min(this._filtered.length - 1, this._cursor);
+    const content = this._filtered[this._cursor];
+    return Promise.resolve(content);
+  }
+
+  /**
+   * Add a new item to the bottom of history.
+   *
+   * @param item The item being added to the bottom of history.
+   *
+   * #### Notes
+   * If the item being added is undefined or empty, it is ignored. If the item
+   * being added is the same as the last item in history, it is ignored as well
+   * so that the console's history will consist of no contiguous repetitions.
+   */
+  push(item: string): void {
+    if (item && item !== this._history[this._history.length - 1]) {
+      this._history.push(item);
+    }
+    this.reset();
+  }
+
+  /**
+   * Reset the history navigation state, i.e., start a new history session.
+   */
+  reset(): void {
+    this._cursor = this._history.length;
+    this._hasSession = false;
+    this._placeholder = '';
+  }
+
+  /**
+   * Populate the history collection on history reply from a kernel.
+   *
+   * @param value The kernel message history reply.
+   *
+   * #### Notes
+   * History entries have the shape:
+   * [session: number, line: number, input: string]
+   * Contiguous duplicates are stripped out of the API response.
+   */
+  protected onHistory(value: KernelMessage.IHistoryReplyMsg): void {
+    this._history.length = 0;
+    let last = '';
+    let current = '';
+    if (value.content.status === 'ok') {
+      for (let i = 0; i < value.content.history.length; i++) {
+        current = (value.content.history[i] as string[])[2];
+        if (current !== last) {
+          this._history.push((last = current));
+        }
+      }
+    }
+    // Reset the history navigation cursor back to the bottom.
+    this._cursor = this._history.length;
+  }
+
+  /**
+   * Handle a text change signal from the editor.
+   */
+  protected onTextChange(): void {
+    if (this._setByHistory) {
+      this._setByHistory = false;
+      return;
+    }
+    this.reset();
+  }
+
+  /**
+   * Handle an edge requested signal.
+   */
+  protected onEdgeRequest(
+    editor: CodeEditor.IEditor,
+    location: CodeEditor.EdgeLocation
+  ): void {
+    const sharedModel = editor.model.sharedModel;
+    const source = sharedModel.getSource();
+
+    if (location === 'top' || location === 'topLine') {
+      void this.back(source).then(value => {
+        if (this.isDisposed || !value) {
+          return;
+        }
+        if (sharedModel.getSource() === value) {
+          return;
+        }
+        this._setByHistory = true;
+        sharedModel.setSource(value);
+        let columnPos = 0;
+        columnPos = value.indexOf('\n');
+        if (columnPos < 0) {
+          columnPos = value.length;
+        }
+        editor.setCursorPosition({ line: 0, column: columnPos });
+      });
+    } else {
+      void this.forward(source).then(value => {
+        if (this.isDisposed) {
+          return;
+        }
+        const text = value || this.placeholder;
+        if (sharedModel.getSource() === text) {
+          return;
+        }
+        this._setByHistory = true;
+        sharedModel.setSource(text);
+        const pos = editor.getPositionAt(text.length);
+        if (pos) {
+          editor.setCursorPosition(pos);
+        }
+      });
+    }
+  }
+
+  /**
+   * Handle the current kernel changing.
+   */
+  private async _handleKernel(): Promise<void> {
+    const kernel = this.sessionContext?.session?.kernel;
+    if (!kernel) {
+      this._history.length = 0;
+      return;
+    }
+
+    return kernel.requestHistory(Private.initialRequest).then(v => {
+      this.onHistory(v);
+    });
+  }
+
+  /**
+   * Set the filter data.
+   *
+   * @param filterStr - The string to use when filtering the data.
+   */
+  protected setFilter(filterStr: string = ''): void {
+    // Apply the new filter and remove contiguous duplicates.
+    this._filtered.length = 0;
+
+    let last = '';
+    let current = '';
+
+    for (let i = 0; i < this._history.length; i++) {
+      current = this._history[i];
+      if (
+        current !== last &&
+        filterStr === current.slice(0, filterStr.length)
+      ) {
+        this._filtered.push((last = current));
+      }
+    }
+
+    this._filtered.push(filterStr);
+  }
+
+  private _cursor = 0;
+  private _hasSession = false;
+  private _history: string[] = [];
+  private _placeholder: string = '';
+  private _setByHistory = false;
+  private _isDisposed = false;
+  private _editor: CodeEditor.IEditor | null = null;
+  private _filtered: string[] = [];
+}
+
+/**
+ * A namespace for ConsoleHistory statics.
+ */
+export namespace ConsoleHistory {
+  /**
+   * The initialization options for a console history object.
+   */
+  export interface IOptions {
+    /**
+     * The client session used by the foreign handler.
+     */
+    sessionContext?: ISessionContext;
+  }
+}
+
+/**
+ * A namespace for private data.
+ */
+namespace Private {
+  export const initialRequest: KernelMessage.IHistoryRequestMsg['content'] = {
+    output: false,
+    raw: true,
+    hist_access_type: 'tail',
+    n: 500
+  };
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module console
+ */
+
+export * from './foreign';
+export * from './history';
+export * from './panel';
+export * from './tokens';
+export * from './widget';

package/src/panel.ts

@@ -0,0 +1,336 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import {
+  ISessionContext,
+  MainAreaWidget,
+  SessionContext,
+  SessionContextDialogs
+} from '@jupyterlab/apputils';
+import { IEditorMimeTypeService } from '@jupyterlab/codeeditor';
+import { PathExt, Time, URLExt } from '@jupyterlab/coreutils';
+import {
+  IRenderMimeRegistry,
+  RenderMimeRegistry
+} from '@jupyterlab/rendermime';
+import { ServiceManager } from '@jupyterlab/services';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import { consoleIcon } from '@jupyterlab/ui-components';
+import { Token, UUID } from '@lumino/coreutils';
+import { IDisposable } from '@lumino/disposable';
+import { Message } from '@lumino/messaging';
+import { Panel } from '@lumino/widgets';
+import { CodeConsole } from './widget';
+
+/**
+ * The class name added to console panels.
+ */
+const PANEL_CLASS = 'jp-ConsolePanel';
+
+/**
+ * A panel which contains a console and the ability to add other children.
+ */
+export class ConsolePanel extends MainAreaWidget<Panel> {
+  /**
+   * Construct a console panel.
+   */
+  constructor(options: ConsolePanel.IOptions) {
+    super({ content: new Panel() });
+    this.addClass(PANEL_CLASS);
+    let {
+      rendermime,
+      mimeTypeService,
+      path,
+      basePath,
+      name,
+      manager,
+      modelFactory,
+      sessionContext,
+      translator
+    } = options;
+    this.translator = translator ?? nullTranslator;
+    const trans = this.translator.load('jupyterlab');
+
+    const contentFactory = (this.contentFactory = options.contentFactory);
+    const count = Private.count++;
+    if (!path) {
+      path = URLExt.join(basePath || '', `console-${count}-${UUID.uuid4()}`);
+    }
+
+    sessionContext = this._sessionContext =
+      sessionContext ??
+      new SessionContext({
+        sessionManager: manager.sessions,
+        specsManager: manager.kernelspecs,
+        path,
+        name: name || trans.__('Console %1', count),
+        type: 'console',
+        kernelPreference: options.kernelPreference,
+        setBusy: options.setBusy
+      });
+
+    const resolver = new RenderMimeRegistry.UrlResolver({
+      path,
+      contents: manager.contents
+    });
+    rendermime = rendermime.clone({ resolver });
+
+    this.console = contentFactory.createConsole({
+      rendermime,
+      sessionContext: sessionContext,
+      mimeTypeService,
+      contentFactory,
+      modelFactory,
+      translator
+    });
+    this.content.addWidget(this.console);
+
+    void sessionContext.initialize().then(async value => {
+      if (value) {
+        await (
+          options.sessionDialogs ?? new SessionContextDialogs({ translator })
+        ).selectKernel(sessionContext!);
+      }
+      this._connected = new Date();
+      this._updateTitlePanel();
+    });
+
+    this.console.executed.connect(this._onExecuted, this);
+    this._updateTitlePanel();
+    sessionContext.kernelChanged.connect(this._updateTitlePanel, this);
+    sessionContext.propertyChanged.connect(this._updateTitlePanel, this);
+
+    this.title.icon = consoleIcon;
+    this.title.closable = true;
+    this.id = `console-${count}`;
+  }
+
+  /**
+   * The content factory used by the console panel.
+   */
+  readonly contentFactory: ConsolePanel.IContentFactory;
+
+  /**
+   * The console widget used by the panel.
+   */
+  console: CodeConsole;
+
+  /**
+   * The session used by the panel.
+   */
+  get sessionContext(): ISessionContext {
+    return this._sessionContext;
+  }
+
+  /**
+   * Dispose of the resources held by the widget.
+   */
+  dispose(): void {
+    this.sessionContext.dispose();
+    this.console.dispose();
+    super.dispose();
+  }
+
+  /**
+   * Handle `'activate-request'` messages.
+   */
+  protected onActivateRequest(msg: Message): void {
+    const prompt = this.console.promptCell;
+    if (prompt) {
+      prompt.editor!.focus();
+    }
+  }
+
+  /**
+   * Handle `'close-request'` messages.
+   */
+  protected onCloseRequest(msg: Message): void {
+    super.onCloseRequest(msg);
+    this.dispose();
+  }
+
+  /**
+   * Handle a console execution.
+   */
+  private _onExecuted(sender: CodeConsole, args: Date) {
+    this._executed = args;
+    this._updateTitlePanel();
+  }
+
+  /**
+   * Update the console panel title.
+   */
+  private _updateTitlePanel(): void {
+    Private.updateTitle(this, this._connected, this._executed, this.translator);
+  }
+
+  translator: ITranslator;
+  private _executed: Date | null = null;
+  private _connected: Date | null = null;
+  private _sessionContext: ISessionContext;
+}
+
+/**
+ * A namespace for ConsolePanel statics.
+ */
+export namespace ConsolePanel {
+  /**
+   * The initialization options for a console panel.
+   */
+  export interface IOptions {
+    /**
+     * The rendermime instance used by the panel.
+     */
+    rendermime: IRenderMimeRegistry;
+
+    /**
+     * The content factory for the panel.
+     */
+    contentFactory: IContentFactory;
+
+    /**
+     * The service manager used by the panel.
+     */
+    manager: ServiceManager.IManager;
+
+    /**
+     * The path of an existing console.
+     */
+    path?: string;
+
+    /**
+     * The base path for a new console.
+     */
+    basePath?: string;
+
+    /**
+     * The name of the console.
+     */
+    name?: string;
+
+    /**
+     * A kernel preference.
+     */
+    kernelPreference?: ISessionContext.IKernelPreference;
+
+    /**
+     * An existing session context to use.
+     */
+    sessionContext?: ISessionContext;
+
+    /**
+     * Session dialogs to use.
+     */
+    sessionDialogs?: ISessionContext.IDialogs;
+
+    /**
+     * The model factory for the console widget.
+     */
+    modelFactory?: CodeConsole.IModelFactory;
+
+    /**
+     * The service used to look up mime types.
+     */
+    mimeTypeService: IEditorMimeTypeService;
+
+    /**
+     * The application language translator.
+     */
+    translator?: ITranslator;
+
+    /**
+     * A function to call when the kernel is busy.
+     */
+    setBusy?: () => IDisposable;
+  }
+
+  /**
+   * The console panel renderer.
+   */
+  export interface IContentFactory extends CodeConsole.IContentFactory {
+    /**
+     * Create a new console panel.
+     */
+    createConsole(options: CodeConsole.IOptions): CodeConsole;
+  }
+
+  /**
+   * Default implementation of `IContentFactory`.
+   */
+  export class ContentFactory
+    extends CodeConsole.ContentFactory
+    implements IContentFactory
+  {
+    /**
+     * Create a new console panel.
+     */
+    createConsole(options: CodeConsole.IOptions): CodeConsole {
+      return new CodeConsole(options);
+    }
+  }
+
+  /**
+   * A namespace for the console panel content factory.
+   */
+  export namespace ContentFactory {
+    /**
+     * Options for the code console content factory.
+     */
+    export interface IOptions extends CodeConsole.ContentFactory.IOptions {}
+  }
+
+  /**
+   * The console renderer token.
+   */
+  export const IContentFactory = new Token<IContentFactory>(
+    '@jupyterlab/console:IContentFactory'
+  );
+}
+
+/**
+ * A namespace for private data.
+ */
+namespace Private {
+  /**
+   * The counter for new consoles.
+   */
+  export let count = 1;
+
+  /**
+   * Update the title of a console panel.
+   */
+  export function updateTitle(
+    panel: ConsolePanel,
+    connected: Date | null,
+    executed: Date | null,
+    translator?: ITranslator
+  ): void {
+    translator = translator || nullTranslator;
+    const trans = translator.load('jupyterlab');
+
+    const sessionContext = panel.console.sessionContext.session;
+    if (sessionContext) {
+      // FIXME:
+      let caption =
+        trans.__('Name: %1\n', sessionContext.name) +
+        trans.__('Directory: %1\n', PathExt.dirname(sessionContext.path)) +
+        trans.__('Kernel: %1', panel.console.sessionContext.kernelDisplayName);
+
+      if (connected) {
+        caption += trans.__(
+          '\nConnected: %1',
+          Time.format(connected.toISOString())
+        );
+      }
+
+      if (executed) {
+        caption += trans.__('\nLast Execution: %1');
+      }
+      panel.title.label = sessionContext.name;
+      panel.title.caption = caption;
+    } else {
+      panel.title.label = trans.__('Console');
+      panel.title.caption = '';
+    }
+  }
+}