Skip to content

Commit b9c2faf

Browse files
junaed-optimizelyjunaed-optimizely
committed
[FSSDK-10935] log adjustment
1 parent 32a592a commit b9c2faf

File tree

23 files changed

+541
-416
lines changed

23 files changed

+541
-416
lines changed

‎lib/core/audience_evaluator/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ import { getLogger } from '../../modules/logging';
1818
import fns from '../../utils/fns';
1919
import {
2020
LOG_LEVEL,
21-
LOG_MESSAGES,
2221
} from '../../utils/enums';
2322
import * as conditionTreeEvaluator from '../condition_tree_evaluator';
2423
import * as customAttributeConditionEvaluator from '../custom_attribute_condition_evaluator';
2524
import * as odpSegmentsConditionEvaluator from './odp_segment_condition_evaluator';
2625
import { Audience, Condition, OptimizelyUserContext } from '../../shared_types';
2726
import { CONDITION_EVALUATOR_ERROR } from '../../error_messages';
27+
import { AUDIENCE_EVALUATION_RESULT, EVALUATING_AUDIENCE, UNKNOWN_CONDITION_TYPE } from '../../log_messages';
2828

2929
const logger = getLogger();
3030
const MODULE_NAME = 'AUDIENCE_EVALUATOR';
@@ -78,14 +78,14 @@ export class AudienceEvaluator {
7878
if (audience) {
7979
logger.log(
8080
LOG_LEVEL.DEBUG,
81-
LOG_MESSAGES.EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)
81+
EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)
8282
);
8383
const result = conditionTreeEvaluator.evaluate(
8484
audience.conditions as unknown[] ,
8585
this.evaluateConditionWithUserAttributes.bind(this, user)
8686
);
8787
const resultText = result === null ? 'UNKNOWN' : result.toString().toUpperCase();
88-
logger.log(LOG_LEVEL.DEBUG, LOG_MESSAGES.AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText);
88+
logger.log(LOG_LEVEL.DEBUG, AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText);
8989
return result;
9090
}
9191
return null;
@@ -104,7 +104,7 @@ export class AudienceEvaluator {
104104
evaluateConditionWithUserAttributes(user: OptimizelyUserContext, condition: Condition): boolean | null {
105105
const evaluator = this.typeToEvaluatorMap[condition.type];
106106
if (!evaluator) {
107-
logger.log(LOG_LEVEL.WARNING, LOG_MESSAGES.UNKNOWN_CONDITION_TYPE, MODULE_NAME, JSON.stringify(condition));
107+
logger.log(LOG_LEVEL.WARNING, UNKNOWN_CONDITION_TYPE, MODULE_NAME, JSON.stringify(condition));
108108
return null;
109109
}
110110
try {

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,10 @@ import sinon from 'sinon';
1717
import { assert } from 'chai';
1818
import { sprintf } from '../../../utils/fns';
1919

20-
import {
21-
LOG_LEVEL,
22-
LOG_MESSAGES,
23-
} from '../../../utils/enums';
20+
import { LOG_LEVEL } from '../../../utils/enums';
2421
import * as logging from '../../../modules/logging';
2522
import * as odpSegmentEvalutor from './';
23+
import { UNKNOWN_MATCH_TYPE } from '../../../log_messages';
2624

2725
var odpSegment1Condition = {
2826
"value": "odp-segment-1",
@@ -68,6 +66,6 @@ describe('lib/core/audience_evaluator/odp_segment_condition_evaluator', function
6866
sinon.assert.calledOnce(stubLogHandler.log);
6967
assert.strictEqual(stubLogHandler.log.args[0][0], LOG_LEVEL.WARNING);
7068
var logMessage = stubLogHandler.log.args[0][1];
71-
assert.strictEqual(logMessage, sprintf(LOG_MESSAGES.UNKNOWN_MATCH_TYPE, 'ODP_SEGMENT_CONDITION_EVALUATOR', JSON.stringify(invalidOdpMatchCondition)));
69+
assert.strictEqual(logMessage, sprintf(UNKNOWN_MATCH_TYPE, 'ODP_SEGMENT_CONDITION_EVALUATOR', JSON.stringify(invalidOdpMatchCondition)));
7270
});
7371
});

‎lib/core/audience_evaluator/odp_segment_condition_evaluator/index.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313
* See the License for the specific language governing permissions and *
1414
* limitations under the License. *
1515
***************************************************************************/
16+
import { UNKNOWN_MATCH_TYPE } from '../../../log_messages';
1617
import { getLogger } from '../../../modules/logging';
1718
import { Condition, OptimizelyUserContext } from '../../../shared_types';
1819

19-
import { LOG_MESSAGES } from '../../../utils/enums';
20-
2120
const MODULE_NAME = 'ODP_SEGMENT_CONDITION_EVALUATOR';
2221

2322
const logger = getLogger();
@@ -45,7 +44,7 @@ EVALUATORS_BY_MATCH_TYPE[QUALIFIED_MATCH_TYPE] = qualifiedEvaluator;
4544
export function evaluate(condition: Condition, user: OptimizelyUserContext): boolean | null {
4645
const conditionMatch = condition.match;
4746
if (typeof conditionMatch !== 'undefined' && MATCH_TYPES.indexOf(conditionMatch) === -1) {
48-
logger.warn(LOG_MESSAGES.UNKNOWN_MATCH_TYPE, MODULE_NAME, JSON.stringify(condition));
47+
logger.warn(UNKNOWN_MATCH_TYPE, MODULE_NAME, JSON.stringify(condition));
4948
return null;
5049
}
5150

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

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,17 @@ import { cloneDeep } from 'lodash';
1919
import { sprintf } from '../../utils/fns';
2020

2121
import * as bucketer from './';
22-
import {
23-
ERROR_MESSAGES,
24-
LOG_MESSAGES,
25-
LOG_LEVEL,
26-
} from '../../utils/enums';
22+
import { LOG_LEVEL } from '../../utils/enums';
2723
import { createLogger } from '../../plugins/logger';
2824
import projectConfig from '../../project_config/project_config';
2925
import { getTestProjectConfig } from '../../tests/test_data';
3026
import { INVALID_BUCKETING_ID, INVALID_GROUP_ID } from '../../error_messages';
27+
import {
28+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
29+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
30+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
31+
USER_NOT_IN_ANY_EXPERIMENT,
32+
} from '../../log_messages';
3133

3234
var buildLogMessageFromArgs = args => sprintf(args[1], ...args.splice(2));
3335
var testData = getTestProjectConfig();
@@ -79,7 +81,7 @@ describe('lib/core/bucketer', function () {
7981

8082
var bucketedUser_log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
8183
expect(bucketedUser_log1).to.equal(
82-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'ppid1')
84+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'ppid1')
8385
);
8486

8587
var bucketerParamsTest2 = cloneDeep(bucketerParams);
@@ -89,7 +91,7 @@ describe('lib/core/bucketer', function () {
8991
var notBucketedUser_log1 = buildLogMessageFromArgs(createdLogger.log.args[1]);
9092

9193
expect(notBucketedUser_log1).to.equal(
92-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'ppid2')
94+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'ppid2')
9395
);
9496
});
9597
});
@@ -141,13 +143,13 @@ describe('lib/core/bucketer', function () {
141143

142144
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
143145
expect(log1).to.equal(
144-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
146+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
145147
);
146148

147149
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
148150
expect(log2).to.equal(
149151
sprintf(
150-
LOG_MESSAGES.USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
152+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
151153
'BUCKETER',
152154
'testUser',
153155
'groupExperiment1',
@@ -157,7 +159,7 @@ describe('lib/core/bucketer', function () {
157159

158160
var log3 = buildLogMessageFromArgs(createdLogger.log.args[2]);
159161
expect(log3).to.equal(
160-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
162+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
161163
);
162164
});
163165

@@ -172,12 +174,12 @@ describe('lib/core/bucketer', function () {
172174

173175
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
174176
expect(log1).to.equal(
175-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '5000', 'testUser')
177+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '5000', 'testUser')
176178
);
177179
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
178180
expect(log2).to.equal(
179181
sprintf(
180-
LOG_MESSAGES.USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
182+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
181183
'BUCKETER',
182184
'testUser',
183185
'groupExperiment1',
@@ -197,10 +199,10 @@ describe('lib/core/bucketer', function () {
197199

198200
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
199201
expect(log1).to.equal(
200-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'testUser')
202+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'testUser')
201203
);
202204
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
203-
expect(log2).to.equal(sprintf(LOG_MESSAGES.USER_NOT_IN_ANY_EXPERIMENT, 'BUCKETER', 'testUser', '666'));
205+
expect(log2).to.equal(sprintf(USER_NOT_IN_ANY_EXPERIMENT, 'BUCKETER', 'testUser', '666'));
204206
});
205207

206208
it('should return decision response with variation null when a user is bucketed into traffic space of deleted experiment within a random group', function () {
@@ -214,10 +216,10 @@ describe('lib/core/bucketer', function () {
214216

215217
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
216218
expect(log1).to.equal(
217-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '9000', 'testUser')
219+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '9000', 'testUser')
218220
);
219221
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
220-
expect(log2).to.equal(sprintf(LOG_MESSAGES.USER_NOT_IN_ANY_EXPERIMENT, 'BUCKETER', 'testUser', '666'));
222+
expect(log2).to.equal(sprintf(USER_NOT_IN_ANY_EXPERIMENT, 'BUCKETER', 'testUser', '666'));
221223
});
222224

223225
it('should throw an error if group ID is not in the datafile', function () {
@@ -255,7 +257,7 @@ describe('lib/core/bucketer', function () {
255257
sinon.assert.calledOnce(createdLogger.log);
256258

257259
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
258-
expect(log1).to.equal(sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '0', 'testUser'));
260+
expect(log1).to.equal(sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '0', 'testUser'));
259261
});
260262

261263
it('should return decision response with variation null when a user does not fall into an experiment within an overlapping group', function () {

‎lib/core/bucketer/index.ts

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,15 @@ import {
2727
Group,
2828
} from '../../shared_types';
2929

30-
import {
31-
LOG_LEVEL,
32-
LOG_MESSAGES,
33-
} from '../../utils/enums';
30+
import { LOG_LEVEL } from '../../utils/enums';
3431
import { INVALID_BUCKETING_ID, INVALID_GROUP_ID } from '../../error_messages';
32+
import {
33+
INVALID_VARIATION_ID,
34+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
35+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
36+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
37+
USER_NOT_IN_ANY_EXPERIMENT,
38+
} from '../../log_messages';
3539

3640
const HASH_SEED = 1;
3741
const MAX_HASH_VALUE = Math.pow(2, 32);
@@ -77,13 +81,13 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
7781
if (bucketedExperimentId === null) {
7882
bucketerParams.logger.log(
7983
LOG_LEVEL.INFO,
80-
LOG_MESSAGES.USER_NOT_IN_ANY_EXPERIMENT,
84+
USER_NOT_IN_ANY_EXPERIMENT,
8185
MODULE_NAME,
8286
bucketerParams.userId,
8387
groupId,
8488
);
8589
decideReasons.push([
86-
LOG_MESSAGES.USER_NOT_IN_ANY_EXPERIMENT,
90+
USER_NOT_IN_ANY_EXPERIMENT,
8791
MODULE_NAME,
8892
bucketerParams.userId,
8993
groupId,
@@ -98,14 +102,14 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
98102
if (bucketedExperimentId !== bucketerParams.experimentId) {
99103
bucketerParams.logger.log(
100104
LOG_LEVEL.INFO,
101-
LOG_MESSAGES.USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
105+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
102106
MODULE_NAME,
103107
bucketerParams.userId,
104108
bucketerParams.experimentKey,
105109
groupId,
106110
);
107111
decideReasons.push([
108-
LOG_MESSAGES.USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
112+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
109113
MODULE_NAME,
110114
bucketerParams.userId,
111115
bucketerParams.experimentKey,
@@ -120,14 +124,14 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
120124
// Continue bucketing if user is bucketed into specified experiment
121125
bucketerParams.logger.log(
122126
LOG_LEVEL.INFO,
123-
LOG_MESSAGES.USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
127+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
124128
MODULE_NAME,
125129
bucketerParams.userId,
126130
bucketerParams.experimentKey,
127131
groupId,
128132
);
129133
decideReasons.push([
130-
LOG_MESSAGES.USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
134+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
131135
MODULE_NAME,
132136
bucketerParams.userId,
133137
bucketerParams.experimentKey,
@@ -140,13 +144,13 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
140144

141145
bucketerParams.logger.log(
142146
LOG_LEVEL.DEBUG,
143-
LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
147+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
144148
MODULE_NAME,
145149
bucketValue,
146150
bucketerParams.userId,
147151
);
148152
decideReasons.push([
149-
LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
153+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
150154
MODULE_NAME,
151155
bucketValue,
152156
bucketerParams.userId,
@@ -156,8 +160,8 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
156160
if (entityId !== null) {
157161
if (!bucketerParams.variationIdMap[entityId]) {
158162
if (entityId) {
159-
bucketerParams.logger.log(LOG_LEVEL.WARNING, LOG_MESSAGES.INVALID_VARIATION_ID, MODULE_NAME);
160-
decideReasons.push([LOG_MESSAGES.INVALID_VARIATION_ID, MODULE_NAME]);
163+
bucketerParams.logger.log(LOG_LEVEL.WARNING, INVALID_VARIATION_ID, MODULE_NAME);
164+
decideReasons.push([INVALID_VARIATION_ID, MODULE_NAME]);
161165
}
162166
return {
163167
result: null,
@@ -190,7 +194,7 @@ export const bucketUserIntoExperiment = function(
190194
const bucketValue = _generateBucketValue(bucketingKey);
191195
logger.log(
192196
LOG_LEVEL.DEBUG,
193-
LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
197+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
194198
MODULE_NAME,
195199
bucketValue,
196200
userId,

0 commit comments

Comments
 (0)