Send template updates to Apple Wallet passes (#6)

.github/pull_request_template.md

@@ -10,6 +10,10 @@
 
 <!--- Please describe in detail how you tested your changes. -->
 
+- [ ] Status checks pass
+- [ ] Works on Goerli
+- [ ] Works on Mainnet
+
 ## Are There Admin Tasks?
 
 <!--- Please include any related admin tasks, like adding/changing environment variables in Vercel. -->

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build and Lint
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: server
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        cache-dependency-path: server/package-lock.json
+    - run: npm install
+
+    - run: npm run build
+    - run: npm run lint

.github/workflows/integration_tests.yml

@@ -0,0 +1,34 @@
+name: Integration Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: server
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        cache-dependency-path: server/package-lock.json
+    - run: npm install
+
+    - run: cp .env.local.goerli .env.local
+    - run: npm run e2e:headless

.github/workflows/node.js.yml → .github/workflows/unit_tests.yml

@@ -1,7 +1,4 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
+name: Unit Tests
 
 on:
   push:
@@ -32,10 +29,7 @@ jobs:
         cache: 'npm'
         cache-dependency-path: server/package-lock.json
     - run: npm install
-    - run: npm run build
-    - run: npm run lint
+
     - run: npm run test
     - run: npm run test:coverage
     - uses: codecov/codecov-action@v3
-    - run: cp .env.local.goerli .env.local
-    - run: npm run e2e:headless

server/README.md

@@ -15,6 +15,15 @@ Run unit tests:
 npm run test
 ```
 
+## Code Coverage
+
+[![codecov](https://codecov.io/gh/nation3/mobile-passport/branch/main/graph/badge.svg)](https://codecov.io/gh/nation3/mobile-passport)
+
+Run code coverage:
+```
+npm run test:coverage
+```
+
 ## Add the file with local environment variables
 
 ```

server/cypress/e2e/api/apple/[passTypeIdentifier].cy.ts

@@ -0,0 +1,38 @@
+describe('Get the List of Updatable Passes', () => {
+
+  it('error when wrong request method (POST instead of GET)', () => {
+    cy.request({
+      method: 'POST',
+      url: '/api/apple/v1/devices/b33e3a3dccb3030333e3333da33333a3/registrations/pass.org.passport.nation3',
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400)
+      expect(JSON.stringify(response.body)).to.contain('Request Not Authorized: Wrong request method')
+    })
+  })
+
+  it('204 when unknown deviceLibraryIdentifier', () => {
+    cy.request({
+      method: 'GET',
+      url: '/api/apple/v1/devices/cypress_b00e3a3dccb3030333e3333da33333a3/registrations/pass.org.passport.nation3',
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(204)
+    })
+  })
+
+  it('200 when existing deviceLibraryIdentifier', () => {
+    cy.request({
+      method: 'GET',
+      url: '/api/apple/v1/devices/cypress_b33e3a3dccb3030333e3333da33333a3/registrations/pass.org.passport.nation3',
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(200)
+      expect(JSON.stringify(response.body)).to.contain('serialNumbers')
+      expect(JSON.stringify(response.body)).to.contain('lastUpdated')
+      // TODO: verify serial number value(s)
+    })
+  })
+})
+
+export {}

server/cypress/e2e/api/apple/log.cy.ts

@@ -0,0 +1,32 @@
+describe('Log a Message', () => {
+
+  it('error when wrong request method (GET instead of POST)', () => {
+    cy.request({
+      method: 'GET',
+      url: '/api/apple/v1/log',
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(401)
+      expect(JSON.stringify(response.body)).to.contain('Request Not Authorized: Wrong request method')
+    })
+  })
+
+  it('success when POST request', () => {
+    cy.request({
+      method: 'POST',
+      url: '/api/apple/v1/log',
+      body: {
+        logs: [
+          '[2022-09-06 09:14:07 +0800] Get serial #s task (for device b33e3a3dccb3030333e3333da33333a3, pass type pass.org.passport.nation3, last updated (null); with web service url https://passports.nation3.org/api/apple) encountered error: Unexpected response code 404',
+          '[2022-09-06 09:14:07 +0800] Get serial #s task (for device b33e3a3dccb3030333e3333da33333a3, pass type pass.org.passport.nation3, last updated (null); with web service url https://passports.nation3.org/api/apple) encountered error: Unexpected response code 404'
+        ]
+      },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(200)
+      expect(JSON.stringify(response.body)).to.contain('OK')
+    })
+  })
+})
+
+export {}

server/cypress/e2e/api/apple/v1/passes/[passTypeIdentifier]/[serialNumber].cy.ts

@@ -0,0 +1,44 @@
+import crypto from 'crypto'
+
+describe('Send an Updated Pass', () => {
+
+  it('error when wrong request method (POST instead of GET)', () => {
+    cy.request({
+      method: 'POST',
+      url: '/api/apple/v1/passes/pass.org.passport.nation3/333',
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(401)
+      expect(JSON.stringify(response.body)).to.contain('Request Not Authorized: Wrong request method')
+    })
+  })
+
+  it('error when authentication token missing in header', () => {
+    cy.request({
+      method: 'GET',
+      url: '/api/apple/v1/passes/pass.org.passport.nation3/333',
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(401)
+      expect(JSON.stringify(response.body)).to.contain('Request Not Authorized: Missing/empty header: Authorization')
+    })
+  })
+
+  it('success when valid authentication token in header', () => {
+    cy.request({
+      method: 'GET',
+      url: '/api/apple/v1/passes/pass.org.passport.nation3/333',
+      headers: {
+        'Authorization': 'ApplePass 0x3fbeb3ae33af3fb33f3d33333303d333a333aff33f3133efbc3330333adb333a'
+      },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(200)
+      expect(response.headers).to.include({
+        'content-type': 'application/vnd.apple.pkpass'
+      })
+    })
+  })
+})
+
+export {}

server/cypress/e2e/api/downloadPass.cy.ts

@@ -46,7 +46,9 @@ describe('/api/downloadPass', () => {
       failOnStatusCode: false
     }).then((response) => {
       expect(response.status).to.eq(200)
-      // expect(JSON.stringify(response.body)).to.contain('Invalid signature')
+      expect(response.headers).to.include({
+        'content-type': 'application/vnd.apple.pkpass'
+      })
     })
   })
 })

server/db-migrations/0.7.0.sql

@@ -0,0 +1,11 @@
+create type platform as enum ('Apple', 'Google');
+create table downloads (
+  id bigint generated by default as identity primary key,
+  time_of_download timestamp without time zone default now() not null,
+  platform platform not null,
+  template_version int not null,
+  passport_id bigint not null,
+  issue_date timestamp without time zone not null,
+  address text not null,
+  ens_name text
+);

server/db-migrations/0.8.0.sql

@@ -0,0 +1,2 @@
+delete from registrations;
+alter table registrations add column template_version int not null;

server/interfaces/index.ts

@@ -13,5 +13,5 @@ export interface GooglePass extends Pass {
 
 export enum Platform {
   Apple,
-  Google,
+  Google
 }

server/jest.config.js

@@ -4,7 +4,7 @@ module.exports = {
   testEnvironment: 'node',
   coverageThreshold: {
     global: {
-      lines: 18.55
+      lines: 80.00
     }
   }
 }