Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
feat(cli): improve CLI errors
jkomynocd4dd576d1a6
diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 984581743..1c170bed3 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -511,6 +511,9 @@ importers:ts/packages/cli:dependencies:+ '@clack/prompts':+ specifier: 1.0.0-alpha.1+ version: 1.0.0-alpha.1'@composio/client':specifier: 0.1.0-alpha.29version: 0.1.0-alpha.29@@ -547,6 +550,9 @@ importers:open:specifier: ^10.2.0version: 10.2.0+ picocolors:+ specifier: ^1.1.1+ version: 1.1.1semver:specifier: ^7.7.2version: 7.7.2@@ -1088,6 +1094,12 @@ packages:'@changesets/[email protected]':resolution: {integrity: sha512-CdTLvIOPiCNuH71pyDu3rA+Q0n65cmAbXnwWH84rKGiFumFzkmHNT8KHTMEchcxN+Kl8I54xGUhJ7l3E7X396Q==}+ '@clack/[email protected]':+ resolution: {integrity: sha512-rFbCU83JnN7l3W1nfgCqqme4ZZvTTgsiKQ6FM0l+r0P+o2eJpExcocBUWUIwnDzL76Aca9VhUdWmB2MbUv+Qyg==}++ '@clack/[email protected]':+ resolution: {integrity: sha512-07MNT0OsxjKOcyVfX8KhXBhJiyUbDP1vuIAcHc+nx5v93MJO23pX3X/k3bWz6T3rpM9dgWPq90i4Jq7gZAyMbw==}+'@cloudflare/[email protected]':resolution: {integrity: sha512-+tv3z+SPp+gqTIcImN9o0hqE9xyfQjI1XD9pL6NuKjua9B1y7mNYv0S9cP+QEbA4ppVgGZEmKOvHX5G5Ei1CVA==}engines: {node: '>=18.0.0'}@@ -5750,6 +5762,9 @@ packages:resolution: {integrity: sha512-FoqMu0NCGBLCcAkS1qA+XJIQTR6/JHfQXl+uGteNCQ76T91DMUjPa9xfmeqMY3z80nLSg9yQmNjK0Px6RWsH/A==}engines: {node: '>=18'}+ resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==}+resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==}engines: {node: '>=8'}@@ -7097,6 +7112,17 @@ snapshots:human-id: 4.1.1prettier: 2.8.8+ '@clack/[email protected]':+ dependencies:+ picocolors: 1.1.1+ sisteransi: 1.0.5++ '@clack/[email protected]':+ dependencies:+ '@clack/core': 1.0.0-alpha.1+ picocolors: 1.1.1+ sisteransi: 1.0.5+'@cloudflare/[email protected]':dependencies:mime: 3.0.0@@ -9590,6 +9616,14 @@ snapshots:chai: 5.2.0tinyrainbow: 2.0.0+ '@vitest/[email protected]([email protected](@types/[email protected])([email protected])([email protected])([email protected]))':+ dependencies:+ '@vitest/spy': 3.2.4+ estree-walker: 3.0.3+ magic-string: 0.30.17+ optionalDependencies:+'@vitest/[email protected]([email protected](@types/[email protected])([email protected])([email protected])([email protected]))':dependencies:'@vitest/spy': 3.2.4@@ -9598,6 +9632,14 @@ snapshots:optionalDependencies:+ '@vitest/[email protected]([email protected](@types/[email protected])([email protected])([email protected])([email protected]))':+ dependencies:+ '@vitest/spy': 3.2.4+ estree-walker: 3.0.3+ magic-string: 0.30.17+ optionalDependencies:+'@vitest/[email protected]':dependencies:tinyrainbow: 2.0.0@@ -9627,7 +9669,7 @@ snapshots:sirv: 3.0.1tinyglobby: 0.2.14tinyrainbow: 2.0.0- vitest: 3.2.4(@types/[email protected])(@vitest/[email protected])([email protected])([email protected])([email protected])+ vitest: 3.2.4(@types/[email protected])(@vitest/[email protected])([email protected])([email protected])([email protected])'@vitest/[email protected]':dependencies:@@ -12131,6 +12173,8 @@ snapshots:mrmime: 2.0.1totalist: 3.0.1+ [email protected]: {}+@@ -12689,7 +12733,7 @@ snapshots:dependencies:'@types/chai': 5.2.2'@vitest/expect': 3.2.4- '@vitest/mocker': 3.2.4([email protected](@types/[email protected])([email protected])([email protected])([email protected]))+ '@vitest/mocker': 3.2.4([email protected](@types/[email protected])([email protected])([email protected])([email protected]))'@vitest/pretty-format': 3.2.4'@vitest/runner': 3.2.4'@vitest/snapshot': 3.2.4@@ -12773,7 +12817,7 @@ snapshots:dependencies:'@types/chai': 5.2.2'@vitest/expect': 3.2.4- '@vitest/mocker': 3.2.4([email protected](@types/[email protected])([email protected])([email protected])([email protected]))+ '@vitest/mocker': 3.2.4([email protected](@types/[email protected])([email protected])([email protected])([email protected]))'@vitest/pretty-format': 3.2.4'@vitest/runner': 3.2.4'@vitest/snapshot': 3.2.4diff --git a/ts/packages/cli/package.json b/ts/packages/cli/package.jsonindex 357bc1429..c08c8493e 100644--- a/ts/packages/cli/package.json+++ b/ts/packages/cli/package.json@@ -54,6 +54,7 @@"vitest": "^3.2.4"},"dependencies": {+ "@clack/prompts": "1.0.0-alpha.1","@composio/client": "0.1.0-alpha.29","@composio/core": "workspace:*","@composio/ts-builders": "workspace:*",@@ -66,6 +67,7 @@"effect-errors": "^1.10.11","indent-string": "^5.0.0","open": "^10.2.0",+ "picocolors": "^1.1.1","semver": "^7.7.2","superjson": "^2.2.2"},diff --git a/ts/packages/cli/src/bin.ts b/ts/packages/cli/src/bin.tsindex 1a5f98b3c..159b3f834 100644--- a/ts/packages/cli/src/bin.ts+++ b/ts/packages/cli/src/bin.ts@@ -1,6 +1,6 @@import process from 'node:process';-import { Cause, Effect, Exit, Layer, Logger } from 'effect';-import { prettyPrint } from 'effect-errors';+import { Cause, Console, Effect, Exit, Layer, Logger } from 'effect';+import { captureErrors, prettyPrintFromCapturedErrors } from 'effect-errors';import { CliConfig } from '@effect/cli';import { FetchHttpClient } from '@effect/platform';import { BunContext, BunRuntime, BunFileSystem } from '@effect/platform-bun';@@ -91,9 +91,6 @@ const runWithArgs = Effect.flatMap(runWithConfig, run => run(process.argv)) sati* - collects and displays errors*/runWithArgs.pipe(- Effect.provide(layers),- Effect.withConfigProvider(extendConfigProvider(BaseConfigProviderLive)),- Effect.provide(BunContext.layer),Effect.scoped,Effect.withSpan('composio-cli', {attributes: {@@ -102,7 +99,22 @@ runWithArgs.pipe(},}),Effect.sandbox,- Effect.catchAll(e => Effect.fail(prettyPrint(e))),+ Effect.catchAll(+ Effect.fn(function* (cause) {+ const captured = yield* captureErrors(cause, {+ stripCwd: true,+ });+ const message = prettyPrintFromCapturedErrors(captured, {+ hideStackTrace: true,+ stripCwd: true,+ enabled: true,+ });++ yield* Console.error(message);+ })+ ),+ Effect.provide(layers),+ Effect.withConfigProvider(extendConfigProvider(BaseConfigProviderLive)),BunRuntime.runMain({teardown,})diff --git a/ts/packages/cli/src/models/tools.ts b/ts/packages/cli/src/models/tools.tsindex d3fa3dac8..d04dbf827 100644--- a/ts/packages/cli/src/models/tools.ts+++ b/ts/packages/cli/src/models/tools.ts@@ -1,10 +1,17 @@import { Brand, Schema } from 'effect';import { JSONTransformSchema } from './utils/json-transform-schema';+import { extractActual } from './utils/extract-actual';-export const Tool = Schema.String;+export const Tool = Schema.String.annotations({ identifier: 'Tool' });export type Tool = Schema.Schema.Type<typeof Tool>;-export const Tools = Schema.Array(Tool);+export const Tools = Schema.Array(Tool).annotations({+ identifier: 'Array<Tool>',+ message: issue => ({+ message: `Expected an array of strings, got ${extractActual(issue)}`,+ override: true,+ }),+});export type Tools = Schema.Schema.Type<typeof Tools>;export const ToolsJSON = JSONTransformSchema(Tools);diff --git a/ts/packages/cli/src/models/trigger-types.ts b/ts/packages/cli/src/models/trigger-types.tsindex ed15a5028..a25023161 100644--- a/ts/packages/cli/src/models/trigger-types.ts+++ b/ts/packages/cli/src/models/trigger-types.ts@@ -1,10 +1,18 @@import { Brand, Schema } from 'effect';import { JSONTransformSchema } from './utils/json-transform-schema';+import { extractActual } from './utils/extract-actual';-export const TriggerType = Schema.String;+export const TriggerType = Schema.String.annotations({ identifier: 'TriggerType' });export type TriggerType = Schema.Schema.Type<typeof TriggerType>;-export const TriggerTypes = Schema.Array(TriggerType);+export const TriggerTypes = Schema.Array(TriggerType).annotations({+ identifier: 'Array<TriggerType>',+ title: 'TriggerTypes',+ message: issue => ({+ message: `Expected an array of strings, got ${extractActual(issue)}`,+ override: true,+ }),+});export type TriggerTypes = Schema.Schema.Type<typeof TriggerTypes>;export const TriggerTypesJSON = JSONTransformSchema(TriggerTypes);diff --git a/ts/packages/cli/src/models/utils/extract-actual.ts b/ts/packages/cli/src/models/utils/extract-actual.tsnew file mode 100644index 000000000..d141a05d4--- /dev/null+++ b/ts/packages/cli/src/models/utils/extract-actual.ts@@ -0,0 +1,13 @@+import type { ParseIssue } from 'effect/ParseResult';++export function extractActual({ actual }: ParseIssue, cap = 50) {+ // Cap the length of the actual value to 30 characters+ let str = undefined;++ if (typeof actual === 'object') {+ str = JSON.stringify(actual);+ }++ str = String(actual);+ return str.slice(0, cap) + (str.length > cap ? '...' : '');+}diff --git a/ts/packages/cli/src/services/composio-clients.ts b/ts/packages/cli/src/services/composio-clients.tsindex 7dc2d6b26..5f0dc127c 100644--- a/ts/packages/cli/src/services/composio-clients.ts+++ b/ts/packages/cli/src/services/composio-clients.ts@@ -1,11 +1,12 @@-import { pipe, Data, Effect, Option, Schema, Array, Order } from 'effect';+import { pipe, Data, Effect, Option, Schema, Array, Order, ParseResult } from 'effect';import { Composio as _RawComposioClient } from '@composio/client';import { Toolkit, Toolkits } from 'src/models/toolkits';import { Tools } from 'src/models/tools';import { LinkedSession, Session, RetrievedSession } from 'src/models/session';-import { TriggerType } from 'src/models/trigger-types';+import { TriggerTypes } from 'src/models/trigger-types';import { ComposioUserContext, ComposioUserContextLive } from './user-context';import type { NoSuchElementException } from 'effect/Cause';+import { renderPrettyError } from './utils/pretty-error';/*** Error types@@ -15,16 +16,14 @@ import type { NoSuchElementException } from 'effect/Cause';* Error thrown when a HTTP request fails.*/export class HttpServerError extends Data.TaggedError('services/HttpServerError')<{- readonly cause: Error;- readonly message: string;+ readonly cause?: unknown;}> {}/*** Error thrown when a HTTP response doesn't match the expected response schema.*/export class HttpDecodingError extends Data.TaggedError('services/HttpDecodingError')<{- readonly cause: Error;- readonly message: string;+ readonly cause?: unknown;}> {}export type HttpError = HttpServerError | HttpDecodingError;@@ -52,9 +51,24 @@ export type ToolkitsResponse = Schema.Schema.Type<typeof ToolkitsResponse>;export const ToolsResponse = Tools;export type ToolsResponse = Schema.Schema.Type<typeof ToolsResponse>;-export const TriggerTypesResponse = Schema.Array(TriggerType);+export const TriggerTypesResponse = TriggerTypes;export type TriggerResponse = Schema.Schema.Type<typeof TriggerTypesResponse>;+/**+ * Error response schemas+ */+export const HttpErrorResponse = Schema.Struct({+ status: Schema.Int,+ error: Schema.Struct({+ error: Schema.Struct({+ message: Schema.NonEmptyString,+ suggested_fix: Schema.String,+ code: Schema.Int,+ }),+ }),+}).annotations({ identifier: 'HttpErrorResponse' });+export type HttpErrorResponse = Schema.Schema.Type<typeof HttpErrorResponse>;+/*** Utilities*/@@ -70,11 +84,27 @@ const callClient = <T, S extends Schema.Schema<any, any>>(const client = yield* clientSingleton.get();const json = yield* Effect.tryPromise({try: () => apiCall(client),- catch: error => {- const e = error as Error;+ catch: e => {+ const decodedOpt = Schema.decodeUnknownOption(HttpErrorResponse)(e);++ if (Option.isNone(decodedOpt)) {+ return new HttpServerError({+ cause: e,+ });+ }++ const {+ status,+ error: { error },+ } = decodedOpt.value;+ const pretty = renderPrettyError([+ ['code', error.code],+ ['message', error.message],+ ['suggested fix', error.suggested_fix],+ ]);+return new HttpServerError({- cause: e,- message: e.message,+ cause: `HTTP ${status}\n${pretty}`,});},});@@ -82,9 +112,10 @@ const callClient = <T, S extends Schema.Schema<any, any>>(return yield* pipe(Schema.decodeUnknown(responseSchema)(json),Effect.catchTag('ParseError', e => {+ const message = ParseResult.TreeFormatter.formatErrorSync(e);+return new HttpDecodingError({- cause: e,- message: e.message,+ cause: `ParseError\n ${message}`,});}));diff --git a/ts/packages/cli/src/services/upgrade-binary.ts b/ts/packages/cli/src/services/upgrade-binary.tsindex 7d20bae17..47f8f081f 100644--- a/ts/packages/cli/src/services/upgrade-binary.ts+++ b/ts/packages/cli/src/services/upgrade-binary.ts@@ -10,10 +10,11 @@ import { CompareSemverError, semverComparator } from 'src/effects/compare-semver// Note: `node:zlib` does not support Github's zip filesimport decompress from 'decompress';import type { Predicate } from 'effect/Predicate';+import { renderPrettyError } from './utils/pretty-error';export class UpgradeBinaryError extends Data.TaggedError('services/UpgradeBinaryError')<{- readonly cause: Error;- readonly message: string;+ readonly cause?: unknown;+ readonly message?: string;}> {}/**@@ -62,10 +63,13 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upgconst response = yield* Effect.gen(function* () {const resp = yield* httpClient.get(url);if (resp.status < 200 || resp.status >= 300) {+ const json = yield* resp.json;+ const keyValues = Object.entries(json as object);+ const pretty = renderPrettyError(keyValues);+return yield* Effect.fail(new UpgradeBinaryError({- cause: new Error(`HTTP ${resp.status}`),- message: `Failed to fetch ${urlSuffix} release from GitHub`,+ cause: `HTTP ${resp.status}\n${pretty}`,}));}@@ -74,7 +78,7 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/UpgEffect.catchAll(error =>Effect.fail(new UpgradeBinaryError({- cause: new Error(String(error)),+ cause: error,message: `Failed to fetch ${urlSuffix} release from GitHub`,}))@@ -87,7 +91,7 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/UpgEffect.catchAll(error =>Effect.fail(new UpgradeBinaryError({- cause: error as Error,+ cause: error,message: 'Failed to parse GitHub release JSON response',}))diff --git a/ts/packages/cli/src/services/utils/pretty-error.ts b/ts/packages/cli/src/services/utils/pretty-error.tsnew file mode 100644index 000000000..cdb89679d--- /dev/null+++ b/ts/packages/cli/src/services/utils/pretty-error.ts@@ -0,0 +1,33 @@+import colors from 'picocolors';+import { S_BAR, S_BAR_H, unicodeOr } from '@clack/prompts';++const S_CORNER_TOP_LEFT = unicodeOr('╭', '+');+const S_CORNER_BOTTOM_LEFT = unicodeOr('╰', '+');++export function renderPrettyError(errorLines: Array<[key: string, value: unknown]>): string {+ return renderPrettyErrorGen(errorLines).toArray().join('\n');+}++function* renderPrettyErrorGen(+ errorLines: Array<[key: string, value: unknown]>+): Generator<string, void, unknown> {+ if (errorLines.length === 0) {+ yield '';+ } else if (errorLines.length <= 2) {+ for (const [key, value] of errorLines) {+ yield `${colors.gray(S_BAR)} ${colors.blueBright(key)}: ${value}`;+ }+ } else if (errorLines.length > 2) {+ for (let i = 0; i < errorLines.length; i++) {+ const [key, value] = errorLines[i];++ if (i === 0) {+ yield `${colors.gray(`${S_CORNER_TOP_LEFT}${S_BAR_H}`)} ${colors.blueBright(key)}: ${value}`;+ } else if (i === errorLines.length - 1) {+ yield `${colors.gray(`${S_CORNER_BOTTOM_LEFT}${S_BAR_H}`)} ${colors.blueBright(key)}: ${value}`;+ } else {+ yield `${colors.gray(S_BAR)} ${colors.blueBright(key)}: ${value}`;+ }+ }+ }+}