Refactor repeated default prefixes in variable resolution (#3365)

## Why
Plan to update this with "resources", this reduces number of places to
change. Also adds a central place to explain why this list has this
contents.

## Tests
Existing tests.

Author: denik

bundle/config/mutator/resolve_variable_references.go

@@ -33,6 +33,16 @@ rounds           time
 */
 const maxResolutionRounds = 11
 
+// List of prefixes to be used by default in ResolveVariableReferencesOnlyResources/ResolveVariableReferencesWithoutResources
+// Prefixes specify which references are resolves, e.g. ${bundle...} and so on.
+// This list does not include "artifacts" because this section will be modified in build phase and variable resolution happens in initialize phase.
+// This list does not include "resources" because some of those references are known after resource is deployed.
+var defaultPrefixes = []string{
+	"bundle",
+	"workspace",
+	"variables",
+}
+
 type resolveVariableReferences struct {
 	prefixes    []string
 	pattern     dyn.Pattern
@@ -48,6 +58,9 @@ type resolveVariableReferences struct {
 }
 
 func ResolveVariableReferencesOnlyResources(prefixes ...string) bundle.Mutator {
+	if len(prefixes) == 0 {
+		prefixes = defaultPrefixes
+	}
 	return &resolveVariableReferences{
 		prefixes:         prefixes,
 		lookupFn:         lookup,
@@ -58,6 +71,9 @@ func ResolveVariableReferencesOnlyResources(prefixes ...string) bundle.Mutator {
 }
 
 func ResolveVariableReferencesWithoutResources(prefixes ...string) bundle.Mutator {
+	if len(prefixes) == 0 {
+		prefixes = defaultPrefixes
+	}
 	return &resolveVariableReferences{
 		prefixes:    prefixes,
 		lookupFn:    lookup,
@@ -67,11 +83,7 @@ func ResolveVariableReferencesWithoutResources(prefixes ...string) bundle.Mutato
 
 func ResolveVariableReferencesInLookup() bundle.Mutator {
 	return &resolveVariableReferences{
-		prefixes: []string{
-			"bundle",
-			"workspace",
-			"variables",
-		},
+		prefixes:    defaultPrefixes,
 		pattern:     dyn.NewPattern(dyn.Key("variables"), dyn.AnyKey(), dyn.Key("lookup")),
 		lookupFn:    lookupForVariables,
 		extraRounds: maxResolutionRounds - 1,

bundle/config/mutator/resourcemutator/process_static_resources.go

@@ -44,11 +44,7 @@ func (p processStaticResources) Apply(ctx context.Context, b *bundle.Bundle) dia
 		// Reads (dynamic): * (strings) (searches for variable references in string values)
 		// Updates (dynamic): resources.* (strings) (resolves variable references to their actual values)
 		// Resolves variable references in 'resources' using bundle, workspace, and variables prefixes
-		mutator.ResolveVariableReferencesOnlyResources(
-			"bundle",
-			"workspace",
-			"variables",
-		),
+		mutator.ResolveVariableReferencesOnlyResources(),
 		mutator.NormalizePaths(),
 
 		// Translate dashboard paths into paths in the workspace file system

bundle/config/mutator/resourcemutator/resource_mutator.go

@@ -125,11 +125,7 @@ func applyNormalizeMutators(ctx context.Context, b *bundle.Bundle) {
 		// Reads (dynamic): * (strings) (searches for variable references in string values)
 		// Updates (dynamic): resources.* (strings) (resolves variable references to their actual values)
 		// Resolves variable references in 'resources' using bundle, workspace, and variables prefixes
-		mutator.ResolveVariableReferencesOnlyResources(
-			"bundle",
-			"workspace",
-			"variables",
-		),
+		mutator.ResolveVariableReferencesOnlyResources(),
 
 		// Reads (dynamic): resources.pipelines.*.libraries (checks for notebook.path and file.path fields)
 		// Updates (dynamic): resources.pipelines.*.libraries (expands glob patterns in path fields to multiple library entries)

bundle/phases/initialize.go

@@ -119,11 +119,7 @@ func Initialize(ctx context.Context, b *bundle.Bundle) {
 		// Updates (dynamic): * (except 'resources') (strings) (resolves variable references to their actual values)
 		// Resolves variable references in configuration (except resources) using bundle, workspace,
 		// and variables prefixes
-		mutator.ResolveVariableReferencesWithoutResources(
-			"bundle",
-			"workspace",
-			"variables",
-		),
+		mutator.ResolveVariableReferencesWithoutResources(),
 
 		// Check for invalid use of /Volumes in workspace paths
 		validate.ValidateVolumePath(),