7268023719

Committed 19 Dec 2023 09:59PM UTC coverage: 72.679% (-0.07%) from 72.749%

Build # 7268023719

Build Type

Pull #1892

github

Committed by

web-flow

Commit Message

Merge 5e334a630 into b4bc0fa8b

Pull Request Pull Request #1892: feat(core): Shader debugger

Run Details

1302 of 1767 branches covered (0.0%)

Branch coverage included in aggregate %.

114 of 170 new or added lines in 3 files covered. (67.06%)

1 existing line in 1 file now uncovered.

21051 of 28989 relevant lines covered (72.62%)

16.37 hits per line

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

80.0

/modules/core/src/lib/compiler-log/format-compiler-log.ts

// luma.gl, MIT license
import type {CompilerMessage} from './compiler-message';

/** @returns annotated errors or warnings */
export function formatCompilerLog(
  shaderLog: readonly CompilerMessage[],
  source: string,
  options?: {
    /** Include source code in the log. Either just the lines before issues or all source code */
    showSourceCode?: 'no' | 'issues' | 'all';
    html?: boolean;
  }
): string {
  let formattedLog = '';
  const lines = source.split(/\r?\n/);
  const log = shaderLog.slice().sort((a, b) => a.lineNum - b.lineNum);

  switch (options?.showSourceCode || 'no') {
    case 'all':
      // Parse the error - note: browser and driver dependent
      let currentMessage = 0;
      for (let lineNum = 0; lineNum < lines.length; lineNum++) {
        formattedLog += getNumberedLine(lines[lineNum], lineNum, options);
        while (log.length > currentMessage && log[currentMessage].lineNum === lineNum + 1) {
          const message = log[currentMessage++];
          formattedLog += formatCompilerMessage(message, lines, message.lineNum + 1, {
            ...options,
            inlineSource: false
          });
        }
      }
      return formattedLog;

    case 'issues':
    case 'no':
      // Parse the error - note: browser and driver dependent
      for (const message of shaderLog) {
        formattedLog += formatCompilerMessage(message, lines, message.lineNum, {
          inlineSource: options?.showSourceCode !== 'no'
        });
      }
      return formattedLog;
  }
}

// Helpers

/** Format one message */
function formatCompilerMessage(
  message: CompilerMessage,
  lines: readonly string[],
  lineNum: number,
  options: {
    inlineSource?: boolean;
    html?: boolean;
  }
): string {
  if (options?.inlineSource) {
    const numberedLines = getNumberedLines(lines, lineNum);
    // If we got error position on line add a `^^^` indicator on next line
    const positionIndicator = message.linePos > 0 ? `${' '.repeat(message.linePos + 5)}^^^\n` : '';
    return `
${numberedLines}${positionIndicator}${message.type.toUpperCase()}: ${message.message}

`;
  }
  return options?.html
    ? `<div style="color:red;"><b> ${message.type.toUpperCase()}: ${message.message}</b></div>`
    : `${message.type.toUpperCase()}: ${message.message}`;
}

function getNumberedLines(
  lines: readonly string[],
  lineNum: number,
  options?: {html?: boolean}
): string {
  let numberedLines = '';
  for (let line = lineNum - 2; line <= lineNum; line++) {
    const sourceLine = lines[line];
    if (sourceLine !== undefined) {
      numberedLines += getNumberedLine(sourceLine, lineNum, options);
    }
  }
  return numberedLines;
}

function getNumberedLine(line: string, lineNum: number, options?: {html?: boolean}): string {
  return `${padLeft(String(lineNum), 4)}: ${line}${options?.html ? '<br/>' : '\n'}`;
}

/**
 * Pads a string with a number of spaces (space characters) to the left
 * @param {String} string - string to pad
 * @param {Number} digits - number of spaces to add
 * @return {String} string - The padded string
 */
function padLeft(string: string, paddedLength: number): string {
  let result = '';
  for (let i = string.length; i < paddedLength; ++i) {
    result += ' ';
  }
  return result + string;
}

1	// luma.gl, MIT license	1✔
2	import type {CompilerMessage} from './compiler-message';	1✔
3		1✔
4	/** @returns annotated errors or warnings */	1✔
5	export function formatCompilerLog(	1✔
6	shaderLog: readonly CompilerMessage[],	1✔
7	source: string,	1✔
8	options?: {	1✔
9	/** Include source code in the log. Either just the lines before issues or all source code */	1✔
10	showSourceCode?: 'no' \| 'issues' \| 'all';	1✔
11	html?: boolean;	1✔
12	}	1✔
13	): string {	1✔
14	let formattedLog = '';	1✔
15	const lines = source.split(/\r?\n/);	1✔
16	const log = shaderLog.slice().sort((a, b) => a.lineNum - b.lineNum);	1✔
17		1✔
18	switch (options?.showSourceCode \|\| 'no') {	1!
19	case 'all':	1!
NEW 20	// Parse the error - note: browser and driver dependent	×
NEW 21	let currentMessage = 0;	×
NEW 22	for (let lineNum = 0; lineNum < lines.length; lineNum++) {	×
NEW 23	formattedLog += getNumberedLine(lines[lineNum], lineNum, options);	×
NEW 24	while (log.length > currentMessage && log[currentMessage].lineNum === lineNum + 1) {	×
NEW 25	const message = log[currentMessage++];	×
NEW 26	formattedLog += formatCompilerMessage(message, lines, message.lineNum + 1, {	×
NEW 27	...options,	×
NEW 28	inlineSource: false	×
NEW 29	});	×
NEW 30	}	×
NEW 31	}	×
NEW 32	return formattedLog;	×
33		1✔
34	case 'issues':	1✔
35	case 'no':	1✔
36	// Parse the error - note: browser and driver dependent	1✔
37	for (const message of shaderLog) {	1✔
38	formattedLog += formatCompilerMessage(message, lines, message.lineNum, {	20✔
39	inlineSource: options?.showSourceCode !== 'no'	20✔
40	});	20✔
41	}	20✔
42	return formattedLog;	1✔
43	}	1✔
UNCOV 44	}	×
45		1✔
46	// Helpers	1✔
47		1✔
48	/** Format one message */	1✔
49	function formatCompilerMessage(	20✔
50	message: CompilerMessage,	20✔
51	lines: readonly string[],	20✔
52	lineNum: number,	20✔
53	options: {	20✔
54	inlineSource?: boolean;	20✔
55	html?: boolean;	20✔
56	}	20✔
57	): string {	20✔
58	if (options?.inlineSource) {	20✔
59	const numberedLines = getNumberedLines(lines, lineNum);	20✔
60	// If we got error position on line add a `^^^` indicator on next line	20✔
61	const positionIndicator = message.linePos > 0 ? `${' '.repeat(message.linePos + 5)}^^^\n` : '';	20!
62	return `	20✔
63	${numberedLines}${positionIndicator}${message.type.toUpperCase()}: ${message.message}	20✔
64		20✔
65	`;	20✔
66	}	20✔
NEW 67	return options?.html	×
68	? `<div style="color:red;"><b> ${message.type.toUpperCase()}: ${message.message}</b></div>`	20!
69	: `${message.type.toUpperCase()}: ${message.message}`;	20!
70	}	20✔
71		1✔
72	function getNumberedLines(	20✔
73	lines: readonly string[],	20✔
74	lineNum: number,	20✔
75	options?: {html?: boolean}	20✔
76	): string {	20✔
77	let numberedLines = '';	20✔
78	for (let line = lineNum - 2; line <= lineNum; line++) {	20✔
79	const sourceLine = lines[line];	60✔
80	if (sourceLine !== undefined) {	60✔
81	numberedLines += getNumberedLine(sourceLine, lineNum, options);	60✔
82	}	60✔
83	}	60✔
84	return numberedLines;	20✔
85	}	20✔
86		1✔
87	function getNumberedLine(line: string, lineNum: number, options?: {html?: boolean}): string {	60✔
88	return `${padLeft(String(lineNum), 4)}: ${line}${options?.html ? '<br/>' : '\n'}`;	60!
89	}	60✔
90		1✔
91	/**	1✔
92	* Pads a string with a number of spaces (space characters) to the left	1✔
93	* @param {String} string - string to pad	1✔
94	* @param {Number} digits - number of spaces to add	1✔
95	* @return {String} string - The padded string	1✔
96	*/	1✔
97	function padLeft(string: string, paddedLength: number): string {	60✔
98	let result = '';	60✔
99	for (let i = string.length; i < paddedLength; ++i) {	60✔
100	result += ' ';	60✔
101	}	60✔
102	return result + string;	60✔
103	}	60✔

visgl / luma.gl / 7268023719

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