feat!: content serve authorization #1590

fforbeck · 2024-11-26T14:36:57Z

Context

To enable a gateway to serve content from a specific space, we must ensure that the space owner delegates the space/content/serve/* capability to the Gateway. This delegation allows the Gateway to serve content and log egress events appropriately.

I created a new function authorizeContentServe for this implementation and included it in the createSpace flow. This is a breaking change because now the user is forced to provide the DIDs of the Content Serve services, and the connection, or skip the authorization flow.

Additionally, with the authorizeContentServe function, we can implement a feature in the Console App that enables users to explicitly authorize the Freeway Gateway to serve content from existing/legacy spaces.

Main Changes

New Functionality: Added a new function, authorizeContentServe, in the w3up-client module to facilitate the delegation process. Integrated it with the createdSpace flow.
Testing: Introduced test cases to verify the authorization of specified gateways.
Fixes: Resolved issues with previously broken test cases (Egress Record).

Related Issues

packages/w3up-client/src/client.js

packages/w3up-client/test/capability/space.test.js

packages/w3up-client/test/client.test.js

Peeja

Looking good! Just the TypeScript / JSDoc thing.

packages/w3up-client/test/mocks/service.js

packages/w3up-client/test/capability/space.test.js

packages/w3up-client/src/client.js

fforbeck · 2024-12-02T14:14:54Z

packages/upload-api/src/access/claim.js

@@ -13,13 +13,15 @@ export const provide = (ctx) =>

 /**
 * Checks if the given Principal is an Account.
+ *


fixed lint issue

fforbeck · 2024-12-02T14:15:00Z

packages/upload-api/src/access/claim.js

 * @param {API.Principal} principal
 * @returns {principal is API.Principal<API.DID<'mailto'>>}
 */
 const isAccount = (principal) => principal.did().startsWith('did:mailto:')

 /**
 * Returns true when the delegation has a `ucan:*` capability.
+ *


fixed lint issue

fforbeck · 2024-12-02T14:15:12Z

packages/upload-api/src/lib.js

 * @param {Agent<S>} agent
+ * @param {Types.Invocation} invocation


fixed lint issue

Implemented suggested changes.

🤖 I have created a release *beep* *boop* --- ## [18.0.0](capabilities-v17.4.1...capabilities-v18.0.0) (2024-12-05) ### ⚠ BREAKING CHANGES * content serve authorization ([#1590](#1590)) ### Features * content serve authorization ([#1590](#1590)) ([8b553a5](8b553a5)) ### Fixes * **egressRecord:** Remove unnecessary multiplication for ts conversion ([#1588](#1588)) ([b7bc90e](b7bc90e)) ### Other Changes * **main:** release w3up-client 16.4.1 ([#1577](#1577)) ([1482d69](1482d69)) --- 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>

🤖 I have created a release *beep* *boop* --- ## [8.0.0](filecoin-api-v7.3.2...filecoin-api-v8.0.0) (2024-12-09) ### ⚠ BREAKING CHANGES * content serve authorization ([#1590](#1590)) ### Features * content serve authorization ([#1590](#1590)) ([8b553a5](8b553a5)) ### Other Changes * **main:** release w3up-client 16.4.1 ([#1577](#1577)) ([1482d69](1482d69)) --- 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>

🤖 I have created a release *beep* *boop* --- ## [19.0.0](upload-api-v18.1.4...upload-api-v19.0.0) (2024-12-09) ### ⚠ BREAKING CHANGES * content serve authorization ([#1590](#1590)) ### Features * content serve authorization ([#1590](#1590)) ([8b553a5](8b553a5)) --- 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>

🤖 I have created a release *beep* *boop* --- ## [17.0.0](w3up-client-v16.5.2...w3up-client-v17.0.0) (2024-12-09) ### ⚠ BREAKING CHANGES * content serve authorization ([#1590](#1590)) ### Features * content serve authorization ([#1590](#1590)) ([8b553a5](8b553a5)) --- 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>

juliangruber · 2024-12-10T09:31:18Z

I created a new function authorizeContentServe for this implementation and included it in the createSpace flow. This is a breaking change because now the user is forced to provide the DIDs of the Content Serve services, and the connection, or skip the authorization flow.

Do you have any documentation / getting started example for this new behavior?

fforbeck · 2024-12-10T12:48:13Z

Do you have any documentation / getting started example for this new behavior?

Not yet @juliangruber . This functionality will align with other ongoing changes, like this issue. Once those are finalized, the documentation will be updated with all the necessary details to explain the new behavior.

juliangruber · 2024-12-10T12:53:29Z

Got it, thanks. For now we shouldn't upgrade to that version, correct?

fforbeck · 2024-12-10T13:02:13Z

Got it, thanks. For now we shouldn't upgrade to that version, correct?

That's correct. If you keep your w3up-client on version 16.5.2, you won't be required to set the authorization details.

To enable a gateway to serve content from a specific space, we must ensure that the space owner delegates the `space/content/serve/*` capability to the Gateway. This delegation allows the Gateway to serve content and log egress events appropriately. I created a new function `authorizeContentServe` for this implementation and included it in the `createSpace` flow. This is a breaking change because now the user is forced to provide the DIDs of the Content Serve services, and the connection, or skip the authorization flow. Additionally, with the `authorizeContentServe` function, we can implement a feature in the Console App that enables users to explicitly authorize the Freeway Gateway to serve content from existing/legacy spaces. - **New Functionality:** Added a new function, `authorizeContentServe`, in the `w3up-client` module to facilitate the delegation process. Integrated it with the `createdSpace` flow. - **Testing:** Introduced test cases to verify the authorization of specified gateways. - **Fixes:** Resolved issues with previously broken test cases (Egress Record). - storacha/project-tracking#158 - storacha/project-tracking#160

fforbeck self-assigned this Nov 26, 2024

fforbeck requested review from travis, Peeja and alanshaw November 26, 2024 17:58

fforbeck force-pushed the feat/gateway-authorization branch 2 times, most recently from b98e723 to 5d8ba9b Compare November 27, 2024 14:08

fforbeck marked this pull request as ready for review November 27, 2024 14:08

fforbeck mentioned this pull request Nov 27, 2024

Client should authorize Gateway to space/content/serve Spaces by default storacha/project-tracking#158

Closed

2 tasks

alanshaw requested changes Nov 27, 2024

View reviewed changes

Peeja requested changes Nov 27, 2024

View reviewed changes

packages/w3up-client/src/client.js Outdated Show resolved Hide resolved

packages/w3up-client/test/capability/space.test.js Outdated Show resolved Hide resolved

packages/w3up-client/test/client.test.js Outdated Show resolved Hide resolved

Peeja previously requested changes Nov 29, 2024

View reviewed changes

packages/w3up-client/test/mocks/service.js Outdated Show resolved Hide resolved

packages/w3up-client/test/capability/space.test.js Outdated Show resolved Hide resolved

fforbeck added 7 commits November 29, 2024 13:37

feat: authorize gateway

0a98e87

fix tests

d2735dc

implemented reviewer suggestions

5245370

create space and authorize content serve flow

a9c36e9

fix broken tests due to changes in createSpace func

022061e

fix authorizeContentServe test

64b08d1

fix and add tests

7a395a9

fforbeck force-pushed the feat/gateway-authorization branch from 9984a07 to 7a395a9 Compare November 29, 2024 16:37

fforbeck requested review from Peeja and alanshaw November 29, 2024 16:41

lint fix

988ea2d

fforbeck changed the title ~~feat: authorize gateway~~ feat!: content serve authorization Nov 29, 2024

alanshaw requested changes Nov 29, 2024

View reviewed changes

fforbeck force-pushed the feat/gateway-authorization branch 2 times, most recently from e0fb6fb to d533b7a Compare December 2, 2024 14:06

reviewer suggestions implemented

5f414b0

fforbeck force-pushed the feat/gateway-authorization branch from d533b7a to 5f414b0 Compare December 2, 2024 14:09

fforbeck requested a review from alanshaw December 2, 2024 14:14

fforbeck commented Dec 2, 2024

View reviewed changes

packages/upload-api/src/lib.js

* @param {Agent<S>} agent

* @param {Types.Invocation} invocation

Copy link

Member Author

fforbeck Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed lint issue

export authorizeContentServe

d85023d

alanshaw approved these changes Dec 2, 2024

View reviewed changes

fix authorizeContentServe export

8ab9792

fforbeck force-pushed the feat/gateway-authorization branch from 990df46 to 8ab9792 Compare December 3, 2024 15:24

travis merged commit 8b553a5 into main Dec 4, 2024
9 checks passed

travis deleted the feat/gateway-authorization branch December 4, 2024 17:10

This was referenced Nov 29, 2024

chore(main): release capabilities 18.0.0 #1578

Merged

chore(main): release filecoin-api 8.0.0 #1580

Merged

chore(main): release upload-api 19.0.0 #1599

Merged

chore(main): release w3up-client 17.0.0 #1598

Merged

This was referenced Dec 10, 2024

deps: bump @web3-storage/w3up-client from 16.5.2 to 17.0.0 filecoin-station/spark-api#470

Open

deps: bump @web3-storage/w3up-client from 16.5.2 to 17.0.0 filecoin-station/spark-evaluate#424

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: content serve authorization #1590

feat!: content serve authorization #1590

fforbeck commented Nov 26, 2024 •

edited

Loading

Peeja left a comment

fforbeck Dec 2, 2024 •

edited

Loading

fforbeck Dec 2, 2024 •

edited

Loading

fforbeck Dec 2, 2024

juliangruber commented Dec 10, 2024

fforbeck commented Dec 10, 2024

juliangruber commented Dec 10, 2024

fforbeck commented Dec 10, 2024

		* @param {Agent<S>} agent
		* @param {Types.Invocation} invocation

feat!: content serve authorization #1590

feat!: content serve authorization #1590

Conversation

fforbeck commented Nov 26, 2024 • edited Loading

Context

Main Changes

Related Issues

Peeja left a comment

Choose a reason for hiding this comment

fforbeck Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

fforbeck Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

fforbeck Dec 2, 2024

Choose a reason for hiding this comment

juliangruber commented Dec 10, 2024

fforbeck commented Dec 10, 2024

juliangruber commented Dec 10, 2024

fforbeck commented Dec 10, 2024

fforbeck commented Nov 26, 2024 •

edited

Loading

fforbeck Dec 2, 2024 •

edited

Loading

fforbeck Dec 2, 2024 •

edited

Loading