-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy pathversion-gated-feature-flags.mdc
More file actions
97 lines (68 loc) · 3.33 KB
/
Copy pathversion-gated-feature-flags.mdc
File metadata and controls
97 lines (68 loc) · 3.33 KB
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
---
description: Use shared version-gated feature flag helpers; never duplicate hasMinimumRequiredVersion or validatedVersionGatedFeatureFlag
globs: app/**/*.{ts,tsx}
alwaysApply: false
---
# Version-Gated Feature Flags
> Canonical human guide: [`docs/readme/version-gated-feature-flags.md`](../../docs/readme/version-gated-feature-flags.md)
## Canonical source (SSOT)
All version-gated feature flag logic lives in `app/util/remoteFeatureFlag/index.ts`:
- `validatedVersionGatedFeatureFlag` — preferred for remote flags shaped as `{ enabled, minimumVersion }` (or progressive-rollout wrappers)
- `hasMinimumRequiredVersion` — version comparison only; import when needed, never redefine
## Required patterns
### ✅ Use `validatedVersionGatedFeatureFlag` in selectors
```typescript
import { validatedVersionGatedFeatureFlag, VersionGatedFeatureFlag } from '../../../util/remoteFeatureFlag';
export const selectMyFeatureEnabled = createSelector(
selectRemoteFeatureFlags,
(remoteFeatureFlags) => {
const remoteFlag = remoteFeatureFlags?.myFeature as unknown as VersionGatedFeatureFlag;
return validatedVersionGatedFeatureFlag(remoteFlag) ?? false;
},
);
```
### ✅ Non-standard flag shapes — map, don't duplicate
Configs that use `active` instead of `enabled` (e.g. `depositConfig`) must map to the canonical shape and call the shared helper:
```typescript
import { validatedVersionGatedFeatureFlag } from '../../../util/remoteFeatureFlag';
return (
validatedVersionGatedFeatureFlag({
enabled: depositConfig.active ?? false,
minimumVersion: depositConfig.minimumVersion ?? '',
}) ?? false
);
```
### ✅ Import `hasMinimumRequiredVersion` only from the util
```typescript
import { hasMinimumRequiredVersion } from '../../../util/remoteFeatureFlag';
```
Never copy the `compare-versions` + `getVersion` pattern into feature modules.
## Forbidden patterns
### ❌ Do not define local version-gating helpers
```typescript
// FORBIDDEN — duplicate of app/util/remoteFeatureFlag
function hasMinimumRequiredVersion(minVersion: string) { ... }
const validatedVersionGatedFeatureFlag = (flag: unknown) => { ... }
```
### ❌ Do not inline version checks for feature flags
```typescript
// FORBIDDEN
import { getVersion } from 'react-native-device-info';
import compareVersions from 'compare-versions';
const ok = compareVersions.compare(getVersion(), flag.minimumVersion, '>=');
```
### ❌ Do not add duplicate utils under feature folders
Do not create files like:
- `app/components/UI/**/utils/hasMinimumRequiredVersion.ts`
- `app/core/redux/slices/**/hasMinimumRequiredVersion.ts`
## Where logic belongs
| Layer | Responsibility |
|-------|----------------|
| `RemoteFeatureFlagController` | Fetch/store raw flags — **no** client version gating |
| `app/util/remoteFeatureFlag` | Version comparison + `validatedVersionGatedFeatureFlag` |
| Selectors (`featureFlagController`, `**/selectors/featureFlags`) | Call shared helpers; return `boolean` |
| Hooks / components | `useSelector(selectXEnabled)` — not local version math |
## Enforcement
- **REJECT** new local definitions of `hasMinimumRequiredVersion` or `validatedVersionGatedFeatureFlag`
- **REJECT** new `compare-versions` + `getVersion` usage for feature-flag gating outside `app/util/remoteFeatureFlag`
- **REQUIRE** imports from `app/util/remoteFeatureFlag` for all version-gated flag checks