feat: Add audit trial length optimizely experiment (#82)

* feat: Add audit trial length optimizely experiment

- Add the experiment and variation keys
- And some logic for upgrade eligibility

* fix: corrected logic for gating trial w/ var keys

- also added tests

* chore: nit

src/data/optimizely.js

@@ -23,13 +23,22 @@ const getOptimizely = () => {
   return instance;
 };
 
+const OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_KEY = 'xpert_audit_trial_experiment';
+const OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS = {
+  CONTROL: 'control',
+  XPERT_AUDIT_14_DAY_TRIAL: 'xpert_audit_14_day_trial',
+  XPERT_AUDIT_28_DAY_TRIAL: 'xpert_audit_28_day_trial',
+};
+
 const OPTIMIZELY_PROMPT_EXPERIMENT_KEY = '_cosmo__xpert_gpt_4_0_prompt';
 const OPTIMIZELY_PROMPT_EXPERIMENT_VARIATION_KEYS = {
   UPDATED_PROMPT: 'updated_prompt',
 };
 
 export {
   getOptimizely,
+  OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_KEY,
+  OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS,
   OPTIMIZELY_PROMPT_EXPERIMENT_KEY,
   OPTIMIZELY_PROMPT_EXPERIMENT_VARIATION_KEYS,
 };

src/experiments/experimentHooks.js

@@ -1,7 +1,7 @@
 import { getAuthenticatedUser } from '@edx/frontend-platform/auth';
 import { useDecision } from '@optimizely/react-sdk';
 
-import { OPTIMIZELY_PROMPT_EXPERIMENT_KEY } from '../data/optimizely';
+import { OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_KEY, OPTIMIZELY_PROMPT_EXPERIMENT_KEY } from '../data/optimizely';
 
 // eslint-disable-next-line import/prefer-default-export
 export function usePromptExperimentDecision() {
@@ -14,3 +14,15 @@ export function usePromptExperimentDecision() {
 
   return [decision];
 }
+
+// eslint-disable-next-line import/prefer-default-export
+export function useAuditTrialExperimentDecision() {
+  const { userId } = getAuthenticatedUser();
+
+  const [decision] = useDecision(
+    OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_KEY,
+    { overrideUserId: userId.toString() }, // This override is just to make sure the userId is up to date.
+  );
+
+  return [decision];
+}

src/hooks/use-course-upgrade.js

@@ -3,6 +3,9 @@ import { useModel } from '@src/generic/model-store'; // eslint-disable-line impo
 import { useSelector } from 'react-redux';
 import { CourseInfoContext } from '../context';
 
+import { OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS } from '../data/optimizely';
+import { useAuditTrialExperimentDecision } from '../experiments';
+
 const millisecondsInOneDay = 24 * 60 * 60 * 1000; // hours*minutes*seconds*milliseconds
 
 /**
@@ -41,9 +44,18 @@ export default function useCourseUpgrade() {
     auditTrial,
   } = useSelector(state => state.learningAssistant);
 
+  const [decision] = useAuditTrialExperimentDecision();
+  const { enabled, variationKey } = decision || {};
+
   const upgradeUrl = offer?.upgradeUrl || verifiedMode?.upgradeUrl;
 
-  if (!isUpgradeEligible || !upgradeUrl) { return { upgradeable: false }; }
+  if (
+    !isUpgradeEligible
+    || !upgradeUrl
+    || !enabled
+    || (variationKey !== OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS.XPERT_AUDIT_14_DAY_TRIAL
+      && variationKey !== OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS.XPERT_AUDIT_28_DAY_TRIAL)
+  ) { return { upgradeable: false }; }
 
   let auditTrialExpired = false;
   let auditTrialDaysRemaining;

src/hooks/use-course-upgrade.test.jsx

@@ -3,8 +3,12 @@ import { useSelector } from 'react-redux';
 import { useModel } from '@src/generic/model-store'; // eslint-disable-line import/no-unresolved
 import { CourseInfoProvider } from '../context';
 import useCourseUpgrade from './use-course-upgrade';
+import { OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS } from '../data/optimizely';
+
+import { useAuditTrialExperimentDecision } from '../experiments';
 
 jest.mock('react-redux', () => ({ useSelector: jest.fn() }));
+jest.mock('../experiments', () => ({ useAuditTrialExperimentDecision: jest.fn() }));
 
 const mockedUpgradeUrl = 'https://upgrade.edx/course/test';
 const mockedAuditTrialLengthDays = 7;
@@ -31,6 +35,10 @@ const renderHook = ({
   });
 
   useSelector.mockReturnValue(state.learningAssistant);
+  useAuditTrialExperimentDecision.mockReturnValue([{
+    enabled: true,
+    variationKey: OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS.XPERT_AUDIT_14_DAY_TRIAL,
+  }]);
 
   return rtlRenderHook(
     () => useCourseUpgrade(),
@@ -55,6 +63,26 @@ describe('useCourseUpgrade()', () => {
     expect(result.current).toEqual({ upgradeable: false });
   });
 
+  it('should return { upgradeable: false } if audit trial experiment is not enabled', () => {
+    const { result } = renderHook({ courseInfo: { isUpgradeEligible: true } });
+    useAuditTrialExperimentDecision.mockReturnValue([{
+      enabled: false,
+      variationKey: OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS.XPERT_AUDIT_14_DAY_TRIAL,
+    }]);
+
+    expect(result.current).toEqual({ upgradeable: false });
+  });
+
+  it('should return { upgradeable: false } is not one of the audit trial experiment treatment keys', () => {
+    useAuditTrialExperimentDecision.mockReturnValue([{
+      enabled: false,
+      variationKey: OPTIMIZELY_AUDIT_TRIAL_LENGTH_EXPERIMENT_VARIATION_KEYS.CONTROL,
+    }]);
+    const { result } = renderHook({ courseInfo: { isUpgradeEligible: true } });
+
+    expect(result.current).toEqual({ upgradeable: false });
+  });
+
   it('should return { upgradeable: true } if eligible and upgradeable and no trial info for both offer and verifiedMode urls', () => {
     const expected = {
       upgradeable: true,