chrome-devtools-frontend 1.0.1669021 → 1.0.1672388

package/front_end/panels/application/SharedStorageItemsView.ts

@@ -1,179 +0,0 @@
-// Copyright 2022 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 i18n from '../../core/i18n/i18n.js';
-import type * as Protocol from '../../generated/protocol.js';
-import * as SourceFrame from '../../ui/legacy/components/source_frame/source_frame.js';
-import * as UI from '../../ui/legacy/legacy.js';
-
-import * as ApplicationComponents from './components/components.js';
-import {KeyValueStorageItemsView, type View as ViewFunction} from './KeyValueStorageItemsView.js';
-import {SharedStorageForOrigin} from './SharedStorageModel.js';
-
-const UIStrings = {
-  /**
-   * @description Text in SharedStorage Items View of the Application panel
-   */
-  sharedStorage: 'Shared storage',
-  /**
-   * @description Text for announcing that the "Shared Storage Items" table was cleared, that is, all
-   * entries were deleted.
-   */
-  sharedStorageItemsCleared: 'Shared Storage items cleared',
-  /**
-   * @description Text for announcing that the filtered "Shared Storage Items" table was cleared, that is,
-   * all filtered entries were deleted.
-   */
-  sharedStorageFilteredItemsCleared: 'Shared Storage filtered items cleared',
-  /**
-   * @description Text for announcing a Shared Storage key/value item has been deleted
-   */
-  sharedStorageItemDeleted: 'The storage item was deleted.',
-  /**
-   * @description Text for announcing a Shared Storage key/value item has been edited
-   */
-  sharedStorageItemEdited: 'The storage item was edited.',
-  /**
-   * @description Text for announcing a Shared Storage key/value item edit request has been canceled
-   */
-  sharedStorageItemEditCanceled: 'The storage item edit was canceled.',
-} as const;
-const str_ = i18n.i18n.registerUIStrings('panels/application/SharedStorageItemsView.ts', UIStrings);
-const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
-
-interface WrappedEntry {
-  key: string;
-  value: string;
-}
-
-export namespace SharedStorageItemsDispatcher {
-  export const enum Events {
-    FILTERED_ITEMS_CLEARED = 'FilteredItemsCleared',
-    ITEM_DELETED = 'ItemDeleted',
-    ITEM_EDITED = 'ItemEdited',
-    ITEMS_CLEARED = 'ItemsCleared',
-    ITEMS_REFRESHED = 'ItemsRefreshed',
-  }
-
-  export interface ItemDeletedEvent {
-    key: string;
-  }
-
-  export interface ItemEditedEvent {
-    columnIdentifier: string;
-    oldText: string|null;
-    newText: string;
-  }
-
-  export interface EventTypes {
-    [Events.FILTERED_ITEMS_CLEARED]: void;
-    [Events.ITEM_DELETED]: ItemDeletedEvent;
-    [Events.ITEM_EDITED]: void;
-    [Events.ITEMS_CLEARED]: void;
-    [Events.ITEMS_REFRESHED]: void;
-  }
-}
-
-export class SharedStorageItemsView extends KeyValueStorageItemsView {
-  #sharedStorage: SharedStorageForOrigin;
-  readonly sharedStorageItemsDispatcher: Common.ObjectWrapper.ObjectWrapper<SharedStorageItemsDispatcher.EventTypes>;
-
-  constructor(sharedStorage: SharedStorageForOrigin, view?: ViewFunction) {
-    super(
-        i18nString(UIStrings.sharedStorage), 'shared-storage-items-view', /* editable=*/ true, view,
-        new ApplicationComponents.SharedStorageMetadataView.SharedStorageMetadataView(
-            sharedStorage, sharedStorage.securityOrigin));
-
-    this.#sharedStorage = sharedStorage;
-    this.performUpdate();
-
-    this.#sharedStorage.addEventListener(
-        SharedStorageForOrigin.Events.SHARED_STORAGE_CHANGED, this.#sharedStorageChanged, this);
-
-    this.sharedStorageItemsDispatcher =
-        new Common.ObjectWrapper.ObjectWrapper<SharedStorageItemsDispatcher.EventTypes>();
-  }
-
-  // Use `createView()` instead of the constructor to create a view, so that entries can be awaited asynchronously.
-  static async createView(sharedStorage: SharedStorageForOrigin, viewFunction?: ViewFunction):
-      Promise<SharedStorageItemsView> {
-    const view = new SharedStorageItemsView(sharedStorage, viewFunction);
-    await view.updateEntriesOnly();
-    return view;
-  }
-
-  async updateEntriesOnly(): Promise<void> {
-    const entries = await this.#sharedStorage.getEntries();
-    if (entries) {
-      this.#showSharedStorageItems(entries);
-    }
-  }
-
-  async #sharedStorageChanged(): Promise<void> {
-    await this.refreshItems();
-  }
-
-  override async refreshItems(): Promise<void> {
-    await this.metadataView?.render();
-    await this.updateEntriesOnly();
-    this.sharedStorageItemsDispatcher.dispatchEventToListeners(SharedStorageItemsDispatcher.Events.ITEMS_REFRESHED);
-  }
-
-  override async deleteAllItems(): Promise<void> {
-    if (!this.toolbar?.hasFilter()) {
-      await this.#sharedStorage.clear();
-      await this.refreshItems();
-      this.sharedStorageItemsDispatcher.dispatchEventToListeners(SharedStorageItemsDispatcher.Events.ITEMS_CLEARED);
-      UI.ARIAUtils.LiveAnnouncer.alert(i18nString(UIStrings.sharedStorageItemsCleared));
-      return;
-    }
-
-    await Promise.all(this.keys().map(key => this.#sharedStorage.deleteEntry(key)));
-
-    await this.refreshItems();
-    this.sharedStorageItemsDispatcher.dispatchEventToListeners(
-        SharedStorageItemsDispatcher.Events.FILTERED_ITEMS_CLEARED);
-    UI.ARIAUtils.LiveAnnouncer.alert(i18nString(UIStrings.sharedStorageFilteredItemsCleared));
-  }
-
-  protected override isEditAllowed(columnIdentifier: string, _oldText: string, newText: string): boolean {
-    if (columnIdentifier === 'key' && newText === '') {
-      // The Shared Storage backend does not currently allow '' as a key, so we only set a new entry with a new key if its new key is nonempty.
-      void this.refreshItems().then(() => {
-        UI.ARIAUtils.LiveAnnouncer.alert(i18nString(UIStrings.sharedStorageItemEditCanceled));
-      });
-      return false;
-    }
-    return true;
-  }
-
-  protected async setItem(key: string, value: string): Promise<void> {
-    await this.#sharedStorage.setEntry(key, value, false);
-
-    await this.refreshItems();
-    this.sharedStorageItemsDispatcher.dispatchEventToListeners(SharedStorageItemsDispatcher.Events.ITEM_EDITED);
-    UI.ARIAUtils.LiveAnnouncer.alert(i18nString(UIStrings.sharedStorageItemEdited));
-  }
-
-  #showSharedStorageItems(items: Protocol.Storage.SharedStorageEntry[]): void {
-    if (this.toolbar) {
-      const filteredList = items.filter(item => this.toolbar?.filterRegex?.test(`${item.key} ${item.value}`) ?? true);
-      this.showItems(filteredList);
-    }
-  }
-
-  protected async removeItem(key: string): Promise<void> {
-    await this.#sharedStorage.deleteEntry(key);
-    await this.refreshItems();
-    this.sharedStorageItemsDispatcher.dispatchEventToListeners(
-        SharedStorageItemsDispatcher.Events.ITEM_DELETED, {key} as SharedStorageItemsDispatcher.ItemDeletedEvent);
-    UI.ARIAUtils.LiveAnnouncer.alert(i18nString(UIStrings.sharedStorageItemDeleted));
-  }
-
-  protected async createPreview(key: string, value: string): Promise<UI.Widget.Widget|null> {
-    const wrappedEntry = key && {key, value: value || ''} as WrappedEntry;
-    return SourceFrame.JSONView.JSONView.createViewSync(wrappedEntry);
-  }
-}

package/front_end/panels/application/SharedStorageListTreeElement.ts

@@ -1,65 +0,0 @@
-// Copyright 2022 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 i18n from '../../core/i18n/i18n.js';
-import type * as Platform from '../../core/platform/platform.js';
-import type * as Protocol from '../../generated/protocol.js';
-import {createIcon} from '../../ui/kit/kit.js';
-
-import {ApplicationPanelTreeElement} from './ApplicationPanelTreeElement.js';
-import type {ResourcesPanel} from './ResourcesPanel.js';
-import {SharedStorageEventsView} from './SharedStorageEventsView.js';
-
-const UIStrings = {
-  /**
-   * @description Text in SharedStorage Category View of the Application panel
-   */
-  sharedStorage: 'Shared storage',
-} as const;
-const str_ = i18n.i18n.registerUIStrings('panels/application/SharedStorageListTreeElement.ts', UIStrings);
-const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
-
-export class SharedStorageListTreeElement extends ApplicationPanelTreeElement {
-  readonly #expandedSetting: Common.Settings.Setting<boolean>;
-  readonly view: SharedStorageEventsView;
-
-  constructor(resourcesPanel: ResourcesPanel, expandedSettingsDefault = false) {
-    super(resourcesPanel, i18nString(UIStrings.sharedStorage), false, 'shared-storage');
-    this.#expandedSetting =
-        Common.Settings.Settings.instance().createSetting('resources-shared-storage-expanded', expandedSettingsDefault);
-    const sharedStorageIcon = createIcon('database');
-    this.setLeadingIcons([sharedStorageIcon]);
-    this.view = new SharedStorageEventsView();
-  }
-
-  override get itemURL(): Platform.DevToolsPath.UrlString {
-    return 'shared-storage://' as Platform.DevToolsPath.UrlString;
-  }
-
-  override onselect(selectedByUser: boolean|undefined): boolean {
-    super.onselect(selectedByUser);
-    this.resourcesPanel.showView(this.view);
-    return false;
-  }
-
-  override onattach(): void {
-    super.onattach();
-    if (this.#expandedSetting.get()) {
-      this.expand();
-    }
-  }
-
-  override onexpand(): void {
-    this.#expandedSetting.set(true);
-  }
-
-  override oncollapse(): void {
-    this.#expandedSetting.set(false);
-  }
-
-  addEvent(event: Protocol.Storage.SharedStorageAccessedEvent): void {
-    this.view.addEvent(event);
-  }
-}

package/front_end/panels/application/SharedStorageModel.ts

@@ -1,249 +0,0 @@
-// Copyright 2022 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 SDK from '../../core/sdk/sdk.js';
-import type * as ProtocolProxyApi from '../../generated/protocol-proxy-api.js';
-import * as Protocol from '../../generated/protocol.js';
-
-export class SharedStorageForOrigin extends Common.ObjectWrapper.ObjectWrapper<SharedStorageForOrigin.EventTypes> {
-  readonly #model: SharedStorageModel;
-  readonly #securityOrigin: string;
-
-  constructor(model: SharedStorageModel, securityOrigin: string) {
-    super();
-    this.#model = model;
-    this.#securityOrigin = securityOrigin;
-  }
-
-  get securityOrigin(): string {
-    return this.#securityOrigin;
-  }
-
-  async getMetadata(): Promise<Protocol.Storage.SharedStorageMetadata|null> {
-    return await this.#model.storageAgent.invoke_getSharedStorageMetadata({ownerOrigin: this.securityOrigin})
-        .then(({metadata}) => metadata);
-  }
-
-  async getEntries(): Promise<Protocol.Storage.SharedStorageEntry[]|null> {
-    return await this.#model.storageAgent.invoke_getSharedStorageEntries({ownerOrigin: this.securityOrigin})
-        .then(({entries}) => entries);
-  }
-
-  async setEntry(key: string, value: string, ignoreIfPresent: boolean): Promise<void> {
-    await this.#model.storageAgent.invoke_setSharedStorageEntry(
-        {ownerOrigin: this.securityOrigin, key, value, ignoreIfPresent});
-  }
-
-  async deleteEntry(key: string): Promise<void> {
-    await this.#model.storageAgent.invoke_deleteSharedStorageEntry({ownerOrigin: this.securityOrigin, key});
-  }
-
-  async clear(): Promise<void> {
-    await this.#model.storageAgent.invoke_clearSharedStorageEntries({ownerOrigin: this.securityOrigin});
-  }
-
-  async resetBudget(): Promise<void> {
-    await this.#model.storageAgent.invoke_resetSharedStorageBudget({ownerOrigin: this.securityOrigin});
-  }
-}
-
-export namespace SharedStorageForOrigin {
-  export const enum Events {
-    SHARED_STORAGE_CHANGED = 'SharedStorageChanged',
-  }
-
-  export interface SharedStorageChangedEvent {
-    accessTime: Protocol.Network.TimeSinceEpoch;
-    scope: Protocol.Storage.SharedStorageAccessScope;
-    method: Protocol.Storage.SharedStorageAccessMethod;
-    mainFrameId: Protocol.Page.FrameId;
-    ownerSite: string;
-    params: Protocol.Storage.SharedStorageAccessParams;
-  }
-
-  export interface EventTypes {
-    [Events.SHARED_STORAGE_CHANGED]: SharedStorageChangedEvent;
-  }
-}
-
-export class SharedStorageModel extends SDK.SDKModel.SDKModel<EventTypes> implements
-    ProtocolProxyApi.StorageDispatcher {
-  readonly #securityOriginManager: SDK.SecurityOriginManager.SecurityOriginManager;
-  #storages: Map<string, SharedStorageForOrigin>;
-  readonly storageAgent: ProtocolProxyApi.StorageApi;
-  #enabled: boolean;
-
-  constructor(target: SDK.Target.Target) {
-    super(target);
-    target.registerStorageDispatcher(this);
-    this.#securityOriginManager = target.model(SDK.SecurityOriginManager.SecurityOriginManager) as
-        SDK.SecurityOriginManager.SecurityOriginManager;
-    this.#storages = new Map();
-    this.storageAgent = target.storageAgent();
-    this.#enabled = false;
-  }
-
-  async enable(): Promise<void> {
-    if (this.#enabled) {
-      return;
-    }
-
-    this.#securityOriginManager.addEventListener(
-        SDK.SecurityOriginManager.Events.SecurityOriginAdded, this.#securityOriginAdded, this);
-    this.#securityOriginManager.addEventListener(
-        SDK.SecurityOriginManager.Events.SecurityOriginRemoved, this.#securityOriginRemoved, this);
-
-    await this.storageAgent.invoke_setSharedStorageTracking({enable: true});
-    this.#addAllOrigins();
-    this.#enabled = true;
-  }
-
-  disable(): void {
-    if (!this.#enabled) {
-      return;
-    }
-
-    this.#securityOriginManager.removeEventListener(
-        SDK.SecurityOriginManager.Events.SecurityOriginAdded, this.#securityOriginAdded, this);
-    this.#securityOriginManager.removeEventListener(
-        SDK.SecurityOriginManager.Events.SecurityOriginRemoved, this.#securityOriginRemoved, this);
-
-    void this.storageAgent.invoke_setSharedStorageTracking({enable: false});
-    this.#removeAllOrigins();
-    this.#enabled = false;
-  }
-
-  override dispose(): void {
-    this.disable();
-  }
-
-  #addAllOrigins(): void {
-    for (const securityOrigin of this.#securityOriginManager.securityOrigins()) {
-      void this.#maybeAddOrigin(securityOrigin);
-    }
-  }
-
-  #removeAllOrigins(): void {
-    for (const securityOrigin of this.#storages.keys()) {
-      this.#removeOrigin(securityOrigin);
-    }
-  }
-
-  #securityOriginAdded(event: Common.EventTarget.EventTargetEvent<string>): void {
-    this.#maybeAddOrigin(event.data);
-  }
-
-  #maybeAddOrigin(securityOrigin: string): void {
-    const parsedSecurityOrigin = new Common.ParsedURL.ParsedURL(securityOrigin);
-    // These are "opaque" origins which are not supposed to support shared storage.
-    if (!parsedSecurityOrigin.isValid || parsedSecurityOrigin.scheme === 'data' ||
-        parsedSecurityOrigin.scheme === 'about' || parsedSecurityOrigin.scheme === 'javascript') {
-      return;
-    }
-
-    // Only add origin if it's not already added.
-    if (this.#storages.has(securityOrigin)) {
-      return;
-    }
-
-    const storage = new SharedStorageForOrigin(this, securityOrigin);
-    this.#storages.set(securityOrigin, storage);
-    this.dispatchEventToListeners(Events.SHARED_STORAGE_ADDED, storage);
-  }
-
-  #securityOriginRemoved(event: Common.EventTarget.EventTargetEvent<string>): void {
-    this.#removeOrigin(event.data);
-  }
-
-  #removeOrigin(securityOrigin: string): void {
-    const storage = this.storageForOrigin(securityOrigin);
-    if (!storage) {
-      return;
-    }
-    this.#storages.delete(securityOrigin);
-    this.dispatchEventToListeners(Events.SHARED_STORAGE_REMOVED, storage);
-  }
-
-  storages(): IterableIterator<SharedStorageForOrigin> {
-    return this.#storages.values();
-  }
-
-  storageForOrigin(origin: string): SharedStorageForOrigin|null {
-    return this.#storages.get(origin) || null;
-  }
-
-  numStoragesForTesting(): number {
-    return this.#storages.size;
-  }
-
-  isChangeEvent(event: Protocol.Storage.SharedStorageAccessedEvent): boolean {
-    return [
-      Protocol.Storage.SharedStorageAccessMethod.Set,
-      Protocol.Storage.SharedStorageAccessMethod.Append,
-      Protocol.Storage.SharedStorageAccessMethod.Delete,
-      Protocol.Storage.SharedStorageAccessMethod.Clear,
-    ].includes(event.method);
-  }
-
-  sharedStorageAccessed(event: Protocol.Storage.SharedStorageAccessedEvent): void {
-    if (this.isChangeEvent(event)) {
-      const sharedStorage = this.storageForOrigin(event.ownerOrigin);
-
-      if (sharedStorage) {
-        const eventData = {
-          accessTime: event.accessTime,
-          method: event.method,
-          mainFrameId: event.mainFrameId,
-          ownerSite: event.ownerSite,
-          params: event.params,
-          scope: event.scope,
-        };
-
-        // Forward events that may have changed `sharedStorage` to listeners for `sharedStorage`.
-        sharedStorage.dispatchEventToListeners(SharedStorageForOrigin.Events.SHARED_STORAGE_CHANGED, eventData);
-      } else {
-        void this.#maybeAddOrigin(event.ownerOrigin);
-      }
-    }
-
-    this.dispatchEventToListeners(Events.SHARED_STORAGE_ACCESS, event);
-  }
-
-  sharedStorageWorkletOperationExecutionFinished(
-      _event: Protocol.Storage.SharedStorageWorkletOperationExecutionFinishedEvent): void {
-  }
-
-  indexedDBListUpdated(_event: Protocol.Storage.IndexedDBListUpdatedEvent): void {
-  }
-
-  indexedDBContentUpdated(_event: Protocol.Storage.IndexedDBContentUpdatedEvent): void {
-  }
-
-  cacheStorageListUpdated(_event: Protocol.Storage.CacheStorageListUpdatedEvent): void {
-  }
-
-  cacheStorageContentUpdated(_event: Protocol.Storage.CacheStorageContentUpdatedEvent): void {
-  }
-
-  storageBucketCreatedOrUpdated(_event: Protocol.Storage.StorageBucketCreatedOrUpdatedEvent): void {
-  }
-
-  storageBucketDeleted(_event: Protocol.Storage.StorageBucketDeletedEvent): void {
-  }
-}
-
-SDK.SDKModel.SDKModel.register(SharedStorageModel, {capabilities: SDK.Target.Capability.STORAGE, autostart: false});
-
-export const enum Events {
-  SHARED_STORAGE_ACCESS = 'SharedStorageAccess',
-  SHARED_STORAGE_ADDED = 'SharedStorageAdded',
-  SHARED_STORAGE_REMOVED = 'SharedStorageRemoved',
-}
-
-export interface EventTypes {
-  [Events.SHARED_STORAGE_ACCESS]: Protocol.Storage.SharedStorageAccessedEvent;
-  [Events.SHARED_STORAGE_ADDED]: SharedStorageForOrigin;
-  [Events.SHARED_STORAGE_REMOVED]: SharedStorageForOrigin;
-}

package/front_end/panels/application/SharedStorageTreeElement.ts

@@ -1,40 +0,0 @@
-// Copyright 2022 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 Platform from '../../core/platform/platform.js';
-import {createIcon} from '../../ui/kit/kit.js';
-import * as VisualLogging from '../../ui/visual_logging/visual_logging.js';
-
-import {ApplicationPanelTreeElement} from './ApplicationPanelTreeElement.js';
-import type {ResourcesPanel} from './ResourcesPanel.js';
-import {SharedStorageItemsView} from './SharedStorageItemsView.js';
-import type {SharedStorageForOrigin} from './SharedStorageModel.js';
-
-export class SharedStorageTreeElement extends ApplicationPanelTreeElement {
-  view!: SharedStorageItemsView;
-
-  constructor(resourcesPanel: ResourcesPanel, sharedStorage: SharedStorageForOrigin) {
-    super(resourcesPanel, sharedStorage.securityOrigin, false, 'shared-storage-instance');
-  }
-
-  static async createElement(resourcesPanel: ResourcesPanel, sharedStorage: SharedStorageForOrigin):
-      Promise<SharedStorageTreeElement> {
-    const treeElement = new SharedStorageTreeElement(resourcesPanel, sharedStorage);
-    treeElement.view = await SharedStorageItemsView.createView(sharedStorage);
-    treeElement.view.element.setAttribute('jslog', `${VisualLogging.pane('shared-storage-data')}`);
-    const sharedStorageIcon = createIcon('database');
-    treeElement.setLeadingIcons([sharedStorageIcon]);
-    return treeElement;
-  }
-
-  override get itemURL(): Platform.DevToolsPath.UrlString {
-    return 'shared-storage://' as Platform.DevToolsPath.UrlString;
-  }
-
-  override onselect(selectedByUser: boolean|undefined): boolean {
-    super.onselect(selectedByUser);
-    this.resourcesPanel.showView(this.view);
-    return false;
-  }
-}