mirror of
https://github.com/bitwarden/browser
synced 2025-12-11 13:53:34 +00:00
8b64087b32
* feat: add content script manager * feat: inject into all pages * feat: only inject if flag is enabled * fix: wrong constructor parameters
143 lines
5.6 KiB
TypeScript
143 lines
5.6 KiB
TypeScript
import { ServerConfig } from "../platform/abstractions/config/server-config";
|
|
|
|
/**
|
|
* Feature flags.
|
|
*
|
|
* Flags MUST be short lived and SHALL be removed once enabled.
|
|
*
|
|
* Flags should be grouped by team to have visibility of ownership and cleanup.
|
|
*/
|
|
export enum FeatureFlag {
|
|
/* Admin Console Team */
|
|
AccountDeprovisioning = "pm-10308-account-deprovisioning",
|
|
VerifiedSsoDomainEndpoint = "pm-12337-refactor-sso-details-endpoint",
|
|
LimitItemDeletion = "pm-15493-restrict-item-deletion-to-can-manage-permission",
|
|
SsoExternalIdVisibility = "pm-18630-sso-external-id-visibility",
|
|
AccountDeprovisioningBanner = "pm-17120-account-deprovisioning-admin-console-banner",
|
|
|
|
/* Auth */
|
|
PM9112_DeviceApprovalPersistence = "pm-9112-device-approval-persistence",
|
|
|
|
/* Autofill */
|
|
BlockBrowserInjectionsByDomain = "block-browser-injections-by-domain",
|
|
DelayFido2PageScriptInitWithinMv2 = "delay-fido2-page-script-init-within-mv2",
|
|
EnableNewCardCombinedExpiryAutofill = "enable-new-card-combined-expiry-autofill",
|
|
GenerateIdentityFillScriptRefactor = "generate-identity-fill-script-refactor",
|
|
IdpAutoSubmitLogin = "idp-auto-submit-login",
|
|
InlineMenuPositioningImprovements = "inline-menu-positioning-improvements",
|
|
NotificationRefresh = "notification-refresh",
|
|
UseTreeWalkerApiForPageDetailsCollection = "use-tree-walker-api-for-page-details-collection",
|
|
MacOsNativeCredentialSync = "macos-native-credential-sync",
|
|
|
|
/* Billing */
|
|
TrialPaymentOptional = "PM-8163-trial-payment",
|
|
PM15179_AddExistingOrgsFromProviderPortal = "pm-15179-add-existing-orgs-from-provider-portal",
|
|
PM12276_BreadcrumbEventLogs = "pm-12276-breadcrumbing-for-business-features",
|
|
PM18794_ProviderPaymentMethod = "pm-18794-provider-payment-method",
|
|
|
|
/* Key Management */
|
|
PrivateKeyRegeneration = "pm-12241-private-key-regeneration",
|
|
UserKeyRotationV2 = "userkey-rotation-v2",
|
|
PM4154_BulkEncryptionService = "PM-4154-bulk-encryption-service",
|
|
|
|
/* Tools */
|
|
ItemShare = "item-share",
|
|
CriticalApps = "pm-14466-risk-insights-critical-application",
|
|
EnableRiskInsightsNotifications = "enable-risk-insights-notifications",
|
|
DesktopSendUIRefresh = "desktop-send-ui-refresh",
|
|
ExportAttachments = "export-attachments",
|
|
|
|
/* Vault */
|
|
PM8851_BrowserOnboardingNudge = "pm-8851-browser-onboarding-nudge",
|
|
PM9111ExtensionPersistAddEditForm = "pm-9111-extension-persist-add-edit-form",
|
|
NewDeviceVerificationTemporaryDismiss = "new-device-temporary-dismiss",
|
|
NewDeviceVerificationPermanentDismiss = "new-device-permanent-dismiss",
|
|
VaultBulkManagementAction = "vault-bulk-management-action",
|
|
SecurityTasks = "security-tasks",
|
|
CipherKeyEncryption = "cipher-key-encryption",
|
|
|
|
/* Platform */
|
|
IpcChannelFramework = "ipc-channel-framework",
|
|
}
|
|
|
|
export type AllowedFeatureFlagTypes = boolean | number | string;
|
|
|
|
// Helper to ensure the value is treated as a boolean.
|
|
const FALSE = false as boolean;
|
|
|
|
/**
|
|
* Default value for feature flags.
|
|
*
|
|
* DO NOT enable previously disabled flags, REMOVE them instead.
|
|
* We support true as a value as we prefer flags to "enable" not "disable".
|
|
*
|
|
* Flags should be grouped by team to have visibility of ownership and cleanup.
|
|
*/
|
|
export const DefaultFeatureFlagValue = {
|
|
/* Admin Console Team */
|
|
[FeatureFlag.AccountDeprovisioning]: FALSE,
|
|
[FeatureFlag.VerifiedSsoDomainEndpoint]: FALSE,
|
|
[FeatureFlag.LimitItemDeletion]: FALSE,
|
|
[FeatureFlag.SsoExternalIdVisibility]: FALSE,
|
|
[FeatureFlag.AccountDeprovisioningBanner]: FALSE,
|
|
|
|
/* Autofill */
|
|
[FeatureFlag.BlockBrowserInjectionsByDomain]: FALSE,
|
|
[FeatureFlag.DelayFido2PageScriptInitWithinMv2]: FALSE,
|
|
[FeatureFlag.EnableNewCardCombinedExpiryAutofill]: FALSE,
|
|
[FeatureFlag.GenerateIdentityFillScriptRefactor]: FALSE,
|
|
[FeatureFlag.IdpAutoSubmitLogin]: FALSE,
|
|
[FeatureFlag.InlineMenuPositioningImprovements]: FALSE,
|
|
[FeatureFlag.NotificationRefresh]: FALSE,
|
|
[FeatureFlag.UseTreeWalkerApiForPageDetailsCollection]: FALSE,
|
|
[FeatureFlag.MacOsNativeCredentialSync]: FALSE,
|
|
|
|
/* Tools */
|
|
[FeatureFlag.ItemShare]: FALSE,
|
|
[FeatureFlag.CriticalApps]: FALSE,
|
|
[FeatureFlag.EnableRiskInsightsNotifications]: FALSE,
|
|
[FeatureFlag.DesktopSendUIRefresh]: FALSE,
|
|
[FeatureFlag.ExportAttachments]: FALSE,
|
|
|
|
/* Vault */
|
|
[FeatureFlag.PM8851_BrowserOnboardingNudge]: FALSE,
|
|
[FeatureFlag.PM9111ExtensionPersistAddEditForm]: FALSE,
|
|
[FeatureFlag.NewDeviceVerificationTemporaryDismiss]: FALSE,
|
|
[FeatureFlag.NewDeviceVerificationPermanentDismiss]: FALSE,
|
|
[FeatureFlag.VaultBulkManagementAction]: FALSE,
|
|
[FeatureFlag.SecurityTasks]: FALSE,
|
|
[FeatureFlag.CipherKeyEncryption]: FALSE,
|
|
|
|
/* Auth */
|
|
[FeatureFlag.PM9112_DeviceApprovalPersistence]: FALSE,
|
|
|
|
/* Billing */
|
|
[FeatureFlag.TrialPaymentOptional]: FALSE,
|
|
[FeatureFlag.PM15179_AddExistingOrgsFromProviderPortal]: FALSE,
|
|
[FeatureFlag.PM12276_BreadcrumbEventLogs]: FALSE,
|
|
[FeatureFlag.PM18794_ProviderPaymentMethod]: FALSE,
|
|
|
|
/* Key Management */
|
|
[FeatureFlag.PrivateKeyRegeneration]: FALSE,
|
|
[FeatureFlag.UserKeyRotationV2]: FALSE,
|
|
[FeatureFlag.PM4154_BulkEncryptionService]: FALSE,
|
|
|
|
/* Platform */
|
|
[FeatureFlag.IpcChannelFramework]: FALSE,
|
|
} satisfies Record<FeatureFlag, AllowedFeatureFlagTypes>;
|
|
|
|
export type DefaultFeatureFlagValueType = typeof DefaultFeatureFlagValue;
|
|
|
|
export type FeatureFlagValueType<Flag extends FeatureFlag> = DefaultFeatureFlagValueType[Flag];
|
|
|
|
export function getFeatureFlagValue<Flag extends FeatureFlag>(
|
|
serverConfig: ServerConfig | null,
|
|
flag: Flag,
|
|
) {
|
|
if (serverConfig?.featureStates == null || serverConfig.featureStates[flag] == null) {
|
|
return DefaultFeatureFlagValue[flag];
|
|
}
|
|
|
|
return serverConfig.featureStates[flag] as FeatureFlagValueType<Flag>;
|
|
}
|