add Zod validation of state chain objects, infer types #1485

mholtzman · 2023-03-14T07:00:23Z

No description provided.

goosewobbler · 2023-03-17T13:23:42Z

main/store/migrate/index.ts


 // Version number of latest known migration
-const latest = Math.max(...Object.keys(migrations).map((n) => parseInt(n)))
+const latest = migrations[migrations.length - 1].version


You might use dynamic import to avoid having to specify new migrations here each time, something like

get array of dirNames in migrations dir

map array to dynamic import of each migration index file

sort as on line 9 above

I thought about this but deferred as it would make the migration process async and I thought it might be too much of a moving target to change the sync/async nature of the entire startup flow on top of all of these other changes. I do think this makes sense as a future optimization though as it will make it easier to manage migrations and not have to worry about adding them in two places.

gonna just try a couple things though to see if there's something easy here

ahh yeah I think we'd need to use top-level await and that would require us changing our TS config, so at a minimum I think this is best left for another PR

goosewobbler · 2023-03-17T13:30:23Z

main/store/migrate/migrations/35/index.ts

+export default {
+  version: 35,
+  migrate
+}


Prefer to use named exports and, e.g. import * as migration35 when exporting objects like this. If using the dynamic import I suggested above a named export will play nicer too

I want to leave it as is, at least for now, as I don't want these modules exporting multiple different things (ie a field called version and function called migrate), I want them exporting just one thing: an object of type Migration

main/store/migrate/migrations/36/index.ts

* add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing

* Integrate pylon evm (#1478) * bump version * remove infura and alchemy presets, use pylon * update package lock * remove gnosis chain preset * fix chain name * move migrations to separate files, use TS (#1482) * add Zod validation of state chain objects, infer types (#1485) * add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing * Choose summon keybinding (#1494) Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com> * re-order migrations * convert hot signers to TS, make tests run reliably * more commits * update comment * remove unneeded assignment * make worker interaction more typesafe * remove unused code * remove unused interface * fix tests * revert weird test change * try revert file * try move * decouple worker controller and launch script, write controller tests * fix worker exit in tests * remove double cast * rename some files * remove ignore * clean up worker interface * last cleanup, fix typed data * more type safety * rebase, add bip39 type * remove ts-ignores * remove rebase artifact * remove migration files * update package lock --------- Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

* add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing

* Integrate pylon evm (#1478) * bump version * remove infura and alchemy presets, use pylon * update package lock * remove gnosis chain preset * fix chain name * move migrations to separate files, use TS (#1482) * add Zod validation of state chain objects, infer types (#1485) * add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing * Choose summon keybinding (#1494) Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com> * re-order migrations * convert hot signers to TS, make tests run reliably * more commits * update comment * remove unneeded assignment * make worker interaction more typesafe * remove unused code * remove unused interface * fix tests * revert weird test change * try revert file * try move * decouple worker controller and launch script, write controller tests * fix worker exit in tests * remove double cast * rename some files * remove ignore * clean up worker interface * last cleanup, fix typed data * more type safety * rebase, add bip39 type * remove ts-ignores * remove rebase artifact * remove migration files * update package lock --------- Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

* add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing

mholtzman added 14 commits March 16, 2023 08:59

add Zod validation of state chain objects, infer types

c4a3d03

move state files to TS, add more inferred types

1e3e52c

fix persist mock for tests

3619eab

add types to main state

369cb4e

update test

d083646

add mute notification schema

1d56254

move type export to state main

46421e5

move legacy file to TS

a480e82

try new migration format

b473d72

update legacy migrations and tests

351bd58

fix gas fees type

4625893

fix gas type

130e29b

move legacy mapping

2574ab1

final migration prototype

7d599af

mholtzman force-pushed the typed-state branch from ceb0fa8 to 7d599af Compare March 16, 2023 14:35

mholtzman added 2 commits March 16, 2023 12:11

finish migration poc

8fc2b72

finish cleaning up migrations

a316534

mholtzman marked this pull request as ready for review March 16, 2023 16:55

mholtzman added 2 commits March 16, 2023 13:13

test cleanup

e6d71de

fix compilation error

d557e14

mholtzman requested review from goosewobbler and floating March 16, 2023 19:15

goosewobbler suggested changes Mar 17, 2023

View reviewed changes

fix state parsing

65c621c

goosewobbler approved these changes Mar 17, 2023

View reviewed changes

floating approved these changes Mar 20, 2023

View reviewed changes

mholtzman merged commit 14b55a0 into canary Mar 20, 2023

mholtzman deleted the typed-state branch March 20, 2023 12:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add Zod validation of state chain objects, infer types #1485

add Zod validation of state chain objects, infer types #1485

mholtzman commented Mar 14, 2023

goosewobbler Mar 17, 2023

mholtzman Mar 17, 2023

mholtzman Mar 17, 2023

mholtzman Mar 17, 2023

goosewobbler Mar 17, 2023

mholtzman Mar 17, 2023

add Zod validation of state chain objects, infer types #1485

add Zod validation of state chain objects, infer types #1485

Conversation

mholtzman commented Mar 14, 2023

goosewobbler Mar 17, 2023

Choose a reason for hiding this comment

mholtzman Mar 17, 2023

Choose a reason for hiding this comment

mholtzman Mar 17, 2023

Choose a reason for hiding this comment

mholtzman Mar 17, 2023

Choose a reason for hiding this comment

goosewobbler Mar 17, 2023

Choose a reason for hiding this comment

mholtzman Mar 17, 2023

Choose a reason for hiding this comment