forge: Add MarshalChangeID/UnmarshalChangeID (#521)

Add a means for forges to serialize and deserialize just their ChangeIDs without any other change metadata. This will be used by #508.
abhinav · Dec 20, 2024 · 28d0458 · 28d0458
1 parent b1932d1
commit 28d0458
Show file tree

Hide file tree

Showing 7 changed files with 179 additions and 6 deletions.
diff --git a/internal/forge/forge.go b/internal/forge/forge.go
@@ -91,6 +91,12 @@ type Forge interface {
 	// it's possible to define change templates in the repository.
 	ChangeTemplatePaths() []string
 
+	// MarshalChangeID serializes the given change ID into a valid JSON blob.
+	MarshalChangeID(ChangeID) (json.RawMessage, error)
+
+	// UnmarshalChangeID deserializes the given JSON blob into a change ID.
+	UnmarshalChangeID(json.RawMessage) (ChangeID, error)
+
 	// MarshalChangeMetadata serializes the given change metadata
 	// into a valid JSON blob.
 	MarshalChangeMetadata(ChangeMetadata) (json.RawMessage, error)

diff --git a/internal/forge/forgetest/mocks.go b/internal/forge/forgetest/mocks.go
diff --git a/internal/forge/github/change_meta.go b/internal/forge/github/change_meta.go
@@ -75,6 +75,20 @@ func (*Forge) UnmarshalChangeMetadata(data json.RawMessage) (forge.ChangeMetadat
 	return &md, nil
 }
 
+// MarshalChangeID serializes a PR into JSON.
+func (*Forge) MarshalChangeID(cid forge.ChangeID) (json.RawMessage, error) {
+	return json.Marshal(mustPR(cid))
+}
+
+// UnmarshalChangeID deserializes a PR from JSON.
+func (*Forge) UnmarshalChangeID(data json.RawMessage) (forge.ChangeID, error) {
+	var pr PR
+	if err := json.Unmarshal(data, &pr); err != nil {
+		return nil, fmt.Errorf("unmarshal PR: %w", err)
+	}
+	return &pr, nil
+}
+
 // PR uniquely identifies a PR in a GitHub repository.
 // It's a valid forge.ChangeID.
 type PR struct {

diff --git a/internal/forge/github/change_meta_test.go b/internal/forge/github/change_meta_test.go
@@ -30,6 +30,33 @@ func TestPRString(t *testing.T) {
 	}).String())
 }
 
+func TestPRMarshal(t *testing.T) {
+	tests := []struct {
+		name string
+		give PR
+		want string
+	}{
+		{
+			name: "NumberOnly",
+			give: PR{Number: 42},
+			want: `{"number": 42}`,
+		},
+		{
+			name: "NumberAndGQLID",
+			give: PR{Number: 42, GQLID: "foo"},
+			want: `{"number": 42, "gqlID": "foo"}`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := new(Forge).MarshalChangeID(&tt.give)
+			require.NoError(t, err)
+			assert.JSONEq(t, tt.want, string(got))
+		})
+	}
+}
+
 func TestPRUnmarshal(t *testing.T) {
 	tests := []struct {
 		name string
@@ -57,16 +84,15 @@ func TestPRUnmarshal(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			var pr PR
-			err := json.Unmarshal([]byte(tt.give), &pr)
+			pr, err := new(Forge).UnmarshalChangeID(json.RawMessage(tt.give))
 			if tt.wantErr != "" {
 				require.Error(t, err)
 				assert.ErrorContains(t, err, tt.wantErr)
 				return
 			}
 
 			require.NoError(t, err)
-			assert.Equal(t, tt.want, pr)
+			assert.Equal(t, &tt.want, pr)
 		})
 	}
 }

diff --git a/internal/forge/gitlab/change_meta.go b/internal/forge/gitlab/change_meta.go
@@ -68,6 +68,20 @@ func (*Forge) UnmarshalChangeMetadata(data json.RawMessage) (forge.ChangeMetadat
 	return &md, nil
 }
 
+// MarshalChangeID serializes a MR into JSON.
+func (*Forge) MarshalChangeID(id forge.ChangeID) (json.RawMessage, error) {
+	return json.Marshal(mustMR(id))
+}
+
+// UnmarshalChangeID deserializes a MR from JSON.
+func (*Forge) UnmarshalChangeID(data json.RawMessage) (forge.ChangeID, error) {
+	var id MR
+	if err := json.Unmarshal(data, &id); err != nil {
+		return nil, fmt.Errorf("unmarshal MR ID: %w", err)
+	}
+	return &id, nil
+}
+
 // MR uniquely identifies a Merge Request in GitLab.
 // It's a valid forge.ChangeID.
 type MR struct {

diff --git a/internal/forge/gitlab/change_meta_test.go b/internal/forge/gitlab/change_meta_test.go
@@ -48,6 +48,28 @@ func TestMRString(t *testing.T) {
 	}).String())
 }
 
+func TestMRMarshal(t *testing.T) {
+	tests := []struct {
+		name string
+		give MR
+		want string
+	}{
+		{
+			name: "NumberOnly",
+			give: MR{Number: 42},
+			want: `{"number": 42}`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := new(Forge).MarshalChangeID(&tt.give)
+			require.NoError(t, err)
+			assert.JSONEq(t, tt.want, string(got))
+		})
+	}
+}
+
 func TestMRUnmarshal(t *testing.T) {
 	tests := []struct {
 		name string
@@ -70,16 +92,15 @@ func TestMRUnmarshal(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			var pr MR
-			err := json.Unmarshal([]byte(tt.give), &pr)
+			pr, err := new(Forge).UnmarshalChangeID(json.RawMessage(tt.give))
 			if tt.wantErr != "" {
 				require.Error(t, err)
 				assert.ErrorContains(t, err, tt.wantErr)
 				return
 			}
 
 			require.NoError(t, err)
-			assert.Equal(t, tt.want, pr)
+			assert.Equal(t, &tt.want, pr)
 		})
 	}
 }

diff --git a/internal/forge/shamhub/change_meta.go b/internal/forge/shamhub/change_meta.go
@@ -63,3 +63,17 @@ func (f *Forge) UnmarshalChangeMetadata(data json.RawMessage) (forge.ChangeMetad
 	}
 	return &md, nil
 }
+
+// MarshalChangeID marshals the given change ID to JSON.
+func (f *Forge) MarshalChangeID(id forge.ChangeID) (json.RawMessage, error) {
+	return json.Marshal(id.(ChangeID))
+}
+
+// UnmarshalChangeID unmarshals the given JSON data to change ID.
+func (f *Forge) UnmarshalChangeID(data json.RawMessage) (forge.ChangeID, error) {
+	var id ChangeID
+	if err := json.Unmarshal(data, &id); err != nil {
+		return nil, fmt.Errorf("unmarshal change ID: %w", err)
+	}
+	return id, nil
+}