[FSSDK-8284] Add allowed types to UserAttributes (#886)

optimizely · Dec 22, 2023 · 2b40193 · 2b40193
1 parent 01b099b
commit 2b40193
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 11 deletions.
diff --git a/lib/core/custom_attribute_condition_evaluator/index.ts b/lib/core/custom_attribute_condition_evaluator/index.ts
@@ -241,7 +241,7 @@ function greaterThanEvaluator(condition: Condition, user: OptimizelyUserContext)
   if (!validateValuesForNumericCondition(condition, user) || conditionValue === null) {
     return null;
   }
-  return userValue > conditionValue;
+  return userValue! > conditionValue;
 }
 
 /**
@@ -262,7 +262,7 @@ function greaterThanOrEqualEvaluator(condition: Condition, user: OptimizelyUserC
     return null;
   }
 
-  return userValue >= conditionValue;
+  return userValue! >= conditionValue;
 }
 
 /**
@@ -283,7 +283,7 @@ function lessThanEvaluator(condition: Condition, user: OptimizelyUserContext): b
     return null;
   }
 
-  return userValue < conditionValue;
+  return userValue! < conditionValue;
 }
 
 /**
@@ -304,7 +304,7 @@ function lessThanOrEqualEvaluator(condition: Condition, user: OptimizelyUserCont
     return null;
   }
 
-  return userValue <= conditionValue;
+  return userValue! <= conditionValue;
 }
 
 /**

diff --git a/lib/core/decision_service/index.ts b/lib/core/decision_service/index.ts
@@ -766,7 +766,7 @@ export class DecisionService {
       attributes.hasOwnProperty(CONTROL_ATTRIBUTES.BUCKETING_ID)
     ) {
       if (typeof attributes[CONTROL_ATTRIBUTES.BUCKETING_ID] === 'string') {
-        bucketingId = attributes[CONTROL_ATTRIBUTES.BUCKETING_ID];
+        bucketingId = String(attributes[CONTROL_ATTRIBUTES.BUCKETING_ID]);
         this.logger.log(LOG_LEVEL.DEBUG, LOG_MESSAGES.VALID_BUCKETING_ID, MODULE_NAME, bucketingId);
       } else {
         this.logger.log(LOG_LEVEL.WARNING, LOG_MESSAGES.BUCKETING_ID_NOT_STRING, MODULE_NAME);

diff --git a/lib/core/event_builder/event_helpers.ts b/lib/core/event_builder/event_helpers.ts
@@ -245,7 +245,7 @@ function buildVisitorAttributes(
           builtAttributes.push({
             entityId: attributeId,
             key: attributeKey,
-            value: attributes[attributeKey],
+            value: attributeValue!,
           });
         }
       }

diff --git a/lib/core/event_builder/index.ts b/lib/core/event_builder/index.ts
@@ -157,7 +157,7 @@ function getCommonEventParams({
             entity_id: attributeId,
             key: attributeKey,
             type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
-            value: attributes[attributeKey],
+            value: attributeValue!,
           });
         }
       }

diff --git a/lib/export_types.ts b/lib/export_types.ts
@@ -19,6 +19,7 @@
  */
 
 export {
+  UserAttributeValue,
   UserAttributes,
   OptimizelyConfig,
   OptimizelyVariable,

diff --git a/lib/optimizely_user_context/index.ts b/lib/optimizely_user_context/index.ts
@@ -20,6 +20,7 @@ import {
   OptimizelyDecision,
   OptimizelyDecisionContext,
   OptimizelyForcedDecision,
+  UserAttributeValue,
   UserAttributes,
 } from '../shared_types';
 import { CONTROL_ATTRIBUTES } from '../utils/enums';
@@ -80,7 +81,7 @@ export default class OptimizelyUserContext implements IOptimizelyUserContext {
    * @param     {string}                     key         An attribute key
    * @param     {any}                        value       An attribute value
    */
-  setAttribute(key: string, value: unknown): void {
+  setAttribute(key: string, value: UserAttributeValue): void {
     this.attributes[key] = value;
   }
 

diff --git a/lib/shared_types.ts b/lib/shared_types.ts
@@ -55,10 +55,10 @@ export interface DecisionResponse<T> {
   readonly reasons: (string | number)[][];
 }
 
+export type UserAttributeValue = string | number | boolean | null;
+
 export type UserAttributes = {
-  // TODO[OASIS-6649]: Don't use any type
-  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-  [name: string]: any;
+  [name: string]: UserAttributeValue;
 };
 
 export interface ExperimentBucketMap {