-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.ts
244 lines (217 loc) · 8.72 KB
/
index.ts
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
import { User } from './objects/user';
import { EventStore } from './stores/EventStore';
import { createSchedule, removeSchedule } from './schedule';
import { GIT_REVISION } from './shared';
import { APIClient } from './api/client';
import { Config, defaultConfig } from './config';
import { createDefaultEvaluationEvent, createEvaluationEvent } from './objects/evaluationEvent';
import { createGoalEvent } from './objects/goalEvent';
import {
createLatencyMetricsEvent,
createSizeMetricsEvent,
toErrorMetricsEvent,
} from './objects/metricsEvent';
import { Evaluation } from './objects/evaluation';
import { Event } from './objects/event';
import { GetEvaluationResponse } from './objects/response';
import { ApiId, NodeApiIds } from './objects/apiId';
export interface BuildInfo {
readonly GIT_REVISION: string;
}
export { Config } from './config';
export { Logger, DefaultLogger } from './logger';
export { User } from './objects/user';
export interface Bucketeer {
/**
* getStringVariation returns variation as string.
* If a variation returned by server is not string, defaultValue is retured.
* @param user User information.
* @param featureId Feature flag ID to use.
* @param defaultValue The variation value that is retured if SDK fails to fetch the variation or the variation is not string.
* @returns The variation value returned from server or default value.
*/
getStringVariation(user: User, featureId: string, defaultValue: string): Promise<string>;
/**
* getBoolVariation returns variation as boolean.
* If a variation returned by server is not boolean, defaultValue is retured.
* @param user User information.
* @param featureId Feature flag ID to use.
* @param defaultValue The variation value that is retured if SDK fails to fetch the variation or the variation is not boolean.
* @returns The variation value returned from server or default value.
*/
getBoolVariation(user: User, featureId: string, defaultValue: boolean): Promise<boolean>;
/**
* getNumberVariation returns variation as number.
* If a variation returned by server is not number, defaultValue is retured.
* @param user User information.
* @param featureId Feature flag ID to use.
* @param defaultValue The variation value that is retured if SDK fails to fetch the variation or the variation is not number.
* @returns The variation value returned from server or default value.
*/
getNumberVariation(user: User, featureId: string, defaultValue: number): Promise<number>;
/**
* getJsonVariation returns variation as json object.
* If a variation returned by server is not json, defaultValue is retured.
* @param user User information.
* @param featureId Feature flag ID to use.
* @param defaultValue The variation value that is retured if SDK fails to fetch the variation or the variation is not json.
* @returns The variation value returned from server or default value.
*/
getJsonVariation(user: User, featureId: string, defaultValue: object): Promise<object>;
/**
* track records a goal event.
* @param user User information.
* @param goalId Goal ID to record.
* @param value The value that is the additional information that user can add to goal event.
* @returns The variation value returned from server or default value.
*/
track(user: User, goalId: string, value?: number): void;
/**
* destroy finalizes Bucketeer instance.
* It sends all event in memory and stop workers.
* The application should call destroy before the application stops, otherwise remaining events can be lost.
*/
destroy(): void;
/**
* getBuildInfo returns the SDK's build information.
* @returns The SDK's build information.
*/
getBuildInfo(): BuildInfo;
}
const COUNT_PER_REGISTER_EVENT = 100;
/**
* initialize initializes a Bucketeer instance and returns it.
* @param config Configurations of the SDK.
* @returns Bucketeer SDK instance.
*/
export function initialize(config: Config): Bucketeer {
return new BKTClientImpl(config);
}
export class BKTClientImpl implements Bucketeer {
apiClient: APIClient;
eventStore: EventStore;
config: Config;
registerEventsScheduleID: NodeJS.Timeout;
constructor(config: Config) {
this.config = {
...defaultConfig,
...config,
};
this.apiClient = new APIClient(this.config.host, this.config.token);
this.eventStore = new EventStore();
this.registerEventsScheduleID = createSchedule(() => {
if (this.eventStore.size() > 0) {
this.callRegisterEvents(this.eventStore.takeout(this.eventStore.size()));
}
}, this.config.pollingIntervalForRegisterEvents!);
}
registerEvents(): void {
if (this.eventStore.size() >= COUNT_PER_REGISTER_EVENT) {
this.callRegisterEvents(this.eventStore.takeout(COUNT_PER_REGISTER_EVENT));
}
}
registerAllEvents(): void {
if (this.eventStore.size() > 0) {
this.callRegisterEvents(this.eventStore.getAll());
}
}
callRegisterEvents(events: Array<Event>): void {
this.apiClient.registerEvents(events).catch((e) => {
this.saveErrorMetricsEvent(this.config.tag, e, ApiId.REGISTER_EVENTS);
this.config.logger?.warn('register events failed', e);
});
}
saveDefaultEvaluationEvent(user: User, featureId: string) {
this.eventStore.add(createDefaultEvaluationEvent(this.config.tag, user, featureId));
this.registerEvents();
}
saveEvaluationEvent(user: User, evaluation: Evaluation) {
this.eventStore.add(createEvaluationEvent(this.config.tag, user, evaluation));
this.registerEvents();
}
saveGoalEvent(user: User, goalId: string, value?: number) {
this.eventStore.add(createGoalEvent(this.config.tag, goalId, user, value ? value : 0));
this.registerEvents();
}
saveEvaluationMetricsEvent(tag: string, second: number, size: number) {
this.saveLatencyMetricsEvent(tag, second, ApiId.GET_EVALUATION);
this.saveSizeMetricsEvent(tag, size, ApiId.GET_EVALUATION);
}
saveLatencyMetricsEvent(tag: string, second: number, apiId: NodeApiIds) {
this.eventStore.add(createLatencyMetricsEvent(tag, second, apiId));
this.registerEvents();
}
saveSizeMetricsEvent(tag: string, size: number, apiId: NodeApiIds) {
this.eventStore.add(createSizeMetricsEvent(tag, size, apiId));
this.registerEvents();
}
saveErrorMetricsEvent(tag: string, e: any, apiId: NodeApiIds) {
const event = toErrorMetricsEvent(e, tag, apiId);
this.eventStore.add(event);
this.registerEvents();
}
async getStringVariation(user: User, featureId: string, defaultValue: string): Promise<string> {
const startTime: number = Date.now();
let res: GetEvaluationResponse;
let size: number;
try {
[res, size] = await this.apiClient.getEvaluation(this.config.tag, user, featureId);
} catch (error) {
this.saveErrorMetricsEvent(this.config.tag, error, ApiId.GET_EVALUATION);
this.saveDefaultEvaluationEvent(user, featureId);
return defaultValue;
}
const evaluation = res?.evaluation;
if (evaluation == null) {
this.saveDefaultEvaluationEvent(user, featureId);
return defaultValue;
}
const second = (Date.now() - startTime) / 1000;
this.saveEvaluationEvent(user, evaluation);
this.saveEvaluationMetricsEvent(this.config.tag, second, size);
return evaluation.variationValue;
}
async getBoolVariation(user: User, featureId: string, defaultValue: boolean): Promise<boolean> {
const valueStr = await this.getStringVariation(user, featureId, '');
switch (valueStr.toLowerCase()) {
case 'true':
return true;
case 'false':
return false;
default:
return defaultValue;
}
}
async getNumberVariation(user: User, featureId: string, defaultValue: number): Promise<number> {
const valueStr = await this.getStringVariation(user, featureId, '');
const value = parseFloat(valueStr);
if (isNaN(value)) {
this.config.logger?.debug('getNumberVariation failed to parseFloat');
return defaultValue;
}
return value;
}
async getJsonVariation(user: User, featureId: string, defaultValue: object): Promise<object> {
const valueStr = await this.getStringVariation(user, featureId, '');
try {
return JSON.parse(valueStr);
} catch (e) {
this.config.logger?.debug('getJsonVariation failed to parse', e);
return defaultValue;
}
}
track(user: User, goalId: string, value?: number): void {
this.config.logger?.debug('track is called', goalId, value);
this.saveGoalEvent(user, goalId, value);
}
async destroy(): Promise<void> {
this.registerAllEvents();
removeSchedule(this.registerEventsScheduleID);
this.config.logger?.info('destroy finished', this.registerEventsScheduleID);
}
getBuildInfo(): BuildInfo {
return {
GIT_REVISION,
};
}
}