Merge pull request #6381 from TheThingsNetwork/feature/remove-body-un…

…claim

Remove body from Unclaim request

api/api.md

@@ -2885,7 +2885,7 @@ and allows clients to claim end devices.
 | Method Name | Method | Pattern | Body |
 | ----------- | ------ | ------- | ---- |
 | `Claim` | `POST` | `/api/v3/edcs/claim` | `*` |
-| `Unclaim` | `DELETE` | `/api/v3/edcs/claim/{application_ids.application_id}/devices/{device_id}` | `*` |
+| `Unclaim` | `DELETE` | `/api/v3/edcs/claim/{application_ids.application_id}/devices/{device_id}` |  |
 | `GetInfoByJoinEUI` | `POST` | `/api/v3/edcs/claim/info` | `*` |
 | `GetClaimStatus` | `GET` | `/api/v3/edcs/claim/{application_ids.application_id}/devices/{device_id}` |  |
 | `AuthorizeApplication` | `POST` | `/api/v3/edcs/applications/{application_ids.application_id}/authorize` | `*` |

api/api.swagger.json

@@ -8117,35 +8117,28 @@
             "type": "string"
           },
           {
-            "name": "body",
-            "in": "body",
-            "required": true,
-            "schema": {
-              "type": "object",
-              "properties": {
-                "application_ids": {
-                  "type": "object"
-                },
-                "dev_eui": {
-                  "type": "string",
-                  "format": "string",
-                  "example": "70B3D57ED000ABCD",
-                  "description": "The LoRaWAN DevEUI."
-                },
-                "join_eui": {
-                  "type": "string",
-                  "format": "string",
-                  "example": "70B3D57ED000ABCD",
-                  "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)."
-                },
-                "dev_addr": {
-                  "type": "string",
-                  "format": "string",
-                  "example": "2600ABCD",
-                  "description": "The LoRaWAN DevAddr."
-                }
-              }
-            }
+            "name": "dev_eui",
+            "description": "The LoRaWAN DevEUI.",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "format": "string"
+          },
+          {
+            "name": "join_eui",
+            "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "format": "string"
+          },
+          {
+            "name": "dev_addr",
+            "description": "The LoRaWAN DevAddr.",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "format": "string"
           }
         ],
         "tags": [

api/deviceclaimingserver.proto

@@ -162,7 +162,6 @@ service EndDeviceClaimingServer {
   rpc Unclaim(EndDeviceIdentifiers) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/edcs/claim/{application_ids.application_id}/devices/{device_id}",
-      body: "*"
     };
   };
 

cypress/e2e/console/devices/unclaim.spec.js

@@ -90,9 +90,11 @@ describe('Device un-claiming', () => {
       .its('request.url')
       .then(url => {
         const params = new URLSearchParams(new URL(url).search)
+        const hexToBase64 = hex =>
+          btoa(String.fromCharCode(...hex.match(/.{1,2}/g).map(byte => parseInt(byte, 16))))
 
-        expect(params.get('dev_eui')).to.equal(ns.end_device.ids.dev_eui)
-        expect(params.get('join_eui')).to.equal('0000000000000000')
+        expect(params.get('dev_eui')).to.equal(hexToBase64(ns.end_device.ids.dev_eui))
+        expect(params.get('join_eui')).to.equal(hexToBase64('0000000000000000'))
       })
 
     cy.findByTestId('error-notification').should('not.exist')

pkg/webui/console/views/device/index.js

@@ -34,6 +34,7 @@ import { getNsFrequencyPlans } from '@console/store/actions/configuration'
 import { getInfoByJoinEUI } from '@console/store/actions/claim'
 
 import { selectSelectedApplicationId } from '@console/store/selectors/applications'
+import { selectSelectedDevice } from '@console/store/selectors/devices'
 
 import Device from './device'
 
@@ -105,9 +106,13 @@ const DeviceContainer = props => {
     [appId, devId, dispatch],
   )
 
+  // Check whether the device still exists after it has been possibly deleted.
+  const device = useSelector(selectSelectedDevice)
+  const hasDevice = Boolean(device)
+
   return (
     <RequireRequest requestAction={loadDeviceData}>
-      <Device {...props} />
+      {hasDevice && <Device {...props} />}
     </RequireRequest>
   )
 }

sdk/js/generated/api-definition.json

@@ -2281,7 +2281,6 @@
         {
           "method": "delete",
           "pattern": "/edcs/claim/{application_ids.application_id}/devices/{device_id}",
-          "body": "*",
           "parameters": [
             "application_ids.application_id",
             "device_id"

sdk/js/generated/api.json

@@ -11131,8 +11131,7 @@
                   "rules": [
                     {
                       "method": "DELETE",
-                      "pattern": "/edcs/claim/{application_ids.application_id}/devices/{device_id}",
-                      "body": "*"
+                      "pattern": "/edcs/claim/{application_ids.application_id}/devices/{device_id}"
                     }
                   ]
                 }

sdk/js/src/service/claim.js

@@ -14,6 +14,7 @@
 
 import autoBind from 'auto-bind'
 
+import Bytes from '../util/bytes'
 import Marshaler from '../util/marshaler'
 
 class DeviceClaim {
@@ -62,8 +63,8 @@ class DeviceClaim {
     }
 
     const response = await this._api.EndDeviceClaimingServer.Unclaim(params, {
-      dev_eui: devEui,
-      join_eui: joinEui,
+      dev_eui: Bytes.hexToBase64(devEui),
+      join_eui: Bytes.hexToBase64(joinEui),
     })
 
     return Marshaler.payloadSingleResponse(response)

sdk/js/src/util/bytes.js

@@ -0,0 +1,51 @@
+// Copyright © 2023 The Things Network Foundation, The Things Industries B.V.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+class Bytes {
+  /**
+   * Converts hex encoded string to base64.
+   *
+   * @param {string} str - Hex encoded string.
+   * @returns {string} - `str` base64 encoded.
+   */
+  static hexToBase64(str) {
+    return btoa(
+      String.fromCharCode.apply(
+        null,
+        str
+          .replace(/\r|\n/g, '')
+          .replace(/([\da-fA-F]{2}) ?/g, '0x$1 ')
+          .replace(/ +$/, '')
+          .split(' '),
+      ),
+    )
+  }
+
+  static base64ToHex(str) {
+    /**
+     * Converts base64 encoded string to hex.
+     *
+     * @param {string} str - Base64 encoded string.
+     * @returns {string} - `str` hex encoded.
+     */
+    return Array.from(atob(str.replace(/[ \r\n]+$/, '')))
+      .map(char => {
+        const tmp = char.charCodeAt(0).toString(16)
+        return tmp.length > 1 ? tmp : `0${tmp}`
+      })
+      .join('')
+  }
+}
+
+export default Bytes

tools/mage/proto.go

@@ -152,7 +152,7 @@ func (p Proto) fieldMask(context.Context) error {
 func (p Proto) grpcGateway(context.Context) error {
 	return withProtoc(grpcGatewayProtoImage, func(pCtx *protocContext, protoc func(...string) error) error {
 		if err := protoc(
-			fmt.Sprintf("--grpc-gateway_out=allow_delete_body=true:%s", protocOut),
+			fmt.Sprintf("--grpc-gateway_out=:%s", protocOut),
 			fmt.Sprintf("%s/api/*.proto", pCtx.WorkingDirectory),
 		); err != nil {
 			return fmt.Errorf("failed to generate protos: %w", err)
@@ -204,7 +204,6 @@ func (p Proto) Swagger(context.Context) error {
 	}
 	return withProtoc(openAPIv2ProtoImage, func(pCtx *protocContext, protoc func(...string) error) error {
 		if err := protoc(
-			"--openapiv2_opt allow_delete_body=true",
 			"--openapiv2_opt=json_names_for_fields=false",
 			fmt.Sprintf("--openapiv2_out=allow_merge,merge_file_name=api:%s/api", pCtx.WorkingDirectory),
 			fmt.Sprintf("%s/api/*.proto", pCtx.WorkingDirectory),