update OpenPGP.js to v5

[tomholub]

Likely, flowcrypt-ios uses an older version of OpenPGP.js than browser extension does.

Originally posted by @tomholub in #1357 (comment)

[IvanPizhenko]

@tomholub I'm stuck in typescript issue a bit.
v4:

    class BasePacket {
      tag: enums.packet;
      read(bytes: Uint8Array): void;
      write(): Uint8Array;
    }

v5:

abstract class BasePacket {
  static readonly tag: enums.packet;
  public read(bytes: Uint8Array): void;
  public write(): Uint8Array;
}

Then, our code:

  public static isPacketPrivate = (p: OpenPGP.AnyKeyPacket): p is PrvPacket => {
    return p.tag === openpgp.enums.packet.secretKey || p.tag === openpgp.enums.packet.secretSubkey;
  }

This works with v4, but with v5 it gives error:

Property 'tag' does not exist on type 'BasePublicKeyPacket'. Did you mean to access the static member 'BasePublicKeyPacket.tag'?

I don't understand how to rewrite this to preserve same functionality.

[tomholub]

When a method has a return type of x is y, in this case p is PrvPacket, it's a type-testing method.

Into the method goes an unknown, or too regeric type.

Out of the method goes boolean. If the boolean is true, then typescript knows that the value in the input (the x) is of type y.

It's our job, within that method, to safely establish if it's that wanted type or not.

In this particular case, if you have an input variable that may or may not have the tag on it, and wanted variable that you know does have the tag, then you would do this:

if (!p || typeof p !== 'object') {
  return false; // now we know it's an object so it's safe to test its properties
}
return (p as PrvPacket).tag === openpgp.enums.packet.secretKey || (p as PrvPacket).tag === openpgp.enums.packet.secretSubkey;

I suppose, in this particular case, you should not need the initial if, because the type coming in is already clarified as AnyKeyPacket which is an object?

This may not get you 100% there but should give you the idea.

[IvanPizhenko]

(p as PrvPacket).tag === openpgp.enums.packet.secretKey also doesn't work. It refuses to access static member on object, and if I access static member by class name, then what will be the sense of this function at all? Where those static members go in resulting JavaScript? Maybe I should try accessing it via prototype?

[IvanPizhenko]

it turns like correct solution is following:

  public static isPacketPrivate = (p: OpenPGP.AnyKeyPacket): p is PrvPacket => {
    return p instanceof SecretKeyPacket || p instanceof SecretSubkeyPacket;
  }

[tomholub]

That's the ideal solution if the type is also an actual javascript class 👍

[IvanPizhenko]

I'm stuck with following issue: openpgp v4 had a function for reading whole stream content (openpgp.streams.readToEnd()). There is no equivalent in v5. I don't know how to implement it, and I couldn't find anything suitable on the Internet so far.

Here is what it all about: some functions return MaybeStream<Data>,
where:
Data = string | Uint8Array and MaybeStream<T> = T | Stream<T>,
where:
Stream<T> = WebStream<T> | NodeStream<T>,
where:

interface WebStream<T extends Data> extends BaseStream<T> { // copied+simplified version of ReadableStream from lib.dom.d.ts
  readonly locked: boolean; getReader: Function; pipeThrough: Function; pipeTo: Function; tee: Function;
  cancel(reason?: any): Promise<void>;
}

interface NodeStream<T extends Data> extends BaseStream<T> { // copied+simplified version of ReadableStream from @types/node/index.d.ts
  readable: boolean; pipe: Function; unpipe: Function; wrap: Function;
  read(size?: number): string | Uint8Array; setEncoding(encoding: string): this; pause(): this; resume(): this;
  isPaused(): boolean; unshift(chunk: string | Uint8Array): void;
}

where:

interface BaseStream<T extends Data> extends AsyncIterable<T> { }

I've asked a question on the opnpgp.js discussion forum openpgpjs/openpgpjs#1478 but there is no any answers so far.

Meanwhile I've ended up with following:

export const readToEnd = async (maybeStream: OpenPGP.MaybeStream<string>): Promise<string> => {
  if (typeof maybeStream === 'string') return maybeStream;
  // TODO - implement
  throw Error('Can\'t read stream');
}

export const readToEndBinary = async (maybeStream: OpenPGP.MaybeStream<Uint8Array>): Promise<Uint8Array> => {
  if (maybeStream instanceof Uint8Array) return maybeStream;
  // TODO - implement
  throw Error('Can\'t read stream');
}

@tomholub @rrrooommmaaa Any ideas how to deal with this?

[IvanPizhenko]

Function readToEnd() seems to exist inside library, but it is missing in openpgp.d.ts and I am not sure if it is accessible outside at all.

[IvanPizhenko]

Added following to openpgp.d.ts:

// ----- BEGIN ADDED BY FLOWCRYPT -----
export function readToEnd<T extends Data>(input: MaybeStream<T>, concat?: (list: T[]) => T): Promise<T>;
// ----- END ADDED BY FLOWCRYPT -----

If function like readKey() done similar way, with no special "exporting" in library source code, then this one should also work.

[IvanPizhenko]

Trying to run tests. Getting errors:

> ava build/ts/test.js --verbose


  Uncaught exception in build/ts/test.js

  build/ts/test.js:15

   14: const chai_1 = require("chai");                             
   15: const pgp_1 = require("./core/pgp");                        
   16: const endpoints_1 = require("./mobile-interface/endpoints");

  ReferenceError: OpenPGP is not defined

No ideas how to solve this. @tomholub @rrrooommmaaa Any ideas?