fix(egress/record): rename capability #1572

fforbeck · 2024-10-31T18:46:00Z

Update to `usage/record` Capability

Overview

This PR restructures the usage/record capability, moving it under the Space namespace instead of Usage. As part of this change, the usage/record definition has been renamed to space/content/serve/egress/record, and a new top-level capability, space/content/serve/*, has been introduced.

Key Changes

Namespace Update: The usage/record capability now resides under the Space namespace.
New Naming Convention:
- space/content/serve/egress/record: This capability records egress for all served data.
- space/content/serve/*: New top-level capability, representing general serve actions within the Space.contentServe namespace.

Signed-off-by: Felipe Forbeck <[email protected]>

packages/capabilities/test/capabilities/usage.test.js

alanshaw

As I mentioned before, I don't think this is the way we should do this. There's no delegatation chain back to the user. All we're doing here is using UCAN to verify we can call microservices within our own stack, for which we could simply use a plain HTTP API and a bearer token.

From discord: It's important that the gateway is authorized to record egress. In a future where there are multiple decentralized gateways, there should be no other gateway able to record egress usage for a given space unless authorized to do so. There should be a delegation chain from the user to the gateway that authorizes it to track egress usage so that the user can be billed accordingly.

I'm loathed to approve this - we're going to have to undo it in the future.

packages/upload-api/test/helpers/utils.js

fforbeck · 2024-11-05T16:20:38Z

As I mentioned before, I don't think this is the way we should do this. There's no delegatation chain back to the user. All we're doing here is using UCAN to verify we can call microservices within our own stack, for which we could simply use a plain HTTP API and a bearer token.

From discord: It's important that the gateway is authorized to record egress. In a future where there are multiple decentralized gateways, there should be no other gateway able to record egress usage for a given space unless authorized to do so. There should be a delegation chain from the user to the gateway that authorizes it to track egress usage so that the user can be billed accordingly.

I'm loathed to approve this - we're going to have to undo it in the future.

Thanks for flagging this @alanshaw ! I've updated the code and renamed the capability to make it easy for us in the future. This is ready for review again.

alanshaw

LGTM

packages/capabilities/src/space.js

packages/upload-api/test/helpers/utils.js

🤖 I have created a release *beep* *boop* --- ## [18.1.1](upload-api-v18.1.0...upload-api-v18.1.1) (2024-11-05) ### Fixes * **egress/record:** rename capability ([#1572](#1572)) ([d28691c](d28691c)) --- 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* --- ## [16.4.1](w3up-client-v16.4.0...w3up-client-v16.4.1) (2024-11-05) ### Fixes * **egress/record:** rename capability ([#1572](#1572)) ([d28691c](d28691c)) --- 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.4.1](capabilities-v17.4.0...capabilities-v17.4.1) (2024-11-05) ### Fixes * **egress/record:** rename capability ([#1572](#1572)) ([d28691c](d28691c)) --- 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> Co-authored-by: Felipe Forbeck <[email protected]>

🤖 I have created a release *beep* *boop* --- ## [16.4.1](w3up-client-v16.4.0...w3up-client-v16.4.1) (2024-11-05) ### Fixes * **egress/record:** rename capability ([#1572](#1572)) ([d28691c](d28691c)) --- 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>

This PR restructures the `usage/record` capability, moving it under the `Space` namespace instead of `Usage`. As part of this change, the `usage/record` definition has been renamed to `space/content/serve/egress/record`, and a new top-level capability, `space/content/serve/*`, has been introduced. - **Namespace Update**: The `usage/record` capability now resides under the `Space` namespace. - **New Naming Convention**: - `space/content/serve/egress/record`: This capability records egress for all served data. - `space/content/serve/*`: New top-level capability, representing general serve actions within the `Space.contentServe` namespace. --------- Signed-off-by: Felipe Forbeck <[email protected]>

This PR restructures the `usage/record` capability, moving it under the `Space` namespace instead of `Usage`. As part of this change, the `usage/record` definition has been renamed to `space/content/serve/egress/record`, and a new top-level capability, `space/content/serve/*`, has been introduced. - **Namespace Update**: The `usage/record` capability now resides under the `Space` namespace. - **New Naming Convention**: - `space/content/serve/egress/record`: This capability records egress for all served data. - `space/content/serve/*`: New top-level capability, representing general serve actions within the `Space.contentServe` namespace. ---------

🤖 I have created a release *beep* *boop* --- ## [1.1.2](capabilities-v1.1.1...capabilities-v1.1.2) (2024-12-12) ### Fixes * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([98ab50c](98ab50c)) * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([#97](#97)) ([df8b9a2](df8b9a2)) --- 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* --- ## [1.1.8](upload-api-v1.1.7...upload-api-v1.1.8) (2024-12-12) ### Fixes * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([98ab50c](98ab50c)) * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([#97](#97)) ([df8b9a2](df8b9a2)) --- 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* --- ## [1.0.6](client-v1.0.5...client-v1.0.6) (2024-12-12) ### Fixes * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([98ab50c](98ab50c)) * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([#97](#97)) ([df8b9a2](df8b9a2)) --- 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* --- ## [1.1.8](upload-api-v1.1.7...upload-api-v1.1.8) (2024-12-12) ### Fixes * **egress/record:** Remove unnecessary multiplication for ts conversion ([#98](#98)) ([79ac1ab](79ac1ab)) * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([98ab50c](98ab50c)) * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([#97](#97)) ([df8b9a2](df8b9a2)) * **egressRecord:** Remove unnecessary multiplication for ts conversion ([storacha#1588](https://github.com/storacha/upload-service/issues/1588)) ([1870202](1870202)) --- 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* --- ## [1.0.6](client-v1.0.5...client-v1.0.6) (2024-12-12) ### Fixes * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([98ab50c](98ab50c)) * **egress/record:** rename capability ([storacha#1572](https://github.com/storacha/upload-service/issues/1572)) ([#97](#97)) ([df8b9a2](df8b9a2)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

fix(usage/record): add provider as the resource

a0bbd9e

fforbeck requested a review from travis October 31, 2024 18:46

fforbeck added 3 commits October 31, 2024 21:44

fix: fixed test to resolve did key

4549961

wip: fixing tests

092906f

fix: usage/record tests

3c2866d

Signed-off-by: Felipe Forbeck <[email protected]>

fforbeck marked this pull request as ready for review November 1, 2024 18:19

fforbeck requested review from Peeja, alanshaw and hannahhoward November 1, 2024 18:37

travis reviewed Nov 1, 2024

View reviewed changes

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

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

alanshaw approved these changes Nov 2, 2024

View reviewed changes

packages/upload-api/test/helpers/utils.js Outdated Show resolved Hide resolved

wip: rename usage/record capability

810a2bf

fforbeck changed the title ~~fix(usage/record): add provider as the resource~~ fix(usage/record): rename capability Nov 4, 2024

fforbeck requested review from alanshaw and travis November 4, 2024 20:09

fforbeck changed the title ~~fix(usage/record): rename capability~~ fix(egress/record): rename capability Nov 5, 2024

fix(usage/record) - rename capability

abcbb87

alanshaw approved these changes Nov 5, 2024

View reviewed changes

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

packages/upload-api/test/helpers/utils.js Outdated Show resolved Hide resolved

applied suggested changes

aca9517

fforbeck merged commit d28691c into main Nov 5, 2024
6 checks passed

fforbeck deleted the fix/usage-record-definition branch November 5, 2024 19:16

This was referenced Nov 5, 2024

chore(main): release capabilities 17.4.1 #1574

Merged

chore(main): release w3up-client 16.4.1 #1575

Merged

chore(main): release upload-api 18.1.1 #1576

Merged

github-actions bot mentioned this pull request Nov 5, 2024

chore(main): release w3up-client 16.4.1 #1577

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(egress/record): rename capability #1572

fix(egress/record): rename capability #1572

fforbeck commented Oct 31, 2024 •

edited

Loading

alanshaw left a comment

fforbeck commented Nov 5, 2024

alanshaw left a comment

fix(egress/record): rename capability #1572

fix(egress/record): rename capability #1572

Conversation

fforbeck commented Oct 31, 2024 • edited Loading

Update to usage/record Capability

Overview

Key Changes

alanshaw left a comment

Choose a reason for hiding this comment

fforbeck commented Nov 5, 2024

alanshaw left a comment

Choose a reason for hiding this comment

fforbeck commented Oct 31, 2024 •

edited

Loading

Update to `usage/record` Capability