Fix for edge case when importing an experiment from a feature experiment that has no trackingKey

Author: Auz

packages/back-end/src/controllers/experiments.ts

@@ -310,18 +310,20 @@ export async function getNewFeatures(req: AuthRequest, res: Response) {
   projectFeatures.forEach((f) => {
     if (f?.rules && f?.rules.length > 0) {
       f.rules.forEach((r) => {
-        if (
-          r.type === "experiment" &&
-          r?.trackingKey &&
-          !expMap.get(r?.trackingKey)
-        ) {
-          // this feature experiment has no report:
-          newFeatures.set(r.trackingKey, {
-            feature: f,
-            rule: r,
-            trackingKey: r.trackingKey,
-            partialExperiment: getExperimentDefinitionFromFeatureAndRule(f, r),
-          });
+        if (r.type === "experiment") {
+          const tKey = r.trackingKey || f.id;
+          if (!expMap.get(tKey)) {
+            // this feature experiment has no report:
+            newFeatures.set(tKey, {
+              feature: f,
+              rule: r,
+              trackingKey: tKey,
+              partialExperiment: getExperimentDefinitionFromFeatureAndRule(
+                f,
+                r
+              ),
+            });
+          }
         }
       });
     }
@@ -343,8 +345,8 @@ const getExperimentDefinitionFromFeatureAndRule = (
   const totalPercent = expRule.values.reduce((sum, w) => sum + w.weight, 0);
 
   const expDefinition: Partial<ExperimentInterfaceStringDates> = {
-    trackingKey: expRule.trackingKey,
-    name: expRule.trackingKey + " experiment",
+    trackingKey: expRule.trackingKey || feature.id,
+    name: (expRule.trackingKey || feature.id) + " experiment",
     hypothesis: expRule.description || "",
     description: `Experiment analysis for the feature [**${feature.id}**](/features/${feature.id})`,
     variations: expRule.values.map((v, i) => {

packages/front-end/components/Experiment/NewExperimentForm.tsx

@@ -88,27 +88,28 @@ const NewExperimentForm: FC<NewExperimentFormProps> = ({
     project,
   } = useDefinitions();
   const { refreshWatching } = useWatching();
-  const initialPhases: ExperimentPhaseStringDates[] = isImport
-    ? [
-        {
-          coverage: initialValue.phases?.[0].coverage || 1,
-          dateStarted: getValidDate(initialValue.phases?.[0]?.dateStarted)
-            .toISOString()
-            .substr(0, 16),
-          dateEnded: getValidDate(initialValue.phases?.[0]?.dateEnded)
-            .toISOString()
-            .substr(0, 16),
-          phase: initialValue.phases?.[0].phase || "main",
-          reason: "",
-          groups: [],
-          variationWeights:
-            initialValue.phases?.[0].variationWeights ||
-            getEvenSplit(
-              initialValue.variations ? initialValue.variations.length : 2
-            ),
-        },
-      ]
-    : [];
+  const initialPhases: ExperimentPhaseStringDates[] =
+    isImport && initialValue
+      ? [
+          {
+            coverage: initialValue.phases?.[0].coverage || 1,
+            dateStarted: getValidDate(initialValue.phases?.[0]?.dateStarted)
+              .toISOString()
+              .substr(0, 16),
+            dateEnded: getValidDate(initialValue.phases?.[0]?.dateEnded)
+              .toISOString()
+              .substr(0, 16),
+            phase: initialValue.phases?.[0].phase || "main",
+            reason: "",
+            groups: [],
+            variationWeights:
+              initialValue.phases?.[0].variationWeights ||
+              getEvenSplit(
+                initialValue.variations ? initialValue.variations.length : 2
+              ),
+          },
+        ]
+      : [];
 
   useEffect(() => {
     track("New Experiment Form", {

packages/front-end/components/Experiment/NewFeatureExperiments.tsx

@@ -25,7 +25,7 @@ export default function NewFeatureExperiments() {
   }
 
   return (
-    <div className="mb-3" style={{ maxHeight: "120px", overflowY: "auto" }}>
+    <div className="mb-3" style={{ maxHeight: "107px", overflowY: "auto" }}>
       {data.features.map((o, i) => {
         const f = o.feature;
         const expDefinition = o.partialExperiment;

packages/front-end/components/Features/ExperimentSummary.tsx

@@ -1,4 +1,5 @@
 import {
+  ExperimentRule,
   ExperimentValue,
   FeatureInterface,
   FeatureValueType,
@@ -24,23 +25,22 @@ export default function ExperimentSummary({
   trackingKey,
   experiment,
   feature,
+  expRule,
 }: {
   values: ExperimentValue[];
   type: FeatureValueType;
   hashAttribute: string;
   trackingKey: string;
   feature: FeatureInterface;
   experiment?: ExperimentInterfaceStringDates;
+  expRule: ExperimentRule;
 }) {
   const totalPercent = values.reduce((sum, w) => sum + w.weight, 0);
   const { datasources, metrics } = useDefinitions();
   const [newExpModal, setNewExpModal] = useState(false);
   const [experimentInstructions, setExperimentInstructions] = useState(false);
 
-  const expDefinition = getExperimentDefinitionFromFeature(
-    feature,
-    trackingKey
-  );
+  const expDefinition = getExperimentDefinitionFromFeature(feature, expRule);
 
   return (
     <div>

packages/front-end/components/Features/Rule.tsx

@@ -191,6 +191,7 @@ export const Rule = forwardRef<HTMLDivElement, RuleProps>(
                 experiment={experiments[rule.trackingKey || feature.id]}
                 hashAttribute={rule.hashAttribute || ""}
                 trackingKey={rule.trackingKey || feature.id}
+                expRule={rule}
               />
             )}
           </div>

packages/front-end/services/features.ts

@@ -374,32 +374,18 @@ export function useAttributeMap(): Map<string, AttributeData> {
 
 export function getExperimentDefinitionFromFeature(
   feature: FeatureInterface,
-  trackingKey: string = ""
+  expRule: ExperimentRule
 ) {
-  let expRule: ExperimentRule;
-  if (feature?.rules && feature?.rules?.length > 0) {
-    feature.rules.forEach((r) => {
-      if (r.type === "experiment") {
-        // to handle the case where there are multiple experiment rules per feature, make sure it matches the requested one:
-        if (trackingKey) {
-          if (r.trackingKey === trackingKey) {
-            expRule = r;
-          }
-        } else {
-          expRule = r;
-        }
-      }
-    });
-  }
-  if (!expRule || !expRule.trackingKey) {
+  const trackingKey = expRule?.trackingKey || feature.id;
+  if (!trackingKey) {
     return null;
   }
 
   const totalPercent = expRule.values.reduce((sum, w) => sum + w.weight, 0);
 
   const expDefinition: Partial<ExperimentInterfaceStringDates> = {
-    trackingKey: expRule.trackingKey,
-    name: expRule.trackingKey + " experiment",
+    trackingKey: trackingKey,
+    name: trackingKey + " experiment",
     hypothesis: expRule.description || "",
     description: `Experiment analysis for the feature [**${feature.id}**](/features/${feature.id})`,
     variations: expRule.values.map((v, i) => {