Skip to content

Commit 2f02b69

Browse files
raju-optiraju-opti
authored
[FSSDK-11035] refactor logger and error handler (#982)
1 parent 92ab2a7 commit 2f02b69

File tree

79 files changed

+3380
-4910
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+3380
-4910
lines changed

‎lib/common_exports.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414
* limitations under the License.
1515
*/
1616

17-
export { LogLevel, LogHandler, getLogger, setLogHandler } from './modules/logging';
1817
export { LOG_LEVEL } from './utils/enums';
19-
export { createLogger } from './plugins/logger';
2018
export { createStaticProjectConfigManager } from './project_config/config_manager_factory';
2119
export { PollingConfigManagerConfig } from './project_config/config_manager_factory';

‎lib/core/audience_evaluator/index.tests.js‎

Lines changed: 102 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,20 @@
1616
import sinon from 'sinon';
1717
import { assert } from 'chai';
1818
import { sprintf } from '../../utils/fns';
19-
import { getLogger } from '../../modules/logging';
2019

2120
import AudienceEvaluator, { createAudienceEvaluator } from './index';
2221
import * as conditionTreeEvaluator from '../condition_tree_evaluator';
2322
import * as customAttributeConditionEvaluator from '../custom_attribute_condition_evaluator';
23+
import { AUDIENCE_EVALUATION_RESULT, EVALUATING_AUDIENCE } from '../../log_messages';
24+
// import { getEvaluator } from '../custom_attribute_condition_evaluator';
2425

2526
var buildLogMessageFromArgs = args => sprintf(args[1], ...args.splice(2));
26-
var mockLogger = getLogger();
27+
var mockLogger = {
28+
debug: () => {},
29+
info: () => {},
30+
warn: () => {},
31+
error: () => {},
32+
}
2733

2834
var getMockUserContext = (attributes, segments) => ({
2935
getAttributes: () => ({ ... (attributes || {})}),
@@ -82,11 +88,17 @@ describe('lib/core/audience_evaluator', function() {
8288
var audienceEvaluator;
8389

8490
beforeEach(function() {
85-
sinon.stub(mockLogger, 'log');
91+
sinon.stub(mockLogger, 'info');
92+
sinon.stub(mockLogger, 'debug');
93+
sinon.stub(mockLogger, 'warn');
94+
sinon.stub(mockLogger, 'error');
8695
});
8796

8897
afterEach(function() {
89-
mockLogger.log.restore();
98+
mockLogger.info.restore();
99+
mockLogger.debug.restore();
100+
mockLogger.warn.restore();
101+
mockLogger.error.restore();
90102
});
91103

92104
describe('APIs', function() {
@@ -170,7 +182,6 @@ describe('lib/core/audience_evaluator', function() {
170182

171183
beforeEach(function() {
172184
sandbox.stub(conditionTreeEvaluator, 'evaluate');
173-
sandbox.stub(customAttributeConditionEvaluator, 'evaluate');
174185
});
175186

176187
afterEach(function() {
@@ -199,26 +210,40 @@ describe('lib/core/audience_evaluator', function() {
199210
conditionTreeEvaluator.evaluate.callsFake(function(conditions, leafEvaluator) {
200211
return leafEvaluator(conditions[1]);
201212
});
202-
customAttributeConditionEvaluator.evaluate.returns(false);
213+
214+
const mockCustomAttributeConditionEvaluator = sinon.stub().returns(false);
215+
216+
sinon.stub(customAttributeConditionEvaluator, 'getEvaluator').returns({
217+
evaluate: mockCustomAttributeConditionEvaluator,
218+
});
219+
220+
const audienceEvaluator = createAudienceEvaluator();
221+
203222
var userAttributes = { device_model: 'android' };
204223
var user = getMockUserContext(userAttributes);
205224
var result = audienceEvaluator.evaluate(['or', '1'], audiencesById, user);
206-
sinon.assert.calledOnce(customAttributeConditionEvaluator.evaluate);
225+
sinon.assert.calledOnce(mockCustomAttributeConditionEvaluator);
207226
sinon.assert.calledWithExactly(
208-
customAttributeConditionEvaluator.evaluate,
227+
mockCustomAttributeConditionEvaluator,
209228
iphoneUserAudience.conditions[1],
210229
user,
211230
);
212231
assert.isFalse(result);
232+
233+
customAttributeConditionEvaluator.getEvaluator.restore();
213234
});
214235
});
215236

216237
describe('Audience evaluation logging', function() {
217238
var sandbox = sinon.sandbox.create();
239+
var mockCustomAttributeConditionEvaluator;
218240

219241
beforeEach(function() {
242+
mockCustomAttributeConditionEvaluator = sinon.stub();
220243
sandbox.stub(conditionTreeEvaluator, 'evaluate');
221-
sandbox.stub(customAttributeConditionEvaluator, 'evaluate');
244+
sandbox.stub(customAttributeConditionEvaluator, 'getEvaluator').returns({
245+
evaluate: mockCustomAttributeConditionEvaluator,
246+
});
222247
});
223248

224249
afterEach(function() {
@@ -229,69 +254,110 @@ describe('lib/core/audience_evaluator', function() {
229254
conditionTreeEvaluator.evaluate.callsFake(function(conditions, leafEvaluator) {
230255
return leafEvaluator(conditions[1]);
231256
});
232-
customAttributeConditionEvaluator.evaluate.returns(null);
257+
258+
mockCustomAttributeConditionEvaluator.returns(null);
233259
var userAttributes = { device_model: 5.5 };
234260
var user = getMockUserContext(userAttributes);
261+
262+
const audienceEvaluator = createAudienceEvaluator({}, mockLogger);
263+
235264
var result = audienceEvaluator.evaluate(['or', '1'], audiencesById, user);
236-
sinon.assert.calledOnce(customAttributeConditionEvaluator.evaluate);
265+
266+
sinon.assert.calledOnce(mockCustomAttributeConditionEvaluator);
237267
sinon.assert.calledWithExactly(
238-
customAttributeConditionEvaluator.evaluate,
268+
mockCustomAttributeConditionEvaluator,
239269
iphoneUserAudience.conditions[1],
240270
user
241271
);
242272
assert.isFalse(result);
243-
assert.strictEqual(2, mockLogger.log.callCount);
244-
assert.strictEqual(
245-
buildLogMessageFromArgs(mockLogger.log.args[0]),
246-
'AUDIENCE_EVALUATOR: Starting to evaluate audience "1" with conditions: ["and",{"name":"device_model","value":"iphone","type":"custom_attribute"}].'
247-
);
248-
assert.strictEqual(buildLogMessageFromArgs(mockLogger.log.args[1]), 'AUDIENCE_EVALUATOR: Audience "1" evaluated to UNKNOWN.');
273+
assert.strictEqual(2, mockLogger.debug.callCount);
274+
275+
sinon.assert.calledWithExactly(
276+
mockLogger.debug,
277+
EVALUATING_AUDIENCE,
278+
'1',
279+
JSON.stringify(['and', iphoneUserAudience.conditions[1]])
280+
)
281+
282+
sinon.assert.calledWithExactly(
283+
mockLogger.debug,
284+
AUDIENCE_EVALUATION_RESULT,
285+
'1',
286+
'UNKNOWN'
287+
)
249288
});
250289

251290
it('logs correctly when conditionTreeEvaluator.evaluate returns true', function() {
252291
conditionTreeEvaluator.evaluate.callsFake(function(conditions, leafEvaluator) {
253292
return leafEvaluator(conditions[1]);
254293
});
255-
customAttributeConditionEvaluator.evaluate.returns(true);
294+
295+
mockCustomAttributeConditionEvaluator.returns(true);
296+
256297
var userAttributes = { device_model: 'iphone' };
257298
var user = getMockUserContext(userAttributes);
299+
300+
const audienceEvaluator = createAudienceEvaluator({}, mockLogger);
301+
258302
var result = audienceEvaluator.evaluate(['or', '1'], audiencesById, user);
259-
sinon.assert.calledOnce(customAttributeConditionEvaluator.evaluate);
303+
sinon.assert.calledOnce(mockCustomAttributeConditionEvaluator);
260304
sinon.assert.calledWithExactly(
261-
customAttributeConditionEvaluator.evaluate,
305+
mockCustomAttributeConditionEvaluator,
262306
iphoneUserAudience.conditions[1],
263307
user,
264308
);
265309
assert.isTrue(result);
266-
assert.strictEqual(2, mockLogger.log.callCount);
267-
assert.strictEqual(
268-
buildLogMessageFromArgs(mockLogger.log.args[0]),
269-
'AUDIENCE_EVALUATOR: Starting to evaluate audience "1" with conditions: ["and",{"name":"device_model","value":"iphone","type":"custom_attribute"}].'
270-
);
271-
assert.strictEqual(buildLogMessageFromArgs(mockLogger.log.args[1]), 'AUDIENCE_EVALUATOR: Audience "1" evaluated to TRUE.');
310+
assert.strictEqual(2, mockLogger.debug.callCount);
311+
sinon.assert.calledWithExactly(
312+
mockLogger.debug,
313+
EVALUATING_AUDIENCE,
314+
'1',
315+
JSON.stringify(['and', iphoneUserAudience.conditions[1]])
316+
)
317+
318+
sinon.assert.calledWithExactly(
319+
mockLogger.debug,
320+
AUDIENCE_EVALUATION_RESULT,
321+
'1',
322+
'TRUE'
323+
)
272324
});
273325

274326
it('logs correctly when conditionTreeEvaluator.evaluate returns false', function() {
275327
conditionTreeEvaluator.evaluate.callsFake(function(conditions, leafEvaluator) {
276328
return leafEvaluator(conditions[1]);
277329
});
278-
customAttributeConditionEvaluator.evaluate.returns(false);
330+
331+
mockCustomAttributeConditionEvaluator.returns(false);
332+
279333
var userAttributes = { device_model: 'android' };
280334
var user = getMockUserContext(userAttributes);
335+
336+
const audienceEvaluator = createAudienceEvaluator({}, mockLogger);
337+
281338
var result = audienceEvaluator.evaluate(['or', '1'], audiencesById, user);
282-
sinon.assert.calledOnce(customAttributeConditionEvaluator.evaluate);
339+
sinon.assert.calledOnce(mockCustomAttributeConditionEvaluator);
283340
sinon.assert.calledWithExactly(
284-
customAttributeConditionEvaluator.evaluate,
341+
mockCustomAttributeConditionEvaluator,
285342
iphoneUserAudience.conditions[1],
286343
user,
287344
);
288345
assert.isFalse(result);
289-
assert.strictEqual(2, mockLogger.log.callCount);
290-
assert.strictEqual(
291-
buildLogMessageFromArgs(mockLogger.log.args[0]),
292-
'AUDIENCE_EVALUATOR: Starting to evaluate audience "1" with conditions: ["and",{"name":"device_model","value":"iphone","type":"custom_attribute"}].'
293-
);
294-
assert.strictEqual(buildLogMessageFromArgs(mockLogger.log.args[1]), 'AUDIENCE_EVALUATOR: Audience "1" evaluated to FALSE.');
346+
assert.strictEqual(2, mockLogger.debug.callCount);
347+
348+
sinon.assert.calledWithExactly(
349+
mockLogger.debug,
350+
EVALUATING_AUDIENCE,
351+
'1',
352+
JSON.stringify(['and', iphoneUserAudience.conditions[1]])
353+
)
354+
355+
sinon.assert.calledWithExactly(
356+
mockLogger.debug,
357+
AUDIENCE_EVALUATION_RESULT,
358+
'1',
359+
'FALSE'
360+
)
295361
});
296362
});
297363
});

‎lib/core/audience_evaluator/index.ts‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
import { getLogger } from '../../modules/logging';
17-
18-
import fns from '../../utils/fns';
1916
import {
2017
LOG_LEVEL,
2118
} from '../../utils/enums';
@@ -25,11 +22,13 @@ import * as odpSegmentsConditionEvaluator from './odp_segment_condition_evaluato
2522
import { Audience, Condition, OptimizelyUserContext } from '../../shared_types';
2623
import { CONDITION_EVALUATOR_ERROR, UNKNOWN_CONDITION_TYPE } from '../../error_messages';
2724
import { AUDIENCE_EVALUATION_RESULT, EVALUATING_AUDIENCE} from '../../log_messages';
25+
import { LoggerFacade } from '../../logging/logger';
2826

29-
const logger = getLogger();
3027
const MODULE_NAME = 'AUDIENCE_EVALUATOR';
3128

3229
export class AudienceEvaluator {
30+
private logger?: LoggerFacade;
31+
3332
private typeToEvaluatorMap: {
3433
[key: string]: {
3534
[key: string]: (condition: Condition, user: OptimizelyUserContext) => boolean | null
@@ -43,11 +42,12 @@ export class AudienceEvaluator {
4342
* Optimizely evaluators cannot be overridden.
4443
* @constructor
4544
*/
46-
constructor(UNSTABLE_conditionEvaluators: unknown) {
45+
constructor(UNSTABLE_conditionEvaluators: unknown, logger?: LoggerFacade) {
46+
this.logger = logger;
4747
this.typeToEvaluatorMap = {
4848
...UNSTABLE_conditionEvaluators as any,
49-
custom_attribute: customAttributeConditionEvaluator,
50-
third_party_dimension: odpSegmentsConditionEvaluator,
49+
custom_attribute: customAttributeConditionEvaluator.getEvaluator(this.logger),
50+
third_party_dimension: odpSegmentsConditionEvaluator.getEvaluator(this.logger),
5151
};
5252
}
5353

@@ -77,16 +77,15 @@ export class AudienceEvaluator {
7777
const evaluateAudience = (audienceId: string) => {
7878
const audience = audiencesById[audienceId];
7979
if (audience) {
80-
logger.log(
81-
LOG_LEVEL.DEBUG,
82-
EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)
80+
this.logger?.debug(
81+
EVALUATING_AUDIENCE, audienceId, JSON.stringify(audience.conditions)
8382
);
8483
const result = conditionTreeEvaluator.evaluate(
8584
audience.conditions as unknown[] ,
8685
this.evaluateConditionWithUserAttributes.bind(this, user)
8786
);
8887
const resultText = result === null ? 'UNKNOWN' : result.toString().toUpperCase();
89-
logger.log(LOG_LEVEL.DEBUG, AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText);
88+
this.logger?.debug(AUDIENCE_EVALUATION_RESULT, audienceId, resultText);
9089
return result;
9190
}
9291
return null;
@@ -105,15 +104,14 @@ export class AudienceEvaluator {
105104
evaluateConditionWithUserAttributes(user: OptimizelyUserContext, condition: Condition): boolean | null {
106105
const evaluator = this.typeToEvaluatorMap[condition.type];
107106
if (!evaluator) {
108-
logger.log(LOG_LEVEL.WARNING, UNKNOWN_CONDITION_TYPE, MODULE_NAME, JSON.stringify(condition));
107+
this.logger?.warn(UNKNOWN_CONDITION_TYPE, JSON.stringify(condition));
109108
return null;
110109
}
111110
try {
112111
return evaluator.evaluate(condition, user);
113112
} catch (err: any) {
114-
logger.log(
115-
LOG_LEVEL.ERROR,
116-
CONDITION_EVALUATOR_ERROR, MODULE_NAME, condition.type, err.message
113+
this.logger?.error(
114+
CONDITION_EVALUATOR_ERROR, condition.type, err.message
117115
);
118116
}
119117

@@ -123,6 +121,6 @@ export class AudienceEvaluator {
123121

124122
export default AudienceEvaluator;
125123

126-
export const createAudienceEvaluator = function(UNSTABLE_conditionEvaluators: unknown): AudienceEvaluator {
127-
return new AudienceEvaluator(UNSTABLE_conditionEvaluators);
124+
export const createAudienceEvaluator = function(UNSTABLE_conditionEvaluators: unknown, logger?: LoggerFacade): AudienceEvaluator {
125+
return new AudienceEvaluator(UNSTABLE_conditionEvaluators, logger);
128126
};

‎lib/core/audience_evaluator/odp_segment_condition_evaluator/index.tests.js‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ import { assert } from 'chai';
1818
import { sprintf } from '../../../utils/fns';
1919

2020
import { LOG_LEVEL } from '../../../utils/enums';
21-
import * as logging from '../../../modules/logging';
2221
import * as odpSegmentEvalutor from './';
2322
import { UNKNOWN_MATCH_TYPE } from '../../../error_messages';
2423

@@ -34,38 +33,44 @@ var getMockUserContext = (attributes, segments) => ({
3433
isQualifiedFor: segment => segments.indexOf(segment) > -1
3534
});
3635

36+
var createLogger = () => ({
37+
debug: () => {},
38+
info: () => {},
39+
warn: () => {},
40+
error: () => {},
41+
child: () => createLogger(),
42+
})
43+
3744
describe('lib/core/audience_evaluator/odp_segment_condition_evaluator', function() {
38-
var stubLogHandler;
45+
const mockLogger = createLogger();
46+
const { evaluate } = odpSegmentEvalutor.getEvaluator(mockLogger);
3947

4048
beforeEach(function() {
41-
stubLogHandler = {
42-
log: sinon.stub(),
43-
};
44-
logging.setLogLevel('notset');
45-
logging.setLogHandler(stubLogHandler);
49+
sinon.stub(mockLogger, 'warn');
50+
sinon.stub(mockLogger, 'error');
4651
});
4752

4853
afterEach(function() {
49-
logging.resetLogger();
54+
mockLogger.warn.restore();
55+
mockLogger.error.restore();
5056
});
5157

5258
it('should return true when segment qualifies and known match type is provided', () => {
53-
assert.isTrue(odpSegmentEvalutor.evaluate(odpSegment1Condition, getMockUserContext({}, ['odp-segment-1'])));
59+
assert.isTrue(evaluate(odpSegment1Condition, getMockUserContext({}, ['odp-segment-1'])));
5460
});
5561

5662
it('should return false when segment does not qualify and known match type is provided', () => {
57-
assert.isFalse(odpSegmentEvalutor.evaluate(odpSegment1Condition, getMockUserContext({}, ['odp-segment-2'])));
63+
assert.isFalse(evaluate(odpSegment1Condition, getMockUserContext({}, ['odp-segment-2'])));
5864
})
5965

6066
it('should return null when segment qualifies but unknown match type is provided', () => {
6167
const invalidOdpMatchCondition = {
6268
... odpSegment1Condition,
6369
"match": 'unknown',
6470
};
65-
assert.isNull(odpSegmentEvalutor.evaluate(invalidOdpMatchCondition, getMockUserContext({}, ['odp-segment-1'])));
66-
sinon.assert.calledOnce(stubLogHandler.log);
67-
assert.strictEqual(stubLogHandler.log.args[0][0], LOG_LEVEL.WARNING);
68-
var logMessage = stubLogHandler.log.args[0][1];
69-
assert.strictEqual(logMessage, sprintf(UNKNOWN_MATCH_TYPE, 'ODP_SEGMENT_CONDITION_EVALUATOR', JSON.stringify(invalidOdpMatchCondition)));
71+
assert.isNull(evaluate(invalidOdpMatchCondition, getMockUserContext({}, ['odp-segment-1'])));
72+
sinon.assert.calledOnce(mockLogger.warn);
73+
assert.strictEqual(mockLogger.warn.args[0][0], UNKNOWN_MATCH_TYPE);
74+
assert.strictEqual(mockLogger.warn.args[0][1], JSON.stringify(invalidOdpMatchCondition));
7075
});
7176
});

0 commit comments

Comments
 (0)