tabletcommand-location 2.3.8 → 2.4.1

package/src/location.ts

@@ -1,8 +1,10 @@
 import _ from "lodash";
 import {
+  AccountIndustry,
   Department,
   Location,
   CADVehicle,
+  LocationKindType,
   LocationVisibility,
 } from "tabletcommand-backend-models";
 import {
@@ -49,7 +51,20 @@ export function location(store: StoreModule) {
       }
     }
 
-    const userId = `${item.radioName}-${item.vehicleId}`; // Fake user id radioName - vehicleId
+    // Originally always was this fake id, but now can override these values
+    // If overridden then we use the values on the record instead of the fake userId
+    let userId = `${item.radioName}-${item.vehicleId}`; // Fake user id radioName - vehicleId
+    if (_.isString(item.userId) && _.trim(item.userId) !== "") {
+      userId = item.userId;
+    }
+    let session = userId;
+    if (_.isString(item.session) && _.trim(item.session) !== "") {
+      session = item.session;
+    }
+    let username = item.radioName;
+    if (_.isString(item.username) && _.trim(item.username) !== "") {
+      username = item.username;
+    }
 
     let sharingEnabled = false;
     let opAreaName = "";
@@ -72,7 +87,9 @@ export function location(store: StoreModule) {
       }
     }
     const deleteAfterDate = new Date(atDate.valueOf() + 1000 * 60 * locationStaleMinutes);
-    const personnelUUID = "";
+    const personnelUUID = _.isString(item.personnelUUID) ? item.personnelUUID : "";
+    const transponderUUID = _.isString(item.transponderUUID) ? item.transponderUUID : "";
+    const industry: AccountIndustry = department?.industry ?? AccountIndustry.Fire; // If not set, fallback to fire
 
     const cadAVL: Partial<Location> = {
       device_type: deviceType,
@@ -86,10 +103,10 @@ export function location(store: StoreModule) {
       modified: atDate,
       movedAt: new Date(movedAtUnix * 1000),
       active: true,
-      username: item.radioName,
+      username,
       userId,
       departmentId: String(department._id),
-      session: userId,
+      session,
       version: 2,
       shared: sharingEnabled,
       sendToCAD: false,
@@ -98,6 +115,8 @@ export function location(store: StoreModule) {
       state: deptState,
       visibility: [], // will be updated after .active is set
       personnelUUID,
+      transponderUUID,
+      industry,
     };
 
     if (_.isNumber(item.speed)) {
@@ -165,12 +184,46 @@ export function location(store: StoreModule) {
     return cadItem;
   }
 
+  // Returns true when the item is a person location and was fully handled here
+  // Returns false if trying to handle vehicle item
+  async function processPersonItem(decoded: DecodedLocation, item: LocationPayload, atDate: Date): Promise<boolean> {
+    const isPerson = decoded.cadAVL.kindType === LocationKindType.Person ||
+      decoded.cadAVL.locationType === LocationKindType.Person;
+    if (!isPerson) {
+      return false;
+    }
+    const hasPersonnelUUID = _.isString(decoded.cadAVL.personnelUUID) && decoded.cadAVL.personnelUUID !== "";
+    const hasTransponderUUID = _.isString(decoded.cadAVL.transponderUUID) && decoded.cadAVL.transponderUUID !== "";
+    if (!hasPersonnelUUID && !hasTransponderUUID) {
+      // A person Location with neither personnelUUID nor transponderUUID
+      // would leak into the vehicle sync endpoints (they filter on
+      // personnelUUID: "") so to process person must have one or other
+      debug(`skipping person location without personnelUUID/transponderUUID: ${JSON.stringify(item)}`);
+      return true;
+    }
+    // Person records: no CAD vehicle, always active/visible, never shared or CAD.
+    // Stamp kindType so records classified by locationType alone still match
+    // the person feed query (kindType: "person")
+    decoded.cadAVL.kindType = LocationKindType.Person;
+    decoded.cadAVL.active = true;
+    decoded.cadAVL.shared = false;
+    decoded.cadAVL.sendToCAD = false;
+    decoded.cadAVL.visibility = [LocationVisibility.Visible];
+    await store.updateLocation(decoded.cadAVL, atDate);
+    return true;
+  }
+
   async function processItems(department: Partial<Department>, items: LocationPayload[], atDate: Date) {
     for (const item of items) {
       const decoded = decodeLocation(item, department, atDate, "cad");
       debug(`processCADVehicleLocation item: ${JSON.stringify(item)} d:${JSON.stringify(department)} at: ${atDate.toISOString()}.`);
       if (!decoded.isValid) {
-        return;
+        // Skip only the invalid item, not the rest of the batch
+        continue;
+      }
+
+      if (await processPersonItem(decoded, item, atDate)) {
+        continue;
       }
 
       let active = true;
@@ -203,7 +256,15 @@ export function location(store: StoreModule) {
       const decoded = decodeLocation(item, department, atDate, "geotab");
       debug(`processItemsDeviceMappingGeotab item: ${JSON.stringify(item)} d:${JSON.stringify(department)} at: ${atDate.toISOString()}.`);
       if (!decoded.isValid) {
-        return;
+        // Skip only the invalid item, not the rest of the batch
+        // This is actually a fix for vehicle processing as well
+        continue;
+      }
+
+      // Defensive code technically we shouldn't be getting here with person
+      // But it would still be valid to use this with a person so added the logic
+      if (await processPersonItem(decoded, item, atDate)) {
+        continue;
       }
 
       let active = true;

package/src/query.ts

@@ -0,0 +1,492 @@
+import {
+  FilterQuery,
+  ProjectionType,
+  SortOrder,
+} from "mongoose";
+
+import {
+  Location,
+} from "tabletcommand-backend-models";
+
+export type MQP = {
+  list: FilterQuery<Location>,
+  projection: ProjectionType<Location>,
+  sortBy?: Record<string, SortOrder>,
+};
+
+export type AdminListLocationParams1 = {
+  departmentId: string,
+  movedAt: Date,
+  showAll?: boolean,
+};
+
+export type AdminListLocationParams2 = {
+  departmentId: string,
+  movedAt: Date,
+  longitude: number,
+  latitude: number,
+  diagonal: number,
+  showAll?: boolean,
+};
+
+export type SyncModifiedDate = {
+  modifiedDate: Date,
+};
+
+export const metersToRadians = 6378100; // The equatorial radius of the Earth in meters
+
+function centerSphereFilter(longitude: number, latitude: number, diagonal: number) {
+  return {
+    $geoWithin: {
+      $centerSphere: [
+        [longitude, latitude],
+        diagonal / metersToRadians,
+      ] as [[number, number], number],
+    },
+  };
+}
+
+// Transponder-tracked person records carry an empty personnelUUID;
+// they surface via the person/responder feeds, never in unit/vehicle lists
+const excludePersonAndTransponderRecords = [
+  {
+    $or: [
+      { personnelUUID: "" },
+      { personnelUUID: { $exists: false } }, // TODO: Remove $exists check once all location services are running the latest
+    ],
+  },
+  {
+    $or: [
+      { transponderUUID: "" },
+      { transponderUUID: { $exists: false } },
+    ],
+  },
+];
+
+// Same fields defined in the frontend
+// api/a1/location/units and api/a1/location/units-shared
+const projectionAdmin = {
+  _id: 1,
+  active: 1,
+  altitude: 1,
+  color: 1,
+  device_type: 1,
+  kindType: 1,
+  location: 1,
+  locationGeoJSON: 1,
+  modified: 1,
+  movedAt: 1,
+  sendToCAD: 1,
+  source: 1,
+  speed: 1,
+  uuid: 1, // Legacy, remove later
+};
+
+export function adminListLocations(params: AdminListLocationParams1): MQP {
+  const {
+    departmentId,
+    movedAt,
+    showAll,
+  } = params;
+
+  const query: FilterQuery<Location> = {
+    // TODO: Replace models.Location active: true with visibility in "visible"
+    active: true,
+    departmentId,
+    $and: excludePersonAndTransponderRecords,
+    kindType: {
+      $ne: "uav",
+    },
+    // 03/14/23 (Joe) - Trying movedAt only [sc-11794] - determined modified was being overwritten by cad vehicle status updates
+    movedAt: {
+      $gte: movedAt,
+    },
+  };
+  if (showAll) {
+    delete query.active;
+  }
+
+  return {
+    list: query,
+    projection: projectionAdmin,
+  };
+}
+
+export function adminListPersonLocations(params: AdminListLocationParams1): MQP {
+  const {
+    departmentId,
+    movedAt,
+    showAll
+  } = params;
+
+  const query: FilterQuery<Location> = {
+    active: true,
+    departmentId,
+    kindType: "person",
+    movedAt: {
+      $gte: movedAt,
+    },
+  };
+  if (showAll) {
+    delete query.active;
+  }
+
+  // Same fields defined in the frontend
+  // api/a1/location/person
+  const projection = {
+    _id: 1,
+    active: 1,
+    altitude: 1,
+    color: 1,
+    device_type: 1,
+    kindType: 1,
+    location: 1,
+    locationGeoJSON: 1,
+    modified: 1,
+    movedAt: 1,
+    personnelUUID: 1,
+    sendToCAD: 1,
+    source: 1,
+    speed: 1,
+    transponderUUID: 1,
+    uuid: 1, // Legacy, remove later
+  };
+
+  return {
+    list: query,
+    projection,
+  };
+}
+
+export function adminListUAVLocations(params: AdminListLocationParams1): MQP {
+  const {
+    departmentId,
+    movedAt,
+    showAll,
+  } = params;
+
+  const query: FilterQuery<Location> = {
+    active: true,
+    departmentId,
+    kindType: "uav",
+    movedAt: {
+      $gte: movedAt,
+    },
+  };
+  if (showAll) {
+    delete query.active;
+  }
+
+  const projection = {
+    _id: 1,
+    active: 1,
+    agencyCode: 1,
+    agencyName: 1,
+    altitude: 1,
+    color: 1,
+    device_type: 1,
+    heading: 1,
+    kindType: 1,
+    locationGeoJSON: 1,
+    modified: 1,
+    movedAt: 1,
+    opAreaCode: 1,
+    opAreaName: 1,
+    sendToCAD: 1,
+    source: 1,
+    speed: 1,
+    state: 1,
+    userId: 1,
+    username: 1,
+    uuid: 1, // Legacy, remove later
+    vehicleId: 1,
+  };
+
+  return {
+    list: query,
+    projection,
+  };
+}
+
+export function adminListAircraftLocations(params: AdminListLocationParams2): MQP {
+  const {
+    departmentId,
+    movedAt,
+    longitude,
+    latitude,
+    diagonal
+  } = params;
+
+  const list = {
+    shared: true,
+    active: true,
+    source: "ADSB",
+    kindType: {
+      $in: ["fixed-wing", "helicopter"],
+    },
+    departmentId: {
+      $ne: departmentId,
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    },
+    locationGeoJSON: centerSphereFilter(longitude, latitude, diagonal),
+  };
+
+  return {
+    list,
+    projection: projectionAdmin,
+  };
+}
+
+export function adminListSharedLocations(params: AdminListLocationParams2): MQP {
+  const {
+    departmentId,
+    movedAt,
+    longitude,
+    latitude,
+    diagonal
+  } = params;
+
+  const listSharedAVLQuery = {
+    shared: true,
+    active: true,
+    source: {
+      $ne: "ADSB"
+    },
+    departmentId: {
+      $ne: departmentId,
+    },
+    kindType: {
+      $ne: "uav",
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    },
+    locationGeoJSON: centerSphereFilter(longitude, latitude, diagonal),
+  };
+
+  return {
+    list: listSharedAVLQuery,
+    projection: projectionAdmin,
+  };
+}
+
+export function adminListFocusedLocations(params: AdminListLocationParams2): MQP {
+  const {
+    departmentId,
+    movedAt,
+    longitude,
+    latitude,
+    diagonal,
+    showAll
+  } = params;
+
+  const listFocusedAVLQuery: FilterQuery<Location> = {
+    active: true,
+    departmentId,
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    },
+    locationGeoJSON: centerSphereFilter(longitude, latitude, diagonal),
+  };
+
+  if (showAll) {
+    delete listFocusedAVLQuery.locationGeoJSON;
+  }
+
+  return {
+    list: listFocusedAVLQuery,
+    projection: projectionAdmin,
+  };
+}
+
+// Sync queries
+
+const projectionSync: ProjectionType<Location> = {
+  active: 1,
+  departmentId: 1,
+  device_type: 1, // used in web ui
+  location: 1,
+  locationGeoJSON: 1,
+  modified: 1,
+  userId: 1,
+  username: 1,
+  uuid: 1, // used in iOS
+  // both used by AVL sharing
+  opAreaName: 1,
+  opAreaCode: 1,
+  shared: 1,
+  state: 1,
+  // v3
+  altitude: 1,
+  speed: 1,
+  movedAt: 1,
+  agencyName: 1,
+  agencyCode: 1,
+  // v4
+  color: 1,
+  colorChangedAt: 1,
+  propsChangedAt: 1,
+  heading: 1,
+  // v4 extra
+  kindType: 1,
+  source: 1,
+  personnelUUID: 1,
+  transponderUUID: 1,
+  // v4 kind/type/locationType
+  kind: 1,
+  type: 1,
+  locationType: 1,
+  kindColor: 1,
+};
+
+export function syncListSharedLocations(params: AdminListLocationParams2 & SyncModifiedDate): MQP {
+  const {
+    departmentId,
+    modifiedDate,
+    movedAt,
+    longitude,
+    latitude,
+    diagonal,
+  } = params;
+
+  const list: FilterQuery<Location> = {
+    shared: true,
+    source: {
+      $nin: ["ADSB", "DroneSense"]
+    },
+    departmentId: {
+      $ne: departmentId,
+    },
+    modified: {
+      $gte: modifiedDate.toISOString(),
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    },
+    locationGeoJSON: centerSphereFilter(longitude, latitude, diagonal),
+  };
+
+  return {
+    list,
+    projection: projectionSync,
+  };
+}
+
+export function syncListLocations(params: AdminListLocationParams1 & SyncModifiedDate): MQP {
+  const {
+    departmentId,
+    modifiedDate,
+    movedAt,
+  } = params;
+
+  const list: FilterQuery<Location> = {
+    departmentId,
+    $and: excludePersonAndTransponderRecords,
+    kindType: {
+      $ne: "uav"
+    },
+    modified: {
+      $gte: modifiedDate.toISOString(),
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    }
+  };
+
+  return {
+    list,
+    projection: projectionSync,
+  };
+}
+
+export function syncListPersonLocations(params: AdminListLocationParams1 & SyncModifiedDate): MQP {
+  const {
+    departmentId,
+    modifiedDate,
+    movedAt,
+  } = params;
+
+  const list: FilterQuery<Location> = {
+    departmentId,
+    kindType: "person",
+    modified: {
+      $gte: modifiedDate.toISOString(),
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    },
+  };
+
+  return {
+    list,
+    projection: projectionSync,
+  };
+}
+
+export function syncListAircraftLocations(params: AdminListLocationParams2 & SyncModifiedDate): MQP {
+  const {
+    departmentId,
+    movedAt,
+    modifiedDate,
+    // Possibly missing
+    longitude,
+    latitude,
+    diagonal
+  } = params;
+
+  const list: FilterQuery<Location> = {
+    shared: true,
+    source: "ADSB",
+    kindType: {
+      $in: ["fixed-wing", "helicopter"]
+    },
+    departmentId: {
+      $ne: departmentId,
+    },
+    modified: {
+      $gte: modifiedDate.toISOString(),
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    }
+  };
+
+  const hasCoordinate = Math.abs(latitude) > 0.01 || Math.abs(longitude) > 0.01;
+  const validCoordinate = Math.abs(latitude) < 90 && Math.abs(longitude) < 180;
+  const filterOnLocation = hasCoordinate && validCoordinate;
+  if (filterOnLocation) {
+    list.locationGeoJSON = centerSphereFilter(longitude, latitude, diagonal);
+  }
+
+  return {
+    list,
+    projection: projectionSync,
+  };
+}
+
+export function syncListUAVLocations(params: AdminListLocationParams1 & SyncModifiedDate): MQP {
+  const {
+    departmentId,
+    modifiedDate,
+    movedAt,
+
+  } = params;
+
+  const list: FilterQuery<Location> = {
+    departmentId,
+    kindType: "uav",
+    modified: {
+      $gte: modifiedDate.toISOString(),
+    },
+    movedAt: {
+      $gte: movedAt.toISOString(),
+    },
+  };
+
+  return {
+    list,
+    projection: projectionSync,
+  };
+}

package/src/store.ts

@@ -2,6 +2,7 @@ import debugModule from "debug";
 import {
   DepartmentModel,
   Location,
+  LocationKindType,
   LocationModel,
   CADVehicleModel,
   CADVehicle,
@@ -48,14 +49,43 @@ export function store(
     return await cadVehicleModel.findOneAndUpdate(query, item, options);
   }
 
+  function isDuplicateKeyError(error: unknown): boolean {
+    return _.isObject(error) && (error as { code?: number }).code === 11000;
+  }
+
   async function updateLocation(item: Partial<Location>, atDate: Date) {
+    try {
+      await performUpdateLocation(item, atDate);
+    } catch (error) {
+      if (!isDuplicateKeyError(error)) {
+        throw error;
+      }
+      // A concurrent first-write hit the unique (departmentId, session, device_type)
+      // index; the record exists now so we can retry once, so this update goes through.
+      await performUpdateLocation(item, atDate);
+    }
+  }
+
+  async function performUpdateLocation(item: Partial<Location>, atDate: Date) {
     // eslint-disable-next-line new-cap
     const modelItem = new locationModel(item);
-    const query = {
-      device_type: modelItem.device_type,
-      departmentId: modelItem.departmentId,
-      username: modelItem.username
-    };
+    const hasPersonIdentity = (_.isString(modelItem.personnelUUID) && modelItem.personnelUUID !== "") ||
+      (_.isString(modelItem.transponderUUID) && modelItem.transponderUUID !== "");
+    const isPerson = (modelItem.kindType === LocationKindType.Person || modelItem.locationType === LocationKindType.Person) &&
+      hasPersonIdentity;
+    // Person records upsert by session (their stable identity key); username is
+    // display-only for transponder stuff, so renames must not create new records from updates
+    const query = isPerson
+      ? {
+          device_type: modelItem.device_type,
+          departmentId: modelItem.departmentId,
+          session: modelItem.session
+        }
+      : {
+          device_type: modelItem.device_type,
+          departmentId: modelItem.departmentId,
+          username: modelItem.username
+        };
     debug(`Location.findOne: ${JSON.stringify(query)}`);
     const dbItem = await locationModel.findOne(query).lean().exec() as Partial<LocationObject>;
     const cloneItem = { ...dbItem };
@@ -95,6 +125,25 @@ export function store(
     dbItem.locationGeoJSON = modelItem.locationGeoJSON;
     dbItem.source = modelItem.source;
     dbItem.kindType = modelItem.kindType;
+    dbItem.industry = modelItem.industry;
+    // Carry person/category fields on the update path; only overwrite when the
+    // incoming payload actually provides a value, so sources that don't send
+    // these fields don't wipe values written by other sources.
+    if (_.isString(modelItem.locationType) && modelItem.locationType !== "") {
+      dbItem.locationType = modelItem.locationType;
+    }
+    if (_.isString(modelItem.kind) && modelItem.kind !== "") {
+      dbItem.kind = modelItem.kind;
+    }
+    if (_.isString(modelItem.type) && modelItem.type !== "") {
+      dbItem.type = modelItem.type;
+    }
+    if (_.isString(modelItem.personnelUUID) && modelItem.personnelUUID !== "") {
+      dbItem.personnelUUID = modelItem.personnelUUID;
+    }
+    if (_.isString(modelItem.transponderUUID) && modelItem.transponderUUID !== "") {
+      dbItem.transponderUUID = modelItem.transponderUUID;
+    }
 
     // Propagate sharedAVL items
     dbItem.opAreaCode = modelItem.opAreaCode;
@@ -135,6 +184,7 @@ export function store(
       "shared",
       "state",
       "username",
+      "industry",
     ];
     if (_.intersection(updatedKeys, propsKeys).length > 0) {
       locationDelta.propsChangedAt = atDate;