chrome-devtools-frontend/front_end/models/extensions/RecorderPluginManager.ts

Chrome DevTools UI

// Copyright 2022 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import {type RecorderExtensionEndpoint} from './RecorderExtensionEndpoint.js';
import * as Common from '../../core/common/common.js';

let instance: RecorderPluginManager|null = null;

export type ViewDescriptor = {
  id: string,
  title: string,
  pagePath: string,
  onShown: () => void,
  onHidden: () => void,
};

export class RecorderPluginManager extends Common.ObjectWrapper.ObjectWrapper<EventTypes> {
  #plugins: Set<RecorderExtensionEndpoint> = new Set();
  #views: Map<string, ViewDescriptor> = new Map();

  static instance(): RecorderPluginManager {
    if (!instance) {
      instance = new RecorderPluginManager();
    }
    return instance;
  }

  addPlugin(plugin: RecorderExtensionEndpoint): void {
    this.#plugins.add(plugin);
    this.dispatchEventToListeners(Events.PluginAdded, plugin);
  }

  removePlugin(plugin: RecorderExtensionEndpoint): void {
    this.#plugins.delete(plugin);
    this.dispatchEventToListeners(Events.PluginRemoved, plugin);
  }

  plugins(): RecorderExtensionEndpoint[] {
    return Array.from(this.#plugins.values());
  }

  registerView(descriptor: ViewDescriptor): void {
    this.#views.set(descriptor.id, descriptor);
    this.dispatchEventToListeners(Events.ViewRegistered, descriptor);
  }

  views(): ViewDescriptor[] {
    return Array.from(this.#views.values());
  }

  getViewDescriptor(id: string): ViewDescriptor|undefined {
    return this.#views.get(id);
  }

  showView(id: string): void {
    const descriptor = this.#views.get(id);
    if (!descriptor) {
      throw new Error(`View with id ${id} is not found.`);
    }
    this.dispatchEventToListeners(Events.ShowViewRequested, descriptor);
  }
}

// TODO(crbug.com/1167717): Make this a const enum again
// eslint-disable-next-line rulesdir/const_enum
export enum Events {
  PluginAdded = 'pluginAdded',
  PluginRemoved = 'pluginRemoved',
  ViewRegistered = 'viewRegistered',
  ShowViewRequested = 'showViewRequested',
}

export type EventTypes = {
  [Events.PluginAdded]: RecorderExtensionEndpoint,
  [Events.PluginRemoved]: RecorderExtensionEndpoint,
  [Events.ViewRegistered]: ViewDescriptor,
  [Events.ShowViewRequested]: ViewDescriptor,
};