The global state refactor #422

icidasset · 2022-09-15T09:53:38Z

Summary

This refactor gets rid of the global state throughout webnative. Things such as the setup object and dependency injection now work entirely different. Instead of accessing a global object, we now create Program instances which have pointers to various instances of components that we pass to functions. For example, we create a crypto component and that is passed to a function that does crypto things.

See CHANGELOG.md for more info.

Tasks

Code quality checks

keystore-idb code is only used in the Crypto implementation code and nowhere else. SymmAlg should only be imported from components/crypto/implementation
IPFS is not used/mentioned anywhere except in the Depot implementation, everything else should be Depot + DAGs /IPLD + CIDs

Manual testing

Will need updating

Test with alpha version before release.

Fission Dashboard
Fission Drive
Webnative Elm
Webnative Walletauth

Closes issues

Closes #418, #283, #274

CHANGELOG.md

icidasset · 2022-11-15T11:53:23Z

package.json

    "prebuild": "rimraf lib dist && node scripts/gen-version.js",
-    "build": "yarn run build:ipfs && tsc && yarn run build:minified",
+    "build": "tsc && npm run build:minified",


Replaced yarn with npm.

icidasset · 2022-11-15T11:54:03Z

scripts/gen-version.js

-})
+
+import pkg from "../package.json" assert { type: "json" };
+import lock from "../package-lock.json" assert { type: "json" };


May need Node v18.

icidasset · 2022-11-15T11:56:40Z

src/common/identifiers.ts

+export async function bareNameFilter(
+  { crypto, accountDID, path }: Arguments
+): Promise<string> {
+  return `wnfs:${accountDID}:bareNameFilter:${await pathHash(crypto, path)}`


File systems are namespaced by account DID, allows for multiple filesystems to be loaded at the same time and temporary filesystems.

src/components/depot/implementation.ts

icidasset · 2022-11-15T12:05:20Z

src/components/depot/implementation.ts

+import { CID } from "multiformats/cid"
+
+
+export type Implementation = {


Preparation for CAR mirror/pool, allows us to switch out js-ipfs.

icidasset · 2022-11-15T12:27:34Z

tests/helpers/components.ts

+export const inMemoryDepot: Record<string, Uint8Array> = {}
+
+
+const depot: Depot.Implementation = {


This avoids us having to use js-ipfs in the tests.
Bit hacky I guess because I shove large chunked files inside a single block, but it works.

tests/helpers/components.ts

icidasset · 2022-11-15T12:30:08Z

src/index.ts

+  @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+    %@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%
+
+ */


Most important file, everything comes together here. The documentation should be self-explanatory, note if anything is not clear or missing.

src/index.ts

icidasset · 2022-11-15T12:36:27Z

src/index.ts


-  const authedUsername = await common.authenticatedUsername()
+// PREDEFINED COMPONENT COMBINATIONS


See this section for a detailed explanation on the components and how they work together. A short explanation is located in the changelog.

icidasset · 2022-11-15T12:41:11Z

Left a bunch of comments here, some thoughts, questions and additional notes for other people to read.

icidasset · 2022-11-15T14:00:51Z

src/index.ts

+  {
+    implementation: Auth.Implementation<Components>
+
+    accountConsumer: (username: string) => Promise<AccountLinkingConsumer>


I wanted to separate the functions that a user/dev directly uses from the implementation. Mixing the implementation functions in here would be confusing, for example, linkDevice does not fully link a device, you have to create an account linking consumer & producer.

icidasset · 2022-11-16T11:52:42Z

src/index.ts

 *
+ * See `assemble` for more information.


Can we somehow make it so that typedoc inserts a link here to the documentation of this assemble function?

src/components/auth/implementation/base.ts

src/components/depot/implementation.ts

src/components/reference/implementation/fission-base.ts

src/components/reference/implementation/fission/data-root.ts

src/components/storage/implementation/memory.ts

Co-authored-by: Brian Ginsburg <7957636+bgins@users.noreply.github.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

matheus23 · 2022-11-22T13:42:51Z

There's some remaining usage of "confidences" in the README and CHANGELOG ✌️ @icidasset

src/fs/filesystem.ts

src/linking/consumer.test.ts

Co-authored-by: Brian Ginsburg <7957636+bgins@users.noreply.github.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

icidasset · 2022-11-22T21:55:52Z

There's some remaining usage of "confidences" in the README and CHANGELOG

Thanks for spotting that!

bgins

Amazing work! So much accomplished here. It's looking great! 💯 🎉

As a summary, here are the things I have tested manually:

webnative.compositions with staging set to true
Account linking (tested in the Webnative app template on staging and production)
Backwards compatibility (tested with staging and production)
Custom manners component with alterations to logging
Custom manners component with filesystem hooks (using Add file system hooks #428)
Tested with the Stored Wasm example which uses capabilities and the Fission Auth Lobby

Thanks for all these changes! Excited to start using them in our apps. 🕺

src/permissions.ts

* Add file system hooks * Use FileSystem interface instead of type arg * Less changes * Add Properties interface * Pass CID to beforeLoadExisting hook * Re-export CID from common/cid * Provide the data flow components as arguments * Remove unnecessary cast to Uint8Array * Pass AssociatedIdentity to hooks * Remove Exchange interface * Don't add sample data by default * DataFlowComponents -> DataComponents

Co-authored-by: Brian Ginsburg <7957636+bgins@users.noreply.github.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

src/filesystem.ts

matheus23

I looked through quite a bit of this PR and I got a feel for the refactor when working a bit on the dashboard.

I'd say we can go ahead and :)

scripts/build-minified.js

src/common/hex.node.test.ts

src/common/type-checks.ts

Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

matheus23 self-requested a review September 19, 2022 17:00

matheus23 assigned icidasset Sep 19, 2022

icidasset force-pushed the icidasset/state-refactor branch 2 times, most recently from 7b3efbd to d38edfa Compare September 23, 2022 16:32

bgins mentioned this pull request Oct 13, 2022

Refactor load filesystem #424

Closed

7 tasks

icidasset force-pushed the icidasset/state-refactor branch from fd6048c to feb2d1b Compare October 24, 2022 17:33

jessmartin reviewed Oct 28, 2022

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

jessmartin mentioned this pull request Nov 8, 2022

Update README to explain new Webnative APIs oddsdk/odd-app-template#86

Closed

icidasset force-pushed the icidasset/state-refactor branch from b4765e2 to 9a19aa9 Compare November 14, 2022 16:38

icidasset commented Nov 15, 2022

View reviewed changes

bgins mentioned this pull request Nov 15, 2022

Implement recovery flow oddsdk/odd-app-template#55

Open

6 tasks

icidasset commented Nov 16, 2022

View reviewed changes

icidasset and others added 16 commits November 16, 2022 15:54

Refactor state management

8475509

Extend Repository class and add instance methods

cbb616b

FileSystem refactor, pt. 1

b485c56

FileSystem refactor, pt. 2

1a9f3f5

FileSystem refactor, pt. 3

6fbde40

FileSystem refactor, pt. 4

55ad5c4

Rewire private sharing

580a74f

Only add soft links when accepting share

6e63102

Load filesystem

e10e220

Fix async Repo constructor issue

1aa3916

Retry data root when loading filesystem (from #424)

2252e91

Update changelog

f32963e

Edited the CHANGELOG

cb86dae

Refactor remaining UCAN & DID functions

716547e

Refactor appl platform code

45fa3bb

Refactor linking

ed46650

bgins reviewed Nov 22, 2022

View reviewed changes

Apply suggestions from code review

fe0a4c8

Co-authored-by: Brian Ginsburg <7957636+bgins@users.noreply.github.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

bgins reviewed Nov 22, 2022

View reviewed changes

src/fs/filesystem.ts Outdated Show resolved Hide resolved

src/linking/consumer.test.ts Outdated Show resolved Hide resolved

icidasset and others added 3 commits November 22, 2022 22:50

Replace remaining mentions of confidences

95f3025

Remove globe typecasting

ddf69ca

Update src/linking/consumer.test.ts

f9bb14e

Co-authored-by: Brian Ginsburg <7957636+bgins@users.noreply.github.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

bgins approved these changes Nov 23, 2022

View reviewed changes

src/permissions.ts Outdated Show resolved Hide resolved

src/permissions.ts Outdated Show resolved Hide resolved

icidasset and others added 8 commits November 24, 2022 10:40

Replace BlockCodec with CodecIdentifier

bcdd288

Apply suggestions from code review

63bc13b

Co-authored-by: Brian Ginsburg <7957636+bgins@users.noreply.github.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

Don't remove old indexedDB databases

97feee1

appDataPath -> Path.appData

eca0796

Update changelog

43a4137

Window -> self

d0baebf

Forgot to change session type for capabilities

30b8b7a

matheus23 reviewed Nov 24, 2022

View reviewed changes

src/filesystem.ts Outdated Show resolved Hide resolved

icidasset added 4 commits November 24, 2022 14:25

Dependents -> Dependencies

bb7757f

Export all implementations from components

c15c085

Don't export capability types

23e6705

Rename activate to session

a5f9d0a

matheus23 approved these changes Nov 24, 2022

View reviewed changes

scripts/build-minified.js Show resolved Hide resolved

src/common/hex.node.test.ts Outdated Show resolved Hide resolved

src/common/type-checks.ts Show resolved Hide resolved

icidasset and others added 5 commits November 24, 2022 16:31

Update src/common/type-checks.ts

d676b20

Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

Update src/common/hex.node.test.ts

4398e63

Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com> Signed-off-by: Steven Vandevelde <icid.asset@gmail.com>

Undo type check change & remove min/max thing

34adc89

Update package.json metadata

39f6a34

Set engine to >= 16

27a23b8

icidasset merged commit db89623 into main Nov 24, 2022

icidasset deleted the icidasset/state-refactor branch November 24, 2022 18:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The global state refactor #422

The global state refactor #422

icidasset commented Sep 15, 2022 •

edited

Loading

icidasset Nov 15, 2022

icidasset Nov 15, 2022

icidasset Nov 15, 2022

icidasset Nov 15, 2022

icidasset Nov 15, 2022

icidasset Nov 15, 2022

icidasset Nov 15, 2022

icidasset commented Nov 15, 2022

icidasset Nov 15, 2022

icidasset Nov 16, 2022

matheus23 commented Nov 22, 2022

icidasset commented Nov 22, 2022

bgins left a comment

matheus23 left a comment

		import { CID } from "multiformats/cid"


		export type Implementation = {

		export const inMemoryDepot: Record<string, Uint8Array> = {}


		const depot: Depot.Implementation = {


		const authedUsername = await common.authenticatedUsername()
		// PREDEFINED COMPONENT COMBINATIONS

The global state refactor #422

The global state refactor #422

Conversation

icidasset commented Sep 15, 2022 • edited Loading

Summary

Tasks

Code quality checks

Manual testing

Will need updating

Closes issues

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

icidasset commented Nov 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matheus23 commented Nov 22, 2022

icidasset commented Nov 22, 2022

bgins left a comment

Choose a reason for hiding this comment

matheus23 left a comment

Choose a reason for hiding this comment

icidasset commented Sep 15, 2022 •

edited

Loading