Fix missing blobs request/response #31
Conversation
Blobs are not globally addressable across the BSR, largely for SOC2 compliance so that we can safely and cheaply delete all assets for a repository. Blobs are scoped to a repository. Therefore, when we query for missing blobs, we have to query for missing blobs in the context of a `ModuleRef`. I chose to take the route of querying for multiple sets of module blobs in a single request rather than one request per set of module blobs.
| (buf.validate.field).repeated.min_items = 1, | ||
| (buf.validate.field).repeated.max_items = 250 | ||
| ]; | ||
| } | ||
|
|
||
| message GetMissingBlobDigestsResponse { | ||
| message MissingBlobDigest { | ||
| // The reference to the Module that the missing digests are for. | ||
| ModuleRef module = 1; |
There was a problem hiding this comment.
@bufdev what type would I use here? ModuleRef is marked as request_only.
Is this canonical?
string module_id = 6 [
(buf.validate.field).required = true,
(buf.validate.field).string.uuid = true
];If so, that's incongruent with ModuleRef, which may not be an ID. Ideally the caller doesn't have to make other calls to fetch IDs for the modules (if that's the case, why take in ModuleRef at all).
There was a problem hiding this comment.
It should be Module module = 1 on the response. Good catch.
| (buf.validate.field).repeated.min_items = 1, | ||
| (buf.validate.field).repeated.max_items = 250 | ||
| ]; | ||
| } | ||
|
|
||
| message GetMissingBlobDigestsResponse { | ||
| message MissingBlobDigest { | ||
| // The Module that the missing digests are for. | ||
| Module module = 1 [(buf.validate.field).required = true]; |
There was a problem hiding this comment.
Quite a lot of info just to say "is this the module you requested?", but ok.
| (buf.validate.field).repeated.min_items = 1, | ||
| (buf.validate.field).repeated.max_items = 250 | ||
| ]; | ||
| } | ||
|
|
||
| message GetMissingBlobDigestsResponse { | ||
| message MissingBlobDigest { |
There was a problem hiding this comment.
This isn't a single digest, this is a set of Digests, so this name doesn't make as much sense. I would want to call it ModuleDigests, but then the field repeated ModuleDigests module_digests doesn't really make sense, it's more like repeated ModuleDigests module_digests_es. Plurals for message names rarely make sense.
Perhaps something like ModuleBlobDigestSet, and then repeated ModuleBlobDigestSet module_blob_digest_sets, or just Value and repeated Value values.
|
|
Blobs are not globally addressable across the BSR, largely for SOC2 compliance so that we can safely and cheaply delete all assets for a repository. Blobs are scoped to a repository.
Therefore, when we query for missing blobs, we have to query for missing blobs in the context of a
ModuleRef. I chose to take the route of querying for multiple sets of module blobs in a single request rather than one request per set of module blobs.