[FSSDK-10935] exception log adjustment

Author: junaed-optimizely

lib/error_messages.ts

@@ -77,3 +77,7 @@ export const INVALID_INPUT_FORMAT = '%s: 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';
 export const INVALID_VARIATION_KEY = '%s: 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'
+export const DATAFILE_FETCH_REQUEST_FAILED = 'Datafile fetch request failed with status: %s'
+export const ONRUNNING_ERROR = 'onRunning error'

lib/event_processor/batch_event_processor.ts

@@ -27,6 +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";
 
 export type EventWithId = {
   id: string;
@@ -160,7 +162,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(`Failed to dispatch events: ${res.statusCode}`));
+        return Promise.reject(new Error(sprintf(FAILED_TO_DISPATCH_EVENTS_WITH_ARG, res.statusCode)));
       }
       return Promise.resolve(res);
     });
@@ -195,7 +197,7 @@ export class BatchEventProcessor extends BaseService implements EventProcessor {
     }).catch((err) => {
       // if the dispatch fails, the events will still be
       // in the store for future processing
-      this.logger?.error('Failed to dispatch events', err);
+      this.logger?.error(FAILED_TO_DISPATCH_EVENTS, err);
     }).finally(() => {
       this.runningTask.delete(taskId);
       ids.forEach((id) => this.dispatchingEventIds.delete(id));
@@ -253,7 +255,7 @@ export class BatchEventProcessor extends BaseService implements EventProcessor {
 
     if (this.isNew()) {
       // TOOD: replace message with imported constants
-      this.startPromise.reject(new Error('Event processor stopped before it could be started'));
+      this.startPromise.reject(new Error(EVENT_PROCESSOR_STOPPED));
     }
 
     this.state = ServiceState.Stopping;

lib/event_processor/event_dispatcher/default_dispatcher.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { ONLY_POST_REQUESTS_ARE_SUPPORTED } from '../../exception_messages';
 import { RequestHandler } from '../../utils/http_request_handler/http';
 import { EventDispatcher, EventDispatcherResponse, LogEvent } from './event_dispatcher';
 
@@ -28,7 +29,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 Error(ONLY_POST_REQUESTS_ARE_SUPPORTED));
     }
 
     const dataString = JSON.stringify(eventObj.params);

lib/event_processor/event_dispatcher/send_beacon_dispatcher.browser.ts

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

lib/event_processor/event_processor_factory.react_native.spec.ts

@@ -60,11 +60,11 @@ async function mockRequireNetInfo() {
   M._load = (uri: string, parent: string) => {
     if (uri === '@react-native-community/netinfo') {
       if (isNetInfoAvailable) return {};
-      throw new Error('Module not found: @react-native-community/netinfo');
+      throw new Error(MODULE_NOT_FOUND_REACT_NATIVE_NETINFO);
     }
     if (uri === '@react-native-async-storage/async-storage') {
       if (isAsyncStorageAvailable) return {};
-      throw new Error('Module not found: @react-native-async-storage/async-storage');
+      throw new Error(MODULE_NOT_FOUND_REACT_NATIVE_ASYNC_STORAGE);
     }
 
     return M._load_original(uri, parent);
@@ -80,6 +80,10 @@ import { AsyncCache, AsyncPrefixCache, SyncCache, SyncPrefixCache } from '../uti
 import { AsyncStorageCache } from '../utils/cache/async_storage_cache.react_native';
 import { ReactNativeNetInfoEventProcessor } from './batch_event_processor.react_native';
 import { BatchEventProcessor } from './batch_event_processor';
+import {
+  MODULE_NOT_FOUND_REACT_NATIVE_ASYNC_STORAGE,
+  MODULE_NOT_FOUND_REACT_NATIVE_NETINFO,
+} from '../exception_messages';
 
 describe('createForwardingEventProcessor', () => {
   const mockGetForwardingEventProcessor = vi.mocked(getForwardingEventProcessor);
@@ -163,7 +167,7 @@ describe('createBatchEventProcessor', () => {
     });
 
     expect(() => createBatchEventProcessor({})).toThrowError(
-      'Module not found: @react-native-async-storage/async-storage'
+      MODULE_NOT_FOUND_REACT_NATIVE_ASYNC_STORAGE
     );
 
     isAsyncStorageAvailable = true;

lib/event_processor/forwarding_event_processor.ts

@@ -23,6 +23,7 @@ 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';
 class ForwardingEventProcessor extends BaseService implements EventProcessor {
   private dispatcher: EventDispatcher;
   private eventEmitter: EventEmitter<{ dispatch: LogEvent }>;
@@ -54,7 +55,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 Error(SERVICE_STOPPED_BEFORE_IT_WAS_STARTED));
     }
 
     this.state = ServiceState.Terminated;

lib/exception_messages.ts

@@ -0,0 +1,26 @@
+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 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_DATAFILE_IN_SSR = 'You must provide datafile in SSR';
+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_ERROR = 'Request error';
+export const UNSUPPORTED_PROTOCOL = 'Unsupported protocol: %s';
+export const REQUEST_TIMEOUT = 'Request timed out';
+export const NO_STATUS_CODE_IN_RESPONSE = 'No status code in response';
+export const MODULE_NOT_FOUND_REACT_NATIVE_ASYNC_STORAGE = 'Module not found: @react-native-async-storage/async-storage';
+export const MODULE_NOT_FOUND_REACT_NATIVE_NETINFO = 'Module not found: @react-native-community/netinfo';
+export const INVALID_CONFIG_OR_SOMETHING = 'Invalid config or something';
+export const PROMISE_SHOULD_NOT_HAVE_RESOLVED = 'Promise should not have resolved';

lib/index.browser.tests.js

@@ -34,6 +34,7 @@ import { getMockProjectConfigManager } from './tests/mock/mock_project_config_ma
 import { createProjectConfig } from './project_config/project_config';
 import { ODP_EVENT_FAILED_ODP_MANAGER_MISSING } from './error_messages';
 import { ODP_DISABLED, ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED } from './log_messages';
+import { INVALID_CONFIG_OR_SOMETHING } from './exception_messages';
 
 
 class MockLocalStorage {
@@ -163,7 +164,7 @@ describe('javascript-sdk (Browser)', function() {
       // });
 
       it('should not throw if the provided config is not valid', function() {
-        configValidator.validate.throws(new Error('Invalid config or something'));
+        configValidator.validate.throws(new Error(INVALID_CONFIG_OR_SOMETHING));
         assert.doesNotThrow(function() {
           var optlyInstance = optimizelyFactory.createInstance({
             projectConfigManager: getMockProjectConfigManager(),

lib/index.browser.umdtests.js

@@ -23,6 +23,7 @@ import Optimizely from './optimizely';
 import testData from './tests/test_data';
 import packageJSON from '../package.json';
 import eventDispatcher from './plugins/event_dispatcher/index.browser';
+import { INVALID_CONFIG_OR_SOMETHING } from './exception_messages';
 
 describe('javascript-sdk', function() {
   describe('APIs', function() {
@@ -92,7 +93,7 @@ describe('javascript-sdk', function() {
       });
 
       it('should not throw if the provided config is not valid', function() {
-        configValidator.validate.throws(new Error('Invalid config or something'));
+        configValidator.validate.throws(new Error(INVALID_CONFIG_OR_SOMETHING));
         assert.doesNotThrow(function() {
           var optlyInstance = window.optimizelySdk.createInstance({
             datafile: {},

lib/index.lite.tests.js

@@ -22,6 +22,7 @@ import * as loggerPlugin from './plugins/logger';
 import optimizelyFactory from './index.lite';
 import configValidator from './utils/config_validator';
 import { getMockProjectConfigManager } from './tests/mock/mock_project_config_manager';
+import { INVALID_CONFIG_OR_SOMETHING } from './exception_messages';
 
 describe('optimizelyFactory', function() {
   describe('APIs', function() {
@@ -52,7 +53,7 @@ describe('optimizelyFactory', function() {
       });
 
       it('should not throw if the provided config is not valid and log an error if logger is passed in', function() {
-        configValidator.validate.throws(new Error('Invalid config or something'));
+        configValidator.validate.throws(new Error(INVALID_CONFIG_OR_SOMETHING));
         var localLogger = loggerPlugin.createLogger({ logLevel: enums.LOG_LEVEL.INFO });
         assert.doesNotThrow(function() {
           var optlyInstance = optimizelyFactory.createInstance({