[keyserver][web] Add types for @matrix-org/olm
ClosedPublic
Actions

Authored by ashoat on Mar 9 2023, 11:37 AM.

Details

Reviewers

atul
anunay

Commits

rCOMMeb898443e91e: [keyserver][web] Add types for @matrix-org/olm

Summary

@anunay is going to extend these. Mostly inspired by TypeScript types.

Test Plan

Flow

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

ashoat created this revision.Mar 9 2023, 11:37 AM

Herald added a subscriber: tomek. · View Herald TranscriptMar 9 2023, 11:37 AM

ashoat added a child revision: D7027: [web] Introduce Jest tests for Olm.Mar 9 2023, 11:38 AM

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 9 2023, 11:58 AM

Harbormaster failed remote builds in B17223: Diff 23589!

Fix up errors

ashoat retitled this revision from [keyserver][web] Add types for @matrix-org to [keyserver][web] Add types for @matrix-org/olm.Mar 9 2023, 12:12 PM

Harbormaster completed remote builds in B17226: Diff 23593.Mar 9 2023, 12:22 PM

ashoat requested review of this revision.Mar 9 2023, 12:22 PM

Noted some inconsistencies with the TypeScript types. Feel free to re-request review if the omissions were intentional.

keyserver/flow-typed/npm/@matrix-org/olm_vx.x.x.js
17–19 ↗	(On Diff #23593)	Looks like we're missing unpublished_fallback_key(): string; forget_old_fallback_key(): void; in between `fallback_key()` and `pickle(...)`. Let me know if I'm missing something here.
39 ↗	(On Diff #23593)	Can we do this instead of `Object` to match TypeScript types: ? Let me know if I'm missing something here.
58 ↗	(On Diff #23593)	Can we do this instead of `Object` to match TypeScript types: ? Let me know if I'm missing something here.
80 ↗	(On Diff #23593)	Can we do this instead of `Object` to match TypeScript types: ? Let me know if I'm missing something here.
108–109 ↗	(On Diff #23593)	Looks like we're missing calculate_mac_fixed_base64(input: string, info: string): string; in between `calculate_mac` and `calculate_mac_long_kdf`

This revision now requires changes to proceed.Mar 9 2023, 1:46 PM

atul attached a referenced file: F419758: 014c61.png. (Show Details)Mar 9 2023, 1:46 PM

atul attached a referenced file: F419756: 6c1aae.png. (Show Details)

atul attached a referenced file: F419751: 602258.png. (Show Details)

I pulled this from the version of the types in node_modules. Will try to make those improvements, with exceptions for any methods that might not exist in this older version of Olm (I think you're looking at master, which I linked above)

ashoat added inline comments.Mar 10 2023, 1:26 PM

keyserver/flow-typed/npm/@matrix-org/olm_vx.x.x.js
17–19 ↗	(On Diff #23593)	Ran these commands to confirm that this doesn't exist on our version of Olm (3.2.4): cd web/node_modules/\@matrix-org/olm/ grep -R unpublished_fallback_key . grep -R forget_old_fallback_key . I'm a little worried about using a different versions of Olm in different parts of our app. It's ultimately unavoidable (ie. if we upgrade keyserver and native at the same time, we'll still have some old clients running the old version), but it seems like a good idea to keep our versions generally in sync. The latest version of Olm is actually 3.2.14, so arguably we should just upgrade everything. I think @anunay has been working off of master, as I recall him mentioning `forget_old_fallback_key`. I'll try to put up a diff ahead of this one that upgrades our versions of Olm.