Skip to content

Commit 51e8c1a

Browse files
junaed-optimizelyjunaed-optimizely
authored
[FSSDK-10935] Refactor log object export (#976)
1 parent 1adcbdb commit 51e8c1a

File tree

62 files changed

+966
-678
lines changed

Some content is hidden

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

62 files changed

+966
-678
lines changed

‎lib/core/audience_evaluator/index.ts

Lines changed: 6 additions & 6 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,
22-
ERROR_MESSAGES,
2321
} from '../../utils/enums';
2422
import * as conditionTreeEvaluator from '../condition_tree_evaluator';
2523
import * as customAttributeConditionEvaluator from '../custom_attribute_condition_evaluator';
2624
import * as odpSegmentsConditionEvaluator from './odp_segment_condition_evaluator';
2725
import { Audience, Condition, OptimizelyUserContext } from '../../shared_types';
26+
import { CONDITION_EVALUATOR_ERROR, UNKNOWN_CONDITION_TYPE } from '../../error_messages';
27+
import { AUDIENCE_EVALUATION_RESULT, EVALUATING_AUDIENCE} from '../../log_messages';
2828

2929
const logger = getLogger();
3030
const MODULE_NAME = 'AUDIENCE_EVALUATOR';
@@ -79,14 +79,14 @@ export class AudienceEvaluator {
7979
if (audience) {
8080
logger.log(
8181
LOG_LEVEL.DEBUG,
82-
LOG_MESSAGES.EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)
82+
EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)
8383
);
8484
const result = conditionTreeEvaluator.evaluate(
8585
audience.conditions as unknown[] ,
8686
this.evaluateConditionWithUserAttributes.bind(this, user)
8787
);
8888
const resultText = result === null ? 'UNKNOWN' : result.toString().toUpperCase();
89-
logger.log(LOG_LEVEL.DEBUG, LOG_MESSAGES.AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText);
89+
logger.log(LOG_LEVEL.DEBUG, AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText);
9090
return result;
9191
}
9292
return null;
@@ -105,15 +105,15 @@ export class AudienceEvaluator {
105105
evaluateConditionWithUserAttributes(user: OptimizelyUserContext, condition: Condition): boolean | null {
106106
const evaluator = this.typeToEvaluatorMap[condition.type];
107107
if (!evaluator) {
108-
logger.log(LOG_LEVEL.WARNING, LOG_MESSAGES.UNKNOWN_CONDITION_TYPE, MODULE_NAME, JSON.stringify(condition));
108+
logger.log(LOG_LEVEL.WARNING, UNKNOWN_CONDITION_TYPE, MODULE_NAME, JSON.stringify(condition));
109109
return null;
110110
}
111111
try {
112112
return evaluator.evaluate(condition, user);
113113
} catch (err: any) {
114114
logger.log(
115115
LOG_LEVEL.ERROR,
116-
ERROR_MESSAGES.CONDITION_EVALUATOR_ERROR, MODULE_NAME, condition.type, err.message
116+
CONDITION_EVALUATOR_ERROR, MODULE_NAME, condition.type, err.message
117117
);
118118
}
119119

‎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 '../../../error_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 '../../../error_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: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +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';
26+
import { INVALID_BUCKETING_ID, INVALID_GROUP_ID } from '../../error_messages';
27+
import {
28+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
29+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
30+
USER_NOT_IN_ANY_EXPERIMENT,
31+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
32+
} from '.';
3033

3134
var buildLogMessageFromArgs = args => sprintf(args[1], ...args.splice(2));
3235
var testData = getTestProjectConfig();
@@ -78,7 +81,7 @@ describe('lib/core/bucketer', function () {
7881

7982
var bucketedUser_log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
8083
expect(bucketedUser_log1).to.equal(
81-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'ppid1')
84+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'ppid1')
8285
);
8386

8487
var bucketerParamsTest2 = cloneDeep(bucketerParams);
@@ -88,7 +91,7 @@ describe('lib/core/bucketer', function () {
8891
var notBucketedUser_log1 = buildLogMessageFromArgs(createdLogger.log.args[1]);
8992

9093
expect(notBucketedUser_log1).to.equal(
91-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'ppid2')
94+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'ppid2')
9295
);
9396
});
9497
});
@@ -140,13 +143,13 @@ describe('lib/core/bucketer', function () {
140143

141144
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
142145
expect(log1).to.equal(
143-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
146+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
144147
);
145148

146149
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
147150
expect(log2).to.equal(
148151
sprintf(
149-
LOG_MESSAGES.USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
152+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
150153
'BUCKETER',
151154
'testUser',
152155
'groupExperiment1',
@@ -156,7 +159,7 @@ describe('lib/core/bucketer', function () {
156159

157160
var log3 = buildLogMessageFromArgs(createdLogger.log.args[2]);
158161
expect(log3).to.equal(
159-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
162+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50', 'testUser')
160163
);
161164
});
162165

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

172175
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
173176
expect(log1).to.equal(
174-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '5000', 'testUser')
177+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '5000', 'testUser')
175178
);
176179
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
177180
expect(log2).to.equal(
178181
sprintf(
179-
LOG_MESSAGES.USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
182+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
180183
'BUCKETER',
181184
'testUser',
182185
'groupExperiment1',
@@ -196,10 +199,10 @@ describe('lib/core/bucketer', function () {
196199

197200
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
198201
expect(log1).to.equal(
199-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'testUser')
202+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '50000', 'testUser')
200203
);
201204
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
202-
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'));
203206
});
204207

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

214217
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
215218
expect(log1).to.equal(
216-
sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '9000', 'testUser')
219+
sprintf(USER_ASSIGNED_TO_EXPERIMENT_BUCKET, 'BUCKETER', '9000', 'testUser')
217220
);
218221
var log2 = buildLogMessageFromArgs(createdLogger.log.args[1]);
219-
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'));
220223
});
221224

222225
it('should throw an error if group ID is not in the datafile', function () {
@@ -225,7 +228,7 @@ describe('lib/core/bucketer', function () {
225228

226229
assert.throws(function () {
227230
bucketer.bucket(bucketerParamsWithInvalidGroupId);
228-
}, sprintf(ERROR_MESSAGES.INVALID_GROUP_ID, 'BUCKETER', '6969'));
231+
}, sprintf(INVALID_GROUP_ID, 'BUCKETER', '6969'));
229232
});
230233
});
231234

@@ -254,7 +257,7 @@ describe('lib/core/bucketer', function () {
254257
sinon.assert.calledOnce(createdLogger.log);
255258

256259
var log1 = buildLogMessageFromArgs(createdLogger.log.args[0]);
257-
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'));
258261
});
259262

260263
it('should return decision response with variation null when a user does not fall into an experiment within an overlapping group', function () {
@@ -357,8 +360,8 @@ describe('lib/core/bucketer', function () {
357360
bucketer._generateBucketValue(null);
358361
} );
359362
expect([
360-
sprintf(ERROR_MESSAGES.INVALID_BUCKETING_ID, 'BUCKETER', null, "Cannot read property 'length' of null"), // node v14
361-
sprintf(ERROR_MESSAGES.INVALID_BUCKETING_ID, 'BUCKETER', null, "Cannot read properties of null (reading \'length\')") // node v16
363+
sprintf(INVALID_BUCKETING_ID, 'BUCKETER', null, "Cannot read property 'length' of null"), // node v14
364+
sprintf(INVALID_BUCKETING_ID, 'BUCKETER', null, "Cannot read properties of null (reading \'length\')") // node v16
362365
]).contain(response.message);
363366
});
364367
});

‎lib/core/bucketer/index.ts

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

30-
import {
31-
ERROR_MESSAGES,
32-
LOG_LEVEL,
33-
LOG_MESSAGES,
34-
} from '../../utils/enums';
30+
import { LOG_LEVEL } from '../../utils/enums';
31+
import { INVALID_BUCKETING_ID, INVALID_GROUP_ID } from '../../error_messages';
32+
33+
export const USER_NOT_IN_ANY_EXPERIMENT = '%s: User %s is not in any experiment of group %s.';
34+
export const USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP = '%s: User %s is not in experiment %s of group %s.';
35+
export const USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP = '%s: User %s is in experiment %s of group %s.';
36+
export const USER_ASSIGNED_TO_EXPERIMENT_BUCKET = '%s: Assigned bucket %s to user with bucketing ID %s.';
37+
export const INVALID_VARIATION_ID = '%s: Bucketed into an invalid variation ID. Returning null.';
3538

3639
const HASH_SEED = 1;
3740
const MAX_HASH_VALUE = Math.pow(2, 32);
@@ -63,7 +66,7 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
6366
if (groupId) {
6467
const group = bucketerParams.groupIdMap[groupId];
6568
if (!group) {
66-
throw new Error(sprintf(ERROR_MESSAGES.INVALID_GROUP_ID, MODULE_NAME, groupId));
69+
throw new Error(sprintf(INVALID_GROUP_ID, MODULE_NAME, groupId));
6770
}
6871
if (group.policy === RANDOM_POLICY) {
6972
const bucketedExperimentId = bucketUserIntoExperiment(
@@ -77,13 +80,13 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
7780
if (bucketedExperimentId === null) {
7881
bucketerParams.logger.log(
7982
LOG_LEVEL.INFO,
80-
LOG_MESSAGES.USER_NOT_IN_ANY_EXPERIMENT,
83+
USER_NOT_IN_ANY_EXPERIMENT,
8184
MODULE_NAME,
8285
bucketerParams.userId,
8386
groupId,
8487
);
8588
decideReasons.push([
86-
LOG_MESSAGES.USER_NOT_IN_ANY_EXPERIMENT,
89+
USER_NOT_IN_ANY_EXPERIMENT,
8790
MODULE_NAME,
8891
bucketerParams.userId,
8992
groupId,
@@ -98,14 +101,14 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
98101
if (bucketedExperimentId !== bucketerParams.experimentId) {
99102
bucketerParams.logger.log(
100103
LOG_LEVEL.INFO,
101-
LOG_MESSAGES.USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
104+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
102105
MODULE_NAME,
103106
bucketerParams.userId,
104107
bucketerParams.experimentKey,
105108
groupId,
106109
);
107110
decideReasons.push([
108-
LOG_MESSAGES.USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
111+
USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
109112
MODULE_NAME,
110113
bucketerParams.userId,
111114
bucketerParams.experimentKey,
@@ -120,14 +123,14 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
120123
// Continue bucketing if user is bucketed into specified experiment
121124
bucketerParams.logger.log(
122125
LOG_LEVEL.INFO,
123-
LOG_MESSAGES.USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
126+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
124127
MODULE_NAME,
125128
bucketerParams.userId,
126129
bucketerParams.experimentKey,
127130
groupId,
128131
);
129132
decideReasons.push([
130-
LOG_MESSAGES.USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
133+
USER_BUCKETED_INTO_EXPERIMENT_IN_GROUP,
131134
MODULE_NAME,
132135
bucketerParams.userId,
133136
bucketerParams.experimentKey,
@@ -140,13 +143,13 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
140143

141144
bucketerParams.logger.log(
142145
LOG_LEVEL.DEBUG,
143-
LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
146+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
144147
MODULE_NAME,
145148
bucketValue,
146149
bucketerParams.userId,
147150
);
148151
decideReasons.push([
149-
LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
152+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
150153
MODULE_NAME,
151154
bucketValue,
152155
bucketerParams.userId,
@@ -156,8 +159,8 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
156159
if (entityId !== null) {
157160
if (!bucketerParams.variationIdMap[entityId]) {
158161
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]);
162+
bucketerParams.logger.log(LOG_LEVEL.WARNING, INVALID_VARIATION_ID, MODULE_NAME);
163+
decideReasons.push([INVALID_VARIATION_ID, MODULE_NAME]);
161164
}
162165
return {
163166
result: null,
@@ -190,7 +193,7 @@ export const bucketUserIntoExperiment = function(
190193
const bucketValue = _generateBucketValue(bucketingKey);
191194
logger.log(
192195
LOG_LEVEL.DEBUG,
193-
LOG_MESSAGES.USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
196+
USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
194197
MODULE_NAME,
195198
bucketValue,
196199
userId,
@@ -235,7 +238,7 @@ export const _generateBucketValue = function(bucketingKey: string): number {
235238
const ratio = hashValue / MAX_HASH_VALUE;
236239
return Math.floor(ratio * MAX_TRAFFIC_VALUE);
237240
} catch (ex: any) {
238-
throw new Error(sprintf(ERROR_MESSAGES.INVALID_BUCKETING_ID, MODULE_NAME, bucketingKey, ex.message));
241+
throw new Error(sprintf(INVALID_BUCKETING_ID, MODULE_NAME, bucketingKey, ex.message));
239242
}
240243
};
241244

0 commit comments

Comments
 (0)