docs(tvix/castore/directorysvc): K/V is not necessarily flat r/7570

Some implementations of DirectoryService might not allow retrieval of
intermediate Directory nodes, that are not at the "root".

Think about an object store implementation. The client is doing a
get_recursive anyways to reduce the number of roundtrips.

By documenting the fact we don't need to support looking up intermediate
Directory messages, we can just batch all directories into the same
object, keyed by the root.

Change-Id: I019d720186d03c4125cec9191e93d20586a20963
Reviewed-on: https://cl.tvl.fyi/c/depot/+/10988
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI

1 files changed, 10 insertions, 0 deletions

diff --git a/tvix/castore-go/rpc_directory_grpc.pb.go b/tvix/castore-go/rpc_directory_grpc.pb.go
index f19e457d867b..98789fef833e 100644
--- a/tvix/castore-go/rpc_directory_grpc.pb.go
+++ b/tvix/castore-go/rpc_directory_grpc.pb.go
@@ -35,6 +35,11 @@ type DirectoryServiceClient interface {
 	// Keep in mind multiple DirectoryNodes in different parts of the graph might
 	// have the same digest if they have the same underlying contents,
 	// so sending subsequent ones can be omitted.
+	//
+	// It is okay for certain implementations to only allow retrieval of
+	// Directory digests that are at the "root", aka the last element that's
+	// sent in a Put. This makes sense for implementations bundling closures of
+	// directories together in batches.
 	Get(ctx context.Context, in *GetDirectoryRequest, opts ...grpc.CallOption) (DirectoryService_GetClient, error)
 	// Put uploads a graph of Directory messages.
 	// Individual Directory messages need to be send in an order walking up
@@ -131,6 +136,11 @@ type DirectoryServiceServer interface {
 	// Keep in mind multiple DirectoryNodes in different parts of the graph might
 	// have the same digest if they have the same underlying contents,
 	// so sending subsequent ones can be omitted.
+	//
+	// It is okay for certain implementations to only allow retrieval of
+	// Directory digests that are at the "root", aka the last element that's
+	// sent in a Put. This makes sense for implementations bundling closures of
+	// directories together in batches.
 	Get(*GetDirectoryRequest, DirectoryService_GetServer) error
 	// Put uploads a graph of Directory messages.
 	// Individual Directory messages need to be send in an order walking up