@vellumai/assistant 0.12.2 → 0.12.3-staging.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +2 -0
- package/AGENTS.md +1 -1
- package/docs/architecture/integrations.md +7 -0
- package/docs/architecture/memory.md +17 -2
- package/docs/credential-execution-service.md +1 -1
- package/docs/desktop-browser-cli.md +7 -3
- package/node_modules/@vellumai/ces-client/node_modules/@vellumai/service-contracts/src/__tests__/secret-detection.test.ts +1 -0
- package/node_modules/@vellumai/ces-client/node_modules/@vellumai/service-contracts/src/secret-detection.ts +4 -1
- package/node_modules/@vellumai/environments/src/shell.test.ts +21 -0
- package/node_modules/@vellumai/environments/src/shell.ts +24 -0
- package/node_modules/@vellumai/gateway-client/node_modules/@vellumai/service-contracts/src/__tests__/secret-detection.test.ts +1 -0
- package/node_modules/@vellumai/gateway-client/node_modules/@vellumai/service-contracts/src/secret-detection.ts +4 -1
- package/node_modules/@vellumai/gateway-client/src/inbound-contract.ts +8 -2
- package/node_modules/@vellumai/service-contracts/src/__tests__/secret-detection.test.ts +1 -0
- package/node_modules/@vellumai/service-contracts/src/secret-detection.ts +4 -1
- package/openapi.yaml +54 -5
- package/package.json +1 -1
- package/scripts/smoke-desktop-browser-cli.ts +1 -0
- package/scripts/sync-llm-catalog.ts +3 -0
- package/scripts/voice-ttft-spike.ts +2 -2
- package/src/__tests__/agent-loop.test.ts +259 -0
- package/src/__tests__/agent-wake-delegation-prompt.test.ts +64 -2
- package/src/__tests__/anthropic-provider.test.ts +55 -0
- package/src/__tests__/approval-interception-trust-gates.test.ts +40 -0
- package/src/__tests__/attachments-store.test.ts +22 -3
- package/src/__tests__/channel-approval.test.ts +9 -14
- package/src/__tests__/channel-reply-delivery.test.ts +56 -0
- package/src/__tests__/chat-credential-redaction.test.ts +23 -0
- package/src/__tests__/computer-use-screenshot-attachments.test.ts +411 -0
- package/src/__tests__/computer-use-screenshot-selection.test.ts +50 -0
- package/src/__tests__/conversation-agent-loop-inference-profile.test.ts +2 -0
- package/src/__tests__/conversation-agent-loop-overflow.test.ts +2 -0
- package/src/__tests__/conversation-agent-loop.test.ts +257 -6
- package/src/__tests__/conversation-attachments.test.ts +106 -0
- package/src/__tests__/conversation-fork-crud.test.ts +191 -0
- package/src/__tests__/conversation-rendered-delegation-state.test.ts +276 -0
- package/src/__tests__/credential-execution-client.test.ts +70 -53
- package/src/__tests__/db-conversation-tool-surface.test.ts +221 -0
- package/src/__tests__/events-tail-route.test.ts +33 -0
- package/src/__tests__/history-repair.test.ts +53 -0
- package/src/__tests__/inference-profile-session-handler.test.ts +26 -0
- package/src/__tests__/list-messages-tool-merge.test.ts +85 -1
- package/src/__tests__/llm-catalog-parity.test.ts +27 -4
- package/src/__tests__/oauth-apps-routes.test.ts +1 -0
- package/src/__tests__/oauth-commands-routes.test.ts +114 -101
- package/src/__tests__/oauth-connect-orchestrator.test.ts +2 -0
- package/src/__tests__/oauth-provider-serializer.test.ts +1 -0
- package/src/__tests__/oauth-providers-routes.test.ts +2 -0
- package/src/__tests__/persist-media-references.test.ts +50 -0
- package/src/__tests__/plugin-import-boundary-guard.test.ts +0 -1
- package/src/__tests__/run-conversation-turn-persistence.test.ts +138 -1
- package/src/__tests__/schedule-routes.test.ts +20 -0
- package/src/__tests__/scheduler-result-notification.test.ts +23 -4
- package/src/__tests__/script-proxy-certs.test.ts +1 -1
- package/src/__tests__/secret-routes-platform-proxy.test.ts +86 -31
- package/src/__tests__/secret-routes-scrub.test.ts +22 -27
- package/src/__tests__/secret-scanner.test.ts +20 -0
- package/src/__tests__/secure-keys-managed-failover.test.ts +8 -0
- package/src/__tests__/secure-keys.test.ts +7 -3
- package/src/__tests__/server-tool-pairing.test.ts +107 -0
- package/src/__tests__/skills.test.ts +5 -4
- package/src/__tests__/subagent-tool-gate-mode.test.ts +226 -0
- package/src/__tests__/terminal-tools.test.ts +8 -0
- package/src/__tests__/tool-result-follow-up.test.ts +99 -0
- package/src/__tests__/tool-result-metadata-plumbing.test.ts +63 -0
- package/src/__tests__/unicode.test.ts +36 -0
- package/src/agent/loop.ts +37 -12
- package/src/agent/tool-result-follow-up.ts +70 -0
- package/src/api/attachment-provenance.test.ts +68 -0
- package/src/api/computer-use-tool.test.ts +55 -0
- package/src/api/computer-use-tool.ts +27 -0
- package/src/api/events/assistant-outbound-attachment.ts +3 -0
- package/src/api/events/desktop-activity-changed.ts +10 -0
- package/src/api/events/question-request.ts +1 -0
- package/src/api/index.ts +11 -0
- package/src/api/responses/conversation-message.ts +3 -0
- package/src/approvals/approval-primitive.ts +5 -2
- package/src/approvals/scoped-approval-grants.ts +6 -2
- package/src/browser/virtual-desktop-target.ts +1 -2
- package/src/cli/commands/__tests__/cli-test-harness.ts +21 -3
- package/src/cli/commands/__tests__/plugins.test.ts +20 -1
- package/src/cli/commands/__tests__/schedules.test.ts +14 -0
- package/src/cli/commands/bash.help.ts +4 -3
- package/src/cli/commands/browser.help.ts +5 -1
- package/src/cli/commands/credentials.help.ts +3 -3
- package/src/cli/commands/oauth/index.help.ts +10 -0
- package/src/cli/commands/oauth/providers.ts +12 -0
- package/src/cli/commands/oauth/request.test.ts +179 -2
- package/src/cli/commands/oauth/request.ts +41 -10
- package/src/cli/commands/plugins.ts +12 -5
- package/src/cli/commands/schedules.ts +2 -0
- package/src/cli/lib/__tests__/inspect-plugin.test.ts +54 -0
- package/src/cli/lib/__tests__/install-from-github.test.ts +41 -0
- package/src/cli/lib/__tests__/local-plugin-upgrade.test.ts +133 -51
- package/src/cli/lib/__tests__/plugin-catalog-cache.test.ts +8 -2
- package/src/cli/lib/bundled-marketplace.json +855 -0
- package/src/cli/lib/bundled-plugin-packages.json +783 -1
- package/src/cli/lib/inspect-plugin.ts +11 -4
- package/src/cli/lib/upgrade-plugin.ts +19 -11
- package/src/cli/output.ts +18 -4
- package/src/config/__tests__/default-provider.test.ts +4 -0
- package/src/config/bundled-skills/schedule/SKILL.md +6 -6
- package/src/config/loader.ts +9 -17
- package/src/config/platform-identity.ts +8 -8
- package/src/config/profile-text-generation.test.ts +51 -0
- package/src/config/profile-text-generation.ts +51 -0
- package/src/config/schemas/__tests__/memory-v3.test.ts +12 -0
- package/src/config/schemas/llm.ts +7 -2
- package/src/config/schemas/mcp.ts +5 -1
- package/src/config/schemas/memory-v3.ts +12 -0
- package/src/credential-execution/ces-runtime.ts +2 -2
- package/src/credential-execution/executable-discovery.ts +36 -134
- package/src/credential-execution/process-manager.test.ts +20 -24
- package/src/credential-execution/process-manager.ts +24 -19
- package/src/daemon/__tests__/conversation-tool-setup.test.ts +43 -0
- package/src/daemon/__tests__/turn-tail-deleted-conversation.test.ts +36 -0
- package/src/daemon/assistant-attachments.ts +20 -12
- package/src/daemon/chat-credential-redaction.ts +16 -1
- package/src/daemon/conversation-agent-loop-handlers.ts +74 -3
- package/src/daemon/conversation-agent-loop.ts +12 -0
- package/src/daemon/conversation-attachments.ts +93 -12
- package/src/daemon/conversation-tool-setup.ts +71 -3
- package/src/daemon/conversation-turn-finalize.ts +26 -13
- package/src/daemon/conversation.ts +72 -17
- package/src/daemon/daemon-control.ts +3 -7
- package/src/daemon/lifecycle.ts +4 -4
- package/src/daemon/mcp-reload-service.ts +1 -1
- package/src/daemon/message-types/shared.ts +1 -0
- package/src/daemon/orphan-reaper.ts +4 -3
- package/src/daemon/persist-media-references.ts +20 -3
- package/src/daemon/tool-setup-types.ts +6 -0
- package/src/daemon/wake-conversation-ops.ts +50 -15
- package/src/desktop/desktop-automation-lease.test.ts +230 -0
- package/src/desktop/desktop-automation-lease.ts +90 -6
- package/src/desktop/desktop-help.ts +15 -0
- package/src/desktop/desktop-stream-bridge.test.ts +65 -10
- package/src/desktop/desktop-stream-bridge.ts +3 -3
- package/src/desktop/desktop-wallpaper-renderer.ts +132 -0
- package/src/desktop/desktop-wallpaper-worker.ts +17 -0
- package/src/desktop/desktop-wallpaper.test.ts +48 -7
- package/src/desktop/desktop-wallpaper.ts +34 -102
- package/src/desktop/virtual-desktop-feature.ts +1 -1
- package/src/mcp/__tests__/manager-tool-caps.test.ts +111 -0
- package/src/mcp/__tests__/startup.test.ts +30 -7
- package/src/mcp/__tests__/tool-caps.test.ts +107 -0
- package/src/mcp/manager.ts +168 -101
- package/src/mcp/startup.ts +33 -13
- package/src/mcp/tool-caps.ts +176 -0
- package/src/messaging/provider-message-metadata.ts +3 -3
- package/src/notifications/__tests__/copy-composer.test.ts +70 -0
- package/src/notifications/copy-composer.ts +11 -3
- package/src/notifications/schedule-result-producer.ts +4 -6
- package/src/oauth/AGENTS.md +2 -0
- package/src/oauth/__tests__/identity-verifier.test.ts +36 -1
- package/src/oauth/identity-verifier.ts +24 -0
- package/src/oauth/oauth-store.ts +11 -1
- package/src/oauth/provider-serializer.ts +1 -0
- package/src/oauth/seed-providers.ts +12 -0
- package/src/permissions/confirmation-guardian-request.test.ts +16 -0
- package/src/permissions/confirmation-guardian-request.ts +2 -3
- package/src/permissions/question-prompter.test.ts +31 -0
- package/src/permissions/question-prompter.ts +2 -0
- package/src/persistence/attachments-store.ts +84 -44
- package/src/persistence/conversation-crud.ts +111 -20
- package/src/persistence/conversation-plugin-facade.ts +30 -0
- package/src/persistence/conversation-tool-surface.ts +135 -0
- package/src/persistence/conversation-types.test.ts +32 -0
- package/src/persistence/conversation-types.ts +26 -4
- package/src/persistence/migrations/378-create-conversation-tool-surfaces.test.ts +78 -0
- package/src/persistence/migrations/378-create-conversation-tool-surfaces.ts +29 -0
- package/src/persistence/migrations/379-oauth-providers-response-ok-field.test.ts +92 -0
- package/src/persistence/migrations/379-oauth-providers-response-ok-field.ts +32 -0
- package/src/persistence/migrations/380-conversation-tool-surfaces-delegate-independent-tasks.test.ts +90 -0
- package/src/persistence/migrations/380-conversation-tool-surfaces-delegate-independent-tasks.ts +34 -0
- package/src/persistence/schema/conversation-tool-surfaces.ts +32 -0
- package/src/persistence/schema/index.ts +1 -0
- package/src/persistence/schema/oauth.ts +1 -0
- package/src/persistence/steps.ts +24 -3
- package/src/plugin-api/conversation-turn.ts +31 -7
- package/src/plugin-api/index.ts +11 -1
- package/src/plugin-api/plugin-channel-turn-trust.test.ts +133 -0
- package/src/plugin-api/plugin-channel-turn-trust.ts +71 -0
- package/src/plugins/defaults/memory/AGENTS.md +39 -5
- package/src/plugins/defaults/memory/__tests__/buffer-file.test.ts +365 -0
- package/src/plugins/defaults/memory/__tests__/buffer-format.test.ts +43 -0
- package/src/plugins/defaults/memory/__tests__/conversation-memory-purge.test.ts +1 -0
- package/src/plugins/defaults/memory/__tests__/db-memory-attach.test.ts +2 -0
- package/src/plugins/defaults/memory/__tests__/fixtures/buffer-appender.ts +17 -0
- package/src/plugins/defaults/memory/__tests__/memory-retrospective-job.test.ts +74 -0
- package/src/plugins/defaults/memory/__tests__/memory-run-evidence.test.ts +161 -0
- package/src/plugins/defaults/memory/__tests__/relocated-memory-test-rows.ts +10 -0
- package/src/plugins/defaults/memory/buffer-file.ts +354 -0
- package/src/plugins/defaults/memory/buffer-format.ts +40 -0
- package/src/plugins/defaults/memory/context-search/agent-runner.ts +1 -2
- package/src/plugins/defaults/memory/context-search/format.ts +2 -1
- package/src/plugins/defaults/memory/context-search/sources/memory-v2.ts +2 -1
- package/src/plugins/defaults/memory/context-search/sources/workspace.ts +2 -1
- package/src/plugins/defaults/memory/conversation-memory-purge.ts +4 -0
- package/src/plugins/defaults/memory/graph/capability-seed.ts +1 -2
- package/src/plugins/defaults/memory/graph/tool-handlers.ts +1 -42
- package/src/plugins/defaults/memory/host-utils.ts +0 -10
- package/src/plugins/defaults/memory/injectors.ts +4 -3
- package/src/plugins/defaults/memory/memory-retrospective-job.ts +72 -183
- package/src/plugins/defaults/memory/memory-run-evidence.ts +213 -0
- package/src/plugins/defaults/memory/src/memory-item-routes.test.ts +1 -1
- package/src/plugins/defaults/memory/substrate/__tests__/consolidation-job.test.ts +407 -99
- package/src/plugins/defaults/memory/substrate/__tests__/consolidation-prompt-flag-gating-guard.test.ts +10 -0
- package/src/plugins/defaults/memory/substrate/__tests__/prompts-consolidation.test.ts +107 -7
- package/src/plugins/defaults/memory/substrate/consolidation-job.ts +307 -86
- package/src/plugins/defaults/memory/substrate/consolidation-tool-surface.ts +34 -0
- package/src/plugins/defaults/memory/substrate/page-index.ts +2 -1
- package/src/plugins/defaults/memory/substrate/prompts/consolidation.ts +89 -49
- package/src/plugins/defaults/memory/substrate/sweep-job.ts +1 -1
- package/src/plugins/defaults/memory/tools.ts +1 -1
- package/src/plugins/defaults/memory/v1/graph/consolidation.ts +2 -2
- package/src/plugins/defaults/memory/v1/graph/extraction.ts +2 -1
- package/src/plugins/defaults/memory/v1/graph/retriever.ts +1 -1
- package/src/plugins/defaults/memory/v2/__tests__/migration.test.ts +5 -0
- package/src/plugins/defaults/memory/v2/__tests__/reranker.test.ts +5 -2
- package/src/plugins/defaults/memory/v2/reranker.ts +2 -1
- package/src/plugins/defaults/memory/v3/__tests__/injection.test.ts +81 -1
- package/src/plugins/defaults/memory/v3/__tests__/orchestrate.test.ts +87 -0
- package/src/plugins/defaults/memory/v3/__tests__/plugin-schema.test.ts +12 -0
- package/src/plugins/defaults/memory/v3/__tests__/pool-log-store.test.ts +183 -4
- package/src/plugins/defaults/memory/v3/__tests__/shadow-plugin.test.ts +103 -2
- package/src/plugins/defaults/memory/v3/card.ts +2 -1
- package/src/plugins/defaults/memory/v3/injector.ts +212 -178
- package/src/plugins/defaults/memory/v3/orchestrate.ts +112 -25
- package/src/plugins/defaults/memory/v3/plugin-schema.ts +54 -4
- package/src/plugins/defaults/memory/v3/pool-log-store.ts +253 -1
- package/src/plugins/defaults/memory/v3/pool-select.test.ts +35 -2
- package/src/plugins/defaults/memory/v3/pool-select.ts +31 -19
- package/src/plugins/defaults/memory/v3/sections.ts +2 -1
- package/src/plugins/defaults/memory/v3/shadow-plugin.ts +41 -14
- package/src/plugins/defaults/tool-error/hooks/post-tool-use.ts +4 -1
- package/src/plugins/defaults/tool-result-truncate/terminal.ts +1 -46
- package/src/prompts/__tests__/parallel-tasks-section.test.ts +25 -0
- package/src/prompts/delegation-gate.ts +57 -0
- package/src/prompts/system-prompt.ts +14 -32
- package/src/providers/inference/adapter-factory.ts +6 -0
- package/src/providers/jev/client.test.ts +260 -0
- package/src/providers/jev/client.ts +518 -0
- package/src/providers/model-catalog.ts +58 -3
- package/src/providers/server-tool-pairing.ts +16 -7
- package/src/runtime/AGENTS.md +2 -2
- package/src/runtime/__tests__/agent-wake.test.ts +94 -1
- package/src/runtime/agent-wake.ts +31 -4
- package/src/runtime/guardian-action-service.ts +2 -17
- package/src/runtime/guardian-reply-router.ts +1 -8
- package/src/runtime/http-server.ts +2 -2
- package/src/runtime/migrations/__tests__/vbundle-import-policy.test.ts +89 -0
- package/src/runtime/migrations/vbundle-import-policy.ts +33 -11
- package/src/runtime/routes/__tests__/inference-profiles-routes.test.ts +24 -2
- package/src/runtime/routes/channel-route-shared.ts +1 -9
- package/src/runtime/routes/conversation-routes.ts +29 -4
- package/src/runtime/routes/desktop-setup-routes.test.ts +2 -2
- package/src/runtime/routes/desktop-setup-routes.ts +8 -5
- package/src/runtime/routes/guardian-approval-interception.ts +24 -0
- package/src/runtime/routes/inbound-message-handler.ts +2 -3
- package/src/runtime/routes/inbound-stages/background-dispatch.test.ts +1 -1
- package/src/runtime/routes/inbound-stages/background-dispatch.ts +7 -4
- package/src/runtime/routes/inference-profile-session-handler.ts +11 -1
- package/src/runtime/routes/inference-profiles-routes.ts +9 -0
- package/src/runtime/routes/oauth-commands-routes.ts +57 -54
- package/src/runtime/routes/oauth-providers.ts +4 -0
- package/src/runtime/routes/oauth-request-hints.test.ts +246 -0
- package/src/runtime/routes/oauth-request-hints.ts +149 -0
- package/src/runtime/routes/schedule-routes.ts +2 -0
- package/src/runtime/routes/secret-routes.ts +99 -119
- package/src/schedule/__tests__/worker-mcp-bootstrap.test.ts +107 -0
- package/src/schedule/__tests__/worker-mcp-readiness.test.ts +173 -0
- package/src/schedule/__tests__/worker-mcp-tools.test.ts +13 -47
- package/src/schedule/run-script.ts +2 -2
- package/src/schedule/scheduler.ts +47 -11
- package/src/schedule/tool-surface-readiness.ts +65 -0
- package/src/schedule/worker-mcp.ts +85 -0
- package/src/schedule/worker.ts +9 -31
- package/src/security/secure-keys.ts +60 -48
- package/src/tools/ask-question/ask-question-tool.test.ts +167 -5
- package/src/tools/ask-question/ask-question-tool.ts +119 -23
- package/src/tools/browser/browser-execution.ts +7 -1
- package/src/tools/host-terminal/host-shell.ts +12 -6
- package/src/tools/shared/filesystem/file-ops-service.ts +1 -31
- package/src/tools/shared/shell-output.test.ts +10 -0
- package/src/tools/shared/shell-output.ts +14 -2
- package/src/tools/skills/sandbox-runner.ts +13 -2
- package/src/tools/skills/scaffold-managed.ts +2 -1
- package/src/tools/terminal/__tests__/safe-env.test.ts +33 -4
- package/src/tools/terminal/__tests__/sanitized-bash.test.ts +0 -14
- package/src/tools/terminal/safe-env.ts +35 -24
- package/src/tools/terminal/sanitized-bash.ts +15 -2
- package/src/tools/terminal/shell-launch.test.ts +162 -0
- package/src/tools/terminal/shell.test.ts +29 -0
- package/src/tools/terminal/shell.ts +13 -7
- package/src/util/browser-human-verification.ts +14 -0
- package/src/util/host-process.test.ts +17 -1
- package/src/util/host-process.ts +24 -0
- package/src/util/unicode.ts +29 -0
|
@@ -105,8 +105,11 @@ export interface BackgroundProcessingParams {
|
|
|
105
105
|
chatType?: string;
|
|
106
106
|
/** IANA timezone reported by the active client for the current turn. */
|
|
107
107
|
clientTimezone?: string;
|
|
108
|
-
/**
|
|
109
|
-
|
|
108
|
+
/**
|
|
109
|
+
* The message addresses the assistant by name, as stated by the channel
|
|
110
|
+
* (`sourceMetadata.botMentioned`). Absent means not established.
|
|
111
|
+
*/
|
|
112
|
+
botMentioned?: boolean;
|
|
110
113
|
/**
|
|
111
114
|
* Slack-specific inbound metadata extracted at the HTTP boundary. Threaded
|
|
112
115
|
* through to `persistUserMessage` so the row can be tagged with a
|
|
@@ -166,7 +169,7 @@ export function processChannelMessageInBackground(
|
|
|
166
169
|
sourceLanguageCode,
|
|
167
170
|
chatType,
|
|
168
171
|
clientTimezone,
|
|
169
|
-
|
|
172
|
+
botMentioned,
|
|
170
173
|
slackInbound,
|
|
171
174
|
channelInbound,
|
|
172
175
|
slackReactionRowMeta,
|
|
@@ -204,7 +207,7 @@ export function processChannelMessageInBackground(
|
|
|
204
207
|
initiatorUserId: slackInbound?.actorExternalUserId,
|
|
205
208
|
startImmediately: shouldShowActivityImmediately({
|
|
206
209
|
chatType,
|
|
207
|
-
botMentioned
|
|
210
|
+
botMentioned,
|
|
208
211
|
}),
|
|
209
212
|
});
|
|
210
213
|
const stopApprovalWatcher = replyCallbackUrl
|
|
@@ -16,6 +16,10 @@ import { randomUUID } from "node:crypto";
|
|
|
16
16
|
|
|
17
17
|
import { getUserSelectableProfilesForProvider } from "../../config/default-profile-catalog.js";
|
|
18
18
|
import { loadConfig } from "../../config/loader.js";
|
|
19
|
+
import {
|
|
20
|
+
nonTextConversationProfileMessage,
|
|
21
|
+
profileSupportsTextGeneration,
|
|
22
|
+
} from "../../config/profile-text-generation.js";
|
|
19
23
|
import { findConversation } from "../../daemon/conversation-registry.js";
|
|
20
24
|
import {
|
|
21
25
|
getConversation,
|
|
@@ -163,10 +167,16 @@ export async function setInferenceProfileSession({
|
|
|
163
167
|
);
|
|
164
168
|
}
|
|
165
169
|
|
|
170
|
+
const selectable = profiles as Record<string, unknown>;
|
|
171
|
+
const selected = selectable[profile] as Record<string, unknown>;
|
|
172
|
+
if (!profileSupportsTextGeneration(selected, selectable)) {
|
|
173
|
+
throw new BadRequestError(nonTextConversationProfileMessage(profile));
|
|
174
|
+
}
|
|
175
|
+
|
|
166
176
|
// Pinning a profile that provably cannot dispatch turns the next turn in
|
|
167
177
|
// this conversation into a hard failure, so refuse the pin the same way the
|
|
168
178
|
// active-profile setter does.
|
|
169
|
-
const entry =
|
|
179
|
+
const entry = selected;
|
|
170
180
|
const availability = await computeProfileAvailability(entry);
|
|
171
181
|
if (isUnavailable(availability)) {
|
|
172
182
|
throw new BadRequestError(
|
|
@@ -29,6 +29,10 @@ import {
|
|
|
29
29
|
getConfigReadOnly,
|
|
30
30
|
loadRawConfig,
|
|
31
31
|
} from "../../config/loader.js";
|
|
32
|
+
import {
|
|
33
|
+
nonTextConversationProfileMessage,
|
|
34
|
+
profileSupportsTextGeneration,
|
|
35
|
+
} from "../../config/profile-text-generation.js";
|
|
32
36
|
import {
|
|
33
37
|
ProfileEntry,
|
|
34
38
|
routingIdentityModelIssue,
|
|
@@ -891,6 +895,11 @@ async function handleSetActiveProfile({ body = {} }: RouteHandlerArgs) {
|
|
|
891
895
|
`Profile "${name}" is disabled and cannot be set as the active profile. Enable it first, or pick another.`,
|
|
892
896
|
);
|
|
893
897
|
}
|
|
898
|
+
if (
|
|
899
|
+
!profileSupportsTextGeneration(entry, effective as Record<string, unknown>)
|
|
900
|
+
) {
|
|
901
|
+
throw new BadRequestError(nonTextConversationProfileMessage(name));
|
|
902
|
+
}
|
|
894
903
|
// No escape hatch here: an active profile that cannot dispatch locks the
|
|
895
904
|
// user out of chat entirely, and nothing about the write signals that.
|
|
896
905
|
await guardProfileAvailability({
|
|
@@ -20,7 +20,10 @@ import {
|
|
|
20
20
|
type Services,
|
|
21
21
|
ServicesSchema,
|
|
22
22
|
} from "../../config/schemas/services.js";
|
|
23
|
-
import type {
|
|
23
|
+
import type {
|
|
24
|
+
OAuthConnectionRequest,
|
|
25
|
+
OAuthConnectionResponse,
|
|
26
|
+
} from "../../oauth/connection.js";
|
|
24
27
|
import {
|
|
25
28
|
isBinaryOAuthBody,
|
|
26
29
|
jsonSafeOAuthBody,
|
|
@@ -30,6 +33,7 @@ import {
|
|
|
30
33
|
type ResolveOAuthConnectionOptions,
|
|
31
34
|
resolveOAuthConnectionWithMeta,
|
|
32
35
|
} from "../../oauth/connection-resolver.js";
|
|
36
|
+
import { providerReportsFailure } from "../../oauth/identity-verifier.js";
|
|
33
37
|
import { syncManualTokenConnection } from "../../oauth/manual-token-connection.js";
|
|
34
38
|
import {
|
|
35
39
|
disconnectOAuthProvider,
|
|
@@ -54,6 +58,7 @@ import {
|
|
|
54
58
|
} from "../../util/oauth-request-body.js";
|
|
55
59
|
import { LOCAL_PRINCIPALS } from "../auth/route-policy.js";
|
|
56
60
|
import { BadRequestError, InternalError, NotFoundError } from "./errors.js";
|
|
61
|
+
import { composeRequestHint } from "./oauth-request-hints.js";
|
|
57
62
|
import type { RouteDefinition, RouteHandlerArgs } from "./types.js";
|
|
58
63
|
|
|
59
64
|
const log = getLogger("oauth-commands-routes");
|
|
@@ -233,6 +238,27 @@ function assertOAuthRequestUrlAllowed(
|
|
|
233
238
|
}
|
|
234
239
|
}
|
|
235
240
|
|
|
241
|
+
/**
|
|
242
|
+
* The verdict on a provider exchange: whether the status said success, and
|
|
243
|
+
* whether the provider's declared ok field (`responseOkField`) then took it
|
|
244
|
+
* back. The field is read only under a 2xx, so a 429 or 5xx whose body
|
|
245
|
+
* happens to carry it stays a transport failure rather than a refusal.
|
|
246
|
+
* `reportedFailure` is the one-line account of a refusal, absent otherwise.
|
|
247
|
+
*/
|
|
248
|
+
function judgeProviderResponse(
|
|
249
|
+
providerRow: OAuthProviderRow,
|
|
250
|
+
response: OAuthConnectionResponse,
|
|
251
|
+
): { ok: boolean; reportedFailure?: string } {
|
|
252
|
+
const httpOk = response.status >= 200 && response.status < 300;
|
|
253
|
+
if (httpOk && providerReportsFailure(providerRow, response.body)) {
|
|
254
|
+
return {
|
|
255
|
+
ok: false,
|
|
256
|
+
reportedFailure: `${providerRow.provider} answered HTTP ${response.status} but reported ${providerRow.responseOkField}: false`,
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
return { ok: httpOk };
|
|
260
|
+
}
|
|
261
|
+
|
|
236
262
|
/**
|
|
237
263
|
* Required scopes the resolved connection's stored grant lacks. Credential
|
|
238
264
|
* health measures the same thing on the heartbeat; measuring it on the
|
|
@@ -689,7 +715,8 @@ async function handlePing({ body = {} }: RouteHandlerArgs) {
|
|
|
689
715
|
...(pingBody !== undefined ? { body: pingBody } : {}),
|
|
690
716
|
});
|
|
691
717
|
|
|
692
|
-
|
|
718
|
+
const verdict = judgeProviderResponse(providerRow, response);
|
|
719
|
+
if (verdict.ok) {
|
|
693
720
|
return { ok: true, provider: b.provider, status: response.status };
|
|
694
721
|
}
|
|
695
722
|
|
|
@@ -697,10 +724,21 @@ async function handlePing({ body = {} }: RouteHandlerArgs) {
|
|
|
697
724
|
ok: false,
|
|
698
725
|
provider: b.provider,
|
|
699
726
|
status: response.status,
|
|
700
|
-
error:
|
|
727
|
+
error: verdict.reportedFailure
|
|
728
|
+
? `Ping failed: ${verdict.reportedFailure}`
|
|
729
|
+
: `Ping failed with HTTP ${response.status}`,
|
|
701
730
|
};
|
|
731
|
+
if (verdict.reportedFailure) {
|
|
732
|
+
payload.body = response.body;
|
|
733
|
+
}
|
|
702
734
|
|
|
703
|
-
|
|
735
|
+
// A provider that refuses the ping inside a 2xx is refusing the credential
|
|
736
|
+
// the same way a 401 does.
|
|
737
|
+
if (
|
|
738
|
+
response.status === 401 ||
|
|
739
|
+
response.status === 403 ||
|
|
740
|
+
verdict.reportedFailure
|
|
741
|
+
) {
|
|
704
742
|
payload.hint =
|
|
705
743
|
`Run 'assistant oauth status ${b.provider}' to check connection health. ` +
|
|
706
744
|
`To reconnect, run 'assistant oauth connect --help'.`;
|
|
@@ -978,8 +1016,10 @@ export async function handleRequest({ body = {} }: RouteHandlerArgs) {
|
|
|
978
1016
|
const response = await connection.request(req);
|
|
979
1017
|
const encodedBody = jsonSafeOAuthBody(response.body);
|
|
980
1018
|
|
|
1019
|
+
const verdict = judgeProviderResponse(providerRow, response);
|
|
1020
|
+
|
|
981
1021
|
const result: Record<string, unknown> = {
|
|
982
|
-
ok:
|
|
1022
|
+
ok: verdict.ok,
|
|
983
1023
|
status: response.status,
|
|
984
1024
|
headers: response.headers,
|
|
985
1025
|
body: encodedBody.body,
|
|
@@ -1001,60 +1041,23 @@ export async function handleRequest({ body = {} }: RouteHandlerArgs) {
|
|
|
1001
1041
|
`used "${selected}". Pass --account to select a specific one.`;
|
|
1002
1042
|
}
|
|
1003
1043
|
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
`To reconnect, run 'assistant oauth connect --help'.`
|
|
1017
|
-
: `Request returned HTTP ${response.status}. The OAuth token may be expired or revoked.\n\n` +
|
|
1018
|
-
`Run 'assistant oauth status ${b.provider}' to check connection status.\n` +
|
|
1019
|
-
`To reconnect, run 'assistant oauth connect --help'.`;
|
|
1020
|
-
} else if (response.status === 404 && isHtmlResponse(response.headers)) {
|
|
1021
|
-
// An HTML 404 (rather than a JSON API error) is the signature of a request
|
|
1022
|
-
// reaching a valid host but a path that host does not serve — e.g. a
|
|
1023
|
-
// relative path resolved against a base URL that points at the wrong
|
|
1024
|
-
// product. Surface the resolved base so the caller can tell where the path
|
|
1025
|
-
// landed, and steer them to an absolute URL for non-default services.
|
|
1026
|
-
const resolvedBaseUrl =
|
|
1027
|
-
baseUrl ?? providerRow.baseUrl ?? "(none configured)";
|
|
1028
|
-
result.hint =
|
|
1029
|
-
`Request returned HTTP ${response.status} with an HTML body, which usually means ` +
|
|
1030
|
-
`the path does not exist on the base URL it resolved against.\n\n` +
|
|
1031
|
-
`This request used base URL "${resolvedBaseUrl}" (relative paths are joined onto it). ` +
|
|
1032
|
-
`If you meant a different service on this provider, pass an absolute URL ` +
|
|
1033
|
-
`(e.g. https://host/full/path) so the host and full path are set explicitly.`;
|
|
1034
|
-
}
|
|
1035
|
-
|
|
1036
|
-
const missingScopes = missingScopesForConnection(providerRow, connection.id);
|
|
1037
|
-
if (missingScopes.length > 0) {
|
|
1038
|
-
const scopeHint =
|
|
1039
|
-
`The ${b.provider} connection is missing required scopes: ${missingScopes.join(", ")}. ` +
|
|
1040
|
-
`It was connected before they were required, so calls that need them fail. ` +
|
|
1041
|
-
`Reconnect it from Integrations, or run 'assistant oauth connect ${b.provider}', to grant them.`;
|
|
1042
|
-
result.hint = result.hint ? `${scopeHint}\n\n${result.hint}` : scopeHint;
|
|
1044
|
+
const hint = composeRequestHint({
|
|
1045
|
+
provider: b.provider,
|
|
1046
|
+
status: response.status,
|
|
1047
|
+
headers: response.headers,
|
|
1048
|
+
reportedFailure: verdict.reportedFailure,
|
|
1049
|
+
botChannel: channelForBotProvider(b.provider),
|
|
1050
|
+
managed,
|
|
1051
|
+
resolvedBaseUrl: baseUrl ?? providerRow.baseUrl ?? undefined,
|
|
1052
|
+
missingScopes: missingScopesForConnection(providerRow, connection.id),
|
|
1053
|
+
});
|
|
1054
|
+
if (hint) {
|
|
1055
|
+
result.hint = hint;
|
|
1043
1056
|
}
|
|
1044
1057
|
|
|
1045
1058
|
return result;
|
|
1046
1059
|
}
|
|
1047
1060
|
|
|
1048
|
-
/** True when the response's Content-Type header indicates an HTML body. */
|
|
1049
|
-
function isHtmlResponse(headers: Record<string, string>): boolean {
|
|
1050
|
-
for (const [key, value] of Object.entries(headers)) {
|
|
1051
|
-
if (key.toLowerCase() === "content-type") {
|
|
1052
|
-
return value.toLowerCase().includes("text/html");
|
|
1053
|
-
}
|
|
1054
|
-
}
|
|
1055
|
-
return false;
|
|
1056
|
-
}
|
|
1057
|
-
|
|
1058
1061
|
// ---------------------------------------------------------------------------
|
|
1059
1062
|
// Connect handler (managed path for platform OAuth)
|
|
1060
1063
|
// ---------------------------------------------------------------------------
|
|
@@ -176,6 +176,7 @@ function handleRegisterProvider({ body = {} }: RouteHandlerArgs) {
|
|
|
176
176
|
(b.identity_response_paths as string[]) ?? undefined,
|
|
177
177
|
identityFormat: (b.identity_format as string) ?? undefined,
|
|
178
178
|
identityOkField: (b.identity_ok_field as string) ?? undefined,
|
|
179
|
+
responseOkField: (b.response_ok_field as string) ?? undefined,
|
|
179
180
|
setupNotes: (b.setup_notes as string[]) ?? undefined,
|
|
180
181
|
});
|
|
181
182
|
|
|
@@ -312,6 +313,9 @@ function handleUpdateProvider({
|
|
|
312
313
|
if (b.identity_ok_field !== undefined) {
|
|
313
314
|
params.identityOkField = b.identity_ok_field;
|
|
314
315
|
}
|
|
316
|
+
if (b.response_ok_field !== undefined) {
|
|
317
|
+
params.responseOkField = b.response_ok_field;
|
|
318
|
+
}
|
|
315
319
|
if (b.setup_notes !== undefined) {
|
|
316
320
|
params.setupNotes = b.setup_notes;
|
|
317
321
|
}
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The request doors' hint, asserted on the composer directly. Every case
|
|
3
|
+
* pins the rendered text in full, so a wording change is a visible diff here
|
|
4
|
+
* and never a silent one behind a route test's substring match.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { describe, expect, test } from "bun:test";
|
|
8
|
+
|
|
9
|
+
import {
|
|
10
|
+
composeRequestHint,
|
|
11
|
+
REQUEST_HINT_RULES,
|
|
12
|
+
type RequestHintFacts,
|
|
13
|
+
} from "./oauth-request-hints.js";
|
|
14
|
+
|
|
15
|
+
const JSON_HEADERS = { "content-type": "application/json" };
|
|
16
|
+
const HTML_HEADERS = { "content-type": "text/html; charset=utf-8" };
|
|
17
|
+
|
|
18
|
+
function asBot(overrides: Partial<RequestHintFacts> = {}): RequestHintFacts {
|
|
19
|
+
return {
|
|
20
|
+
provider: "slack_channel",
|
|
21
|
+
status: 200,
|
|
22
|
+
headers: JSON_HEADERS,
|
|
23
|
+
botChannel: "slack",
|
|
24
|
+
managed: false,
|
|
25
|
+
resolvedBaseUrl: "https://slack.com/api",
|
|
26
|
+
missingScopes: [],
|
|
27
|
+
...overrides,
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
function asPerson(overrides: Partial<RequestHintFacts> = {}): RequestHintFacts {
|
|
32
|
+
return {
|
|
33
|
+
provider: "google",
|
|
34
|
+
status: 200,
|
|
35
|
+
headers: JSON_HEADERS,
|
|
36
|
+
managed: false,
|
|
37
|
+
resolvedBaseUrl: "https://api.google.com",
|
|
38
|
+
missingScopes: [],
|
|
39
|
+
...overrides,
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
describe("composeRequestHint", () => {
|
|
44
|
+
test("the rules are applied in this precedence order", () => {
|
|
45
|
+
// The generic 401/403 rule matches every 403, so the HTML 403 rule has
|
|
46
|
+
// to be judged before it; a provider's own reported failure outranks
|
|
47
|
+
// every status. The list is the order, and this pins it.
|
|
48
|
+
expect(REQUEST_HINT_RULES.map((rule) => rule.name)).toEqual([
|
|
49
|
+
"provider reported failure",
|
|
50
|
+
"resource not visible",
|
|
51
|
+
"credential rejected",
|
|
52
|
+
"path not served",
|
|
53
|
+
]);
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
test("a 2xx is silent", () => {
|
|
57
|
+
expect(composeRequestHint(asBot())).toBeUndefined();
|
|
58
|
+
expect(composeRequestHint(asPerson())).toBeUndefined();
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
test("a provider's reported failure names only why the 2xx failed", () => {
|
|
62
|
+
expect(
|
|
63
|
+
composeRequestHint(
|
|
64
|
+
asBot({
|
|
65
|
+
reportedFailure:
|
|
66
|
+
"slack_channel answered HTTP 200 but reported ok: false",
|
|
67
|
+
}),
|
|
68
|
+
),
|
|
69
|
+
).toBe(
|
|
70
|
+
"slack_channel answered HTTP 200 but reported ok: false in the response body. The body names the error.",
|
|
71
|
+
);
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
test("a reported failure outranks every status rule", () => {
|
|
75
|
+
expect(
|
|
76
|
+
composeRequestHint(
|
|
77
|
+
asBot({
|
|
78
|
+
status: 403,
|
|
79
|
+
headers: HTML_HEADERS,
|
|
80
|
+
reportedFailure:
|
|
81
|
+
"slack_channel answered HTTP 403 but reported ok: false",
|
|
82
|
+
}),
|
|
83
|
+
),
|
|
84
|
+
).toBe(
|
|
85
|
+
"slack_channel answered HTTP 403 but reported ok: false in the response body. The body names the error.",
|
|
86
|
+
);
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
test("an HTML 403 as a bot names the resource's access and the channel's diagnostics", () => {
|
|
90
|
+
expect(
|
|
91
|
+
composeRequestHint(
|
|
92
|
+
asBot({
|
|
93
|
+
status: 403,
|
|
94
|
+
headers: HTML_HEADERS,
|
|
95
|
+
resolvedBaseUrl: "https://files.slack.com",
|
|
96
|
+
}),
|
|
97
|
+
),
|
|
98
|
+
).toBe(
|
|
99
|
+
"Request returned HTTP 403 with an HTML page from files.slack.com, not an API error. " +
|
|
100
|
+
"That usually means the slack bot cannot see this resource: it is not shared with it, or the scope it needs is missing. " +
|
|
101
|
+
"Check the resource's access before treating the credential as revoked; " +
|
|
102
|
+
"'assistant channels get slack' reports the credential itself.",
|
|
103
|
+
);
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
test("an HTML 403 as a person names the connected account and oauth status", () => {
|
|
107
|
+
expect(
|
|
108
|
+
composeRequestHint(asPerson({ status: 403, headers: HTML_HEADERS })),
|
|
109
|
+
).toBe(
|
|
110
|
+
"Request returned HTTP 403 with an HTML page from api.google.com, not an API error. " +
|
|
111
|
+
"That usually means the connected account cannot see this resource: it is not shared with it, or the scope it needs is missing. " +
|
|
112
|
+
"Check the resource's access before treating the credential as revoked; " +
|
|
113
|
+
"'assistant oauth status google' reports the credential itself.",
|
|
114
|
+
);
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
test("an HTML 403 with no resolved base omits the host", () => {
|
|
118
|
+
expect(
|
|
119
|
+
composeRequestHint(
|
|
120
|
+
asPerson({
|
|
121
|
+
status: 403,
|
|
122
|
+
headers: HTML_HEADERS,
|
|
123
|
+
resolvedBaseUrl: undefined,
|
|
124
|
+
}),
|
|
125
|
+
),
|
|
126
|
+
).toBe(
|
|
127
|
+
"Request returned HTTP 403 with an HTML page, not an API error. " +
|
|
128
|
+
"That usually means the connected account cannot see this resource: it is not shared with it, or the scope it needs is missing. " +
|
|
129
|
+
"Check the resource's access before treating the credential as revoked; " +
|
|
130
|
+
"'assistant oauth status google' reports the credential itself.",
|
|
131
|
+
);
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
test("a JSON 403 keeps the credential reading on any host", () => {
|
|
135
|
+
// An API's own refusal, on the base host or on a provider's other API
|
|
136
|
+
// hosts alike.
|
|
137
|
+
const onApiHost = composeRequestHint(asBot({ status: 403 }));
|
|
138
|
+
expect(onApiHost).toContain("slack bot credential was rejected");
|
|
139
|
+
expect(onApiHost).not.toContain("cannot see this resource");
|
|
140
|
+
|
|
141
|
+
const onOtherApiHost = composeRequestHint(
|
|
142
|
+
asPerson({
|
|
143
|
+
status: 403,
|
|
144
|
+
resolvedBaseUrl: "https://calendar.googleapis.com",
|
|
145
|
+
}),
|
|
146
|
+
);
|
|
147
|
+
expect(onOtherApiHost).toContain(
|
|
148
|
+
"The OAuth token may be expired or revoked",
|
|
149
|
+
);
|
|
150
|
+
expect(onOtherApiHost).not.toContain("cannot see this resource");
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
test("a rejected bot credential points at the channel's diagnostics, never the OAuth commands", () => {
|
|
154
|
+
expect(composeRequestHint(asBot({ status: 401 }))).toBe(
|
|
155
|
+
"Request returned HTTP 401. The slack bot credential was rejected; it may have been revoked or reinstalled with fewer scopes.\n\n" +
|
|
156
|
+
"Run 'assistant channels get slack' to re-probe the channel and see what it reports.\n" +
|
|
157
|
+
"To reconnect, run the channel's setup skill again.",
|
|
158
|
+
);
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
test("a rejected managed credential points at connection health", () => {
|
|
162
|
+
expect(composeRequestHint(asPerson({ status: 403, managed: true }))).toBe(
|
|
163
|
+
"Request returned HTTP 403. The OAuth token may be expired or revoked.\n\n" +
|
|
164
|
+
"Run 'assistant oauth status google' to check connection health.\n" +
|
|
165
|
+
"To reconnect, run 'assistant oauth connect --help'.",
|
|
166
|
+
);
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
test("a rejected your-own credential points at connection status", () => {
|
|
170
|
+
expect(composeRequestHint(asPerson({ status: 401 }))).toBe(
|
|
171
|
+
"Request returned HTTP 401. The OAuth token may be expired or revoked.\n\n" +
|
|
172
|
+
"Run 'assistant oauth status google' to check connection status.\n" +
|
|
173
|
+
"To reconnect, run 'assistant oauth connect --help'.",
|
|
174
|
+
);
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
test("an HTML 404 reports the base the path resolved against", () => {
|
|
178
|
+
expect(
|
|
179
|
+
composeRequestHint(asPerson({ status: 404, headers: HTML_HEADERS })),
|
|
180
|
+
).toBe(
|
|
181
|
+
"Request returned HTTP 404 with an HTML body, which usually means " +
|
|
182
|
+
"the path does not exist on the base URL it resolved against.\n\n" +
|
|
183
|
+
'This request used base URL "https://api.google.com" (relative paths are joined onto it). ' +
|
|
184
|
+
"If you meant a different service on this provider, pass an absolute URL " +
|
|
185
|
+
"(e.g. https://host/full/path) so the host and full path are set explicitly.",
|
|
186
|
+
);
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
test("an HTML 404 with no base says so", () => {
|
|
190
|
+
expect(
|
|
191
|
+
composeRequestHint(
|
|
192
|
+
asPerson({
|
|
193
|
+
status: 404,
|
|
194
|
+
headers: HTML_HEADERS,
|
|
195
|
+
resolvedBaseUrl: undefined,
|
|
196
|
+
}),
|
|
197
|
+
),
|
|
198
|
+
).toContain('This request used base URL "(none configured)"');
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
test("a JSON 404 and every other status are silent", () => {
|
|
202
|
+
expect(composeRequestHint(asPerson({ status: 404 }))).toBeUndefined();
|
|
203
|
+
expect(composeRequestHint(asPerson({ status: 429 }))).toBeUndefined();
|
|
204
|
+
expect(composeRequestHint(asPerson({ status: 500 }))).toBeUndefined();
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
test("the Content-Type check is case-insensitive on key and value", () => {
|
|
208
|
+
expect(
|
|
209
|
+
composeRequestHint(
|
|
210
|
+
asPerson({ status: 404, headers: { "Content-Type": "TEXT/HTML" } }),
|
|
211
|
+
),
|
|
212
|
+
).toContain("with an HTML body");
|
|
213
|
+
});
|
|
214
|
+
|
|
215
|
+
test("a missing-scope hint stands alone on a successful call", () => {
|
|
216
|
+
expect(
|
|
217
|
+
composeRequestHint(
|
|
218
|
+
asPerson({ provider: "slack", missingScopes: ["files:read"] }),
|
|
219
|
+
),
|
|
220
|
+
).toBe(
|
|
221
|
+
"The slack connection is missing required scopes: files:read. " +
|
|
222
|
+
"It was connected before they were required, so calls that need them fail. " +
|
|
223
|
+
"Reconnect it from Integrations, or run 'assistant oauth connect slack', to grant them.",
|
|
224
|
+
);
|
|
225
|
+
});
|
|
226
|
+
|
|
227
|
+
test("a missing-scope hint is prepended to the status hint", () => {
|
|
228
|
+
expect(
|
|
229
|
+
composeRequestHint(
|
|
230
|
+
asPerson({
|
|
231
|
+
provider: "slack",
|
|
232
|
+
status: 401,
|
|
233
|
+
missingScopes: ["files:read", "search:read"],
|
|
234
|
+
}),
|
|
235
|
+
),
|
|
236
|
+
).toBe(
|
|
237
|
+
"The slack connection is missing required scopes: files:read, search:read. " +
|
|
238
|
+
"It was connected before they were required, so calls that need them fail. " +
|
|
239
|
+
"Reconnect it from Integrations, or run 'assistant oauth connect slack', to grant them." +
|
|
240
|
+
"\n\n" +
|
|
241
|
+
"Request returned HTTP 401. The OAuth token may be expired or revoked.\n\n" +
|
|
242
|
+
"Run 'assistant oauth status slack' to check connection status.\n" +
|
|
243
|
+
"To reconnect, run 'assistant oauth connect --help'.",
|
|
244
|
+
);
|
|
245
|
+
});
|
|
246
|
+
});
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The hint the request doors attach to a provider response, composed from
|
|
3
|
+
* the response and the connection facts alone. The route gathers the facts;
|
|
4
|
+
* nothing here reads a store, a config, or a connection, so a hint's wording
|
|
5
|
+
* is assertable without booting the route.
|
|
6
|
+
*
|
|
7
|
+
* The status hints are an ordered list and the first rule that applies wins.
|
|
8
|
+
* The order is precedence, not coincidence: a provider's own reported failure
|
|
9
|
+
* outranks every status, and an HTML 403 must be judged before the generic
|
|
10
|
+
* 401/403 rule or it is never reached. The missing-scope hint is not a rule
|
|
11
|
+
* in the list; it is prepended to whichever hint applied, or stands alone.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
export interface RequestHintFacts {
|
|
15
|
+
/** The provider key the request was made under. */
|
|
16
|
+
provider: string;
|
|
17
|
+
status: number;
|
|
18
|
+
headers: Record<string, string>;
|
|
19
|
+
/**
|
|
20
|
+
* The provider's own one-line account of a refusal inside a 2xx, from its
|
|
21
|
+
* declared ok field; absent when the status is the whole verdict.
|
|
22
|
+
*/
|
|
23
|
+
reportedFailure?: string;
|
|
24
|
+
/**
|
|
25
|
+
* The channel whose bot credential served the request. Absent when the
|
|
26
|
+
* request acted as a person through their OAuth integration.
|
|
27
|
+
*/
|
|
28
|
+
botChannel?: string;
|
|
29
|
+
/** The provider runs in platform-managed mode. */
|
|
30
|
+
managed: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* The base URL the request resolved against: an absolute URL's own origin,
|
|
33
|
+
* otherwise the provider's configured base. Absent when neither is set.
|
|
34
|
+
*/
|
|
35
|
+
resolvedBaseUrl?: string;
|
|
36
|
+
/** Required scopes the resolved connection's stored grant lacks. */
|
|
37
|
+
missingScopes: readonly string[];
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
interface RequestHintRule {
|
|
41
|
+
name: string;
|
|
42
|
+
applies(facts: RequestHintFacts): boolean;
|
|
43
|
+
render(facts: RequestHintFacts): string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** The status hints in precedence order; the first rule that applies wins. */
|
|
47
|
+
export const REQUEST_HINT_RULES: readonly RequestHintRule[] = [
|
|
48
|
+
{
|
|
49
|
+
// The body carries the provider's own error code, so the hint says only
|
|
50
|
+
// why a 2xx is being reported as a failure.
|
|
51
|
+
name: "provider reported failure",
|
|
52
|
+
applies: (facts) => facts.reportedFailure !== undefined,
|
|
53
|
+
render: (facts) =>
|
|
54
|
+
`${facts.reportedFailure} in the response body. The body names the error.`,
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
// An API refuses with JSON. A 403 carrying an HTML page is a resource
|
|
58
|
+
// host (a file host, a sign-in page) refusing this identity: the same
|
|
59
|
+
// token is what the API accepts, and the resource is simply not visible
|
|
60
|
+
// to it. Blaming the credential sends the caller off to reconnect one
|
|
61
|
+
// that works.
|
|
62
|
+
name: "resource not visible",
|
|
63
|
+
applies: (facts) => facts.status === 403 && isHtmlResponse(facts.headers),
|
|
64
|
+
render: (facts) => {
|
|
65
|
+
const identity = facts.botChannel
|
|
66
|
+
? `${facts.botChannel} bot`
|
|
67
|
+
: "connected account";
|
|
68
|
+
const requestHost = hostnameOf(facts.resolvedBaseUrl);
|
|
69
|
+
return (
|
|
70
|
+
`Request returned HTTP 403 with an HTML page${requestHost ? ` from ${requestHost}` : ""}, not an API error. ` +
|
|
71
|
+
`That usually means the ${identity} cannot see this resource: it is not shared with it, or the scope it needs is missing. ` +
|
|
72
|
+
`Check the resource's access before treating the credential as revoked; ` +
|
|
73
|
+
(facts.botChannel
|
|
74
|
+
? `'assistant channels get ${facts.botChannel}' reports the credential itself.`
|
|
75
|
+
: `'assistant oauth status ${facts.provider}' reports the credential itself.`)
|
|
76
|
+
);
|
|
77
|
+
},
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
// The recovery steps follow the credential's kind, not the door the
|
|
81
|
+
// request came through: a channel bot's token was stored by the channel's
|
|
82
|
+
// setup, so the OAuth status and connect commands cannot repair it.
|
|
83
|
+
name: "credential rejected",
|
|
84
|
+
applies: (facts) => facts.status === 401 || facts.status === 403,
|
|
85
|
+
render: (facts) =>
|
|
86
|
+
facts.botChannel
|
|
87
|
+
? `Request returned HTTP ${facts.status}. The ${facts.botChannel} bot credential was rejected; it may have been revoked or reinstalled with fewer scopes.\n\n` +
|
|
88
|
+
`Run 'assistant channels get ${facts.botChannel}' to re-probe the channel and see what it reports.\n` +
|
|
89
|
+
`To reconnect, run the channel's setup skill again.`
|
|
90
|
+
: facts.managed
|
|
91
|
+
? `Request returned HTTP ${facts.status}. The OAuth token may be expired or revoked.\n\n` +
|
|
92
|
+
`Run 'assistant oauth status ${facts.provider}' to check connection health.\n` +
|
|
93
|
+
`To reconnect, run 'assistant oauth connect --help'.`
|
|
94
|
+
: `Request returned HTTP ${facts.status}. The OAuth token may be expired or revoked.\n\n` +
|
|
95
|
+
`Run 'assistant oauth status ${facts.provider}' to check connection status.\n` +
|
|
96
|
+
`To reconnect, run 'assistant oauth connect --help'.`,
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
// An HTML 404 (rather than a JSON API error) is the signature of a request
|
|
100
|
+
// reaching a valid host but a path that host does not serve, such as a
|
|
101
|
+
// relative path resolved against a base URL that points at the wrong
|
|
102
|
+
// product. Surface the resolved base so the caller can tell where the path
|
|
103
|
+
// landed, and steer them to an absolute URL for non-default services.
|
|
104
|
+
name: "path not served",
|
|
105
|
+
applies: (facts) => facts.status === 404 && isHtmlResponse(facts.headers),
|
|
106
|
+
render: (facts) =>
|
|
107
|
+
`Request returned HTTP ${facts.status} with an HTML body, which usually means ` +
|
|
108
|
+
`the path does not exist on the base URL it resolved against.\n\n` +
|
|
109
|
+
`This request used base URL "${facts.resolvedBaseUrl ?? "(none configured)"}" (relative paths are joined onto it). ` +
|
|
110
|
+
`If you meant a different service on this provider, pass an absolute URL ` +
|
|
111
|
+
`(e.g. https://host/full/path) so the host and full path are set explicitly.`,
|
|
112
|
+
},
|
|
113
|
+
];
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* The hint for one provider response, or undefined when nothing applies.
|
|
117
|
+
* A missing-scope hint is prepended to the status hint, or stands alone: a
|
|
118
|
+
* connection made before a scope was required keeps working for every call
|
|
119
|
+
* that does not need it, so the gap is named on every request.
|
|
120
|
+
*/
|
|
121
|
+
export function composeRequestHint(
|
|
122
|
+
facts: RequestHintFacts,
|
|
123
|
+
): string | undefined {
|
|
124
|
+
const hint = REQUEST_HINT_RULES.find((rule) => rule.applies(facts))?.render(
|
|
125
|
+
facts,
|
|
126
|
+
);
|
|
127
|
+
if (facts.missingScopes.length === 0) {
|
|
128
|
+
return hint;
|
|
129
|
+
}
|
|
130
|
+
const scopeHint =
|
|
131
|
+
`The ${facts.provider} connection is missing required scopes: ${facts.missingScopes.join(", ")}. ` +
|
|
132
|
+
`It was connected before they were required, so calls that need them fail. ` +
|
|
133
|
+
`Reconnect it from Integrations, or run 'assistant oauth connect ${facts.provider}', to grant them.`;
|
|
134
|
+
return hint ? `${scopeHint}\n\n${hint}` : scopeHint;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/** True when the response's Content-Type header indicates an HTML body. */
|
|
138
|
+
function isHtmlResponse(headers: Record<string, string>): boolean {
|
|
139
|
+
for (const [key, value] of Object.entries(headers)) {
|
|
140
|
+
if (key.toLowerCase() === "content-type") {
|
|
141
|
+
return value.toLowerCase().includes("text/html");
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
return false;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
function hostnameOf(url: string | undefined): string | undefined {
|
|
148
|
+
return url && URL.canParse(url) ? new URL(url).hostname : undefined;
|
|
149
|
+
}
|