Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

feature-flags.md 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750
  1. # Feature Flag Governance
  2. ## Principle
  3. Feature flags enable controlled rollouts and A/B testing, but require disciplined testing governance. Centralize flag definitions in a frozen enum, test both enabled and disabled states, clean up targeting after each spec, and maintain a comprehensive flag lifecycle checklist. For LaunchDarkly-style systems, script API helpers to seed variations programmatically rather than manual UI mutations.
  4. ## Rationale
  5. Poorly managed feature flags become technical debt: untested variations ship broken code, forgotten flags clutter the codebase, and shared environments become unstable from leftover targeting rules. Structured governance ensures flags are testable, traceable, temporary, and safe. Testing both states prevents surprises when flags flip in production.
  6. ## Pattern Examples
  7. ### Example 1: Feature Flag Enum Pattern with Type Safety
  8. **Context**: Centralized flag management with TypeScript type safety and runtime validation.
  9. **Implementation**:
  10. ```typescript
  11. // src/utils/feature-flags.ts
  12. /**
  13. * Centralized feature flag definitions
  14. * - Object.freeze prevents runtime modifications
  15. * - TypeScript ensures compile-time type safety
  16. * - Single source of truth for all flag keys
  17. */
  18. export const FLAGS = Object.freeze({
  19. // User-facing features
  20. NEW_CHECKOUT_FLOW: 'new-checkout-flow',
  21. DARK_MODE: 'dark-mode',
  22. ENHANCED_SEARCH: 'enhanced-search',
  23. // Experiments
  24. PRICING_EXPERIMENT_A: 'pricing-experiment-a',
  25. HOMEPAGE_VARIANT_B: 'homepage-variant-b',
  26. // Infrastructure
  27. USE_NEW_API_ENDPOINT: 'use-new-api-endpoint',
  28. ENABLE_ANALYTICS_V2: 'enable-analytics-v2',
  29. // Killswitches (emergency disables)
  30. DISABLE_PAYMENT_PROCESSING: 'disable-payment-processing',
  31. DISABLE_EMAIL_NOTIFICATIONS: 'disable-email-notifications',
  32. } as const);
  33. /**
  34. * Type-safe flag keys
  35. * Prevents typos and ensures autocomplete in IDEs
  36. */
  37. export type FlagKey = (typeof FLAGS)[keyof typeof FLAGS];
  38. /**
  39. * Flag metadata for governance
  40. */
  41. type FlagMetadata = {
  42. key: FlagKey;
  43. name: string;
  44. owner: string;
  45. createdDate: string;
  46. expiryDate?: string;
  47. defaultState: boolean;
  48. requiresCleanup: boolean;
  49. dependencies?: FlagKey[];
  50. telemetryEvents?: string[];
  51. };
  52. /**
  53. * Flag registry with governance metadata
  54. * Used for flag lifecycle tracking and cleanup alerts
  55. */
  56. export const FLAG_REGISTRY: Record<FlagKey, FlagMetadata> = {
  57. [FLAGS.NEW_CHECKOUT_FLOW]: {
  58. key: FLAGS.NEW_CHECKOUT_FLOW,
  59. name: 'New Checkout Flow',
  60. owner: 'payments-team',
  61. createdDate: '2025-01-15',
  62. expiryDate: '2025-03-15',
  63. defaultState: false,
  64. requiresCleanup: true,
  65. dependencies: [FLAGS.USE_NEW_API_ENDPOINT],
  66. telemetryEvents: ['checkout_started', 'checkout_completed'],
  67. },
  68. [FLAGS.DARK_MODE]: {
  69. key: FLAGS.DARK_MODE,
  70. name: 'Dark Mode UI',
  71. owner: 'frontend-team',
  72. createdDate: '2025-01-10',
  73. defaultState: false,
  74. requiresCleanup: false, // Permanent feature toggle
  75. },
  76. // ... rest of registry
  77. };
  78. /**
  79. * Validate flag exists in registry
  80. * Throws at runtime if flag is unregistered
  81. */
  82. export function validateFlag(flag: string): asserts flag is FlagKey {
  83. if (!Object.values(FLAGS).includes(flag as FlagKey)) {
  84. throw new Error(`Unregistered feature flag: ${flag}`);
  85. }
  86. }
  87. /**
  88. * Check if flag is expired (needs removal)
  89. */
  90. export function isFlagExpired(flag: FlagKey): boolean {
  91. const metadata = FLAG_REGISTRY[flag];
  92. if (!metadata.expiryDate) return false;
  93. const expiry = new Date(metadata.expiryDate);
  94. return Date.now() > expiry.getTime();
  95. }
  96. /**
  97. * Get all expired flags requiring cleanup
  98. */
  99. export function getExpiredFlags(): FlagMetadata[] {
  100. return Object.values(FLAG_REGISTRY).filter((meta) => isFlagExpired(meta.key));
  101. }
  102. ```
  103. **Usage in application code**:
  104. ```typescript
  105. // components/Checkout.tsx
  106. import { FLAGS } from '@/utils/feature-flags';
  107. import { useFeatureFlag } from '@/hooks/useFeatureFlag';
  108. export function Checkout() {
  109. const isNewFlow = useFeatureFlag(FLAGS.NEW_CHECKOUT_FLOW);
  110. return isNewFlow ? <NewCheckoutFlow /> : <LegacyCheckoutFlow />;
  111. }
  112. ```
  113. **Key Points**:
  114. - **Type safety**: TypeScript catches typos at compile time
  115. - **Runtime validation**: validateFlag ensures only registered flags used
  116. - **Metadata tracking**: Owner, dates, dependencies documented
  117. - **Expiry alerts**: Automated detection of stale flags
  118. - **Single source of truth**: All flags defined in one place
  119. ---
  120. ### Example 2: Feature Flag Testing Pattern (Both States)
  121. **Context**: Comprehensive testing of feature flag variations with proper cleanup.
  122. **Implementation**:
  123. ```typescript
  124. // tests/e2e/checkout-feature-flag.spec.ts
  125. import { test, expect } from '@playwright/test';
  126. import { FLAGS } from '@/utils/feature-flags';
  127. /**
  128. * Feature Flag Testing Strategy:
  129. * 1. Test BOTH enabled and disabled states
  130. * 2. Clean up targeting after each test
  131. * 3. Use dedicated test users (not production data)
  132. * 4. Verify telemetry events fire correctly
  133. */
  134. test.describe('Checkout Flow - Feature Flag Variations', () => {
  135. let testUserId: string;
  136. test.beforeEach(async () => {
  137. // Generate unique test user ID
  138. testUserId = `test-user-${Date.now()}`;
  139. });
  140. test.afterEach(async ({ request }) => {
  141. // CRITICAL: Clean up flag targeting to prevent shared env pollution
  142. await request.post('/api/feature-flags/cleanup', {
  143. data: {
  144. flagKey: FLAGS.NEW_CHECKOUT_FLOW,
  145. userId: testUserId,
  146. },
  147. });
  148. });
  149. test('should use NEW checkout flow when flag is ENABLED', async ({ page, request }) => {
  150. // Arrange: Enable flag for test user
  151. await request.post('/api/feature-flags/target', {
  152. data: {
  153. flagKey: FLAGS.NEW_CHECKOUT_FLOW,
  154. userId: testUserId,
  155. variation: true, // ENABLED
  156. },
  157. });
  158. // Act: Navigate as targeted user
  159. await page.goto('/checkout', {
  160. extraHTTPHeaders: {
  161. 'X-Test-User-ID': testUserId,
  162. },
  163. });
  164. // Assert: New flow UI elements visible
  165. await expect(page.getByTestId('checkout-v2-container')).toBeVisible();
  166. await expect(page.getByTestId('express-payment-options')).toBeVisible();
  167. await expect(page.getByTestId('saved-addresses-dropdown')).toBeVisible();
  168. // Assert: Legacy flow NOT visible
  169. await expect(page.getByTestId('checkout-v1-container')).not.toBeVisible();
  170. // Assert: Telemetry event fired
  171. const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS_EVENTS__ || []);
  172. expect(analyticsEvents).toContainEqual(
  173. expect.objectContaining({
  174. event: 'checkout_started',
  175. properties: expect.objectContaining({
  176. variant: 'new_flow',
  177. }),
  178. }),
  179. );
  180. });
  181. test('should use LEGACY checkout flow when flag is DISABLED', async ({ page, request }) => {
  182. // Arrange: Disable flag for test user (or don't target at all)
  183. await request.post('/api/feature-flags/target', {
  184. data: {
  185. flagKey: FLAGS.NEW_CHECKOUT_FLOW,
  186. userId: testUserId,
  187. variation: false, // DISABLED
  188. },
  189. });
  190. // Act: Navigate as targeted user
  191. await page.goto('/checkout', {
  192. extraHTTPHeaders: {
  193. 'X-Test-User-ID': testUserId,
  194. },
  195. });
  196. // Assert: Legacy flow UI elements visible
  197. await expect(page.getByTestId('checkout-v1-container')).toBeVisible();
  198. await expect(page.getByTestId('legacy-payment-form')).toBeVisible();
  199. // Assert: New flow NOT visible
  200. await expect(page.getByTestId('checkout-v2-container')).not.toBeVisible();
  201. await expect(page.getByTestId('express-payment-options')).not.toBeVisible();
  202. // Assert: Telemetry event fired with correct variant
  203. const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS_EVENTS__ || []);
  204. expect(analyticsEvents).toContainEqual(
  205. expect.objectContaining({
  206. event: 'checkout_started',
  207. properties: expect.objectContaining({
  208. variant: 'legacy_flow',
  209. }),
  210. }),
  211. );
  212. });
  213. test('should handle flag evaluation errors gracefully', async ({ page, request }) => {
  214. // Arrange: Simulate flag service unavailable
  215. await page.route('**/api/feature-flags/evaluate', (route) => route.fulfill({ status: 500, body: 'Service Unavailable' }));
  216. // Act: Navigate (should fallback to default state)
  217. await page.goto('/checkout', {
  218. extraHTTPHeaders: {
  219. 'X-Test-User-ID': testUserId,
  220. },
  221. });
  222. // Assert: Fallback to safe default (legacy flow)
  223. await expect(page.getByTestId('checkout-v1-container')).toBeVisible();
  224. // Assert: Error logged but no user-facing error
  225. const consoleErrors = [];
  226. page.on('console', (msg) => {
  227. if (msg.type() === 'error') consoleErrors.push(msg.text());
  228. });
  229. expect(consoleErrors).toContain(expect.stringContaining('Feature flag evaluation failed'));
  230. });
  231. });
  232. ```
  233. **Cypress equivalent**:
  234. ```javascript
  235. // cypress/e2e/checkout-feature-flag.cy.ts
  236. import { FLAGS } from '@/utils/feature-flags';
  237. describe('Checkout Flow - Feature Flag Variations', () => {
  238. let testUserId;
  239. beforeEach(() => {
  240. testUserId = `test-user-${Date.now()}`;
  241. });
  242. afterEach(() => {
  243. // Clean up targeting
  244. cy.task('removeFeatureFlagTarget', {
  245. flagKey: FLAGS.NEW_CHECKOUT_FLOW,
  246. userId: testUserId,
  247. });
  248. });
  249. it('should use NEW checkout flow when flag is ENABLED', () => {
  250. // Arrange: Enable flag via Cypress task
  251. cy.task('setFeatureFlagVariation', {
  252. flagKey: FLAGS.NEW_CHECKOUT_FLOW,
  253. userId: testUserId,
  254. variation: true,
  255. });
  256. // Act
  257. cy.visit('/checkout', {
  258. headers: { 'X-Test-User-ID': testUserId },
  259. });
  260. // Assert
  261. cy.get('[data-testid="checkout-v2-container"]').should('be.visible');
  262. cy.get('[data-testid="checkout-v1-container"]').should('not.exist');
  263. });
  264. it('should use LEGACY checkout flow when flag is DISABLED', () => {
  265. // Arrange: Disable flag
  266. cy.task('setFeatureFlagVariation', {
  267. flagKey: FLAGS.NEW_CHECKOUT_FLOW,
  268. userId: testUserId,
  269. variation: false,
  270. });
  271. // Act
  272. cy.visit('/checkout', {
  273. headers: { 'X-Test-User-ID': testUserId },
  274. });
  275. // Assert
  276. cy.get('[data-testid="checkout-v1-container"]').should('be.visible');
  277. cy.get('[data-testid="checkout-v2-container"]').should('not.exist');
  278. });
  279. });
  280. ```
  281. **Key Points**:
  282. - **Test both states**: Enabled AND disabled variations
  283. - **Automatic cleanup**: afterEach removes targeting (prevent pollution)
  284. - **Unique test users**: Avoid conflicts with real user data
  285. - **Telemetry validation**: Verify analytics events fire correctly
  286. - **Graceful degradation**: Test fallback behavior on errors
  287. ---
  288. ### Example 3: Feature Flag Targeting Helper Pattern
  289. **Context**: Reusable helpers for programmatic flag control via LaunchDarkly/Split.io API.
  290. **Implementation**:
  291. ```typescript
  292. // tests/support/feature-flag-helpers.ts
  293. import { request as playwrightRequest } from '@playwright/test';
  294. import { FLAGS, FlagKey } from '@/utils/feature-flags';
  295. /**
  296. * LaunchDarkly API client configuration
  297. * Use test project SDK key (NOT production)
  298. */
  299. const LD_SDK_KEY = process.env.LD_SDK_KEY_TEST;
  300. const LD_API_BASE = 'https://app.launchdarkly.com/api/v2';
  301. type FlagVariation = boolean | string | number | object;
  302. /**
  303. * Set flag variation for specific user
  304. * Uses LaunchDarkly API to create user target
  305. */
  306. export async function setFlagForUser(flagKey: FlagKey, userId: string, variation: FlagVariation): Promise<void> {
  307. const response = await playwrightRequest.newContext().then((ctx) =>
  308. ctx.post(`${LD_API_BASE}/flags/${flagKey}/targeting`, {
  309. headers: {
  310. Authorization: LD_SDK_KEY!,
  311. 'Content-Type': 'application/json',
  312. },
  313. data: {
  314. targets: [
  315. {
  316. values: [userId],
  317. variation: variation ? 1 : 0, // 0 = off, 1 = on
  318. },
  319. ],
  320. },
  321. }),
  322. );
  323. if (!response.ok()) {
  324. throw new Error(`Failed to set flag ${flagKey} for user ${userId}: ${response.status()}`);
  325. }
  326. }
  327. /**
  328. * Remove user from flag targeting
  329. * CRITICAL for test cleanup
  330. */
  331. export async function removeFlagTarget(flagKey: FlagKey, userId: string): Promise<void> {
  332. const response = await playwrightRequest.newContext().then((ctx) =>
  333. ctx.delete(`${LD_API_BASE}/flags/${flagKey}/targeting/users/${userId}`, {
  334. headers: {
  335. Authorization: LD_SDK_KEY!,
  336. },
  337. }),
  338. );
  339. if (!response.ok() && response.status() !== 404) {
  340. // 404 is acceptable (user wasn't targeted)
  341. throw new Error(`Failed to remove flag ${flagKey} target for user ${userId}: ${response.status()}`);
  342. }
  343. }
  344. /**
  345. * Percentage rollout helper
  346. * Enable flag for N% of users
  347. */
  348. export async function setFlagRolloutPercentage(flagKey: FlagKey, percentage: number): Promise<void> {
  349. if (percentage < 0 || percentage > 100) {
  350. throw new Error('Percentage must be between 0 and 100');
  351. }
  352. const response = await playwrightRequest.newContext().then((ctx) =>
  353. ctx.patch(`${LD_API_BASE}/flags/${flagKey}`, {
  354. headers: {
  355. Authorization: LD_SDK_KEY!,
  356. 'Content-Type': 'application/json',
  357. },
  358. data: {
  359. rollout: {
  360. variations: [
  361. { variation: 0, weight: 100 - percentage }, // off
  362. { variation: 1, weight: percentage }, // on
  363. ],
  364. },
  365. },
  366. }),
  367. );
  368. if (!response.ok()) {
  369. throw new Error(`Failed to set rollout for flag ${flagKey}: ${response.status()}`);
  370. }
  371. }
  372. /**
  373. * Enable flag globally (100% rollout)
  374. */
  375. export async function enableFlagGlobally(flagKey: FlagKey): Promise<void> {
  376. await setFlagRolloutPercentage(flagKey, 100);
  377. }
  378. /**
  379. * Disable flag globally (0% rollout)
  380. */
  381. export async function disableFlagGlobally(flagKey: FlagKey): Promise<void> {
  382. await setFlagRolloutPercentage(flagKey, 0);
  383. }
  384. /**
  385. * Stub feature flags in local/test environments
  386. * Bypasses LaunchDarkly entirely
  387. */
  388. export function stubFeatureFlags(flags: Record<FlagKey, FlagVariation>): void {
  389. // Set flags in localStorage or inject into window
  390. if (typeof window !== 'undefined') {
  391. (window as any).__STUBBED_FLAGS__ = flags;
  392. }
  393. }
  394. ```
  395. **Usage in Playwright fixture**:
  396. ```typescript
  397. // playwright/fixtures/feature-flag-fixture.ts
  398. import { test as base } from '@playwright/test';
  399. import { setFlagForUser, removeFlagTarget } from '../support/feature-flag-helpers';
  400. import { FlagKey } from '@/utils/feature-flags';
  401. type FeatureFlagFixture = {
  402. featureFlags: {
  403. enable: (flag: FlagKey, userId: string) => Promise<void>;
  404. disable: (flag: FlagKey, userId: string) => Promise<void>;
  405. cleanup: (flag: FlagKey, userId: string) => Promise<void>;
  406. };
  407. };
  408. export const test = base.extend<FeatureFlagFixture>({
  409. featureFlags: async ({}, use) => {
  410. const cleanupQueue: Array<{ flag: FlagKey; userId: string }> = [];
  411. await use({
  412. enable: async (flag, userId) => {
  413. await setFlagForUser(flag, userId, true);
  414. cleanupQueue.push({ flag, userId });
  415. },
  416. disable: async (flag, userId) => {
  417. await setFlagForUser(flag, userId, false);
  418. cleanupQueue.push({ flag, userId });
  419. },
  420. cleanup: async (flag, userId) => {
  421. await removeFlagTarget(flag, userId);
  422. },
  423. });
  424. // Auto-cleanup after test
  425. for (const { flag, userId } of cleanupQueue) {
  426. await removeFlagTarget(flag, userId);
  427. }
  428. },
  429. });
  430. ```
  431. **Key Points**:
  432. - **API-driven control**: No manual UI clicks required
  433. - **Auto-cleanup**: Fixture tracks and removes targeting
  434. - **Percentage rollouts**: Test gradual feature releases
  435. - **Stubbing option**: Local development without LaunchDarkly
  436. - **Type-safe**: FlagKey prevents typos
  437. ---
  438. ### Example 4: Feature Flag Lifecycle Checklist & Cleanup Strategy
  439. **Context**: Governance checklist and automated cleanup detection for stale flags.
  440. **Implementation**:
  441. ```typescript
  442. // scripts/feature-flag-audit.ts
  443. /**
  444. * Feature Flag Lifecycle Audit Script
  445. * Run weekly to detect stale flags requiring cleanup
  446. */
  447. import { FLAG_REGISTRY, FLAGS, getExpiredFlags, FlagKey } from '../src/utils/feature-flags';
  448. import * as fs from 'fs';
  449. import * as path from 'path';
  450. type AuditResult = {
  451. totalFlags: number;
  452. expiredFlags: FlagKey[];
  453. missingOwners: FlagKey[];
  454. missingDates: FlagKey[];
  455. permanentFlags: FlagKey[];
  456. flagsNearingExpiry: FlagKey[];
  457. };
  458. /**
  459. * Audit all feature flags for governance compliance
  460. */
  461. function auditFeatureFlags(): AuditResult {
  462. const allFlags = Object.keys(FLAG_REGISTRY) as FlagKey[];
  463. const expiredFlags = getExpiredFlags().map((meta) => meta.key);
  464. // Flags expiring in next 30 days
  465. const thirtyDaysFromNow = Date.now() + 30 * 24 * 60 * 60 * 1000;
  466. const flagsNearingExpiry = allFlags.filter((flag) => {
  467. const meta = FLAG_REGISTRY[flag];
  468. if (!meta.expiryDate) return false;
  469. const expiry = new Date(meta.expiryDate).getTime();
  470. return expiry > Date.now() && expiry < thirtyDaysFromNow;
  471. });
  472. // Missing metadata
  473. const missingOwners = allFlags.filter((flag) => !FLAG_REGISTRY[flag].owner);
  474. const missingDates = allFlags.filter((flag) => !FLAG_REGISTRY[flag].createdDate);
  475. // Permanent flags (no expiry, requiresCleanup = false)
  476. const permanentFlags = allFlags.filter((flag) => {
  477. const meta = FLAG_REGISTRY[flag];
  478. return !meta.expiryDate && !meta.requiresCleanup;
  479. });
  480. return {
  481. totalFlags: allFlags.length,
  482. expiredFlags,
  483. missingOwners,
  484. missingDates,
  485. permanentFlags,
  486. flagsNearingExpiry,
  487. };
  488. }
  489. /**
  490. * Generate markdown report
  491. */
  492. function generateReport(audit: AuditResult): string {
  493. let report = `# Feature Flag Audit Report\n\n`;
  494. report += `**Date**: ${new Date().toISOString()}\n`;
  495. report += `**Total Flags**: ${audit.totalFlags}\n\n`;
  496. if (audit.expiredFlags.length > 0) {
  497. report += `## ⚠️ EXPIRED FLAGS - IMMEDIATE CLEANUP REQUIRED\n\n`;
  498. audit.expiredFlags.forEach((flag) => {
  499. const meta = FLAG_REGISTRY[flag];
  500. report += `- **${meta.name}** (\`${flag}\`)\n`;
  501. report += ` - Owner: ${meta.owner}\n`;
  502. report += ` - Expired: ${meta.expiryDate}\n`;
  503. report += ` - Action: Remove flag code, update tests, deploy\n\n`;
  504. });
  505. }
  506. if (audit.flagsNearingExpiry.length > 0) {
  507. report += `## ⏰ FLAGS EXPIRING SOON (Next 30 Days)\n\n`;
  508. audit.flagsNearingExpiry.forEach((flag) => {
  509. const meta = FLAG_REGISTRY[flag];
  510. report += `- **${meta.name}** (\`${flag}\`)\n`;
  511. report += ` - Owner: ${meta.owner}\n`;
  512. report += ` - Expires: ${meta.expiryDate}\n`;
  513. report += ` - Action: Plan cleanup or extend expiry\n\n`;
  514. });
  515. }
  516. if (audit.permanentFlags.length > 0) {
  517. report += `## 🔄 PERMANENT FLAGS (No Expiry)\n\n`;
  518. audit.permanentFlags.forEach((flag) => {
  519. const meta = FLAG_REGISTRY[flag];
  520. report += `- **${meta.name}** (\`${flag}\`) - Owner: ${meta.owner}\n`;
  521. });
  522. report += `\n`;
  523. }
  524. if (audit.missingOwners.length > 0 || audit.missingDates.length > 0) {
  525. report += `## ❌ GOVERNANCE ISSUES\n\n`;
  526. if (audit.missingOwners.length > 0) {
  527. report += `**Missing Owners**: ${audit.missingOwners.join(', ')}\n`;
  528. }
  529. if (audit.missingDates.length > 0) {
  530. report += `**Missing Created Dates**: ${audit.missingDates.join(', ')}\n`;
  531. }
  532. report += `\n`;
  533. }
  534. return report;
  535. }
  536. /**
  537. * Feature Flag Lifecycle Checklist
  538. */
  539. const FLAG_LIFECYCLE_CHECKLIST = `
  540. # Feature Flag Lifecycle Checklist
  541. ## Before Creating a New Flag
  542. - [ ] **Name**: Follow naming convention (kebab-case, descriptive)
  543. - [ ] **Owner**: Assign team/individual responsible
  544. - [ ] **Default State**: Determine safe default (usually false)
  545. - [ ] **Expiry Date**: Set removal date (30-90 days typical)
  546. - [ ] **Dependencies**: Document related flags
  547. - [ ] **Telemetry**: Plan analytics events to track
  548. - [ ] **Rollback Plan**: Define how to disable quickly
  549. ## During Development
  550. - [ ] **Code Paths**: Both enabled/disabled states implemented
  551. - [ ] **Tests**: Both variations tested in CI
  552. - [ ] **Documentation**: Flag purpose documented in code/PR
  553. - [ ] **Telemetry**: Analytics events instrumented
  554. - [ ] **Error Handling**: Graceful degradation on flag service failure
  555. ## Before Launch
  556. - [ ] **QA**: Both states tested in staging
  557. - [ ] **Rollout Plan**: Gradual rollout percentage defined
  558. - [ ] **Monitoring**: Dashboards/alerts for flag-related metrics
  559. - [ ] **Stakeholder Communication**: Product/design aligned
  560. ## After Launch (Monitoring)
  561. - [ ] **Metrics**: Success criteria tracked
  562. - [ ] **Error Rates**: No increase in errors
  563. - [ ] **Performance**: No degradation
  564. - [ ] **User Feedback**: Qualitative data collected
  565. ## Cleanup (Post-Launch)
  566. - [ ] **Remove Flag Code**: Delete if/else branches
  567. - [ ] **Update Tests**: Remove flag-specific tests
  568. - [ ] **Remove Targeting**: Clear all user targets
  569. - [ ] **Delete Flag Config**: Remove from LaunchDarkly/registry
  570. - [ ] **Update Documentation**: Remove references
  571. - [ ] **Deploy**: Ship cleanup changes
  572. `;
  573. // Run audit
  574. const audit = auditFeatureFlags();
  575. const report = generateReport(audit);
  576. // Save report
  577. const outputPath = path.join(__dirname, '../feature-flag-audit-report.md');
  578. fs.writeFileSync(outputPath, report);
  579. fs.writeFileSync(path.join(__dirname, '../FEATURE-FLAG-CHECKLIST.md'), FLAG_LIFECYCLE_CHECKLIST);
  580. console.log(`✅ Audit complete. Report saved to: ${outputPath}`);
  581. console.log(`Total flags: ${audit.totalFlags}`);
  582. console.log(`Expired flags: ${audit.expiredFlags.length}`);
  583. console.log(`Flags expiring soon: ${audit.flagsNearingExpiry.length}`);
  584. // Exit with error if expired flags exist
  585. if (audit.expiredFlags.length > 0) {
  586. console.error(`\n❌ EXPIRED FLAGS DETECTED - CLEANUP REQUIRED`);
  587. process.exit(1);
  588. }
  589. ```
  590. **package.json scripts**:
  591. ```json
  592. {
  593. "scripts": {
  594. "feature-flags:audit": "ts-node scripts/feature-flag-audit.ts",
  595. "feature-flags:audit:ci": "npm run feature-flags:audit || true"
  596. }
  597. }
  598. ```
  599. **Key Points**:
  600. - **Automated detection**: Weekly audit catches stale flags
  601. - **Lifecycle checklist**: Comprehensive governance guide
  602. - **Expiry tracking**: Flags auto-expire after defined date
  603. - **CI integration**: Audit runs in pipeline, warns on expiry
  604. - **Ownership clarity**: Every flag has assigned owner
  605. ---
  606. ## Feature Flag Testing Checklist
  607. Before merging flag-related code, verify:
  608. - [ ] **Both states tested**: Enabled AND disabled variations covered
  609. - [ ] **Cleanup automated**: afterEach removes targeting (no manual cleanup)
  610. - [ ] **Unique test data**: Test users don't collide with production
  611. - [ ] **Telemetry validated**: Analytics events fire for both variations
  612. - [ ] **Error handling**: Graceful fallback when flag service unavailable
  613. - [ ] **Flag metadata**: Owner, dates, dependencies documented in registry
  614. - [ ] **Rollback plan**: Clear steps to disable flag in production
  615. - [ ] **Expiry date set**: Removal date defined (or marked permanent)
  616. ## Integration Points
  617. - Used in workflows: `*automate` (test generation), `*framework` (flag setup)
  618. - Related fragments: `test-quality.md`, `selective-testing.md`
  619. - Flag services: LaunchDarkly, Split.io, Unleash, custom implementations
  620. _Source: LaunchDarkly strategy blog, Murat test architecture notes, enterprise feature flag governance_