feat: allow multiple providers #595

alanshaw · 2023-03-22T16:02:57Z

Allows multiple providers to be used with the system and defines web3 and NFT providers in config.

gobengo

lgtm. I want to make sure @Gozala also approves using these did:web:nft.storage as provider DIDs since it's not explicitly mentioned in this spec

Gozala

Looks great! But I think we can't land this until we impose constraint that only one of the providers can be added to the space. I provided more detailed comment inline.

My lest urgent concern is that we (as in web3.storage) decides who gets to have a nft.storage provider as opposed to nft.storage itself. It's probably fine if we want to land and unblock work on the client side, but I do think we need to address this sooner than later.

Gozala · 2023-03-22T16:39:49Z

packages/access-api/src/types/provisions.ts

 /**
 * action which results in provisionment of a space consuming a storage provider
 */
 export interface Provision<ServiceDID extends Ucanto.DID<'web'>> {
  invocation: Ucanto.Invocation<ProviderAdd>
  space: Ucanto.DID<'key'>
  account: Ucanto.DID<'mailto'>
-  provider: AlphaStorageProvider | ServiceDID
+  provider: ServiceDID


Nit: I would personally loose the generic and use Ucanto.DID<'web'> here. Which I think would make ts-expect-error in file above go away as well.

Gozala · 2023-03-22T16:42:56Z

packages/access-api/src/types/provisions.ts

 }

 /**
 * stores instances of a storage provider being consumed by a consumer
 */
 export interface ProvisionsStorage<ServiceDID extends Ucanto.DID<'web'>> {
-  service: ServiceDID
+  services: ServiceDID[]


Nit: I'd remove these from the interface entirely. When I was designing provider protocol I was assuming that we would have provider/publish capability which would allow you to create a provider and consequently allow others to add it if they received consumer/add delegation from you. I realize we're far from there, but it still might be good idea to align on it. Implementation could still have such a field.

I did start out that way but it's a bigger change set and neither of you were awake for me to double check with ;)

Gozala · 2023-03-22T16:46:53Z

packages/access-api/src/models/provisions.js

As far as I can tell there are no constraints imposed at the DB layer that would prevent one from adding both nft.storage and web3.storage providers to the same space

https://github.com/web3-storage/w3protocol/blob/52cf7c1f35f01aac66d475d884b87f29348a145c/packages/access-api/migrations/0006_add_storage_provider_consumer_schema.sql#L11-L22

We should impose that constraint at some layer to prevent having spaces with both providers otherwise we'll run into problem where user might add something to a space and we don't know if it's an nft or web3 content.

Gozala · 2023-03-23T06:24:28Z

packages/access-api/test/provider-add.test.js

-  },
-])) {
-  describe(`provider/add ${providerAddHandlerVariant.name}`, () => {
-    it(`can be invoked by did:key`, async () => {


Note: This test was removed because it was not testing a right thing and was only passing because it did not used validator.

Gozala · 2023-03-23T06:26:44Z

packages/access-api/test/provider-add.test.js

I have removed bunch of indirection in the tests because those loops with test variants made my head heart and I could not get my head around what what was passed where. Instead I've added some test utility functions so each test can setup whatever it needs test and then test.

alanshaw

LGTM

Motivation: * make it easier to merge #595 --------- Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

🤖 I have created a release *beep* *boop* --- ## [5.0.0](access-api-v4.11.0...access-api-v5.0.0) (2023-03-23) ### ⚠ BREAKING CHANGES * implement new account-based multi-device flow ([#433](#433)) * upgrade capabilities to latest ucanto ([#463](#463)) ### Features * access-api handles provider/add invocations ([#462](#462)) ([5fb56f7](5fb56f7)) * access-api serves access/claim invocations ([#456](#456)) ([baacf35](baacf35)) * access/authorize confirmation email click results in a delegation back to the issuer did:key so that access/claim works ([#460](#460)) ([a466a7d](a466a7d)) * allow multiple providers ([#595](#595)) ([96c5a2e](96c5a2e)) * define `access/confirm` handler and use it in ucanto-test-utils registerSpaces + validate-email handler ([#530](#530)) ([b1bbc90](b1bbc90)) * handle access/delegate invocations without error ([#427](#427)) ([4f0bd1c](4f0bd1c)) * if POST /validate-email?mode=authorize catches error w/ too big qr code ([#516](#516)) ([d0df525](d0df525)) * implement new account-based multi-device flow ([#433](#433)) ([1ddc6a0](1ddc6a0)) * includes proofs chains in the delegated authorization chain ([#467](#467)) ([5144293](5144293)) * move access-api delegation bytes out of d1 and into r2 ([#578](#578)) ([4510c9a](4510c9a)) * move validation flow to a Durable Object to make it ⏩ fast ⏩ fast ⏩ fast ⏩ ([#449](#449)) ([02d7552](02d7552)) * provision provider type is now the DID of the w3s service ([#528](#528)) ([6a72855](6a72855)) * space/info will not error for spaces that have had storage provider added via provider/add ([#510](#510)) ([ea4e872](ea4e872)) * upgrade capabilities to latest ucanto ([#463](#463)) ([2d786ee](2d786ee)) * upgrade to new ucanto ([#498](#498)) ([dcb41a9](dcb41a9)) * write invocations and receipts into ucan log ([#592](#592)) ([754bf52](754bf52)) ### Bug Fixes * access/delegate checks hasStorageProvider(space) in a way that provider/add allows access/delegate ([#483](#483)) ([f4c640d](f4c640d)) * adjust migration 0005 to keep delegations table but create new used delegations_v2 ([#469](#469)) ([a205ad1](a205ad1)) * adjust migration 0005 to not do a drop table and instead rename delegations -> delegations_old and create a new delegations ([#468](#468)) ([6c8242d](6c8242d)) * allow injecting email ([#466](#466)) ([e19847f](e19847f)) * DbDelegationsStorage#find throws UnexpectedDelegation w/ { row } if failed bytesToDelegations ([#476](#476)) ([a6dafcb](a6dafcb)) * DbProvisionsStorage putMany doesnt error on cid col conflict ([#517](#517)) ([c1fea63](c1fea63)) * delegations model tries to handle if row.bytes is Array not Buffer (e.g. cloudflare) ([#478](#478)) ([030e7b7](030e7b7)) ### Miscellaneous Chores * **access-client:** release 11.0.0-rc.0 ([#573](#573)) ([be4386d](be4386d)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- ## [4.0.1](capabilities-v4.0.0...capabilities-v4.0.1) (2023-03-27) ### Features * allow multiple providers ([#595](#595)) ([96c5a2e](96c5a2e)) ### Miscellaneous Chores * **access-client:** release 11.0.0-rc.0 ([#573](#573)) ([be4386d](be4386d)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Allows multiple providers to be used with the system and defines web3 and NFT providers in config. --------- Co-authored-by: Irakli Gozalishvili <contact@gozala.io> Co-authored-by: Benjamin Goering <171782+gobengo@users.noreply.github.com>

🤖 I have created a release *beep* *boop* --- ## [5.0.0](access-api-v4.11.0...access-api-v5.0.0) (2023-03-23) ### ⚠ BREAKING CHANGES * implement new account-based multi-device flow ([#433](#433)) * upgrade capabilities to latest ucanto ([#463](#463)) ### Features * access-api handles provider/add invocations ([#462](#462)) ([46da0df](46da0df)) * access-api serves access/claim invocations ([#456](#456)) ([2ec16e9](2ec16e9)) * access/authorize confirmation email click results in a delegation back to the issuer did:key so that access/claim works ([#460](#460)) ([fc62691](fc62691)) * allow multiple providers ([#595](#595)) ([aba57b3](aba57b3)) * define `access/confirm` handler and use it in ucanto-test-utils registerSpaces + validate-email handler ([#530](#530)) ([a08b513](a08b513)) * handle access/delegate invocations without error ([#427](#427)) ([db01d07](db01d07)) * if POST /validate-email?mode=authorize catches error w/ too big qr code ([#516](#516)) ([ab83b19](ab83b19)) * implement new account-based multi-device flow ([#433](#433)) ([6152e55](6152e55)) * includes proofs chains in the delegated authorization chain ([#467](#467)) ([743a72f](743a72f)) * move access-api delegation bytes out of d1 and into r2 ([#578](#578)) ([3029e4a](3029e4a)) * move validation flow to a Durable Object to make it ⏩ fast ⏩ fast ⏩ fast ⏩ ([#449](#449)) ([3868d97](3868d97)) * provision provider type is now the DID of the w3s service ([#528](#528)) ([4cd6cd9](4cd6cd9)) * space/info will not error for spaces that have had storage provider added via provider/add ([#510](#510)) ([362024f](362024f)) * upgrade capabilities to latest ucanto ([#463](#463)) ([e375ae4](e375ae4)) * upgrade to new ucanto ([#498](#498)) ([790750d](790750d)) * write invocations and receipts into ucan log ([#592](#592)) ([d52a281](d52a281)) ### Bug Fixes * access/delegate checks hasStorageProvider(space) in a way that provider/add allows access/delegate ([#483](#483)) ([1d3d562](1d3d562)) * adjust migration 0005 to keep delegations table but create new used delegations_v2 ([#469](#469)) ([d90825a](d90825a)) * adjust migration 0005 to not do a drop table and instead rename delegations -> delegations_old and create a new delegations ([#468](#468)) ([89f2acd](89f2acd)) * allow injecting email ([#466](#466)) ([b4b0173](b4b0173)) * DbDelegationsStorage#find throws UnexpectedDelegation w/ { row } if failed bytesToDelegations ([#476](#476)) ([660f773](660f773)) * DbProvisionsStorage putMany doesnt error on cid col conflict ([#517](#517)) ([8c6dea8](8c6dea8)) * delegations model tries to handle if row.bytes is Array not Buffer (e.g. cloudflare) ([#478](#478)) ([02c0c28](02c0c28)) ### Miscellaneous Chores * **access-client:** release 11.0.0-rc.0 ([#573](#573)) ([29daa02](29daa02)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- ## [4.0.1](capabilities-v4.0.0...capabilities-v4.0.1) (2023-03-27) ### Features * allow multiple providers ([#595](#595)) ([aba57b3](aba57b3)) ### Miscellaneous Chores * **access-client:** release 11.0.0-rc.0 ([#573](#573)) ([29daa02](29daa02)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

feat: allow multiple providers

ca0f975

alanshaw requested review from Gozala and gobengo March 22, 2023 16:02

Alan Shaw and others added 2 commits March 22, 2023 16:22

fix: provisions test

140b5f9

chore: apply prettier

ca5e70b

gobengo approved these changes Mar 22, 2023

View reviewed changes

Gozala requested changes Mar 22, 2023

View reviewed changes

Gozala added 9 commits March 22, 2023 20:45

stash changes

2aec2b9

chore: clean up

e2a01f5

undo change

487d3f1

undo package.lock

3d62ba1

fix pnpm-lock

1cbe46b

add more tests including failing one

ba4a937

feat: impose single provider type constraint

6ba6565

fix: type error

d7ae195

fix: lint error

b042f1d

Gozala reviewed Mar 23, 2023

View reviewed changes

This was referenced Mar 23, 2023

chore: 595 and 571 #604

Closed

chore: Feat/multi provider mergeback 1679556904 #606

Merged

alanshaw commented Mar 23, 2023

View reviewed changes

gobengo and others added 2 commits March 23, 2023 13:46

chore: Feat/multi provider mergeback 1679556904 (#606)

c3fca01

Motivation: * make it easier to merge #595 --------- Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

Merge branch 'main' into feat/multi-provider

03d597f

alanshaw merged commit 96c5a2e into main Mar 23, 2023

alanshaw deleted the feat/multi-provider branch March 23, 2023 13:52

This was referenced Mar 23, 2023

chore(main): release access-api 5.0.0 #588

Merged

chore(main): release capabilities 4.0.1 #589

Merged

it-dag-house mentioned this pull request Mar 23, 2023

chore(main): release access-api 11.0.0-rc.0 #620

Closed

gobengo mentioned this pull request Apr 14, 2023

restricting the number of spaces per providers #704

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow multiple providers #595

feat: allow multiple providers #595

alanshaw commented Mar 22, 2023

gobengo left a comment

Gozala left a comment

Gozala Mar 22, 2023

Gozala Mar 22, 2023

alanshaw Mar 22, 2023

Gozala Mar 22, 2023

Gozala Mar 23, 2023

Gozala Mar 23, 2023

alanshaw left a comment

feat: allow multiple providers #595

feat: allow multiple providers #595

Conversation

alanshaw commented Mar 22, 2023

gobengo left a comment

Choose a reason for hiding this comment

Gozala left a comment

Choose a reason for hiding this comment

Gozala Mar 22, 2023

Choose a reason for hiding this comment

Gozala Mar 22, 2023

Choose a reason for hiding this comment

alanshaw Mar 22, 2023

Choose a reason for hiding this comment

Gozala Mar 22, 2023

Choose a reason for hiding this comment

Gozala Mar 23, 2023

Choose a reason for hiding this comment

Gozala Mar 23, 2023

Choose a reason for hiding this comment

alanshaw left a comment

Choose a reason for hiding this comment