mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Alberto Schiabel
5e7432372a
## Problem `composio upgrade` fails on every CLI currently in the field, including stable `0.3.3`: ``` 💥 services/UpgradeBinaryError • Downloaded binary package is incomplete Caused by: Missing companion module: …/extract/composio-darwin-aarch64/acp-adapters/codex/darwin-x64/codex-acp ``` `archiveCompanionRelativePaths` (added 2026-08-18 in #4134) narrows each release archive to the shared ACP assets plus only the one `codex-acp` its platform can execute. That is a sound optimisation, but it shipped writer-first: a CLI released *before* it verifies a downloaded package against `RUN_COMPANION_STATIC_ASSET_RELATIVE_PATHS` — shared assets plus **all four** codex target paths — with no parameter to relax the check, and hard-fails on any archive missing one. Stable `0.3.3` shipped 2026-08-11, a week before that change, so the entire installed stable base is affected. Recovery today means re-running `install.sh` by hand. Evidence: | Archive | codex binaries shipped | | --- | --- | | `0.3.4-beta.351` (pre-#4134) | `darwin-arm64`, `darwin-x64`, `linux-arm64`, `linux-x64` | | `0.4.0-beta.357` (post-#4134) | `darwin-arm64` only | ## Fix The reader has to become tolerant before the writer narrows, and the already-installed reader cannot be patched retroactively. Packaging ships the full companion set again. `archiveCompanionRelativePaths` stays in place with its tests, documented as deliberately uncalled. Re-wiring it into `package-binaries.ts` is a one-line change once no supported client still validates all four paths — worth roughly 651 MB per archive. ## Why CI missed it `cli.test-installation.yml` only exercises fresh `install.sh` installs, which are unaffected: each archive is internally consistent. Nothing covers an in-place upgrade from a previously released binary. Worth closing separately — it needs a real prior-stable binary in the matrix, not a unit test. ## Verification - `vitest run test/src/scripts/release-artifacts.test.ts` — 29 passed - `pnpm --filter @composio/cli typecheck` — clean - `pnpm validate:changesets` — passes (CLI is Changesets-ignored; note lands in `ts/packages/cli/CHANGELOG.md`) - Added coverage asserting every release artifact's codex-acp binary is in the packaged set - Final check is the archive itself: the beta cut from this branch must contain all four `acp-adapters/codex/*/codex-acp` entries, and `composio upgrade` must succeed from a pre-#4134 install `@composio/cli@0.4.0-beta.357` should be abandoned rather than promoted. https://claude.ai/code/session_01JkwtxPHfobZxzvAqe53x62
Composio TypeScript workspace
This directory contains the TypeScript half of the Composio SDK monorepo: the core SDK, provider adapters, the CLI, examples, and end-to-end tests. For an overview of Composio itself, start at the root README and docs.composio.dev.
If you just want to use the SDK:
npm install @composio/core
import { Composio } from '@composio/core';
const composio = new Composio({ apiKey: process.env.COMPOSIO_API_KEY });
const session = await composio.create('user_123');
const tools = await session.tools();
See the @composio/core README and the quickstart for the full flow, including provider setup for your agent framework.
Packages
Published packages:
| Package | Description |
|---|---|
@composio/core |
The Composio SDK. Ships its TypeScript source and SDK docs so installed copies are inspectable by coding agents. |
@composio/slim |
Same API as @composio/core without the packaged source and docs; smaller install. |
composio CLI |
Standalone CLI binary: search, execute, and script tools from your shell. |
@composio/* providers |
Adapters that format Composio tools for agent frameworks (OpenAI, Anthropic, Vercel AI SDK, LangChain, and more). See the provider table. |
@composio/experimental |
Experimental integrations, currently the Pi provider. |
@composio/json-schema-to-zod |
JSON Schema to Zod conversion. |
Internal (unpublished) packages: cli-keyring and cli-local-tools support the CLI; ts-builders generates TypeScript source.
Layout
ts/
packages/ Published and internal packages (see above)
examples/ Runnable examples per feature and framework
e2e-tests/ Runtime E2E tests (Node, Deno, Cloudflare Workers, CLI)
docs/ Workspace SDK docs: API notes and internal guides
scripts/ Build, validation, and scaffolding scripts
vendor/ Read-only reference submodules; do not edit
Development
Commands run from the repository root. Install the pinned toolchain first:
mise install
pnpm install
Build and verify:
pnpm build:packages # build all TS packages
pnpm typecheck # typecheck all TS packages
pnpm lint:packages # oxlint over ts/packages
pnpm test # package unit tests plus example validation
Runtime E2E suites (require credentials):
pnpm test:e2e:node
pnpm test:e2e:deno
pnpm test:e2e:cloudflare
pnpm test:e2e:cli
Scaffolding:
pnpm create:provider <name> [--agentic] # new provider package
pnpm create:example <name> # new example under ts/examples
Changesets are required for changes to published packages; see the contribution guidelines.