Update Packet metadata generation based on feedback (#27490)

server/public/pluginapi/system.go

@@ -2,11 +2,14 @@ package pluginapi
 
 import (
 	"net/url"
+	"os"
 	"path"
+	filePath "path"
 	"time"
 
 	"github.com/blang/semver/v4"
 	"github.com/pkg/errors"
+	"gopkg.in/yaml.v2"
 
 	"github.com/mattermost/mattermost/server/public/model"
 	"github.com/mattermost/mattermost/server/public/plugin"
@@ -102,11 +105,20 @@ func (s *SystemService) GetSystemInstallDate() (time.Time, error) {
 // GetDiagnosticID returns a unique identifier used by the server for diagnostic reports.
 //
 // Minimum server version: 5.10
+//
+// Deprecated: Use GetTelemetryID instead. It returns the same value.
 func (s *SystemService) GetDiagnosticID() string {
 	// TODO: Consider deprecating/rewriting in favor of just using GetUnsanitizedConfig().
 	return s.api.GetDiagnosticId()
 }
 
+// GetTelemetryID returns a unique identifier used by the server for telemetry reports.
+//
+// Minimum server version: 5.10
+func (s *SystemService) GetTelemetryID() string {
+	return s.api.GetTelemetryId()
+}
+
 // RequestTrialLicense requests a trial license and installs it in the server.
 // If the server version is lower than 5.36.0, an error is returned.
 //
@@ -122,3 +134,49 @@ func (s *SystemService) RequestTrialLicense(requesterID string, users int, terms
 	err := s.api.RequestTrialLicense(requesterID, users, termsAccepted, receiveEmailsAccepted)
 	return normalizeAppErr(err)
 }
+
+// GeneratePacketMetadata generates metadata for Customer Packets, encods it to YAML and saves it to a file
+// defined by the path parameter.
+// pluginMeta should contain the values that plugin wants to insert into the standard metadata.
+//
+// The plugin_id and plugin_version will be used from the manifest.
+// If pluginMeta contains plugin_id or plugin_version, they will be overridden.
+//
+// It returns the path to the file where the metadata was saved.
+//
+// @tag Metadata
+// Minimum server version: 5.10
+func (s *SystemService) GeneratePacketMetadata(path string, pluginMeta map[string]any) (string, error) {
+	manifest, err := s.GetManifest()
+	if err != nil {
+		return "", errors.Wrap(err, "failed to get manifest")
+	}
+	license := s.GetLicense()
+	serverID := s.GetTelemetryID()
+
+	if pluginMeta == nil {
+		pluginMeta = make(map[string]any)
+	}
+
+	// we override the plugin_id and version fields from the manifest
+	pluginMeta["plugin_id"] = manifest.Id
+	pluginMeta["plugin_version"] = manifest.Version
+
+	md, err := model.GeneratePacketMetadata(serverID, license, pluginMeta)
+	if err != nil {
+		return "", errors.Wrap(err, "failed to get packet metadata")
+	}
+	filePath := filePath.Join(path, model.PacketMetadataFileName)
+	f, err := os.Create(filePath)
+	if err != nil {
+		return "", errors.Wrap(err, "failed to create packet metadata file")
+	}
+	defer f.Close()
+
+	err = yaml.NewEncoder(f).Encode(md)
+	if err != nil {
+		return "", errors.Wrap(err, "failed to create packet metadata file")
+	}
+
+	return filePath, nil
+}

server/public/pluginapi/system_test.go

@@ -1,12 +1,14 @@
 package pluginapi_test
 
 import (
+	"encoding/json"
 	"os"
 	"path/filepath"
 	"testing"
 
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v2"
 
 	"github.com/mattermost/mattermost/server/public/model"
 	"github.com/mattermost/mattermost/server/public/plugin/plugintest"
@@ -15,25 +17,13 @@ import (
 
 func TestGetManifest(t *testing.T) {
 	t.Run("valid manifest", func(t *testing.T) {
-		content := []byte(`
-		{
-			"id": "some.id",
-			"name": "Some Name"
-		}
-		`)
 		expectedManifest := &model.Manifest{
-			Id:   "some.id",
-			Name: "Some Name",
+			Id:      "some.id",
+			Name:    "Some Name",
+			Version: "1.0.0",
 		}
 
-		dir, err := os.MkdirTemp("", "")
-		require.NoError(t, err)
-		defer os.RemoveAll(dir)
-
-		tmpfn := filepath.Join(dir, "plugin.json")
-		//nolint:gosec //only used in tests
-		err = os.WriteFile(tmpfn, content, 0o666)
-		require.NoError(t, err)
+		dir := generateManifest(t)
 
 		api := &plugintest.API{}
 		api.On("GetBundlePath").Return(dir, nil)
@@ -102,3 +92,69 @@ func TestRequestTrialLicense(t *testing.T) {
 		require.NoError(t, err)
 	})
 }
+
+func TestGenerateCustomerPacketMetadata(t *testing.T) {
+	licenseID := model.NewId()
+	customerID := model.NewId()
+	telemetryID := model.NewId()
+	t.Run("happy path", func(t *testing.T) {
+		api := plugintest.NewAPI(t)
+		client := pluginapi.NewClient(api, &plugintest.Driver{})
+
+		dir := generateManifest(t)
+		api.On("GetBundlePath").Return(dir, nil)
+		api.On("GetLicense").Return(&model.License{
+			Id: licenseID,
+			Customer: &model.Customer{
+				Id: customerID,
+			},
+		})
+		api.On("GetTelemetryId").Return(telemetryID)
+
+		path := os.TempDir()
+		filePath, err := client.System.GeneratePacketMetadata(path, nil)
+		require.NoError(t, err)
+
+		f, err := os.Open(filePath)
+		require.NoError(t, err)
+		t.Cleanup(func() {
+			require.NoError(t, f.Close())
+		})
+
+		var md model.PacketMetadata
+		err = yaml.NewDecoder(f).Decode(&md)
+		require.NoError(t, err)
+
+		require.Equal(t, model.CurrentMetadataVersion, md.Version)
+		require.Equal(t, model.PluginPacketType, md.Type)
+		require.NotZero(t, md.GeneratedAt)
+		require.Equal(t, model.CurrentVersion, md.ServerVersion)
+		require.Equal(t, telemetryID, md.ServerID)
+		require.Equal(t, licenseID, md.LicenseID)
+		require.Equal(t, customerID, md.CustomerID)
+		require.Equal(t, "some.id", md.Extras["plugin_id"])
+		require.Equal(t, "1.0.0", md.Extras["plugin_version"])
+	})
+}
+
+func generateManifest(t *testing.T) string {
+	manifest := &model.Manifest{
+		Id:      "some.id",
+		Name:    "Some Name",
+		Version: "1.0.0",
+	}
+
+	dir, err := os.MkdirTemp("", "")
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		require.NoError(t, os.RemoveAll(dir))
+	})
+
+	tmpfn := filepath.Join(dir, "plugin.json")
+	f, err := os.Create(tmpfn)
+	require.NoError(t, err)
+	err = json.NewEncoder(f).Encode(manifest)
+	require.NoError(t, err)
+
+	return dir
+}