Mish Ushakov
4fcf7cb150
The specs in `spec/` were copied from their source repos by hand and had
drifted ~2,400 lines behind infra, so they are now imported with
Copybara (`copy.bara.sky`, run in a pinned Docker image by
`scripts/fetch-spec.sh`): `make codegen` re-fetches them at the commits
pinned in `spec/infra-ref` and `spec/belt-ref` before generating, and
the generated-files CI check fails if the tracked copies don't match the
pins. Regenerating from the current pins picks up the accumulated spec
changes in the generated JS/Python clients (renamed request schemas,
`SandboxNetworkConfig`, `SandboxIam` workload identity,
`FILE_TYPE_SYMLINK`, access-token auth deprecation, volume path-metadata
tweaks). The one handwritten SDK change follows from that: the public
`FileType` enums gain a `SYMLINK` member (JS and both Python surfaces)
so entries envd reports as symlinks show up in `files.list()` and
`getInfo()`/`get_info()` instead of being silently skipped as unknown
types. The custom `spec/remove_extra_tags.py` tag-filtering script is
replaced by Redocly CLI's `filter-in` decorator (`redocly.yaml`), which
produces identical generated JS output; a `filter-out` decorator
additionally drops any operation or component schema the upstream specs
mark `x-not-implemented: true` (currently the SOCKS5
`SandboxEgressProxyConfig`/`egressProxy` surface, which infra flagged as
spec-only); each SDK's bundle now goes to its own gitignored
`spec/openapi_generated.<api>.yml` instead of both pipelines overwriting
one shared file; Python client models now list fields in spec order
instead of alphabetical (mechanical reordering only — construct models
with keyword args). Spec fetches try whatever GitHub token is available
and fall back to the tracked copies with a warning (the public infra
specs also fetch anonymously); in CI a short-lived belt-scoped token is
minted from the org-wide Autofixer GitHub App (no new secrets), so fork
PRs simply fall back for the belt spec; the CI workflows also cache the
Copybara image alongside the codegen image, and the previously ignored
`CODEGEN_IMAGE` env is honored by the Makefile.
## Usage
```sh
# update the specs: bump a pin, then regenerate
echo <infra-commit-sha> > spec/infra-ref
make codegen
# fetch a single spec without regenerating
pnpm fetch:api-spec # spec/openapi.yml from infra
pnpm fetch:envd-spec # spec/envd/ from infra
pnpm fetch:volume-spec # spec/openapi-volumecontent.yml from belt
# try the latest spec without touching the pin
E2B_INFRA_REF=main pnpm fetch:api-spec
# change which endpoint tags an SDK exposes
$EDITOR redocly.yaml && make codegen
```
```ts
// symlinks are now visible in the filesystem API (JS; same shape in Python)
const entries = await sandbox.files.list('/home/user')
const link = entries.find((e) => e.type === FileType.SYMLINK)
console.log(link?.symlinkTarget)
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
45 lines
1.5 KiB
Docker
45 lines
1.5 KiB
Docker
FROM golang:1.23
|
|
|
|
# Install Golang deps
|
|
RUN 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
|
|
|
|
|
|
FROM python:3.10
|
|
|
|
# Set working directory
|
|
WORKDIR /workspace
|
|
|
|
# Copy installed Go deps from previous build step
|
|
COPY --from=0 /go /go
|
|
|
|
# Add Go binary to PATH
|
|
ENV PATH="/go/bin:${PATH}"
|
|
|
|
# Install Python deps (e2b-openapi-python-client is patched version to fix issue with explode)
|
|
# https://github.com/openapi-generators/openapi-python-client/pull/1296
|
|
# protoc-gen-py generates the Python envd protobuf-py messages and
|
|
# protoc-gen-connectrpc the Connect stubs.
|
|
RUN pip install black==26.3.1 e2b-openapi-python-client==0.26.2 datamodel-code-generator==0.34.0 protoc-gen-connectrpc==0.11.1 protoc-gen-py==0.1.1
|
|
|
|
# Install Node.js (pinned to match .tool-versions)
|
|
ENV NODE_VERSION=22.18.0
|
|
RUN ARCH=$(uname -m) && \
|
|
case "$ARCH" in \
|
|
x86_64) NODE_ARCH="x64" ;; \
|
|
arm64|aarch64) NODE_ARCH="arm64" ;; \
|
|
*) echo "Unsupported architecture: $ARCH" && exit 1 ;; \
|
|
esac && \
|
|
curl -fsSL https://nodejs.org/dist/v${NODE_VERSION}/node-v${NODE_VERSION}-linux-${NODE_ARCH}.tar.xz | tar -xJ -C /usr/local --strip-components=1
|
|
|
|
# Install Node.js deps
|
|
ENV PNPM_VERSION=9.15.5
|
|
RUN npm install -g \
|
|
pnpm@${PNPM_VERSION} \
|
|
@connectrpc/protoc-gen-connect-es@1.6.1 \
|
|
@bufbuild/protoc-gen-es@2.6.2 \
|
|
@redocly/cli@2.39.0
|
|
|
|
CMD ["make", "generate"]
|