feat: get_optimizely_config API #226

oakbani · 2019-12-06T15:03:41Z

Summary

Adds support for get_optimizely_config public API.

Test plan

Tested manually with FSC OptimizelyConfig tests.
Added simple Unit tests in test_optimizely.py

Issues

OASIS-5464

coveralls · 2019-12-06T15:11:31Z

Coverage decreased (-4.2%) to 93.422% when pulling 4deaf60 on oakbani/optimizely-config into 9fee8ff on master.

coveralls · 2019-12-06T15:11:31Z

Coverage decreased (-4.2%) to 93.422% when pulling 4deaf60 on oakbani/optimizely-config into 9fee8ff on master.

coveralls · 2019-12-06T15:11:31Z

Coverage decreased (-4.2%) to 93.422% when pulling 4deaf60 on oakbani/optimizely-config into 9fee8ff on master.

coveralls · 2019-12-06T15:11:31Z

Coverage increased (+0.1%) to 97.741% when pulling a95c669 on oakbani/optimizely-config into 0a6086c on master.

aliabbasrizvi · 2019-12-09T17:13:19Z

optimizely/optimizely_config.py

+
+    def __init__(self, project_config):
+        """
+        Arguments:


aliabbasrizvi · 2019-12-09T17:14:01Z

optimizely/optimizely_config.py

+
+
+class OptimizelyVariable(object):
+    def __init__(self, id, key, type, value):


type is a keyword and shadows a built in name. Would recommend naming this variable something else. May be variable_type

aliabbasrizvi · 2019-12-09T17:15:18Z

optimizely/optimizely_config.py

+        Returns:
+            Optimizely Config instance.
+        """
+        self._create_lookup_maps()


This seems awkward that a get is calling a create.

aliabbasrizvi · 2019-12-09T17:15:44Z

optimizely/optimizely_config.py

+    def _get_variables_map(self, variation, experiment):
+        """ Gets variables map for given variation and experiment.
+
+        Arguments:


Args and not Arguments. Apply this feedback throughout this PR.

aliabbasrizvi · 2019-12-09T17:19:35Z

optimizely/optimizely_config.py

+        self.groups = project_config.groups
+        self.revision = project_config.revision
+
+    def get_optimizely_config(self):


nit. Not sure if the naming has to be get_optimizely_config, but OptimizelyConfigService.get_optimizely_config has too much redundant information in it.

Something as simple as get_config may suffice here. cc @jaeopt

jaeopt · 2019-12-10T17:43:29Z

tests/test_optimizely.py

+        opt_obj = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
+        opt_config = opt_obj.get_optimizely_config()
+        self.assertIsInstance(opt_config, optimizely_config.OptimizelyConfig)
+


Can we add tests for OptConfig contents validation as well?

jaeopt

It looks great! I suggest to add more unit tests for OptConfig contents validation.

oakbani · 2019-12-10T17:46:14Z

@jaeopt Have added unit tests. Please take a look.

oakbani · 2019-12-10T17:48:05Z

tests/base.py

@@ -182,14 +182,12 @@ def setUp(self, config_dict='config_dict'):
                        {
                            'id': '122239',
                            'key': 'control',
-                            'featureEnabled': True,
-                            'variables': [{'id': '155551', 'value': '42.42'}],
+                            'variables': [],


Removed these since this is not a feature experiment so shouldn't have these props.

msohailhussain · 2019-12-10T18:47:13Z

optimizely/optimizely_config.py

+class OptimizelyConfigService(object):
+    """ Class encapsulating methods to be used in creating instance of OptimizelyConfig. """
+
+    def __init__(self, project_config):


do we need to check instance of ProjectConfig

I don't expect to be used elsewhere. And in the main class, we validate project_config before using OptimizelyService. I can still validate if you so, but will have to keep a validity flag so that get_config returns nil and does not break.

my suggestion is to validate but @aliabbasrizvi will you suggest for validation here?

Agree with @msohailhussain, we should validate here.

msohailhussain · 2019-12-10T18:48:48Z

optimizely/optimizely_config.py

+
+        self.exp_id_to_feature_map = {}
+        for feature in self.feature_flags:
+            for id in feature['experimentIds']:


I would instead of id use experimentId

msohailhussain · 2019-12-10T18:51:15Z

optimizely/optimizely_config.py

+
+        self.feature_key_variable_key_to_variable_map = {}
+        self.feature_key_variable_id_to_variable_map = {}
+        for feature in self.feature_flags:


am unable to find the difference between this feature_flags loop and at line 86. Can't we use one loop only?

jaeopt

LGTM

…imizely-config

msohailhussain · 2019-12-19T23:19:46Z

optimizely/optimizely_config.py

+        self._create_lookup_maps()
+
+    def get_config(self):
+        """ Returns instance of OptimizelyConfig


…imizely-config

aliabbasrizvi

Mostly looks good. Comments could use some clarity.

aliabbasrizvi · 2020-01-02T20:01:49Z

optimizely/optimizely_config.py

+            self.feature_key_variable_key_to_variable_map[feature['key']] = variables_key_map
+            self.feature_key_variable_id_to_variable_map[feature['key']] = variables_id_map
+
+    def _get_variables_map(self, variation, experiment):


nit. I personally prefer arranging this as self, experiment, variation to honor the parent child relationship between experiments and variations.

aliabbasrizvi · 2020-01-02T20:02:02Z

optimizely/optimizely_config.py

+        """ Gets variables map for given variation and experiment.
+
+        Args:
+            variation dict


This is very vague. Dict consisting of what?

…imizely-config

zashraf1985 · 2020-01-03T11:55:48Z

@mikeng13 This is approved and i dont have rights to merge. Can you help.

oakbani added 4 commits December 5, 2019 17:01

Structure Optimizely Config

b46b95e

Some more work

0f2cf5a

Works on this

e2cccb8

Optimized by lookup maps

4deaf60

oakbani and others added 2 commits December 9, 2019 19:21

Add comments and unit tests

6f2a79f

Merge branch 'master' into oakbani/optimizely-config

b7e25fb

oakbani marked this pull request as ready for review December 9, 2019 14:23

oakbani requested a review from a team as a code owner December 9, 2019 14:23

oakbani changed the title ~~WIP - feat: get_optimizely_config API~~ feat: get_optimizely_config API Dec 9, 2019

oakbani requested a review from jaeopt December 9, 2019 14:27

optimizely-codereview-bot added 🤖 4 hrs 🤖 8 hrs and removed 🤖 4 hrs labels Dec 9, 2019

aliabbasrizvi suggested changes Dec 9, 2019

View reviewed changes

optimizely-codereview-bot removed the 🤖 8 hrs label Dec 9, 2019

optimizely-codereview-bot assigned oakbani Dec 9, 2019

optimizely-codereview-bot added 🤖 8 hrs and removed 🤖 8 hrs labels Dec 9, 2019

oakbani added 2 commits December 10, 2019 19:49

address comments

7709dff

tests: unit tests

7a9cb08

jaeopt reviewed Dec 10, 2019

View reviewed changes

jaeopt requested changes Dec 10, 2019

View reviewed changes

oakbani requested review from aliabbasrizvi and jaeopt December 10, 2019 17:46

oakbani commented Dec 10, 2019

View reviewed changes

msohailhussain reviewed Dec 10, 2019

View reviewed changes

jaeopt approved these changes Dec 10, 2019

View reviewed changes

oakbani added 4 commits December 12, 2019 16:05

address comments

15bcb76

fix: lint

720d350

Merge remote-tracking branch 'remotes/origin/master' into oakbani/opt…

ec4f84f

…imizely-config

validate project config

caad32d

oakbani requested a review from msohailhussain December 16, 2019 09:40

msohailhussain reviewed Dec 19, 2019

View reviewed changes

oakbani added 3 commits December 31, 2019 13:09

Merge remote-tracking branch 'remotes/origin/master' into oakbani/opt…

1704ada

…imizely-config

nit

dcc7389

headers

19bb7fd

aliabbasrizvi approved these changes Jan 2, 2020

View reviewed changes

oakbani added 2 commits January 3, 2020 16:23

Merge remote-tracking branch 'remotes/origin/master' into oakbani/opt…

2aa243c

…imizely-config

refact: nits

a95c669

jaeopt merged commit 1785902 into master Jan 6, 2020

oakbani deleted the oakbani/optimizely-config branch January 13, 2020 09:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: get_optimizely_config API #226

feat: get_optimizely_config API #226

oakbani commented Dec 6, 2019 •

edited

Loading

coveralls commented Dec 6, 2019

coveralls commented Dec 6, 2019

coveralls commented Dec 6, 2019

coveralls commented Dec 6, 2019 •

edited

Loading

aliabbasrizvi Dec 9, 2019

aliabbasrizvi Dec 9, 2019

aliabbasrizvi Dec 9, 2019

aliabbasrizvi Dec 9, 2019

aliabbasrizvi Dec 9, 2019

jaeopt Dec 10, 2019

jaeopt left a comment

oakbani commented Dec 10, 2019

oakbani Dec 10, 2019

msohailhussain Dec 10, 2019

oakbani Dec 12, 2019 •

edited

Loading

msohailhussain Dec 13, 2019

aliabbasrizvi Dec 16, 2019

msohailhussain Dec 10, 2019 •

edited

Loading

msohailhussain Dec 10, 2019

jaeopt left a comment

msohailhussain Dec 19, 2019

aliabbasrizvi left a comment

aliabbasrizvi Jan 2, 2020

aliabbasrizvi Jan 2, 2020

zashraf1985 commented Jan 3, 2020



		class OptimizelyVariable(object):
		def __init__(self, id, key, type, value):

feat: get_optimizely_config API #226

feat: get_optimizely_config API #226

Conversation

oakbani commented Dec 6, 2019 • edited Loading

Summary

Test plan

Issues

coveralls commented Dec 6, 2019

coveralls commented Dec 6, 2019

coveralls commented Dec 6, 2019

coveralls commented Dec 6, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaeopt left a comment

Choose a reason for hiding this comment

oakbani commented Dec 10, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oakbani Dec 12, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msohailhussain Dec 10, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaeopt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aliabbasrizvi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zashraf1985 commented Jan 3, 2020

oakbani commented Dec 6, 2019 •

edited

Loading

coveralls commented Dec 6, 2019 •

edited

Loading

oakbani Dec 12, 2019 •

edited

Loading

msohailhussain Dec 10, 2019 •

edited

Loading