@sketch-hq/sketch-assistant-utils
Version:
Utility functions and types for Sketch Assistants.
141 lines (140 loc) • 6.4 kB
JavaScript
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import pMap from 'p-map';
import pTimeout, { TimeoutError } from 'p-timeout';
import { ViolationSeverity, } from '@sketch-hq/sketch-assistant-types';
import { createRuleUtilsCreator } from '../../rule-utils';
import { isRuleActive, getRuleConfig, getRuleTitle } from '../../assistant-config';
import { isRuleFullIgnored } from '../ignore';
/**
* Given a set of violations and rule errors, determine the grade. A "fail"
* means severe error-level violations are present, whereas a "pass"
* means only info or warn-level violations are present. An "unknown" grade
* means an indeterminate result - for example, if one or more rules timed-out
* then we can't give a definitive grade.
*/
const getGrade = (violations, ruleErrors) => {
const hasTimedOutRules = !!ruleErrors.find((ruleError) => ruleError.code === 'timeout');
if (hasTimedOutRules)
return 'unknown';
const hasErrorLevelViolations = !!violations.find((violation) => violation.severity === ViolationSeverity.error);
return hasErrorLevelViolations ? 'fail' : 'pass';
};
/**
* Rule invocation errors are errors thrown by rule functions while they are
* executing. Rule errors could be thrown by the Assistant architecture code,
* or by mistakes in 3rd party rules. In either case, they are caught in the
* runAssistant function and collated into plain RuleError objects to be
* incorporated into the overall result.
*/
class RuleInvocationError extends Error {
constructor(cause, assistantName, ruleName, code) {
super(`Error thrown during invocation of rule "${ruleName}" on assistant "${assistantName}": ${cause.message}`);
this.cause = cause;
this.assistantName = assistantName;
this.ruleName = ruleName;
this.name = 'RuleInvocationError';
this.code = code;
Object.setPrototypeOf(this, new.target.prototype);
}
}
/**
* Run a single assistant, catching and returning any errors encountered during rule invocation.
*/
const runAssistant = (file, assistant, env, cancelToken, getImageMetadata, ignoreConfig, ruleTimeout) => __awaiter(void 0, void 0, void 0, function* () {
const violations = [];
const createUtils = createRuleUtilsCreator(file, violations, assistant, cancelToken, getImageMetadata, ignoreConfig);
const context = {
env,
file,
assistant,
cancelToken,
getImageMetadata,
};
const activeRules = assistant.rules
.filter((rule) => isRuleActive(assistant.config, rule.name)) // Rule turned on in config
.filter((rule) => (rule.runtime ? rule.runtime === env.runtime : true)); // Rule platform is supported
const profile = {
ruleTimings: {},
};
const metadata = {
assistant: {
name: assistant.name,
config: assistant.config,
},
rules: activeRules.reduce((acc, rule) => {
const ruleConfig = getRuleConfig(assistant.config, rule.name);
const configTitle = getRuleTitle(assistant.config, rule.name);
const title = configTitle
? configTitle
: ruleConfig && 'active' in ruleConfig && typeof rule.title === 'function'
? rule.title(ruleConfig)
: rule.title;
const description = ruleConfig && 'active' in ruleConfig && typeof rule.description === 'function'
? rule.description(ruleConfig)
: rule.description;
return Object.assign(Object.assign({}, acc), { [rule.name]: {
name: rule.name,
title,
description,
debug: rule.debug,
runtime: rule.runtime,
} });
}, {}),
};
// Filter out ignored rules to find the final set of rules to invoke
const rulesToRun = activeRules.filter((rule) => !isRuleFullIgnored(ignoreConfig, assistant.name, rule.name));
try {
yield pMap(rulesToRun, (rule) => __awaiter(void 0, void 0, void 0, function* () {
if (cancelToken.cancelled)
return;
const timeoutToken = { timedOut: false };
const { rule: ruleFunction, name: ruleName } = rule;
const ruleContext = Object.assign(Object.assign({}, context), { utils: createUtils(ruleName, timeoutToken) });
const start = Date.now();
try {
const rulePromise = ruleFunction(ruleContext);
yield (ruleTimeout === Infinity
? rulePromise
: pTimeout(rulePromise, ruleTimeout, `Rule timed-out after ${ruleTimeout} milliseconds`));
}
catch (error) {
const timedOut = error instanceof TimeoutError;
timeoutToken.timedOut = timedOut;
throw new RuleInvocationError(error, assistant.name, ruleName, timedOut ? 'timeout' : 'error');
}
profile.ruleTimings[ruleName] = Date.now() - start;
}), { concurrency: 1, stopOnError: false });
}
catch (errors) {
const ruleErrors = Array.from(errors).map((error) => ({
assistantName: error.assistantName,
ruleName: error.ruleName,
message: error.cause.message,
stack: error.cause.stack || '',
code: error.code,
}));
return {
grade: getGrade(violations, ruleErrors),
violations,
ruleErrors,
metadata,
profile,
};
}
return {
grade: getGrade(violations, []),
violations,
ruleErrors: [],
metadata,
profile,
};
});
export { runAssistant };