Fix ephemeral parameters

ammario · ammario · commit 6cb0e29baa6d · 2024-01-21T21:50:37.000-06:00
diff --git a/site/e2e/parameters.ts b/site/e2e/parameters.ts
@@ -129,8 +129,10 @@ export const seventhParameter: RichParameter = {
 };
 
 // randParamName returns a new parameter with a random name.
+// It helps to avoid cross-test interference when user-auto-fill triggers on
+// the same parameter name.
 export const randParamName = (p: RichParameter): RichParameter => {
-  const name = p.name + Math.random().toString(36).substring(7);
+  const name = p.name + "_" + Math.random().toString(36).substring(7);
   return { ...p, name: name };
 };
 
diff --git a/site/e2e/tests/restartWorkspace.spec.ts b/site/e2e/tests/restartWorkspace.spec.ts
@@ -49,7 +49,7 @@ test("restart workspace with ephemeral parameters", async ({ page }) => {
 
   // Verify that build options are default (not selected).
   await verifyParameters(page, workspaceName, richParameters, [
-    { name: firstBuildOption.name, value: firstBuildOption.defaultValue },
-    { name: secondBuildOption.name, value: secondBuildOption.defaultValue },
+    { name: richParameters[0].name, value: firstBuildOption.defaultValue },
+    { name: richParameters[1].name, value: secondBuildOption.defaultValue },
   ]);
 });
diff --git a/site/e2e/tests/startWorkspace.spec.ts b/site/e2e/tests/startWorkspace.spec.ts
@@ -50,7 +50,7 @@ test("start workspace with ephemeral parameters", async ({ page }) => {
 
   // Verify that build options are default (not selected).
   await verifyParameters(page, workspaceName, richParameters, [
-    { name: firstBuildOption.name, value: firstBuildOption.defaultValue },
-    { name: secondBuildOption.name, value: secondBuildOption.defaultValue },
+    { name: richParameters[0].name, value: firstBuildOption.defaultValue },
+    { name: richParameters[1].name, value: secondBuildOption.defaultValue },
   ]);
 });
diff --git a/site/src/utils/richParameters.ts b/site/src/utils/richParameters.ts
@@ -17,9 +17,19 @@ export const getInitialRichParameterValues = (
   autofillParams?: AutofillBuildParameter[],
 ): WorkspaceBuildParameter[] => {
   return templateParams.map((parameter) => {
+    // Short-circuit for ephemeral parameters, which are always reset to
+    // the template-defined default.
+    if (parameter.ephemeral) {
+      return {
+        name: parameter.name,
+        value: parameter.default_value,
+      };
+    }
+
     const autofillParam = autofillParams?.find(
       (p) => p.name === parameter.name,
     );
+
     if (autofillParam !== undefined && isValidValue(parameter, autofillParam)) {
       return {
         name: parameter.name,
