Display list of non-deleted WebGL objects

package.json

@@ -45,7 +45,7 @@
     "sass-loader": "^8.0.2",
     "style-loader": "^1.1.3",
     "tslint": "^6.1.3",
-    "typescript": "^3.8.3",
+    "typescript": "^4.2.4",
     "webpack": "^4.42.0",
     "webpack-cli": "^3.3.11"
   }

src/backend/recorders/baseRecorder.ts

@@ -4,6 +4,7 @@ import { WebGlConstants, WebGlConstantsByValue } from "../types/webglConstants";
 import { FunctionCallbacks, IFunctionInformation } from "../types/functionInformation";
 import { ICapture } from "../../shared/capture/capture";
 import { WebGlObjects } from "../webGlObjects/baseWebGlObject";
+import {StackTrace} from "../../shared/utils/stackTrace";
 
 export interface IRecorder {
     registerCallbacks(onFunctionCallbacks: FunctionCallbacks): void;
@@ -85,6 +86,8 @@ export abstract class BaseRecorder<T extends WebGLObject> implements IRecorder {
     protected readonly startTime: number;
     protected readonly memoryPerSecond: { [second: number]: number };
 
+    private objects: { [id: number]: WeakRef<WebGLObject> };
+
     private totalMemory: number;
     private frameMemory: number;
     private capturing: boolean;
@@ -131,6 +134,22 @@ export abstract class BaseRecorder<T extends WebGLObject> implements IRecorder {
     public appendRecordedInformation(capture: ICapture): void {
         capture.frameMemory[this.objectName] = this.frameMemory;
         capture.memory[this.objectName] = this.memoryPerSecond;
+        capture.objects[this.objectName] = {};
+        for (const id in this.objects) {
+            if (this.objects.hasOwnProperty(id)) {
+                const object = this.objects[id].deref();
+                if (object) {
+                    const source = WebGlObjects.getWebGlObjectSource(object);
+                    if (source) {
+                        capture.objects[this.objectName][id] = source;
+                    } else {
+                        console.log("Object without source");
+                    }
+                } else {
+                    console.log("Object which was already free'd");
+                }
+            }
+        }
     }
 
     protected abstract getCreateCommandNames(): string[];
@@ -141,7 +160,19 @@ export abstract class BaseRecorder<T extends WebGLObject> implements IRecorder {
     protected abstract delete(instance: T): number;
 
     protected create(functionInformation: IFunctionInformation): void {
-        // Nothing tracked currently on create.
+        // Removes the spector internal calls to leave only the relevant part.
+        const stackTrace = StackTrace.getStackTrace(5, 0);
+
+        const createdWebGlObject = functionInformation.result as T;
+
+        // Add information where this object was created
+        WebGlObjects.attachWebGlObjectSource(createdWebGlObject, stackTrace);
+
+        // Add our object to the list of tracked objects (object should only exist once).
+        const tag = WebGlObjects.getWebGlObjectTag(createdWebGlObject);
+        this.objects = this.objects || [];
+        if (this.objects[tag.id]) { debugger; }
+        this.objects[tag.id] = new WeakRef(createdWebGlObject);
     }
 
     protected createWithoutSideEffects(functionInformation: IFunctionInformation): void {
@@ -186,6 +217,16 @@ export abstract class BaseRecorder<T extends WebGLObject> implements IRecorder {
         }
 
         this.options.toggleCapture(false);
+
+        const tag = WebGlObjects.getWebGlObjectTag(instance);
+        if (!tag) {
+            this.options.toggleCapture(true);
+            return;
+        }
+
+        // Remove object from list of objects
+        delete this.objects[tag.id];
+
         const size = this.delete(instance);
         this.changeMemorySize(-size);
         this.options.toggleCapture(true);

src/backend/spies/contextSpy.ts

@@ -125,6 +125,7 @@ export class ContextSpy {
             analyses: [],
             frameMemory: {},
             memory: {},
+            objects: {},
         };
 
         // Refreshes canvas info in case it changed beffore the capture.

src/backend/states/baseState.ts

@@ -263,6 +263,7 @@ export abstract class BaseState {
 
         return {
             __SPECTOR_Object_TAG: WebGlObjects.getWebGlObjectTag(object) || this.options.tagWebGlObject(object),
+            __SPECTOR_Object_Source: WebGlObjects.getWebGlObjectSource(object),
             __SPECTOR_Object_CustomData: object.__SPECTOR_Object_CustomData,
             __SPECTOR_Metadata: object.__SPECTOR_Metadata,
         };

src/backend/webGlObjects/baseWebGlObject.ts

@@ -5,6 +5,8 @@ export type WebGlObjectTag = {
     customData?: any;
 };
 
+export type WebGlObjectSource = string[];
+
 export class WebGlObjects {
     public static getWebGlObjectTag(object: WebGLObject): WebGlObjectTag {
         return (object as any)[WebGlObjects.SPECTOROBJECTTAGKEY];
@@ -22,7 +24,16 @@ export class WebGlObjects {
         return `${tag.typeName} - ID: ${tag.id}`;
     }
 
+    public static getWebGlObjectSource(object: WebGLObject): WebGlObjectSource {
+        return (object as any)[WebGlObjects.SPECTOROBJECTSOURCEKEY];
+    }
+
+    public static attachWebGlObjectSource(object: WebGLObject, source: WebGlObjectSource): void {
+        (object as any)[WebGlObjects.SPECTOROBJECTSOURCEKEY] = source;
+    }
+
     private static readonly SPECTOROBJECTTAGKEY = "__SPECTOR_Object_TAG";
+    private static readonly SPECTOROBJECTSOURCEKEY = "__SPECTOR_Object_SOURCE";
 }
 
 // tslint:disable-next-line:max-classes-per-file

src/embeddedFrontend/resultView/resultView.ts

@@ -407,6 +407,8 @@ export class ResultView {
         }
         this.displayJSONGroup(rightJsonContentStateId, "Frame Memory Changes", capture.frameMemory);
         this.displayJSONGroup(rightJsonContentStateId, "Total Memory (seconds since application start: bytes)", capture.memory);
+        this.displayJSONGroup(rightJsonContentStateId, "Objects", capture.objects);
+
     }
 
     private displayJSON(parentGroupId: number, json: any) {
@@ -501,6 +503,10 @@ export class ResultView {
             return null;
         }
 
+        if (json.__SPECTOR_Object_SOURCE) {
+            return json.__SPECTOR_Object_SOURCE;
+        }
+
         if (json.__SPECTOR_Object_TAG) {
             return json.__SPECTOR_Object_TAG.displayText;
         }

src/shared/capture/capture.ts

@@ -16,4 +16,5 @@ export interface ICapture {
     analyses: IAnalysis[];
     frameMemory: { [objectName: string]: number };
     memory: { [objectName: string]: { [second: number]: number } };
+    objects: { [objectName: string]: { [id: number]: string[] } };
 }

src/tsconfig.json

@@ -10,6 +10,10 @@
         "experimentalDecorators": true,
         "module": "es6",
         "moduleResolution": "node",
-        "target": "es5"
+        "target": "es5",
+        "lib": [
+            "ESNext",
+            "dom"
+        ]
     }
-}
+}