chrome-devtools-frontend 1.0.1672557 → 1.0.1675430

package/.agents/skills/devtools-ux-writing-refactor/SKILL.md

@@ -59,14 +59,16 @@ Locate all TypeScript files in the target folder that define `const UIStrings =
    * For panel names that consist of two words, capitalize only the first word (for example, `Developer resources panel`).
    * When you use the panel name in combination with another word, capitalize the panel name but not the other word, unless it is a proper noun (for example, `Console view` or `DevTools Console`).
    * In some cases, ambiguity exists whether a word refers to a UX element in DevTools (such as a panel name) or a concept (such as developer terminology). For example, this occurs with `console`, `issue`, or `network`. Decide based on the surrounding context and code (for example, `Console view`, `Console sidebar`, and `Console prompt` versus `console message`, `console warning`, `console log`, `copy console`, `clear console`, and `console history`; `Show Network` versus `network log` and `network filter`).
+   * **Casing in `@description` comments:** Apply the same capitalization rules to `@description` comments: ONLY panel names use sentence case (for example, `Memory panel`, `Console panel`, `Performance panel`). Feature names, view names, tool names, and sub-components MUST be all lowercase unless they appear at the very start of the description sentence or phrase (for example, `heap profiler`, `heap snapshot view`, `isolate selector`, `allocation sampling`, `command menu`, `summary view`).
 6. **Punctuation and actionability:** Remove trailing periods from single-sentence labels or titles. Ensure that error messages instruct the user how to recover (for example, `Shorten filename to 64 characters or less` instead of `Invalid filename`). Ensure that ARIA labels and multi-sentence tooltips have consistent terminal punctuation.
 7. **Terminology (glossary):** Strictly follow standard DevTools UI terminology and letter casing (`panel`, `tab`, `drawer`, `sidebar`, `datagrid` or `table`, `action bar`, `status bar`, and `live expressions section`). Never use `pane` or call tabs `panes` in UI strings or localization (L10n) comments.
 8. **Localization (L10n) comments:** Ensure that every string in `UIStrings` has a preceding `@description` comment that explains where and when it appears. This information is used for translators who need to understand the context in which the string is used.
+   * **Research usage sites:** Before modifying or writing `@description` comments, always research where the string key (for example, `UIStrings.keyName`) is used in the codebase (`grep_search` or view surrounding code). Determine the exact UI element type (for example, button label, tooltip, table column header, context menu item, checkbox label, aria label, status bar message, or dropdown option) and location (panel, view, sidebar, or dialog).
+   * **Avoid redundancy and repetition:** Do not simply repeat or restate the UI string value in the description (for example, avoid `@description Text for clear all profiles` for `'Clear all profiles'`). Instead, describe the UI role, element type, and location (for example, `@description Tooltip text for the clear button in the profiles sidebar of the Memory panel.`).
+   * **Consistency across similar descriptions:** Ensure consistent phrasing structure across descriptions of similar UI strings in the same module and throughout DevTools (for example, use uniform patterns like `Tooltip text for the <action> button in <location>.` or `Column header in <table_name> datagrid for <purpose>.`).
+   * **Casing in descriptions:** Strictly follow the rule that ONLY panel names use sentence case (for example, `Memory panel`, `Console panel`, `Profiles panel`), while feature names, views, tools, and sub-components are ALL LOWERCASE (for example, `heap profiler`, `heap snapshot view`, `isolate selector`, `allocation sampling`, `summary view`), unless appearing at the start of the description sentence or phrase.
    * **Straight apostrophes in comments:** Always use straight apostrophes (`'`) in code comments (such as `@description` comments and L10n annotations), even if the UI string itself uses curly apostrophes (`’`).
-   * Use precise terminology and correct letter casing (see rule 7). Ensure that the description is easy to understand and provides enough context for translators. For descriptions that are underspecified or
-   ambiguous, figure out the context by looking at the use site of the
-   string and come up with a better description.
-   * You must explicitly document all standard placeholders (`{PH1}`, `{url}`, `{index}`) with runtime data examples (for example, `@example {https://example.com} url`).
+   * **Placeholders:** You must explicitly document all standard placeholders (`{PH1}`, `{url}`, `{index}`) with runtime data examples (for example, `@example {https://example.com} url`).
    * *ICU plural variables:* The i18n tool automatically parses variables in ICU plural format (such as `n` in `{n, plural, =0 {No issues} ...}`) as numeric counts, so they don’t require an `@example` tag in the `@description` comment.
    * *Terminal punctuation:* Every `@description` comment must end with a period (`.`), even if it is a single phrase or sentence.
 
@@ -74,11 +76,26 @@ Locate all TypeScript files in the target folder that define `const UIStrings =
 
 Also consult the style guides at `google3/experimental/users/rachelandrew/tools/chrome_writing/knowledge/style/` for applicable guidelines.
 
-## 5. Pause for confirmation
+## 5. Subagent critique of proposed changes
+
+Before running tests or pausing for user review, enter an iterative critique loop with a subagent:
+1. **Invoke subagent:** Use `invoke_subagent` with `TypeName: "self"` and `Role: "UX Writing Reviewer"`.
+2. **Prompt instructions:** Provide the subagent with the `git diff` of your changes and instruct it to critique the refactoring against the **8-point UX writing checklist**:
+   - Are `@description` comments specific, informative, and non-redundant (not restating string values)?
+   - Are usage sites researched so the UI element type and location are accurately described?
+   - Do `@description` comments and string values strictly follow the casing rule (ONLY panel names in sentence case, feature/view names in all lowercase unless starting a phrase)?
+   - Are contractions, curly apostrophes, ellipses, and placeholders (`{PH1}`) correctly formatted?
+   - Were all references in sibling code/tests properly updated?
+3. **Address feedback and loop:**
+   - If the subagent raises any feedback, concerns, or suggested fixes, apply the necessary code changes.
+   - Re-invoke the subagent with the updated `git diff` to re-critique the changes.
+   - **Repeat this loop continuously as long as the subagent has feedback, until the subagent explicitly approves the diff with no remaining issues.**
+
+## 6. Pause for confirmation
 
 Ask the user for a preliminary review of the proposed changes before proceeding. If the user has feedback, address feedback and pause again for confirmation.
 
-## 6. Mandatory verification and testing
+## 7. Mandatory verification and testing
 
 Don’t finish an edit without running the linter and test suite. In DevTools, i18n placeholder changes or string edits can easily break tests or linter rules.
 
@@ -89,18 +106,18 @@ Don’t finish an edit without running the linter and test suite. In DevTools, i
    npm run lint -- <folder_path>
    ```
 3. **Run unit tests**
-   Run unit tests for the target folder first for fast feedback. Then, run the full test suite to verify that no cross-module regressions or snapshot failures occurred:
+   You MUST run the full test suite using `npm run test` to verify that no cross-module regressions, e2e test failures, or snapshot regressions occurred. Do not only run a subset of tests:
    ```bash
-   npm run test -- <folder_path>
    npm run test
    ```
+   *(Optionally, you may run `npm run test -- <folder_path>` first for rapid initial feedback during iterative development, but running `npm run test` for full test suite coverage is required before completing the task.)*
 4. **Run presubmit checks**
    Ensure that you commit or stage all changes before you run presubmit checks:
    ```bash
    git cl presubmit -u
    ```
 
-## 7. Summarize changes and upload the CL
+## 8. Summarize changes and upload the CL
 
 When all tests and presubmit checks pass, commit your changes and upload the CL to Gerrit. Don’t use `[uxw]` as a prefix.
 

package/front_end/core/common/ParsedURL.ts

@@ -533,7 +533,11 @@ export class ParsedURL {
       return 'data:' as Platform.DevToolsPath.UrlString;
     }
     const scheme = this.isBlobURL() ? this.blobInnerScheme : this.scheme;
-    return scheme + '://' + this.domain() as Platform.DevToolsPath.UrlString;
+    const domain = this.domain();
+    if (!scheme && !domain) {
+      return '' as Platform.DevToolsPath.UrlString;
+    }
+    return scheme + '://' + domain as Platform.DevToolsPath.UrlString;
   }
 
   urlWithoutScheme(): string {

package/front_end/core/common/SettingRegistration.ts

@@ -4,7 +4,6 @@
 
 import * as i18n from '../i18n/i18n.js';
 import type * as Platform from '../platform/platform.js';
-import * as Root from '../root/root.js';
 
 import type {SettingStorageType} from './Settings.js';
 
@@ -78,44 +77,60 @@ const UIStrings = {
    * section allows users to see their signed-in account and configure which DevTools data is synced via Chrome Sync.
    */
   account: 'Account',
-  /**
-   * @description Title of the Privacy setting category.
-   */
-  privacy: 'Privacy',
 } as const;
 const str_ = i18n.i18n.registerUIStrings('core/common/SettingRegistration.ts', UIStrings);
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 let registeredSettings: SettingRegistration[] = [];
 const settingNameSet = new Set<string>();
+const orderValuesBySettingCategory = new Map<SettingCategory, Set<number>>();
+
+export function registerCategoryOrder(category?: SettingCategory, order?: number): void {
+  if (category && typeof order === 'number') {
+    let orderValues = orderValuesBySettingCategory.get(category);
+    if (!orderValues) {
+      orderValues = new Set();
+      orderValuesBySettingCategory.set(category, orderValues);
+    }
+    if (orderValues.has(order)) {
+      throw new Error(`Duplicate order value '${order}' for settings category '${category}'`);
+    }
+    orderValues.add(order);
+  }
+}
+
+export function removeCategoryOrder(category?: SettingCategory, order?: number): void {
+  if (category && typeof order === 'number') {
+    orderValuesBySettingCategory.get(category)?.delete(order);
+  }
+}
 
 export function registerSettingExtension(registration: SettingRegistration): void {
   const settingName = registration.settingName;
   if (settingNameSet.has(settingName)) {
     throw new Error(`Duplicate setting name '${settingName}'`);
   }
+  registerCategoryOrder(registration.category, registration.order);
   settingNameSet.add(settingName);
   registeredSettings.push(registration);
 }
 
 export function getRegisteredSettings(): SettingRegistration[] {
-  return registeredSettings.filter(setting => Root.Runtime.Runtime.isDescriptorEnabled(setting));
+  return registeredSettings;
 }
 
 export function registerSettingsForTest(settings: SettingRegistration[], forceReset = false): void {
   if (registeredSettings.length === 0 || forceReset) {
-    registeredSettings = settings;
-    settingNameSet.clear();
+    resetSettings();
     for (const setting of settings) {
-      const settingName = setting.settingName;
-      if (settingNameSet.has(settingName)) {
-        throw new Error(`Duplicate setting name '${settingName}'`);
-      }
-      settingNameSet.add(settingName);
+      registerSettingExtension(setting);
     }
   }
 }
 
 export function resetSettings(): void {
+  for (const setting of registeredSettings) {
+    removeCategoryOrder(setting.category, setting.order);
+  }
   registeredSettings = [];
   settingNameSet.clear();
 }
@@ -125,7 +140,8 @@ export function maybeRemoveSettingExtension(settingName: string): boolean {
   if (settingIndex < 0 || !settingNameSet.delete(settingName)) {
     return false;
   }
-  registeredSettings.splice(settingIndex, 1);
+  const [removed] = registeredSettings.splice(settingIndex, 1);
+  removeCategoryOrder(removed.category, removed.order);
   return true;
 }
 
@@ -149,7 +165,6 @@ export const enum SettingCategory {
   EXTENSIONS = 'EXTENSIONS',
   ADORNER = 'ADORNER',
   ACCOUNT = 'ACCOUNT',
-  PRIVACY = 'PRIVACY',
 }
 
 export function getLocalizedSettingsCategory(category: SettingCategory): Platform.UIString.LocalizedString {
@@ -192,8 +207,6 @@ export function getLocalizedSettingsCategory(category: SettingCategory): Platfor
       return i18n.i18n.lockedString('');
     case SettingCategory.ACCOUNT:
       return i18nString(UIStrings.account);
-    case SettingCategory.PRIVACY:
-      return i18nString(UIStrings.privacy);
   }
 }
 
@@ -268,19 +281,6 @@ export interface SettingRegistration {
    * Determines if the setting value is stored in the global, local or session storage.
    */
   storageType?: SettingStorageType;
-  /**
-   * A condition is a function that will make the setting available if it
-   * returns true, and not available, otherwise. Make sure that objects you
-   * access from inside the condition function are ready at the time when the
-   * setting conditions are checked.
-   */
-  condition?: Root.Runtime.Condition;
-
-  /**
-   * A function that returns true if the setting should be disabled, along with
-   * the reason why.
-   */
-  disabledCondition?: (config?: Root.Runtime.HostConfig) => DisabledConditionResult;
 
   /**
    * See {@link LearnMore} for more info.
@@ -319,7 +319,3 @@ interface RawSettingExtensionOption {
   raw: true;
 }
 export type SettingExtensionOption = LocalizedSettingExtensionOption|RawSettingExtensionOption;
-export type DisabledConditionResult = {
-  disabled: true,
-  reasons: Platform.UIString.LocalizedString[],
-}|{disabled: false};

package/front_end/core/common/Settings.ts

@@ -112,7 +112,6 @@ export class Settings {
   readonly #settingRegistrations: SettingRegistration[];
   readonly #sessionStorage = new SettingsStorage({});
   settingNameSet = new Set<string>();
-  orderValuesBySettingCategory = new Map<SettingCategory, Set<number>>();
   #eventSupport = new ObjectWrapper<GenericEvents>();
   #registry = new Map<string, Setting<unknown>>();
   readonly moduleSettings = new Map<string, Setting<unknown>>();
@@ -215,19 +214,9 @@ export class Settings {
 
   private registerModuleSetting(setting: Setting<unknown>): void {
     const settingName = setting.name;
-    const category = setting.category();
-    const order = setting.order();
     if (this.settingNameSet.has(settingName)) {
       throw new Error(`Duplicate Setting name '${settingName}'`);
     }
-    if (category && order) {
-      const orderValues = this.orderValuesBySettingCategory.get(category) || new Set();
-      if (orderValues.has(order)) {
-        throw new Error(`Duplicate order value '${order}' for settings category '${category}'`);
-      }
-      orderValues.add(order);
-      this.orderValuesBySettingCategory.set(category, orderValues);
-    }
     this.settingNameSet.add(settingName);
     this.moduleSettings.set(setting.name, setting);
   }
@@ -499,10 +488,7 @@ export class Setting<V> {
   #type: SettingType|null = null;
   #requiresUserAction?: boolean;
   #value?: V;
-  // TODO(crbug.com/1172300) Type cannot be inferred without changes to consumers. See above.
-  #serializer: Serializer<unknown, V> = JSON;
   #hadUserAction?: boolean;
-  #disabled?: boolean;
   #loggedInitialAccess = false;
   #logSettingAccess?: (name: string, value: number|string|boolean) => Promise<void>;
   readonly #console: Console;
@@ -515,10 +501,6 @@ export class Setting<V> {
     this.#logSettingAccess = logSettingAccess;
   }
 
-  setSerializer(serializer: Serializer<unknown, V>): void {
-    this.#serializer = serializer;
-  }
-
   descriptor(): SettingDescriptor<V> {
     return {
       name: this.name,
@@ -547,38 +529,11 @@ export class Setting<V> {
     this.#requiresUserAction = requiresUserAction;
   }
 
-  disabled(): boolean {
-    if (this.#registration?.disabledCondition) {
-      const {disabled} = this.#registration.disabledCondition(Root.Runtime.hostConfig);
-      // If registration does not disable it, pass through to #disabled
-      // attribute check.
-      if (disabled) {
-        return true;
-      }
-    }
-    return this.#disabled || false;
-  }
-
-  disabledReasons(): Platform.UIString.LocalizedString[] {
-    if (this.#registration?.disabledCondition) {
-      const result = this.#registration.disabledCondition(Root.Runtime.hostConfig);
-      if (result.disabled) {
-        return result.reasons;
-      }
-    }
-    return [];
-  }
-
-  setDisabled(disabled: boolean): void {
-    this.#disabled = disabled;
-    this.eventSupport.dispatchEventToListeners(this.name);
-  }
-
   #maybeLogAccess(value: V): void {
     try {
       const valueToLog = typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean' ?
           value :
-          this.#serializer?.stringify(value);
+          JSON.stringify(value);
       if (valueToLog !== undefined && this.#logSettingAccess) {
         void this.#logSettingAccess(this.name, valueToLog);
       }
@@ -607,7 +562,7 @@ export class Setting<V> {
     this.#value = this.defaultValue;
     if (this.storage.has(this.name)) {
       try {
-        this.#value = this.#serializer.parse(this.storage.get(this.name));
+        this.#value = JSON.parse(this.storage.get(this.name)) as V;
       } catch {
         this.storage.remove(this.name);
       }
@@ -616,16 +571,6 @@ export class Setting<V> {
     return this.#value;
   }
 
-  // Prefer this getter for settings which are "disableable". The plain getter returns `this.#value`,
-  // even if the setting is disabled, which means the callsite has to explicitly call the `disabled()`
-  // getter and add its own logic for the disabled state.
-  getIfNotDisabled(): V|undefined {
-    if (this.disabled()) {
-      return;
-    }
-    return this.get();
-  }
-
   async forceGet(): Promise<V> {
     const name = this.name;
     const oldValue = this.storage.get(name);
@@ -633,7 +578,7 @@ export class Setting<V> {
     this.#value = this.defaultValue;
     if (value) {
       try {
-        this.#value = this.#serializer.parse(value);
+        this.#value = JSON.parse(value) as V;
       } catch {
         this.storage.remove(this.name);
       }
@@ -652,7 +597,7 @@ export class Setting<V> {
     this.#hadUserAction = true;
     this.#value = value;
     try {
-      const settingString = this.#serializer.stringify(value);
+      const settingString = JSON.stringify(value);
       try {
         this.storage.set(this.name, settingString);
       } catch (e) {
@@ -822,11 +767,6 @@ export {
   SettingType,
 };
 
-export interface Serializer<I, O> {
-  stringify: (value: I) => string;
-  parse: (value: string) => O;
-}
-
 export interface SimpleSettingOption {
   value: string|boolean;
   title: string;