feat: use shared types from docs (#1339)

- use [new protocol definitions from docs](NordicSemiconductor/asset-tracker-cloud-docs#665) - switch to ES modules (Closes #572) - get rid of fp-ts (makes code too complicated, no clear benefit)
NordicSemiconductor · Mar 20, 2023 · ec0e3b1 · ec0e3b1
1 parent 2d4e58d
commit ec0e3b1
Show file tree

Hide file tree

Showing 168 changed files with 1,871 additions and 4,486 deletions.
diff --git a/.github/workflows/test-and-release.yaml b/.github/workflows/test-and-release.yaml
@@ -79,8 +79,7 @@ jobs:
       - run: echo "VERSION=${{ github.sha }}" >> $GITHUB_ENV
       - name: Set up stack for End-to-End tests
         run: |
-          npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-sourcecode.ts' bootstrap aws://`aws sts get-caller-identity | jq -r '.Account' | tr -d '\n'`/${{ env.AWS_REGION }}
-          npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-sourcecode.ts' deploy
+          npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-test.ts' bootstrap aws://`aws sts get-caller-identity | jq -r '.Account' | tr -d '\n'`/${{ env.AWS_REGION }}
           npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-http-api-mock.ts' deploy '*' --require-approval never
           ./cli.sh configure thirdParty nrfcloud teamId `uuidgen`
           openssl ecparam -name prime256v1 -genkey | ./cli.sh configure thirdParty nrfcloud agpsLocationServiceKey
@@ -112,11 +111,6 @@ jobs:
           ./cli.sh purge-buckets
           npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-test.ts' destroy -f '*'
           npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-http-api-mock.ts' destroy -f '*'
-          # Delete sourcecode bucket
-          SOURCE_CODE_BUCKET=`aws cloudformation describe-stacks --stack-name $STACK_NAME-sourcecode | jq -r '.Stacks[0].Outputs[] | select(.OutputKey == "bucketName") | .OutputValue'`
-          aws s3 rb s3://$SOURCE_CODE_BUCKET --force
-          # Delete the sourceode stack
-          npx cdk -a 'node --loader tsx --unhandled-rejections=strict cdk/cloudformation-sourcecode.ts' destroy -f '*'
       - uses: actions/upload-artifact@v3
         if: always()
         with:

diff --git a/.prettierrc.js b/.prettierrc.js
diff --git a/agps/cacheKey.spec.ts b/agps/cacheKey.spec.ts
@@ -1,4 +1,4 @@
-import { cacheKey } from './cacheKey'
+import { cacheKey } from './cacheKey.js'
 
 describe('cacheKey', () => {
 	it('should create a cache key', () =>

diff --git a/agps/cacheKey.ts b/agps/cacheKey.ts
@@ -1,5 +1,5 @@
-import { Static } from '@sinclair/typebox'
-import { agpsRequestSchema } from './types'
+import type { Static } from '@sinclair/typebox'
+import type { agpsRequestSchema } from './types.js'
 
 export const cacheKey = ({
 	request,

diff --git a/agps/deviceRequestHandler.ts b/agps/deviceRequestHandler.ts
@@ -9,14 +9,13 @@ import {
 	SendMessageBatchRequestEntry,
 	SQSClient,
 } from '@aws-sdk/client-sqs'
-import { Static } from '@sinclair/typebox'
-import { SQSEvent, SQSMessageAttributes } from 'aws-lambda'
-import { isRight } from 'fp-ts/lib/These'
+import type { Static } from '@sinclair/typebox'
+import type { SQSEvent, SQSMessageAttributes } from 'aws-lambda'
 import { randomUUID } from 'node:crypto'
-import { fromEnv } from '../util/fromEnv'
-import { cacheKey } from './cacheKey'
-import { AGPSDataCache, getCache } from './getCache'
-import { agpsRequestSchema } from './types'
+import { fromEnv } from '../util/fromEnv.js'
+import { cacheKey } from './cacheKey.js'
+import { AGPSDataCache, getCache } from './getCache.js'
+import type { agpsRequestSchema } from './types.js'
 
 const {
 	binHoursString,
@@ -84,7 +83,7 @@ export const handler = async (event: SQSEvent): Promise<void> => {
 			if (grouped[k] === undefined) {
 				grouped[k] = [deviceRequest]
 			} else {
-				grouped[k].push(deviceRequest)
+				grouped[k]?.push(deviceRequest)
 			}
 			return grouped
 		},
@@ -104,19 +103,10 @@ export const handler = async (event: SQSEvent): Promise<void> => {
 				if (resolvedRequests[cacheKey] === undefined) {
 					console.debug(cacheKey, 'Load from DB')
 					const d = await c(cacheKey)
-					if (isRight(d)) {
-						if (d.right?.unresolved !== undefined) {
-							console.debug(cacheKey, 'Processing of the request is finished')
-							resolvedRequests[cacheKey] = d.right
-							if (d.right.unresolved === true) {
-								console.error(cacheKey, `A-GPS request is unresolved.`)
-								return
-							}
-						}
-					} else {
+					if ('error' in d) {
 						console.debug(cacheKey, 'cache does not exist')
-						console.warn({ getCache: d.left })
-						const r = deviceRequests[0].request
+						console.warn({ getCache: d })
+						const r = deviceRequests[0]?.request
 						await Promise.all([
 							// Create DB entry
 							await dynamodb
@@ -128,25 +118,25 @@ export const handler = async (event: SQSEvent): Promise<void> => {
 												S: cacheKey,
 											},
 											mcc: {
-												N: `${r.mcc}`,
+												N: `${r?.mcc}`,
 											},
 											mnc: {
-												N: `${r.mnc}`,
+												N: `${r?.mnc}`,
 											},
 											cell: {
-												N: `${r.cell}`,
+												N: `${r?.cell}`,
 											},
 											area: {
-												N: `${r.area}`,
+												N: `${r?.area}`,
 											},
 											phycell:
-												r.phycell !== undefined
+												r?.phycell !== undefined
 													? {
 															N: `${r.phycell}`,
 													  }
 													: { NULL: true },
 											types: {
-												NS: r.types.map((t) => `${t}`),
+												NS: r?.types.map((t) => `${t}`) ?? [],
 											},
 											updatedAt: {
 												S: new Date().toISOString(),
@@ -189,13 +179,22 @@ export const handler = async (event: SQSEvent): Promise<void> => {
 									)
 								}),
 						])
+					} else {
+						if (d.unresolved !== undefined) {
+							console.debug(cacheKey, 'Processing of the request is finished')
+							resolvedRequests[cacheKey] = d
+							if (d.unresolved === true) {
+								console.error(cacheKey, `A-GPS request is unresolved.`)
+								return
+							}
+						}
 					}
 				}
 
 				// The data for these requests is available
 				if (
 					resolvedRequests[cacheKey]?.unresolved !== undefined &&
-					resolvedRequests[cacheKey].unresolved === false
+					resolvedRequests[cacheKey]?.unresolved === false
 				) {
 					console.debug(cacheKey, 'data for these requests is available')
 					console.debug(

diff --git a/agps/getCache.ts b/agps/getCache.ts
@@ -1,9 +1,8 @@
 import { DynamoDBClient, GetItemCommand } from '@aws-sdk/client-dynamodb'
 import { unmarshall } from '@aws-sdk/util-dynamodb'
-import { Static } from '@sinclair/typebox'
-import { Either, left, right } from 'fp-ts/lib/Either'
-import { ErrorInfo, ErrorType } from '../api/ErrorInfo'
-import { agpsRequestSchema } from './types'
+import type { Static } from '@sinclair/typebox'
+import { ErrorInfo, ErrorType } from '../api/ErrorInfo.js'
+import type { agpsRequestSchema } from './types.js'
 
 export type AGPSDataCache = Static<typeof agpsRequestSchema> & {
 	source: string
@@ -14,7 +13,7 @@ export type AGPSDataCache = Static<typeof agpsRequestSchema> & {
 
 export const getCache =
 	({ dynamodb, TableName }: { dynamodb: DynamoDBClient; TableName: string }) =>
-	async (cacheKey: string): Promise<Either<ErrorInfo, AGPSDataCache>> => {
+	async (cacheKey: string): Promise<{ error: ErrorInfo } | AGPSDataCache> => {
 		try {
 			const { Item } = await dynamodb.send(
 				new GetItemCommand({
@@ -30,7 +29,7 @@ export const getCache =
 			if (Item === undefined) throw new Error('NOT_FOUND')
 
 			const entry = unmarshall(Item)
-			const i = {
+			return {
 				...entry,
 				updatedAt: new Date(entry.updatedAt as string),
 				types: [...(entry.types as Set<number>)],
@@ -39,17 +38,17 @@ export const getCache =
 						? [...(entry.dataHex as Set<string>)]
 						: undefined,
 			} as AGPSDataCache
-
-			return right(i)
 		} catch (err) {
 			if (
 				(err as Error).message === 'NOT_FOUND' ||
 				(err as Error).name === 'ResourceNotFoundException'
 			)
-				return left({
-					type: ErrorType.EntityNotFound,
-					message: `Report ${cacheKey} not found!`,
-				})
+				return {
+					error: {
+						type: ErrorType.EntityNotFound,
+						message: `Report ${cacheKey} not found!`,
+					},
+				}
 			console.error(
 				JSON.stringify({
 					getCache: {
@@ -60,9 +59,11 @@ export const getCache =
 					},
 				}),
 			)
-			return left({
-				type: ErrorType.InternalError,
-				message: (err as Error).message,
-			})
+			return {
+				error: {
+					type: ErrorType.InternalError,
+					message: (err as Error).message,
+				},
+			}
 		}
 	}
diff --git a/agps/types.ts b/agps/types.ts
@@ -13,6 +13,9 @@ export enum AGPSType {
 
 const PositiveInteger = Type.Integer({ minimum: 1, title: 'positive integer' })
 
+/**
+ * @see https://api.nrfcloud.com/v1#tag/Assisted-GPS/operation/GetAssistanceData
+ */
 export const agpsRequestSchema = Type.Object({
 	mcc: Type.Integer({ minimum: 100, maximum: 999 }),
 	mnc: Type.Integer({ minimum: 0, maximum: 999 }),

diff --git a/api/res.ts b/api/res.ts
@@ -1,4 +1,4 @@
-import { APIGatewayProxyResultV2 } from 'aws-lambda'
+import type { APIGatewayProxyResultV2 } from 'aws-lambda'
 
 export const res =
 	(statusCode: number, options?: { expires: number }) =>

diff --git a/api/resFP.ts b/api/resFP.ts
diff --git a/api/validateWithJSONSchema.spec.ts b/api/validateWithJSONSchema.spec.ts
diff --git a/api/validateWithJSONSchema.ts b/api/validateWithJSONSchema.ts
diff --git a/api/validateWithJSONSchemaFP.spec.ts b/api/validateWithJSONSchemaFP.spec.ts
diff --git a/api/validateWithJSONSchemaFP.ts b/api/validateWithJSONSchemaFP.ts