Merge pull request #6709 from TheThingsNetwork/feature/add-band-id-to…

…-frequencyplansdescription Add band ID to list frequency plans RPC
TheThingsNetwork · Nov 17, 2023 · 748b329 · 748b329
2 parents fc765de + babcb17
commit 748b329
Show file tree

Hide file tree

Showing 12 changed files with 429 additions and 297 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -2650,6 +2650,7 @@ PeerInfo
 | `base_id` | [`string`](#string) |  | The ID of the frequency that the current frequency plan is based on. |
 | `name` | [`string`](#string) |  |  |
 | `base_frequency` | [`uint32`](#uint32) |  | Base frequency in MHz for hardware support (433, 470, 868 or 915) |
+| `band_id` | [`string`](#string) |  |  |
 
 ### <a name="ttn.lorawan.v3.GetPhyVersionsRequest">Message `GetPhyVersionsRequest`</a>
 
@@ -2714,6 +2715,7 @@ PeerInfo
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `base_frequency` | [`uint32`](#uint32) |  | Optional base frequency in MHz for hardware support (433, 470, 868 or 915) |
+| `band_id` | [`string`](#string) |  | Optional Band ID to filter the results. |
 
 ### <a name="ttn.lorawan.v3.ListFrequencyPlansResponse">Message `ListFrequencyPlansResponse`</a>
 

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -6707,6 +6707,13 @@
             "required": false,
             "type": "integer",
             "format": "int64"
+          },
+          {
+            "name": "band_id",
+            "description": "Optional Band ID to filter the results.",
+            "in": "query",
+            "required": false,
+            "type": "string"
           }
         ],
         "tags": [
@@ -22869,6 +22876,9 @@
           "type": "integer",
           "format": "int64",
           "title": "Base frequency in MHz for hardware support (433, 470, 868 or 915)"
+        },
+        "band_id": {
+          "type": "string"
         }
       }
     },

diff --git a/api/ttn/lorawan/v3/configuration_services.proto b/api/ttn/lorawan/v3/configuration_services.proto
@@ -32,6 +32,8 @@ message ListFrequencyPlansRequest {
   };
   // Optional base frequency in MHz for hardware support (433, 470, 868 or 915)
   uint32 base_frequency = 1;
+  // Optional Band ID to filter the results.
+  string band_id = 2;
 }
 
 message FrequencyPlanDescription {
@@ -41,6 +43,7 @@ message FrequencyPlanDescription {
   string name = 3;
   // Base frequency in MHz for hardware support (433, 470, 868 or 915)
   uint32 base_frequency = 4;
+  string band_id = 5;
 }
 
 message ListFrequencyPlansResponse {

diff --git a/pkg/frequencyplans/frequencyplans.go b/pkg/frequencyplans/frequencyplans.go
@@ -519,6 +519,8 @@ type FrequencyPlanDescription struct {
 	ID string `yaml:"id"`
 	// BaseID is the ID of the base frequency plan that this frequency plan extends (optional).
 	BaseID string `yaml:"base-id,omitempty"`
+	// BandID is the ID of the band that this frequency plan uses.
+	BandID string `yaml:"band-id,omitempty"`
 	// Name is a human readable name of the frequency plan.
 	Name string `yaml:"name"`
 	// BaseFrequency is the base frequency of the frequency plan (i.e. 868, 915)

diff --git a/pkg/frequencyplans/rpc.go b/pkg/frequencyplans/rpc.go
@@ -39,8 +39,12 @@ func (s *RPCServer) ListFrequencyPlans(ctx context.Context, req *ttnpb.ListFrequ
 		if req.BaseFrequency != 0 && uint16(req.BaseFrequency) != desc.BaseFrequency {
 			continue
 		}
+		if req.BandId != "" && req.BandId != desc.BandID {
+			continue
+		}
 		res.FrequencyPlans = append(res.FrequencyPlans, &ttnpb.FrequencyPlanDescription{
 			Id:            desc.ID,
+			BandId:        desc.BandID,
 			BaseId:        desc.BaseID,
 			Name:          desc.Name,
 			BaseFrequency: uint32(desc.BaseFrequency),

diff --git a/pkg/frequencyplans/rpc_test.go b/pkg/frequencyplans/rpc_test.go
@@ -26,32 +26,64 @@ import (
 )
 
 func TestRPCServer(t *testing.T) {
+	t.Parallel()
 	a := assertions.New(t)
 
 	store := frequencyplans.NewStore(fetch.NewMemFetcher(map[string][]byte{
 		"frequency-plans.yml": []byte(`- id: A
+  band-id: EU_863_870
   description: Frequency Plan A
   base-frequency: 868
   file: A.yml
 - id: B
+  band-id: AS_923
   base-id: A
   description: Frequency Plan B
   file: B.yml
 - id: C
+  band-id: US_902_928
   description: Frequency Plan C
   base-frequency: 915
   file: C.yml`),
 	}))
 
 	server := frequencyplans.NewRPCServer(store)
 
-	all, err := server.ListFrequencyPlans(context.Background(), &ttnpb.ListFrequencyPlansRequest{})
+	expectedAll := []*ttnpb.FrequencyPlanDescription{
+		{
+			Id:            "A",
+			BandId:        "EU_863_870",
+			BaseFrequency: 868,
+		},
+		{
+			Id:            "B",
+			BaseId:        "A",
+			BaseFrequency: 868,
+			BandId:        "AS_923",
+		},
+		{
+			Id:            "C",
+			BaseFrequency: 915,
+			BandId:        "US_902_928",
+		},
+	}
+
+	actualAll, err := server.ListFrequencyPlans(context.Background(), &ttnpb.ListFrequencyPlansRequest{})
 	a.So(err, should.BeNil)
-	a.So(all.FrequencyPlans, should.HaveLength, 3)
+	a.So(actualAll.FrequencyPlans, should.HaveLength, 3)
+	a.So(actualAll.FrequencyPlans[0], should.Resemble, expectedAll[0])
 
 	base915, err := server.ListFrequencyPlans(context.Background(), &ttnpb.ListFrequencyPlansRequest{
 		BaseFrequency: 868,
 	})
 	a.So(err, should.BeNil)
 	a.So(base915.FrequencyPlans, should.HaveLength, 2)
+	a.So(base915.FrequencyPlans, should.Resemble, expectedAll[:2])
+
+	bandAS, err := server.ListFrequencyPlans(context.Background(), &ttnpb.ListFrequencyPlansRequest{
+		BandId: "AS_923",
+	})
+	a.So(err, should.BeNil)
+	a.So(bandAS.FrequencyPlans, should.HaveLength, 1)
+	a.So(bandAS.FrequencyPlans[0], should.Resemble, expectedAll[1])
 }