8878582614

Committed 29 Apr 2024 12:31PM UTC coverage: 74.9% (-2.6%) from 77.523%

Build # 8878582614

Build Type

push

github

Committed by

web-flow

Commit Message

fix(webgl): Fix spectorjs (#2082)

Run Details

1821 of 2373 branches covered (76.74%)

Branch coverage included in aggregate %.

78 of 1250 new or added lines in 7 files covered. (6.24%)

1 existing line in 1 file now uncovered.

23430 of 31340 relevant lines covered (74.76%)

19.83 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

42.86

/modules/webgl/src/context/debug/spector.ts

// luma.gl
// SPDX-License-Identifier: MIT
// Copyright (c) vis.gl contributors

import {log} from '@luma.gl/core';
import {loadScript} from '../../utils/load-script';

import {Spector} from './spector-types';

/** Spector debug initialization options */
type SpectorProps = {
  /** Whether spector is enabled */
  debugWithSpectorJS?: boolean;
  /** URL to load spector script from. Typically a CDN URL */
  spectorUrl?: string;
  /** Canvas to monitor */
  gl?: WebGL2RenderingContext;
};

const LOG_LEVEL = 1;

let spector: Spector = null;
let initialized: boolean = false;

declare global {
  // @ts-ignore
  // eslint-disable-next-line no-var
  var SPECTOR: Spector;
}

export const DEFAULT_SPECTOR_PROPS: SpectorProps = {
  debugWithSpectorJS: log.get('spector') || log.get('spectorjs'),
  // https://github.com/BabylonJS/Spector.js#basic-usage
  // https://forum.babylonjs.com/t/spectorcdn-is-temporarily-off/48241
  // spectorUrl: 'https://spectorcdn.babylonjs.com/spector.bundle.js';
  spectorUrl: 'https://cdn.jsdelivr.net/npm/spectorjs@0.9.30/dist/spector.bundle.js'
};

/** Loads spector from CDN if not already installed */
export async function loadSpectorJS(props: SpectorProps): Promise<void> {
  if (!globalThis.SPECTOR && props.debugWithSpectorJS) {
    try {
      await loadScript(props.spectorUrl);
    } catch (error) {
      log.warn(String(error));
    }
  }
}

export function initializeSpectorJS(props: SpectorProps): Spector | null {
  props = {...DEFAULT_SPECTOR_PROPS, ...props};
  if (!props.debugWithSpectorJS) {
    return null;
  }

  if (!spector && globalThis.SPECTOR && !globalThis.luma?.spector) {
    log.probe(LOG_LEVEL, 'SPECTOR found and initialized. Start with `luma.spector.displayUI()`')();
    const {Spector} = globalThis.SPECTOR as any;
    spector = new Spector();
    if (globalThis.luma) {
      globalThis.luma.spector = spector;
    }
  }

  if (!spector) {
    return null;
  }

  if (!initialized) {
    initialized = true;

    // enables recording some extra information merged in the capture like texture memory sizes and formats
    spector.spyCanvases();
    // A callback when results are ready
    spector?.onCaptureStarted.add((capture: unknown) =>
      log.info('Spector capture started:', capture)()
    );
    spector?.onCapture.add((capture: unknown) => {
      log.info('Spector capture complete:', capture)();
      // Use undocumented Spector API to open the UI with our capture
      // See https://github.com/BabylonJS/Spector.js/blob/767ad1195a25b85a85c381f400eb50a979239eca/src/spector.ts#L124
      spector?.getResultUI();
      // @ts-expect-error private
      spector?.resultView.display();
      // @ts-expect-error private
      spector?.resultView.addCapture(capture);
    });
  }

  if (props.gl) {
    // capture startup
    const gl = props.gl;
    // @ts-expect-error
    const device = gl.device;
    spector?.startCapture(props.gl, 500); // 500 commands
    // @ts-expect-error
    gl.device = device;

    new Promise(resolve => setTimeout(resolve, 2000)).then(_ => {
      log.info('Spector capture stopped after 2 seconds')();
      spector?.stopCapture();
      // spector?.displayUI();
    });
  }

  return spector;
}

1	// luma.gl	1✔
2	// SPDX-License-Identifier: MIT	1✔
3	// Copyright (c) vis.gl contributors	1✔
4		1✔
5	import {log} from '@luma.gl/core';	1✔
6	import {loadScript} from '../../utils/load-script';	1✔
7		1✔
8	import {Spector} from './spector-types';	1✔
9		1✔
10	/** Spector debug initialization options */	1✔
11	type SpectorProps = {	1✔
12	/** Whether spector is enabled */	1✔
13	debugWithSpectorJS?: boolean;	1✔
14	/** URL to load spector script from. Typically a CDN URL */	1✔
15	spectorUrl?: string;	1✔
16	/** Canvas to monitor */	1✔
17	gl?: WebGL2RenderingContext;	1✔
18	};	1✔
19		1✔
20	const LOG_LEVEL = 1;	1✔
21		1✔
22	let spector: Spector = null;	1✔
23	let initialized: boolean = false;	1✔
24		1✔
25	declare global {	1✔
26	// @ts-ignore	1✔
27	// eslint-disable-next-line no-var	1✔
28	var SPECTOR: Spector;	1✔
29	}	1✔
30		1✔
31	export const DEFAULT_SPECTOR_PROPS: SpectorProps = {	1✔
32	debugWithSpectorJS: log.get('spector') \|\| log.get('spectorjs'),	1✔
33	// https://github.com/BabylonJS/Spector.js#basic-usage	1✔
34	// https://forum.babylonjs.com/t/spectorcdn-is-temporarily-off/48241	1✔
35	// spectorUrl: 'https://spectorcdn.babylonjs.com/spector.bundle.js';	1✔
36	spectorUrl: 'https://cdn.jsdelivr.net/npm/spectorjs@0.9.30/dist/spector.bundle.js'	1✔
37	};	1✔
38		1✔
39	/** Loads spector from CDN if not already installed */	1✔
NEW 40	export async function loadSpectorJS(props: SpectorProps): Promise<void> {	×
NEW 41	if (!globalThis.SPECTOR && props.debugWithSpectorJS) {	×
42	try {	×
NEW 43	await loadScript(props.spectorUrl);	×
44	} catch (error) {	×
45	log.warn(String(error));	×
46	}	×
47	}	×
48	}	×
49		1✔
50	export function initializeSpectorJS(props: SpectorProps): Spector \| null {	1✔
51	props = {...DEFAULT_SPECTOR_PROPS, ...props};	5✔
52	if (!props.debugWithSpectorJS) {	5✔
53	return null;	5✔
54	}	5!
55		×
56	if (!spector && globalThis.SPECTOR && !globalThis.luma?.spector) {	5!
NEW 57	log.probe(LOG_LEVEL, 'SPECTOR found and initialized. Start with `luma.spector.displayUI()`')();	×
NEW 58	const {Spector} = globalThis.SPECTOR as any;	×
NEW 59	spector = new Spector();	×
60	if (globalThis.luma) {	×
61	globalThis.luma.spector = spector;	×
62	}	×
63	}	×
64		×
65	if (!spector) {	×
66	return null;	×
67	}	×
68		×
69	if (!initialized) {	×
70	initialized = true;	×
71		×
72	// enables recording some extra information merged in the capture like texture memory sizes and formats	×
73	spector.spyCanvases();	×
74	// A callback when results are ready	×
75	spector?.onCaptureStarted.add((capture: unknown) =>	×
76	log.info('Spector capture started:', capture)()	×
77	);	×
78	spector?.onCapture.add((capture: unknown) => {	×
79	log.info('Spector capture complete:', capture)();	×
80	// Use undocumented Spector API to open the UI with our capture	×
81	// See https://github.com/BabylonJS/Spector.js/blob/767ad1195a25b85a85c381f400eb50a979239eca/src/spector.ts#L124	×
82	spector?.getResultUI();	×
NEW 83	// @ts-expect-error private	×
84	spector?.resultView.display();	×
NEW 85	// @ts-expect-error private	×
86	spector?.resultView.addCapture(capture);	×
87	});	×
88	}	×
89		×
NEW 90	if (props.gl) {	×
91	// capture startup	×
NEW 92	const gl = props.gl;	×
NEW 93	// @ts-expect-error	×
NEW 94	const device = gl.device;	×
NEW 95	spector?.startCapture(props.gl, 500); // 500 commands	×
NEW 96	// @ts-expect-error	×
NEW 97	gl.device = device;	×
NEW 98		×
99	new Promise(resolve => setTimeout(resolve, 2000)).then(_ => {	×
100	log.info('Spector capture stopped after 2 seconds')();	×
101	spector?.stopCapture();	×
102	// spector?.displayUI();	×
103	});	×
104	}	×
105		×
106	return spector;	×
107	}	×

visgl / luma.gl / 8878582614

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous