fix(api): Only track attributes with valid attribute types. #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I need to review it, will do it later today. |
mikeproeng37
suggested changes
Sep 18, 2018
There was a problem hiding this comment.
@msohailhussain I ran the compat tests for this and most of them pass except for this one:
✔ Before # features/support/steps.js:35
✔ Given the datafile is "ab_experiments.json" # features/support/steps.js:130
✔ And 1 "Activate" listener is added # features/support/steps.js:136
✔ When activate is called with arguments # features/support/steps.js:201
"""
experiment_key: ab_running_exp_untargeted
user_id: test_user_1
attributes:
customattr: null
"""
✔ Then the result should be "all_traffic_variation" # features/support/steps.js:221
✖ And in the response, "listener_called" should match # features/support/steps.js:209
"""
- experiment_key: ab_running_exp_untargeted
user_id: test_user_1
variation_key: all_traffic_variation
attributes:
customattr: null
"""
AssertionError
+ expected - actual
[
{
- "attributes": {}
+ "attributes": {
+ "customattr": [null]
+ }
"experiment_key": "ab_running_exp_untargeted"
"user_id": "test_user_1"
"variation_key": "all_traffic_variation"
}
at World.<anonymous> (/app/features/support/steps.js:211:35)```
Looks like the notification we send to the notification listener doesn't include this `null` attribute value when it should.
OptimizelySDK/Utils/Validator.cs
Outdated
| @@ -103,14 +103,24 @@ public static bool IsFeatureFlagValid(ProjectConfig projectConfig, FeatureFlag f | |||
| return true; | |||
| } | |||
|
|
|||
| private static Type[] AttributeTypes = | |||
There was a problem hiding this comment.
typeof generally takes too much time to get the type. Why we just don't replace with attribute types with string[].
OptimizelySDK/Utils/Validator.cs
Outdated
| /// <summary> | ||
| /// Determine if given user attribute is valid. | ||
| /// </summary> | ||
| /// <param name="attribute">Attribute key and value pair</param> | ||
| /// <returns>true if attribute key is not null and value is one of the supported type, false otherwise</returns> | ||
| public static bool IsUserAttributeValid(KeyValuePair<string, object> attribute) | ||
| { | ||
| return !string.IsNullOrEmpty(attribute.Key) && attribute.Value is string || attribute.Value is bool || attribute.Value is int || attribute.Value is double; | ||
| return !string.IsNullOrEmpty(attribute.Key) && AttributeTypes.Contains(attribute.Value?.GetType()); |
There was a problem hiding this comment.
.GetType().Name returns string, which we can use.
|
@mikeng13 Thanks Mike, once Python PR is merged, I will take a look at this PR. |
corrected unit tests IsUserAttributeValid
mikeproeng37
approved these changes
Sep 20, 2018
| @@ -155,16 +155,28 @@ public void TestIsUserAttributeValidWithValidValues() | |||
| [Test] | |||
| public void TestIsUserAttributeValidWithInvalidValues() | |||
| { | |||
| var userAttributes = new UserAttributes | |||
| var userAttributesInvalid = new UserAttributes | |||
There was a problem hiding this comment.
nit: Let's call this invalidUserAttributes
| [Test] | ||
| public void TestIsUserAttributeValidWithEmptyKeyOrValue() | ||
| { | ||
| var userAttributesValid = new UserAttributes |
| [Test] | ||
| public void TestIsUserAttributeValidWithInvalidValues() | ||
| { | ||
| var userAttributesInvalid = new UserAttributes |
There was a problem hiding this comment.
nit: Can we call this invalidUserAttributes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.