Add monorepo name to the builder metadata and set monorepo metadata within monorepo buildpacks.

PiperOrigin-RevId: 799611698
Change-Id: Ia7a205e0db5519fadc86c53f19fddcb4f546f316

Author: GCP Buildpacks Team

cmd/nodejs/firebasenx/BUILD.bazel

@@ -36,6 +36,7 @@ go_binary(
         "-w",
     ],
     deps = [
+        "//pkg/buildermetadata",
         "//pkg/env",
         "//pkg/firebase/util",
         "//pkg/gcpbuildpack",
@@ -50,5 +51,6 @@ go_test(
     rundir = ".",
     deps = [
         "//internal/buildpacktest",
+        "//pkg/buildermetadata",
     ],
 )

cmd/nodejs/firebasenx/main.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/GoogleCloudPlatform/buildpacks/pkg/buildermetadata"
 	"github.com/GoogleCloudPlatform/buildpacks/pkg/env"
 	"github.com/GoogleCloudPlatform/buildpacks/pkg/firebase/util"
 	gcp "github.com/GoogleCloudPlatform/buildpacks/pkg/gcpbuildpack"
@@ -98,5 +99,8 @@ func buildFn(ctx *gcp.Context) error {
 	// to the Nx API.
 	nxl.BuildEnvironment.Override(nxNoCloud, "true")
 
+	// add nx as the monorepo name to the builder metadata
+	buildermetadata.GlobalBuilderMetadata().SetValue(buildermetadata.MonorepoName, "nx")
+
 	return nil
 }

cmd/nodejs/firebasenx/main_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	bpt "github.com/GoogleCloudPlatform/buildpacks/internal/buildpacktest"
+	bmd "github.com/GoogleCloudPlatform/buildpacks/pkg/buildermetadata"
 )
 
 func TestDetect(t *testing.T) {
@@ -47,10 +48,11 @@ func TestDetect(t *testing.T) {
 
 func TestBuild(t *testing.T) {
 	testCases := []struct {
-		name         string
-		envs         []string
-		files        map[string]string
-		wantExitCode int
+		name                string
+		envs                []string
+		files               map[string]string
+		wantExitCode        int
+		wantBuilderMetadata map[bmd.MetadataID]bmd.MetadataValue
 	}{
 		{
 			name: "successfully read project.json",
@@ -70,6 +72,9 @@ func TestBuild(t *testing.T) {
 				}`,
 			},
 			wantExitCode: 0,
+			wantBuilderMetadata: map[bmd.MetadataID]bmd.MetadataValue{
+				bmd.MonorepoName: bmd.MetadataValue("nx"),
+			},
 		},
 		{
 			name: "ambiguous project name",
@@ -105,6 +110,11 @@ func TestBuild(t *testing.T) {
 			if result.ExitCode != tc.wantExitCode {
 				t.Fatalf("build exit code mismatch, got: %d, want: %d", result.ExitCode, tc.wantExitCode)
 			}
+			for id, m := range tc.wantBuilderMetadata {
+				if m != result.MetadataAdded()[id] {
+					t.Errorf("builder metadata %q mismatch, got: %s, want: %s", bmd.MetadataIDNames[id], result.MetadataAdded()[id], m)
+				}
+			}
 		})
 	}
 }

cmd/nodejs/turborepo/BUILD.bazel

@@ -36,6 +36,7 @@ go_binary(
         "-w",
     ],
     deps = [
+        "//pkg/buildermetadata",
         "//pkg/firebase/util",
         "//pkg/gcpbuildpack",
         "//pkg/nodejs",
@@ -47,5 +48,8 @@ go_test(
     srcs = ["main_test.go"],
     embed = [":main"],
     rundir = ".",
-    deps = ["//internal/buildpacktest"],
+    deps = [
+        "//internal/buildpacktest",
+        "//pkg/buildermetadata",
+    ],
 )

cmd/nodejs/turborepo/main.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/GoogleCloudPlatform/buildpacks/pkg/buildermetadata"
 	"github.com/GoogleCloudPlatform/buildpacks/pkg/firebase/util"
 	gcp "github.com/GoogleCloudPlatform/buildpacks/pkg/gcpbuildpack"
 	"github.com/GoogleCloudPlatform/buildpacks/pkg/nodejs"
@@ -85,5 +86,8 @@ func buildFn(ctx *gcp.Context) error {
 	turbol.BuildEnvironment.Override(monorepoCommand, "turbo")
 	turbol.BuildEnvironment.Override(monorepoBuildArgs, strings.Join(buildArgs, ","))
 
+	// add turbo as the monorepo name to the builder metadata
+	buildermetadata.GlobalBuilderMetadata().SetValue(buildermetadata.MonorepoName, "turbo")
+
 	return nil
 }

cmd/nodejs/turborepo/main_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	bpt "github.com/GoogleCloudPlatform/buildpacks/internal/buildpacktest"
+	bmd "github.com/GoogleCloudPlatform/buildpacks/pkg/buildermetadata"
 )
 
 func TestDetect(t *testing.T) {
@@ -38,10 +39,11 @@ func TestDetect(t *testing.T) {
 
 func TestBuild(t *testing.T) {
 	testCases := []struct {
-		name         string
-		envs         []string
-		files        map[string]string
-		wantExitCode int
+		name                string
+		envs                []string
+		files               map[string]string
+		wantExitCode        int
+		wantBuilderMetadata map[bmd.MetadataID]bmd.MetadataValue
 	}{
 		{
 			name: "successfully_reads_turbo_json_and_app_package_json",
@@ -61,6 +63,9 @@ func TestBuild(t *testing.T) {
 				}`,
 			},
 			wantExitCode: 0,
+			wantBuilderMetadata: map[bmd.MetadataID]bmd.MetadataValue{
+				bmd.MonorepoName: bmd.MetadataValue("turbo"),
+			},
 		},
 		{
 			name: "ambiguous_application_name",
@@ -96,6 +101,11 @@ func TestBuild(t *testing.T) {
 			if result.ExitCode != tc.wantExitCode {
 				t.Fatalf("build exit code mismatch, got: %d, want: %d", result.ExitCode, tc.wantExitCode)
 			}
+			for id, m := range tc.wantBuilderMetadata {
+				if m != result.MetadataAdded()[id] {
+					t.Errorf("builder metadata %q mismatch, got: %s, want: %s", bmd.MetadataIDNames[id], result.MetadataAdded()[id], m)
+				}
+			}
 		})
 	}
 }

pkg/buildermetadata/buildermetadata.go

@@ -56,6 +56,7 @@ const (
 	FrameworkVersion MetadataID = "4" // The framework version used in the build.
 	AdapterName      MetadataID = "5" // The adapter name used in the build.
 	AdapterVersion   MetadataID = "6" // The adapter version used in the build.
+	MonorepoName     MetadataID = "7" // The monorepo name used in the build.
 )
 
 // MetadataIDNames is a lookup map from MetadataID to its name.
@@ -66,6 +67,7 @@ var MetadataIDNames = map[MetadataID]string{
 	FrameworkVersion: "FrameworkVersion",
 	AdapterName:      "AdapterName",
 	AdapterVersion:   "AdapterVersion",
+	MonorepoName:     "MonorepoName",
 }
 
 // GetValue returns the Metadata value with MetadataID id, or creates it if it doesn't exist.

pkg/buildermetadata/buildermetadata_test.go

@@ -37,9 +37,9 @@ func TestBuilderMetadataUnmarshalJSON(t *testing.T) {
 		},
 		{
 			name:  "basic metadata",
-			input: []byte(`{"m":{"1":"true","2":"false","3":"angular","4":"17.0.0","5":"@apphosting/adapter-angular","6":"17.2.3"}}`),
+			input: []byte(`{"m":{"1":"true","2":"false","3":"angular","4":"17.0.0","5":"@apphosting/adapter-angular","6":"17.2.3","7":"nx"}}`),
 			want: BuilderMetadata{
-				map[MetadataID]MetadataValue{"1": "true", "2": "false", "3": "angular", "4": "17.0.0", "5": "@apphosting/adapter-angular", "6": "17.2.3"},
+				map[MetadataID]MetadataValue{"1": "true", "2": "false", "3": "angular", "4": "17.0.0", "5": "@apphosting/adapter-angular", "6": "17.2.3", "7": "nx"},
 			},
 		},
 	}
@@ -72,8 +72,8 @@ func TestBuilderMetadataMarshalJSON(t *testing.T) {
 		},
 		{
 			name:  "basic metadata",
-			input: BuilderMetadata{map[MetadataID]MetadataValue{"1": "true", "2": "false", "3": "angular", "4": "17.0.0", "5": "@apphosting/adapter-angular", "6": "17.2.3"}},
-			want:  []byte(`{"m":{"1":"true","2":"false","3":"angular","4":"17.0.0","5":"@apphosting/adapter-angular","6":"17.2.3"}}`),
+			input: BuilderMetadata{map[MetadataID]MetadataValue{"1": "true", "2": "false", "3": "angular", "4": "17.0.0", "5": "@apphosting/adapter-angular", "6": "17.2.3", "7": "nx"}},
+			want:  []byte(`{"m":{"1":"true","2":"false","3":"angular","4":"17.0.0","5":"@apphosting/adapter-angular","6":"17.2.3","7":"nx"}}`),
 		},
 	}
 

pkg/builderoutput/builderoutput_test.go

@@ -38,7 +38,7 @@ func TestFromJSON(t *testing.T) {
 		"errorMessage": "error-message",
 		"anotherThing": 123
 	},
-	"metadata": {"m":{"1":"true", "2":"false", "3":"angular", "4":"17.0.0", "5":"@apphosting/adapter-angular", "6":"17.2.3"}},
+	"metadata": {"m":{"1":"true", "2":"false", "3":"angular", "4":"17.0.0", "5":"@apphosting/adapter-angular", "6":"17.2.3", "7":"nx"}},
 	"stats": [
 		{
 			"buildpackId": "buildpack-1",
@@ -77,6 +77,7 @@ func TestFromJSON(t *testing.T) {
 	fm.SetValue(buildermetadata.FrameworkVersion, "17.0.0")
 	fm.SetValue(buildermetadata.AdapterName, "@apphosting/adapter-angular")
 	fm.SetValue(buildermetadata.AdapterVersion, "17.2.3")
+	fm.SetValue(buildermetadata.MonorepoName, "nx")
 	want := BuilderOutput{
 		InstalledRuntimeVersions: []string{"6.0.6"},
 		Metrics:                  bm,
@@ -125,6 +126,7 @@ func TestJSON(t *testing.T) {
 	fm.SetValue(buildermetadata.FrameworkVersion, "17.0.0")
 	fm.SetValue(buildermetadata.AdapterName, "@apphosting/adapter-angular")
 	fm.SetValue(buildermetadata.AdapterVersion, "17.2.3")
+	fm.SetValue(buildermetadata.MonorepoName, "nx")
 	b := BuilderOutput{
 		InstalledRuntimeVersions: []string{"6.0.6"},
 		Metrics:                  bm,
@@ -146,7 +148,7 @@ func TestJSON(t *testing.T) {
 	if want := `{"c":{"1":3}}`; !strings.Contains(string(s), want) {
 		t.Errorf(`Expected string %q not found in %s`, want, s)
 	}
-	if want := `{"m":{"1":"true","2":"false","3":"angular","4":"17.0.0","5":"@apphosting/adapter-angular","6":"17.2.3"}}`; !strings.Contains(string(s), want) {
+	if want := `{"m":{"1":"true","2":"false","3":"angular","4":"17.0.0","5":"@apphosting/adapter-angular","6":"17.2.3","7":"nx"}}`; !strings.Contains(string(s), want) {
 		t.Errorf(`Expected string %q not found in %s`, want, s)
 	}
 }