Merge pull request #6704 from JohanMabille/debug

Added debug messages
jupyterlab · Jul 31, 2019 · 97bc2ca · 97bc2ca
2 parents 75166c6 + 1f20115
commit 97bc2ca
Show file tree

Hide file tree

Showing 3 changed files with 223 additions and 3 deletions.
diff --git a/packages/services/src/kernel/default.ts b/packages/services/src/kernel/default.ts
@@ -602,6 +602,40 @@ export class DefaultKernel implements Kernel.IKernel {
     >;
   }
 
+  /**
+   * Send an experimental `debug_request` message.
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this function is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  requestDebug(
+    content: KernelMessage.IDebugRequestMsg['content'],
+    disposeOnDone: boolean = true
+  ): Kernel.IControlFuture<
+    KernelMessage.IDebugRequestMsg,
+    KernelMessage.IDebugReplyMsg
+  > {
+    let msg = KernelMessage.createMessage({
+      msgType: 'debug_request',
+      channel: 'control',
+      username: this._username,
+      session: this._clientId,
+      content
+    });
+    return this.sendControlMessage(
+      msg,
+      true,
+      disposeOnDone
+    ) as Kernel.IControlFuture<
+      KernelMessage.IDebugRequestMsg,
+      KernelMessage.IDebugReplyMsg
+    >;
+  }
+
   /**
    * Send an `is_complete_request` message.
    *

diff --git a/packages/services/src/kernel/kernel.ts b/packages/services/src/kernel/kernel.ts
@@ -278,6 +278,30 @@ export namespace Kernel {
       KernelMessage.IExecuteReplyMsg
     >;
 
+    /**
+     * Send an experimental `debug_request` message.
+     *
+     * @hidden
+     *
+     * @param content - The content of the request.
+     *
+     * @param disposeOnDone - Whether to dispose of the future when done.
+     *
+     * @returns A kernel future.
+     *
+     * #### Notes
+     * Debug messages are experimental messages that are not in the official
+     * kernel message specification. As such, this function is *NOT* considered
+     * part of the public API, and may change without notice.
+     */
+    requestDebug(
+      content: KernelMessage.IDebugRequestMsg['content'],
+      disposeOnDone?: boolean
+    ): Kernel.IControlFuture<
+      KernelMessage.IDebugRequestMsg,
+      KernelMessage.IDebugReplyMsg
+    >;
+
     /**
      * Send an `is_complete_request` message.
      *

diff --git a/packages/services/src/kernel/messages.ts b/packages/services/src/kernel/messages.ts
@@ -109,6 +109,39 @@ export namespace KernelMessage {
     options: IOptions<T>
   ): T;
 
+  /**
+   * @hidden
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this function is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export function createMessage<T extends IDebugRequestMsg>(
+    options: IOptions<T>
+  ): T;
+
+  /**
+   * @hidden
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this function is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export function createMessage<T extends IDebugReplyMsg>(
+    options: IOptions<T>
+  ): T;
+
+  /**
+   * @hidden
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this function is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export function createMessage<T extends IDebugEventMsg>(
+    options: IOptions<T>
+  ): T;
+
   export function createMessage<T extends Message>(options: IOptions<T>): T {
     return {
       buffers: options.buffers || [],
@@ -155,11 +188,21 @@ export namespace KernelMessage {
 
   /**
    * Control message types.
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, debug message types are *NOT*
+   * considered part of the public API, and may change without notice.
    */
-  export type ControlMessageType = never;
+  export type ControlMessageType = 'debug_request' | 'debug_reply';
 
   /**
    * IOPub message types.
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, debug message types are *NOT*
+   * considered part of the public API, and may change without notice.
    */
   export type IOPubMessageType =
     | 'clear_output'
@@ -172,7 +215,8 @@ export namespace KernelMessage {
     | 'execute_result'
     | 'status'
     | 'stream'
-    | 'update_display_data';
+    | 'update_display_data'
+    | 'debug_event';
 
   /**
    * Stdin message types.
@@ -310,6 +354,14 @@ export namespace KernelMessage {
     channel: 'stdin';
   }
 
+  /**
+   * Message types.
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, debug message types are *NOT*
+   * considered part of the public API, and may change without notice.
+   */
   export type Message =
     | IClearOutputMsg
     | ICommCloseMsg<'iopub'>
@@ -340,7 +392,10 @@ export namespace KernelMessage {
     | IIsCompleteRequestMsg
     | IStatusMsg
     | IStreamMsg
-    | IUpdateDisplayDataMsg;
+    | IUpdateDisplayDataMsg
+    | IDebugRequestMsg
+    | IDebugReplyMsg
+    | IDebugEventMsg;
 
   //////////////////////////////////////////////////
   // IOPub Messages
@@ -503,6 +558,40 @@ export namespace KernelMessage {
     return msg.header.msg_type === 'clear_output';
   }
 
+  /**
+   * An experimental `'debug_event'` message on the `'iopub'` channel
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export interface IDebugEventMsg extends IIOPubMessage<'debug_event'> {
+    content: {
+      seq: number;
+      type: 'event';
+      event: string;
+      body?: any;
+    };
+  }
+
+  /**
+   * Test whether a kernel message is an experimental `'debug_event'` message.
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+
+  export function isDebugEventMsg(msg: IMessage): msg is IDebugEventMsg {
+    return msg.header.msg_type === 'debug_event';
+  }
+
   //////////////////////////////////////////////////
   // Comm Messages
   /////////////////////////////////////////////////
@@ -1022,6 +1111,79 @@ export namespace KernelMessage {
     content: ReplyContent<ICommInfoReply>;
   }
 
+  /////////////////////////////////////////////////
+  // Control Messages
+  /////////////////////////////////////////////////
+
+  /**
+   * An experimental `'debug_request'` messsage on the `'control'` channel.
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this function is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export interface IDebugRequestMsg extends IControlMessage<'debug_request'> {
+    content: {
+      seq: number;
+      type: 'request';
+      command: string;
+      arguments?: any;
+    };
+  }
+
+  /**
+   * Test whether a kernel message is an experimental `'debug_request'` message.
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export function isDebugRequestMsg(msg: IMessage): msg is IDebugRequestMsg {
+    return msg.header.msg_type === 'debug_request';
+  }
+
+  /**
+   * An experimental `'debug_reply'` messsage on the `'control'` channel.
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export interface IDebugReplyMsg extends IControlMessage<'debug_reply'> {
+    content: {
+      seq: number;
+      type: 'response';
+      request_seq: number;
+      success: boolean;
+      command: string;
+      message?: string;
+      body?: any;
+    };
+  }
+
+  /**
+   * Test whether a kernel message is an experimental `'debug_reply'` message.
+   *
+   * @hidden
+   *
+   * #### Notes
+   * Debug messages are experimental messages that are not in the official
+   * kernel message specification. As such, this is *NOT* considered
+   * part of the public API, and may change without notice.
+   */
+  export function isDebugReplyMsg(msg: IMessage): msg is IDebugReplyMsg {
+    return msg.header.msg_type === 'debug_reply';
+  }
+
   //////////////////////////////////////////////////
   // Stdin Messages
   /////////////////////////////////////////////////