vwo_log_messages 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c3dcfefaf8e02723047621b3c544729d44755de2e077f84da89d5f4203fd61e
-  data.tar.gz: 6a9480b7497a12b0b290dffffcdec516013eaa37ba415b92ce81ef5bdc42ceb0
+  metadata.gz: 3d81b8ecc23551b618b699e28d3564ef468d9d055d06ecf97834e9dcc3fa98de
+  data.tar.gz: 43751265483c233994d7af8bce1305d1aa168935498ca79a25ed28f19a8a80df
 SHA512:
-  metadata.gz: ea240d2f182c3cc85c1c9e99765bc34b697323c6ae9556023634287e25595a9e7e614f7bc6127c5fc831ca1efb0545155df408b417f2d3ecf371a2352c9aa72f
-  data.tar.gz: 6c4541d00b68dfb902f947d178064e4cddef905f7b935c44005264a1e0d8b797b56dcd8adc325f4ab11490d0d97098341ee559dd4cf951accf0a3918006261c0
+  metadata.gz: 2940a7711d75782c7a9dd0560db594bbe5ee43c4c13295370fe8b397775dd215334b60fa70018e35229d3c339408737a000a3ddab7b0ec3730f0e758888090a8
+  data.tar.gz: 2a12c2ce9253bb2a2086ff1e1a8d96ea8d3f1ee621c9571546d47264ab941d4f68ad340950b8498d7b86812a25a0ad907a1fb6b2db3ec6d375afa4696687b501

data/src/VwoSdkLogMessages.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace vwo;
+
+class VwoSdkLogMessages {
+
+  public static function get()
+  {
+    return [
+      "debugLogs" => json_decode(file_get_contents(__DIR__ . "/debug-messages.json"), true),
+      "infoLogs" => json_decode(file_get_contents(__DIR__ . "/info-messages.json"), true),
+      "errorLogs" => json_decode(file_get_contents(__DIR__ . "/error-messages.json"), true),
+      "warnLogs" => json_decode(file_get_contents(__DIR__ . "/warning-messages.json"), true)
+    ];
+  }
+}

data/src/debug-messages.json

@@ -0,0 +1,36 @@
+{
+  "CONFIG_BATCH_EVENT_LIMIT_EXCEEDED": "({file}): Impression event - {endPoint} failed due to exceeding payload size. Parameter eventsPerRequest in batchEvents config in launch API has value:{eventsPerRequest} for account ID:{accountId}. Please read the official documentation for knowing the size limits",
+  "CONFIG_LOG_LEVEL_SET": "({file}): Log level set to {level}",
+  "CONFIG_CUSTOM_LOGGER_USED": "({file}): Custom logger used",
+  "CONFIG_DEVELOPMENT_MODE_STATUS": "({file}): DEVELOPMENT mode is ON. No tracking call will be made to VWO Server",
+
+  "POLLING_SETTINGS_FILE_REGISTERED": "({file}): Polling of settings-file is registered with a periodic interval of {pollingInterval} ms",
+
+  "SETTINGS_FILE_PROCESSED": "({file}): settings-file matches the schema, validated and properly processed for the Account ID:{accountId}",
+
+  "IMPRESSION_FOR_TRACK_USER": "({file}): Impression built for tracking user - {properties}",
+  "IMPRESSION_FOR_TRACK_GOAL": "({file}): Impression built for tracking goal - {properties}",
+  "IMPRESSION_FOR_PUSH": "({file}): Impression built for pushing custom dimension - {properties}",
+
+  "IMPRESSION_FOR_EVENT_ARCH_TRACK_USER": "({file}): Impression built for vwo_variationShown event for Account ID:{accountId}, User ID:{userId}, and Campaign ID:{campaignId}",
+  "IMPRESSION_FOR_EVENT_ARCH_TRACK_GOAL": "({file}): Impression built for {goalName} event for Account ID:{accountId}, User ID:{userId}, and Campaign ID:{campaignId}",
+  "IMPRESSION_FOR_EVENT_ARCH_PUSH": "({file}): Impression built for visitor-property:{property} for Account ID:{accountId} and User ID:{userId}",
+
+  "EVENT_BATCH_BEFORE_FLUSHING": "({file}): flushing event queue {manually} having {length} events for Account ID:{accountId}. {timer}",
+  "EVENT_BATCH_FLUSH": "{{file}}: Manually flushing batch events for Account ID:{accountId} having {queueLength} events",
+
+  "USER_STORAGE_SERVICE_NOT_CONFIGURED": "({file}): User Storage Service is not configured to get/set the data",
+  "USER_STORAGE_SERVICE_NO_STORED_DATA": "({file}): No stored variation for User ID:{userId} for Campaign:{campaignKey} found in User Storage Service",
+
+  "VARIATION_RANGE_ALLOCATION": "({file}): Variation:{variationName} of Campaign:{campaignKey} having weight:{variationWeight} got bucketing range: ( {start} - {end} )",
+
+  "MEG_ELIGIBLE_CAMPAIGNS": "({file}): Campaigns: {eligibleCampaignKeys} are eligible, {inEligibleText} are ineligible from the Group:{groupName} for the User ID:{userId}",
+
+  "SEGMENTATION_SKIPPED": "({file}): Segmentation is not used for Campaign:{campaignKey}, hence skipping evaluating segmentation{variation} for User ID:{userId}",
+  "SEGMENTATION_STATUS": "({file}): User ID:{userId} for Campaign:{campaignKey} with variables:{customVariables} {status} {segmentationType} {variation}",
+  "WHITELISTING_SKIPPED": "({file}): Whitelisting is not used for Campaign:{campaignKey}, hence skipping evaluating whitelisting for User ID:{userId}",
+
+  "USER_UUID": "({file}): VWO UUID generated for Account Id:{accountId} and User ID:{userId} is {uuid}",
+  "USER_HASH_BUCKET_VALUE": "({file}): User ID:{userId} having hash:{hashValue} got bucketValue:{bucketValue}",
+  "USER_CAMPAIGN_BUCKET_VALUES": "({file}): User ID:{userId} for Campaign:{campaignKey} having percent-traffic:{percentTraffic} got hash-value:{hashValue} and bucket-value:{bucketValue}"
+}

data/src/error-messages.json

@@ -0,0 +1,40 @@
+{
+  "CONFIG_PARAMETER_INVALID": "({file}): {parameter} paased in {api} API is not correct. It should be of type:{type}",
+  "CONFIG_POLLING_SDK_KEY_NOT_PROVIVED": "({file}): SDK Key is required along with pollingInterval to poll the settings-file",
+  "CONFIG_CORRUPTED": "({file}): Config passed to {api} API is invalid. Please refer developer docs",
+
+  "SETTINGS_FILE_INVALID": "({file}): Settings file passed while instantiating SDK instance is invalid",
+  "SETTINGS_FILE_CORRUPTED": "({file}): Fetched settings-file doesn't match the desired schema. Please contact VWO Support for help",
+
+  "BATCH_QUEUE_EMPTY": "{{file}}: No batch queue present for account:{accountId} when calling flushEvents API. Check batchEvents config in launch API",
+
+  "API_HAS_CORRUPTED_SETTINGS_FILE": "({file}): {api} API has corrupted settings-file. Please check or reach out to VWO support",
+
+  "API_BAD_PARAMETERS": "({file}): {api} API got bad parameters. Refer the developer docs",
+  "API_NOT_APPLICABLE": "({file}): {api} API is not valid for Campaign:{campaignKey} having type:{campaignType} for User ID:{userId}",
+
+  "USER_ID_INVALID": "({file}): Invalid User Id:{userId} passed to the API",
+
+  "CAMPAIGN_NOT_FOUND_FOR_GOAL": "({file}): No such campaign found corresponding to goalIdentifier:{goalIdentifier}. Please verify from VWO app",
+
+  "POLLING_FAILED": "({file}): Fetching of settings-file failed via polling for the accountId:{accountId}",
+
+  "SEGMENTATION_REGEX_CREATION_FAILED": "({file}): Regular expression:{regex} used for targeting cound not be evaluated",
+  "SEGMENTATION_ERROR": "({file}): Could not segment the User ID:{userId} for Campaign:{campaignKey}{variation} with customVariables:{customVariables}. Error message: {err}",
+
+  "USER_STORAGE_SERVICE_GET_FAILED": "({file}): Getting data from User Storage Service failed for User ID:{userId}. Error: {error}",
+  "USER_STORAGE_SERVICE_SET_FAILED": "({file}): Saving data into User Storage Service failed for User ID:{userId}. Error: {error}",
+
+  "IMPRESSION_FAILED": "({file}): Impression event could not be sent to VWO - {endPoint}. Reason: {err}",
+
+  "TAG_KEY_LENGTH_EXCEEDED": "({file}): Length of custom dimension key:{tagKey} for User Id:{userId} can not be greater than 255",
+  "TAG_VALUE_LENGTH_EXCEEDED": "({file}): Length of custom dimension value:{tagValue} of tagKey:{tagKey} for User Id:{userId} can not be greater than 255",
+
+  "TRACK_API_GOAL_NOT_FOUND": "({file}): Goal:{goalIdentifier} not found for Campaign:{campaignKey} and User Id:{userId}",
+  "TRACK_API_REVENUE_NOT_PASSED_FOR_REVENUE_GOAL": "({file}): Revenue value should be passed for revenue goal:{goalIdentifier} for Campaign:{campaignKey} and User Id:{userId}",
+
+  "UNABLE_TO_CAST_VALUE": "({file}): Unable to cast value:{variableValue} to type:{variableType}, returning null",
+  "VARIABLE_NOT_FOUND": "({file}): Variable:{variableKey} for User ID:{userId} is not found in settings-file, returning null",
+  "MISSING_IMPORT_SETTINGS_MANDATORY_PARAMS": "AccountId and sdkKey are required for fetching account settings. Aborting!",
+  "ACCOUNT_SETTINGS_NOT_FOUND":  "({file}): Request failed for fetching account settings. Got Status Code: ${statusCode} and message: ${message}"
+}

data/src/info-messages.json

@@ -0,0 +1,58 @@
+{
+  "CONFIG_VALID": "({file}): SDK configuration and account settings-file are valid",
+  "CONFIG_PARAMETER_USED": "({file}): {parameter} paased in launch API having type:{type}",
+  "CONFIG_RETURN_PROMISE": "({file}): {method} API returns a promise as returnPromiseFor is set to true for this API",
+
+  "SDK_INITIALIZED": "({file}): SDK is properly initialzed with the passed configuration",
+
+  "POLLING_SUCCESS": "({file}): settings-file fetched successfully via polling for the accountId:{accountId}",
+  "POLLING_SETTINGS_FILE_UPDATED": "({file}): SDK instance is updated with the latest settings-file for the accountId:{accountId}",
+  "POLLING_SETTINGS_FILE_NOT_UPDATED": "{file}: settings-file fetched via polling is same as earlier fetched settings",
+
+  "DECISION_NO_VARIATION_ALLOTED": "({file}): Variation was not assigned to the User ID:{userId} for Campaign:{campaignKey}",
+
+
+  "EVENT_BATCH_DEFAULTS": "({file}): {parameter} not passed in SDK configuration, setting it default to {defaultValue}",
+  "EVENT_QUEUE": "({file}): Event with payload:{event} pushed to the {queueType} queue",
+  "EVENT_BATCH_After_FLUSHING": "({file}): Event queue having {length} events has been flushed {manually}",
+
+  "CAMPAIGN_NOT_ACTIVATED": "({file}): Activate the campaign:{campaignKey} first for User ID:{userId} to {reason}",
+  "CAMPAIGN_USER_ALREADY_TRACKED": "({file}): User ID:{userId} for Campaign:{campaignKey} has already been tracked earlier for \"{api}\" API. No tracking call is made to VWO server",
+  "CAMPAIGN_GOAL_ALREADY_TRACKED": "({file}): Goal:{goalIdentifier} of Campaign:{campaignKey} for User ID:{userId} has already been tracked earlier. No tracking call is made to VWO server",
+
+  "GOT_STORED_VARIATION": "({file}): Got stored variation from User Storage Service for User ID:{userId} for Campaign:{campaignKey} as Variation:{variationName}",
+  "GETTING_DATA_USER_STORAGE_SERVICE": "({file}): Read data from User Storage Service for User ID:{userId} and Campaign:{campaignKey}",
+  "SETTING_DATA_USER_STORAGE_SERVICE": "({file}): Set data into User Storage Service for User ID:{userId} and Campaign:{campaignKey}",
+
+  "IMPRESSION_SUCCESS": "({file}): Impression event - {endPoint} was successfully received by VWO having main keys: Account ID:{accountId}, {mainKeys}",
+  "IMPRESSION_SUCCESS_FOR_EVENT_ARCH": "({file}): Impression for {event} - {endPoint} was successfully received by VWO for Account ID:{accountId}",
+  "IMPRESSION_BATCH_SUCCESS": "({file}): Impression event - {endPoint} was successfully received by VWO having Account ID:{accountId}",
+  "IMPRESSION_BATCH_FAILED": "({file}): Batch events couldn\"t be received by VWO. Calling Flush Callback with error and data",
+
+  "MEG_ELIGIBLE_CAMPAIGNS": "({file}): Got {noOfEligibleCampaigns} eligible winners out of {noOfGroupCampaigns} campaigns from the Group:{groupName} and for User ID:{userId}",
+
+  "OTHER_CAMPAIGN_SATISFIES_WHITELISTING_STORAGE": "({file}): Campaign:{campaignKey} of Group:{groupName} satisfies {type} for User ID:{userId}",
+  "SEGMENTATION_STATUS": "({file}): User ID:{userId} for Campaign:{campaignKey} with variables:{customVariables} {status} {segmentationType} {variation}",
+
+  "MEG_CALLED_CAMPAIGN_NOT_WINNER": "({file}): Campaign:{campaignKey} does not qualify from the mutually exclusive group:{groupName} for User ID:{userId}",
+  "MEG_GOT_WINNER_CAMPAIGN": "({file}): Campaign:{campaignKey} is selected from the mutually exclusive group:{groupName} for the User ID:{userId}",
+
+  "FEATURE_STATUS": "({file}): Campaign:{campaignKey} is {status} for user ID:{userId}",
+
+  "FEATURE_VARIABLE_VALUE": "({file}): For User ID:{userId}, value for variable:{variableKey} of feature:{campaignKey} is:{variableValue}",
+  "FEATURE_VARIABLE_DEFAULT_VALUE": "({file}): Feature is not enabled for variation:{variationName}. Returning default value for the variable:{variableKey}",
+
+  "USER_NOT_PART_OF_CAMPAIGN": "({file}): User ID:{userId} did not qualify for Campaign:{campaignKey}",
+  "USER_VARIATION_STATUS": "({file}): User ID:{userId} for Campaign:{campaignKey} {status}",
+  "USER_CAMPAIGN_ELIGIBILITY": "({file}): User ID:{userId} for Campaign:{campaignKey} is {status} to become part of campaign",
+  "USER_VARIATION_ALLOCATION_STATUS": "({file}): User ID:{userId} for Campaign:{campaignKey} {status}",
+
+  "OPT_OUT_API_CALLED": "({file}): You have opted out for not tracking i.e. all API calls will stop functioning and will simply early return",
+  "API_NOT_ENABLED": "({file}): {api} API is disabled as you opted out for tracking. Reinitialize the SDK to enable the normal functioning of all APIs.",
+
+  "INITIATING_ACTIVATE": "({file}): Initiating activation of user {userId} for campaign {campaignKey}.",
+  "INITIATING_GET_VARIATION": "({file}): Initiating getVariation of user '{userId}' for campaign '{campaignKey}'.",
+  "INITIATING_GET_FEATURE_VARIATION": "({file}): Initiating getFeatureVariable for variable key '{variableKey}' of user '{userId}' for campaign '{campaignKey}'.",
+  "INITIATING_IS_FEATURE_ENABLED": "({file}): Initiating isFeatureEnabled of user '{userId}' for campaign '{campaignKey}'.",
+  "INITIATING_PUSH_DIMENSION": "({file}): Initiating push segment of user '{userId}' with tag name `{tagKey}` and tag value '{tagValue}'."
+}

data/src/warning-messages.json

@@ -0,0 +1,4 @@
+{
+  "CAMPAIGN_NOT_RUNNING": "({file}): {api} API called with Campaign:{campaignKey} but the campaign is not RUNNING. Please verify from VWO App",
+  "CAMPAIGN_NOT_ACTIVATED": "({file}): Campaign:{campaignKey} for User ID:{userId} is not yet activated for API:{api}. Use activate API to activate A/B test or isFeatureEnabled API to activate Feature Test"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vwo_log_messages
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - VWO
@@ -18,6 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/vwo_log_messages.rb
+- src/VwoSdkLogMessages.php
+- src/debug-messages.json
+- src/error-messages.json
+- src/info-messages.json
+- src/warning-messages.json
 homepage: https://vwo.com/fullstack/server-side-testing/
 licenses:
 - Apache-2.0
@@ -26,6 +31,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- src
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="