Send template updates to Apple Wallet passes (#6) #73

aahna-ashina · 2022-09-06T01:26:40Z

Send an Updated Pass

North Star Metric: Number of Active Citizens

Current metric: 12.43% of the 177 citizens voted on the last proposal.
Theory: Sending Nation3 updates to a citizen's Apple Pass when a new proposal is published will increase voting activity by at least 20%.

Dework Task

https://app.dework.xyz/nation3/app-2?taskId=fb541897-eb04-4c72-ba7d-838f3da72a3f
https://app.dework.xyz/nation3/app-2?taskId=d63e775a-1f47-4db3-b91e-2e7bd33d1e5a

Related GitHub Issue

#6
closes #33
closes #72

How Has This Been Tested?

e61226c Log a Message (integration test)
Added automated integration tests
- 9b71e6e
- 9f853c7
Tested manually with iOS device while observing Vercel logs
Tested /api/apple/v1/passes/pass.org.passport.nation3/<serialNumber> and opened the .pkpass on an iOS device
Sent request to api.push.apple.com while observing Vercel logs
5af5e57 Added unit tests for .pkpass file generation
5762a0b Added /apple/v1/log for testing Apple request responses

Are There Admin Tasks?

Database migration
- @aahna-ashina Run migration script in 0.7.0.sql (passports-goerli)
- @aahna-ashina Run migration script in 0.7.0.sql (passports-mainnet)
- @aahna-ashina Run migration script in 0.8.0.sql (passports-goerli)
- @aahna-ashina Run migration script in 0.8.0.sql (passports-mainnet)
- @aahna-ashina Run migration script in 0.9.0.sql (passports-goerli)
- @aahna-ashina Run migration script in 0.9.0.sql (passports-mainnet)

Are There Documentation Tasks?

4991d07 Add documentation for updating a template

vercel · 2022-09-06T01:26:45Z

@aahna-ashina is attempting to deploy a commit to the Nation3 Team on Vercel.

A member of the Team first needs to authorize it.

Return `serialNumbers`

…ahna-ashina/mobile-passport into dw-58/send-template-updates-to

codecov-commenter · 2022-09-07T04:43:02Z

Codecov Report

Merging #73 (2e04076) into main (f895969) will increase coverage by 61.35%.
The diff coverage is 81.25%.

@@             Coverage Diff             @@
##             main      #73       +/-   ##
===========================================
+ Coverage   19.65%   81.00%   +61.35%     
===========================================
  Files           5        5               
  Lines         173      179        +6     
  Branches       15       16        +1     
===========================================
+ Hits           34      145      +111     
+ Misses        138       33      -105     
  Partials        1        1

Impacted Files	Coverage Δ
server/utils/Config.ts	`90.90% <ø> (ø)`
server/utils/Passes.ts	`84.68% <81.25%> (+84.68%)`	⬆️
server/utils/AppleCryptoUtils.ts	`100.00% <0.00%> (+41.46%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

closes nation3#45

closes nation3#71

johnmark13

This looks great, I think that you are still working through your tasks and moving things around - so I have approved it with some comments.

johnmark13 · 2022-09-08T09:42:28Z

.github/workflows/integration_tests.yml

+        cache-dependency-path: server/package-lock.json
+    - run: npm install
+
+    - run: cp .env.local.goerli .env.local


I'd probably rename these files as .local is not usually checked into a repository, not a big deal though.

@johnmark13 The Goerli environment variables are needed for running unit tests and integration tests.

https://github.com/nation3/mobile-passport/blob/main/server/utils/AppleCryptoUtils.test.ts#L1

https://github.com/nation3/mobile-passport/blob/main/.github/workflows/node.js.yml#L40

johnmark13 · 2022-09-08T09:44:08Z

server/interfaces/index.ts

@@ -13,5 +13,5 @@ export interface GooglePass extends Pass {

 export enum Platform {
  Apple,
-  Google,
+  Google


Is this a Prettier change?

@johnmark13 No, haven't added Prettier config yet. Maybe we should? Added it to #76

johnmark13 · 2022-09-08T09:44:31Z

server/jest.config.js

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


johnmark13 · 2022-09-08T09:47:58Z

...r/pages/api/apple/v1/devices/[deviceLibraryIdentifier]/registrations/[passTypeIdentifier].ts

+            for (const index in result.data) {
+              const serialNumber : string = result.data[index]['serial_number']
+              serialNumbers[Number(index)] = String(serialNumber)
+            }


Can you use map instead serialNumbers = result.data.map((sn) => {your code here})?

@johnmark13 Yes, absolutely. I think we should do some refactoring as part of another pull request, and will keep this comment in mind. #76

johnmark13 · 2022-09-08T09:48:54Z

...r/pages/api/apple/v1/devices/[deviceLibraryIdentifier]/registrations/[passTypeIdentifier].ts

+
+            if (serialNumbers.length == 0) {
+              // There are no matching passes
+              res.status(204).end()


It is not considered a failure to not have a match?

@johnmark13 No, because this endpoint is for getting a list of updatable passes. And if the passes on the device are already up to date, no serial numbers (passport IDs) will be returned (HTTP 204 No Content). At least that's the required HTTP response code used in the Apple documentation: https://developer.apple.com/documentation/walletpasses/get_the_list_of_updatable_passes

johnmark13 · 2022-09-08T09:50:11Z

server/pages/api/apple/v1/log.ts

+    // Expected request method:  POST
+    console.log('req.method:', req.method)
+    if (req.method != 'POST') {
+      throw new Error('Wrong request method: ' + req.method)


http response with code 405?

@johnmark13 Yes, should be 405, thank you. Added it to the task list at #76

johnmark13 · 2022-09-08T09:51:43Z

server/pages/api/apple/v1/passes/[passTypeIdentifier]/[serialNumber].ts

+    console.log('authenticationToken:', authenticationToken)
+    if (!authenticationToken || String(authenticationToken).trim().length == 0) {
+      throw new Error('Missing/empty header: Authorization')
+    }


Will you move all of this to middleware?

@johnmark13 Added this as a refactoring task at #76

Populate the pass template with details stored in the `downloads` table

- Add `latest_updates` table to database - Use timestamp of latest update in `Last-Modified` header when downloading .pkpass - Use timestamp of latest update as `lastUpdated` when getting the list of updatable passes

Return `lastUpdated` as string instead of number, adhering to the Apple documentation: https://developer.apple.com/documentation/walletpasses/serialnumbers

…#6) Adhering to the response codes at https://developer.apple.com/documentation/walletpasses/register_a_pass_for_update_notifications

vercel · 2022-09-12T10:02:53Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
mobile-passport	✅ Ready (Inspect)	Visit Preview	Sep 12, 2022 at 10:04AM (UTC)

…-updates-to

luisivan

Amazing! I was trying to test sending push notifications too, but I realized this PR is for updating the passes themselves. I successfully downloaded an updatable version of my N3 passport :)

feat(apple): log a message (nation3#72)

5762a0b

aahna-ashina self-assigned this Sep 6, 2022

aahna-ashina added 9 commits September 6, 2022 09:42

test(cypress): test /api/apple/v1/log (nation3#72)

e61226c

test(cypress): test /api/apple/v1/log (nation3#72)

9949666

feat: get the list of updatable passes (#6)

9b71e6e

Return `serialNumbers`

feat: allow missing passesUpdatedSince parameter (#6)

80a62c0

refactor: fetch template version from config (#6)

7a28c59

Merge branch 'main' into dw-58/send-template-updates-to

6fab905

test(cypress): update test data (#6)

aaa4090

Merge branch 'dw-58/send-template-updates-to' of https://github.com/a…

9683cee

…ahna-ashina/mobile-passport into dw-58/send-template-updates-to

feat(apple): send an updated pass (#6)

f7d5e47

aahna-ashina requested a review from johnmark13 September 6, 2022 09:57

Merge branch 'main' into dw-58/send-template-updates-to

d6eadcb

aahna-ashina removed the request for review from johnmark13 September 7, 2022 01:26

aahna-ashina added 2 commits September 7, 2022 12:21

feat(apple): send an updated pass (#6)

0b79dae

test(apple): send an updated pass (#6)

9f853c7

aahna-ashina added 12 commits September 7, 2022 13:33

refactor: github workflows

61cf805

docs(metrics): add north star metric to pr template

6e14a36

chore(deps): bump web3 from 1.7.3 to 1.7.5 in /server

a05caf7

closes nation3#45

chore(deps): bump google-auth-library from 8.0.2 to 8.5.1 in /server

4a7b8b8

closes nation3#71

docs: add test checklist

ec05a78

refactor: rename templateFormatVersion (#6)

ef9a065

refactor: rename from download to generate (#6)

e2854f4

refactor: rename to issueDate (#6)

7746528

test(apple): generatePass (#6)

5af5e57

test: reduce coverage threshold to 80% (#6)

9dd6b5f

Update pull_request_template.md

659d80c

feat(apple): store pass details during download (#6)

90afce2

aahna-ashina requested a review from xPi2 September 8, 2022 01:59

aahna-ashina added 3 commits September 8, 2022 10:03

refactor (#6)

beb8718

feat(apple): store template version during registration (#6)

97bcfa3

test: add codecov badge

3feadd1

johnmark13 approved these changes Sep 8, 2022

View reviewed changes

Merge branch 'main' into dw-58/send-template-updates-to

7e423d9

aahna-ashina mentioned this pull request Sep 9, 2022

feat(): Add Splitbee analytics for pass downloads #33

Closed

aahna-ashina added 14 commits September 9, 2022 13:25

feat(apple): store template version during registration (#6)

a8f6f52

feat(apple): use templateVersion as passesUpdatedSince (#6)

cbfb085

feat(apple): get pass details from downloads table (#6)

7e0beaf

Populate the pass template with details stored in the `downloads` table

feat(apple): add template v3 (#6)

4991d07

feat(apple): set latest nation3 update (#6)

832c734

feat(apple): store latest_updates in database (#6)

21032c2

- Add `latest_updates` table to database - Use timestamp of latest update in `Last-Modified` header when downloading .pkpass - Use timestamp of latest update as `lastUpdated` when getting the list of updatable passes

feat(apple): set latest nation3 update (#6)

ed3c128

test: include webservice url for debugging (#6)

42ef3cf

feat(apple): return lastUpdated as string (#6)

f722672

Return `lastUpdated` as string instead of number, adhering to the Apple documentation: https://developer.apple.com/documentation/walletpasses/serialnumbers

feat(apple): return http 200 when serial number is already registered (…

848304e

…#6) Adhering to the response codes at https://developer.apple.com/documentation/walletpasses/register_a_pass_for_update_notifications

test(apple): apple template v3 (#6)

0943c3d

test(apple): remove debugging from back field (#6)

50c28f3

refactor: update goerli domain

43ec3c4

chore(apple): update goerli url (#6)

2e04076

aahna-ashina added 2 commits September 12, 2022 18:20

Merge remote-tracking branch 'upstream/main' into dw-58/send-template…

6799a63

…-updates-to

Merge pull request nation3#71

1032a01

luisivan approved these changes Sep 12, 2022

View reviewed changes

aahna-ashina mentioned this pull request Sep 13, 2022

Refactor Apple Wallet code #76

Open

6 tasks

aahna-ashina merged commit b5aedc3 into nation3:main Sep 13, 2022

aahna-ashina mentioned this pull request Sep 17, 2022

Apple Wallet: Implement support for the lastUpdated tag #75

Closed

aahna-ashina deleted the dw-58/send-template-updates-to branch September 29, 2022 09:50

aahna-ashina mentioned this pull request Oct 14, 2022

Move validation and authorization to middleware #25

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Send template updates to Apple Wallet passes (#6) #73

Send template updates to Apple Wallet passes (#6) #73

aahna-ashina commented Sep 6, 2022 •

edited

Loading

vercel bot commented Sep 6, 2022

codecov-commenter commented Sep 7, 2022 •

edited

Loading

johnmark13 left a comment

johnmark13 Sep 8, 2022

aahna-ashina Sep 13, 2022

johnmark13 Sep 8, 2022

aahna-ashina Sep 13, 2022 •

edited

Loading

johnmark13 Sep 8, 2022

johnmark13 Sep 8, 2022

aahna-ashina Sep 13, 2022 •

edited

Loading

johnmark13 Sep 8, 2022

aahna-ashina Sep 13, 2022

johnmark13 Sep 8, 2022

aahna-ashina Sep 13, 2022 •

edited

Loading

johnmark13 Sep 8, 2022

aahna-ashina Sep 13, 2022

vercel bot commented Sep 12, 2022 •

edited

Loading

luisivan left a comment

Send template updates to Apple Wallet passes (#6) #73

Send template updates to Apple Wallet passes (#6) #73

Conversation

aahna-ashina commented Sep 6, 2022 • edited Loading

North Star Metric: Number of Active Citizens

Dework Task

Related GitHub Issue

How Has This Been Tested?

Are There Admin Tasks?

Are There Documentation Tasks?

vercel bot commented Sep 6, 2022

codecov-commenter commented Sep 7, 2022 • edited Loading

Codecov Report

johnmark13 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aahna-ashina Sep 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aahna-ashina Sep 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aahna-ashina Sep 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Sep 12, 2022 • edited Loading

luisivan left a comment

Choose a reason for hiding this comment

aahna-ashina commented Sep 6, 2022 •

edited

Loading

codecov-commenter commented Sep 7, 2022 •

edited

Loading

aahna-ashina Sep 13, 2022 •

edited

Loading

aahna-ashina Sep 13, 2022 •

edited

Loading

aahna-ashina Sep 13, 2022 •

edited

Loading

vercel bot commented Sep 12, 2022 •

edited

Loading