feat: add API call to update device name

Author: devgianlu

api-spec.yml

@@ -109,6 +109,22 @@ paths:
                     type: boolean
                   track:
                     $ref: '#/components/schemas/track'
+  /set_device_name:
+    post:
+      description: Set the player device name
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [ name ]
+              properties:
+                name:
+                  description: The new device name
+                  type: string
+      responses:
+        200:
+          description: Successful response
   /player/play:
     post:
       description: Starts playing new content

daemon/api_server.go

@@ -74,6 +74,7 @@ const (
 	ApiRequestTypeSetShufflingContext ApiRequestType = "shuffling_context"
 	ApiRequestTypeAddToQueue          ApiRequestType = "add_to_queue"
 	ApiRequestTypeToken               ApiRequestType = "token"
+	ApiRequestSetDeviceName           ApiRequestType = "set_device_name"
 )
 
 type ApiEventType string
@@ -648,6 +649,27 @@ func (s *ConcreteApiServer) serve() {
 
 		s.handleRequest(ApiRequest{Type: ApiRequestTypeToken}, w)
 	})
+	m.HandleFunc("/set_device_name", func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != "POST" {
+			w.WriteHeader(http.StatusMethodNotAllowed)
+			return
+		}
+
+		var data struct {
+			Name string `json:"name"`
+		}
+		if err := jsonDecode(r, &data); err != nil {
+			w.WriteHeader(http.StatusBadRequest)
+			return
+		}
+
+		if len(data.Name) == 0 {
+			w.WriteHeader(http.StatusBadRequest)
+			return
+		}
+
+		s.handleRequest(ApiRequest{Type: ApiRequestSetDeviceName, Data: data.Name}, w)
+	})
 	m.HandleFunc("/events", func(w http.ResponseWriter, r *http.Request) {
 		opts := &websocket.AcceptOptions{}
 		if len(s.allowOrigin) > 0 {

daemon/app.go

@@ -30,6 +30,7 @@ type App struct {
 	client *http.Client
 
 	resolver *apresolve.ApResolver
+	zeroconf *zeroconf.Zeroconf
 
 	deviceId    string
 	deviceType  devicespb.DeviceType
@@ -129,6 +130,18 @@ func New(opts *Options) (*App, error) {
 	return app, nil
 }
 
+func (app *App) SetDeviceName(name string) {
+	if app.cfg.DeviceName == name {
+		return
+	}
+
+	app.cfg.DeviceName = name
+
+	if app.zeroconf != nil {
+		app.zeroconf.SetDeviceName(name)
+	}
+}
+
 // Run starts the daemon. It blocks until ctx is cancelled or an unrecoverable
 // error occurs. The credential type configured in cfg.Credentials.Type
 // determines which login flow is used.
@@ -306,7 +319,7 @@ func (app *App) withAppPlayer(ctx context.Context, appPlayerFunc func(context.Co
 		return fmt.Errorf("failed getting endpoints from resolver: %w", err)
 	}
 
-	z, err := zeroconf.NewZeroconf(app.log, app.cfg.ZeroconfPort, app.cfg.DeviceName, app.deviceId, app.deviceType, app.cfg.ZeroconfInterfacesToAdvertise, app.cfg.ZeroconfBackend == "avahi")
+	app.zeroconf, err = zeroconf.NewZeroconf(app.log, app.cfg.ZeroconfPort, app.cfg.DeviceName, app.deviceId, app.deviceType, app.cfg.ZeroconfInterfacesToAdvertise, app.cfg.ZeroconfBackend == "avahi")
 	if err != nil {
 		return fmt.Errorf("failed initializing zeroconf: %w", err)
 	}
@@ -325,7 +338,7 @@ func (app *App) withAppPlayer(ctx context.Context, appPlayerFunc func(context.Co
 		apiCh = make(chan ApiRequest)
 		go currentPlayer.Run(ctx, apiCh, app.mpris.Receive())
 
-		z.SetCurrentUser(currentPlayer.sess.Username())
+		app.zeroconf.SetCurrentUser(currentPlayer.sess.Username())
 	}
 
 	go func() {
@@ -363,16 +376,16 @@ func (app *App) withAppPlayer(ctx context.Context, appPlayerFunc func(context.Co
 				if err != nil {
 					app.log.WithError(err).Errorf("failed restoring session after logout")
 
-					z.SetCurrentUser("")
+					app.zeroconf.SetCurrentUser("")
 				} else if newAppPlayer == nil {
-					z.SetCurrentUser("")
+					app.zeroconf.SetCurrentUser("")
 				} else {
 					apiCh = make(chan ApiRequest)
 					currentPlayer = newAppPlayer
 
 					go newAppPlayer.Run(ctx, apiCh, app.mpris.Receive())
 
-					z.SetCurrentUser(newAppPlayer.sess.Username())
+					app.zeroconf.SetCurrentUser(newAppPlayer.sess.Username())
 
 					app.log.WithField("username", librespot.ObfuscateUsername(currentPlayer.sess.Username())).
 						Debugf("restored session after logout")
@@ -381,7 +394,7 @@ func (app *App) withAppPlayer(ctx context.Context, appPlayerFunc func(context.Co
 		}
 	}()
 
-	return z.Serve(func(req zeroconf.NewUserRequest) bool {
+	return app.zeroconf.Serve(func(req zeroconf.NewUserRequest) bool {
 		if currentPlayer != nil {
 			currentPlayer.Close()
 			currentPlayer = nil

daemon/player.go

@@ -593,11 +593,21 @@ func (p *AppPlayer) handleApiRequest(ctx context.Context, req ApiRequest) (any,
 		return &ApiResponseToken{
 			Token: accessToken,
 		}, nil
+	case ApiRequestSetDeviceName:
+		p.setDeviceName(ctx, req.Data.(string))
+		return nil, nil
 	default:
 		return nil, fmt.Errorf("unknown request type: %s", req.Type)
 	}
 }
 
+func (p *AppPlayer) setDeviceName(ctx context.Context, name string) {
+	p.app.SetDeviceName(name)
+
+	p.state.device.Name = name
+	p.updateState(ctx)
+}
+
 func pointer[T any](d T) *T {
 	return &d
 }