err msg

Author: raju-opti

lib/core/bucketer/index.tests.js

@@ -29,6 +29,7 @@ import {
   USER_NOT_IN_ANY_EXPERIMENT,
   USER_ASSIGNED_TO_EXPERIMENT_BUCKET,
 } from '.';
+import { OptimizelyError } from '../../error/optimizly_error';
 
 var buildLogMessageFromArgs = args => sprintf(args[1], ...args.splice(2));
 var testData = getTestProjectConfig();
@@ -204,9 +205,11 @@ describe('lib/core/bucketer', function () {
             var bucketerParamsWithInvalidGroupId = cloneDeep(bucketerParams);
             bucketerParamsWithInvalidGroupId.experimentIdMap[configObj.experiments[4].id].groupId = '6969';
 
-            assert.throws(function () {
+            const ex = assert.throws(function () {
               bucketer.bucket(bucketerParamsWithInvalidGroupId);
-            }, sprintf(INVALID_GROUP_ID, 'BUCKETER', '6969'));
+            });
+            assert.equal(ex.baseMessage, INVALID_GROUP_ID);
+            assert.deepEqual(ex.params, ['6969']);
           });
         });
 
@@ -343,10 +346,7 @@ describe('lib/core/bucketer', function () {
        const response = assert.throws(function() {
           bucketer._generateBucketValue(null);
         } );
-        expect([
-          sprintf(INVALID_BUCKETING_ID, 'BUCKETER', null, "Cannot read property 'length' of null"),  // node v14
-          sprintf(INVALID_BUCKETING_ID, 'BUCKETER', null, "Cannot read properties of null (reading \'length\')")  // node v16
-        ]).contain(response.message);
+        expect(response.baseMessage).to.equal(INVALID_BUCKETING_ID);
       });
     });
 

lib/core/bucketer/index.ts

@@ -29,6 +29,7 @@ import {
 
 import { LOG_LEVEL } from '../../utils/enums';
 import { INVALID_BUCKETING_ID, INVALID_GROUP_ID } from '../../error_messages';
+import { OptimizelyError } from '../../error/optimizly_error';
 
 export const USER_NOT_IN_ANY_EXPERIMENT = 'User %s is not in any experiment of group %s.';
 export const USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP = 'User %s is not in experiment %s of group %s.';
@@ -66,7 +67,7 @@ export const bucket = function(bucketerParams: BucketerParams): DecisionResponse
   if (groupId) {
     const group = bucketerParams.groupIdMap[groupId];
     if (!group) {
-      throw new Error(sprintf(INVALID_GROUP_ID, MODULE_NAME, groupId));
+      throw new OptimizelyError(INVALID_GROUP_ID, groupId);
     }
     if (group.policy === RANDOM_POLICY) {
       const bucketedExperimentId = bucketUserIntoExperiment(
@@ -228,7 +229,7 @@ export const _generateBucketValue = function(bucketingKey: string): number {
     const ratio = hashValue / MAX_HASH_VALUE;
     return Math.floor(ratio * MAX_TRAFFIC_VALUE);
   } catch (ex: any) {
-    throw new Error(sprintf(INVALID_BUCKETING_ID, MODULE_NAME, bucketingKey, ex.message));
+    throw new OptimizelyError(INVALID_BUCKETING_ID, bucketingKey, ex.message);
   }
 };
 

lib/core/decision_service/index.ts

@@ -96,6 +96,7 @@ import {
   VALID_BUCKETING_ID,
   VARIATION_REMOVED_FOR_USER,
 } from '../../log_messages';
+import { OptimizelyError } from '../../error/optimizly_error';
 
 export const MODULE_NAME = 'DECISION_SERVICE';
 
@@ -975,7 +976,7 @@ export class DecisionService {
    */
   removeForcedVariation(userId: string, experimentId: string, experimentKey: string): void {
     if (!userId) {
-      throw new Error(sprintf(INVALID_USER_ID, MODULE_NAME));
+      throw new OptimizelyError(INVALID_USER_ID);
     }
 
     if (this.forcedVariationMap.hasOwnProperty(userId)) {
@@ -986,7 +987,7 @@ export class DecisionService {
         userId,
       );
     } else {
-      throw new Error(sprintf(USER_NOT_IN_FORCED_VARIATION, MODULE_NAME, userId));
+      throw new OptimizelyError(USER_NOT_IN_FORCED_VARIATION, userId);
     }
   }
 

lib/error_messages.ts

@@ -18,33 +18,33 @@ export const BROWSER_ODP_MANAGER_INITIALIZATION_FAILED = '%s: Error initializing
 export const CONDITION_EVALUATOR_ERROR = 'Error evaluating audience condition of type %s: %s';
 export const DATAFILE_AND_SDK_KEY_MISSING =
   '%s: You must provide at least one of sdkKey or datafile. Cannot start Optimizely';
-export const EXPERIMENT_KEY_NOT_IN_DATAFILE = '%s: Experiment key %s is not in datafile.';
+export const EXPERIMENT_KEY_NOT_IN_DATAFILE = 'Experiment key %s is not in datafile.';
 export const FEATURE_NOT_IN_DATAFILE = 'Feature key %s is not in datafile.';
 export const FETCH_SEGMENTS_FAILED_NETWORK_ERROR = '%s: Audience segments fetch failed. (network error)';
 export const FETCH_SEGMENTS_FAILED_DECODE_ERROR = '%s: Audience segments fetch failed. (decode error)';
 export const IMPROPERLY_FORMATTED_EXPERIMENT = 'Experiment key %s is improperly formatted.';
-export const INVALID_ATTRIBUTES = '%s: Provided attributes are in an invalid format.';
-export const INVALID_BUCKETING_ID = '%s: Unable to generate hash for bucketing ID %s: %s';
-export const INVALID_DATAFILE = '%s: Datafile is invalid - property %s: %s';
-export const INVALID_DATAFILE_MALFORMED = '%s: Datafile is invalid because it is malformed.';
-export const INVALID_CONFIG = '%s: Provided Optimizely config is in an invalid format.';
-export const INVALID_JSON = '%s: JSON object is not valid.';
-export const INVALID_ERROR_HANDLER = '%s: Provided "errorHandler" is in an invalid format.';
-export const INVALID_EVENT_DISPATCHER = '%s: Provided "eventDispatcher" is in an invalid format.';
-export const INVALID_EVENT_TAGS = '%s: Provided event tags are in an invalid format.';
+export const INVALID_ATTRIBUTES = 'Provided attributes are in an invalid format.';
+export const INVALID_BUCKETING_ID = 'Unable to generate hash for bucketing ID %s: %s';
+export const INVALID_DATAFILE = 'Datafile is invalid - property %s: %s';
+export const INVALID_DATAFILE_MALFORMED = 'Datafile is invalid because it is malformed.';
+export const INVALID_CONFIG = 'Provided Optimizely config is in an invalid format.';
+export const INVALID_JSON = 'JSON object is not valid.';
+export const INVALID_ERROR_HANDLER = 'Provided "errorHandler" is in an invalid format.';
+export const INVALID_EVENT_DISPATCHER = 'Provided "eventDispatcher" is in an invalid format.';
+export const INVALID_EVENT_TAGS = 'Provided event tags are in an invalid format.';
 export const INVALID_EXPERIMENT_KEY =
   'Experiment key %s is not in datafile. It is either invalid, paused, or archived.';
 export const INVALID_EXPERIMENT_ID = 'Experiment ID %s is not in datafile.';
-export const INVALID_GROUP_ID = '%s: Group ID %s is not in datafile.';
-export const INVALID_LOGGER = '%s: Provided "logger" is in an invalid format.';
+export const INVALID_GROUP_ID = 'Group ID %s is not in datafile.';
+export const INVALID_LOGGER = 'Provided "logger" is in an invalid format.';
 export const INVALID_ROLLOUT_ID = 'Invalid rollout ID %s attached to feature %s';
-export const INVALID_USER_ID = '%s: Provided user ID is in an invalid format.';
-export const INVALID_USER_PROFILE_SERVICE = '%s: Provided user profile service instance is in an invalid format: %s.';
+export const INVALID_USER_ID = 'Provided user ID is in an invalid format.';
+export const INVALID_USER_PROFILE_SERVICE = 'Provided user profile service instance is in an invalid format: %s.';
 export const LOCAL_STORAGE_DOES_NOT_EXIST = 'Error accessing window localStorage.';
 export const MISSING_INTEGRATION_KEY =
-  '%s: Integration key missing from datafile. All integrations should include a key.';
-export const NO_DATAFILE_SPECIFIED = '%s: No datafile specified. Cannot start optimizely.';
-export const NO_JSON_PROVIDED = '%s: No JSON object to validate against schema.';
+  'Integration key missing from datafile. All integrations should include a key.';
+export const NO_DATAFILE_SPECIFIED = 'No datafile specified. Cannot start optimizely.';
+export const NO_JSON_PROVIDED = 'No JSON object to validate against schema.';
 export const NO_EVENT_PROCESSOR = 'No event processor is provided';
 export const NO_VARIATION_FOR_EXPERIMENT_KEY = 'No variation key %s defined in datafile for experiment %s.';
 export const ODP_CONFIG_NOT_AVAILABLE = '%s: ODP is not integrated to the project.';
@@ -79,21 +79,21 @@ export const ODP_VUID_INITIALIZATION_FAILED = '%s: ODP VUID initialization faile
 export const ODP_VUID_REGISTRATION_FAILED = '%s: ODP VUID failed to be registered.';
 export const ODP_VUID_REGISTRATION_FAILED_EVENT_MANAGER_MISSING =
   '%s: ODP register vuid failed. (Event Manager not instantiated).';
-export const UNDEFINED_ATTRIBUTE = '%s: Provided attribute: %s has an undefined value.';
+export const UNDEFINED_ATTRIBUTE = 'Provided attribute: %s has an undefined value.';
 export const UNRECOGNIZED_ATTRIBUTE =
   'Unrecognized attribute %s provided. Pruning before sending event to Optimizely.';
 export const UNABLE_TO_CAST_VALUE = 'Unable to cast value %s to type %s, returning null.';
 export const USER_NOT_IN_FORCED_VARIATION =
-  '%s: User %s is not in the forced variation map. Cannot remove their forced variation.';
+  'User %s is not in the forced variation map. Cannot remove their forced variation.';
 export const USER_PROFILE_LOOKUP_ERROR = 'Error while looking up user profile for user ID "%s": %s.';
 export const USER_PROFILE_SAVE_ERROR = 'Error while saving user profile for user ID "%s": %s.';
 export const VARIABLE_KEY_NOT_IN_DATAFILE =
   '%s: Variable with key "%s" associated with feature with key "%s" is not in datafile.';
 export const VARIATION_ID_NOT_IN_DATAFILE = '%s: No variation ID %s defined in datafile for experiment %s.';
 export const VARIATION_ID_NOT_IN_DATAFILE_NO_EXPERIMENT = 'Variation ID %s is not in the datafile.';
-export const INVALID_INPUT_FORMAT = '%s: Provided %s is in an invalid format.';
+export const INVALID_INPUT_FORMAT = 'Provided %s is in an invalid format.';
 export const INVALID_DATAFILE_VERSION =
-  '%s: This version of the JavaScript SDK does not support the given datafile version: %s';
+  'This version of the JavaScript SDK does not support the given datafile version: %s';
 export const INVALID_VARIATION_KEY = 'Provided variation key is in an invalid format.';
 export const UNABLE_TO_GET_VUID = 'Unable to get VUID - ODP Manager is not instantiated yet.';
 export const ERROR_FETCHING_DATAFILE = 'Error fetching datafile: %s';
@@ -126,5 +126,25 @@ export const REQUEST_TIMEOUT = 'Request timeout';
 export const REQUEST_ERROR = 'Request error';
 export const NO_STATUS_CODE_IN_RESPONSE = 'No status code in response';
 export const UNSUPPORTED_PROTOCOL = 'Unsupported protocol: %s';
+export const ONREADY_TIMEOUT = 'onReady timeout expired after %s ms';
+export const INSTANCE_CLOSED = 'Instance closed';
+export const DATAFILE_MANAGER_STOPPED = 'Datafile manager stopped before it could be started';
+export const FAILED_TO_FETCH_DATAFILE = 'Failed to fetch datafile';
+export const NO_SDKKEY_OR_DATAFILE = 'At least one of sdkKey or datafile must be provided';
+export const RETRY_CANCELLED = 'Retry cancelled';
+export const SERVICE_STOPPED_BEFORE_IT_WAS_STARTED = 'Service stopped before it was started';
+export const ONLY_POST_REQUESTS_ARE_SUPPORTED = 'Only POST requests are supported';
+export const SEND_BEACON_FAILED = 'sendBeacon failed';
+export const FAILED_TO_DISPATCH_EVENTS = 'Failed to dispatch events'
+export const FAILED_TO_DISPATCH_EVENTS_WITH_ARG = 'Failed to dispatch events: %s';
+export const EVENT_PROCESSOR_STOPPED = 'Event processor stopped before it could be started';
+export const CANNOT_START_WITHOUT_ODP_CONFIG = 'cannot start without ODP config';
+export const START_CALLED_WHEN_ODP_IS_NOT_INTEGRATED = 'start() called when ODP is not integrated';
+export const ODP_ACTION_IS_NOT_VALID = 'ODP action is not valid (cannot be empty).';
+export const ODP_MANAGER_STOPPED_BEFORE_RUNNING = 'odp manager stopped before running';
+export const ODP_EVENT_MANAGER_STOPPED = "ODP event manager stopped before it could start";
+export const ONREADY_TIMEOUT_EXPIRED = 'onReady timeout expired after %s ms';
+export const DATAFILE_MANAGER_FAILED_TO_START = 'Datafile manager failed to start';
+
 
 export const messages: string[] = [];

lib/event_processor/batch_event_processor.ts

@@ -27,8 +27,8 @@ import { isSuccessStatusCode } from "../utils/http_request_handler/http_util";
 import { EventEmitter } from "../utils/event_emitter/event_emitter";
 import { IdGenerator } from "../utils/id_generator";
 import { areEventContextsEqual } from "./event_builder/user_event";
-import { EVENT_PROCESSOR_STOPPED, FAILED_TO_DISPATCH_EVENTS, FAILED_TO_DISPATCH_EVENTS_WITH_ARG } from "../exception_messages";
-import { sprintf } from "../utils/fns";
+import { EVENT_PROCESSOR_STOPPED, FAILED_TO_DISPATCH_EVENTS, FAILED_TO_DISPATCH_EVENTS_WITH_ARG } from "../error_messages";
+import { OptimizelyError } from "../error/optimizly_error";
 
 export const DEFAULT_MIN_BACKOFF = 1000;
 export const DEFAULT_MAX_BACKOFF = 32000;
@@ -165,7 +165,7 @@ export class BatchEventProcessor extends BaseService implements EventProcessor {
     const dispatcher = closing && this.closingEventDispatcher ? this.closingEventDispatcher : this.eventDispatcher;
     return dispatcher.dispatchEvent(request).then((res) => {
       if (res.statusCode && !isSuccessStatusCode(res.statusCode)) {
-        return Promise.reject(new Error(sprintf(FAILED_TO_DISPATCH_EVENTS_WITH_ARG, res.statusCode)));
+        return Promise.reject(new OptimizelyError(FAILED_TO_DISPATCH_EVENTS_WITH_ARG, res.statusCode));
       }
       return Promise.resolve(res);
     });
@@ -276,7 +276,7 @@ export class BatchEventProcessor extends BaseService implements EventProcessor {
     }
 
     if (this.isNew()) {
-      this.startPromise.reject(new Error(EVENT_PROCESSOR_STOPPED));
+      this.startPromise.reject(new OptimizelyError(EVENT_PROCESSOR_STOPPED));
     }
 
     this.state = ServiceState.Stopping;

lib/event_processor/event_dispatcher/default_dispatcher.ts

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ONLY_POST_REQUESTS_ARE_SUPPORTED } from '../../exception_messages';
+import { OptimizelyError } from '../../error/optimizly_error';
+import { ONLY_POST_REQUESTS_ARE_SUPPORTED } from '../../error_messages';
 import { RequestHandler } from '../../utils/http_request_handler/http';
 import { EventDispatcher, EventDispatcherResponse, LogEvent } from './event_dispatcher';
 
@@ -29,7 +30,7 @@ export class DefaultEventDispatcher implements EventDispatcher {
   ): Promise<EventDispatcherResponse> {
     // Non-POST requests not supported
     if (eventObj.httpVerb !== 'POST') {
-      return Promise.reject(new Error(ONLY_POST_REQUESTS_ARE_SUPPORTED));
+      return Promise.reject(new OptimizelyError(ONLY_POST_REQUESTS_ARE_SUPPORTED));
     }
 
     const dataString = JSON.stringify(eventObj.params);

lib/event_processor/event_dispatcher/send_beacon_dispatcher.browser.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import { SEND_BEACON_FAILED } from '../../exception_messages';
+import { OptimizelyError } from '../../error/optimizly_error';
+import { SEND_BEACON_FAILED } from '../../error_messages';
 import { EventDispatcher, EventDispatcherResponse } from './event_dispatcher';
 
 export type Event = {
@@ -42,7 +43,7 @@ export const dispatchEvent = function(
   if(success) {
     return Promise.resolve({});
   }
-  return Promise.reject(new Error(SEND_BEACON_FAILED));
+  return Promise.reject(new OptimizelyError(SEND_BEACON_FAILED));
 }
 
 const eventDispatcher : EventDispatcher = {

lib/event_processor/forwarding_event_processor.ts

@@ -23,7 +23,8 @@ import { buildLogEvent } from './event_builder/log_event';
 import { BaseService, ServiceState } from '../service';
 import { EventEmitter } from '../utils/event_emitter/event_emitter';
 import { Consumer, Fn } from '../utils/type';
-import { SERVICE_STOPPED_BEFORE_IT_WAS_STARTED } from '../exception_messages';
+import { SERVICE_STOPPED_BEFORE_IT_WAS_STARTED } from '../error_messages';
+import { OptimizelyError } from '../error/optimizly_error';
 class ForwardingEventProcessor extends BaseService implements EventProcessor {
   private dispatcher: EventDispatcher;
   private eventEmitter: EventEmitter<{ dispatch: LogEvent }>;
@@ -55,7 +56,7 @@ class ForwardingEventProcessor extends BaseService implements EventProcessor {
     }
 
     if (this.isNew()) {
-      this.startPromise.reject(new Error(SERVICE_STOPPED_BEFORE_IT_WAS_STARTED));
+      this.startPromise.reject(new OptimizelyError(SERVICE_STOPPED_BEFORE_IT_WAS_STARTED));
     }
 
     this.state = ServiceState.Terminated;

lib/exception_messages.ts

@@ -14,25 +14,4 @@
  * limitations under the License.
  */
 
-export const FAILED_TO_DISPATCH_EVENTS = 'Failed to dispatch events'
-export const FAILED_TO_DISPATCH_EVENTS_WITH_ARG = 'Failed to dispatch events: %s';
-export const EVENT_PROCESSOR_STOPPED = 'Event processor stopped before it could be started';
-export const SERVICE_STOPPED_BEFORE_IT_WAS_STARTED = 'Service stopped before it was started';
-export const ONLY_POST_REQUESTS_ARE_SUPPORTED = 'Only POST requests are supported';
-export const SEND_BEACON_FAILED = 'sendBeacon failed';
-export const CANNOT_START_WITHOUT_ODP_CONFIG = 'cannot start without ODP config';
-export const START_CALLED_WHEN_ODP_IS_NOT_INTEGRATED = 'start() called when ODP is not integrated';
-export const ODP_ACTION_IS_NOT_VALID = 'ODP action is not valid (cannot be empty).';
-export const ODP_MANAGER_STOPPED_BEFORE_RUNNING = 'odp manager stopped before running';
-export const ODP_EVENT_MANAGER_STOPPED = "ODP event manager stopped before it could start";
-export const ONREADY_TIMEOUT_EXPIRED = 'onReady timeout expired after %s ms';
-export const INSTANCE_CLOSED = 'Instance closed';
-export const DATAFILE_MANAGER_STOPPED = 'Datafile manager stopped before it could be started';
-export const DATAFILE_MANAGER_FAILED_TO_START = 'Datafile manager failed to start';
-export const FAILED_TO_FETCH_DATAFILE = 'Failed to fetch datafile';
-export const FAILED_TO_STOP = 'Failed to stop';
-export const YOU_MUST_PROVIDE_AT_LEAST_ONE_OF_SDKKEY_OR_DATAFILE = 'You must provide at least one of sdkKey or datafile';
-export const RETRY_CANCELLED = 'Retry cancelled';
-export const REQUEST_FAILED = 'Request failed';
-export const PROMISE_SHOULD_NOT_HAVE_RESOLVED = 'Promise should not have resolved';
-export const VUID_IS_NOT_SUPPORTED_IN_NODEJS= 'VUID is not supported in Node.js environment';
+

lib/odp/event_manager/odp_event_api_manager.spec.ts

@@ -41,7 +41,6 @@ const PIXEL_URL = 'https://odp.pixel.com';
 const odpConfig = new OdpConfig(API_KEY, API_HOST, PIXEL_URL, []);
 
 import { getMockRequestHandler } from '../../tests/mock/mock_request_handler';
-import { REQUEST_FAILED } from '../../exception_messages';
 
 describe('DefaultOdpEventApiManager', () => {
   it('should generate the event request using the correct odp config and event', async () => {
@@ -101,7 +100,7 @@ describe('DefaultOdpEventApiManager', () => {
   it('should return a promise that fails if the requestHandler response promise fails', async () => {
     const mockRequestHandler = getMockRequestHandler();
     mockRequestHandler.makeRequest.mockReturnValue({
-      responsePromise: Promise.reject(new Error(REQUEST_FAILED)),
+      responsePromise: Promise.reject(new Error('REQUEST_FAILED')),
     });
     const requestGenerator = vi.fn().mockReturnValue({
       method: 'PATCH',
@@ -115,7 +114,7 @@ describe('DefaultOdpEventApiManager', () => {
     const manager = new DefaultOdpEventApiManager(mockRequestHandler, requestGenerator);
     const response = manager.sendEvents(odpConfig, ODP_EVENTS);
 
-    await expect(response).rejects.toThrow('Request failed');
+    await expect(response).rejects.toThrow();
   });
 
   it('should return a promise that resolves with correct response code from the requestHandler', async () => {