web: stop build button replaces start build button when building (#5514)

tilt-dev · Feb 18, 2022 · f5e2ef5 · f5e2ef5
1 parent e311110
commit f5e2ef5
Show file tree

Hide file tree

Showing 26 changed files with 236 additions and 115 deletions.
diff --git a/internal/controllers/apis/tiltfile/main.go b/internal/controllers/apis/tiltfile/main.go
@@ -41,7 +41,7 @@ func MainTiltfile(filename string, args []string) *v1alpha1.Tiltfile {
 				FileWatches: []string{fwName},
 			},
 			StopOn: &v1alpha1.StopOnSpec{
-				UIButtons: []string{uibutton.CancelButtonName(name)},
+				UIButtons: []string{uibutton.StopBuildButtonName(name)},
 			},
 		},
 	}

diff --git a/internal/controllers/apis/uibutton/cancel.go → ...l/controllers/apis/uibutton/stop_build.go b/internal/controllers/apis/uibutton/cancel.go → ...l/controllers/apis/uibutton/stop_build.go
@@ -8,24 +8,24 @@ import (
 	"github.com/tilt-dev/tilt/pkg/apis/core/v1alpha1"
 )
 
-func CancelButtonName(resourceName string) string {
-	return fmt.Sprintf("%s-cancel", resourceName)
+func StopBuildButtonName(resourceName string) string {
+	return fmt.Sprintf("%s-stopbuild", resourceName)
 }
 
-func CancelButton(resourceName string) *v1alpha1.UIButton {
+func StopBuildButton(resourceName string) *v1alpha1.UIButton {
 	return &v1alpha1.UIButton{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: CancelButtonName(resourceName),
+			Name: StopBuildButtonName(resourceName),
 			Annotations: map[string]string{
-				v1alpha1.AnnotationButtonType: v1alpha1.ButtonTypeCancelUpdate,
+				v1alpha1.AnnotationButtonType: v1alpha1.ButtonTypeStopBuild,
 			},
 		},
 		Spec: v1alpha1.UIButtonSpec{
 			Location: v1alpha1.UIComponentLocation{
 				ComponentID:   resourceName,
 				ComponentType: v1alpha1.ComponentTypeResource,
 			},
-			Text:     "Cancel",
+			Text:     "Stop Build",
 			IconName: "cancel",
 		},
 	}

diff --git a/internal/controllers/core/tiltfile/api.go b/internal/controllers/core/tiltfile/api.go
@@ -351,7 +351,7 @@ func toCancelButtons(tlr *tiltfile.TiltfileLoadResult) apiset.TypedObjectSet {
 	}
 
 	for _, m := range tlr.Manifests {
-		button := uibutton.CancelButton(m.Name.String())
+		button := uibutton.StopBuildButton(m.Name.String())
 		result[button.Name] = button
 	}
 	return result

diff --git a/internal/controllers/core/tiltfile/reconciler_test.go b/internal/controllers/core/tiltfile/reconciler_test.go
@@ -382,11 +382,11 @@ func TestCancel(t *testing.T) {
 		},
 		Spec: v1alpha1.TiltfileSpec{
 			Path:   p,
-			StopOn: &v1alpha1.StopOnSpec{UIButtons: []string{uibutton.CancelButtonName("my-tf")}},
+			StopOn: &v1alpha1.StopOnSpec{UIButtons: []string{uibutton.StopBuildButtonName("my-tf")}},
 		},
 	}
 
-	cancelButton := uibutton.CancelButton(tf.Name)
+	cancelButton := uibutton.StopBuildButton(tf.Name)
 	err := f.Client.Create(f.Context(), cancelButton)
 	require.NoError(t, err)
 
@@ -426,11 +426,11 @@ func TestCancelClickedBeforeLoad(t *testing.T) {
 		},
 		Spec: v1alpha1.TiltfileSpec{
 			Path:   p,
-			StopOn: &v1alpha1.StopOnSpec{UIButtons: []string{uibutton.CancelButtonName("my-tf")}},
+			StopOn: &v1alpha1.StopOnSpec{UIButtons: []string{uibutton.StopBuildButtonName("my-tf")}},
 		},
 	}
 
-	cancelButton := uibutton.CancelButton(tf.Name)
+	cancelButton := uibutton.StopBuildButton(tf.Name)
 	cancelButton.Status.LastClickedAt = metav1.NowMicro()
 	err := f.Client.Create(f.Context(), cancelButton)
 	require.NoError(t, err)

diff --git a/internal/engine/buildcontroller.go b/internal/engine/buildcontroller.go
@@ -29,7 +29,7 @@ type BuildController struct {
 
 	// CancelFuncs for in-progress builds
 	mu           sync.Mutex
-	cancelBuilds map[model.ManifestName]context.CancelFunc
+	stopBuildFns map[model.ManifestName]context.CancelFunc
 }
 
 type buildEntry struct {
@@ -48,7 +48,7 @@ func (e buildEntry) BuildReason() model.BuildReason { return e.buildReason }
 func NewBuildController(b buildcontrol.BuildAndDeployer) *BuildController {
 	return &BuildController{
 		b:            b,
-		cancelBuilds: make(map[model.ManifestName]context.CancelFunc),
+		stopBuildFns: make(map[model.ManifestName]context.CancelFunc),
 	}
 }
 
@@ -164,7 +164,7 @@ func (c *BuildController) cleanUpCanceledBuilds(st store.RStore) {
 		}
 		disabled := ms.DisableState == v1alpha1.DisableStateDisabled
 		canceled := false
-		if cancelButton, ok := state.UIButtons[uibutton.CancelButtonName(ms.Name.String())]; ok {
+		if cancelButton, ok := state.UIButtons[uibutton.StopBuildButtonName(ms.Name.String())]; ok {
 			lastCancelClick := cancelButton.Status.LastClickedAt
 			canceled = timecmp.AfterOrEqual(lastCancelClick, ms.CurrentBuild.StartTime)
 		}
@@ -181,16 +181,16 @@ func (c *BuildController) buildContext(ctx context.Context, entry buildEntry, st
 	ctx, cancel := context.WithCancel(ctx)
 	c.mu.Lock()
 	defer c.mu.Unlock()
-	c.cancelBuilds[entry.name] = cancel
+	c.stopBuildFns[entry.name] = cancel
 	return ctx
 }
 
 func (c *BuildController) cleanupBuildContext(mn model.ManifestName) {
 	c.mu.Lock()
 	defer c.mu.Unlock()
-	if cancel, ok := c.cancelBuilds[mn]; ok {
+	if cancel, ok := c.stopBuildFns[mn]; ok {
 		cancel()
-		delete(c.cancelBuilds, mn)
+		delete(c.stopBuildFns, mn)
 	}
 }
 

diff --git a/internal/engine/buildcontroller_test.go b/internal/engine/buildcontroller_test.go
@@ -1624,7 +1624,7 @@ local_resource('local', 'sleep 10000')
 	f.waitUntilManifestBuilding("local")
 
 	var cancelButton v1alpha1.UIButton
-	err := f.ctrlClient.Get(f.ctx, types.NamespacedName{Name: uibutton.CancelButtonName("local")}, &cancelButton)
+	err := f.ctrlClient.Get(f.ctx, types.NamespacedName{Name: uibutton.StopBuildButtonName("local")}, &cancelButton)
 	require.NoError(t, err)
 	cancelButton.Status.LastClickedAt = metav1.NowMicro()
 	err = f.ctrlClient.Status().Update(f.ctx, &cancelButton)
@@ -1655,7 +1655,7 @@ local_resource('local', 'sleep 10000')
 	f.waitUntilManifestBuilding("local")
 
 	var cancelButton v1alpha1.UIButton
-	err := f.ctrlClient.Get(f.ctx, types.NamespacedName{Name: uibutton.CancelButtonName("local")}, &cancelButton)
+	err := f.ctrlClient.Get(f.ctx, types.NamespacedName{Name: uibutton.StopBuildButtonName("local")}, &cancelButton)
 	require.NoError(t, err)
 	cancelButton.Status.LastClickedAt = ts
 	err = f.ctrlClient.Status().Update(f.ctx, &cancelButton)

diff --git a/internal/engine/configs/configs_controller.go b/internal/engine/configs/configs_controller.go
@@ -69,7 +69,7 @@ func (cc *ConfigsController) maybeCreateInitialTiltfileCancelButton(ctx context.
 	if !cancelEnabled {
 		return nil
 	}
-	err := cc.ctrlClient.Create(ctx, uibutton.CancelButton(model.MainTiltfileManifestName.String()))
+	err := cc.ctrlClient.Create(ctx, uibutton.StopBuildButton(model.MainTiltfileManifestName.String()))
 	if err != nil && !apierrors.IsAlreadyExists(err) {
 		return err
 	}

diff --git a/internal/engine/configs/configs_controller_test.go b/internal/engine/configs/configs_controller_test.go
@@ -37,7 +37,7 @@ func TestCreateTiltfile(t *testing.T) {
 			FileWatches: []string{"configs:(Tiltfile)"},
 		},
 		StopOn: &v1alpha1.StopOnSpec{
-			UIButtons: []string{"(Tiltfile)-cancel"},
+			UIButtons: []string{uibutton.StopBuildButtonName("(Tiltfile)")},
 		},
 	})
 }
@@ -64,15 +64,15 @@ func TestCreateTiltfileCancelEnabled(t *testing.T) {
 			FileWatches: []string{"configs:(Tiltfile)"},
 		},
 		StopOn: &v1alpha1.StopOnSpec{
-			UIButtons: []string{"(Tiltfile)-cancel"},
+			UIButtons: []string{uibutton.StopBuildButtonName("(Tiltfile)")},
 		},
 	}
 	assert.Equal(t, expectedTfSpec, tf.Spec)
 
 	var actualButton v1alpha1.UIButton
-	name := types.NamespacedName{Name: uibutton.CancelButtonName(model.MainTiltfileManifestName.String())}
+	name := types.NamespacedName{Name: uibutton.StopBuildButtonName(model.MainTiltfileManifestName.String())}
 	err := client.Get(ctx, name, &actualButton)
 	require.NoError(t, err)
-	expectedButton := uibutton.CancelButton(model.MainTiltfileManifestName.String())
+	expectedButton := uibutton.StopBuildButton(model.MainTiltfileManifestName.String())
 	assert.Equal(t, expectedButton.Spec, actualButton.Spec)
 }
diff --git a/pkg/apis/core/v1alpha1/uibutton_types.go b/pkg/apis/core/v1alpha1/uibutton_types.go
@@ -123,7 +123,7 @@ type UIComponentLocationResource struct {
 const AnnotationButtonType = "tilt.dev/uibutton-type"
 
 const ButtonTypeDisableToggle = "DisableToggle"
-const ButtonTypeCancelUpdate = "CancelUpdate"
+const ButtonTypeStopBuild = "StopBuild"
 
 var _ resource.Object = &UIButton{}
 var _ resourcestrategy.Validater = &UIButton{}

diff --git a/web/src/ApiButton.test.tsx b/web/src/ApiButton.test.tsx
@@ -426,7 +426,9 @@ describe("ApiButton", () => {
   describe("helper functions", () => {
     describe("buttonsByComponent", () => {
       it("returns an empty object if there are no buttons", () => {
-        expect(buttonsByComponent(undefined)).toStrictEqual({})
+        expect(buttonsByComponent(undefined)).toStrictEqual(
+          new Map<string, ButtonSet>()
+        )
       })
 
       it("returns a map of resources names to button sets", () => {
@@ -440,14 +442,17 @@ describe("ApiButton", () => {
           makeUIButton({ componentID: "" }),
         ]
 
-        const expectedOutput: { [key: string]: ButtonSet } = {
-          frontend: {
-            default: [buttons[0], buttons[1]],
-            toggleDisable: buttons[2],
-          },
-          backend: { default: [buttons[3]], toggleDisable: buttons[4] },
-          ["data-warehouse"]: { default: [buttons[5]] },
-        }
+        const expectedOutput = new Map<string, ButtonSet>([
+          [
+            "frontend",
+            {
+              default: [buttons[0], buttons[1]],
+              toggleDisable: buttons[2],
+            },
+          ],
+          ["backend", { default: [buttons[3]], toggleDisable: buttons[4] }],
+          ["data-warehouse", { default: [buttons[5]] }],
+        ])
 
         expect(buttonsByComponent(buttons)).toStrictEqual(expectedOutput)
       })