Add optional depth parameter to envd's ListDir (#524)

Author: 0div

packages/envd/Makefile

@@ -43,9 +43,9 @@ generate:
 		echo "buf is not installed. Do you want to install it?  (Y/n): "; \
 		read choice; \
 		if [ "$$choice" = "Y" ]; then \
-			go install github.com/bufbuild/buf/cmd/buf@latest && \
-			go install google.golang.org/protobuf/cmd/protoc-gen-go@latest && \
-			go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest; \
+			go install github.com/bufbuild/buf/cmd/buf@v1.50.1 && \
+			go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.1 && \
+			go install connectrpc.com/connect/cmd/protoc-gen-connect-go@v1.18.1; \
 		else \
 			exit 1; \
 		fi; \

packages/envd/internal/services/filesystem/dir.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"os"
 	"path"
+	"path/filepath"
+	"strings"
 
 	"github.com/e2b-dev/infra/packages/envd/internal/permissions"
 	rpc "github.com/e2b-dev/infra/packages/envd/internal/services/spec/filesystem"
@@ -13,6 +15,11 @@ import (
 )
 
 func (Service) ListDir(ctx context.Context, req *connect.Request[rpc.ListDirRequest]) (*connect.Response[rpc.ListDirResponse], error) {
+	depth := req.Msg.GetDepth()
+	if depth == 0 {
+		depth = 1 // default depth to current directory
+	}
+
 	u, err := permissions.GetAuthUser(ctx)
 	if err != nil {
 		return nil, err
@@ -36,7 +43,31 @@ func (Service) ListDir(ctx context.Context, req *connect.Request[rpc.ListDirRequ
 		return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("path is not a directory: %s", dirPath))
 	}
 
-	entries, err := os.ReadDir(dirPath)
+	var entries []os.DirEntry
+	err = filepath.WalkDir(dirPath, func(path string, d os.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+
+		// Skip the root directory itself
+		if path == dirPath {
+			return nil
+		}
+
+		// Calculate current depth
+		relPath, err := filepath.Rel(dirPath, path)
+		if err != nil {
+			return err
+		}
+		currentDepth := len(strings.Split(relPath, string(os.PathSeparator)))
+
+		if currentDepth > int(depth) {
+			return filepath.SkipDir
+		}
+
+		entries = append(entries, d)
+		return nil
+	})
 	if err != nil {
 		return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("error reading directory: %w", err))
 	}

packages/envd/internal/services/spec/filesystem/filesystem.pb.go

@@ -32,7 +32,7 @@ const (
 
 var (
 	// These vars are automatically set by goreleaser.
-	Version = "0.1.5"
+	Version = "0.1.6"
 
 	commitSHA string
 

packages/envd/main.go

@@ -62,6 +62,7 @@ enum FileType {
 
 message ListDirRequest {
     string path = 1;
+    uint32 depth = 2;
 }
 
 message ListDirResponse {

packages/envd/spec/filesystem/filesystem.proto

@@ -1,16 +1,22 @@
 # Integration Tests
+
 Package for defining integration tests. Currently, there is a setup for API and Orchestrator testing.
 
 ## Run locally
-1) Setup env variables in the .env file
-2) If necessary, run `make connect-orchestrator` to create a tunnel to one orchestrator client VM in GCP
-3) Run `make test`
+
+1. Setup env variables in the root folder `infra/.env` file
+2. If you made changes to the `api` or `envd` protobuf spec, run `make generate` from this folder (and don't forget to generate it in `envd` if changes apply there too).
+3. If necessary, run `make connect-orchestrator` to create a tunnel to one orchestrator client VM in GCP (you may need to run `make setup-ssh` the first time)
+4. Run `make test` in this folder or `make test-integration` from the root `infra/` folder.
 
 ## Usage of clients (api, orchestrator, envd)
+
 All tests are in the folder internal/tests. You can see the usage of different clients in the tests. Here are just basics.
 
 ### API
+
 HTTP client. In order to pass the API key, use the `setup.WithAPIKey()` option.
+
 ```go
 client := setup.GetAPIClient()
 
@@ -21,19 +27,24 @@ resp, err := client.PostSandboxesWithResponse(ctx, api.NewSandbox{
 ```
 
 ### Orchestrator
+
 GRPC client. There is no authentication needed as it runs behind API in production.
+
 ```go
 client := setup.GetOrchestratorClient(t, ctx)
 resp, err := client.List(ctx, &emptypb.Empty{})
 ```
 
 ### Envd
+
 Envd client is used for interacting with the sandbox.
 There are two API types—HTTP and GRPC.
 Each of them provides different methods for interacting with the sandbox; you need to check which ones you need.
 
 #### HTTP
+
 In order to access correct sandbox URL, you need to pass `setup.WithSandbox(...)` with the required arguments.
+
 ```go
 client := setup.GetEnvdClient(t, ctx)
 resp, err := client.HTTPClient.PostFilesWithBodyWithResponse(
@@ -44,10 +55,12 @@ resp, err := client.HTTPClient.PostFilesWithBodyWithResponse(
 ```
 
 #### GRPC
+
 In order to access correct sandbox URL, you need to call `setup.SetSandboxHeader(...)` with the required arguments.
 
 All methods also expect a user (`user`/`root`) to be set in the header.
 You can achieve it using `setup.SetUserHeader(...)`.
+
 ```go
 client := setup.GetEnvdClient(t, ctx)
 req := connect.NewRequest(&filesystem.ListDirRequest{