Implement IP Anonymization (#87)

Author: mauerbac

optimizely/event_builder.py

@@ -124,6 +124,7 @@ class EventParams(object):
     SOURCE_SDK_TYPE = 'client_name'
     SOURCE_SDK_VERSION = 'client_version'
     CUSTOM = 'custom'
+    ANONYMIZE_IP = 'anonymize_ip'
 
   def _add_attributes(self, attributes):
     """ Add attribute(s) information to the event.
@@ -172,6 +173,11 @@ def _add_visitor(self, user_id):
     visitor[self.EventParams.SNAPSHOTS] = []
     self.params[self.EventParams.USERS].append(visitor)
 
+  def _add_anonymize_ip(self):
+    """ Add IP anonymization bool to the event """
+
+    self.params[self.EventParams.ANONYMIZE_IP] = self.config.get_anonymize_ip_value()
+
   def _add_common_params(self, user_id, attributes):
     """ Add params which are used same in both conversion and impression events.
 
@@ -184,6 +190,7 @@ def _add_common_params(self, user_id, attributes):
     self._add_visitor(user_id)
     self._add_attributes(attributes)
     self._add_source()
+    self._add_anonymize_ip()
 
   def _add_required_params_for_impression(self, experiment, variation_id):
     """ Add parameters that are required for the impression event to register.

optimizely/project_config.py

@@ -55,6 +55,7 @@ def __init__(self, datafile, logger, error_handler):
     self.audiences = config.get('audiences', [])
     self.feature_flags = config.get('featureFlags', [])
     self.rollouts = config.get('rollouts', [])
+    self.anonymize_ip = config.get('anonymizeIP', False)
 
     # Utility maps for quick lookup
     self.group_id_map = self._generate_key_map(self.groups, 'id', entities.Group)
@@ -566,3 +567,12 @@ def get_forced_variation(self, experiment_key, user_id):
                     'Variation "%s" is mapped to experiment "%s" and user "%s" in the forced variation map'
                     % (variation.key, experiment_key, user_id))
     return variation
+
+  def get_anonymize_ip_value(self):
+    """ Gets the anonymize IP value.
+
+      Returns:
+        A boolean value that indicates if the IP should be anonymized.
+    """
+
+    return self.anonymize_ip

tests/test_event_builder.py

@@ -78,7 +78,8 @@ def test_create_impression_event(self):
         }]
       }],
       'client_name': 'python-sdk',
-      'client_version': version.__version__
+      'client_version': version.__version__,
+      'anonymize_ip': False,
     }
 
     with mock.patch('time.time', return_value=42.123), \
@@ -122,7 +123,8 @@ def test_create_impression_event__with_attributes(self):
         }]
       }],
       'client_name': 'python-sdk',
-      'client_version': version.__version__
+      'client_version': version.__version__,
+      'anonymize_ip': False
     }
 
     with mock.patch('time.time', return_value=42.123), \
@@ -167,7 +169,8 @@ def test_create_conversion_event__with_attributes(self):
         }]
       }],
       'client_name': 'python-sdk',
-      'client_version': version.__version__
+      'client_version': version.__version__,
+      'anonymize_ip': False
     }
 
     with mock.patch('time.time', return_value=42.123), \
@@ -220,6 +223,7 @@ def test_create_conversion_event__with_event_tags(self):
       }],
       'account_id': '12001',
       'client_name': 'python-sdk',
+      'anonymize_ip': False
     }
 
     with mock.patch('time.time', return_value=42.123), \
@@ -274,6 +278,7 @@ def test_create_conversion_event__with_invalid_event_tags(self):
       }],
       'account_id': '12001',
       'client_name': 'python-sdk',
+      'anonymize_ip': False
     }
 
     with mock.patch('time.time', return_value=42.123), \

tests/test_optimizely.py

@@ -161,7 +161,8 @@ def test_activate(self):
         }]
       }],
       'client_version': version.__version__,
-      'client_name': 'python-sdk'
+      'client_name': 'python-sdk',
+      'anonymize_ip': False
     }
     mock_decision.assert_called_once_with(
       self.project_config.get_experiment_from_key('test_experiment'), 'test_user', None
@@ -209,7 +210,8 @@ def test_activate__with_attributes__audience_match(self):
         }]
       }],
       'client_version': version.__version__,
-      'client_name': 'python-sdk'
+      'client_name': 'python-sdk',
+      'anonymize_ip': False
     }
     mock_get_variation.assert_called_once_with(self.project_config.get_experiment_from_key('test_experiment'),
                                                'test_user', {'test_attribute': 'test_value'})
@@ -256,7 +258,8 @@ def test_activate__with_attributes__audience_match__forced_bucketing(self):
           }]
         }],
         'client_version': version.__version__,
-        'client_name': 'python-sdk'
+        'client_name': 'python-sdk',
+        'anonymize_ip': False
       }
 
     self.assertEqual(1, mock_dispatch_event.call_count)
@@ -368,7 +371,8 @@ def test_track__with_attributes(self):
         }]
       }],
       'client_version': version.__version__,
-      'client_name': 'python-sdk'
+      'client_name': 'python-sdk',
+      'anonymize_ip': False
     }
     mock_get_variation.assert_called_once_with(self.project_config.get_experiment_from_key('test_experiment'),
                                                'test_user', {'test_attribute': 'test_value'})
@@ -446,7 +450,8 @@ def test_track__with_event_tags(self):
         }],
       }],
       'client_version': version.__version__,
-      'client_name': 'python-sdk'
+      'client_name': 'python-sdk',
+      'anonymize_ip': False
     }
     mock_get_variation.assert_called_once_with(self.project_config.get_experiment_from_key('test_experiment'),
                                                'test_user', {'test_attribute': 'test_value'})
@@ -499,7 +504,8 @@ def test_track__with_event_tags_revenue(self):
       'client_name': 'python-sdk',
       'project_id': '111001',
       'client_version': version.__version__,
-      'account_id': '12001'
+      'account_id': '12001',
+      'anonymize_ip': False
     }
     mock_get_variation.assert_called_once_with(self.project_config.get_experiment_from_key('test_experiment'),
                                                'test_user', {'test_attribute': 'test_value'})
@@ -583,7 +589,8 @@ def test_track__with_event_tags__forced_bucketing(self):
             }],
           }],
           'client_version': version.__version__,
-          'client_name': 'python-sdk'
+          'client_name': 'python-sdk',
+          'anonymize_ip': False
       }
 
     self.assertEqual(1, mock_dispatch_event.call_count)
@@ -633,7 +640,8 @@ def test_track__with_deprecated_event_value(self):
             }],
           }],
           'client_version': version.__version__,
-          'client_name': 'python-sdk'
+          'client_name': 'python-sdk',
+          'anonymize_ip': False
       }
     mock_get_variation.assert_called_once_with(self.project_config.get_experiment_from_key('test_experiment'),
                                                'test_user', {'test_attribute': 'test_value'})
@@ -684,7 +692,8 @@ def test_track__with_invalid_event_tags(self):
       'client_name': 'python-sdk',
       'project_id': '111001',
       'client_version': version.__version__,
-      'account_id': '12001'
+      'account_id': '12001',
+      'anonymize_ip': False
     }
     mock_get_variation.assert_called_once_with(self.project_config.get_experiment_from_key('test_experiment'),
                                                'test_user', {'test_attribute': 'test_value'})
@@ -798,7 +807,8 @@ def test_is_feature_enabled__returns_true_if_user_is_bucketed_into_a_variation_o
         }]
       }],
       'client_version': version.__version__,
-      'client_name': 'python-sdk'
+      'client_name': 'python-sdk',
+      'anonymize_ip': False,
     }
     # Check that impression event is sent
     self.assertEqual(1, mock_dispatch_event.call_count)