INT-2714 - Fix for hardware mapping

CHANGELOG.md

@@ -8,6 +8,14 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Fixed
+
+- Assigned `unknown` value if hardware `manufacturer`, `make` or `model` field
+  is undefined.
+- Fixed part corresponding to iterating hardware assigned user.
+- Cleaned up code for creating hardware related mapped relationships (we can
+  only access the `serial` value).
+
 ## 2.0.0 - 2022-11-10
 
 - Reorganized files

src/collector/types.ts

@@ -10,7 +10,90 @@ export interface PaginatedResponse {
   rows: any[];
 }
 
-export type HardwareAsset = Opaque<any, 'HardwareAsset'>;
+export type HardwareAsset = Opaque<
+  {
+    id: number;
+    name: string;
+    asset_tag: string;
+    serial: string;
+    model: {
+      id: number;
+      name: string;
+    };
+    model_number: string;
+    eol: {
+      date: string;
+      formatted: string;
+    };
+    status_label: {
+      id: number;
+      name: string;
+      status_type: string;
+      status_meta: string;
+    };
+    category: {
+      id: number;
+      name: string;
+    };
+    manufacturer?: {
+      id: number;
+      name: string;
+    };
+    supplier: {
+      id: number;
+      name: string;
+    };
+    notes: string;
+    order_number: string;
+    company?: string;
+    location: {
+      id: number;
+      name: string;
+    };
+    rtd_location: {
+      id: number;
+      name: string;
+    };
+    image: string;
+    qr: string;
+    created_at: {
+      datetime: string;
+      formatted: string;
+    };
+    updated_at: {
+      datetime: string;
+      formatted: string;
+    };
+    purchase_date: {
+      date: string;
+      formatted: string;
+    };
+    purchase_cost: string;
+    checkin_counter: number;
+    checkout_counter: number;
+    requests_counter: number;
+    user_can_checkout: boolean;
+    available_actions: {
+      checkout: boolean;
+      checkin: boolean;
+      clone: boolean;
+      restore: boolean;
+      update: boolean;
+      delete: boolean;
+    };
+    assigned_to?: {
+      id: number;
+      username?: string;
+      name: string;
+      first_name?: string;
+      last_name?: string;
+      employee_number?: string;
+      type: string;
+    };
+  },
+  'HardwareAsset'
+>;
+
 export type SnipeItUser = Opaque<any, 'SnipeItUser'>;
 export type SnipeItConsumable = Opaque<any, 'SnipeItConsumable'>;
 export type SnipeItLicense = Opaque<any, 'SnipeItLicense'>;

src/steps/fetch-hardware/converter.ts

@@ -1,6 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import {
-  convertProperties,
   createIntegrationEntity,
   createMappedRelationship,
   Entity,
@@ -25,23 +24,21 @@ export function convertHardware(
     entityData: {
       source: data,
       assign: {
-        ...convertProperties(data),
-        _key: getHardwareKey(data.id),
+        _key: getHardwareKey(data.id.toString()),
         _type: Entities.HARDWARE._type,
         _class: Entities.HARDWARE._class,
-        id: getHardwareKey(data.id),
+        id: getHardwareKey(data.id.toString()),
         assetId: data.id,
         deviceId: `${data.id}`,
         displayName: data.name,
-        activatedOn: parseTimePropertyValue(data.activated_on),
         username: user?.username || data.assigned_to?.username,
         userId: user?.id || data.assigned_to?.id,
         email: user?.email,
         assetTag: data.asset_tag,
         category: data.category?.name,
-        manufacturer: data.manufacturer?.name,
-        make: data.manufacturer?.name,
-        model: data.model?.name,
+        manufacturer: data.manufacturer?.name || 'unknown',
+        make: data.manufacturer?.name || 'unknown',
+        model: data.model?.name || 'unknown',
         serial: data.serial,
         supplier: data.supplier?.name,
         EOL: !!data.eol,
@@ -56,6 +53,24 @@ export function convertHardware(
         locationId: data.location?.id,
         createdOn: parseTimePropertyValue(data.created_at?.datetime),
         updatedOn: parseTimePropertyValue(data.updated_at?.datetime),
+        modelNumber: data.model_number,
+        orderNumber: data.order_number,
+        company: data.company,
+        rtdLocation: data.rtd_location?.name,
+        image: data.image,
+        qr: data.qr,
+        purchaseOn: parseTimePropertyValue(data.purchase_date?.date),
+        purchaseCost: data.purchase_cost,
+        checkinCounter: data.checkin_counter,
+        checkoutCounter: data.checkout_counter,
+        requestsCounter: data.requests_counter,
+        userCanCheckout: data.user_can_checkout,
+        isCheckoutAvailable: data.available_actions?.checkout,
+        isCheckinAvailable: data.available_actions?.checkin,
+        isCloneAvailable: data.available_actions?.clone,
+        isRestoreAvailable: data.available_actions?.restore,
+        isUpdateAvailable: data.available_actions?.update,
+        isDeleteAvailable: data.available_actions?.delete,
       },
     },
   });
@@ -75,10 +90,12 @@ export function mapHardwareRelationship(
       sourceEntityKey: account._key,
       targetFilterKeys: [['_class', filterKey]],
       targetEntity: {
-        ...convertProperties(hardware),
         _key: hardware._key,
         _type: hardware._type,
         _class: hardware._class,
+        id: hardware.id,
+        displayName: hardware.displayName,
+        createdOn: hardware.createdOn as number,
       },
     },
   });
@@ -98,8 +115,6 @@ export function mapHardwareLocationRelationship(
       sourceEntityKey: getLocationKey(hardware.locationId as string),
       targetFilterKeys: [['_class', 'id', 'locationId']],
       targetEntity: {
-        // not sure if it was inteded, but previously,
-        // _class was a string, not an array.
         _class: Entities.HARDWARE._class,
         id: hardware.id,
         locationId: hardware.locationId as number,

src/steps/fetch-hardware/index.test.ts

@@ -20,6 +20,8 @@ test('fetchHardwareAssets', async () => {
         url: {
           protocol: false,
           query: false,
+          hostname: false,
+          port: false,
         },
       },
     },

src/steps/fetch-hardware/index.ts

@@ -25,9 +25,11 @@ export async function fetchHardwareAssets({
   const hardwareIds: number[] = [];
 
   await client.iterateHardware(async (device) => {
-    const assignedUser = device.assigned_to;
-    const username = assignedUser?.username || assignedUser;
-    const user = username ? await client.fetchUser(username) : undefined;
+    const assignedTo = device.assigned_to;
+    const user =
+      assignedTo?.type === 'user'
+        ? await client.fetchUser(assignedTo.username as string)
+        : undefined;
 
     hardwareIds.push(device.id);
 
@@ -36,20 +38,10 @@ export async function fetchHardwareAssets({
     const targetEntity = convertHardware(device, user);
 
     const relationships: MappedRelationship[] = [];
-    if (accountEntity) {
-      if (targetEntity.macAddress) {
-        relationships.push(
-          mapHardwareRelationship(accountEntity, targetEntity, 'macAddress'),
-        );
-      } else if (targetEntity.serial) {
-        relationships.push(
-          mapHardwareRelationship(accountEntity, targetEntity, 'serial'),
-        );
-      } else if (targetEntity.hardwareId) {
-        relationships.push(
-          mapHardwareRelationship(accountEntity, targetEntity, 'hardwareId'),
-        );
-      }
+    if (accountEntity && targetEntity.serial) {
+      relationships.push(
+        mapHardwareRelationship(accountEntity, targetEntity, 'serial'),
+      );
     }
 
     if (targetEntity.locationId) {
@@ -60,7 +52,7 @@ export async function fetchHardwareAssets({
       await jobState.addRelationships(relationships);
     } else {
       logger.warn(
-        { assetId: device.assetId, username: assignedUser?.username },
+        { assetId: device.id, username: user?.username },
         'Hardware asset has no supported identifier, mapped relationship not created',
       );
     }