Add tests for iOS loop push notifications and websockets

.gitignore

@@ -10,6 +10,7 @@ bundle/bundle.out.js
 my.env
 my.*.env
 *.pem
+!/tests/fixtures/dummy_private_key.pem
 
 static/bower_components/
 .*.sw?

tests/fixtures/api/instance.js

@@ -26,8 +26,8 @@ function configure () {
 
     if (useHttps) {
       env.ssl = {
-        key: fs.readFileSync(path.join(__dirname, '../api3/localhost.key')),
-        cert: fs.readFileSync(path.join(__dirname, '../api3/localhost.crt'))
+        key: fs.readFileSync(path.join(__dirname, '../localhost.key')),
+        cert: fs.readFileSync(path.join(__dirname, '../localhost.crt'))
       };
     }
 
@@ -95,4 +95,4 @@ function configure () {
   return self;
 }
 
-module.exports = configure();
+module.exports = configure();

tests/fixtures/api3/instance.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var fs = require('fs')
+  , path = require('path')
   , language = require('../../../lib/language')()
   , api = require('../../../lib/api3/')
   , http = require('http')
@@ -29,8 +30,8 @@ function configure () {
 
     if (useHttps) {
       env.ssl = {
-        key: fs.readFileSync(__dirname + '/localhost.key'),
-        cert: fs.readFileSync(__dirname + '/localhost.crt')
+        key: fs.readFileSync(path.join(__dirname, '../localhost.key')),
+        cert: fs.readFileSync(path.join(__dirname, '../localhost.crt'))
       };
     }
 

tests/fixtures/dummy_private_key.pem

@@ -0,0 +1,6 @@
+This dummy private key is for automated tests of the APNs integration.
+-----BEGIN EC PRIVATE KEY-----
+MHcCAQEEIJo9Rialfygo3+p+oiCfvwIIZHq6T5decpNmliQWx1rBoAoGCCqGSM49
+AwEHoUQDQgAEmfZuXr6jYx2vk4r6rDM3lWs72IUhotjJjJm1pEVh/jpR0CSU+6Sz
+VcvH8jpN1xEvcYXwPtVjSGmyVkh9e92tOA==
+-----END EC PRIVATE KEY-----

tests/loopnotifications.test.js

@@ -0,0 +1,223 @@
+/**
+ * Wikipedia: Apple Push Notification service (APNs)
+ * https://en.wikipedia.org/wiki/Apple_Push_Notification_service
+ *
+ * APNs response doc:
+ * https://developer.apple.com/documentation/usernotifications/handling-notification-responses-from-apns
+ */
+
+'use strict';
+
+const fs = require('fs');
+const http2 = require('http2');
+const should = require('should');
+const request = require('supertest');
+const apn = require('@parse/node-apn');
+
+const instance = require('./fixtures/api/instance');
+const { guardedDrop } = require('./fixtures/test-guard');
+
+const fakeServerOpts = {
+  key: fs.readFileSync('./tests/fixtures/localhost.key')
+  , cert: fs.readFileSync('./tests/fixtures/localhost.crt')
+, };
+
+const API_SECRET_PLAINTEXT = 'this is my long pass phrase'
+const API_SECRET_HASH = 'b723e97aa97846eb92d5264f084b2823f57c4aa1';
+
+describe('iOS Loop push notifications', function() {
+  this.timeout(10000);
+
+  let fakeAPNServer;
+
+  /**
+   * Let's capture the HTTP request sent to APNs via "@parse/node-apn" npm package.
+   */
+  let capturedApnRequest;
+  let inst;
+  let OriginalApnProviderClass
+
+  before(function(done) {
+    // Use http2+tls since APNs and the @parse/node-apn only supports them.
+    fakeAPNServer = http2.createSecureServer(fakeServerOpts);
+
+    fakeAPNServer.on('listening', () => {
+      // More info about dynamic port: https://nodejs.org/docs/latest-v22.x/api/net.html#serverlistenport-host-backlog-callback
+      const dynamicPort = fakeAPNServer.address().port
+
+      class PatchedApnProvider extends apn.Provider {
+        constructor(options) {
+          options.address = 'localhost';
+          options.port = dynamicPort;
+          options.rejectUnauthorized = false;
+          super(options);
+        }
+      }
+      OriginalApnProviderClass = apn.Provider;
+      apn.Provider = PatchedApnProvider
+
+      // Generated with "openssl ecparam -name prime256v1 -genkey -noout -out dummy_private_key.pem"
+      process.env.LOOP_APNS_KEY = './tests/fixtures/dummy_private_key.pem';
+      process.env.LOOP_APNS_KEY_ID = 'fake_apns_key_id';
+      process.env.LOOP_DEVELOPER_TEAM_ID = 'fake_12345';
+      process.env.ENABLE = 'loop';
+
+      instance.create({ apiSecret: API_SECRET_PLAINTEXT }).then((createdInstance) => {
+        inst = createdInstance
+        const api = require('../lib/api')(inst.env, inst.ctx);
+        const api2 = require('../lib/api2')(inst.env, inst.ctx, api);
+
+        inst.app.use('/api/v1', api);
+        inst.app.use('/api/v2', api2);
+
+        request(inst.app)
+          .put('/api/v1/profile')
+          .set('api-secret', API_SECRET_HASH)
+          .send({
+            // iOS loop integration requires these are configured in the user profile.
+            // Presumably the Loop app uploads them to Nightscout automatically?
+            loopSettings: { deviceToken: 'fakedevicetoken', bundleIdentifier: 'fakebundleid' }
+          , })
+          .expect(200)
+          .end(err => {
+            if (err) return done(err)
+
+            inst.ctx.dataloader.update(inst.ctx.ddata, (err) => {
+              if (err) {
+                done(err)
+              } else {
+                done();
+              }
+            });
+          })
+      }).catch(err => done(err))
+    })
+
+    fakeAPNServer.listen(0);
+  });
+
+  beforeEach(function() {
+    capturedApnRequest = new Promise((resolve) => {
+      fakeAPNServer.once('stream', (stream, headers) => {
+        let body = '';
+        stream.on('data', chunk => (body += chunk));
+        stream.on('end', () => {
+          stream.respond({ ':status': 200, 'content-type': 'application/json' });
+          stream.end();
+          resolve({
+            json: JSON.parse(body)
+            , headers
+          });
+        });
+      });
+    });
+  });
+
+  after(function(done) {
+    inst.server.close();
+    inst.ctx.bus.teardown();
+
+    delete process.env.LOOP_APNS_KEY;
+    delete process.env.LOOP_APNS_KEY_ID;
+    delete process.env.LOOP_DEVELOPER_TEAM_ID;
+    delete process.env.ENABLE;
+
+    apn.Provider = OriginalApnProviderClass;
+
+    guardedDrop(inst.ctx.profile(), err => {
+      if (err) return done(err)
+
+      fakeAPNServer.close(done);
+    });
+  });
+
+  function postLoopNotification (jsonBody) {
+    return request(inst.app)
+      .post('/api/v2/notifications/loop')
+      .send(jsonBody)
+      .set('api-secret', API_SECRET_HASH)
+      .expect(200);
+  }
+
+  it('Sends carb entry with ', async function() {
+    await postLoopNotification({
+      eventType: 'Remote Carbs Entry'
+      , remoteCarbs: 5
+      , remoteAbsorption: 2
+      , otp: 'fakeotp'
+      , created_at: '2020-01-01T10:10:10'
+    });
+
+    const { json } = await capturedApnRequest;
+    json['carbs-entry'].should.equal(5);
+    json['absorption-time'].should.equal(2);
+    json['otp'].should.equal('fakeotp');
+    json['start-time'].should.equal('2020-01-01T10:10:10');
+  });
+
+  it('Sends payload with absorption-time after Remote Carbs Entry', async function() {
+    await postLoopNotification({
+      eventType: 'Remote Carbs Entry'
+      , remoteCarbs: 5
+    });
+
+    const { json } = await capturedApnRequest;
+    json['absorption-time'].should.equal(3);
+  });
+
+  it('Sends payload with bolus-entry field after Remote Bolus Entry', async function() {
+    await postLoopNotification({
+      eventType: 'Remote Bolus Entry'
+      , remoteBolus: 2.5
+    });
+
+    const { json } = await capturedApnRequest;
+    json['bolus-entry'].should.approximately(2.5, 0.01);
+  });
+
+  it('Sends payload with cancel-temporary-override after Temporary Override Cancel', async function() {
+    await postLoopNotification({
+      eventType: 'Temporary Override Cancel'
+    });
+
+    const { json } = await capturedApnRequest;
+    json['cancel-temporary-override'].should.equal('true');
+  });
+
+  it('Sends payload with override-name after Temporary Override', async function() {
+    await postLoopNotification({
+      eventType: 'Temporary Override'
+      , duration: 5
+      , reason: 'stress'
+    });
+
+    const { json } = await capturedApnRequest;
+    json['override-name'].should.equal('stress');
+  });
+
+  it('Sends valid JWT Bearer token in Authorization header', async function() {
+    await postLoopNotification({
+      eventType: 'Remote Bolus Entry'
+      , remoteBolus: 2.5
+    });
+
+    const { headers } = await capturedApnRequest;
+
+    should.exist(headers);
+    should(headers).have.property('authorization');
+    should(headers.authorization).match(/\s*[Bb]earer\s+/);
+
+    const rawJwt = headers['authorization'].replace(/\s*[Bb]earer\s+/, '');
+    const jwtComponents = rawJwt.split('.');
+    should(jwtComponents.length).equal(3);
+
+    const jwtHeader = JSON.parse(Buffer.from(jwtComponents[0], 'base64url').toString());
+    const jwtPayload = JSON.parse(Buffer.from(jwtComponents[1], 'base64url').toString());
+
+    jwtHeader.alg.should.equal('ES256');
+    jwtHeader.typ.should.equal('JWT');
+    jwtHeader.kid.should.equal('fake_apns_key_id');
+    jwtPayload.iss.should.equal('fake_12345');
+  });
+
+});