feat: access-api handles provider/add invocations #462

gobengo · 2023-02-28T21:24:33Z

Motivation:

implement story: I can register a storage provider with a space using access/authorize + provider/add #459
handle provider/add as a way of registering space

Steps

scaffold with in-memory data store
make it work with sqlite data store

…orage cap

packages/access-api/src/utils/context.js

gobengo · 2023-03-03T23:00:15Z

@Gozala I made a few changes based on your suggestions, and linked to the commits under your feedback comments.
For some I created issues to handle as followup.
Let me know if I did that for any you wanted before merging this.

Gozala

Can you just add cid field to the table and otherwise I think it's all good.

Gozala · 2023-03-03T23:50:20Z

packages/access-api/migrations/0006_add_storage_provider_consumer_schema.sql

+    -- provision: the action of providing or supplying something for use
+    -- use case: representing the registration of a storage provider to a space
+    IF NOT EXISTS provisions (
+        id INTEGER NOT NULL PRIMARY KEY,


Can we still add the cid field per our discussion in slack. We can drop it later if we decide it's not needed, but I think we'll want to tie these to the invocations that provisioned the provider. If we don't write those now it would be really hard to trace them later.

Gozala · 2023-03-03T23:52:40Z

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

+      .selectFrom(this.tableNames.provisions)
+      .select((e) => e.fn.count('provider').as('size'))
+      .executeTakeFirstOrThrow()
+    return BigInt(size)


What is it otherwise a string ? Can you plz add a comment explaining why this needs to be a BigInt.

I made it a BigInt to match the interface. I used bigint in the interface for consistency with the count() method on delegations, which I made return a BigInt per @alanshaw review. #427 (comment)

Gozala · 2023-03-03T23:54:06Z

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

+      .values(rows)
+      .executeTakeFirstOrThrow()
+  }
+


By subscriber I assume you mean the account DIDs?

Yes

Gozala · 2023-03-04T00:03:07Z

packages/access-api/migrations/0006_add_storage_provider_consumer_schema.sql

+CREATE TABLE
+    -- provision: the action of providing or supplying something for use
+    -- use case: representing the registration of a storage provider to a space
+    IF NOT EXISTS provisions (


Nit: In the past when I had to do more DB work using plural names for tables was considered a bad practice, stack overflow still seems to think the singular is a the way to go with bunch of reasons there.

I'm not going to get upset if we use plural, but might be worth considering singular names instead.

in general I don't mind singular at all, and maybe even slightly prefer it, but here I made it plural because delegations accounts spaces already was.

I don't have any objection to batch changing them to singular in one big other PR

Gozala · 2023-03-04T00:05:37Z

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

+/**
+ * action which results in provisionment of a space consuming a storage provider
+ */
+export interface StorageProvisionCreation {


Nit: I find naming to be very confusing, can we simply call this

Suggested change

export interface StorageProvisionCreation {

export interface ProvisionModel {

Or better yet

Suggested change

export interface StorageProvisionCreation {

export interface Provision {

Gozala · 2023-03-04T00:06:36Z

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

+/**
+ * stores instances of a storage provider being consumed by a consumer
+ */
+export interface Provisions {


Nit: I would also find it more intuitive if it was called following instead

Suggested change

export interface Provisions {

export interface ProvisionStore {

I called Delegations DelegationsStorage. When I did alan commented that it didn't look like the other types that were called e.g. Delegations. I'm not against changing these names in subsequent PRs. If we call it ProvisionStore we should also change DelegationsStorage to DelegationsStore IMO

renamed to ProvisionsStorage and idc if we rename to something else after. 9b9a14d

(My original intention was to eventually have like type Provision = StorageProvision | OtherKindOfProvision)

I agree with @Gozala but I want consistency in the code base. Can you please open another PR to bring the others in line?

Gozala · 2023-03-04T00:09:36Z

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

+      const account = { did: () => accountDID }
+      const space = await principal.ed25519.generate()
+      const service = await providerAddHandlerVariant.audience
+      const agentACanSignAsAccountDID = await ucanto.delegate({


I'm not sure why this is passing, but ucanto no longer knows anything about ./update. In fact now that you've pointed out it is passing tests, I'm concerned that it does as I would expect it to fail instead.

🤖 I have created a release *beep* *boop* --- ## [3.1.0](capabilities-v3.0.0...capabilities-v3.1.0) (2023-03-04) ### Features * access-api handles provider/add invocations ([#462](#462)) ([5fb56f7](5fb56f7)) * includes proofs chains in the delegated authorization chain ([#467](#467)) ([5144293](5144293)) --- 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* --- ## [10.0.0](access-v9.4.0...access-v10.0.0) (2023-03-08) ### ⚠ BREAKING CHANGES * 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)) * handle access/delegate invocations without error ([#427](#427)) ([4f0bd1c](4f0bd1c)) * upgrade capabilities to latest ucanto ([#463](#463)) ([2d786ee](2d786ee)) * upgrade to new ucanto ([#498](#498)) ([dcb41a9](dcb41a9)) ### Bug Fixes * allow injecting email ([#466](#466)) ([e19847f](e19847f)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). 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).

Motivation: * implement #459 * handle `provider/add` as a way of registering space Steps * [x] scaffold with in-memory data store * [x] make it work with sqlite data store --------- Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

🤖 I have created a release *beep* *boop* --- ## [3.1.0](capabilities-v3.0.0...capabilities-v3.1.0) (2023-03-04) ### Features * access-api handles provider/add invocations ([#462](#462)) ([46da0df](46da0df)) * includes proofs chains in the delegated authorization chain ([#467](#467)) ([743a72f](743a72f)) --- 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* --- ## [10.0.0](access-v9.4.0...access-v10.0.0) (2023-03-08) ### ⚠ BREAKING CHANGES * 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)) * handle access/delegate invocations without error ([#427](#427)) ([db01d07](db01d07)) * upgrade capabilities to latest ucanto ([#463](#463)) ([e375ae4](e375ae4)) * upgrade to new ucanto ([#498](#498)) ([790750d](790750d)) ### Bug Fixes * allow injecting email ([#466](#466)) ([b4b0173](b4b0173)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). 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)) ([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).

gobengo linked an issue Feb 28, 2023 that may be closed by this pull request

story: I can register a storage provider with a space using access/authorize + provider/add #459

Closed

gobengo added 8 commits February 28, 2023 13:28

add voucher/claim test that invokes the delegation in email

1c5d196

fix lint

679e3c2

access/authorize confirmation stores ucan/attest not ./update

b8849a4

add provider add capability

d15d0db

add provider/add capability parser

6da1479

start createProviderAddHandler

25c4e0e

start testing providerAdd handler

da6adb6

test provider/add as did:mailto

2f64d27

gobengo force-pushed the 459-register-space-provider-add branch from 5498b9f to 2f64d27 Compare February 28, 2023 21:31

gobengo changed the title ~~459 register space provider add~~ access-api handles provider/add invocations Feb 28, 2023

gobengo added 2 commits February 28, 2023 13:33

lint

624b355

typo fix

bd05cbd

gobengo changed the title ~~access-api handles provider/add invocations~~ feat: access-api handles provider/add invocations Feb 28, 2023

gobengo marked this pull request as ready for review February 28, 2023 21:34

provider-add.test asserts storage provider using new testing/space-st…

fbb0ce4

…orage cap

gobengo mentioned this pull request Feb 28, 2023

story: I can register a storage provider with a space using access/authorize + provider/add #459

Closed

provider/add stores StorageProvision (in-memory only)

27acf17

gobengo temporarily deployed to dev March 1, 2023 00:04 — with GitHub Actions Inactive

fix caps test after provider/add nb.consumer parser change

0c62dbc

gobengo temporarily deployed to dev March 1, 2023 00:19 — with GitHub Actions Inactive

gobengo commented Mar 1, 2023

View reviewed changes

packages/access-api/src/utils/context.js Outdated Show resolved Hide resolved

gobengo added 4 commits February 28, 2023 16:25

reenable important assertion even tho failing

e537211

StorageProvision backed by kysely

d9768ad

Merge branch 'main' into 459-register-space-provider-add

6c1d1be

Merge branch 'main' into 459-register-space-provider-add

49004e8

gobengo requested a review from Gozala March 3, 2023 00:28

Merge branch 'main' into 459-register-space-provider-add

e403bb3

gobengo temporarily deployed to dev March 3, 2023 07:02 — with GitHub Actions Inactive

fix capabilities test

237d188

gobengo temporarily deployed to dev March 3, 2023 22:55 — with GitHub Actions Inactive

gobengo requested a review from Gozala March 3, 2023 22:59

gobengo mentioned this pull request Mar 3, 2023

automate testing space access across devices through access/delegate invocation handling gobengo/w3protocol-test#8

Open

2 tasks

Gozala requested changes Mar 4, 2023

View reviewed changes

remove provider/add ./update test that wasnt useful

6903891

gobengo temporarily deployed to dev March 4, 2023 00:36 — with GitHub Actions Inactive

provisions table has cid column as pk

40a4f16

gobengo temporarily deployed to dev March 4, 2023 00:55 — with GitHub Actions Inactive

gobengo added 2 commits March 3, 2023 17:15

rename StoreProvisionCreation per review

c1e37f9

rename Provisions ProvisionsStorage

9b9a14d

gobengo requested a review from Gozala March 4, 2023 01:17

gobengo temporarily deployed to dev March 4, 2023 01:18 — with GitHub Actions Inactive

Gozala approved these changes Mar 4, 2023

View reviewed changes

gobengo merged commit 5fb56f7 into main Mar 4, 2023

gobengo deleted the 459-register-space-provider-add branch March 4, 2023 01:20

This was referenced Mar 4, 2023

chore(main): release access 10.0.0 #451

Merged

chore(main): release capabilities 3.1.0 #470

Merged

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

Closed

This was referenced Mar 21, 2023

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

Closed

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

Merged

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

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

Closed

alanshaw mentioned this pull request Mar 27, 2023

implement provider/add for the smaller flow #350

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: access-api handles provider/add invocations #462

feat: access-api handles provider/add invocations #462

gobengo commented Feb 28, 2023 •

edited

Loading

gobengo commented Mar 3, 2023

Gozala left a comment

Gozala Mar 3, 2023

Gozala Mar 3, 2023

gobengo Mar 4, 2023

Gozala Mar 3, 2023

Gozala Mar 4, 2023

gobengo Mar 4, 2023

Gozala Mar 4, 2023

gobengo Mar 4, 2023

Gozala Mar 4, 2023

gobengo Mar 4, 2023

gobengo Mar 4, 2023

alanshaw Mar 6, 2023

Gozala Mar 4, 2023

	export interface StorageProvisionCreation {
	export interface ProvisionModel {

	export interface StorageProvisionCreation {
	export interface Provision {

	export interface Provisions {
	export interface ProvisionStore {

feat: access-api handles provider/add invocations #462

feat: access-api handles provider/add invocations #462

Conversation

gobengo commented Feb 28, 2023 • edited Loading

gobengo commented Mar 3, 2023

Gozala left a 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

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

Choose a reason for hiding this comment

gobengo commented Feb 28, 2023 •

edited

Loading