front_end/core/sdk/StorageKeyManager.ts

// 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 '../common/common.js';
import type * as Platform from '../platform/platform.js';

import {SDKModel} from './SDKModel.js';
import {Capability, type Target} from './Target.js';

export class StorageKeyManager extends SDKModel<EventTypes> {
  #mainStorageKey: string;
  #storageKeys: Set<string>;
  constructor(target: Target) {
    super(target);

    this.#mainStorageKey = '';
    this.#storageKeys = new Set();
  }

  updateStorageKeys(storageKeys: Set<string>): void {
    const oldStorageKeys = this.#storageKeys;
    this.#storageKeys = storageKeys;

    for (const storageKey of oldStorageKeys) {
      if (!this.#storageKeys.has(storageKey)) {
        this.dispatchEventToListeners(Events.STORAGE_KEY_REMOVED, storageKey);
      }
    }

    for (const storageKey of this.#storageKeys) {
      if (!oldStorageKeys.has(storageKey)) {
        this.dispatchEventToListeners(Events.STORAGE_KEY_ADDED, storageKey);
      }
    }
  }

  storageKeys(): string[] {
    return [...this.#storageKeys];
  }

  mainStorageKey(): string {
    return this.#mainStorageKey;
  }

  setMainStorageKey(storageKey: string): void {
    this.#mainStorageKey = storageKey;
    this.dispatchEventToListeners(Events.MAIN_STORAGE_KEY_CHANGED, {
      mainStorageKey: this.#mainStorageKey,
    });
  }
}

export function parseStorageKey(storageKeyString: string): StorageKey {
  // Based on the canonical implementation of StorageKey::Deserialize in
  // third_party/blink/common/storage_key/storage_key.cc
  const components = storageKeyString.split('^');
  const origin = Common.ParsedURL.ParsedURL.extractOrigin(components[0] as Platform.DevToolsPath.UrlString);
  const storageKey = {origin, components: new Map<StorageKeyComponent, string>()};
  for (let i = 1; i < components.length; ++i) {
    storageKey.components.set(components[i].charAt(0) as StorageKeyComponent, components[i].substring(1));
  }
  return storageKey;
}

export const enum StorageKeyComponent {
  TOP_LEVEL_SITE = '0',
  NONCE_HIGH = '1',
  NONCE_LOW = '2',
  ANCESTOR_CHAIN_BIT = '3',
  TOP_LEVEL_SITE_OPAQUE_NONCE_HIGH = '4',
  TOP_LEVEL_SITE_OPAQUE_NONCE_LOW = '5',
  TOP_LEVEL_SITE_OPAQUE_NONCE_PRECURSOR = '6',
}

export interface StorageKey {
  origin: Platform.DevToolsPath.UrlString;
  components: Map<StorageKeyComponent, string>;
}

export const enum Events {
  STORAGE_KEY_ADDED = 'StorageKeyAdded',
  STORAGE_KEY_REMOVED = 'StorageKeyRemoved',
  MAIN_STORAGE_KEY_CHANGED = 'MainStorageKeyChanged',
}

export interface MainStorageKeyChangedEvent {
  mainStorageKey: string;
}

export interface EventTypes {
  [Events.STORAGE_KEY_ADDED]: string;
  [Events.STORAGE_KEY_REMOVED]: string;
  [Events.MAIN_STORAGE_KEY_CHANGED]: MainStorageKeyChangedEvent;
}

// TODO(jarhar): this is the one of the two usages of Capability.None. Do something about it!
SDKModel.register(StorageKeyManager, {capabilities: Capability.NONE, autostart: false});