Allows the child debug adapter to override some variable handling logic.

changsi-an · Feb 5, 2018 · 8b85328 · 8b85328
1 parent a4118f6
commit 8b85328
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 9 deletions.
diff --git a/src/chrome/chromeDebugAdapter.ts b/src/chrome/chromeDebugAdapter.ts
@@ -14,7 +14,7 @@ import {IChromeDebugAdapterOpts, ChromeDebugSession} from './chromeDebugSession'
 import {ChromeConnection} from './chromeConnection';
 import * as ChromeUtils from './chromeUtils';
 import Crdp from '../../crdp/crdp';
-import {PropertyContainer, ScopeContainer, ExceptionContainer, isIndexedPropName} from './variables';
+import {PropertyContainer, ScopeContainer, ExceptionContainer, isIndexedPropName, IVariableContainer} from './variables';
 import * as variables from './variables';
 import {formatConsoleArguments, formatExceptionDetails} from './consoleHelper';
 import {StoppedEvent2, ReasonType} from './stoppedEvent';
@@ -74,6 +74,10 @@ export type CrdpDomain = keyof Crdp.CrdpClient;
 
 export type LoadedSourceEventReason = 'new' | 'changed' | 'removed';
 
+export interface ExtendedDebugProtocolVariable extends DebugProtocol.Variable {
+    msVariableMetadata?: string;
+}
+
 export abstract class ChromeDebugAdapter implements IDebugAdapter {
     public static EVAL_NAME_PREFIX = ChromeUtils.EVAL_NAME_PREFIX;
     public static EVAL_ROOT = '<eval>';
@@ -1790,7 +1794,7 @@ export abstract class ChromeDebugAdapter implements IDebugAdapter {
             });
     }
 
-    public propertyDescriptorToVariable(propDesc: Crdp.Runtime.PropertyDescriptor, owningObjectId?: string, parentEvaluateName?: string): Promise<DebugProtocol.Variable> {
+    public propertyDescriptorToVariable(propDesc: Crdp.Runtime.PropertyDescriptor, owningObjectId?: string, parentEvaluateName?: string): Promise<ExtendedDebugProtocolVariable> {
         if (propDesc.get) {
             // Getter
             const grabGetterValue = 'function remoteFunction(propName) { return this[propName]; }';
@@ -1821,7 +1825,7 @@ export abstract class ChromeDebugAdapter implements IDebugAdapter {
         }
     }
 
-    public getVariablesForObjectId(objectId: string, evaluateName?: string, filter?: string, start?: number, count?: number): Promise<DebugProtocol.Variable[]> {
+    public getVariablesForObjectId(objectId: string, evaluateName?: string, filter?: string, start?: number, count?: number): Promise<ExtendedDebugProtocolVariable[]> {
         if (typeof start === 'number' && typeof count === 'number') {
             return this.getFilteredVariablesForObject(objectId, evaluateName, filter, start, count);
         }
@@ -2166,7 +2170,7 @@ export abstract class ChromeDebugAdapter implements IDebugAdapter {
         error => Promise.reject<string>(errors.errorFromEvaluate(error.message)));
     }
 
-    public remoteObjectToVariable(name: string, object: Crdp.Runtime.RemoteObject, parentEvaluateName?: string, stringify = true, context: VariableContext = 'variables'): Promise<DebugProtocol.Variable> {
+    public remoteObjectToVariable(name: string, object: Crdp.Runtime.RemoteObject, parentEvaluateName?: string, stringify = true, context: VariableContext = 'variables'): Promise<ExtendedDebugProtocolVariable> {
         name = name || '""';
 
         if (object) {
@@ -2236,7 +2240,7 @@ export abstract class ChromeDebugAdapter implements IDebugAdapter {
         }
 
         const evaluateName = ChromeUtils.getEvaluateName(parentEvaluateName, name);
-        const variablesReference = this._variableHandles.create(new PropertyContainer(object.objectId, evaluateName), context);
+        const variablesReference = this._variableHandles.create(this.createPropertyContainer(object, evaluateName), context);
         return propCountP.then(({ indexedVariables, namedVariables }) => (<DebugProtocol.Variable>{
             name,
             value,
@@ -2248,7 +2252,11 @@ export abstract class ChromeDebugAdapter implements IDebugAdapter {
         }));
     }
 
-    public createPrimitiveVariable(name: string, object: Crdp.Runtime.RemoteObject, parentEvaluateName?: string, stringify?: boolean): DebugProtocol.Variable {
+    protected createPropertyContainer(object: Crdp.Runtime.RemoteObject, evaluateName: string): IVariableContainer {
+        return new PropertyContainer(object.objectId, evaluateName);
+    }
+
+    public createPrimitiveVariable(name: string, object: Crdp.Runtime.RemoteObject, parentEvaluateName?: string, stringify?: boolean): ExtendedDebugProtocolVariable {
         const value = variables.getRemoteObjectPreview_primitive(object, stringify);
         const variable = this.createPrimitiveVariableWithValue(name, value, parentEvaluateName);
         variable.type = object.type;

diff --git a/src/chrome/variables.ts b/src/chrome/variables.ts
@@ -5,7 +5,7 @@
 import {DebugProtocol} from 'vscode-debugprotocol';
 import {Handles} from 'vscode-debugadapter';
 
-import {ChromeDebugAdapter, VariableContext} from './chromeDebugAdapter';
+import {ChromeDebugAdapter, VariableContext, ExtendedDebugProtocolVariable} from './chromeDebugAdapter';
 import Crdp from '../../crdp/crdp';
 import * as utils from '../utils';
 
@@ -18,7 +18,7 @@ export abstract class BaseVariableContainer implements IVariableContainer {
     constructor(protected objectId: string, protected evaluateName?: string) {
     }
 
-    public expand(adapter: ChromeDebugAdapter, filter?: string, start?: number, count?: number): Promise<DebugProtocol.Variable[]> {
+    public expand(adapter: ChromeDebugAdapter, filter?: string, start?: number, count?: number): Promise<ExtendedDebugProtocolVariable[]> {
         return adapter.getVariablesForObjectId(this.objectId, this.evaluateName, filter, start, count);
     }
 

diff --git a/src/index.ts b/src/index.ts
@@ -6,7 +6,7 @@
 import {logger} from 'vscode-debugadapter';
 
 import * as chromeConnection from './chrome/chromeConnection';
-import {ChromeDebugAdapter, LoadedSourceEventReason} from './chrome/chromeDebugAdapter';
+import {ChromeDebugAdapter, LoadedSourceEventReason, ExtendedDebugProtocolVariable} from './chrome/chromeDebugAdapter';
 import {ChromeDebugSession, IChromeDebugSessionOpts} from './chrome/chromeDebugSession';
 import * as chromeTargetDiscoveryStrategy from './chrome/chromeTargetDiscoveryStrategy';
 import * as chromeUtils from './chrome/chromeUtils';
@@ -21,6 +21,7 @@ export * from './debugAdapterInterfaces';
 
 import * as utils from './utils';
 import * as telemetry from './telemetry';
+import * as variables from './chrome/variables';
 import {NullLogger} from './nullLogger';
 
 import Crdp from '../crdp/crdp';
@@ -35,6 +36,7 @@ export {
     logger,
     stoppedEvent,
     LoadedSourceEventReason,
+    ExtendedDebugProtocolVariable,
 
     UrlPathTransformer,
     BasePathTransformer,
@@ -43,6 +45,7 @@ export {
 
     utils,
     telemetry,
+    variables,
     NullLogger,
 
     Crdp