refactor: remove util/slice and use standard slices library (argo…

…proj#13775) Signed-off-by: Alan Clucas <[email protected]>
codefresh-io · Oct 24, 2024 · b49e88e · b49e88e
1 parent cd87c50
commit b49e88e
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 105 deletions.
diff --git a/pkg/apis/workflow/v1alpha1/workflow_types.go b/pkg/apis/workflow/v1alpha1/workflow_types.go
@@ -11,6 +11,7 @@ import (
 	"reflect"
 	"regexp"
 	"runtime"
+	"slices"
 	"sort"
 	"strings"
 	"time"
@@ -26,7 +27,6 @@ import (
 	log "github.com/sirupsen/logrus"
 
 	argoerrs "github.com/argoproj/argo-workflows/v3/errors"
-	"github.com/argoproj/argo-workflows/v3/util/slice"
 )
 
 // TemplateType is the type of a template
@@ -3789,7 +3789,7 @@ func (ss *SemaphoreStatus) LockAcquired(holderKey, lockKey string, currentHolder
 	if i < 0 {
 		ss.Holding = append(ss.Holding, SemaphoreHolding{Semaphore: lockKey, Holders: []string{holdingName}})
 		return true
-	} else if !slice.ContainsString(semaphoreHolding.Holders, holdingName) {
+	} else if !slices.Contains(semaphoreHolding.Holders, holdingName) {
 		semaphoreHolding.Holders = append(semaphoreHolding.Holders, holdingName)
 		ss.Holding[i] = semaphoreHolding
 		return true
@@ -3802,7 +3802,8 @@ func (ss *SemaphoreStatus) LockReleased(holderKey, lockKey string) bool {
 	holdingName := holderKey
 
 	if i >= 0 {
-		semaphoreHolding.Holders = slice.RemoveString(semaphoreHolding.Holders, holdingName)
+		semaphoreHolding.Holders = slices.DeleteFunc(semaphoreHolding.Holders,
+			func(x string) bool { return x == holdingName })
 		ss.Holding[i] = semaphoreHolding
 		return true
 	}

diff --git a/util/slice/slice.go b/util/slice/slice.go
diff --git a/util/slice/slice_test.go b/util/slice/slice_test.go
diff --git a/workflow/controller/artifact_gc.go b/workflow/controller/artifact_gc.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"hash/fnv"
+	"slices"
 	"sort"
 
 	"golang.org/x/exp/maps"
@@ -16,7 +17,6 @@ import (
 
 	"github.com/argoproj/argo-workflows/v3/pkg/apis/workflow"
 	wfv1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
-	"github.com/argoproj/argo-workflows/v3/util/slice"
 	"github.com/argoproj/argo-workflows/v3/workflow/common"
 	"github.com/argoproj/argo-workflows/v3/workflow/controller/indexes"
 	"github.com/argoproj/argo-workflows/v3/workflow/util"
@@ -38,7 +38,7 @@ func (woc *wfOperationCtx) addArtifactGCFinalizer() {
 
 	// only do Artifact GC if we have a Finalizer for it (i.e. Artifact GC is configured for this Workflow
 	// and there's work left to do for it)
-	if !slice.ContainsString(woc.wf.Finalizers, common.FinalizerArtifactGC) {
+	if !slices.Contains(woc.wf.Finalizers, common.FinalizerArtifactGC) {
 		if woc.wf.Status.ArtifactGCStatus.NotSpecified {
 			return // we already verified it's not required for this workflow
 		}
@@ -549,7 +549,8 @@ func (woc *wfOperationCtx) processArtifactGCCompletion(ctx context.Context) erro
 	}
 	if removeFinalizer {
 		woc.log.Infof("no remaining artifacts to GC, removing artifact GC finalizer (forceFinalizerRemoval=%v)", forceFinalizerRemoval)
-		woc.wf.Finalizers = slice.RemoveString(woc.wf.Finalizers, common.FinalizerArtifactGC)
+		woc.wf.Finalizers = slices.DeleteFunc(woc.wf.Finalizers,
+			func(x string) bool { return x == common.FinalizerArtifactGC })
 		woc.updated = true
 	}
 	return nil

diff --git a/workflow/controller/controller.go b/workflow/controller/controller.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"slices"
 	"strconv"
 	gosync "sync"
 	"syscall"
@@ -15,7 +16,6 @@ import (
 	"github.com/argoproj/pkg/errors"
 	syncpkg "github.com/argoproj/pkg/sync"
 	log "github.com/sirupsen/logrus"
-	"golang.org/x/exp/slices"
 	"golang.org/x/time/rate"
 	apiv1 "k8s.io/api/core/v1"
 	apierr "k8s.io/apimachinery/pkg/api/errors"
@@ -53,7 +53,6 @@ import (
 	"github.com/argoproj/argo-workflows/v3/util/diff"
 	"github.com/argoproj/argo-workflows/v3/util/env"
 	errorsutil "github.com/argoproj/argo-workflows/v3/util/errors"
-	"github.com/argoproj/argo-workflows/v3/util/slice"
 	"github.com/argoproj/argo-workflows/v3/util/telemetry"
 	"github.com/argoproj/argo-workflows/v3/workflow/artifactrepositories"
 	"github.com/argoproj/argo-workflows/v3/workflow/common"
@@ -546,7 +545,9 @@ func (wfc *WorkflowController) getPodCleanupPatch(pod *apiv1.Pod, labelPodComple
 
 	finalizerEnabled := os.Getenv(common.EnvVarPodStatusCaptureFinalizer) == "true"
 	if finalizerEnabled && pod.Finalizers != nil {
-		finalizers := slice.RemoveString(pod.Finalizers, common.FinalizerPodStatus)
+		finalizers := slices.Clone(pod.Finalizers)
+		finalizers = slices.DeleteFunc(finalizers,
+			func(s string) bool { return s == common.FinalizerPodStatus })
 		if len(finalizers) != len(pod.Finalizers) {
 			un.SetFinalizers(finalizers)
 			un.SetResourceVersion(pod.ObjectMeta.ResourceVersion)
@@ -1108,7 +1109,7 @@ func (wfc *WorkflowController) addWorkflowInformerHandlers(ctx context.Context)
 						log.WithError(err).Error("Failed to list pods")
 					}
 					for _, p := range podList.Items {
-						if slice.ContainsString(p.Finalizers, common.FinalizerPodStatus) {
+						if slices.Contains(p.Finalizers, common.FinalizerPodStatus) {
 							wfc.queuePodForCleanup(p.Namespace, p.Name, removeFinalizer)
 						}
 					}

diff --git a/workflow/controller/controller_test.go b/workflow/controller/controller_test.go
@@ -1191,7 +1191,7 @@ spec:
 	assert.Empty(t, pods.Items)
 }
 
-func TestPodCleaupPatch(t *testing.T) {
+func TestPodCleanupPatch(t *testing.T) {
 	wfc := &WorkflowController{}
 
 	pod := &apiv1.Pod{

diff --git a/workflow/controller/operator.go b/workflow/controller/operator.go
@@ -9,6 +9,7 @@ import (
 	"reflect"
 	"regexp"
 	"runtime/debug"
+	"slices"
 	"sort"
 	"strconv"
 	"strings"
@@ -50,7 +51,6 @@ import (
 	"github.com/argoproj/argo-workflows/v3/util/retry"
 	argoruntime "github.com/argoproj/argo-workflows/v3/util/runtime"
 	"github.com/argoproj/argo-workflows/v3/util/secrets"
-	"github.com/argoproj/argo-workflows/v3/util/slice"
 	"github.com/argoproj/argo-workflows/v3/util/template"
 	waitutil "github.com/argoproj/argo-workflows/v3/util/wait"
 	"github.com/argoproj/argo-workflows/v3/workflow/common"
@@ -1769,7 +1769,8 @@ func (woc *wfOperationCtx) deletePVCs(ctx context.Context) error {
 			if err != nil {
 				return err
 			}
-			x.Finalizers = slice.RemoveString(x.Finalizers, "kubernetes.io/pvc-protection")
+			x.Finalizers = slices.DeleteFunc(x.Finalizers,
+				func(s string) bool { return s == "kubernetes.io/pvc-protection" })
 			_, err = pvcClient.Update(ctx, x, metav1.UpdateOptions{})
 			if err != nil {
 				return err

diff --git a/workflow/executor/common/common.go b/workflow/executor/common/common.go
@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"slices"
 	"strings"
 	"syscall"
 	"time"
@@ -15,7 +16,6 @@ import (
 	v1 "k8s.io/api/core/v1"
 
 	envutil "github.com/argoproj/argo-workflows/v3/util/env"
-	"github.com/argoproj/argo-workflows/v3/util/slice"
 )
 
 const (
@@ -96,7 +96,7 @@ func TerminatePodWithContainerNames(ctx context.Context, c KubernetesClientInter
 		return err
 	}
 	for _, s := range containerStatuses {
-		if !slice.ContainsString(containerNames, s.Name) {
+		if !slices.Contains(containerNames, s.Name) {
 			continue
 		}
 		if s.State.Terminated != nil {