front_end/ui/settings/SettingUIRegistration.test.ts

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

import {assert} from 'chai';

import * as Common from '../../core/common/common.js';
import * as i18n from '../../core/i18n/i18n.js';

import * as SettingsUI from './settings.js';

describe('SettingUIRegistration', () => {
  beforeEach(() => {
    SettingsUI.SettingUIRegistration.resetSettings();
    Common.SettingRegistration.resetSettings();
  });
  afterEach(() => {
    SettingsUI.SettingUIRegistration.resetSettings();
    Common.SettingRegistration.resetSettings();
  });

  const settingDescriptor: Common.Settings.SettingDescriptor<boolean> = {
    name: 'mock-setting',
    type: Common.Settings.SettingType.BOOLEAN,
    defaultValue: false,
  };

  it('registers a setting UI descriptor', () => {
    SettingsUI.SettingUIRegistration.register(settingDescriptor, {
      category: Common.SettingRegistration.SettingCategory.GLOBAL,
    });

    const registered = SettingsUI.SettingUIRegistration.getRegisteredSettings();
    assert.lengthOf(registered, 1);
    assert.strictEqual(registered[0].descriptor.name, 'mock-setting');
    assert.strictEqual(registered[0].uiDescriptor.category, Common.SettingRegistration.SettingCategory.GLOBAL);
  });

  it('includes synthesized legacy settings in getRegisteredSettings', () => {
    Common.SettingRegistration.registerSettingExtension({
      settingName: 'legacy-setting',
      settingType: Common.SettingRegistration.SettingType.BOOLEAN,
      defaultValue: true,
      category: Common.SettingRegistration.SettingCategory.CONSOLE,
    });

    const registered = SettingsUI.SettingUIRegistration.getRegisteredSettings();
    const legacyReg = registered.find(r => r.descriptor.name === 'legacy-setting');
    assert.exists(legacyReg);
    assert.strictEqual(legacyReg?.descriptor.name, 'legacy-setting');
    assert.strictEqual(legacyReg?.descriptor.type, Common.SettingRegistration.SettingType.BOOLEAN);
    assert.strictEqual(legacyReg?.uiDescriptor.category, Common.SettingRegistration.SettingCategory.CONSOLE);
  });

  it('throws an error when trying to register a duplicate setting name', () => {
    SettingsUI.SettingUIRegistration.register(settingDescriptor, {});

    assert.throws(() => {
      SettingsUI.SettingUIRegistration.register(settingDescriptor, {});
    }, 'Duplicate setting name \'mock-setting\'');
  });

  it('resolves a registered setting UI descriptor to a SettingUI instance with accessors', () => {
    const uiDescriptor: SettingsUI.SettingUIRegistration.SettingUIDescriptor = {
      category: Common.SettingRegistration.SettingCategory.GLOBAL,
      order: 10,
      title: () => i18n.i18n.lockedString('Mock Setting Title'),
      tags: [() => i18n.i18n.lockedString('tag1'), () => i18n.i18n.lockedString('tag2')],
      options: [{value: 'val1', title: () => i18n.i18n.lockedString('Option 1')}],
      reloadRequired: true,
    };
    SettingsUI.SettingUIRegistration.register(settingDescriptor, uiDescriptor);

    const resolved = SettingsUI.SettingUIRegistration.resolve(settingDescriptor);
    assert.instanceOf(resolved, SettingsUI.SettingUIRegistration.SettingUI);
    assert.strictEqual(resolved.category, Common.SettingRegistration.SettingCategory.GLOBAL);
    assert.strictEqual(resolved.order, 10);
    assert.strictEqual(resolved.title, 'Mock Setting Title');
    assert.strictEqual(resolved.tags, 'tag1\0tag2');
    assert.deepEqual(resolved.options,
                     [{value: 'val1', title: i18n.i18n.lockedString('Option 1'), text: undefined, raw: undefined}]);
    assert.isTrue(resolved.reloadRequired);
  });

  it('resolves legacy setting registrations to SettingUI', () => {
    Common.SettingRegistration.registerSettingExtension({
      settingName: 'legacy-setting',
      settingType: Common.SettingRegistration.SettingType.BOOLEAN,
      defaultValue: true,
      category: Common.SettingRegistration.SettingCategory.CONSOLE,
    });

    const resolved = SettingsUI.SettingUIRegistration.resolve({
      name: 'legacy-setting',
      type: Common.Settings.SettingType.BOOLEAN,
      defaultValue: true,
    });
    assert.instanceOf(resolved, SettingsUI.SettingUIRegistration.SettingUI);
    assert.strictEqual(resolved.category, Common.SettingRegistration.SettingCategory.CONSOLE);
  });

  it('throws an error when resolving an unregistered setting descriptor', () => {
    assert.throws(() => {
      SettingsUI.SettingUIRegistration.resolve(settingDescriptor);
    }, 'No UI descriptor registered for setting \'mock-setting\'');
  });

  it('returns null when maybeResolve is called for an unregistered setting descriptor', () => {
    assert.isNull(SettingsUI.SettingUIRegistration.maybeResolve(settingDescriptor));
  });

  it('throws an error when trying to register a duplicate order value for the same category', () => {
    SettingsUI.SettingUIRegistration.register(settingDescriptor, {
      category: Common.SettingRegistration.SettingCategory.GLOBAL,
      order: 1,
    });

    const otherDescriptor: Common.Settings.SettingDescriptor<boolean> = {
      name: 'other-setting',
      type: Common.Settings.SettingType.BOOLEAN,
      defaultValue: false,
    };

    assert.throws(() => {
      SettingsUI.SettingUIRegistration.register(otherDescriptor, {
        category: Common.SettingRegistration.SettingCategory.GLOBAL,
        order: 1,
      });
    }, 'Duplicate order value \'1\' for settings category \'GLOBAL\'');
  });

  it('throws an error when registering a UI descriptor that clashes with a legacy setting category order', () => {
    Common.SettingRegistration.registerSettingExtension({
      settingName: 'legacy-setting',
      settingType: Common.SettingRegistration.SettingType.BOOLEAN,
      defaultValue: true,
      category: Common.SettingRegistration.SettingCategory.CONSOLE,
      order: 5,
    });

    assert.throws(() => {
      SettingsUI.SettingUIRegistration.register(settingDescriptor, {
        category: Common.SettingRegistration.SettingCategory.CONSOLE,
        order: 5,
      });
    }, 'Duplicate order value \'5\' for settings category \'CONSOLE\'');
  });

  it('allows re-registering an order after SettingUIRegistration.resetSettings()', () => {
    SettingsUI.SettingUIRegistration.register(settingDescriptor, {
      category: Common.SettingRegistration.SettingCategory.GLOBAL,
      order: 1,
    });

    SettingsUI.SettingUIRegistration.resetSettings();

    const otherDescriptor: Common.Settings.SettingDescriptor<boolean> = {
      name: 'other-setting',
      type: Common.Settings.SettingType.BOOLEAN,
      defaultValue: false,
    };

    assert.doesNotThrow(() => {
      SettingsUI.SettingUIRegistration.register(otherDescriptor, {
        category: Common.SettingRegistration.SettingCategory.GLOBAL,
        order: 1,
      });
    });
  });

  it('preserves UI category order validation when Common.SettingRegistration.resetSettings() is called', () => {
    SettingsUI.SettingUIRegistration.register(settingDescriptor, {
      category: Common.SettingRegistration.SettingCategory.GLOBAL,
      order: 1,
    });

    Common.SettingRegistration.resetSettings();

    const otherDescriptor: Common.Settings.SettingDescriptor<boolean> = {
      name: 'other-setting',
      type: Common.Settings.SettingType.BOOLEAN,
      defaultValue: false,
    };

    assert.throws(() => {
      SettingsUI.SettingUIRegistration.register(otherDescriptor, {
        category: Common.SettingRegistration.SettingCategory.GLOBAL,
        order: 1,
      });
    }, 'Duplicate order value \'1\' for settings category \'GLOBAL\'');
  });
});