File size: 4,804 Bytes
7421850 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | /**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
SettingScope,
isLoadableSettingScope,
type LoadableSettingScope,
type LoadedSettings,
} from '../config/settings.js';
export interface ModifiedScope {
scope: SettingScope;
path: string;
}
export type FeatureActionStatus = 'success' | 'no-op' | 'error';
export interface FeatureActionResult {
status: FeatureActionStatus;
featureName: string;
action: 'enable' | 'disable';
/** Scopes where the feature's state was actually changed. */
modifiedScopes: ModifiedScope[];
/** Scopes where the feature was already in the desired state. */
alreadyInStateScopes: ModifiedScope[];
/** Error message if status is 'error'. */
error?: string;
}
/**
* Strategy pattern to handle differences between feature types (e.g. skills vs agents).
*/
export interface FeatureToggleStrategy {
/**
* Checks if the feature needs to be enabled in the given scope.
* For skills (blacklist): returns true if in disabled list.
* For agents (whitelist): returns true if NOT explicitly enabled (false or undefined).
*/
needsEnabling(
settings: LoadedSettings,
scope: LoadableSettingScope,
featureName: string,
): boolean;
/**
* Applies the enable change to the settings object.
*/
enable(
settings: LoadedSettings,
scope: LoadableSettingScope,
featureName: string,
): void;
/**
* Checks if the feature is explicitly disabled in the given scope.
* For skills (blacklist): returns true if in disabled list.
* For agents (whitelist): returns true if explicitly set to false.
*/
isExplicitlyDisabled(
settings: LoadedSettings,
scope: LoadableSettingScope,
featureName: string,
): boolean;
/**
* Applies the disable change to the settings object.
*/
disable(
settings: LoadedSettings,
scope: LoadableSettingScope,
featureName: string,
): void;
}
/**
* Enables a feature by ensuring it is enabled in all writable scopes.
*/
export function enableFeature(
settings: LoadedSettings,
featureName: string,
strategy: FeatureToggleStrategy,
): FeatureActionResult {
const writableScopes = [SettingScope.Workspace, SettingScope.User];
const foundInDisabledScopes: ModifiedScope[] = [];
const alreadyEnabledScopes: ModifiedScope[] = [];
for (const scope of writableScopes) {
if (isLoadableSettingScope(scope)) {
const scopePath = settings.forScope(scope).path;
if (strategy.needsEnabling(settings, scope, featureName)) {
foundInDisabledScopes.push({ scope, path: scopePath });
} else {
alreadyEnabledScopes.push({ scope, path: scopePath });
}
}
}
if (foundInDisabledScopes.length === 0) {
return {
status: 'no-op',
featureName,
action: 'enable',
modifiedScopes: [],
alreadyInStateScopes: alreadyEnabledScopes,
};
}
const modifiedScopes: ModifiedScope[] = [];
for (const { scope, path } of foundInDisabledScopes) {
if (isLoadableSettingScope(scope)) {
strategy.enable(settings, scope, featureName);
modifiedScopes.push({ scope, path });
}
}
return {
status: 'success',
featureName,
action: 'enable',
modifiedScopes,
alreadyInStateScopes: alreadyEnabledScopes,
};
}
/**
* Disables a feature in the specified scope.
*/
export function disableFeature(
settings: LoadedSettings,
featureName: string,
scope: SettingScope,
strategy: FeatureToggleStrategy,
): FeatureActionResult {
if (!isLoadableSettingScope(scope)) {
return {
status: 'error',
featureName,
action: 'disable',
modifiedScopes: [],
alreadyInStateScopes: [],
error: `Invalid settings scope: ${scope}`,
};
}
const scopePath = settings.forScope(scope).path;
if (strategy.isExplicitlyDisabled(settings, scope, featureName)) {
return {
status: 'no-op',
featureName,
action: 'disable',
modifiedScopes: [],
alreadyInStateScopes: [{ scope, path: scopePath }],
};
}
// Check if it's already disabled in the other writable scope
const otherScope =
scope === SettingScope.Workspace
? SettingScope.User
: SettingScope.Workspace;
const alreadyDisabledInOther: ModifiedScope[] = [];
if (isLoadableSettingScope(otherScope)) {
if (strategy.isExplicitlyDisabled(settings, otherScope, featureName)) {
alreadyDisabledInOther.push({
scope: otherScope,
path: settings.forScope(otherScope).path,
});
}
}
strategy.disable(settings, scope, featureName);
return {
status: 'success',
featureName,
action: 'disable',
modifiedScopes: [{ scope, path: scopePath }],
alreadyInStateScopes: alreadyDisabledInOther,
};
}
|