console: Extract claim gateway error function in utils

Author: PavelJankoski

pkg/webui/console/containers/gateway-onboarding-form/index.js

@@ -15,7 +15,6 @@
 import React, { useCallback, useMemo, useState } from 'react'
 import { useSelector, useDispatch } from 'react-redux'
 import { merge } from 'lodash'
-import { defineMessages } from 'react-intl'
 
 import Form from '@ttn-lw/components/form'
 
@@ -24,7 +23,7 @@ import GatewayApiKeysModal from '@console/components/gateway-api-keys-modal'
 import { composeDataUri, downloadDataUriAsFile } from '@ttn-lw/lib/data-uri'
 import PropTypes from '@ttn-lw/lib/prop-types'
 import attachPromise from '@ttn-lw/lib/store/actions/attach-promise'
-import { getBackendErrorRootCause } from '@ttn-lw/lib/errors/utils'
+import { getClaimGatewayErrorMessage } from '@ttn-lw/lib/errors/utils'
 
 import { createGateway, claimGateway, updateGateway } from '@console/store/actions/gateways'
 import { createGatewayApiKey } from '@console/store/actions/api-keys'
@@ -37,14 +36,6 @@ import { initialValues as registerInitialValues } from './gateway-provisioning-f
 import { initialValues as claimingInitialValues } from './gateway-provisioning-form/gateway-claim-form-section'
 import GatewayQRScanSection from './qr-scan-section'
 
-const m = defineMessages({
-  claimGatewayNotFound:
-    "`NotFound`: the gateway doesn't exist. This is most likely a typo in the EUI. An edge case is that The Things Stack is configured for the staging environment.",
-  claimGatewayFailedPrecondition:
-    "`FailedPrecondition`: the owner token is correct, but either there's no gateway subscription attached and active, or it is a correct gateway activation code and it has expired.",
-  claimGatewayPermissionDenied: '`PermissionDenied`: the owner token is invalid.',
-})
-
 const GatewayOnboardingForm = props => {
   const { onSuccess } = props
   const userId = useSelector(selectUserId)
@@ -151,17 +142,9 @@ const GatewayOnboardingForm = props => {
 
         onSuccess(cleanValues.target_gateway_id, inputMethod === 'managed')
       } catch (error) {
-        const rootCause = getBackendErrorRootCause(error)
-        const errorCode = rootCause?.code ?? -1
-
-        const errorMessages = {
-          5: m.claimGatewayNotFound, // NOT_FOUND
-          9: m.claimGatewayFailedPrecondition, // FAILED_PRECONDITION
-          7: m.claimGatewayPermissionDenied, // PERMISSION_DENIED
-        }
-
-        if (errorMessages[errorCode]) {
-          setError(errorMessages[errorCode])
+        const message = getClaimGatewayErrorMessage(error)
+        if (message) {
+          setError(message)
         } else {
           // Fallback for unexpected/unhandled errors
           setError(error)

pkg/webui/lib/errors/utils.js

@@ -14,6 +14,7 @@
 
 import * as Sentry from '@sentry/react'
 import { isPlainObject, isObject } from 'lodash'
+import { defineMessages } from 'react-intl'
 
 import { error as errorLog, warn } from '@ttn-lw/lib/log'
 import interpolate from '@ttn-lw/lib/interpolate'
@@ -588,3 +589,39 @@ export const ingestError = (error, extras = {}, tags = {}) => {
     })
   }
 }
+
+/**
+ * Maps claim-related backend errors to appropriate user messages.
+ *
+ * @param {object} error - The error object.
+ * @returns {object|undefined} - The corresponding error message, or undefined if no match.
+ */
+export const getClaimGatewayErrorMessage = error => {
+  const m = defineMessages({
+    notFound: "Gateway doesn't exist. Please confirm that the gateway EUI is correct.",
+    subscriptionNotActive:
+      'No gateway subscription attached and active. Please subscribe to the gateway or activate your subscription.',
+    activationCodeExpired: 'Activation code expired. Please extend your subscription.',
+    permissionDenied: 'The owner token is invalid.',
+  })
+
+  const rootCause = getBackendErrorRootCause(error)
+  const errorCode = rootCause?.code
+  const backendErrorMessage = rootCause?.message_format
+  switch (errorCode) {
+    case 5: // NOT_FOUND
+      return m.notFound
+    case 9: // FAILED_PRECONDITION
+      if (backendErrorMessage.includes('gateway subscription not attached and active')) {
+        return m.subscriptionNotActive
+      }
+      if (backendErrorMessage.includes('activation code expired')) {
+        return m.activationCodeExpired
+      }
+      return undefined
+    case 7: // PERMISSION_DENIED
+      return m.permissionDenied
+    default:
+      return undefined
+  }
+}

pkg/webui/locales/en.json

@@ -650,9 +650,6 @@
   "console.containers.gateway-onboarding-form.gateway-provisioning-form.index.continue": "To continue, please confirm the Gateway EUI so we can determine onboarding options",
   "console.containers.gateway-onboarding-form.gateway-provisioning-form.index.emtyEui": "Continue without EUI",
   "console.containers.gateway-onboarding-form.gateway-provisioning-form.index.noEui": "No gateway EUI",
-  "console.containers.gateway-onboarding-form.index.claimGatewayNotFound": "`NotFound`: the gateway doesn't exist. This is most likely a typo in the EUI. An edge case is that The Things Stack is configured for the staging environment.",
-  "console.containers.gateway-onboarding-form.index.claimGatewayFailedPrecondition": "`FailedPrecondition`: the owner token is correct, but either there's no gateway subscription attached and active, or it is a correct gateway activation code and it has expired.",
-  "console.containers.gateway-onboarding-form.index.claimGatewayPermissionDenied": "`PermissionDenied`: the owner token is invalid.",
   "console.containers.gateway-onboarding-form.qr-scan-section.index.hasGatewayQR": "Does your gateway have a LoRaWAN® Gateway Identification QR Code? Scan it to speed up onboarding.",
   "console.containers.gateway-onboarding-form.qr-scan-section.index.gatewayGuide": "Gateway registration help",
   "console.containers.gateway-onboarding-form.qr-scan-section.index.invalidQRCode": "Invalid QR code data. Please note that only TTIGPRO1 Gateway Identification QR Code can be scanned. Some gateways have unrelated QR codes printed on them that cannot be used.",
@@ -1087,6 +1084,10 @@
   "lib.errors.status-code-messages.501": "Not implemented",
   "lib.errors.status-code-messages.503": "Service unavailable",
   "lib.errors.status-code-messages.504": "Gateway timeout",
+  "lib.errors.utils.notFound": "Gateway doesn't exist. Please confirm that the gateway EUI is correct.",
+  "lib.errors.utils.subscriptionNotActive": "No gateway subscription attached and active. Please subscribe to the gateway or activate your subscription.",
+  "lib.errors.utils.activationCodeExpired": "Activation code expired. Please extend your subscription.",
+  "lib.errors.utils.permissionDenied": "The owner token is invalid.",
   "lib.field-description-messages.idLocation": "Enter a value using lowercase letters, numbers, and dashes. You can choose this freely.",
   "lib.field-description-messages.freqPlanDescription": "A frequency plan defines data rates that your end device or gateway is setup to use. It is important that gateways and end devices within reach use the same frequency plan to be able to communicate.",
   "lib.field-description-messages.freqPlanLocation": "Your end device or gateway manufacturer should provide information about the applicable frequency plan for a particular device. In some cases they are printed on the device itself but they should always be in the hardware manual or data sheet.",

pkg/webui/locales/ja.json

@@ -650,9 +650,6 @@
   "console.containers.gateway-onboarding-form.gateway-provisioning-form.index.continue": "",
   "console.containers.gateway-onboarding-form.gateway-provisioning-form.index.emtyEui": "",
   "console.containers.gateway-onboarding-form.gateway-provisioning-form.index.noEui": "",
-  "console.containers.gateway-onboarding-form.index.claimGatewayNotFound": "",
-  "console.containers.gateway-onboarding-form.index.claimGatewayFailedPrecondition": "",
-  "console.containers.gateway-onboarding-form.index.claimGatewayPermissionDenied": "",
   "console.containers.gateway-onboarding-form.qr-scan-section.index.hasGatewayQR": "",
   "console.containers.gateway-onboarding-form.qr-scan-section.index.gatewayGuide": "",
   "console.containers.gateway-onboarding-form.qr-scan-section.index.invalidQRCode": "",
@@ -1087,6 +1084,10 @@
   "lib.errors.status-code-messages.501": "",
   "lib.errors.status-code-messages.503": "",
   "lib.errors.status-code-messages.504": "",
+  "lib.errors.utils.notFound": "",
+  "lib.errors.utils.subscriptionNotActive": "",
+  "lib.errors.utils.activationCodeExpired": "",
+  "lib.errors.utils.permissionDenied": "",
   "lib.field-description-messages.idLocation": "",
   "lib.field-description-messages.freqPlanDescription": "周波数プランは、エンドデバイスやゲートウェイが使用するように設定されたデータレートを定義します。ゲートウェイとエンドデバイスが通信できるようにするためには、同じ周波数プランを使用することが重要です",
   "lib.field-description-messages.freqPlanLocation": "エンドデバイスやゲートウェイのメーカーは、特定のデバイスに適用される周波数プランに関する情報を提供するはずです。場合によっては、デバイス自体に印刷されていることもありますが、常にハードウェアマニュアルまたはデータシートに記載されているはずです",