feat: add store/get and upload/get capabilities
#942
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
olizilla
added a commit
to storacha/specs
that referenced
this pull request
Oct 4, 2023
These capabilities are intended for checking inclusion and allowing users to verify all the shards for an upload have been removed when removing an upload. see also: storacha/w3up#942 License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
olizilla
commented
Oct 17, 2023
Comment on lines
+235
to
+239
| export type Store = InferInvokedCapability<typeof StoreCaps.store> | ||
| export type StoreAdd = InferInvokedCapability<typeof StoreCaps.add> | ||
| export type StoreGet = InferInvokedCapability<typeof StoreCaps.get> | ||
| export type StoreRemove = InferInvokedCapability<typeof StoreCaps.remove> | ||
| export type StoreList = InferInvokedCapability<typeof StoreCaps.list> |
There was a problem hiding this comment.
Update to pull each cap off of StoreCaps to be consistent with all the other caps in this file.
olizilla
commented
Oct 17, 2023
| @@ -271,13 +283,21 @@ export interface StoreListItem { | |||
| link: UnknownLink | |||
| size: number | |||
| origin?: UnknownLink | |||
| insertedAt: string | |||
There was a problem hiding this comment.
add insertedAt to StoreListItem as we already want to return this info for list usage, and it means we can re-use the type for both list and get operations.
olizilla
commented
Oct 17, 2023
Comment on lines
+292
to
+293
| insertedAt: string | ||
| updatedAt: string |
There was a problem hiding this comment.
Add insertedAt and updatedAt props to UploadListItem. We want to share a timestamp with the user about when this upload was added, and these are the props we have. updatedAt currently means "when did we last add a shard to this upload", while insertedAt means "when did you first add a given root cid as an upload to this space."
olizilla
commented
Oct 17, 2023
packages/upload-api/src/types.ts
Outdated
Comment on lines
375
to
381
| inspect: (link: UnknownLink) => Promise<StoreGetOk> | ||
| inspect: (link: UnknownLink) => Promise<StoreInspectOk> |
There was a problem hiding this comment.
Updated the response type for inspect to be StoreInspectOk as StoreGet was confusing... and even more so now I'm adding a StoreGet.
License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
olizilla
commented
Oct 17, 2023
Comment on lines
-75
to
+74
| const item = await context.testStoreTable.get(spaceDid, link) | ||
| const item = await context.storeTable.get(spaceDid, link) |
There was a problem hiding this comment.
storeTable.get is now a thing, so we no longer need the testStoreTable.
olizilla
commented
Oct 17, 2023
Comment on lines
-83
to
-86
| space: item.space, | ||
| link: item.link.toString(), | ||
| size: item.size, | ||
| issuer: item.issuer, |
There was a problem hiding this comment.
i don't think we need to test things here that are not part of the contract
License: MIT Signed-off-by: Oli Evans <[email protected]>
alanshaw
requested changes
Oct 17, 2023
| /** | ||
| * shard CID to fetch info about. | ||
| */ | ||
| link: Link.optional(), |
There was a problem hiding this comment.
I wonder if this should be derivable from store/add (similar to space/info)? i.e. if you were able to store/add you should be able to derive store/get capability for the same link.
Perhaps not, write does not imply read...just thinking out loud.
There was a problem hiding this comment.
is interesting point, but i'm gonna leave it separate for now.
Co-authored-by: Alan Shaw <[email protected]>
…otFound License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
License: MIT Signed-off-by: Oli Evans <[email protected]>
This was referenced Oct 19, 2023
olizilla
pushed a commit
that referenced
this pull request
Oct 19, 2023
🤖 I have created a release *beep* *boop* --- ## [10.2.0](capabilities-v10.1.0...capabilities-v10.2.0) (2023-10-19) ### Features * add `store/get` and `upload/get` capabilities ([#942](#942)) ([40c79eb](40c79eb)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
travis
pushed a commit
that referenced
this pull request
Oct 20, 2023
🤖 I have created a release *beep* *boop* --- ## [10.1.0](upload-client-v10.0.1...upload-client-v10.1.0) (2023-10-20) ### Features * add `store/get` and `upload/get` capabilities ([#942](#942)) ([40c79eb](40c79eb)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
travis
added a commit
that referenced
this pull request
Oct 20, 2023
🤖 I have created a release *beep* *boop* --- ## [9.2.0](w3up-client-v9.1.0...w3up-client-v9.2.0) (2023-10-20) ### Features * add `store/get` and `upload/get` capabilities ([#942](#942)) ([40c79eb](40c79eb)) --- 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: Travis Vachon <[email protected]>
olizilla
added a commit
that referenced
this pull request
Oct 23, 2023
🤖 I have created a release *beep* *boop* --- ## [6.2.0](upload-api-v6.1.0...upload-api-v6.2.0) (2023-10-20) ### Features * add `store/get` and `upload/get` capabilities ([#942](#942)) ([40c79eb](40c79eb)) --- 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: Oli Evans <[email protected]>
olizilla
added a commit
to storacha/specs
that referenced
this pull request
Dec 18, 2023
These capabilities are intended for checking inclusion, or getting the
additional properties we store. This will allow clients to verify all
the shards for an upload have been removed before removing an upload.
## `store/get` delegation
```js
{
can: "store/get",
with: "did:key:abc...",
nb: {
link: "bag...",
}
}
```
### Response
Error if `link` shard cid is not in space or...
```ts
interface StoreListItem {
/** CID of the stored CAR. */
link: string
/** Size in bytes of the stored CAR */
size: number
/** Link to a related CAR, used for sharded uploads */
origin?: string,
/** ISO-8601 timestamp when CAR was added to the space */
insertedAt: string,
}
```
## `upload/get` delegation
```js
{
can: "upload/get",
with: "did:key:abc...",
nb: {
root: "bafyabc..."
}
}
```
### Response
`Error` if root is not in uploads for space or...
```ts
interface UploadListItem {
/** Root CID of the uploaded data item. */
root: string
/** CIDs of CARs that contain the complete DAG for the uploaded data item. */
shards: string[]
/** ISO-8601 timestamp when the upload was added to the space. */
insertedAt: string,
/** ISO-8601 timestamp when the upload entry was last modified. */
updatedAt: string,
}
```
---
see also: storacha/w3up#942
License: MIT
---------
Signed-off-by: Oli Evans <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Capability definitions to allow clients to check for inclusion of cid in store shards or upload roots. Also allows client to fetch the additional properties we store. This will, for example, let a client verify all shards for an upload have been removed before removing an upload.
I'm aiming to simplify things with this PR so that we return insertedAt info on the Upload/Store ListItem types, and return the same object shape for a single object get. If this is pleasing, then I will continue in this direction and make Remove also return the same shape if it removes something
Depends on approval of the new capabilities in storacha/specs#82
TODO:
store/get&upload/getcapabilities specs#82License: MIT