File size: 6,034 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | export type Requirements = {
bins: string[];
anyBins: string[];
env: string[];
config: string[];
os: string[];
};
export type RequirementConfigCheck = {
path: string;
satisfied: boolean;
};
export type RequirementsMetadata = {
requires?: Partial<Pick<Requirements, "bins" | "anyBins" | "env" | "config">>;
os?: string[];
};
export type RequirementRemote = {
hasBin?: (bin: string) => boolean;
hasAnyBin?: (bins: string[]) => boolean;
platforms?: string[];
};
type RequirementsEvaluationContext = {
always: boolean;
hasLocalBin: (bin: string) => boolean;
localPlatform: string;
isEnvSatisfied: (envName: string) => boolean;
isConfigSatisfied: (pathStr: string) => boolean;
};
type RequirementsEvaluationRemoteContext = {
hasRemoteBin?: (bin: string) => boolean;
hasRemoteAnyBin?: (bins: string[]) => boolean;
remotePlatforms?: string[];
};
export function resolveMissingBins(params: {
required: string[];
hasLocalBin: (bin: string) => boolean;
hasRemoteBin?: (bin: string) => boolean;
}): string[] {
const remote = params.hasRemoteBin;
return params.required.filter((bin) => {
if (params.hasLocalBin(bin)) {
return false;
}
if (remote?.(bin)) {
return false;
}
return true;
});
}
export function resolveMissingAnyBins(params: {
required: string[];
hasLocalBin: (bin: string) => boolean;
hasRemoteAnyBin?: (bins: string[]) => boolean;
}): string[] {
if (params.required.length === 0) {
return [];
}
if (params.required.some((bin) => params.hasLocalBin(bin))) {
return [];
}
if (params.hasRemoteAnyBin?.(params.required)) {
return [];
}
return params.required;
}
export function resolveMissingOs(params: {
required: string[];
localPlatform: string;
remotePlatforms?: string[];
}): string[] {
if (params.required.length === 0) {
return [];
}
if (params.required.includes(params.localPlatform)) {
return [];
}
if (params.remotePlatforms?.some((platform) => params.required.includes(platform))) {
return [];
}
return params.required;
}
export function resolveMissingEnv(params: {
required: string[];
isSatisfied: (envName: string) => boolean;
}): string[] {
const missing: string[] = [];
for (const envName of params.required) {
if (params.isSatisfied(envName)) {
continue;
}
missing.push(envName);
}
return missing;
}
export function buildConfigChecks(params: {
required: string[];
isSatisfied: (pathStr: string) => boolean;
}): RequirementConfigCheck[] {
return params.required.map((pathStr) => {
const satisfied = params.isSatisfied(pathStr);
return { path: pathStr, satisfied };
});
}
export function evaluateRequirements(
params: RequirementsEvaluationContext &
RequirementsEvaluationRemoteContext & {
required: Requirements;
},
): { missing: Requirements; eligible: boolean; configChecks: RequirementConfigCheck[] } {
const missingBins = resolveMissingBins({
required: params.required.bins,
hasLocalBin: params.hasLocalBin,
hasRemoteBin: params.hasRemoteBin,
});
const missingAnyBins = resolveMissingAnyBins({
required: params.required.anyBins,
hasLocalBin: params.hasLocalBin,
hasRemoteAnyBin: params.hasRemoteAnyBin,
});
const missingOs = resolveMissingOs({
required: params.required.os,
localPlatform: params.localPlatform,
remotePlatforms: params.remotePlatforms,
});
const missingEnv = resolveMissingEnv({
required: params.required.env,
isSatisfied: params.isEnvSatisfied,
});
const configChecks = buildConfigChecks({
required: params.required.config,
isSatisfied: params.isConfigSatisfied,
});
const missingConfig = configChecks.filter((check) => !check.satisfied).map((check) => check.path);
const missing = params.always
? { bins: [], anyBins: [], env: [], config: [], os: [] }
: {
bins: missingBins,
anyBins: missingAnyBins,
env: missingEnv,
config: missingConfig,
os: missingOs,
};
const eligible =
params.always ||
(missing.bins.length === 0 &&
missing.anyBins.length === 0 &&
missing.env.length === 0 &&
missing.config.length === 0 &&
missing.os.length === 0);
return { missing, eligible, configChecks };
}
export function evaluateRequirementsFromMetadata(
params: RequirementsEvaluationContext &
RequirementsEvaluationRemoteContext & {
metadata?: RequirementsMetadata;
},
): {
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,
isConfigSatisfied: params.isConfigSatisfied,
});
return { required, ...result };
}
export function evaluateRequirementsFromMetadataWithRemote(
params: RequirementsEvaluationContext & {
metadata?: RequirementsMetadata;
remote?: RequirementRemote;
},
): {
required: Requirements;
missing: Requirements;
eligible: boolean;
configChecks: RequirementConfigCheck[];
} {
return evaluateRequirementsFromMetadata({
always: params.always,
metadata: params.metadata,
hasLocalBin: params.hasLocalBin,
hasRemoteBin: params.remote?.hasBin,
hasRemoteAnyBin: params.remote?.hasAnyBin,
localPlatform: params.localPlatform,
remotePlatforms: params.remote?.platforms,
isEnvSatisfied: params.isEnvSatisfied,
isConfigSatisfied: params.isConfigSatisfied,
});
}
|