Files
openhuman/app/src/lib/skills/skillsApi.ts
T
00c7b01280 fix(skills): debug infrastructure + disconnect credential cleanup (#154)
* feat(debug): add skills debug script and E2E tests

- Introduced a new script `debug-skill.sh` for running end-to-end tests on skills, allowing users to easily test specific skills with customizable parameters.
- Added comprehensive integration tests in `skills_debug_e2e.rs` to validate the full lifecycle of skills, including discovery, starting, tool listing, and execution.
- Enhanced logging and error handling in the tests to improve observability and debugging capabilities.

These additions facilitate better testing and debugging of skills, improving the overall development workflow.

* feat(tests): add end-to-end tests for Skills RPC over HTTP JSON-RPC

- Introduced a new test file `skills_rpc_e2e.rs` to validate the full stack of skill operations via HTTP JSON-RPC.
- Implemented comprehensive tests covering skill discovery, starting, tool listing, and execution, ensuring robust functionality.
- Enhanced logging for better observability during test execution, facilitating easier debugging and validation of skill interactions.

These tests improve the reliability and maintainability of the skills framework by ensuring all critical operations are thoroughly validated.

* refactor(tests): update RPC method names in end-to-end tests for skills

- Changed RPC method names in `skills_rpc_e2e.rs` to use the new `openhuman` prefix, reflecting the updated API structure.
- Updated corresponding test assertions to ensure consistency with the new method names.
- Enhanced logging messages to align with the new method naming conventions, improving clarity during test execution.

These changes ensure that the end-to-end tests accurately reflect the current API and improve maintainability.

* feat(debug): add live debugging script and corresponding tests for Notion skill

- Introduced `debug-notion-live.sh` script to facilitate debugging of the Notion skill with a live backend, including health checks and OAuth proxy testing.
- Added `skills_notion_live.rs` test file to validate the Notion skill's functionality using real data and backend interactions.
- Enhanced logging and error handling in both the script and tests to improve observability and debugging capabilities.

These additions streamline the debugging process and ensure the Notion skill operates correctly with live data.

* feat(env): enhance environment configuration for debugging scripts

- Updated `.env.example` to include a new `JWT_TOKEN` variable for session management in debugging scripts.
- Modified `debug-notion-live.sh` and `debug-skill.sh` scripts to load environment variables from `.env`, improving flexibility and usability.
- Enhanced error handling in the scripts to ensure required variables are set, providing clearer feedback during execution.

These changes streamline the debugging process for skills by ensuring necessary configurations are easily managed and accessible.

* feat(tests): add disconnect flow test for skills

- Introduced a new end-to-end test `skill_disconnect_flow` to validate the disconnect process for skills, mirroring the expected frontend behavior.
- The test covers the stopping of a skill, handling OAuth credentials, and verifying cleanup after a disconnect.
- Enhanced logging throughout the test to improve observability and debugging capabilities.

These additions ensure that the disconnect flow is properly validated, improving the reliability of skill interactions.

* fix(skills): revoke OAuth credentials on skill disconnect

disconnectSkill() was only stopping the skill and resetting setup_complete,
leaving oauth_credential.json on disk. On restart the stale credential would
be restored, causing confusing auth state. Now sends oauth/revoked RPC before
stopping so the event loop deletes the credential file and clears memory.

Also adds revokeOAuth() and disableSkill() to the skills RPC API layer.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* style: apply cargo fmt to skill debug tests

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* refactor(tests): improve skills directory discovery and error handling

- Renamed `find_skills_dir` to `try_find_skills_dir`, returning an `Option<PathBuf>` to handle cases where the skills directory is not found.
- Introduced a macro `require_skills_dir!` to simplify the usage of skills directory discovery in tests, providing clearer error messages when the directory is unavailable.
- Updated multiple test functions to utilize the new macro, enhancing readability and maintainability of the test code.

These changes improve the robustness of the skills directory discovery process and streamline the test setup.

* refactor(tests): enhance skills directory discovery with improved error handling

- Renamed `find_skills_dir` to `try_find_skills_dir`, returning an `Option<PathBuf>` to better handle cases where the skills directory is not found.
- Introduced a new macro `require_skills_dir!` to streamline the usage of skills directory discovery in tests, providing clearer error messages when the directory is unavailable.
- Updated test functions to utilize the new macro, improving code readability and maintainability.

These changes enhance the robustness of the skills directory discovery process and simplify test setup.

* fix(tests): skip skill tests gracefully when skills dir unavailable

Tests that require the openhuman-skills repo now return early with a
SKIPPED message instead of panicking when the directory is not found.
Fixes CI failures where the skills repo is not checked out.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(skills): harden disconnect flow, test assertions, and secret redaction

- disconnectSkill: read stored credentialId from snapshot and pass it to
  oauth/revoked for correct memory bucket cleanup; add host-side fallback
  to delete oauth_credential.json when the runtime is already stopped.
- revokeOAuth: make integrationId required (no more "default" fabrication);
  add removePersistedOAuthCredential helper for host-side cleanup.
- skills_debug_e2e: hard-assert oauth_credential.json is deleted after
  oauth/revoked instead of soft logging.
- skills_notion_live: gate behind RUN_LIVE_NOTION=1; require all env vars
  (BACKEND_URL, JWT_TOKEN, CREDENTIAL_ID, SKILLS_DATA_DIR); redact JWT and
  credential file contents from logs.
- skills_rpc_e2e: check_result renamed to assert_rpc_ok and now panics on
  JSON-RPC errors so protocol regressions fail fast.
- debug-notion-live.sh: capture cargo exit code separately from grep/head
  to avoid spurious failures under set -euo pipefail.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* style: apply cargo fmt to skills_notion_live.rs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-31 23:44:07 -07:00

156 lines
4.2 KiB
TypeScript

/**
* Imperative RPC wrapper for skill state — single source of truth.
*
* Replaces direct Redux access for skill state reads and writes.
* All functions call the Rust core sidecar via JSON-RPC.
*/
import { callCoreRpc } from '../../services/coreRpcClient';
// Re-export types that consumers need
export interface SkillSnapshotRpc {
skill_id: string;
name: string;
status: string;
tools: Array<{ name: string; description: string; inputSchema?: unknown }>;
error?: string | null;
state: Record<string, unknown>;
setup_complete: boolean;
connection_status: string;
}
export interface AvailableSkillEntryRpc {
id: string;
name: string;
version: string;
description: string;
runtime: string;
entry: string;
auto_start: boolean;
platforms?: string[] | null;
setup?: { required?: boolean; label?: string; oauth?: { provider: string; scopes: string[]; apiBaseUrl: string } } | null;
ignore_in_production: boolean;
download_url: string;
manifest_url: string;
checksum_sha256?: string | null;
category: string;
installed: boolean;
installed_version?: string | null;
update_available: boolean;
}
export interface InstalledSkillInfoRpc {
id: string;
name: string;
version: string;
description: string;
runtime: string;
}
// --- Read operations ---
export async function getSkillSnapshot(skillId: string): Promise<SkillSnapshotRpc> {
return callCoreRpc<SkillSnapshotRpc>({
method: 'openhuman.skills_status',
params: { skill_id: skillId },
});
}
export async function getAllSnapshots(): Promise<SkillSnapshotRpc[]> {
return callCoreRpc<SkillSnapshotRpc[]>({
method: 'openhuman.skills_get_all_snapshots',
});
}
export async function listAvailable(): Promise<AvailableSkillEntryRpc[]> {
return callCoreRpc<AvailableSkillEntryRpc[]>({
method: 'openhuman.skills_list_available',
});
}
export async function listInstalled(): Promise<InstalledSkillInfoRpc[]> {
return callCoreRpc<InstalledSkillInfoRpc[]>({
method: 'openhuman.skills_list_installed',
});
}
export async function searchSkills(
query: string,
category?: string,
): Promise<AvailableSkillEntryRpc[]> {
return callCoreRpc<AvailableSkillEntryRpc[]>({
method: 'openhuman.skills_search',
params: { query, category },
});
}
// --- Write operations ---
export async function startSkill(skillId: string): Promise<SkillSnapshotRpc> {
return callCoreRpc<SkillSnapshotRpc>({
method: 'openhuman.skills_start',
params: { skill_id: skillId },
});
}
export async function stopSkill(skillId: string): Promise<void> {
await callCoreRpc({ method: 'openhuman.skills_stop', params: { skill_id: skillId } });
}
export async function installSkill(skillId: string): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_install',
params: { skill_id: skillId },
});
}
export async function uninstallSkill(skillId: string): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_uninstall',
params: { skill_id: skillId },
});
}
export async function setSetupComplete(skillId: string, complete: boolean): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_set_setup_complete',
params: { skill_id: skillId, complete },
});
}
export async function revokeOAuth(skillId: string, integrationId: string): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_rpc',
params: {
skill_id: skillId,
method: 'oauth/revoked',
params: { integrationId },
},
});
}
/**
* Host-side fallback: delete oauth_credential.json from the skill's data dir.
* Used when the runtime is already stopped so oauth/revoked RPC can't reach it.
*/
export async function removePersistedOAuthCredential(skillId: string): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_data_write',
params: { skill_id: skillId, filename: 'oauth_credential.json', content: '' },
});
}
export async function disableSkill(skillId: string): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_disable',
params: { skill_id: skillId },
});
}
export async function fetchRegistryFresh(): Promise<void> {
await callCoreRpc({
method: 'openhuman.skills_registry_fetch',
params: { force: true },
});
}