feat: remove ground fix resolution

The nRF Cloud backend actually publishes the location as a message
via MQTT:

{
  "appId": "GROUND_FIX",
  "messageType": "DATA",
  "data": {
    "lat": 59.3381238,
    "lon": 18.00908089,
    "uncertainty": 883,
    "fulfilledWith": "MCELL"
  }
}

so this can be used directly.

See https://docs.nrfcloud.com/APIs/MQTT/Topics/\#c2d-topics-ls

Author: coderbyheart

.github/workflows/test-and-release.yaml

@@ -70,9 +70,7 @@ jobs:
           npx cdk --app "npx tsx --no-warnings cdk/test-resources.ts" deploy --require-approval never
           MOCK_HTTP_API_ENDPOINT=`aws cloudformation describe-stacks --stack-name ${{ env.STACK_NAME }}-test | jq -r '.Stacks[0].Outputs[] | select(.OutputKey == "apiURL") | .OutputValue' | sed -E 's/\/$//g'`
           ./cli.sh configure thirdParty nrfcloud apiEndpoint ${MOCK_HTTP_API_ENDPOINT}
-          openssl ecparam -name prime256v1 -genkey | ./cli.sh configure thirdParty nrfcloud serviceKey
           ./cli.sh configure thirdParty nrfcloud apiKey apiKey
-          ./cli.sh configure thirdParty nrfcloud teamId `uuidgen`
 
       - name: Deploy solution stack
         run: npx cdk deploy --require-approval never
@@ -103,9 +101,7 @@ jobs:
           npx cdk --app 'npx tsx --no-warnings cdk/test-resources.ts' destroy -f
           ./cli.sh fake-nrfcloud-account-device --remove
           ./cli.sh configure thirdParty nrfcloud apiEndpoint -X
-          ./cli.sh configure thirdParty nrfcloud serviceKey -X
           ./cli.sh configure thirdParty nrfcloud apiKey -X
-          ./cli.sh configure thirdParty nrfcloud teamId -X
 
   release:
     needs:

README.md

@@ -28,22 +28,13 @@ npm ci
 
 To setup MQTT bridge, you have to run the below command to generate a
 certificate used by MQTT broker to connect nRF Cloud under your account. So, you
-need to prepare nRF Cloud API key and service key. The service key is used to
-resolve ground fix location.
+need to prepare nRF Cloud API key.
 
 ```bash
 ./cli.sh configure thirdParty nrfcloud apiKey <API key>
 ./cli.sh initialize-nrfcloud-account
 ```
 
-Finally the Ground Fix Service Key and the team ID that it belongs has to be
-configured for resolving device locations:
-
-```bash
-cat serviceKeyFile.pem | ./cli.sh configure thirdParty nrfcloud serviceKey
-./cli.sh configure thirdParty nrfcloud teamId <team ID>
-```
-
 ### Deploy
 
 ```bash

cdk/backend.ts

@@ -34,7 +34,6 @@ const packagesInLayer: string[] = [
 	'ajv',
 	'@hello.nrfcloud.com/proto',
 	'p-limit',
-	'jsonwebtoken',
 	'@aws-lambda-powertools/metrics',
 	'lodash-es',
 	'@middy/core',

cdk/resources/ConvertDeviceMessages.ts

@@ -48,19 +48,8 @@ export class ConvertDeviceMessages extends Construct {
 				DEVICES_TABLE_NAME: deviceStorage.devicesTable.tableName,
 				DEVICES_INDEX_NAME: deviceStorage.devicesTableFingerprintIndexName,
 				NODE_NO_WARNINGS: '1',
-				STACK_NAME: Stack.of(this).stackName,
 			},
 			layers,
-			initialPolicy: [
-				new IAM.PolicyStatement({
-					actions: ['ssm:GetParameter'],
-					resources: [
-						`arn:aws:ssm:${Stack.of(this).region}:${
-							Stack.of(this).account
-						}:parameter/${Stack.of(this).stackName}/thirdParty/nrfcloud/*`,
-					],
-				}),
-			],
 		})
 		new LambdaLogGroup(this, 'onDeviceMessageLogs', onDeviceMessage)
 		websocketAPI.eventBus.grantPutEventsTo(onDeviceMessage)

feature-runner/steps/mocknRFCloud.ts

@@ -64,51 +64,5 @@ ${data}
 		)
 	}
 
-	const mockGroundFix = async ({
-		step,
-		log: {
-			step: { progress },
-		},
-		context: { responsesTableName },
-	}: StepRunnerArgs<World>): Promise<StepRunResult> => {
-		const match = /^there is a ground fix API response as this JSON$/.exec(
-			step.title,
-		)
-		if (match === null) return noMatch
-
-		const data = codeBlockOrThrow(step).code
-
-		const methodPathQuery = `POST v1/location/ground-fix`
-		progress(`Mock http url: ${methodPathQuery}`)
-		await db.send(
-			new PutItemCommand({
-				TableName: responsesTableName,
-				Item: {
-					methodPathQuery: {
-						S: methodPathQuery,
-					},
-					timestamp: {
-						S: new Date().toISOString(),
-					},
-					statusCode: {
-						N: `200`,
-					},
-					body: {
-						S: `Content-Type: application/json
-
-${data}
-						`,
-					},
-					ttl: {
-						N: `${Math.round(Date.now() / 1000) + 5 * 60}`,
-					},
-					keep: {
-						BOOL: false,
-					},
-				},
-			}),
-		)
-	}
-
-	return [mockShadowData, mockGroundFix]
+	return [mockShadowData]
 }

features/GroundFix.feature.md

@@ -1,18 +1,13 @@
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
 import { EventBridge } from '@aws-sdk/client-eventbridge'
 import { proto, type HelloMessage } from '@hello.nrfcloud.com/proto/hello'
-import type { GROUND_FIX } from '@hello.nrfcloud.com/proto/nrfCloud/types/types.js'
 import { fromEnv } from '@nordicsemiconductor/from-env'
 import type { Static } from '@sinclair/typebox'
 import { getModelForDevice } from '../devices/getModelForDevice.js'
-import { locationServiceAPIClient } from '../nrfcloud/locationServiceAPIClient.js'
-import { defaultApiEndpoint } from '../nrfcloud/settings.js'
 import type { WebsocketPayload } from './publishToWebsocketClients.js'
-import { getNRFCloudSSMParameters } from './util/getSSMParameter.js'
 import { logger } from './util/logger.js'
 
-const { EventBusName, DevicesTableName, stackName } = fromEnv({
-	stackName: 'STACK_NAME',
+const { EventBusName, DevicesTableName } = fromEnv({
 	EventBusName: 'EVENTBUS_NAME',
 	DevicesTableName: 'DEVICES_TABLE_NAME',
 })(process.env)
@@ -25,40 +20,6 @@ const eventBus = new EventBridge({})
 
 const modelFetcher = getModelForDevice({ db, DevicesTableName })
 
-const apiClientPromise = (async () => {
-	const [apiEndpoint, serviceKey, teamId] = await getNRFCloudSSMParameters(
-		stackName,
-		['apiEndpoint', 'serviceKey', 'teamId'],
-	)
-	if (serviceKey === undefined)
-		throw new Error(`nRF Cloud service key for ${stackName} is not configured.`)
-	if (teamId === undefined)
-		throw new Error(`nRF Cloud team ID for ${stackName} is not configured.`)
-	return locationServiceAPIClient({
-		endpoint:
-			apiEndpoint !== undefined ? new URL(apiEndpoint) : defaultApiEndpoint,
-		serviceKey,
-		teamId,
-	})
-})()
-
-const preprocessMessage =
-	(apiClient: ReturnType<typeof locationServiceAPIClient>) =>
-	async (message: unknown, ts: number): Promise<unknown> => {
-		// If it is nRF Cloud site survey message, we resolve location using ground fix API
-		if (
-			typeof message === 'object' &&
-			message !== null &&
-			'appId' in message &&
-			message.appId === 'GROUND_FIX'
-		) {
-			return await apiClient.groundFix((message as GROUND_FIX).data, ts)
-		}
-
-		// Otherwise, pass though the message
-		return message
-	}
-
 const parseMessage = async (
 	model: string,
 	message: unknown,
@@ -82,13 +43,11 @@ export const handler = async (event: {
 	timestamp: number
 }): Promise<void> => {
 	log.debug('event', { event })
-	const client = await apiClientPromise
-	const { deviceId, message, timestamp } = event
+	const { deviceId, message } = event
 	const { model } = await modelFetcher(deviceId)
 	log.debug('model', { model })
 
-	const processedMessage = await preprocessMessage(client)(message, timestamp)
-	const converted = await parseMessage(model, processedMessage)
+	const converted = await parseMessage(model, message)
 
 	for (const message of converted) {
 		log.debug('websocket message', { payload: message })