bckelley/cgm-remote-monitor
1
0
Fork 0
mirror of https://github.com/bckelley/cgm-remote-monitor.git synced 2026-08-24 03:14:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: cache filterForAge rejects ObjectId _id on MongoDB driver 5.x

Browse Source 
_.isEmpty(new ObjectId()) returns true on driver 5.x because ObjectId
no longer has enumerable own properties (Object.keys returns []).
This caused filterForAge() to silently drop all entries with ObjectId
_id from the server cache.

check. This correctly accepts ObjectId instances and strings while
still rejecting null, undefined, and empty string.

16 tests confirm the fix:
- 3 root cause tests (_.isEmpty regression)
- 7 filterForAge logic tests (old vs fixed behavior)
- 6 integration tests (actual cache.js with data-update events)

Fixes AAPS backfill display bug where entries were in MongoDB but
invisible on the chart when using API V3 (mongoCachedCollection
emits data-update with raw ObjectId _id).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Ben West
2026-03-25 14:05:28 -07:00
co-authored by Copilot
parent 95b4c5e277
commit f4e686c1fb
2 changed files with 132 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/server/cache.js
+1 -1
View File
@@ -51,7 +51,7 @@ function cache (env, ctx) {
function filterForAge(data, ageLimit) {
return _.filter(data, function hasId(object) {
const hasId = !_.isEmpty(object._id);
const hasId = object._id != null && object._id !== '';
const age = getObjectAge(object);
const isFresh = age >= ageLimit;
return isFresh && hasId;
tests/cache-objectid-compat.test.js
+131 -86
View File
@@ -4,8 +4,10 @@
* cache-objectid-compat.test.js
*
* Regression test: MongoDB driver 5.x ObjectId has no enumerable properties,
* so _.isEmpty(new ObjectId()) returns true. This breaks cache.js
* filterForAge() which uses `!_.isEmpty(object._id)` as the hasId check.
* so _.isEmpty(new ObjectId()) returns true. This broke cache.js
* filterForAge() which used `!_.isEmpty(object._id)` as the hasId check.
*
* Fix: replaced `!_.isEmpty(object._id)` with `object._id != null && object._id !== ''`
*
* On mongodb driver 3.x (v15.0.6), Object.keys(new ObjectID()) returned
* ['_bsontype','id'], making _.isEmpty return false (correct).
@@ -15,9 +17,6 @@
* ObjectId _id as empty).
*
* Affects: lib/server/cache.js filterForAge()
* Affects: Any code path that puts ObjectId _id documents into the cache
* without first converting _id to a string via processRawDataForRuntime().
*
* Related: AAPS backfill display bug (entries in MongoDB but invisible on chart)
*/
@@ -27,11 +26,11 @@ const should = require('should');
describe('Cache ObjectId compatibility', function () {
describe('_.isEmpty behavioral change with new ObjectId', function () {
describe('_.isEmpty behavioral change with new ObjectId (root cause)', function () {
it('REGRESSION: _.isEmpty(ObjectId) returns true on driver 5.x', function () {
it('_.isEmpty(ObjectId) returns true on driver 5.x (regression)', function () {
const oid = new ObjectId();
// This is the root cause: driver 5.x ObjectId has no enumerable keys
// driver 5.x ObjectId has no enumerable keys
Object.keys(oid).should.have.length(0);
_.isEmpty(oid).should.equal(true);
// But the ObjectId IS valid and non-null
@@ -44,20 +43,19 @@ describe('Cache ObjectId compatibility', function () {
_.isEmpty(stringId).should.equal(false);
});
it('processRawDataForRuntime converts ObjectId to string (mitigation)', function () {
it('processRawDataForRuntime converts ObjectId to string (existing mitigation)', function () {
const ddata = require('../lib/data/ddata')();
const doc = { _id: new ObjectId(), type: 'sgv', sgv: 120, date: Date.now() };
const processed = ddata.processRawDataForRuntime([doc]);
// After processing, _id should be a string
(typeof processed[0]._id).should.equal('string');
_.isEmpty(processed[0]._id).should.equal(false);
});
});
describe('filterForAge hasId check', function () {
describe('filterForAge fix verification', function () {
// Reproduce the exact filterForAge logic from cache.js
function filterForAge (data, ageLimit) {
// Reproduce the OLD (broken) logic for comparison
function filterForAgeOLD (data, ageLimit) {
return _.filter(data, function (object) {
var hasId = !_.isEmpty(object._id);
var age = object.mills || object.date;
@@ -66,88 +64,135 @@ describe('Cache ObjectId compatibility', function () {
});
}
// The FIXED logic (matches cache.js after the fix)
function filterForAgeFIXED (data, ageLimit) {
return _.filter(data, function (object) {
var hasId = object._id != null && object._id !== '';
var age = object.mills || object.date;
var isFresh = typeof age === 'number' && age >= ageLimit;
return isFresh && hasId;
});
}
const TWO_DAYS = 172800000;
it('FAILS: ObjectId _id is filtered out by hasId check', function () {
it('OLD: ObjectId _id is rejected (confirms the bug existed)', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = {
_id: new ObjectId(),
type: 'sgv',
sgv: 120,
mills: Date.now() - 3600000
var doc = { _id: new ObjectId(), type: 'sgv', sgv: 120, mills: Date.now() - 3600000 };
filterForAgeOLD([doc], ageLimit).should.have.length(0);
});
it('FIXED: ObjectId _id is accepted', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = { _id: new ObjectId(), type: 'sgv', sgv: 120, mills: Date.now() - 3600000 };
filterForAgeFIXED([doc], ageLimit).should.have.length(1);
});
it('FIXED: string _id still accepted', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = { _id: new ObjectId().toString(), type: 'sgv', sgv: 120, mills: Date.now() - 3600000 };
filterForAgeFIXED([doc], ageLimit).should.have.length(1);
});
it('FIXED: null _id still rejected', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = { _id: null, type: 'sgv', sgv: 120, mills: Date.now() - 3600000 };
filterForAgeFIXED([doc], ageLimit).should.have.length(0);
});
it('FIXED: undefined _id still rejected', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = { type: 'sgv', sgv: 120, mills: Date.now() - 3600000 };
filterForAgeFIXED([doc], ageLimit).should.have.length(0);
});
it('FIXED: empty string _id still rejected', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = { _id: '', type: 'sgv', sgv: 120, mills: Date.now() - 3600000 };
filterForAgeFIXED([doc], ageLimit).should.have.length(0);
});
it('FIXED: stale entries (older than retention) still rejected', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = { _id: new ObjectId(), type: 'sgv', sgv: 120, mills: Date.now() - (TWO_DAYS + 60000) };
filterForAgeFIXED([doc], ageLimit).should.have.length(0);
});
});
describe('actual cache.js integration', function () {
var env, ctx, cache;
beforeEach(function () {
env = require('../lib/server/env')();
// Minimal ctx with bus and ddata for cache initialization
var EventEmitter = require('events');
ctx = {
bus: new EventEmitter(),
ddata: require('../lib/data/ddata')()
};
var result = filterForAge([doc], ageLimit);
// BUG: entry with valid ObjectId _id is rejected
cache = require('../lib/server/cache')(env, ctx);
});
it('cache accepts ObjectId _id entries via insertData', function () {
var entries = [
{ _id: new ObjectId(), type: 'sgv', sgv: 120, date: Date.now() - 3600000, mills: Date.now() - 3600000 },
{ _id: new ObjectId(), type: 'sgv', sgv: 130, date: Date.now() - 3000000, mills: Date.now() - 3000000 }
];
var result = cache.insertData('entries', entries);
result.should.have.length(2);
});
it('cache accepts string _id entries via insertData', function () {
var entries = [
{ _id: new ObjectId().toString(), type: 'sgv', sgv: 120, date: Date.now() - 3600000, mills: Date.now() - 3600000 }
];
var result = cache.insertData('entries', entries);
result.should.have.length(1);
});
it('cache preserves ObjectId entries across data-update events', function () {
// Simulate mongoCachedCollection emitting data-update with ObjectId _id
var doc = { _id: new ObjectId(), type: 'sgv', sgv: 120, date: Date.now() - 3600000, mills: Date.now() - 3600000 };
ctx.bus.emit('data-update', { type: 'entries', op: 'update', changes: [doc] });
var result = cache.getData('entries');
result.should.have.length(1);
result[0].sgv.should.equal(120);
});
it('cache preserves mixed ObjectId and string _id entries', function () {
var entries = [
{ _id: new ObjectId(), type: 'sgv', sgv: 120, date: Date.now() - 3600000, mills: Date.now() - 3600000 },
{ _id: 'abc123string', type: 'sgv', sgv: 130, date: Date.now() - 3000000, mills: Date.now() - 3000000 }
];
var result = cache.insertData('entries', entries);
result.should.have.length(2);
});
it('cache rejects entries without _id', function () {
var entries = [
{ type: 'sgv', sgv: 120, date: Date.now() - 3600000, mills: Date.now() - 3600000 }
];
var result = cache.insertData('entries', entries);
result.should.have.length(0);
});
it('PASSES: string _id passes hasId check', function () {
var ageLimit = Date.now() - TWO_DAYS;
var doc = {
_id: new ObjectId().toString(),
type: 'sgv',
sgv: 120,
mills: Date.now() - 3600000
};
var result = filterForAge([doc], ageLimit);
result.should.have.length(1);
});
it('data-update with ObjectId _id does not evict existing cache entries', function () {
// Pre-populate cache with string _id entries (via dataloader path)
var existing = [
{ _id: new ObjectId().toString(), type: 'sgv', sgv: 100, date: Date.now() - 7200000, mills: Date.now() - 7200000 },
{ _id: new ObjectId().toString(), type: 'sgv', sgv: 110, date: Date.now() - 3600000, mills: Date.now() - 3600000 }
];
cache.insertData('entries', existing);
cache.getData('entries').should.have.length(2);
it('proposed fix: check _id != null instead of _.isEmpty', function () {
function filterForAgeFix (data, ageLimit) {
return _.filter(data, function (object) {
// Fix: use truthiness check instead of _.isEmpty
var hasId = object._id != null && object._id !== '';
var age = object.mills || object.date;
var isFresh = typeof age === 'number' && age >= ageLimit;
return isFresh && hasId;
});
}
// Now simulate API3 data-update with ObjectId _id
var newDoc = { _id: new ObjectId(), type: 'sgv', sgv: 140, date: Date.now() - 1800000, mills: Date.now() - 1800000 };
ctx.bus.emit('data-update', { type: 'entries', op: 'update', changes: [newDoc] });
var ageLimit = Date.now() - TWO_DAYS;
var doc = {
_id: new ObjectId(),
type: 'sgv',
sgv: 120,
mills: Date.now() - 3600000
};
var result = filterForAgeFix([doc], ageLimit);
// With the fix, ObjectId _id passes
result.should.have.length(1);
});
});
describe('mongoCachedCollection data-update path (API3)', function () {
it('REGRESSION: API3 insertOne emits data-update with ObjectId _id', function () {
// Simulates what mongoCachedCollection.updateInCache does
// It passes raw documents (ObjectId _id) to data-update
// WITHOUT going through processRawDataForRuntime
var doc = {
_id: new ObjectId(),
type: 'sgv',
sgv: 120,
date: Date.now() - 7200000, // 2 hours ago
mills: Date.now() - 7200000
};
// Simulate cache.dataChanged with mergeCacheArrays
var TWO_DAYS = 172800000;
var ageLimit = Date.now() - TWO_DAYS;
function filterForAge (data, ageLimit) {
return _.filter(data, function (object) {
var hasId = !_.isEmpty(object._id);
var age = object.mills || object.date;
var isFresh = typeof age === 'number' && age >= ageLimit;
return isFresh && hasId;
});
}
var filteredNew = filterForAge([doc], ageLimit);
// BUG: the ObjectId entry is dropped
filteredNew.should.have.length(0);
var result = cache.getData('entries');
// All 3 entries should be present (2 existing + 1 new)
result.should.have.length(3);
});
});
});