Add filtering option for listing sandboxes

[jakubno]

Description

Allow users to filter out sandbox based on metadata

✨

Description by Callstackai

This PR introduces a filtering option for listing sandboxes based on metadata, allowing users to specify query parameters to filter results.

Diagrams of code changes

sequenceDiagram
    Client->>+API: GET /sandboxes?query=user%3Dabc%26app%3Dprod
    API->>API: Parse query parameter
    API->>API: URL unescape query string
    API->>Orchestrator: GetSandboxes()
    Orchestrator-->>API: Return all sandboxes
    
    alt Has query parameter
        API->>API: Parse filters into key-value pairs
        API->>API: Filter sandboxes based on metadata
        API->>API: Keep only sandboxes matching all filters
    end
    
    API-->>-Client: Return filtered sandboxes

Loading

Files Changed

File	Summary
packages/api/internal/api/api.gen.go	Updated the GetSandboxes method signature to accept filtering parameters.
packages/api/internal/api/spec.gen.go	No changes made.
packages/api/internal/api/types.gen.go	Added a new type GetSandboxesParams to define parameters for the GetSandboxes method.
packages/api/internal/handlers/sandboxes_list.go	Implemented filtering logic in the GetSandboxes method based on query parameters.
spec/openapi.yml	Updated OpenAPI specification to include the new query parameter for filtering sandboxes.

This PR includes files in programming languages that we currently do not support. We have not reviewed files with the extensions .yml. See list of supported languages.

[linear]

E2B-1421 Implement server-side sandbox metadata lookup

[callstackai]

Key Issues

The current implementation is inefficient as it iterates over instanceInfo multiple times for each filter key, which could significantly impact performance on large datasets; consider optimizing by combining filter checks into a single pass.

[callstackai]

Key Issues

The use of nested loops results in inefficient O(n*m) time complexity, which could significantly impact performance on large datasets.

[ValentaTomas]

The next steps here:

• Change naming from filter to query (or similar)
• Ensure the keys and values are escaped
• Ensure we are ready to expand the querying later (make ANDs explicit?)

[jakubno]

Everything should be ready

• Changed naming from filter to query
• Ensured the keys and values are escaped
• We are ready to expand the querying later by adding [reserved characters] (https://datatracker.ietf.org/doc/html/rfc3986#section-2.2)