-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathLDClientDataSystemOptions.ts
More file actions
91 lines (80 loc) · 2.87 KB
/
LDClientDataSystemOptions.ts
File metadata and controls
91 lines (80 loc) · 2.87 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
import { TypeValidators } from '@launchdarkly/js-sdk-common';
import type FDv2ConnectionMode from '../api/datasource/FDv2ConnectionMode';
import type {
LDClientDataSystemOptions,
ManualModeSwitching,
PlatformDataSystemDefaults,
} from '../api/datasource/LDClientDataSystemOptions';
import { anyOf, validatorOf } from '../configuration/validateOptions';
import { connectionModesValidator, connectionModeValidator } from './ConnectionModeConfig';
function hasType(u: unknown, type: string): boolean {
return TypeValidators.Object.is(u) && (u as Record<string, unknown>).type === type;
}
const automaticModeValidators = {
type: TypeValidators.oneOf('automatic'),
lifecycle: TypeValidators.Boolean,
network: TypeValidators.Boolean,
};
const manualModeValidators = {
type: TypeValidators.oneOf('manual'),
initialConnectionMode: connectionModeValidator,
};
const dataSystemValidators = {
backgroundConnectionMode: connectionModeValidator,
automaticModeSwitching: anyOf(
TypeValidators.Boolean,
validatorOf(automaticModeValidators, { is: (u) => hasType(u, 'automatic') }),
validatorOf(manualModeValidators, { is: (u) => hasType(u, 'manual') }),
),
connectionModes: connectionModesValidator,
};
/**
* Default FDv2 data system configuration for browser SDKs.
*/
const BROWSER_DATA_SYSTEM_DEFAULTS: PlatformDataSystemDefaults = {
foregroundConnectionMode: 'one-shot',
backgroundConnectionMode: undefined,
automaticModeSwitching: false,
};
/**
* Default FDv2 data system configuration for mobile (React Native) SDKs.
*/
const MOBILE_DATA_SYSTEM_DEFAULTS: PlatformDataSystemDefaults = {
foregroundConnectionMode: 'streaming',
backgroundConnectionMode: 'background',
automaticModeSwitching: true,
};
/**
* Default FDv2 data system configuration for desktop SDKs (Electron, etc.).
*/
const DESKTOP_DATA_SYSTEM_DEFAULTS: PlatformDataSystemDefaults = {
foregroundConnectionMode: 'streaming',
backgroundConnectionMode: undefined,
automaticModeSwitching: false,
};
function isManualModeSwitching(
value: LDClientDataSystemOptions['automaticModeSwitching'],
): value is ManualModeSwitching {
return typeof value === 'object' && value !== null && 'type' in value && value.type === 'manual';
}
/**
* Resolve the foreground connection mode from a validated data system config
* and platform defaults. Uses the mode from `ManualModeSwitching` when present,
* otherwise falls back to the platform default.
*/
function resolveForegroundMode(
dataSystem: LDClientDataSystemOptions,
defaults: PlatformDataSystemDefaults,
): FDv2ConnectionMode {
if (isManualModeSwitching(dataSystem.automaticModeSwitching)) {
return dataSystem.automaticModeSwitching.initialConnectionMode;
}
return defaults.foregroundConnectionMode;
}
export {
dataSystemValidators,
resolveForegroundMode,
BROWSER_DATA_SYSTEM_DEFAULTS,
MOBILE_DATA_SYSTEM_DEFAULTS,
DESKTOP_DATA_SYSTEM_DEFAULTS,
};