@adminide-stack/extension-api 0.0.2-alpha.0

package/lib/protocol/rpc-logger.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RPCLogger = void 0;
+// Enable to see detailed message communication between window and extension host
+const LOG_EXTENSION_HOST_COMMUNICATION = false;
+const LOG_USE_COLORS = true;
+const colorTables = [
+    ['#2977B1', '#FC802D', '#34A13A', '#D3282F', '#9366BA'],
+    ['#8B564C', '#E177C0', '#7F7F7F', '#BBBE3D', '#2EBECD'],
+];
+function prettyWithoutArrays(data) {
+    if (Array.isArray(data)) {
+        return data;
+    }
+    if (data && typeof data === 'object' && typeof data.toString === 'function') {
+        let result = data.toString();
+        if (result !== '[object Object]') {
+            return result;
+        }
+    }
+    return data;
+}
+function pretty(data) {
+    if (Array.isArray(data)) {
+        return data.map(prettyWithoutArrays);
+    }
+    return prettyWithoutArrays(data);
+}
+class RPCLogger {
+    constructor() {
+        this._totalIncoming = 0;
+        this._totalOutgoing = 0;
+    }
+    _log(direction, totalLength, msgLength, req, initiator, str, data) {
+        data = pretty(data);
+        const colorTable = colorTables[initiator];
+        const color = LOG_USE_COLORS ? colorTable[req % colorTable.length] : '#000000';
+        /* tslint:disable-next-line:max-line-length */
+        let args = [`%c[${direction}]%c[${String(totalLength).padStart(7)}]%c[len: ${String(msgLength).padStart(5)}]%c${String(req).padStart(5)} - ${str}`, 'color: darkgreen', 'color: grey', 'color: grey', `color: ${color}`];
+        if (/\($/.test(str)) {
+            args = args.concat(data);
+            args.push(')');
+        }
+        else {
+            args.push(data);
+        }
+        /* tslint:disable-next-line:no-console */
+        console.log.apply(console, args);
+    }
+    logIncoming(msgLength, req, initiator, str, data) {
+        this._totalIncoming += msgLength;
+        this._log('Ext \u2192 Win', this._totalIncoming, msgLength, req, initiator, str, data);
+    }
+    logOutgoing(msgLength, req, initiator, str, data) {
+        this._totalOutgoing += msgLength;
+        this._log('Win \u2192 Ext', this._totalOutgoing, msgLength, req, initiator, str, data);
+    }
+}
+exports.RPCLogger = RPCLogger;
+//# sourceMappingURL=rpc-logger.js.map

package/lib/protocol/rpc-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-logger.js","sourceRoot":"","sources":["../../src/protocol/rpc-logger.ts"],"names":[],"mappings":";;;AAGA,iFAAiF;AACjF,MAAM,gCAAgC,GAAG,KAAK,CAAC;AAC/C,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B,MAAM,WAAW,GAAG;IAChB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;IACvD,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;CAC1D,CAAC;AAGF,SAAS,mBAAmB,CAAC,IAAS;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC;KACf;IACD,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,UAAU,EAAE;QACzE,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,MAAM,KAAK,iBAAiB,EAAE;YAC9B,OAAO,MAAM,CAAC;SACjB;KACJ;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,MAAM,CAAC,IAAS;IACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;KACxC;IACD,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,MAAa,SAAS;IAAtB;QAEY,mBAAc,GAAG,CAAC,CAAC;QACnB,mBAAc,GAAG,CAAC,CAAC;IA4B/B,CAAC;IA1BW,IAAI,CAAC,SAAiB,EAAE,WAAW,EAAE,SAAiB,EAAE,GAAW,EAAE,SAA2B,EAAE,GAAW,EAAE,IAAS;QAC5H,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAEpB,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,8CAA8C;QACpD,IAAI,IAAI,GAAG,CAAC,MAAM,SAAS,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC;QACnN,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACjB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;aAAM;YACH,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACnB;QACD,yCAAyC;QACzC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,IAA6B,CAAC,CAAC;IAC9D,CAAC;IAEM,WAAW,CAAC,SAAiB,EAAE,GAAW,EAAE,SAA2B,EAAE,GAAW,EAAE,IAAU;QACnG,IAAI,CAAC,cAAc,IAAI,SAAS,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAEM,WAAW,CAAC,SAAiB,EAAE,GAAW,EAAE,SAA2B,EAAE,GAAW,EAAE,IAAU;QACnG,IAAI,CAAC,cAAc,IAAI,SAAS,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;CACJ;AA/BD,8BA+BC"}

package/lib/protocol/rpc-protocol.d.ts

@@ -0,0 +1,148 @@
+/// <reference types="node" />
+import { Event } from '@vscode-alt/monaco-editor/esm/vs/base/common/event';
+import { Disposable } from '@vscode-alt/monaco-editor/esm/vs/base/common/lifecycle';
+import { IURITransformer } from '@vscode-alt/monaco-editor/esm/vs/base/common/uriIpc';
+import { IRPCProtocol, ProxyIdentifier, HostIdentifier } from './proxy-identifier';
+import { VSBuffer } from '@vscode-alt/monaco-editor/esm/vs/base/common/buffer';
+export interface JSONStringifyReplacer {
+    (key: string, value: any): any;
+}
+export declare function safeStringify(obj: any, replacer: JSONStringifyReplacer | null): string;
+export declare const enum RequestInitiator {
+    LocalSide = 0,
+    OtherSide = 1
+}
+export declare const enum ResponsiveState {
+    Responsive = 0,
+    Unresponsive = 1
+}
+export interface IRPCProtocolLogger {
+    logIncoming(msgLength: number, req: number, initiator: RequestInitiator, str: string, data?: any): void;
+    logOutgoing(msgLength: number, req: number, initiator: RequestInitiator, str: string, data?: any): void;
+}
+/**
+ * @sri
+ * Using custom protocol to provide forward functionality.
+ */
+export declare type IRPCMessagePassingProtocol = {
+    onMessage: Event<VSBuffer>;
+    send(buffer: VSBuffer, hostId: HostIdentifier): void;
+    forward?(buffer: VSBuffer, hostId: HostIdentifier): void;
+};
+export declare class RPCProtocol extends Disposable implements IRPCProtocol {
+    private static UNRESPONSIVE_TIME;
+    private readonly _onDidChangeResponsiveState;
+    readonly onDidChangeResponsiveState: Event<ResponsiveState>;
+    private readonly _protocol;
+    private readonly _logger;
+    private readonly _uriTransformer;
+    private readonly _uriReplacer;
+    private _isDisposed;
+    private readonly _locals;
+    private readonly _proxies;
+    private _lastMessageId;
+    private readonly _cancelInvokedHandlers;
+    private readonly _pendingRPCReplies;
+    private _responsiveState;
+    private _unacknowledgedCount;
+    private _unresponsiveTime;
+    private _asyncCheckUresponsive;
+    private localHostId;
+    constructor(protocol: IRPCMessagePassingProtocol, _localHostId?: HostIdentifier | null, logger?: IRPCProtocolLogger | null, transformer?: IURITransformer | null);
+    dispose(): void;
+    private _onWillSendRequest;
+    private _onDidReceiveAcknowledge;
+    private _checkUnresponsive;
+    private _setResponsiveState;
+    get responsiveState(): ResponsiveState;
+    transformIncomingURIs<T>(obj: T): T;
+    getProxy<T>(identifier: ProxyIdentifier<T>): T;
+    private _createProxy;
+    set<T, R extends T>(identifier: ProxyIdentifier<T>, value: R): R;
+    assertRegistered(identifiers: ProxyIdentifier<any>[]): void;
+    private _receiveOneMessage;
+    private _receiveRequest;
+    private _receiveCancel;
+    private _receiveReply;
+    private _receiveReplyErr;
+    private _invokeHandler;
+    private _doInvokeHandler;
+    private _remoteCall;
+}
+export declare class MessageBuffer {
+    static alloc(type: MessageType, req: number, messageSize: number): MessageBuffer;
+    static read(buff: VSBuffer, offset: number): MessageBuffer;
+    private _buff;
+    private _offset;
+    get buffer(): VSBuffer;
+    private constructor();
+    static sizeUInt8(): number;
+    writeUInt8(n: number): void;
+    readUInt8(): number;
+    writeUInt32(n: number): void;
+    readUInt32(): number;
+    static sizeShortString(str: VSBuffer): number;
+    writeShortString(str: VSBuffer): void;
+    readShortString(): string;
+    static sizeLongString(str: VSBuffer): number;
+    writeLongString(str: VSBuffer): void;
+    readLongString(): string;
+    static sizeBuffer(buff: VSBuffer): number;
+    writeBuffer(buff: VSBuffer): void;
+    readBuffer(): Buffer;
+    static sizeVSBuffer(buff: VSBuffer): number;
+    writeVSBuffer(buff: VSBuffer): void;
+    readVSBuffer(): VSBuffer;
+    static sizeMixedArray(arr: VSBuffer[], arrType: ArgType[]): number;
+    writeMixedArray(arr: VSBuffer[], arrType: ArgType[]): void;
+    readMixedArray(): Array<string | Buffer | VSBuffer>;
+}
+export declare class MessageIO {
+    private static _arrayContainsBuffer;
+    static serializeRequest(req: number, rpcId: number, method: string, args: any[], usesCancellationToken: boolean, replacer: JSONStringifyReplacer | null): VSBuffer;
+    private static _requestJSONArgs;
+    static deserializeRequestJSONArgs(buff: MessageBuffer): {
+        rpcId: number;
+        method: string;
+        args: any[];
+    };
+    private static _requestMixedArgs;
+    static deserializeRequestMixedArgs(buff: MessageBuffer): {
+        rpcId: number;
+        method: string;
+        args: any[];
+    };
+    static serializeAcknowledged(req: number): VSBuffer;
+    static serializeCancel(req: number): VSBuffer;
+    static serializeReplyOK(req: number, res: any, replacer: JSONStringifyReplacer | null): VSBuffer;
+    private static _serializeReplyOKEmpty;
+    private static _serializeReplyOKBuffer;
+    private static _serializeReplyOKVSBuffer;
+    static deserializeReplyOKBuffer(buff: MessageBuffer): Buffer;
+    static deserializeReplyOKVSBuffer(buff: MessageBuffer): VSBuffer;
+    private static _serializeReplyOKJSON;
+    static deserializeReplyOKJSON(buff: MessageBuffer): any;
+    static serializeReplyErr(req: number, err: any): VSBuffer;
+    private static _serializeReplyErrEror;
+    static deserializeReplyErrError(buff: MessageBuffer): Error;
+    private static _serializeReplyErrEmpty;
+}
+export declare const enum MessageType {
+    RequestJSONArgs = 1,
+    RequestJSONArgsWithCancellation = 2,
+    RequestMixedArgs = 3,
+    RequestMixedArgsWithCancellation = 4,
+    Acknowledged = 5,
+    Cancel = 6,
+    ReplyOKEmpty = 7,
+    ReplyOKBuffer = 8,
+    ReplyOKVSBuffer = 8,
+    ReplyOKJSON = 9,
+    ReplyErrError = 10,
+    ReplyErrEmpty = 11
+}
+export declare const enum ArgType {
+    String = 1,
+    Buffer = 2,
+    VSBuffer = 3
+}