Add support for recording key to foxglove CLI

Adds support for upload and export with recording key.

foxglove/cmd/export.go

@@ -820,6 +820,7 @@ func executeExport(
 
 func createStreamRequest(
 	recordingID string,
+	key string,
 	importID string,
 	deviceID string,
 	deviceName string,
@@ -849,6 +850,7 @@ func createStreamRequest(
 
 	request := &console.StreamRequest{
 		RecordingID:  recordingID,
+		Key:          key,
 		ImportID:     importID,
 		DeviceName:   deviceName,
 		DeviceID:     deviceID,
@@ -866,6 +868,7 @@ func createStreamRequest(
 
 func newExportCommand(params *baseParams) (*cobra.Command, error) {
 	var recordingID string
+	var key string
 	var importID string
 	var deviceID string
 	var deviceName string
@@ -893,6 +896,7 @@ func newExportCommand(params *baseParams) (*cobra.Command, error) {
 			}
 			request, err := createStreamRequest(
 				recordingID,
+				key,
 				importID,
 				deviceID,
 				deviceName,
@@ -950,6 +954,7 @@ func newExportCommand(params *baseParams) (*cobra.Command, error) {
 	exportCmd.PersistentFlags().StringVarP(&deviceName, "device-name", "", "", "device name")
 	exportCmd.PersistentFlags().StringVarP(&outputFile, "output-file", "o", "", "output file")
 	exportCmd.PersistentFlags().StringVarP(&recordingID, "recording-id", "", "", "recording ID")
+	exportCmd.PersistentFlags().StringVarP(&key, "key", "", "", "recording key")
 	exportCmd.PersistentFlags().StringVarP(&importID, "import-id", "", "", "import ID")
 	exportCmd.PersistentFlags().StringVarP(&start, "start", "", "", "start time (ISO8601 timestamp)")
 	exportCmd.PersistentFlags().StringVarP(&end, "end", "", "", "end time (ISO8601 timestamp")

foxglove/cmd/export_test.go

@@ -193,6 +193,7 @@ func TestDoExport(t *testing.T) {
 			clientID,
 			deviceID,
 			"",
+			"",
 			"../testdata/gps.mcap",
 			token,
 			"user-agent",
@@ -320,6 +321,7 @@ func TestExportCommand(t *testing.T) {
 			clientID,
 			deviceID,
 			"",
+			"",
 			"../testdata/gps.bag",
 			token,
 			"user-agent",
@@ -364,6 +366,7 @@ func TestExportCommand(t *testing.T) {
 			clientID,
 			deviceID,
 			"",
+			"",
 			"../testdata/gps.mcap",
 			token,
 			"user-agent",

foxglove/cmd/import.go

@@ -10,7 +10,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-func executeImport(baseURL, clientID, deviceID, deviceName, filename, token, userAgent string) error {
+func executeImport(baseURL, clientID, deviceID, deviceName, key, filename, token, userAgent string) error {
 	ctx := context.Background()
 	f, err := os.Open(filename)
 	if err != nil {
@@ -22,7 +22,7 @@ func executeImport(baseURL, clientID, deviceID, deviceName, filename, token, use
 		return err
 	}
 	client := console.NewRemoteFoxgloveClient(baseURL, clientID, token, userAgent)
-	err = console.Import(ctx, client, deviceID, deviceName, filename)
+	err = console.Import(ctx, client, deviceID, deviceName, key, filename)
 	if err != nil {
 		return err
 	}
@@ -48,42 +48,42 @@ func newImportCommand(params *baseParams, commandName string) (*cobra.Command, e
 	var deviceID string
 	var deviceName string
 	var edgeRecordingID string
+	var key string
 	importCmd := &cobra.Command{
 		Use:   fmt.Sprintf("%s [FILE]", commandName),
 		Short: "Import a data file to Foxglove Data Platform",
 		Run: func(cmd *cobra.Command, args []string) {
-			if deviceName == "" && deviceID == "" && edgeRecordingID == "" {
-				dief("Must specify either --device-id, --device-name, or --edge-recording-id")
-			}
-			if deviceName != "" || deviceID != "" {
-				if len(args) == 0 {
-					dief("Filename not specified")
-				}
-				filename := args[0]
-				err := executeImport(
-					params.baseURL,
-					*params.clientID,
-					deviceID,
-					deviceName,
-					filename,
-					viper.GetString("bearer_token"),
-					params.userAgent,
-				)
-				if err != nil {
-					dief("Failed to import %s: %s", filename, err)
-				}
-			}
 			if edgeRecordingID != "" {
 				err := importFromEdge(params.baseURL, *params.clientID, params.token, params.userAgent, edgeRecordingID)
 				if err != nil {
 					dief("Failed to import edge recording: %s", err)
 				}
+				return
+			}
+
+			if len(args) == 0 {
+				dief("Filename not specified")
+			}
+			filename := args[0]
+			err := executeImport(
+				params.baseURL,
+				*params.clientID,
+				deviceID,
+				deviceName,
+				key,
+				filename,
+				viper.GetString("bearer_token"),
+				params.userAgent,
+			)
+			if err != nil {
+				dief("Failed to import %s: %s", filename, err)
 			}
 		},
 	}
 	importCmd.InheritedFlags()
 	importCmd.PersistentFlags().StringVarP(&deviceID, "device-id", "", "", "device ID")
 	importCmd.PersistentFlags().StringVarP(&deviceName, "device-name", "", "", "device name")
+	importCmd.PersistentFlags().StringVarP(&key, "key", "", "", "recording key")
 	importCmd.PersistentFlags().StringVarP(&edgeRecordingID, "edge-recording-id", "", "", "edge recording ID")
 	AddDeviceAutocompletion(importCmd, params)
 	return importCmd, nil

foxglove/cmd/import_test.go

@@ -21,6 +21,7 @@ func TestImportCommand(t *testing.T) {
 			"abc",
 			"test-device",
 			"",
+			"",
 			"../testdata/gps.bag",
 			"",
 			"user-agent",
@@ -40,6 +41,7 @@ func TestImportCommand(t *testing.T) {
 			"abc",
 			"unregistered-device",
 			"",
+			"",
 			"../testdata/gps.bag",
 			token,
 			"user-agent",

foxglove/console/api.go

@@ -25,6 +25,7 @@ type TokenResponse struct {
 type UploadRequest struct {
 	Filename   string `json:"filename"`
 	DeviceID   string `json:"device.id,omitempty"`
+	Key        string `json:"key,omitempty"`
 	DeviceName string `json:"device.name,omitempty"`
 }
 
@@ -34,6 +35,7 @@ type UploadResponse struct {
 
 type StreamRequest struct {
 	RecordingID  string     `json:"recordingId,omitempty"`
+	Key          string     `json:"key,omitempty"`
 	ImportID     string     `json:"importId,omitempty"`
 	DeviceID     string     `json:"device.id,omitempty"`
 	DeviceName   string     `json:"device.name,omitempty"`
@@ -44,8 +46,8 @@ type StreamRequest struct {
 }
 
 func (req *StreamRequest) Validate() error {
-	if req.RecordingID == "" && req.ImportID == "" && req.DeviceID == "" && req.DeviceName == "" {
-		return fmt.Errorf("either recording-id, import-id, or all three of device-id/device-name, start, and end are required")
+	if req.RecordingID == "" && req.ImportID == "" && req.DeviceID == "" && req.DeviceName == "" && req.Key == "" {
+		return fmt.Errorf("either recording-id/key, import-id, or all three of device-id/device-name, start, and end are required")
 	}
 	if req.DeviceID != "" && req.DeviceName != "" && req.ImportID == "" && (req.Start == nil || req.End == nil) {
 		return fmt.Errorf("start/end are required if device is supplied")
@@ -192,6 +194,7 @@ type RecordingsResponse struct {
 	EdgeSite     SiteSummary      `json:"edgeSite"`
 	Device       DeviceSummary    `json:"device"`
 	Metadata     []MetadataRecord `json:"metadata"`
+	Key          string           `json:"key"`
 }
 
 func (r RecordingsResponse) Headers() []string {
@@ -212,6 +215,7 @@ func (r RecordingsResponse) Headers() []string {
 		"Device ID",
 		"Device Name",
 		"Metadata",
+		"Key",
 	}
 }
 
@@ -234,6 +238,7 @@ func (r RecordingsResponse) Fields() []string {
 		r.Device.ID,
 		r.Device.Name,
 		string(metadata),
+		r.Key,
 	}
 }
 

foxglove/console/lib.go

@@ -63,6 +63,7 @@ func Import(
 	client *FoxgloveClient,
 	deviceID string,
 	deviceName string,
+	key string,
 	filename string,
 ) error {
 	f, err := os.Open(filename)
@@ -80,6 +81,7 @@ func Import(
 	reader := progressbar.NewReader(f, bar)
 	err = client.Upload(&reader, UploadRequest{
 		Filename:   name,
+		Key:        key,
 		DeviceID:   deviceID,
 		DeviceName: deviceName,
 	})

foxglove/console/lib_test.go

@@ -23,7 +23,7 @@ func TestImport(t *testing.T) {
 		sv, err := NewMockServer(ctx)
 		assert.Nil(t, err)
 		client := NewRemoteFoxgloveClient(sv.BaseURL(), "abc", "", "test-app")
-		err = Import(ctx, client, "test-device", "", "../testdata/gps.bag")
+		err = Import(ctx, client, "test-device", "", "", "../testdata/gps.bag")
 		assert.ErrorIs(t, err, ErrForbidden)
 	})
 	t.Run("successfully imports data after auth", func(t *testing.T) {
@@ -34,7 +34,7 @@ func TestImport(t *testing.T) {
 		token, err := login(ctx, sv)
 		assert.Nil(t, err)
 		client := NewRemoteFoxgloveClient(sv.BaseURL(), "abc", token, "test-app")
-		err = Import(ctx, client, "test-device", "", "../testdata/gps.bag")
+		err = Import(ctx, client, "test-device", "", "", "../testdata/gps.bag")
 		assert.Nil(t, err)
 		assert.Equal(t, 5324051, len(sv.Uploads["device_id=test-device/gps.bag"]))
 	})
@@ -46,7 +46,7 @@ func TestImport(t *testing.T) {
 		token, err := login(ctx, sv)
 		assert.Nil(t, err)
 		client := NewRemoteFoxgloveClient(sv.BaseURL(), "abc", token, "test-app")
-		err = Import(ctx, client, "", "my test device", "../testdata/gps.bag")
+		err = Import(ctx, client, "", "my test device", "", "../testdata/gps.bag")
 		assert.Nil(t, err)
 		assert.Equal(t, 5324051, len(sv.Uploads["device_id=test-device/gps.bag"]))
 	})
@@ -108,7 +108,7 @@ func TestExport(t *testing.T) {
 		assert.Nil(t, err)
 		client := NewRemoteFoxgloveClient(sv.BaseURL(), "abc", token, "test-app")
 		buf := &bytes.Buffer{}
-		err = Import(ctx, client, "test-device", "", "../testdata/gps.bag")
+		err = Import(ctx, client, "test-device", "", "", "../testdata/gps.bag")
 		assert.Nil(t, err)
 		start, err := time.Parse(time.RFC3339, "2020-01-01T00:00:00Z")
 		assert.Nil(t, err)