@sasjs/cli 6.6.0 → 6.8.0

package/build/commands/logcheck/collectLogs.js

@@ -0,0 +1,386 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toSkippedFile = exports.countIssues = exports.partitionIssues = exports.scanLogFile = exports.toDisplayPath = exports.collectLogFiles = exports.MAX_LOG_BYTES = void 0;
+var path_1 = __importDefault(require("path"));
+var promises_1 = require("fs/promises");
+var logs_1 = require("@sasjs/utils/logs");
+var logCheckConfig_1 = require("./logCheckConfig");
+var types_1 = require("./types");
+/** A log bigger than this is reported and skipped rather than read. */
+exports.MAX_LOG_BYTES = 25 * 1024 * 1024;
+/** Folders never walked when a directory is given. */
+var IGNORED_FOLDERS = ['node_modules', '.git'];
+/**
+ * Expands the paths a user named into the files to read.
+ *
+ * A file is taken as it is; a folder is walked, because the reason a user
+ * points at `sasjsresults` is that they do not know which run left which log.
+ * Order is sorted so that two runs over the same folder produce the same
+ * report, which is what makes a diff of two reports readable.
+ */
+var collectLogFiles = function (paths) { return __awaiter(void 0, void 0, void 0, function () {
+    var files, missing, unreadable, paths_1, paths_1_1, candidate, resolved, info, _a, _b, found, e_1_1, e_2_1;
+    var e_2, _c, e_1, _d;
+    return __generator(this, function (_e) {
+        switch (_e.label) {
+            case 0:
+                files = new Set();
+                missing = [];
+                unreadable = [];
+                _e.label = 1;
+            case 1:
+                _e.trys.push([1, 15, 16, 17]);
+                paths_1 = __values(paths), paths_1_1 = paths_1.next();
+                _e.label = 2;
+            case 2:
+                if (!!paths_1_1.done) return [3 /*break*/, 14];
+                candidate = paths_1_1.value;
+                resolved = path_1.default.resolve(candidate);
+                return [4 /*yield*/, (0, promises_1.stat)(resolved).catch(function () { return undefined; })];
+            case 3:
+                info = _e.sent();
+                if (!info) {
+                    missing.push(candidate);
+                    return [3 /*break*/, 13];
+                }
+                if (!info.isDirectory()) return [3 /*break*/, 12];
+                _e.label = 4;
+            case 4:
+                _e.trys.push([4, 9, 10, 11]);
+                e_1 = void 0;
+                return [4 /*yield*/, walk(resolved, unreadable)];
+            case 5:
+                _a = (__values.apply(void 0, [_e.sent()])), _b = _a.next();
+                _e.label = 6;
+            case 6:
+                if (!!_b.done) return [3 /*break*/, 8];
+                found = _b.value;
+                files.add(found);
+                _e.label = 7;
+            case 7:
+                _b = _a.next();
+                return [3 /*break*/, 6];
+            case 8: return [3 /*break*/, 11];
+            case 9:
+                e_1_1 = _e.sent();
+                e_1 = { error: e_1_1 };
+                return [3 /*break*/, 11];
+            case 10:
+                try {
+                    if (_b && !_b.done && (_d = _a.return)) _d.call(_a);
+                }
+                finally { if (e_1) throw e_1.error; }
+                return [7 /*endfinally*/];
+            case 11: return [3 /*break*/, 13];
+            case 12:
+                files.add(resolved);
+                _e.label = 13;
+            case 13:
+                paths_1_1 = paths_1.next();
+                return [3 /*break*/, 2];
+            case 14: return [3 /*break*/, 17];
+            case 15:
+                e_2_1 = _e.sent();
+                e_2 = { error: e_2_1 };
+                return [3 /*break*/, 17];
+            case 16:
+                try {
+                    if (paths_1_1 && !paths_1_1.done && (_c = paths_1.return)) _c.call(paths_1);
+                }
+                finally { if (e_2) throw e_2.error; }
+                return [7 /*endfinally*/];
+            case 17: return [2 /*return*/, {
+                    files: Array.from(files).sort(function (a, b) { return a.localeCompare(b); }),
+                    missing: missing,
+                    unreadable: unreadable
+                }];
+        }
+    });
+}); };
+exports.collectLogFiles = collectLogFiles;
+/**
+ * Recursively lists the files under a folder, recording any folder it cannot
+ * read rather than treating it as empty.
+ *
+ * Symlinks are not followed: a link back up the tree would make the walk
+ * endless, and a log reached through a link is not something to report on
+ * twice.
+ */
+var walk = function (folder_1) {
+    var args_1 = [];
+    for (var _i = 1; _i < arguments.length; _i++) {
+        args_1[_i - 1] = arguments[_i];
+    }
+    return __awaiter(void 0, __spreadArray([folder_1], __read(args_1), false), void 0, function (folder, unreadable) {
+        var entries, found, entries_1, entries_1_1, entry, fullPath, _a, _b, _c, _d, e_3_1;
+        var e_3, _e;
+        if (unreadable === void 0) { unreadable = []; }
+        return __generator(this, function (_f) {
+            switch (_f.label) {
+                case 0: return [4 /*yield*/, (0, promises_1.readdir)(folder, { withFileTypes: true }).catch(function (error) {
+                        unreadable.push({
+                            displayPath: (0, exports.toDisplayPath)(folder),
+                            reason: (error === null || error === void 0 ? void 0 : error.code)
+                                ? "could not be listed (".concat(error.code, ")")
+                                : 'could not be listed'
+                        });
+                        return [];
+                    })];
+                case 1:
+                    entries = _f.sent();
+                    found = [];
+                    _f.label = 2;
+                case 2:
+                    _f.trys.push([2, 8, 9, 10]);
+                    entries_1 = __values(entries), entries_1_1 = entries_1.next();
+                    _f.label = 3;
+                case 3:
+                    if (!!entries_1_1.done) return [3 /*break*/, 7];
+                    entry = entries_1_1.value;
+                    if (entry.isSymbolicLink())
+                        return [3 /*break*/, 6];
+                    fullPath = path_1.default.join(folder, entry.name);
+                    if (!entry.isDirectory()) return [3 /*break*/, 5];
+                    if (IGNORED_FOLDERS.includes(entry.name))
+                        return [3 /*break*/, 6];
+                    _b = (_a = found.push).apply;
+                    _c = [found];
+                    _d = [[]];
+                    return [4 /*yield*/, walk(fullPath, unreadable)];
+                case 4:
+                    _b.apply(_a, _c.concat([__spreadArray.apply(void 0, _d.concat([__read.apply(void 0, [(_f.sent())]), false]))]));
+                    return [3 /*break*/, 6];
+                case 5:
+                    if (entry.isFile())
+                        found.push(fullPath);
+                    _f.label = 6;
+                case 6:
+                    entries_1_1 = entries_1.next();
+                    return [3 /*break*/, 3];
+                case 7: return [3 /*break*/, 10];
+                case 8:
+                    e_3_1 = _f.sent();
+                    e_3 = { error: e_3_1 };
+                    return [3 /*break*/, 10];
+                case 9:
+                    try {
+                        if (entries_1_1 && !entries_1_1.done && (_e = entries_1.return)) _e.call(entries_1);
+                    }
+                    finally { if (e_3) throw e_3.error; }
+                    return [7 /*endfinally*/];
+                case 10: return [2 /*return*/, found];
+            }
+        });
+    });
+};
+/**
+ * The path a report shows for a file: relative to the project folder where
+ * that is shorter and does not climb out of it, absolute otherwise.
+ *
+ * Forward slashes throughout, so a report generated on Windows and one
+ * generated on Linux describe the same log the same way, and so a path can be
+ * dropped into a CI annotation without escaping.
+ */
+var toDisplayPath = function (filePath) {
+    var base = process.projectDir || process.cwd();
+    var relative = path_1.default.relative(base, filePath);
+    return relative && !relative.startsWith('..')
+        ? (0, logCheckConfig_1.toPosix)(relative)
+        : (0, logCheckConfig_1.toPosix)(filePath);
+};
+exports.toDisplayPath = toDisplayPath;
+/**
+ * Parses one log and splits its issues into the ones reported and the ones
+ * suppressed by message code.
+ *
+ * A file that is not a SAS log is skipped rather than reported as clean: a
+ * Python traceback and a shell build log both begin lines with `ERROR:`, and
+ * `isSasLog` is what tells them from the real thing.
+ */
+var scanLogFile = function (filePath, config) { return __awaiter(void 0, void 0, void 0, function () {
+    var displayPath, blank, info, text, _a, issues, suppressed;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                displayPath = (0, exports.toDisplayPath)(filePath);
+                blank = {
+                    filePath: filePath,
+                    displayPath: displayPath,
+                    issues: [],
+                    suppressed: [],
+                    counts: (0, types_1.emptyCounts)()
+                };
+                return [4 /*yield*/, (0, promises_1.stat)(filePath).catch(function () { return undefined; })];
+            case 1:
+                info = _b.sent();
+                if (!info) {
+                    return [2 /*return*/, __assign(__assign({}, blank), { skippedReason: 'could not be read' })];
+                }
+                if (!info.isFile()) {
+                    return [2 /*return*/, __assign(__assign({}, blank), { skippedReason: 'not a file' })];
+                }
+                if (info.size > exports.MAX_LOG_BYTES) {
+                    return [2 /*return*/, __assign(__assign({}, blank), { skippedReason: "larger than ".concat(Math.round(exports.MAX_LOG_BYTES / (1024 * 1024)), " MB") })];
+                }
+                return [4 /*yield*/, (0, promises_1.readFile)(filePath, 'utf8').catch(function () { return undefined; })];
+            case 2:
+                text = _b.sent();
+                if (text === undefined) {
+                    return [2 /*return*/, __assign(__assign({}, blank), { skippedReason: 'could not be read' })];
+                }
+                if (!(0, logs_1.isSasLog)(text)) {
+                    return [2 /*return*/, __assign(__assign({}, blank), { skippedReason: 'not a SAS log' })];
+                }
+                _a = (0, exports.partitionIssues)((0, logs_1.parseLog)(text), config.ignoreCodes), issues = _a.issues, suppressed = _a.suppressed;
+                return [2 /*return*/, __assign(__assign({}, blank), { issues: issues, suppressed: suppressed, counts: (0, exports.countIssues)(issues) })];
+        }
+    });
+}); };
+exports.scanLogFile = scanLogFile;
+/**
+ * Splits parsed issues by the suppressed message codes.
+ *
+ * Matching is on the code alone, because that is what SAS keeps stable: the
+ * text of a note carries values from the data and changes between runs, while
+ * `49-169` means the same thing every time.
+ */
+var partitionIssues = function (issues, ignoreCodes) {
+    var e_4, _a;
+    var codes = new Set(ignoreCodes.map(function (code) { return code.trim(); }));
+    var kept = [];
+    var suppressed = [];
+    try {
+        for (var issues_1 = __values(issues), issues_1_1 = issues_1.next(); !issues_1_1.done; issues_1_1 = issues_1.next()) {
+            var issue = issues_1_1.value;
+            if (issue.code && codes.has(issue.code))
+                suppressed.push(issue);
+            else
+                kept.push(issue);
+        }
+    }
+    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+    finally {
+        try {
+            if (issues_1_1 && !issues_1_1.done && (_a = issues_1.return)) _a.call(issues_1);
+        }
+        finally { if (e_4) throw e_4.error; }
+    }
+    return { issues: kept, suppressed: suppressed };
+};
+exports.partitionIssues = partitionIssues;
+var countIssues = function (issues) {
+    var e_5, _a;
+    var counts = (0, types_1.emptyCounts)();
+    try {
+        for (var issues_2 = __values(issues), issues_2_1 = issues_2.next(); !issues_2_1.done; issues_2_1 = issues_2.next()) {
+            var issue = issues_2_1.value;
+            if (issue.severity === 'error')
+                counts.errors++;
+            else if (issue.severity === 'warning')
+                counts.warnings++;
+            else
+                counts.notes++;
+        }
+    }
+    catch (e_5_1) { e_5 = { error: e_5_1 }; }
+    finally {
+        try {
+            if (issues_2_1 && !issues_2_1.done && (_a = issues_2.return)) _a.call(issues_2);
+        }
+        finally { if (e_5) throw e_5.error; }
+    }
+    return counts;
+};
+exports.countIssues = countIssues;
+/** A file the check declined to open, as the report shows it. */
+var toSkippedFile = function (log) { return ({
+    displayPath: log.displayPath,
+    reason: log.skippedReason || 'skipped'
+}); };
+exports.toSkippedFile = toSkippedFile;

package/build/commands/logcheck/logCheckConfig.d.ts

@@ -0,0 +1,83 @@
+import { LogCheckConfig } from './types';
+/** The section of `sasjsconfig.json` this command reads. */
+export declare const CONFIG_KEY = "logCheck";
+/** Folder checked when the command is given no path of its own. */
+export declare const DEFAULT_FOLDER = "sasjsresults";
+/**
+ * Builds a config from an untrusted `logCheck` section.
+ *
+ * Values a user gets wrong are refused rather than ignored: a typo in
+ * `failOn` that silently fell back to the default would leave a gate that
+ * never fails, which is the one failure mode a quality gate must not have.
+ *
+ * @param section - the parsed `logCheck` object from `sasjsconfig.json`.
+ * @param source - the file it came from, named in the error message.
+ */
+export declare const parseLogCheckSection: (section: unknown, source?: string) => LogCheckConfig;
+/**
+ * Where a project's config may be, in the order they are tried.
+ *
+ * `sasjs/sasjsconfig.json` is the SASjs convention and the one the rest of the
+ * CLI reads, so it wins. A `sasjsconfig.json` at the project root is still
+ * honoured, because a folder holding a single log and a hand-written config is
+ * exactly the case this command is meant to serve - but the two are never
+ * confused for each other, and the convention cannot be shadowed by a stray
+ * file next to it.
+ */
+export declare const configCandidates: (projectDir: string) => string[];
+/**
+ * Reads the `logCheck` policy from the project's `sasjsconfig.json`.
+ *
+ * A missing file, or one without the section, is not an error - the command
+ * has to work in a folder that is not a SASjs project at all, which is the
+ * whole point of checking a log somebody else produced.
+ */
+export declare const readLogCheckConfig: () => Promise<LogCheckConfig>;
+/** Flags a user can set on the command line, all optional. */
+export interface ConfigOverrides {
+    failOn?: string;
+    maxWarnings?: number;
+    ignoreCodes?: string[];
+    ignorePaths?: string[];
+}
+/**
+ * Layers the command line over the config file. Suppressions are added, never
+ * replaced: a flag silences one more code for one run, it does not un-silence
+ * the codes a team has already agreed to accept.
+ */
+export declare const mergeConfig: (base: LogCheckConfig, overrides?: ConfigOverrides) => LogCheckConfig;
+/**
+ * Whether a log path is excluded by one of the `ignorePaths` entries.
+ *
+ * An entry with no wildcard is matched against whole path segments, not as a
+ * bare substring of the text: `test` covers `test/run.log` and
+ * `sasjsresults/test/run.log`, but not `latest.log`, and `logs` does not cover
+ * `nested-logs/x.log`. A suppression rule that quietly covers files the author
+ * did not name is the failure mode this whole config guards against, so an
+ * entry has to name a path, not a fragment of one.
+ *
+ * An entry with a wildcard is a glob over the display path, anchored at both
+ * ends, where `**&#47;` crosses folders and `*` does not.
+ */
+export declare const matchesPath: (displayPath: string, pattern: string) => boolean;
+/**
+ * A non-glob entry matches when it names the path itself, or a run of whole
+ * segments inside it.
+ *
+ * Padding both sides with a separator makes one `includes` do the work: the
+ * needle can only be found where it begins at a segment boundary and ends at
+ * one, which is exactly the difference between `test` and `latest`.
+ */
+export declare const matchesSegments: (subject: string, candidate: string) => boolean;
+export declare const isIgnoredPath: (displayPath: string, patterns: string[]) => boolean;
+/**
+ * Compiles a glob into an expression anchored at both ends.
+ *
+ * `**&#47;` at the start matches zero or more leading folders so that
+ * `**&#47;build.log` covers `build.log` in the project folder as well as one
+ * several folders down - a pattern that only matched the deep case would make
+ * the obvious spelling useless.
+ */
+export declare const globToRegExp: (pattern: string) => RegExp;
+/** Path text as it appears in a report: forward slashes, no wrapping quotes. */
+export declare const toPosix: (value: string) => string;