feat: add access/delegate capability parser exported from @web3-storage/capabilities #420

gobengo · 2023-02-01T23:54:07Z

Motivation:

export access/delegate capability parser from @web3-storage/capabilities #414

…tions

…tions dict

…oofs

packages/capabilities/src/access.js

gobengo · 2023-02-02T17:56:03Z

packages/capabilities/src/access.js

+ *
+ * @template {Types.Ability} A
+ * @template {Types.URI} R
+ * @typedef {Types.ParsedCapability<A, R, { delegations?: Types.Failure | Schema.Dictionary<string, Types.Link<unknown, number, number, 0 | 1>> }>} ParsedAccessDelegate


I use this below on lines 159, 160. @Gozala lmk if there is some better way of inferring this type. It's possible I can't just infer it from delegate because it's also used in the definition of delegate (derives) so there is a circularity?

delegations should not be Failure, ucanto will not create parsed capability like that. It will either parse successfully or just fail, it will never partially fail.

Suggested change

* @typedef {Types.ParsedCapability<A, R, { delegations?: Types.Failure | Schema.Dictionary<string, Types.Link<unknown, number, number, 0 | 1>> }>} ParsedAccessDelegate

* @typedef {Types.ParsedCapability<A, R, { delegations?: Schema.Dictionary<string, Types.Link<unknown, number, number, 0 | 1>> }>} ParsedAccessDelegate

Does this not work ?

@Gozala and I met together, and realized I needed to add this type assertion

I proposed this in ucanto to make the type assertion unnecessary storacha/ucanto#215

Gozala · 2023-02-06T17:15:16Z

packages/capabilities/src/access.js

+function subsetsNbDelegations(claim, proof) {
+  /** @param {ParsedAccessDelegate} ucan */
+  const nbDelegationsCids = (ucan) =>
+    new Set(Object.values(ucan.nb.delegations || {}).map(String))


Nit: can you hoist this function, to the top level since it does not enclose anything

hoisted in d03e081

Gozala

Overall looks good, put bunch of comments but ones I'd like to see addressed before landing are:

Remove one layer of set wrapper new Set(new Set(...
Adjustment to how tests are generated so it's easier to follow what going on.

Thanks

Gozala · 2023-02-06T17:16:25Z

packages/capabilities/src/access.js

+  const nbDelegationsCids = (ucan) =>
+    new Set(Object.values(ucan.nb.delegations || {}).map(String))
+  const missingProofs = setDifference(
+    new Set(nbDelegationsCids(claim)),


You create a set and then pass it into a set constructor, which seems unnecessary

Gozala · 2023-02-06T17:28:22Z

packages/capabilities/test/capabilities/access.test.js

+      audience: bob,
+      capabilities: [{ can: 'store/*', with: alice.did() }],
+    })
+    const validInvocations = [


This is really hard to follow and if one of the cases fails the whole test will fail as well. Could you generate tests instead meaning have loop that calls it ? It would be easier to follow and failure in one case will not fail the whole suite.

Gozala · 2023-02-06T17:34:14Z

packages/capabilities/test/capabilities/access.test.js

+        // correct cid
+        [bobCanStoreAllWithAlice.cid.toString(), bobCanStoreAllWithAlice.cid],
+        // not a cid at all
+        ['thisIsNotACid', bobCanStoreAllWithAlice.cid],


🤔 I'm starting to wonder if the whole dict is a good idea here, but then if we chose list it also may not be ordered.

…e definitions

… smaller calls to mocha test()

Gozala

Suggested minor changes, feel free to land as is or change a bit and then land.

packages/capabilities/test/capabilities/access.test.js

Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

🤖 I have created a release *beep* *boop* --- ## [2.3.0](capabilities-v2.2.0...capabilities-v2.3.0) (2023-02-10) ### Features * add `pre` caveat to `store/list` and `upload/list` ([#423](#423)) ([a0f6d28](a0f6d28)) * add access/delegate capability parser exported from @web3-storage/capabilities ([#420](#420)) ([e8e2b1a](e8e2b1a)) * add support for access/authorize and update ([#392](#392)) ([9c8ca0b](9c8ca0b)), closes [#386](#386) * define access/claim in @web3-storage/capabilities ([#409](#409)) ([4d72ba3](4d72ba3)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Note: * this is a superset of #420 * that defines the `access/delegate` capability parsers that this PR adds handlers for in access-api * my intention is to land that #420 before this Motivation: * part of #425

…ge/capabilities (#420) Motivation: * #414 --------- Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

🤖 I have created a release *beep* *boop* --- ## [2.3.0](capabilities-v2.2.0...capabilities-v2.3.0) (2023-02-10) ### Features * add `pre` caveat to `store/list` and `upload/list` ([#423](#423)) ([9cce414](9cce414)) * add access/delegate capability parser exported from @web3-storage/capabilities ([#420](#420)) ([7834cf2](7834cf2)) * add support for access/authorize and update ([#392](#392)) ([bf41071](bf41071)), closes [#386](#386) * define access/claim in @web3-storage/capabilities ([#409](#409)) ([2fb34dd](2fb34dd)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Note: * this is a superset of #420 * that defines the `access/delegate` capability parsers that this PR adds handlers for in access-api * my intention is to land that #420 before this Motivation: * part of #425

Pass the value of the VITE_W3UP_PROVIDER env variable along to registerSpace. This lets us configure the provider used during space registration at the app level.

gobengo added 3 commits February 1, 2023 14:06

basic access/delegate cap

7ecd857

simple happy test for access/delegate

e1823f4

add access/delegate example from spec including a non-empty nb.delega…

62770fa

…tions

gobengo changed the title ~~add access/delegate capability parser exported from @web3-storage/capabilities~~ feat: add access/delegate capability parser exported from @web3-storage/capabilities Feb 1, 2023

access/delegate test various ways of allocating keys in the nb.delega…

cbf3f89

…tions dict

gobengo marked this pull request as ready for review February 2, 2023 00:19

accesss/delegate derives checks .nb.delegations claim is subset of pr…

235e46e

…oofs

gobengo commented Feb 2, 2023

View reviewed changes

packages/capabilities/src/access.js Outdated Show resolved Hide resolved

gobengo added 3 commits February 2, 2023 09:43

remove ts-ignore from access/delegate derives

8922c0b

access/delegate capParser has derives from '*' and 'access/*'

2579081

jsdoc access/delegate

1e256f1

gobengo commented Feb 2, 2023

View reviewed changes

gobengo added 2 commits February 2, 2023 12:20

simplify types in access/delegate caps

4f1f293

test access/delegate malformed

a6e52bf

gobengo mentioned this pull request Feb 2, 2023

fix: add @returns to @ucanto/validator Schema.dictionary() to avoid problematic inference when using derives storacha/ucanto#215

Merged

gobengo requested review from Gozala, hugomrdias and alanshaw February 2, 2023 21:39

gobengo mentioned this pull request Feb 6, 2023

Implement access/delegate in access-api #393

Closed

7 tasks

Gozala reviewed Feb 6, 2023

View reviewed changes

Gozala requested changes Feb 6, 2023

View reviewed changes

gobengo added 2 commits February 6, 2023 11:32

remove unnecessary extra set creations in capabilities access delegat…

d03e081

…e definitions

some access/delegate capability parser mocha tests are now split into…

edeee6b

… smaller calls to mocha test()

gobengo requested review from Gozala and removed request for hugomrdias February 6, 2023 23:21

gobengo mentioned this pull request Feb 7, 2023

feat: handle access/delegate invocations without error #427

Merged

Merge branch 'main' into 1675210470-define-access-delegate-cap

5a8ed04

Gozala approved these changes Feb 7, 2023

View reviewed changes

packages/capabilities/test/capabilities/access.test.js Outdated Show resolved Hide resolved

packages/capabilities/test/capabilities/access.test.js Outdated Show resolved Hide resolved

gobengo and others added 2 commits February 7, 2023 14:13

Update packages/capabilities/test/capabilities/access.test.js

6be0322

Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

Update packages/capabilities/test/capabilities/access.test.js

fce9027

Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

gobengo added 2 commits February 7, 2023 14:21

rm once-used utility function in capabilities access.test.js

57f51ea

Merge branch 'main' into 1675210470-define-access-delegate-cap

f683c33

gobengo merged commit e8e2b1a into main Feb 7, 2023

gobengo deleted the 1675210470-define-access-delegate-cap branch February 7, 2023 22:25

it-dag-house mentioned this pull request Feb 7, 2023

chore(main): release capabilities 2.3.0 #417

Merged

gobengo added a commit that referenced this pull request Apr 11, 2023

feat: add access/delegate capability parser exported from @web3-stora…

7834cf2

…ge/capabilities (#420) Motivation: * #414 --------- Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add access/delegate capability parser exported from @web3-storage/capabilities #420

feat: add access/delegate capability parser exported from @web3-storage/capabilities #420

gobengo commented Feb 1, 2023

gobengo Feb 2, 2023

Gozala Feb 2, 2023

Gozala Feb 2, 2023

gobengo Feb 2, 2023

gobengo Feb 2, 2023

Gozala Feb 6, 2023

gobengo Feb 6, 2023

Gozala left a comment

Gozala Feb 6, 2023

gobengo Feb 6, 2023

Gozala Feb 6, 2023

gobengo Feb 6, 2023

Gozala Feb 6, 2023

Gozala left a comment

	* @typedef {Types.ParsedCapability<A, R, { delegations?: Types.Failure \| Schema.Dictionary<string, Types.Link<unknown, number, number, 0 \| 1>> }>} ParsedAccessDelegate
	* @typedef {Types.ParsedCapability<A, R, { delegations?: Schema.Dictionary<string, Types.Link<unknown, number, number, 0 \| 1>> }>} ParsedAccessDelegate

feat: add access/delegate capability parser exported from @web3-storage/capabilities #420

feat: add access/delegate capability parser exported from @web3-storage/capabilities #420

Conversation

gobengo commented Feb 1, 2023

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

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

Gozala left a comment

Choose a reason for hiding this comment