devtools-tracing 1.1.0 → 1.2.0

package/lib/front_end/models/text_utils/ContentData.ts

@@ -1,199 +0,0 @@
-// Copyright 2023 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import * as Platform from '../../core/platform/platform.js';
-
-import { contentAsDataURL, type DeferredContent } from './ContentProvider.js';
-import {Text} from './Text.js';
-
-/**
- * This class is a small wrapper around either raw binary or text data.
- * As the binary data can actually contain textual data, we also store the
- * MIME type and if applicable, the charset.
- *
- * This information should be generally kept together, as interpreting text
- * from raw bytes requires an encoding.
- *
- * Note that we only rarely have to decode text ourselves in the frontend,
- * this is mostly handled by the backend. There are cases though (e.g. SVG,
- * or streaming response content) where we receive text data in
- * binary (base64-encoded) form.
- *
- * The class only implements decoding. We currently don't have a use-case
- * to re-encode text into base64 bytes using a specified charset.
- */
-export class ContentData {
-  readonly mimeType: string;
-  readonly charset: string;
-
-  #contentAsBase64?: string;
-  #contentAsText?: string;
-
-  #contentAsTextObj?: Text;
-
-  constructor(data: string, isBase64: boolean, mimeType: string, charset?: string) {
-    this.charset = charset || 'utf-8';
-    if (isBase64) {
-      this.#contentAsBase64 = data;
-    } else {
-      this.#contentAsText = data;
-    }
-
-    this.mimeType = mimeType;
-    if (!this.mimeType) {
-      // Tests or broken requests might pass an empty/undefined mime type. Fallback to
-      // "default" mime types.
-      this.mimeType = isBase64 ? 'application/octet-stream' : 'text/plain';
-    }
-  }
-
-  /**
-   * Returns the data as base64.
-   *
-   * @throws if this `ContentData` was constructed from text content.
-   */
-  get base64(): string {
-    if (this.#contentAsBase64 === undefined) {
-      throw new Error('Encoding text content as base64 is not supported');
-    }
-    return this.#contentAsBase64;
-  }
-
-  /**
-   * Returns the content as text. If this `ContentData` was constructed with base64
-   * encoded bytes, it will use the provided charset to attempt to decode the bytes.
-   *
-   * @throws if `mimeType` is not a text type.
-   */
-  get text(): string {
-    if (this.#contentAsText !== undefined) {
-      return this.#contentAsText;
-    }
-
-    if (!this.isTextContent) {
-      throw new Error('Cannot interpret binary data as text');
-    }
-
-    const binaryString = window.atob(this.#contentAsBase64 as string);
-    const len = binaryString.length;
-    const bytes = new Uint8Array(len);
-    for (let i = 0; i < len; i++) {
-      bytes[i] = binaryString.charCodeAt(i);
-    }
-
-    this.#contentAsText = new TextDecoder(this.charset).decode(bytes);
-    return this.#contentAsText;
-  }
-
-  /** @returns true, if this `ContentData` was constructed from text content or the mime type indicates text that can be decoded */
-  get isTextContent(): boolean {
-    return this.#createdFromText || Platform.MimeType.isTextType(this.mimeType);
-  }
-
-  get isEmpty(): boolean {
-    // Don't trigger unnecessary decoding. Only check if both of the strings are empty.
-    return !Boolean(this.#contentAsBase64) && !Boolean(this.#contentAsText);
-  }
-
-  get createdFromBase64(): boolean {
-    return this.#contentAsBase64 !== undefined;
-  }
-
-  get #createdFromText(): boolean {
-    return this.#contentAsBase64 === undefined;
-  }
-
-  /**
-   * Returns the text content as a `Text` object. The returned object is always the same to
-   * minimize the number of times we have to calculate the line endings array.
-   *
-   * @throws if `mimeType` is not a text type.
-   */
-  get textObj(): Text {
-    if (this.#contentAsTextObj === undefined) {
-      this.#contentAsTextObj = new Text(this.text);
-    }
-    return this.#contentAsTextObj;
-  }
-
-  /**
-   * @returns True, iff the contents (base64 or text) are equal.
-   * Does not compare mime type and charset, but will decode base64 data if both
-   * mime types indicate that it's text content.
-   */
-  contentEqualTo(other: ContentData): boolean {
-    if (this.#contentAsBase64 !== undefined && other.#contentAsBase64 !== undefined) {
-      return this.#contentAsBase64 === other.#contentAsBase64;
-    }
-    if (this.#contentAsText !== undefined && other.#contentAsText !== undefined) {
-      return this.#contentAsText === other.#contentAsText;
-    }
-    if (this.isTextContent && other.isTextContent) {
-      return this.text === other.text;
-    }
-    return false;
-  }
-
-  asDataUrl(): string|null {
-    // To keep with existing behavior we prefer to return the content
-    // encoded if that is how this ContentData was constructed with.
-    if (this.#contentAsBase64 !== undefined) {
-      const charset = this.isTextContent ? this.charset : null;
-      return contentAsDataURL(this.#contentAsBase64, this.mimeType ?? '', true, charset);
-    }
-    return contentAsDataURL(this.text, this.mimeType ?? '', false, 'utf-8');
-  }
-
-  /**
-   * @deprecated Used during migration from `DeferredContent` to `ContentData`.
-   */
-  asDeferedContent(): DeferredContent {
-    // To prevent encoding mistakes, we'll return text content already decoded.
-    if (this.isTextContent) {
-      return {content: this.text, isEncoded: false};
-    }
-    if (this.#contentAsText !== undefined) {
-      // Unknown text mime type, this should not really happen.
-      return {content: this.#contentAsText, isEncoded: false};
-    }
-    if (this.#contentAsBase64 !== undefined) {
-      return {content: this.#contentAsBase64, isEncoded: true};
-    }
-    throw new Error('Unreachable');
-  }
-
-  static isError(contentDataOrError: ContentDataOrError): contentDataOrError is {error: string} {
-    return 'error' in contentDataOrError;
-  }
-
-  /** @returns `value` if the passed `ContentDataOrError` is an error, or the text content otherwise */
-  static textOr<T>(contentDataOrError: ContentDataOrError, value: T): string|T {
-    if (ContentData.isError(contentDataOrError)) {
-      return value;
-    }
-    return contentDataOrError.text;
-  }
-
-  /** @returns an empty 'text/plain' content data if the passed `ContentDataOrError` is an error, or the content data itself otherwise */
-  static contentDataOrEmpty(contentDataOrError: ContentDataOrError): ContentData {
-    if (ContentData.isError(contentDataOrError)) {
-      return EMPTY_TEXT_CONTENT_DATA;
-    }
-    return contentDataOrError;
-  }
-
-  /**
-   * @deprecated Used during migration from `DeferredContent` to `ContentData`.
-   */
-  static asDeferredContent(contentDataOrError: ContentDataOrError): DeferredContent {
-    if (ContentData.isError(contentDataOrError)) {
-      return {error: contentDataOrError.error, content: null, isEncoded: false};
-    }
-    return contentDataOrError.asDeferedContent();
-  }
-}
-
-export const EMPTY_TEXT_CONTENT_DATA = new ContentData('', /* isBase64 */ false, 'text/plain');
-
-export type ContentDataOrError = ContentData|{error: string};

package/lib/front_end/models/text_utils/ContentProvider.ts

@@ -1,68 +0,0 @@
-// Copyright 2012 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import type * as Common from '../../core/common/common.js';
-import type * as Platform from '../../core/platform/platform.js';
-
-import type {ContentDataOrError} from './ContentData.js';
-import type {StreamingContentDataOrError} from './StreamingContentData.js';
-import type {WasmDisassembly} from './WasmDisassembly.js';
-
-export interface ContentProvider {
-  contentURL(): Platform.DevToolsPath.UrlString;
-  contentType(): Common.ResourceType.ResourceType;
-  requestContentData(): Promise<ContentDataOrError>;
-  searchInContent(query: string, caseSensitive: boolean, isRegex: boolean): Promise<SearchMatch[]>;
-}
-
-export class SearchMatch {
-  constructor(
-      readonly lineNumber: number, readonly lineContent: string, readonly columnNumber: number,
-      readonly matchLength: number) {
-  }
-
-  static comparator(a: SearchMatch, b: SearchMatch): number {
-    return a.lineNumber - b.lineNumber || a.columnNumber - b.columnNumber;
-  }
-}
-
-export const contentAsDataURL = function(
-    content: string|null, mimeType: string, contentEncoded: boolean, charset?: string|null,
-    limitSize = true): string|null {
-  const maxDataUrlSize = 1024 * 1024;
-  if (content === undefined || content === null || (limitSize && content.length > maxDataUrlSize)) {
-    return null;
-  }
-
-  content = contentEncoded ? content : encodeURIComponent(content);
-  return 'data:' + mimeType + (charset ? ';charset=' + charset : '') + (contentEncoded ? ';base64' : '') + ',' +
-      content;
-};
-
-export type DeferredContent = {
-  content: string,
-  isEncoded: boolean,
-}|{
-  content: '',
-  isEncoded: false,
-  wasmDisassemblyInfo: WasmDisassembly,
-}|{
-  content: null,
-  error: string,
-  isEncoded: boolean,
-};
-
-/**
- * Some ContentProvider like NetworkRequests might never actually be able to return
- * a fully completed "requestContentData" as the request keeps on going indefinitely.
- * Such proivders can implement the "StreamingContentProvider" addition, which allows
- * for partial/streaming content.
- **/
-export interface StreamingContentProvider extends ContentProvider {
-  requestStreamingContent(): Promise<StreamingContentDataOrError>;
-}
-
-export const isStreamingContentProvider = function(provider: ContentProvider): provider is StreamingContentProvider {
-  return 'requestStreamingContent' in provider;
-};

package/lib/front_end/models/text_utils/StaticContentProvider.ts

@@ -1,49 +0,0 @@
-// Copyright 2014 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import type * as Common from '../../core/common/common.js';
-import type * as Platform from '../../core/platform/platform.js';
-
-import {ContentData, type ContentDataOrError} from './ContentData.js';
-import type {ContentProvider, SearchMatch} from './ContentProvider.js';
-import {performSearchInContentData} from './TextUtils.js';
-
-export class StaticContentProvider implements ContentProvider {
-  readonly #contentURL: Platform.DevToolsPath.UrlString;
-  readonly #contentType: Common.ResourceType.ResourceType;
-  readonly #lazyContent: () => Promise<ContentDataOrError>;
-
-  constructor(
-      contentURL: Platform.DevToolsPath.UrlString, contentType: Common.ResourceType.ResourceType,
-      lazyContent: () => Promise<ContentDataOrError>) {
-    this.#contentURL = contentURL;
-    this.#contentType = contentType;
-    this.#lazyContent = lazyContent;
-  }
-
-  static fromString(
-      contentURL: Platform.DevToolsPath.UrlString, contentType: Common.ResourceType.ResourceType,
-      content: string): StaticContentProvider {
-    const lazyContent = (): Promise<ContentData> =>
-        Promise.resolve(new ContentData(content, /* isBase64 */ false, contentType.canonicalMimeType()));
-    return new StaticContentProvider(contentURL, contentType, lazyContent);
-  }
-
-  contentURL(): Platform.DevToolsPath.UrlString {
-    return this.#contentURL;
-  }
-
-  contentType(): Common.ResourceType.ResourceType {
-    return this.#contentType;
-  }
-
-  requestContentData(): Promise<ContentDataOrError> {
-    return this.#lazyContent();
-  }
-
-  async searchInContent(query: string, caseSensitive: boolean, isRegex: boolean): Promise<SearchMatch[]> {
-    const contentData = await this.requestContentData();
-    return performSearchInContentData(contentData, query, caseSensitive, isRegex);
-  }
-}

package/lib/front_end/models/text_utils/StreamingContentData.ts

@@ -1,108 +0,0 @@
-// Copyright 2024 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import * as Common from '../../core/common/common.js';
-import * as Platform from '../../core/platform/platform.js';
-
-import {ContentData, type ContentDataOrError} from './ContentData.js';
-
-/**
- * Usage of this class is mostly intended for content that is never "complete".
- * E.g. streaming XHR/fetch requests.
- *
- * Due to the streaming nature this class only supports base64-encoded binary data.
- * Decoding to text only happens on-demand by clients. This ensures that at most we have
- * incomplete unicode at the end and not in-between chunks.
- */
-export class StreamingContentData extends Common.ObjectWrapper.ObjectWrapper<EventTypes> {
-  readonly mimeType: string;
-  readonly #charset?: string;
-
-  readonly #disallowStreaming: boolean;
-
-  #chunks: string[] = [];
-  #contentData?: ContentData;
-
-  private constructor(mimeType: string, charset?: string, initialContent?: ContentData) {
-    super();
-    this.mimeType = mimeType;
-    this.#charset = charset;
-    this.#disallowStreaming = Boolean(initialContent && !initialContent.createdFromBase64);
-    this.#contentData = initialContent;
-  }
-
-  /**
-   * Creates a new StreamingContentData with the given MIME type/charset.
-   */
-  static create(mimeType: string, charset?: string): StreamingContentData {
-    return new StreamingContentData(mimeType, charset);
-  }
-
-  /**
-   * Creates a new StringContentData from an existing ContentData instance.
-   *
-   * Calling `addChunk` is on the resulting `StreamingContentData` is illegal if
-   * `content` was not created from base64 data. The reason is that JavaScript TextEncoder
-   * only supports UTF-8. We can't convert text with arbitrary encoding back to base64 for concatenation.
-   */
-  static from(content: ContentData): StreamingContentData {
-    return new StreamingContentData(content.mimeType, content.charset, content);
-  }
-
-  /** @returns true, if this `ContentData` was constructed from text content or the mime type indicates text that can be decoded */
-  get isTextContent(): boolean {
-    if (this.#contentData) {
-      return this.#contentData.isTextContent;
-    }
-    return Platform.MimeType.isTextType(this.mimeType);
-  }
-
-  /** @param chunk base64 encoded data */
-  addChunk(chunk: string): void {
-    if (this.#disallowStreaming) {
-      throw new Error('Cannot add base64 data to a text-only ContentData.');
-    }
-
-    this.#chunks.push(chunk);
-    this.dispatchEventToListeners(Events.CHUNK_ADDED, {content: this, chunk});
-  }
-
-  /** @returns An immutable ContentData with all the bytes received so far */
-  content(): ContentData {
-    if (this.#contentData && this.#chunks.length === 0) {
-      return this.#contentData;
-    }
-
-    const initialBase64 = this.#contentData?.base64 ?? '';
-    const base64Content =
-        this.#chunks.reduce((acc, chunk) => Platform.StringUtilities.concatBase64(acc, chunk), initialBase64);
-    this.#contentData = new ContentData(base64Content, /* isBase64=*/ true, this.mimeType, this.#charset);
-    this.#chunks = [];
-    return this.#contentData;
-  }
-}
-
-export type StreamingContentDataOrError = StreamingContentData|{error: string};
-
-export const isError = function(contentDataOrError: StreamingContentDataOrError): contentDataOrError is {
-error:
-  string,
-} {
-  return 'error' in contentDataOrError;
-};
-
-export const asContentDataOrError = function(contentDataOrError: StreamingContentDataOrError): ContentDataOrError {
-  if (isError(contentDataOrError)) {
-    return contentDataOrError;
-  }
-  return contentDataOrError.content();
-};
-
-export const enum Events {
-  CHUNK_ADDED = 'ChunkAdded',
-}
-
-export interface EventTypes {
-  [Events.CHUNK_ADDED]: {content: StreamingContentData, chunk: string};
-}

package/lib/front_end/models/text_utils/Text.ts

@@ -1,90 +0,0 @@
-// Copyright 2016 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import * as Platform from '../../core/platform/platform.js';
-
-import {TextCursor} from './TextCursor.js';
-import {SourceRange, TextRange} from './TextRange.js';
-
-export class Text {
-  readonly #value: string;
-  #lineEndings?: number[];
-
-  constructor(value: string) {
-    this.#value = value;
-  }
-
-  lineEndings(): number[] {
-    if (!this.#lineEndings) {
-      this.#lineEndings = Platform.StringUtilities.findLineEndingIndexes(this.#value);
-    }
-    return this.#lineEndings;
-  }
-
-  value(): string {
-    return this.#value;
-  }
-
-  lineCount(): number {
-    const lineEndings = this.lineEndings();
-    return lineEndings.length;
-  }
-
-  offsetFromPosition(lineNumber: number, columnNumber: number): number {
-    return (lineNumber ? this.lineEndings()[lineNumber - 1] + 1 : 0) + columnNumber;
-  }
-
-  positionFromOffset(offset: number): Position {
-    const lineEndings = this.lineEndings();
-    const lineNumber =
-        Platform.ArrayUtilities.lowerBound(lineEndings, offset, Platform.ArrayUtilities.DEFAULT_COMPARATOR);
-    return {lineNumber, columnNumber: offset - (lineNumber && (lineEndings[lineNumber - 1] + 1))};
-  }
-
-  lineAt(lineNumber: number): string {
-    const lineEndings = this.lineEndings();
-    const lineStart = lineNumber > 0 ? lineEndings[lineNumber - 1] + 1 : 0;
-    const lineEnd = lineEndings[lineNumber];
-    let lineContent = this.#value.substring(lineStart, lineEnd);
-    if (lineContent.length > 0 && lineContent.charAt(lineContent.length - 1) === '\r') {
-      lineContent = lineContent.substring(0, lineContent.length - 1);
-    }
-    return lineContent;
-  }
-
-  toSourceRange(range: TextRange): SourceRange {
-    const start = this.offsetFromPosition(range.startLine, range.startColumn);
-    const end = this.offsetFromPosition(range.endLine, range.endColumn);
-    return new SourceRange(start, end - start);
-  }
-
-  toTextRange(sourceRange: SourceRange): TextRange {
-    const cursor = new TextCursor(this.lineEndings());
-    const result = TextRange.createFromLocation(0, 0);
-
-    cursor.resetTo(sourceRange.offset);
-    result.startLine = cursor.lineNumber();
-    result.startColumn = cursor.columnNumber();
-
-    cursor.advance(sourceRange.offset + sourceRange.length);
-    result.endLine = cursor.lineNumber();
-    result.endColumn = cursor.columnNumber();
-    return result;
-  }
-
-  replaceRange(range: TextRange, replacement: string): string {
-    const sourceRange = this.toSourceRange(range);
-    return this.#value.substring(0, sourceRange.offset) + replacement +
-        this.#value.substring(sourceRange.offset + sourceRange.length);
-  }
-
-  extract(range: TextRange): string {
-    const sourceRange = this.toSourceRange(range);
-    return this.#value.substr(sourceRange.offset, sourceRange.length);
-  }
-}
-export interface Position {
-  lineNumber: number;
-  columnNumber: number;
-}

package/lib/front_end/models/text_utils/TextCursor.ts

@@ -1,44 +0,0 @@
-// Copyright 2020 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import * as Platform from '../../core/platform/platform.js';
-
-export class TextCursor {
-  readonly #lineEndings: number[];
-
-  #offset = 0;
-  #lineNumber = 0;
-  #columnNumber = 0;
-
-  constructor(lineEndings: number[]) {
-    this.#lineEndings = lineEndings;
-  }
-
-  advance(offset: number): void {
-    this.#offset = offset;
-    while (this.#lineNumber < this.#lineEndings.length && this.#lineEndings[this.#lineNumber] < this.#offset) {
-      ++this.#lineNumber;
-    }
-    this.#columnNumber = this.#lineNumber ? this.#offset - this.#lineEndings[this.#lineNumber - 1] - 1 : this.#offset;
-  }
-
-  offset(): number {
-    return this.#offset;
-  }
-
-  resetTo(offset: number): void {
-    this.#offset = offset;
-    this.#lineNumber =
-        Platform.ArrayUtilities.lowerBound(this.#lineEndings, offset, Platform.ArrayUtilities.DEFAULT_COMPARATOR);
-    this.#columnNumber = this.#lineNumber ? this.#offset - this.#lineEndings[this.#lineNumber - 1] - 1 : this.#offset;
-  }
-
-  lineNumber(): number {
-    return this.#lineNumber;
-  }
-
-  columnNumber(): number {
-    return this.#columnNumber;
-  }
-}