[keyserver] Add the qrcode dependency for terminal output
ClosedPublic
Actions

Authored by rohan on Sep 5 2023, 10:37 AM.

Details

Reviewers

atul
ginsu
varun
• patryk
ashoat

Commits

rCOMM5cd376aa8df6: [keyserver] Add the qrcode dependency for terminal output

Summary

We need a package to generate the QR codes from keyserver when it's run into the terminal. We have two options:

qrcode-terminal is the package that Expo CLI uses to display a QR code in the terminal similar to when yarn dev is run. While it's reliable, it hasn't really been updated in 5 years so I decided to not use it.
node-qrcode is the package that I decided to go to for a few reasons. It seems to be well supported (latest update in April), lots of community issues/responses on existing issues, and has a better API to generate the QR codes, specifically handling different encoding types.

Ultimately it shouldn't matter too much what we go with, the main challenge will be attempting to encode large amounts of data in a QR code in the terminal without it breaking the line output, so for now I'm going to go with this package. If we need to, it's a very easy change.

Addresses ENG-4778 and ENG-4771

Test Plan

Ran yarn cleaninstall and confirmed I can print out a simple QR code to the terminal in keyserver.js

Diff Detail

Repository

rCOMM Comm

Branch

terminal_qr

Lint

No Lint Coverage

Unit

No Test Coverage

Event Timeline

rohan created this revision.Sep 5 2023, 10:37 AM

Herald added a subscriber: tomek. · View Herald TranscriptSep 5 2023, 10:37 AM

rohan edited the summary of this revision. (Show Details)Sep 5 2023, 10:38 AM

rohan edited the summary of this revision. (Show Details)

Harbormaster completed remote builds in B22393: Diff 30782.Sep 5 2023, 10:55 AM

rohan requested review of this revision.Sep 5 2023, 10:55 AM

Not sure if we actually need to add the dependency, planning changes to confirm before requesting review

rohan requested review of this revision.Sep 7 2023, 7:04 AM

rohan added inline comments.

native/ios/Podfile.lock
957 ↗	(On Diff #30782)	This seemed automatic, not sure if it's something I should prevent / revert?

ashoat added inline comments.Sep 7 2023, 7:13 AM

native/ios/Podfile.lock

957 ↗

(On Diff #30782)

You need to update your Nix environment:

 ashoat  ~  src  comm  pod --version                                                                                                                                     ST 3   master
1.11.3
 ashoat  ~  src  comm  exit                                                                                                                                              ST 3   master
exit
ashoat@ashoatmbp2021 [~/src/comm]$ nix develop
Existing MariaDB instance found outside of nix environment
Please stop existing services and attempt 'nix develop' again
Existing Redis instance found outside of nix environment
Please stop existing services and attempt 'nix develop' again
Welcome to Comm dev environment! :)
 ashoat  ~  src  comm  pod --version                                                                                                                                     ST 3   master
1.12.1

rohan added inline comments.Sep 7 2023, 7:34 AM