fix(history): use proper types and add e2e test

Author: coderbyheart

cdk/backend.ts

@@ -41,7 +41,7 @@ new BackendApp({
 			: undefined,
 	version: (() => {
 		const v = process.env.VERSION
-		const defaultVersion = '0.0.0-development'
+		const defaultVersion = `0.0.0-development`
 		if (v === undefined)
 			console.warn(`VERSION is not defined, using ${defaultVersion}!`)
 		return v ?? defaultVersion

feature-runner/run-features.ts

@@ -25,16 +25,16 @@ import { slashless } from '@hello.nrfcloud.com/nrfcloud-api-helpers/api'
 const iotData = new IoTDataPlaneClient({})
 const db = new DynamoDBClient({})
 
-const backendConfig = await stackOutput(
-	new CloudFormationClient({}),
-)<BackendStackOutputs>(STACK_NAME)
-
 const { mockApiEndpoint, responsesTableName } = fromEnv({
 	mockApiEndpoint: 'HTTP_API_MOCK_API_URL',
 	responsesTableName: 'HTTP_API_MOCK_RESPONSES_TABLE_NAME',
 	requestsTableName: 'HTTP_API_MOCK_REQUESTS_TABLE_NAME',
 })(process.env)
 
+const backendConfig = await stackOutput(
+	new CloudFormationClient({}),
+)<BackendStackOutputs>(STACK_NAME)
+
 const print = (arg: unknown) =>
 	typeof arg === 'object' ? JSON.stringify(arg) : arg
 const start = Date.now()

features/ResourceHistory.feature.md

@@ -0,0 +1,64 @@
+---
+exampleContext:
+  deviceId: f1394b9a-a7c7-4a4a-ade2-bf2012f92e1f
+  publicDeviceId: discloak-classify-nodosity
+  ts: 1694503339523
+  API: "https://api.nordicsemi.world/2024-04-15"
+---
+
+# History can be fetched for numeric LwM2M object resources
+
+## Background
+
+Given I have the device id for a shared `kartverket-vasstandsdata` device in
+`deviceId` and the public device id in `publicDeviceId`
+
+## Publish SenML via MQTT
+
+Given I store `$millis()` into `ts`
+
+And the device `${deviceId}` publishes this message to the topic
+`m/senml/${deviceId}`
+
+```json
+[
+  {
+    "bn": "14230/0/",
+    "bt": "$number{ts}",
+    "n": "0",
+    "v": 225.1
+  },
+  {
+    "n": "1",
+    "vs": "TRD"
+  }
+]
+```
+
+## Fetch the published data
+
+When I `GET` `${API}/history?deviceId=${publicDeviceId}&instance=14230%2F0`
+
+Then I should receive a
+`https://github.com/hello-nrfcloud/proto-map/history/resource` response
+
+And `$.query` of the last response should match
+
+```json
+{
+  "ObjectID": 14230,
+  "ObjectVersion": "1.0",
+  "ObjectInstanceID": 0,
+  "deviceId": "${publicDeviceId}",
+  "binIntervalMinutes": 15
+}
+```
+
+And `$.partialInstances[0]` of the last response should match
+
+```json
+{
+  "0": 225.1,
+  "99": "$number{ts}"
+}
+```

lambda/queryHistory.ts

@@ -12,10 +12,14 @@ import {
 	isLwM2MObjectID,
 	type LWM2MObjectInfo,
 } from '@hello.nrfcloud.com/proto-map'
-import { PublicDeviceId } from '@hello.nrfcloud.com/proto-map/api'
+import {
+	Context,
+	PublicDeviceId,
+	ResourceHistory,
+} from '@hello.nrfcloud.com/proto-map/api'
 import { fromEnv } from '@nordicsemiconductor/from-env'
 import { parseResult } from '@nordicsemiconductor/timestream-helpers'
-import { Type } from '@sinclair/typebox'
+import { Type, type Static } from '@sinclair/typebox'
 import type {
 	APIGatewayProxyEventV2,
 	APIGatewayProxyResultV2,
@@ -53,6 +57,16 @@ const validateInput = validateWithTypeBox(
 	}),
 )
 
+// TODO: cache globally
+const availableColumns =
+	(
+		await ts.send(
+			new QueryCommand({
+				QueryString: `SELECT * FROM "${DatabaseName}"."${TableName}" LIMIT 1`,
+			}),
+		)
+	)?.ColumnInfo?.map(({ Name }) => Name) ?? []
+
 const h = async (
 	event: APIGatewayProxyEventV2,
 ): Promise<APIGatewayProxyResultV2> => {
@@ -81,26 +95,27 @@ const h = async (
 	const def = definitions[ObjectID]
 
 	try {
-		const res = await queryResourceHistory({
+		const history = await queryResourceHistory({
 			def,
 			instance: InstanceID,
 			deviceId,
 		})
+		const result: Static<typeof ResourceHistory> = {
+			'@context': Context.history.resource.toString(),
+			query: {
+				ObjectID,
+				ObjectVersion: def.ObjectVersion,
+				ObjectInstanceID: InstanceID,
+				deviceId,
+				binIntervalMinutes,
+			},
+			partialInstances: history,
+		}
 		return aResponse(
 			200,
 			{
-				// FIXME: add to proto-map
-				'@context': new URL(
-					'https://github.com/hello-nrfcloud/proto-map/history',
-				),
-				query: {
-					ObjectID,
-					ObjectVersion: def.ObjectVersion,
-					InstanceID,
-					deviceId,
-					binIntervalMinutes,
-				},
-				partialInstances: res,
+				...result,
+				'@context': Context.history.resource,
 			},
 			binIntervalMinutes * 60,
 		)
@@ -131,17 +146,9 @@ const queryResourceHistory = async ({
 	def: LWM2MObjectInfo
 	instance: number
 	deviceId: string
-}) => {
-	// TODO: cache
-	const availableColumns =
-		(
-			await ts.send(
-				new QueryCommand({
-					QueryString: `SELECT * FROM "${DatabaseName}"."${TableName}" LIMIT 1`,
-				}),
-			)
-		)?.ColumnInfo?.map(({ Name }) => Name) ?? []
-
+}): Promise<
+	Array<Record<number, string | number | boolean> & { ts: string }>
+> => {
 	const resourceNames = Object.values(def.Resources)
 		.filter(isNumeric)
 		.map<[string, number]>(({ ResourceID }) => [

package-lock.json

@@ -41,7 +41,7 @@
     "@bifravst/run": "1.2.0",
     "@commitlint/config-conventional": "19.2.2",
     "@hello.nrfcloud.com/bdd-markdown-steps": "2.1.0",
-    "@nordicsemiconductor/bdd-markdown": "8.1.0",
+    "@nordicsemiconductor/bdd-markdown": "8.1.1",
     "@nordicsemiconductor/cloudformation-helpers": "9.0.3",
     "@swc/cli": "0.3.12",
     "@swc/core": "1.4.16",
@@ -102,13 +102,13 @@
     "@hello.nrfcloud.com/certificate-helpers": "1.0.0",
     "@hello.nrfcloud.com/lambda-helpers": "1.0.2",
     "@hello.nrfcloud.com/nrfcloud-api-helpers": "2.0.0",
-    "@hello.nrfcloud.com/proto": "6.6.2",
-    "@hello.nrfcloud.com/proto-map": "5.3.2",
+    "@hello.nrfcloud.com/proto": "6.6.3",
+    "@hello.nrfcloud.com/proto-map": "5.4.2",
     "@middy/core": "5.3.2",
     "@nordicsemiconductor/from-env": "3.0.1",
     "@nordicsemiconductor/random-words": "8.0.1",
     "@nordicsemiconductor/timestream-helpers": "6.0.2",
-    "@sinclair/typebox": "0.32.20",
+    "@sinclair/typebox": "0.32.21",
     "id128": "1.6.6",
     "lodash-es": "4.17.21"
   }