backend/devices: split bb02 and nova product names

We want to be able to show different banners to bb02 and bb02nova
users. This adds a backend check to differentiate the product name and
adds a new banner category for the nova.

Author: Beerosagos

backend/backend.go

@@ -792,7 +792,7 @@ func (backend *Backend) Register(theDevice device.Interface) error {
 		backend.Notify(observable.Event{
 			Subject: fmt.Sprintf(
 				"devices/%s/%s/%s",
-				theDevice.ProductName(),
+				theDevice.PlatformName(),
 				theDevice.Identifier(),
 				event.Subject),
 			Action: event.Action,
@@ -814,8 +814,10 @@ func (backend *Backend) Register(theDevice device.Interface) error {
 	switch theDevice.ProductName() {
 	case bitbox.ProductName:
 		backend.banners.Activate(banners.KeyBitBox01)
-	case bitbox02.ProductName:
+	case bitbox02.BitBox02ProductName:
 		backend.banners.Activate(banners.KeyBitBox02)
+	case bitbox02.BitBox02NovaProductName:
+		backend.banners.Activate(banners.KeyBitBox02Nova)
 	}
 	return nil
 }
@@ -834,8 +836,10 @@ func (backend *Backend) Deregister(deviceID string) {
 		switch device.ProductName() {
 		case bitbox.ProductName:
 			backend.banners.Deactivate(banners.KeyBitBox01)
-		case bitbox02.ProductName:
+		case bitbox02.BitBox02ProductName:
 			backend.banners.Deactivate(banners.KeyBitBox02)
+		case bitbox02.BitBox02NovaProductName:
+			backend.banners.Deactivate(banners.KeyBitBox02Nova)
 		}
 
 	}

backend/banners/banners.go

@@ -52,6 +52,8 @@ const (
 	KeyBitBox01 MessageKey = "bitbox01"
 	// KeyBitBox02 is the message key for the event when a BitBox02 gets connected.
 	KeyBitBox02 MessageKey = "bitbox02"
+	// KeyBitBox02Nova is the message key for the event when a BitBox02 Nova gets connected.
+	KeyBitBox02Nova MessageKey = "bitbox02nova"
 )
 
 // Message is one entry in the banners json.
@@ -77,8 +79,9 @@ type Banners struct {
 
 	url     string
 	banners struct {
-		BitBox01 *Message `json:"bitbox01"`
-		BitBox02 *Message `json:"bitbox02"`
+		BitBox01     *Message `json:"bitbox01"`
+		BitBox02     *Message `json:"bitbox02"`
+		BitBox02nova *Message `json:"bitbox02nova"`
 	}
 
 	active     map[MessageKey]struct{}
@@ -162,6 +165,8 @@ func (banners *Banners) GetMessage(key MessageKey) *Message {
 		return banners.banners.BitBox01
 	case KeyBitBox02:
 		return banners.banners.BitBox02
+	case KeyBitBox02Nova:
+		return banners.banners.BitBox02nova
 	default:
 		banners.log.Errorf("unrecognized key: %s", key)
 		return nil

backend/devices/bitbox/device.go

@@ -1074,6 +1074,11 @@ func (dbb *Device) ProductName() string {
 	return ProductName
 }
 
+// PlatformName implements device.Interface.
+func (dbb *Device) PlatformName() string {
+	return ProductName
+}
+
 // Identifier implements device.Interface.
 func (dbb *Device) Identifier() string {
 	return dbb.deviceID

backend/devices/bitbox02/device.go

@@ -28,16 +28,23 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// ProductName is the name of the BitBox02 product.
-// If you change this, be sure to check the frontend and other places which assume this is a
+// If you change these, be sure to check the frontend and other places which assume they are
 // constant.
-const ProductName = "bitbox02"
+const (
+	// BitBox02ProductName is the name of the BitBox02 product.
+	BitBox02ProductName = "bitbox02"
+	// BitBox02NovaProductName is the name of the BitBox02 Nova product.
+	BitBox02NovaProductName = "bitbox02nova"
+	// PlatformName is the name of the BitVox02 platform.
+	PlatformName = "bitbox02"
+)
 
 // Device implements device.Device.
 type Device struct {
 	firmware.Device
-	deviceID string
-	log      *logrus.Entry
+	deviceID    string
+	productName string
+	log         *logrus.Entry
 
 	observable.Implementation
 }
@@ -51,10 +58,16 @@ func NewDevice(
 	communication firmware.Communication,
 	opts ...firmware.DeviceOption,
 ) *Device {
+	productName := BitBox02ProductName
+	// BitBox02Plus is the internal code name for the BitBox Nova.
+	if product == bitbox02common.ProductBitBox02PlusBTCOnly ||
+		product == bitbox02common.ProductBitBox02PlusMulti {
+		productName = BitBox02NovaProductName
+	}
 	log := logging.Get().
 		WithGroup("device").
 		WithField("deviceID", deviceID).
-		WithField("productName", ProductName).
+		WithField("productName", productName).
 		WithField("product", product)
 
 	log.Info("Plugged in device")
@@ -67,8 +80,9 @@ func NewDevice(
 			logger{log},
 			opts...,
 		),
-		deviceID: deviceID,
-		log:      log,
+		deviceID:    deviceID,
+		productName: productName,
+		log:         log,
 	}
 	device.Device.SetOnEvent(func(ev firmware.Event, meta interface{}) {
 		switch ev {
@@ -116,7 +130,12 @@ func (device *Device) init() {
 
 // ProductName implements device.Device.
 func (device *Device) ProductName() string {
-	return ProductName
+	return device.productName
+}
+
+// PlatformName implements device.Device.
+func (device *Device) PlatformName() string {
+	return PlatformName
 }
 
 // Identifier implements device.Device.

backend/devices/bitbox02bootloader/device.go

@@ -119,6 +119,11 @@ func (device *Device) ProductName() string {
 	return ProductName
 }
 
+// PlatformName implements device.Device.
+func (device *Device) PlatformName() string {
+	return ProductName
+}
+
 // Identifier implements device.Device.
 func (device *Device) Identifier() string {
 	return device.deviceID

backend/devices/device/device.go

@@ -25,10 +25,15 @@ type Interface interface {
 	observable.Interface
 
 	Init(testing bool) error
-	// ProductName returns the product name of the device in lowercase/no spaces.
-	// It acts as an identifier for the device type, not for display.
-	// If you change a device's product name, be sure to check the frontend and other places which
+	// PlatformName returns the Platform name of the device in lowercase/no spaces.
+	// It acts as an identifier for the device type, not for the specific model (e.g.
+	// it return bitbox02 for both the bitbox02 and the bitbox02 nova).
+	// If you change a device's platform name, be sure to check the frontend and other places which
 	// assume this is a constant.
+	PlatformName() string
+
+	// ProductName is the actual model of the product in lowercase/no spaces
+	// (e.g. bitbox, bitbox02, bitbox02nova).
 	ProductName() string
 
 	// Identifier returns the hash of the type and the serial number.

backend/handlers/handlers.go

@@ -913,7 +913,7 @@ func (handlers *Handlers) postAccountsReinitialize(*http.Request) interface{} {
 func (handlers *Handlers) getDevicesRegistered(*http.Request) interface{} {
 	jsonDevices := map[string]string{}
 	for deviceID, device := range handlers.backend.DevicesRegistered() {
-		jsonDevices[deviceID] = device.ProductName()
+		jsonDevices[deviceID] = device.PlatformName()
 	}
 	return jsonDevices
 }

frontends/web/src/api/devices.ts

@@ -16,10 +16,10 @@
 
 import { apiGet } from '@/utils/request';
 
-export type TProductName = 'bitbox' | 'bitbox02' | 'bitbox02-bootloader';
+export type TPlatformName = 'bitbox' | 'bitbox02' | 'bitbox02-bootloader';
 
 export type TDevices = {
-    readonly [key in string]: TProductName;
+    readonly [key in string]: TPlatformName;
 };
 
 export const getDeviceList = (): Promise<TDevices> => {

frontends/web/src/app.tsx

@@ -188,8 +188,8 @@ export const App = () => {
             <Aopp />
             <KeystoreConnectPrompt />
             {
-              Object.entries(devices).map(([deviceID, productName]) => {
-                if (productName === 'bitbox02') {
+              Object.entries(devices).map(([deviceID, platformName]) => {
+                if (platformName === 'bitbox02') {
                   return (
                     <Fragment key={deviceID}>
                       <BitBox02Wizard

frontends/web/src/components/banners/banner.tsx

@@ -23,7 +23,7 @@ import { A } from '@/components/anchor/anchor';
 import style from './banner.module.css';
 
 type TBannerProps = {
-  msgKey: 'bitbox01' | 'bitbox02';
+  msgKey: 'bitbox01' | 'bitbox02' | 'bitbox02nova';
 }
 
 export const Banner = ({ msgKey }: TBannerProps) => {