SIMSBIOHUB-286: Upload Telemetry Files on Device Creation

api/src/paths/telemetry/device/{deviceId}.test.ts

@@ -21,6 +21,7 @@ describe('getDeviceDetails', () => {
   it('gets device details', async () => {
     const mockGetDeviceDetails = sinon.stub(BctwService.prototype, 'getDeviceDetails').resolves([]);
     const mockGetDeployments = sinon.stub(BctwService.prototype, 'getDeviceDeployments').resolves([]);
+    const mockGetKeyXDetails = sinon.stub(BctwService.prototype, 'getKeyXDetails').resolves([]);
 
     const { mockReq, mockRes, mockNext } = getRequestHandlerMocks();
     const requestHandler = getDeviceDetails();
@@ -30,5 +31,23 @@ describe('getDeviceDetails', () => {
     expect(mockRes.statusValue).to.equal(200);
     expect(mockGetDeviceDetails).to.have.been.calledOnce;
     expect(mockGetDeployments).to.have.been.calledOnce;
+    expect(mockGetKeyXDetails).to.have.been.calledOnce;
+  });
+
+  it('catches and re-throws errors', async () => {
+    const mockError = new Error('test error');
+    const mockGetDeviceDetails = sinon.stub(BctwService.prototype, 'getDeviceDetails').rejects(mockError);
+
+    const { mockReq, mockRes, mockNext } = getRequestHandlerMocks();
+    const requestHandler = getDeviceDetails();
+
+    try {
+      await requestHandler(mockReq, mockRes, mockNext);
+      expect.fail();
+    } catch (error) {
+      expect(error).to.equal(mockError);
+      expect(mockGetDeviceDetails).to.have.been.calledOnce;
+      expect(mockNext).not.to.have.been.called;
+    }
   });
 });

api/src/paths/telemetry/device/{deviceId}.ts

@@ -67,8 +67,11 @@ export function getDeviceDetails(): RequestHandler {
     try {
       const results = await bctwService.getDeviceDetails(deviceId);
       const deployments = await bctwService.getDeviceDeployments(deviceId);
+      const keyXResult = await bctwService.getKeyXDetails([deviceId]);
+      const keyXStatus = keyXResult?.[0]?.keyx?.idcollar === deviceId;
       const retObj = {
         device: results?.[0],
+        keyXStatus: keyXStatus,
         deployments: deployments
       };
       return res.status(200).json(retObj);

api/src/services/bctw-service.test.ts

@@ -14,6 +14,7 @@ import {
   GET_DEPLOYMENTS_BY_DEVICE_ENDPOINT,
   GET_DEPLOYMENTS_ENDPOINT,
   GET_DEVICE_DETAILS,
+  GET_KEYX_STATUS_ENDPOINT,
   HEALTH_ENDPOINT,
   IDeployDevice,
   IDeploymentUpdate,
@@ -238,6 +239,16 @@ describe('BctwService', () => {
       });
     });
 
+    describe('getKeyXDetails', () => {
+      it('should send a get request', async () => {
+        const mockGetRequest = sinon.stub(bctwService, '_makeGetRequest');
+
+        await bctwService.getKeyXDetails([123]);
+
+        expect(mockGetRequest).to.have.been.calledOnceWith(GET_KEYX_STATUS_ENDPOINT, { device_ids: ['123'] });
+      });
+    });
+
     describe('updateDevice', () => {
       it('should send a post request', async () => {
         const mockAxios = sinon.stub(bctwService.axiosInstance, 'post').resolves({ data: { results: [], errors: [] } });

api/src/services/bctw-service.ts

@@ -69,6 +69,21 @@ export const IUploadKeyxResponse = z.object({
 
 export type IUploadKeyxResponse = z.infer<typeof IUploadKeyxResponse>;
 
+export const IKeyXDetails = z.object({
+  device_id: z.number(),
+  keyx: z
+    .object({
+      idcom: z.string(),
+      comtype: z.string(),
+      idcollar: z.number(),
+      collarkey: z.string(),
+      collartype: z.number()
+    })
+    .nullable()
+});
+
+export type IKeyXDetails = z.infer<typeof IKeyXDetails>;
+
 export const IBctwUser = z.object({
   keycloak_guid: z.string(),
   username: z.string()
@@ -97,6 +112,7 @@ export const HEALTH_ENDPOINT = '/health';
 export const GET_CODE_ENDPOINT = '/get-code';
 export const GET_DEVICE_DETAILS = '/get-collar-history-by-device/';
 export const UPLOAD_KEYX_ENDPOINT = '/import-xml';
+export const GET_KEYX_STATUS_ENDPOINT = '/get-collars-keyx';
 
 export class BctwService {
   user: IBctwUser;
@@ -330,6 +346,10 @@ export class BctwService {
     };
   }
 
+  async getKeyXDetails(deviceIds: number[]): Promise<IKeyXDetails[]> {
+    return this._makeGetRequest(GET_KEYX_STATUS_ENDPOINT, { device_ids: deviceIds.map((id) => String(id)) });
+  }
+
   /**
    * Get a list of all BCTW codes with a given header name.
    *

app/src/components/file-upload/FileUpload.tsx

@@ -32,7 +32,7 @@ export interface IFileUploadProps {
    * @type {IUploadHandler}
    * @memberof IFileUploadProps
    */
-  uploadHandler: IUploadHandler;
+  uploadHandler?: IUploadHandler;
   /**
    * Callback fired for each accepted file in the list (that do not have any `DropZone` errors (size, count, extension).
    *

app/src/components/file-upload/FileUploadItem.tsx

@@ -44,12 +44,12 @@
 
 export interface IFileUploadItemProps {
   /**
-   * A file upload callback fired for each file.
+   * An optional file upload callback fired for each file.
    *
    * @type {IUploadHandler}
    * @memberof IFileUploadItemProps
    */
-  uploadHandler: IUploadHandler;
+  uploadHandler?: IUploadHandler;
   /**
    * An optional callback fired if the file upload is successful.
    *
@@ -223,16 +223,18 @@
       onSuccess?.(response);
     };
 
-    uploadHandler(file, cancelToken, handleFileUploadProgress)
-      .then(handleFileUploadSuccess, (error: APIError) => {
-        setError(error?.message);
-        setErrorDetails(
-          error.errors?.map((error) => {
-            return { _id: v4(), message: String(error) };
-          })
-        );
-      })
-      .catch();
+    if (uploadHandler) {
+      uploadHandler(file, cancelToken, handleFileUploadProgress)
+        .then(handleFileUploadSuccess, (error: APIError) => {
+          setError(error?.message);
+          setErrorDetails(
+            error?.errors?.map((e) => {
+              return { _id: v4(), message: e?.toString() };
+            })
+          );
+        })
+        .catch();
+    }
 
     setStatus(UploadFileStatus.UPLOADING);
   }, [

app/src/constants/attachments.ts

@@ -22,6 +22,7 @@ export enum ProjectSurveyAttachmentValidExtensions {
   DATA = '.txt, .xls, .xlsx, .xlsm, .xlsb, .accdb, .mdb, .ods, .csv',
   IMAGE = '.gif, .png, .jpg, .jpeg, .svg, .tiff, .bmp, .tif',
   KEYX = '.keyx, .zip',
+  CONFIG = '.cfg',
   REPORT = '.doc, .docx, .pdf',
   SPATIAL = '.kml, .gpx, .zip',
   VIDEO = '.mp4, .mov, .wmv, .ave',

app/src/features/surveys/view/SurveyAnimals.test.tsx

@@ -131,8 +131,9 @@ describe('SurveyAnimals', () => {
       fireEvent.click(getByTestId('animal actions'));
       fireEvent.click(getByTestId('animal-table-row-edit-timespan'));
       fireEvent.click(getByText('Save Changes'));
-      //fireEvent.click(getByText('Import Animals'));
-      //fireEvent.click(getByText('Save Changes'));
+      fireEvent.click(getByTestId('animal actions'));
+      fireEvent.click(getByTestId('animal-table-row-add-device'));
+      fireEvent.click(getByText('Save Changes'));
     });
   });
 });

app/src/features/surveys/view/SurveyAnimals.tsx

@@ -4,6 +4,7 @@
 import HelpButtonTooltip from 'components/buttons/HelpButtonTooltip';
 import EditDialog from 'components/dialog/EditDialog';
 import { H2ButtonToolbar } from 'components/toolbar/ActionToolbars';
+import { AttachmentType } from 'constants/attachments';
 import { SurveyAnimalsI18N } from 'constants/i18n';
 import { DialogContext } from 'contexts/dialogContext';
 import { SurveyContext } from 'contexts/surveyContext';
@@ -16,10 +17,18 @@
 import yup from 'utils/YupSchema';
 import NoSurveySectionData from '../components/NoSurveySectionData';
 import { AnimalSchema, AnimalSex, Critter, IAnimal } from './survey-animals/animal';
-import { AnimalTelemetryDeviceSchema, Device, IAnimalTelemetryDevice } from './survey-animals/device';
+import {
+  AnimalTelemetryDeviceSchema,
+  Device,
+  IAnimalTelemetryDevice,
+  IDeploymentTimespan
+} from './survey-animals/device';
 import IndividualAnimalForm from './survey-animals/IndividualAnimalForm';
 import { SurveyAnimalsTable } from './survey-animals/SurveyAnimalsTable';
-import TelemetryDeviceForm, { TELEMETRY_DEVICE_FORM_MODE } from './survey-animals/TelemetryDeviceForm';
+import TelemetryDeviceForm, {
+  IAnimalTelemetryDeviceFile,
+  TELEMETRY_DEVICE_FORM_MODE
+} from './survey-animals/TelemetryDeviceForm';
 
 const SurveyAnimals: React.FC = () => {
   const bhApi = useBiohubApi();
@@ -151,44 +160,91 @@
     }
   };
 
-  const handleTelemetrySave = async (survey_critter_id: number, data: IAnimalTelemetryDevice[]) => {
+  const uploadAttachment = async (file?: File, attachmentType?: AttachmentType) => {
+    try {
+      if (file && attachmentType === AttachmentType.KEYX) {
+        await bhApi.survey.uploadSurveyKeyx(projectId, surveyId, file);
+      } else if (file && attachmentType === AttachmentType.OTHER) {
+        await bhApi.survey.uploadSurveyAttachments(projectId, surveyId, file);
+      }
+    } catch (error) {
+      throw new Error(`Failed to upload attachment ${file?.name}`);
+    }
+  };
+
+  const handleAddTelemetry = async (survey_critter_id: number, data: IAnimalTelemetryDeviceFile[]) => {
     const critter = critterData?.find((a) => a.survey_critter_id === survey_critter_id);
-    const critterTelemetryDevice = { ...data[0], critter_id: critter?.critter_id ?? '' };
-    if (telemetryFormMode === TELEMETRY_DEVICE_FORM_MODE.ADD) {
-      try {
-        await bhApi.survey.addDeployment(projectId, surveyId, survey_critter_id, critterTelemetryDevice);
-        setPopup('Successfully added deployment.');
-      } catch (e) {
+    const { attachmentFile, attachmentType, ...critterTelemetryDevice } = {
+      ...data[0],
+      critter_id: critter?.critter_id ?? ''
+    };
+    try {
+      // Upload attachment if there is one
+      await uploadAttachment(attachmentFile, attachmentType);
+      // create new deployment record
+      await bhApi.survey.addDeployment(projectId, surveyId, survey_critter_id, critterTelemetryDevice);
+      setPopup('Successfully added deployment.');
+      surveyContext.artifactDataLoader.refresh(projectId, surveyId);
+    } catch (error: unknown) {
+      if (error instanceof Error) {
+        setPopup('Failed to add deployment' + (error?.message ? `: ${error.message}` : '.'));
+      } else {
         setPopup('Failed to add deployment.');
       }
-    } else if (telemetryFormMode === TELEMETRY_DEVICE_FORM_MODE.EDIT) {
-      for (const formValues of data) {
-        const existingDevice = deploymentData?.find((a) => a.device_id === formValues.device_id);
-        const formDevice = new Device({ collar_id: existingDevice?.collar_id, ...formValues });
-        if (existingDevice && !_deepEquals(new Device(existingDevice), formDevice)) {
-          //Verify whether the data entered in the form changed from the device metadata we already have.
-          try {
-            await telemetryApi.devices.upsertCollar(formDevice); //If it's different, upsert. Note that this alone does not touch a deployment.
-          } catch (e) {
-            setPopup(`Failed to update device ${formDevice.device_id}`);
-          }
-        }
-        for (const formDeployment of formValues.deployments ?? []) {
-          //Iterate over the deployments under this device.
-          const existingDeployment = deploymentData?.find((a) => a.deployment_id === formDeployment.deployment_id); //Find the deployment info we already have.
-          if (
-            !datesSameNullable(formDeployment?.attachment_start, existingDeployment?.attachment_start) ||
-            !datesSameNullable(formDeployment?.attachment_end, existingDeployment?.attachment_end) //Helper function necessary for this date comparison since moment(null) !== moment(null) normally.
-          ) {
-            try {
-              await bhApi.survey.updateDeployment(projectId, surveyId, survey_critter_id, formDeployment);
-            } catch (e) {
-              setPopup(`Failed to update deployment ${formDeployment.deployment_id}`);
-            }
-          }
+    }
+  };
+
+  const updateDevice = async (formValues: IAnimalTelemetryDevice) => {
+    const existingDevice = deploymentData?.find((deployment) => deployment.device_id === formValues.device_id);
+    const formDevice = new Device({ collar_id: existingDevice?.collar_id, ...formValues });
+    if (existingDevice && !_deepEquals(new Device(existingDevice), formDevice)) {
+      try {
+        await telemetryApi.devices.upsertCollar(formDevice);
+      } catch (error) {
+        throw new Error(`Failed to update collar ${formDevice.collar_id}`);
+      }
+    }
+  };
+
+  const updateDeployments = async (formDeployments: IDeploymentTimespan[], survey_critter_id: number) => {
+    for (const formDeployment of formDeployments ?? []) {
+      const existingDeployment = deploymentData?.find(
+        (animalDeployment) => animalDeployment.deployment_id === formDeployment.deployment_id
+      );
+      if (
+        !datesSameNullable(formDeployment?.attachment_start, existingDeployment?.attachment_start) ||
+        !datesSameNullable(formDeployment?.attachment_end, existingDeployment?.attachment_end)
+      ) {
+        try {
+          await bhApi.survey.updateDeployment(projectId, surveyId, survey_critter_id, formDeployment);
+        } catch (error) {
+          throw new Error(`Failed to update deployment ${formDeployment.deployment_id}`);
         }
       }
-      setPopup('Updated deployment and device data successfully.');
+    }
+  };
+
+  const handleEditTelemetry = async (survey_critter_id: number, data: IAnimalTelemetryDeviceFile[]) => {
+    const errors: string[] = [];
+    for (const { attachmentFile, attachmentType, ...formValues } of data) {
+      try {
+        await uploadAttachment(attachmentFile, attachmentType);
+        await updateDevice(formValues);
+        await updateDeployments(formValues.deployments ?? [], survey_critter_id);
+      } catch (error) {
+        errors.push(`Device ${formValues.device_id} - ` + (error instanceof Error ? error.message : 'Unknown error'));
+      }
+    }
+    errors.length
+      ? setPopup('Failed to save some data: ' + errors.join(', '))
+      : setPopup('Updated deployment and device data successfully.');
+  };
+
+  const handleTelemetrySave = async (survey_critter_id: number, data: IAnimalTelemetryDeviceFile[]) => {
+    if (telemetryFormMode === TELEMETRY_DEVICE_FORM_MODE.ADD) {
+      await handleAddTelemetry(survey_critter_id, data);
+    } else if (telemetryFormMode === TELEMETRY_DEVICE_FORM_MODE.EDIT) {
+      await handleEditTelemetry(survey_critter_id, data);
     }
 
     setOpenDeviceDialog(false);