feat: ucan invocation handler #133

fforbeck · 2024-12-03T15:26:44Z

Context

To enable the gateway to serve content from a specific space, the space owner must delegate the space/content/serve/* capability to the Gateway. This delegation ensures the Gateway has the authority to serve the content and log egress events accurately.

This PR introduces a new handler to process POST requests to the server's root path. The handler acts as a UCAN Invocation handler, processing access/delegate invocations and extracting relevant delegation proofs. If a delegation proof is valid, it is stored in Cloudflare KV, allowing other handlers to retrieve and verify the proof to determine whether content should be served and egress logged.

Note: It doesn't cover the token verification.

Main Changes

New Functionality

Added withUcanInvocationHandler.js to process access/delegate invocations:
- Validates delegation proofs.
- Stores valid proofs in a Cloudflare KV namespace dedicated to content serve delegations.
Feature Flag: FF_DELEGATIONS_STORAGE_ENABLED if enabled, the new withDelegationsStorage.js handler will be used to find delegations in KV, and the existing withDelegationsStubs.js will be disabled.

Related Issues

alanshaw

Note: as a follow up you'll need to update reads and w3link to proxy POST /.

docs/ucan-handler.md

src/middleware/withUcanInvocationHandler.js

docs/ucan-handler.md

src/index.js

src/server/utils.js

test/unit/middleware/withAuthorizedSpace.spec.js

src/middleware/withDelegationsStorage.js

src/middleware/withDelegationsStorage.types.ts

fforbeck · 2024-12-05T23:00:20Z

Note: as a follow up you'll need to update reads and w3link to proxy POST /.

Sounds good! The PR is ready for another review, @alanshaw .

src/middleware/withDelegationsStorage.js

src/server/index.js

src/index.js

src/middleware/withAuthorizedSpace.js

src/middleware/withAuthorizedSpace.types.ts

src/middleware/withDelegationsStorage.js

src/middleware/withUcanInvocationHandler.js

src/server/utils.js

src/server/service.js

src/server/index.js

Most of the critical changes were implemented. Waiting for final review.

fforbeck · 2024-12-10T16:12:03Z

@Peeja, I will merge this without the token validation for now. Implementing the token will require additional work beyond the scope of Phase 1 of the Egress Billing project. For more details, see issue #213.

Peeja

Apologies for being slow to get back on this, it looks great!

🤖 I have created a release *beep* *boop* --- ## [2.22.0](v2.21.0...v2.22.0) (2024-12-19) ### Features * egress client - ucanto integration ([#123](#123)) ([22bed68](22bed68)) * enable egress tracking in production env ([#135](#135)) ([ad43b62](ad43b62)) * **indexer:** probabilistic feature flag ([#136](#136)) ([dca2b35](dca2b35)) * ucan invocation handler ([#133](#133)) ([b199bfa](b199bfa)) * Use Indexing Service when feature flag is present ([#132](#132)) ([fa3f480](fa3f480)) ### Bug Fixes * **config:** staging kv bidding ([#134](#134)) ([7a523d5](7a523d5)) * **egress-client:** set nonce, expire and fix servedAt ([#130](#130)) ([b135643](b135643)) * enable open telemetry for all envs ([#131](#131)) ([c822465](c822465)) --- 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: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

fforbeck changed the title ~~feat: ucan invocation handler~~ feat!: ucan invocation handler Dec 4, 2024

fforbeck force-pushed the feat/delegate-access-handler branch 3 times, most recently from 7a55163 to 3288275 Compare December 4, 2024 14:27

fforbeck added 8 commits December 4, 2024 12:53

feat: enable POST requests

2edc21b

preparing ucan handler

cf11438

wip

7651904

save spaceContentServe delegations to KV

260bcbf

basic doc

416214b

finding delegations in kv

aba527e

added validation for content serve delegations

f98ef7e

removed locator from withDelegationsStorage

11e5f01

fforbeck force-pushed the feat/delegate-access-handler branch from 535e099 to 11e5f01 Compare December 5, 2024 13:54

fforbeck self-assigned this Dec 5, 2024

fforbeck requested review from alanshaw and Peeja December 5, 2024 13:57

fforbeck marked this pull request as ready for review December 5, 2024 13:57

alanshaw requested changes Dec 5, 2024

View reviewed changes

unit test withDelegationsStorage.js

006da33

fforbeck force-pushed the feat/delegate-access-handler branch from d1a1eec to 006da33 Compare December 5, 2024 16:18

fforbeck added 4 commits December 5, 2024 13:36

fix docs

211a676

implemented suggested changes

0040762

clean up ucanto server code

3fbbbb1

fix did resolver + ucanto.provide

c55018f

fforbeck requested a review from alanshaw December 5, 2024 22:59

alanshaw requested changes Dec 6, 2024

View reviewed changes

src/middleware/withDelegationsStorage.js Outdated Show resolved Hide resolved

src/middleware/withDelegationsStorage.js Outdated Show resolved Hide resolved

src/server/index.js Outdated Show resolved Hide resolved

implemented suggested changes

1d64f0e

fforbeck requested a review from alanshaw December 6, 2024 16:02

alanshaw approved these changes Dec 6, 2024

View reviewed changes

unit tests: withUcanInvocationHandler

a4a61c5

Peeja previously requested changes Dec 6, 2024

View reviewed changes

fforbeck added 2 commits December 6, 2024 16:27

allow N delegations to be stored and retrieved

641b42a

fix lint issues

14a69bc

fforbeck force-pushed the feat/delegate-access-handler branch 2 times, most recently from 25b9df4 to 36a99a0 Compare December 9, 2024 15:24

implemented suggested changes

38f0047

fforbeck force-pushed the feat/delegate-access-handler branch from 36a99a0 to 38f0047 Compare December 9, 2024 15:37

Peeja reviewed Dec 9, 2024

View reviewed changes

src/server/index.js Outdated Show resolved Hide resolved

fforbeck mentioned this pull request Dec 9, 2024

feat(edge-gateway): proxy post requests storacha/reads#201

Closed

remove resolveDIDKey from ucanto server definition

d67fb4a

fforbeck force-pushed the feat/delegate-access-handler branch from 8ecc001 to d67fb4a Compare December 9, 2024 18:21

This was referenced Dec 9, 2024

Update w3link to proxy POST requests to the Freeway UCAN handler storacha/project-tracking#212

Closed

feat(dag-w3s-link): proxy post requests storacha/dag.w3s.link#10

Closed

feat(ucanto-server): proxy post requests storacha/w3link#65

Merged

fforbeck requested a review from Peeja December 10, 2024 14:14

fforbeck force-pushed the feat/delegate-access-handler branch 2 times, most recently from 046b70e to 7e84090 Compare December 11, 2024 13:41

fforbeck changed the title ~~feat!: ucan invocation handler~~ feat: ucan invocation handler Dec 11, 2024

fforbeck force-pushed the feat/delegate-access-handler branch from 7e84090 to 1b44871 Compare December 11, 2024 13:48

minor fixes

b6aa238

fforbeck force-pushed the feat/delegate-access-handler branch from 1b44871 to b6aa238 Compare December 11, 2024 13:51

fforbeck merged commit b199bfa into main Dec 11, 2024
1 check passed

fforbeck deleted the feat/delegate-access-handler branch December 11, 2024 13:54

github-actions bot mentioned this pull request Dec 11, 2024

chore(main): release 2.22.0 #129

Merged

Peeja reviewed Dec 11, 2024

View reviewed changes

fforbeck mentioned this pull request Feb 12, 2025

Fix withDelegationsStorage middleware #155

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ucan invocation handler #133

feat: ucan invocation handler #133

fforbeck commented Dec 3, 2024 •

edited

Loading

alanshaw left a comment

fforbeck commented Dec 5, 2024

fforbeck commented Dec 10, 2024 •

edited

Loading

Peeja left a comment

feat: ucan invocation handler #133

feat: ucan invocation handler #133

Conversation

fforbeck commented Dec 3, 2024 • edited Loading

Context

Main Changes

New Functionality

Related Issues

alanshaw left a comment

Choose a reason for hiding this comment

fforbeck commented Dec 5, 2024

fforbeck commented Dec 10, 2024 • edited Loading

Peeja left a comment

Choose a reason for hiding this comment

fforbeck commented Dec 3, 2024 •

edited

Loading

fforbeck commented Dec 10, 2024 •

edited

Loading