qrg: Update parse gateway qr response

TheThingsNetwork · Sep 10, 2024 · d780ef2 · d780ef2
1 parent dcd2455
commit d780ef2
Show file tree

Hide file tree

Showing 15 changed files with 309 additions and 276 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -10563,8 +10563,15 @@ The Pba service allows clients to manage peering through Packet Broker.
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| `format_id` | [`string`](#string) |  | Identifier of the format used to successfully parse the QR code data. |
-| `claim_gateway_request` | [`ClaimGatewayRequest`](#ttn.lorawan.v3.ClaimGatewayRequest) |  |  |
+| `format_id` | [`string`](#string) |  | Identifier of the format used to parse the QR code data. |
+| `gateway_eui` | [`bytes`](#bytes) |  |  |
+| `owner_token` | [`string`](#string) |  |  |
+
+#### Field Rules
+
+| Field | Validations |
+| ----- | ----------- |
+| `gateway_eui` | <p>`bytes.len`: `8`</p> |
 
 ### <a name="ttn.lorawan.v3.QRCodeFormat">Message `QRCodeFormat`</a>
 

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -28058,10 +28058,15 @@
       "properties": {
         "format_id": {
           "type": "string",
-          "description": "Identifier of the format used to successfully parse the QR code data."
+          "description": "Identifier of the format used to parse the QR code data."
         },
-        "claim_gateway_request": {
-          "$ref": "#/definitions/v3ClaimGatewayRequest"
+        "gateway_eui": {
+          "type": "string",
+          "format": "string",
+          "example": "70B3D57ED000ABCD"
+        },
+        "owner_token": {
+          "type": "string"
         }
       }
     },

diff --git a/api/ttn/lorawan/v3/qrcodegenerator.proto b/api/ttn/lorawan/v3/qrcodegenerator.proto
@@ -20,7 +20,7 @@ import "google/api/annotations.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 import "protoc-gen-openapiv2/options/annotations.proto";
-import "ttn/lorawan/v3/deviceclaimingserver.proto";
+import "thethings/json/annotations.proto";
 import "ttn/lorawan/v3/end_device.proto";
 import "ttn/lorawan/v3/picture.proto";
 import "validate/validate.proto";
@@ -147,9 +147,24 @@ message ParseGatewayQRCodeRequest {
 }
 
 message ParseGatewayQRCodeResponse {
-  // Identifier of the format used to successfully parse the QR code data.
+  // Identifier of the format used to parse the QR code data.
   string format_id = 1;
-  ClaimGatewayRequest claim_gateway_request = 2;
+  bytes gateway_eui = 2 [
+    (validate.rules).bytes = {
+      len: 8,
+      ignore_empty: true
+    },
+    (thethings.json.field) = {
+      marshaler_func: "go.thethings.network/lorawan-stack/v3/pkg/types.MarshalHEXBytes",
+      unmarshaler_func: "go.thethings.network/lorawan-stack/v3/pkg/types.Unmarshal8Bytes"
+    },
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+      type: STRING,
+      format: "string",
+      example: "\"70B3D57ED000ABCD\""
+    }
+  ];
+  string owner_token = 3;
 }
 
 // The GatewayQRCodeGenerator service provides functionality to generate and parse QR codes for gateways.

diff --git a/pkg/qrcodegenerator/grpc_gateways.go b/pkg/qrcodegenerator/grpc_gateways.go
@@ -59,14 +59,8 @@ func (s *gatewayQRCodeGeneratorServer) Parse(
 	}
 
 	return &ttnpb.ParseGatewayQRCodeResponse{
-		FormatId: data.FormatID(),
-		ClaimGatewayRequest: &ttnpb.ClaimGatewayRequest{
-			SourceGateway: &ttnpb.ClaimGatewayRequest_AuthenticatedIdentifiers_{
-				AuthenticatedIdentifiers: &ttnpb.ClaimGatewayRequest_AuthenticatedIdentifiers{
-					GatewayEui:         data.GatewayEUI().Bytes(),
-					AuthenticationCode: []byte(data.OwnerToken()),
-				},
-			},
-		},
+		FormatId:   data.FormatID(),
+		GatewayEui: data.GatewayEUI().Bytes(),
+		OwnerToken: data.OwnerToken(),
 	}, nil
 }
diff --git a/pkg/qrcodegenerator/grpc_gateways_test.go b/pkg/qrcodegenerator/grpc_gateways_test.go
@@ -117,6 +117,8 @@ func TestGatewayQRCodeParsing(t *testing.T) {
 					return false
 				}
 				a.So(resp.FormatId, should.Equal, ttigpro1.ID())
+				a.So(resp.GatewayEui, should.Resemble, []uint8{0xec, 0x65, 0x6e, 0xff, 0xfe, 0x00, 0x01, 0x28})
+				a.So(resp.OwnerToken, should.Equal, "abcdef123456")
 
 				return true
 			},

diff --git a/pkg/qrcodegenerator/qrcode/gateways/gateways.go b/pkg/qrcodegenerator/qrcode/gateways/gateways.go
@@ -16,7 +16,6 @@
 package gateways
 
 import (
-	"context"
 	"encoding"
 
 	"go.thethings.network/lorawan-stack/v3/pkg/errors"
@@ -56,13 +55,13 @@ type Server struct {
 }
 
 // New returns a new Server.
-func New(_ context.Context) *Server {
+func New() *Server {
 	s := &Server{
 		// Newer formats should be added to this slice first to
 		// preferentially match with those first.
 		gatewayFormats: []gatewayFormat{
 			{
-				id:     formatIDTTIGPRO1,
+				id:     ttigpro1FormatID,
 				format: new(TTIGPRO1Format),
 			},
 		},

diff --git a/pkg/qrcodegenerator/qrcode/gateways/gateways_test.go b/pkg/qrcodegenerator/qrcode/gateways/gateways_test.go
@@ -15,7 +15,6 @@
 package gateways_test
 
 import (
-	"context"
 	"strconv"
 	"testing"
 
@@ -48,7 +47,7 @@ func TestParseGatewaysAuthenticationCodes(t *testing.T) {
 			t.Parallel()
 			a := assertions.New(t)
 
-			qrCode := gateways.New(context.Background())
+			qrCode := gateways.New()
 
 			d, err := qrCode.Parse(tc.FormatID, tc.Data)
 			data := test.Must(d, err)

diff --git a/pkg/qrcodegenerator/qrcode/gateways/ttigpro1.go b/pkg/qrcodegenerator/qrcode/gateways/ttigpro1.go
@@ -22,22 +22,19 @@ import (
 )
 
 const (
-	formatIDTTIGPRO1 = "ttigpro1"
-
-	euiLength        = 16
-	ownerTokenLength = 12
+	ttigpro1FormatID = "ttigpro1"
 )
 
+// ttigpro1Regex is the regular expression to match the TTIGPRO1 format.
+// The format is as follows: https://ttig.pro/c/{16 lowercase base16 chars}/{12 base62 chars}.
+var ttigpro1Regex = regexp.MustCompile(`^https://ttig\.pro/c/([a-f0-9]{16})/([a-z0-9]{12})$`)
+
 // TTIGPRO1 is a format for gateway identification QR codes.
 type ttigpro1 struct {
 	gatewayEUI types.EUI64
 	ownerToken string
 }
 
-// ttigpro1Regex is the regular expression to match the TTIGPRO1 format.
-// The format is as follows: https://ttig.pro/c/{16 lowercase base16 chars}/{12 base62 chars}.
-var ttigpro1Regex = regexp.MustCompile(`^https://ttig\.pro/c/([a-f0-9]{16})/([a-z0-9]{12})$`)
-
 // UnmarshalText implements the TextUnmarshaler interface.
 func (m *ttigpro1) UnmarshalText(text []byte) error {
 	// Match the URL against the pattern
@@ -52,7 +49,7 @@ func (m *ttigpro1) UnmarshalText(text []byte) error {
 
 	m.ownerToken = matches[2]
 
-	if len(m.ownerToken) != ownerTokenLength {
+	if len(m.ownerToken) != 12 /* owner token length */ {
 		return errInvalidLength
 	}
 
@@ -61,7 +58,7 @@ func (m *ttigpro1) UnmarshalText(text []byte) error {
 
 // FormatID implements the Data interface.
 func (*ttigpro1) FormatID() string {
-	return formatIDTTIGPRO1
+	return ttigpro1FormatID
 }
 
 func (m *ttigpro1) GatewayEUI() types.EUI64 {
@@ -89,7 +86,7 @@ func (TTIGPRO1Format) Format() *ttnpb.QRCodeFormat {
 
 // ID is the identifier of the format as a string.
 func (TTIGPRO1Format) ID() string {
-	return formatIDTTIGPRO1
+	return ttigpro1FormatID
 }
 
 // New implements the Format interface.

diff --git a/pkg/qrcodegenerator/qrcodegenerator.go b/pkg/qrcodegenerator/qrcodegenerator.go
@@ -57,7 +57,7 @@ func New(c *component.Component, _ *Config, opts ...Option) (*QRCodeGenerator, e
 	qrg.grpc.gatewayQRCodeGenerator = &gatewayQRCodeGeneratorServer{QRG: qrg}
 
 	qrg.endDevices = enddevices.New(ctx)
-	qrg.gateways = gateways.New(ctx)
+	qrg.gateways = gateways.New()
 
 	c.RegisterGRPC(qrg)