feat(packages/sui-pde): upgrade optimizely version and add use-decisi…

packages/sui-pde/package.json

@@ -17,7 +17,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@optimizely/optimizely-sdk": "4.9.4",
+    "@optimizely/optimizely-sdk": "5.3.4",
     "@s-ui/js": "2"
   },
   "peerDependencies": {

packages/sui-pde/src/adapters/default.js

@@ -15,6 +15,10 @@ export default class DefaultAdapter {
     return null
   }
 
+  decide() {
+    return null
+  }
+
   updateConsents() {
     return null
   }

packages/sui-pde/src/adapters/optimizely/index.js

@@ -62,12 +62,14 @@ export default class OptimizelyAdapter {
       sdkKey = undefined
     }
 
+    const isServer = typeof window === 'undefined'
     const optimizelyInstance = optimizely.createInstance({
       sdkKey,
       datafileOptions: options,
       datafile,
       eventDispatcher,
-      ...DEFAULT_EVENTS_OPTIONS
+      ...DEFAULT_EVENTS_OPTIONS,
+      defaultDecideOptions: isServer ? [optimizely.OptimizelyDecideOption.DISABLE_DECISION_EVENT] : []
     })
 
     return optimizelyInstance
@@ -117,6 +119,23 @@ export default class OptimizelyAdapter {
     })
   }
 
+  /**
+   * @param {Object} params
+   * @param {string} params.name
+   * @param {object} [params.attributes]
+   * @returns {string=} variation name
+   */
+  decide({name, attributes}) {
+    if (!this._hasUserConsents) return null
+
+    const user = this._optimizely.createUserContext(this._userId, {
+      ...this._applicationAttributes,
+      ...attributes
+    })
+
+    return user.decide(name)
+  }
+
   /**
    * Gets the variation without tracking the impression
    * @param {Object} params

packages/sui-pde/src/adapters/optimizely/multiple.js

@@ -60,6 +60,10 @@ class MultipleOptimizelyAdapter {
     return this.#adapters[adapterId].activateExperiment(props)
   }
 
+  decide({adapterId = defaultAdapterId, ...props}) {
+    return this.#adapters[adapterId].decide(props)
+  }
+
   getVariation({adapterId = defaultAdapterId, ...props}) {
     return this.#adapters[adapterId].getVariation(props)
   }

packages/sui-pde/src/hooks/common/platformStrategies.js

@@ -6,6 +6,9 @@ const getServerStrategy = () => ({
   getVariation: ({pde, experimentName, attributes, adapterId}) => {
     return pde.getVariation({pde, name: experimentName, attributes, adapterId})
   },
+  decide: ({pde, name, attributes, adapterId}) => {
+    return pde.decide({pde, name, attributes, adapterId})
+  },
   trackExperiment: () => {},
   getForcedValue: ({key, queryString}) => {
     if (!queryString) {
@@ -27,6 +30,9 @@ const getBrowserStrategy = ({customTrackExperimentViewed, cache}) => ({
 
     return variationName
   },
+  decide: ({pde, name, attributes, adapterId}) => {
+    return pde.decide({pde, name, attributes, adapterId})
+  },
   trackExperiment: ({variationName, experimentName}) => {
     if (customTrackExperimentViewed) {
       return customTrackExperimentViewed({variationName, experimentName})

packages/sui-pde/src/hooks/useDecision.js

@@ -0,0 +1,58 @@
+import {useContext, useMemo} from 'react'
+
+import PdeContext from '../contexts/PdeContext.js'
+import {getPlatformStrategy} from './common/platformStrategies.js'
+
+/**
+ * Hook to use a feature test
+ * @param {string} name
+ * @param {object} param
+ * @param {object} param.attributes
+ * @param {function} param.trackExperimentViewed
+ * @param {string} param.queryString
+ * @param {string} param.adapterId Adapter id to be executed
+ * @return {object}
+ */
+export default function useDecision(name, {attributes, trackExperimentViewed, queryString, adapterId} = {}) {
+  const {pde} = useContext(PdeContext)
+
+  if (pde === null) {
+    throw new Error('[sui-pde: useDecision] sui-pde provider is required to work')
+  }
+
+  const variation = useMemo(() => {
+    const strategy = getPlatformStrategy({
+      customTrackExperimentViewed: trackExperimentViewed
+    })
+
+    const forced = strategy.getForcedValue({
+      key: name,
+      queryString
+    })
+
+    const data = strategy.decide({
+      pde,
+      name,
+      attributes,
+      adapterId
+    })
+
+    const {ruleKey, variationKey} = data || {}
+
+    if (forced) {
+      if (!ruleKey) {
+        return {...data, enabled: forced === 'on'}
+      }
+
+      return {...data, enabled: true, variationKey: forced}
+    }
+
+    if (ruleKey) {
+      strategy.trackExperiment({variationName: variationKey, experimentName: name})
+    }
+
+    return data
+  }, [trackExperimentViewed, name, queryString, pde, attributes, adapterId])
+
+  return {variation}
+}

packages/sui-pde/src/index.js

@@ -2,5 +2,6 @@ export {default as PDE} from './pde.js'
 export {default as useFeature} from './hooks/useFeature.js'
 export {default as PdeContext} from './contexts/PdeContext.js'
 export {default as useExperiment} from './hooks/useExperiment.js'
+export {default as useDecision} from './hooks/useDecision.js'
 export {default as Experiment} from './components/experiment.js'
 export {default as Feature} from './components/feature.js'

packages/sui-pde/src/pde.js

@@ -28,6 +28,15 @@ export default class PDE {
     return this._adapter.activateExperiment({name, attributes, adapterId})
   }
 
+  /**
+   * @param {object} param
+   * @param {string} param.name
+   * @param {object} param.attributes
+   */
+  decide({name, attributes, adapterId}) {
+    return this._adapter.decide({name, attributes, adapterId})
+  }
+
   getInitialData() {
     return this._adapter.getInitialData()
   }