Update device key

udmif/event-handler/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+cd udmif/event-handler
+npx lint-staged

udmif/event-handler/src/DeviceDao.ts

@@ -5,17 +5,17 @@ import { DeviceKey } from './model/DeviceKey';
 const options = { upsert: true };
 
 export interface DeviceDao {
-  upsert(filterQuery: any, updateQuery: any);
-  get(filterQuery: any);
+  upsert(filterQuery: any, updateQuery: any): Promise<void>;
+  get(filterQuery: any): Promise<Device>;
 }
 
 export class DefaultDeviceDao implements DeviceDao {
-  constructor(private collection: Collection<Device>) { }
+  constructor(private collection: Collection<Device>) {}
 
   /**
    * Updates a device document if it is found using the device key, else it will insert a new device document
    * @param {DeviceKey} deviceKey
-   * @param {Device} deviceDocument 
+   * @param {Device} deviceDocument
    */
   async upsert(deviceKey: DeviceKey, deviceDocument: Device): Promise<void> {
     // we're using upsert which will allow document updates if it already exists and a document cretion if it does not

udmif/event-handler/src/DeviceDocumentFactory.ts

@@ -1,9 +1,5 @@
 import { DeviceBuilder, Device } from './model/Device';
-import {
-  isPointsetSubType,
-  isSystemSubType,
-  isValidationSubType,
-} from './MessageUtils';
+import { isPointsetSubType, isSystemSubType, isValidationSubType } from './MessageUtils';
 import { UdmiMessage } from './model/UdmiMessage';
 import { PointBuilder, Point } from './model/Point';
 import { Validation, ValidationBuilder } from './model/Validation';
@@ -16,9 +12,7 @@ export class DeviceDocumentFactory {
 
 export function createDeviceDocument(udmiMessage: UdmiMessage, existingPoints: Point[]): Device {
   const builder: DeviceBuilder = new DeviceBuilder();
-  builder
-    .id(udmiMessage.attributes.deviceNumId)
-    .name(udmiMessage.attributes.deviceId);
+  builder.site(udmiMessage.attributes.deviceRegistryId).name(udmiMessage.attributes.deviceId);
 
   if (isSystemSubType(udmiMessage)) {
     return buildDeviceDocumentFromSystem(udmiMessage, builder);
@@ -32,11 +26,7 @@ export function createDeviceDocument(udmiMessage: UdmiMessage, existingPoints: P
 /**
  * https://faucetsdn.github.io/udmi/gencode/docs/event_system.html describes the incoming schema for an event system message
  */
-function buildDeviceDocumentFromSystem(
-  udmiMessage: UdmiMessage,
-  builder: DeviceBuilder
-): Device {
-
+function buildDeviceDocumentFromSystem(udmiMessage: UdmiMessage, builder: DeviceBuilder): Device {
   return builder
     .lastPayload(udmiMessage.data.timestamp)
     .operational(udmiMessage.data.operational)
@@ -45,18 +35,14 @@ function buildDeviceDocumentFromSystem(
     .model(udmiMessage.data.hardware?.model)
     .firmware(udmiMessage.data.software?.firmware)
     .section(udmiMessage.data.location?.section)
-    .site(udmiMessage.data.location?.site)
+    .id(udmiMessage.attributes.deviceNumId)
     .build();
 }
 
 /**
  * https://faucetsdn.github.io/udmi/gencode/docs/event_validation.html  describes the incoming schema for an event validation message
  */
-function buildDeviceDocumentFromValidation(
-  udmiMessage: UdmiMessage,
-  builder: DeviceBuilder
-): Device {
-
+function buildDeviceDocumentFromValidation(udmiMessage: UdmiMessage, builder: DeviceBuilder): Device {
   const validation: Validation = new ValidationBuilder()
     .timestamp(udmiMessage.data.timestamp)
     .category(udmiMessage.data.status.category)
@@ -65,8 +51,7 @@ function buildDeviceDocumentFromValidation(
     .errors(udmiMessage.data.errors)
     .build();
 
-  return builder.validation(validation)
-    .build();
+  return builder.validation(validation).build();
 }
 
 /**
@@ -80,7 +65,7 @@ function buildDeviceDocumentFromPointset(
   const points: Point[] = [];
 
   for (let pointCode in udmiMessage.data.points) {
-    const existingPoint = existingPoints.find(candidatePoint => candidatePoint.name === pointCode);
+    const existingPoint = existingPoints.find((candidatePoint) => candidatePoint.name === pointCode);
     const point: Point = buildPoint(udmiMessage, existingPoint, pointCode);
     points.push(point);
   }
@@ -89,7 +74,6 @@ function buildDeviceDocumentFromPointset(
 }
 
 function buildPoint(udmiMessage: UdmiMessage, existingPoint: Point, pointCode: string): Point {
-
   const pointValue = udmiMessage.data.points[pointCode];
 
   // we get the value from either the message or the existing point
@@ -107,4 +91,3 @@ function buildPoint(udmiMessage: UdmiMessage, existingPoint: Point, pointCode: s
     .metaCode(pointCode)
     .build();
 }
-

udmif/event-handler/src/InvalidMessageError.ts

@@ -1,8 +1,8 @@
 export class InvalidMessageError extends Error {
-    constructor(msg: string) {
-        super(msg);
+  constructor(msg: string) {
+    super(msg);
 
-        // Set the prototype explicitly.
-        Object.setPrototypeOf(this, InvalidMessageError.prototype);
-    }
-}
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, InvalidMessageError.prototype);
+  }
+}

udmif/event-handler/src/UdmiMessageHandler.ts

@@ -40,11 +40,11 @@ export default class UdmiMessageHandler {
       throw new InvalidMessageError('An invalid device id was submitted');
     }
 
-    if (!message.attributes.deviceNumId) {
-      throw new InvalidMessageError('An invalid device num id was submitted');
+    if (!message.attributes.deviceRegistryId) {
+      throw new InvalidMessageError('An invalid site was submitted');
     }
 
-    return { name: message.attributes.deviceId, id: message.attributes.deviceNumId };
+    return { name: message.attributes.deviceId, site: message.attributes.deviceRegistryId };
   }
 
   private messageCanBeHandled(message: UdmiMessage): boolean {

udmif/event-handler/src/__tests__/DeviceDao.spec.ts

@@ -23,15 +23,15 @@ afterAll(async () => {
 beforeEach(async () => {
   // clean the collection before each test
   await deviceCollection.deleteMany({});
-})
+});
 
 describe('DeviceDao.upsert', () => {
   test('upsert calls the updateOne method on the provided collection', () => {
     // arrange
     const name: string = 'name';
-    const id: string = 'id';
-    const deviceKey: DeviceKey = { name, id };
-    const deviceDocument: Device = { name, id };
+    const site: string = 'site-1';
+    const deviceKey: DeviceKey = { name, site };
+    const deviceDocument: Device = { name, site };
     const deviceDao: DeviceDao = new DefaultDeviceDao(deviceCollection);
     const updateOneSpy = jest.spyOn(deviceCollection, 'updateOne').mockImplementation(jest.fn());
 
@@ -44,17 +44,16 @@ describe('DeviceDao.upsert', () => {
 });
 
 describe('DeviceDao.get', () => {
-
   test('get method is called and returns the matching document', async () => {
     // arrange
     const findOneSpy = jest.spyOn(deviceCollection, 'findOne');
 
     const name: string = 'name';
-    const id: string = 'id';
-    const deviceKey: DeviceKey = { name, id };
+    const site: string = 'id';
+    const deviceKey: DeviceKey = { name, site };
     const deviceDao: DeviceDao = new DefaultDeviceDao(deviceCollection);
 
-    const insertedDeviceDocument: Device = { name, id, points: [], serialNumber: 'randomSerialId' };
+    const insertedDeviceDocument: Device = { name, site, points: [], serialNumber: 'randomSerialId' };
     deviceCollection.insertOne(insertedDeviceDocument);
 
     // act
@@ -64,4 +63,4 @@ describe('DeviceDao.get', () => {
     expect(retrievedDeviceDocument).toEqual(insertedDeviceDocument);
     expect(findOneSpy).toHaveBeenCalledWith(deviceKey);
   });
-});
+});