tabletcommand-location 2.4.2 → 2.4.3

package/.claude/worktrees/sc-36275/src/query.ts

@@ -0,0 +1,497 @@
+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,
+  industry: 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,
+    industry: 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,
+    industry: 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,
+  // v4
+  industry: 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", "Skydio"]
+    },
+    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/.claude/worktrees/sc-36275/src/store.ts

@@ -0,0 +1,204 @@
+import debugModule from "debug";
+import {
+  DepartmentModel,
+  Location,
+  LocationKindType,
+  LocationModel,
+  CADVehicleModel,
+  CADVehicle,
+  DeviceMappingModel,
+} from "tabletcommand-backend-models";
+import _ from "lodash";
+import { LocationObject, LocationPayload } from "./types";
+
+export function store(
+  departmentModel: DepartmentModel,
+  locationModel: LocationModel,
+  cadVehicleModel: CADVehicleModel,
+  deviceMappingModel: DeviceMappingModel
+) {
+  const debug = debugModule("tabletcommand-location:location:store");
+
+  async function getVehicle(item: LocationPayload, departmentId: string) {
+    const query = {
+      vehicleId: item.vehicleId,
+      departmentId,
+    };
+    return cadVehicleModel.findOne(query).lean();
+  }
+
+  async function getDeviceMappingGeotab(item: LocationPayload, departmentId: string) {
+    const query = {
+      deviceId: item.vehicleId,
+      departmentId,
+      deviceType: "geotab",
+    };
+    return deviceMappingModel.findOne(query).lean();
+  }
+
+  async function updateVehicle(item: Partial<CADVehicle>, departmentId: string) {
+    const query = {
+      departmentId,
+      vehicleId: item.vehicleId,
+    };
+    const options = {
+      upsert: true,
+      setDefaultsOnInsert: true,
+      new: true
+    };
+    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 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 };
+    let updatedItem = propagateLocation(modelItem, dbItem);
+    debug(`Location.save: ${JSON.stringify(updatedItem)}`);
+    if (cloneItem._id) {
+      const locationDelta = generateLocationDelta(cloneItem, updatedItem, atDate);
+      updatedItem = locationDelta;
+      debug(`Location.delta: ${JSON.stringify(locationDelta)}`);
+    } else {
+      // if new location record - Attempt to reconcile agency name and code to resources
+      // this is going to be resolved by the bin/cron-cleanup-minute cron
+    }
+    await locationModel.updateOne(query, {
+      $set: updatedItem,
+    }, {
+      upsert: true,
+    });
+  }
+
+  function propagateLocation(modelItem: Location, dbItem: Partial<LocationObject>) {
+    if (!_.isObject(dbItem)) {
+      return modelItem;
+    }
+
+    // We keep the same value for _id, uuid, departmentId
+    dbItem.altitude = modelItem.altitude;
+    dbItem.device_type = modelItem.device_type;
+    dbItem.heading = modelItem.heading;
+    dbItem.modified = modelItem.modified;
+    dbItem.movedAt = modelItem.movedAt;
+    dbItem.session = modelItem.session;
+    dbItem.speed = modelItem.speed;
+    dbItem.userId = modelItem.userId;
+    dbItem.username = modelItem.username;
+    dbItem.version = modelItem.version;
+    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;
+    dbItem.opAreaName = modelItem.opAreaName;
+    dbItem.state = modelItem.state;
+
+    // Legacy
+    dbItem.active = modelItem.active;
+    dbItem.shared = modelItem.shared;
+    dbItem.sendToCAD = modelItem.sendToCAD;
+    //
+    dbItem.visibility = modelItem.visibility;
+
+    return dbItem;
+  }
+
+  function generateLocationDelta(locationRecord: Partial<LocationObject>, updateObject: Partial<LocationObject>, atDate: Date) {
+    if (!_.isObject(locationRecord)) {
+      return updateObject;
+    }
+    const locationDelta: Partial<LocationObject> = {};
+    for (const [key, value] of Object.entries(updateObject)) {
+      // eslint-disable-next-line security/detect-object-injection
+      if (JSON.stringify(value) !== JSON.stringify(locationRecord[key])) {
+        // eslint-disable-next-line security/detect-object-injection
+        locationDelta[key] = value;
+      }
+    }
+
+    const updatedKeys = Object.keys(locationDelta);
+    const propsKeys = [
+      "active",
+      "agencyCode",
+      "agencyName",
+      "device_type",
+      "opAreaCode",
+      "opAreaName",
+      "shared",
+      "state",
+      "username",
+      "industry",
+    ];
+    if (_.intersection(updatedKeys, propsKeys).length > 0) {
+      locationDelta.propsChangedAt = atDate;
+    }
+
+    return locationDelta;
+  }
+
+  return {
+    getVehicle,
+    getDeviceMappingGeotab,
+    updateVehicle,
+    updateLocation,
+  };
+}
+export default store;
+export type StoreModule = ReturnType<typeof store>;