fix: Optimizely refactor #57
Conversation
rijuma
changed the title
rijuma
force-pushed
the
rijuma/optimizely-context-fix
branch
from
696e411 to
3de26cf
Compare
rijuma
changed the title
rijuma
force-pushed
the
rijuma/optimizely-context-fix
branch
from
676ee05 to
1b28cf5
Compare
rijuma
changed the title
src/components/MessageForm/index.jsx
Outdated
| @@ -17,6 +19,11 @@ const MessageForm = ({ courseId, shouldAutofocus, unitId }) => { | |||
| const dispatch = useDispatch(); | |||
| const inputRef = useRef(); | |||
|
|
|||
| const { userId } = getAuthenticatedUser(); | |||
| const [decision] = useDecision(OPTIMIZELY_PROMPT_EXPERIMENT_KEY, { autoUpdate: true }, { id: userId.toString() }); | |||
There was a problem hiding this comment.
Could you explain why autoUpdate is true here? I believe the default is false. Reading the documentation, I don't exactly understand why we'd want to set this to true.
There was a problem hiding this comment.
Should the id override have the name overrideUserId?
There was a problem hiding this comment.
If you send the userId via the OptimizelyProvider, which you do via the ExperimentsProvider component, you shouldn't need to send a user ID override, because that user ID will already be available to Optimizely throughout the component tree. Is there a reason we need to override the ID here? I have the same question for src/components/Sidebar/index.jsx.
There was a problem hiding this comment.
Could you explain why autoUpdate is true here? I believe the default is false. Reading the documentation, I don't exactly understand why we'd want to set this to true.
I understood that having the autoUpdate: true would react to changes on the experiment immediately while the user is in the experiment. I think it's a good thing to have in cases where we detect a bug and want to remove the experiment. I thought it was an useful thing to use to be able to react in real time.
Should the id override have the name overrideUserId?
Indeed. Good catch. I've made a small refactor on the useDecision() hook into its own usePromptExperimentDecision() hook to avoid repetition.
If you send the userId via the OptimizelyProvider, which you do via the ExperimentsProvider component, you shouldn't need to send a user ID override, because that user ID will already be available to Optimizely throughout the component tree. Is there a reason we need to override the ID here? I have the same question for src/components/Sidebar/index.jsx.
I was worried if for some reason the user changed after the initialization. Since the getAuthenticatedUser() is a getter, the provider might not update if this happens. The override would have the updated userId when the call is made, so I thought it was more accurate.
There was a problem hiding this comment.
That makes sense. I don't think those cases are likely to occur in the experiment, but I don't see a good reason not have these options set this way because, as you said, it's safer. I think my main concern is it makes it a little more difficult to understand. The user override, for example, feels like it's serving to perform an override, but the user ID is exactly the same. But that's why I asked the question, and I appreciate you explaining their function! I don't have any concerns with leaving them in.
There was a problem hiding this comment.
Same thing. I saw the usage in some examples in Optimizely's documentation and saw no reason to exclude it. I've added a short inline comment on each prop to explain the usage.
src/components/MessageForm/index.jsx
Outdated
| @@ -17,6 +19,11 @@ const MessageForm = ({ courseId, shouldAutofocus, unitId }) => { | |||
| const dispatch = useDispatch(); | |||
| const inputRef = useRef(); | |||
|
|
|||
| const { userId } = getAuthenticatedUser(); | |||
| const [decision] = useDecision(OPTIMIZELY_PROMPT_EXPERIMENT_KEY, { autoUpdate: true }, { id: userId.toString() }); | |||
There was a problem hiding this comment.
Should the id override have the name overrideUserId?
src/components/MessageForm/index.jsx
Outdated
| @@ -17,6 +19,11 @@ const MessageForm = ({ courseId, shouldAutofocus, unitId }) => { | |||
| const dispatch = useDispatch(); | |||
| const inputRef = useRef(); | |||
|
|
|||
| const { userId } = getAuthenticatedUser(); | |||
| const [decision] = useDecision(OPTIMIZELY_PROMPT_EXPERIMENT_KEY, { autoUpdate: true }, { id: userId.toString() }); | |||
There was a problem hiding this comment.
If you send the userId via the OptimizelyProvider, which you do via the ExperimentsProvider component, you shouldn't need to send a user ID override, because that user ID will already be available to Optimizely throughout the component tree. Is there a reason we need to override the ID here? I have the same question for src/components/Sidebar/index.jsx.
Co-authored-by: Michael Roytman <[email protected]>
Co-authored-by: Michael Roytman <[email protected]>
rijuma
force-pushed
the
rijuma/optimizely-context-fix
branch
from
9cc2269 to
9d9504e
Compare
This PR is a refactor of a bad first approach on integrating Optimizely to the repo.
Since this PR reverts some of the old code and adds the fixes it's a bit complicated to see. I'ts easier to look at it if we look at a compare of this branch with tag v2.1.4 to see all changes without the reverts.