mirror of
https://github.com/farcasclaudiu/openclaw.git
synced 2026-06-28 19:01:47 +03:00
refactor(shared): derive requirements from metadata
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import type { OpenClawConfig } from "../config/config.js";
|
import type { OpenClawConfig } from "../config/config.js";
|
||||||
import { evaluateRequirements } from "../shared/requirements.js";
|
import { evaluateRequirementsFromMetadata } from "../shared/requirements.js";
|
||||||
import { CONFIG_DIR } from "../utils.js";
|
import { CONFIG_DIR } from "../utils.js";
|
||||||
import {
|
import {
|
||||||
hasBinary,
|
hasBinary,
|
||||||
@@ -197,25 +197,14 @@ function buildSkillStatus(
|
|||||||
? bundledNames.has(entry.skill.name)
|
? bundledNames.has(entry.skill.name)
|
||||||
: entry.skill.source === "openclaw-bundled";
|
: entry.skill.source === "openclaw-bundled";
|
||||||
|
|
||||||
const requiredBins = entry.metadata?.requires?.bins ?? [];
|
|
||||||
const requiredAnyBins = entry.metadata?.requires?.anyBins ?? [];
|
|
||||||
const requiredEnv = entry.metadata?.requires?.env ?? [];
|
|
||||||
const requiredConfig = entry.metadata?.requires?.config ?? [];
|
|
||||||
const requiredOs = entry.metadata?.os ?? [];
|
|
||||||
|
|
||||||
const {
|
const {
|
||||||
|
required,
|
||||||
missing,
|
missing,
|
||||||
eligible: requirementsSatisfied,
|
eligible: requirementsSatisfied,
|
||||||
configChecks,
|
configChecks,
|
||||||
} = evaluateRequirements({
|
} = evaluateRequirementsFromMetadata({
|
||||||
always,
|
always,
|
||||||
required: {
|
metadata: entry.metadata,
|
||||||
bins: requiredBins,
|
|
||||||
anyBins: requiredAnyBins,
|
|
||||||
env: requiredEnv,
|
|
||||||
config: requiredConfig,
|
|
||||||
os: requiredOs,
|
|
||||||
},
|
|
||||||
hasLocalBin: hasBinary,
|
hasLocalBin: hasBinary,
|
||||||
hasRemoteBin: eligibility?.remote?.hasBin,
|
hasRemoteBin: eligibility?.remote?.hasBin,
|
||||||
hasRemoteAnyBin: eligibility?.remote?.hasAnyBin,
|
hasRemoteAnyBin: eligibility?.remote?.hasAnyBin,
|
||||||
@@ -247,13 +236,7 @@ function buildSkillStatus(
|
|||||||
disabled,
|
disabled,
|
||||||
blockedByAllowlist,
|
blockedByAllowlist,
|
||||||
eligible,
|
eligible,
|
||||||
requirements: {
|
requirements: required,
|
||||||
bins: requiredBins,
|
|
||||||
anyBins: requiredAnyBins,
|
|
||||||
env: requiredEnv,
|
|
||||||
config: requiredConfig,
|
|
||||||
os: requiredOs,
|
|
||||||
},
|
|
||||||
missing,
|
missing,
|
||||||
configChecks,
|
configChecks,
|
||||||
install: normalizeInstallOptions(entry, prefs ?? resolveSkillsInstallPreferences(config)),
|
install: normalizeInstallOptions(entry, prefs ?? resolveSkillsInstallPreferences(config)),
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import type { OpenClawConfig } from "../config/config.js";
|
import type { OpenClawConfig } from "../config/config.js";
|
||||||
import type { HookEligibilityContext, HookEntry, HookInstallSpec } from "./types.js";
|
import type { HookEligibilityContext, HookEntry, HookInstallSpec } from "./types.js";
|
||||||
import { evaluateRequirements } from "../shared/requirements.js";
|
import { evaluateRequirementsFromMetadata } from "../shared/requirements.js";
|
||||||
import { CONFIG_DIR } from "../utils.js";
|
import { CONFIG_DIR } from "../utils.js";
|
||||||
import { hasBinary, isConfigPathTruthy, resolveConfigPath, resolveHookConfig } from "./config.js";
|
import { hasBinary, isConfigPathTruthy, resolveConfigPath, resolveHookConfig } from "./config.js";
|
||||||
import { loadWorkspaceHookEntries } from "./workspace.js";
|
import { loadWorkspaceHookEntries } from "./workspace.js";
|
||||||
@@ -110,25 +110,14 @@ function buildHookStatus(
|
|||||||
const homepage = homepageRaw?.trim() ? homepageRaw.trim() : undefined;
|
const homepage = homepageRaw?.trim() ? homepageRaw.trim() : undefined;
|
||||||
const events = entry.metadata?.events ?? [];
|
const events = entry.metadata?.events ?? [];
|
||||||
|
|
||||||
const requiredBins = entry.metadata?.requires?.bins ?? [];
|
|
||||||
const requiredAnyBins = entry.metadata?.requires?.anyBins ?? [];
|
|
||||||
const requiredEnv = entry.metadata?.requires?.env ?? [];
|
|
||||||
const requiredConfig = entry.metadata?.requires?.config ?? [];
|
|
||||||
const requiredOs = entry.metadata?.os ?? [];
|
|
||||||
|
|
||||||
const {
|
const {
|
||||||
|
required,
|
||||||
missing,
|
missing,
|
||||||
eligible: requirementsSatisfied,
|
eligible: requirementsSatisfied,
|
||||||
configChecks,
|
configChecks,
|
||||||
} = evaluateRequirements({
|
} = evaluateRequirementsFromMetadata({
|
||||||
always,
|
always,
|
||||||
required: {
|
metadata: entry.metadata,
|
||||||
bins: requiredBins,
|
|
||||||
anyBins: requiredAnyBins,
|
|
||||||
env: requiredEnv,
|
|
||||||
config: requiredConfig,
|
|
||||||
os: requiredOs,
|
|
||||||
},
|
|
||||||
hasLocalBin: hasBinary,
|
hasLocalBin: hasBinary,
|
||||||
hasRemoteBin: eligibility?.remote?.hasBin,
|
hasRemoteBin: eligibility?.remote?.hasBin,
|
||||||
hasRemoteAnyBin: eligibility?.remote?.hasAnyBin,
|
hasRemoteAnyBin: eligibility?.remote?.hasAnyBin,
|
||||||
@@ -157,13 +146,7 @@ function buildHookStatus(
|
|||||||
disabled,
|
disabled,
|
||||||
eligible,
|
eligible,
|
||||||
managedByPlugin,
|
managedByPlugin,
|
||||||
requirements: {
|
requirements: required,
|
||||||
bins: requiredBins,
|
|
||||||
anyBins: requiredAnyBins,
|
|
||||||
env: requiredEnv,
|
|
||||||
config: requiredConfig,
|
|
||||||
os: requiredOs,
|
|
||||||
},
|
|
||||||
missing,
|
missing,
|
||||||
configChecks,
|
configChecks,
|
||||||
install: normalizeInstallOptions(entry),
|
install: normalizeInstallOptions(entry),
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
import {
|
import {
|
||||||
buildConfigChecks,
|
buildConfigChecks,
|
||||||
|
evaluateRequirementsFromMetadata,
|
||||||
resolveMissingAnyBins,
|
resolveMissingAnyBins,
|
||||||
resolveMissingBins,
|
resolveMissingBins,
|
||||||
resolveMissingEnv,
|
resolveMissingEnv,
|
||||||
@@ -60,4 +61,24 @@ describe("requirements helpers", () => {
|
|||||||
}),
|
}),
|
||||||
).toEqual([{ path: "a.b", value: 1, satisfied: true }]);
|
).toEqual([{ path: "a.b", value: 1, satisfied: true }]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("evaluateRequirementsFromMetadata derives required+missing", () => {
|
||||||
|
const res = evaluateRequirementsFromMetadata({
|
||||||
|
always: false,
|
||||||
|
metadata: {
|
||||||
|
requires: { bins: ["a"], anyBins: ["b"], env: ["E"], config: ["cfg.value"] },
|
||||||
|
os: ["darwin"],
|
||||||
|
},
|
||||||
|
hasLocalBin: (bin) => bin === "a",
|
||||||
|
localPlatform: "linux",
|
||||||
|
isEnvSatisfied: (name) => name === "E",
|
||||||
|
resolveConfigValue: () => "x",
|
||||||
|
isConfigSatisfied: () => false,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(res.required.bins).toEqual(["a"]);
|
||||||
|
expect(res.missing.config).toEqual(["cfg.value"]);
|
||||||
|
expect(res.missing.os).toEqual(["darwin"]);
|
||||||
|
expect(res.eligible).toBe(false);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -12,6 +12,11 @@ export type RequirementConfigCheck = {
|
|||||||
satisfied: boolean;
|
satisfied: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type RequirementsMetadata = {
|
||||||
|
requires?: Partial<Pick<Requirements, "bins" | "anyBins" | "env" | "config">>;
|
||||||
|
os?: string[];
|
||||||
|
};
|
||||||
|
|
||||||
export function resolveMissingBins(params: {
|
export function resolveMissingBins(params: {
|
||||||
required: string[];
|
required: string[];
|
||||||
hasLocalBin: (bin: string) => boolean;
|
hasLocalBin: (bin: string) => boolean;
|
||||||
@@ -147,3 +152,43 @@ export function evaluateRequirements(params: {
|
|||||||
|
|
||||||
return { missing, eligible, configChecks };
|
return { missing, eligible, configChecks };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function evaluateRequirementsFromMetadata(params: {
|
||||||
|
always: boolean;
|
||||||
|
metadata?: RequirementsMetadata;
|
||||||
|
hasLocalBin: (bin: string) => boolean;
|
||||||
|
hasRemoteBin?: (bin: string) => boolean;
|
||||||
|
hasRemoteAnyBin?: (bins: string[]) => boolean;
|
||||||
|
localPlatform: string;
|
||||||
|
remotePlatforms?: string[];
|
||||||
|
isEnvSatisfied: (envName: string) => boolean;
|
||||||
|
resolveConfigValue: (pathStr: string) => unknown;
|
||||||
|
isConfigSatisfied: (pathStr: string) => boolean;
|
||||||
|
}): {
|
||||||
|
required: Requirements;
|
||||||
|
missing: Requirements;
|
||||||
|
eligible: boolean;
|
||||||
|
configChecks: RequirementConfigCheck[];
|
||||||
|
} {
|
||||||
|
const required: Requirements = {
|
||||||
|
bins: params.metadata?.requires?.bins ?? [],
|
||||||
|
anyBins: params.metadata?.requires?.anyBins ?? [],
|
||||||
|
env: params.metadata?.requires?.env ?? [],
|
||||||
|
config: params.metadata?.requires?.config ?? [],
|
||||||
|
os: params.metadata?.os ?? [],
|
||||||
|
};
|
||||||
|
|
||||||
|
const result = evaluateRequirements({
|
||||||
|
always: params.always,
|
||||||
|
required,
|
||||||
|
hasLocalBin: params.hasLocalBin,
|
||||||
|
hasRemoteBin: params.hasRemoteBin,
|
||||||
|
hasRemoteAnyBin: params.hasRemoteAnyBin,
|
||||||
|
localPlatform: params.localPlatform,
|
||||||
|
remotePlatforms: params.remotePlatforms,
|
||||||
|
isEnvSatisfied: params.isEnvSatisfied,
|
||||||
|
resolveConfigValue: params.resolveConfigValue,
|
||||||
|
isConfigSatisfied: params.isConfigSatisfied,
|
||||||
|
});
|
||||||
|
return { required, ...result };
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user