@justair/justair-library 7.5.0-alpha.c87c244 → 7.5.0-alpha.d0806df

package/dist/constants/deviceTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deviceTypes.d.ts","sourceRoot":"","sources":["../../src/constants/deviceTypes.js"],"names":[],"mappings":"AA0BA;;;;GAIG;AAEH,0FAA6E;AAiBtE,iEAEoC;;;;;;yBAL9B,CAAA,OAAO,YAAY,EAAC,MAAM,OAAO,YAAY,CAAC"}
+{"version":3,"file":"deviceTypes.d.ts","sourceRoot":"","sources":["../../src/constants/deviceTypes.js"],"names":[],"mappings":"AA0BA;;;;GAIG;AAEH,0FAA6E;AAiBtE,iEAEoC;;;;;;yBAZ9B,CAAA,OAAO,YAAY,EAAC,MAAM,OAAO,YAAY,CAAC"}

package/dist/utils/subscribedDevices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscribedDevices.d.ts","sourceRoot":"","sources":["../../src/utils/subscribedDevices.js"],"names":[],"mappings":"AA4EA;;;;;GAKG;AAyII,8DANI,KAAK,CAAC;IAAE,QAAQ,EAAE,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC;IAC1D,UAAU,EAAE,OAAO,6BAA6B,EAAE,UAAU,CAAA;CAAE,CAAC,8BACzD;IAAE,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,KAC7E,OAAO,CAAC,KAAK,CAAC,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,CAAA;CAAE,GAC9D,OAAO,CAAC,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CA0BxD"}
+{"version":3,"file":"subscribedDevices.d.ts","sourceRoot":"","sources":["../../src/utils/subscribedDevices.js"],"names":[],"mappings":"AAqFA;;;;;GAKG;AA4II,8DANI,KAAK,CAAC;IAAE,QAAQ,EAAE,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC;IAC1D,UAAU,EAAE,OAAO,6BAA6B,EAAE,UAAU,CAAA;CAAE,CAAC,8BACzD;IAAE,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,KAC7E,OAAO,CAAC,KAAK,CAAC,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,CAAA;CAAE,GAC9D,OAAO,CAAC,OAAO,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CA0BxD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justair/justair-library",
-  "version": "7.5.0-alpha.c87c244",
+  "version": "7.5.0-alpha.d0806df",
   "description": "JustAir Internal Library",
   "main": "src/index.js",
   "type": "module",

package/src/constants/deviceTypes.js

@@ -32,13 +32,6 @@ export const DEVICE_TYPES = Object.freeze({
 
 export const DEVICE_TYPE_VALUES = Object.freeze(Object.values(DEVICE_TYPES));
 
-// Whether a device of this type can ever report AQI, and therefore whether a
-// subscription to it can contribute to AQI alert delivery.
-//
-// Note the asymmetry: `sample-site` is unconditionally false, but a true result
-// for `linked-device` is necessary and NOT sufficient — a Site is only actually
-// AQI-capable when it links at least one monitor, which the type alone cannot
-// tell you. Callers must still check the Site's monitorIds.
 /**
  * The device-type vocabulary as a type, so consumers get autocomplete and a
  * compile error on a mis-cased value like "sampleSite" — the exact bug the
@@ -47,6 +40,13 @@ export const DEVICE_TYPE_VALUES = Object.freeze(Object.values(DEVICE_TYPES));
  * @typedef {typeof DEVICE_TYPES[keyof typeof DEVICE_TYPES]} DeviceType
  */
 
+// Whether a device of this type can ever report AQI, and therefore whether a
+// subscription to it can contribute to AQI alert delivery.
+//
+// Note the asymmetry: `sample-site` is unconditionally false, but a true result
+// for `linked-device` is necessary and NOT sufficient — a Site is only actually
+// AQI-capable when it links at least one monitor, which the type alone cannot
+// tell you. Callers must still check the Site's monitorIds.
 export const isAqiCapableDeviceType = (deviceType) =>
   deviceType === DEVICE_TYPES.MONITOR ||
   deviceType === DEVICE_TYPES.LINKED_DEVICE;

package/src/index.js

@@ -276,7 +276,8 @@ export {
   // Every consumer that writes a subscription recomputes the AQI audience with
   // this instead of re-implementing the per-device-type rule.
   // SUBSCRIBED_DEVICES_ERRORS is the stable `err.code` vocabulary for the
-  // throw above; consumers branch on it rather than on message wording.
+  // errors projectSubscribedMonitors throws; consumers branch on it rather
+  // than on message wording.
   projectSubscribedMonitors,
   SUBSCRIBED_DEVICES_ERRORS,
   // Utilities

package/src/utils/subscribedDevices.js

@@ -42,11 +42,20 @@
 //      { deviceId, deviceType: "monitor" } entry per existing id), then
 //      overwrite freely. This is the target state.
 //   2. Until that backfill has run for the user, union the projection with the
-//      existing subscribedMonitors instead of overwriting. THIS IS
-//      SUBSCRIBE-ONLY. A union can only ever add ids, so using it for an
-//      unsubscribe makes the removal a silent no-op. There is deliberately no
-//      third option: an unsubscribe on a user who predates subscribedDevices
-//      MUST run the per-user backfill in option 1 first, and only then
+//      existing subscribedMonitors instead of overwriting — AND write the
+//      per-user backfill in the same update, one
+//      { deviceId, deviceType: "monitor" } entry per id already in
+//      subscribedMonitors, alongside the device being subscribed. Both halves
+//      are required. Unioning without backfilling leaves a user who looks
+//      migrated (subscribedDevices is non-empty) but is not, so the obvious
+//      "has this user been backfilled?" check answers yes and the next
+//      unsubscribe overwrites subscribedMonitors with a projection missing
+//      every monitor they had before. A half-migrated user must never exist.
+//
+//      This path is also SUBSCRIBE-ONLY. A union can only ever add ids, so
+//      using it for an unsubscribe makes the removal a silent no-op. There is
+//      deliberately no third option: an unsubscribe on a user who predates
+//      subscribedDevices MUST be preceded by the backfill, and only then
 //      overwrite. Removing a subscription is not correct any other way.
 //
 // This module deliberately does NOT offer a `union: true` flag. A blanket
@@ -145,15 +154,10 @@ const validateResolvedSiteMonitorIds = (resolved) => {
     throw error;
   }
 
-  // Discriminating a document from an id without importing mongoose: both
-  // expose `_id`, because mongoose defines `_id` on ObjectId.prototype as a
-  // self-reference (`oid._id === oid`). A document's `_id` is a *different*
-  // object, so the self-reference is the test — checking merely for the
-  // presence of `_id` would reject every ordinary ObjectId.
-  // `.map` instead of `.flatMap` yields [[m1, m2]]. It is not caught by the
-  // document check (an array is not a plain object) and fails inconsistently
-  // downstream: one monitor per Site casts back to the id and silently works,
-  // two throws a CastError at write time, far from the cause.
+  // `.map` instead of `.flatMap` yields [[m1, m2]]. An array is not a plain
+  // object, so the document check below never sees it, and it fails
+  // inconsistently downstream: one monitor per Site casts back to the id and
+  // silently works, two throws a CastError at write time, far from the cause.
   if (resolved.some(Array.isArray)) {
     const error = new TypeError(
       "resolveSiteMonitorIds must resolve to a flat array of monitor ids"
@@ -162,9 +166,17 @@ const validateResolvedSiteMonitorIds = (resolved) => {
     throw error;
   }
 
+  // Discriminating a document from an id without importing mongoose: test for
+  // what only an id has. `toHexString` is on ObjectId (mongoose-patched or raw
+  // bson) and on nothing a Sites query returns, hydrated or lean.
+  //
+  // Deliberately not keyed on `_id`, which is wrong in both directions: every
+  // ObjectId appears to carry one (mongoose defines `_id` on ObjectId.prototype
+  // as a self-reference), and a lean read that projects it away
+  // (`Sites.find(..., "monitorIds -_id").lean()`) carries none.
   if (
     resolved.some(
-      (id) => isPlainObject(id) && id._id !== undefined && id._id !== id
+      (id) => isPlainObject(id) && typeof id.toHexString !== "function"
     )
   ) {
     const error = new TypeError(

package/src/utils/tests/subscribedDevices.test.js

@@ -1,4 +1,5 @@
 import mongoose from 'mongoose';
+import { Users } from '../../models/users.js';
 import {
   DEVICE_TYPE_VALUES,
   isAqiCapableDeviceType,
@@ -148,11 +149,42 @@ describe('projectSubscribedMonitors', () => {
     });
   });
 
+  test('rejects a lean Site read that projected _id away', async () => {
+    // The `_id`-based discriminator missed this: `Sites.find(..., "monitorIds
+    // -_id").lean()` yields objects carrying no _id at all, which would
+    // otherwise key as "[object Object]" in dedupeById and land in
+    // subscribedMonitors as junk.
+    await expect(
+      projectSubscribedMonitors([{ deviceId: oid(), deviceType: 'linked-device' }], {
+        resolveSiteMonitorIds: async () => [{ monitorIds: [oid()] }],
+      }),
+    ).rejects.toMatchObject({
+      code: SUBSCRIBED_DEVICES_ERRORS.RESOLVER_RETURNED_DOCUMENTS,
+    });
+  });
+
+  test('rejects a hydrated Site document (the forgot-.lean() case)', async () => {
+    // The likeliest real-world shape of this mistake. A throwaway model keeps
+    // this file off the real Sites schema; hydration needs no connection.
+    const HydratedSite = mongoose.model(
+      'SubscribedDevicesProbeSite',
+      new mongoose.Schema({ monitorIds: [mongoose.Schema.Types.ObjectId] }),
+    );
+
+    await expect(
+      projectSubscribedMonitors([{ deviceId: oid(), deviceType: 'linked-device' }], {
+        resolveSiteMonitorIds: async () => [new HydratedSite({ monitorIds: [oid()] })],
+      }),
+    ).rejects.toMatchObject({
+      code: SUBSCRIBED_DEVICES_ERRORS.RESOLVER_RETURNED_DOCUMENTS,
+    });
+  });
+
   test('does not mistake ordinary ObjectIds for documents', async () => {
-    // Regression guard for the discriminator: mongoose defines `_id` on
-    // ObjectId.prototype as a self-reference, so a naive "has _id" check
-    // rejects every legitimate resolver result. Only a differing `_id` marks
-    // an actual document.
+    // Regression guard for the discriminator: an id has `toHexString`, a Site
+    // document does not. Keying on `_id` instead gets it wrong both ways —
+    // mongoose defines `_id` on ObjectId.prototype as a self-reference, so a
+    // naive "has _id" check rejects every legitimate resolver result.
     const siteId = oid();
     const monitorId = oid();
 
@@ -341,6 +373,33 @@ describe('projectSubscribedMonitors', () => {
 // Nothing structural keeps them in step, so a fourth type added to one and not
 // the other would report as AQI-capable while contributing no audience — the
 // silent failure this module exists to prevent. This pins them together.
+// Every other case here passes plain object literals, but the real call site
+// hands in user.subscribedDevices — a mongoose DocumentArray of subdocuments,
+// which has to survive the isPlainObject filter. If it ever stopped doing so
+// every entry would be dropped and the projection would return an empty
+// audience with no error. Hydration needs no connection, so this stays DB-free.
+describe('accepts real mongoose subdocuments, not just object literals', () => {
+  test('projects a hydrated user.subscribedDevices the same as plain objects', async () => {
+    const monitorId = oid();
+    const siteId = oid();
+    const siteMonitorId = oid();
+
+    const user = new Users({
+      subscribedDevices: [
+        { deviceId: monitorId, deviceType: 'monitor' },
+        { deviceId: siteId, deviceType: 'linked-device' },
+        { deviceId: oid(), deviceType: 'sample-site' },
+      ],
+    });
+
+    await expect(
+      projectSubscribedMonitors(user.subscribedDevices, {
+        resolveSiteMonitorIds: async () => [siteMonitorId],
+      }),
+    ).resolves.toEqual([monitorId, siteMonitorId]);
+  });
+});
+
 describe('isAqiCapableDeviceType agrees with the projection', () => {
   test.each(DEVICE_TYPE_VALUES)('%s', async (deviceType) => {
     const deviceId = oid();