x-fidelity 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [2.7.0](https://github.com/zotoio/x-fidelity/compare/v2.6.0...v2.7.0) (2024-08-22)
+
+
+### Bug Fixes
+
+* Add missing `repoUrl` property to `mockParams` object ([e94114d](https://github.com/zotoio/x-fidelity/commit/e94114dced7c9f6b4f53caa034937d07313abd71))
+
+
+### Features
+
+* **exemption process:** allow a repo to have a timelimited waiver for a given rule ([42d4b7d](https://github.com/zotoio/x-fidelity/commit/42d4b7de181131bbc3400710fc86876f4f3d8748))
+
 # [2.6.0](https://github.com/zotoio/x-fidelity/compare/v2.5.0...v2.6.0) (2024-08-22)
 
 

package/dist/core/engine/analyzer.js

@@ -26,7 +26,12 @@ function analyzeCodebase(params) {
     return __awaiter(this, void 0, void 0, function* () {
         const { repoPath, archetype = 'node-fullstack', configServer = '', localConfigPath = '', executionLogPrefix = '' } = params;
         logger_1.logger.info(`STARTING..`);
+        // Load exemptions
+        if (localConfigPath) {
+            yield configManager_1.ConfigManager.loadExemptions(localConfigPath);
+        }
         const telemetryData = yield (0, telemetryCollector_1.collectTelemetryData)({ repoPath, configServer });
+        const repoUrl = telemetryData.repoUrl;
         // Send telemetry for analysis start
         yield (0, telemetry_1.sendTelemetry)({
             eventType: 'analysisStart',
@@ -72,7 +77,8 @@ function analyzeCodebase(params) {
             fileData,
             installedDependencyVersions,
             minimumDependencyVersions,
-            standardStructure
+            standardStructure,
+            repoUrl
         });
         const finishMsg = `\n==========================\nCHECKS COMPLETED..\n==========================`;
         logger_1.logger.info(finishMsg);

package/dist/core/engine/engineRunner.js

@@ -14,7 +14,7 @@ const logger_1 = require("../../utils/logger");
 const configManager_1 = require("../../utils/configManager");
 function runEngineOnFiles(params) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { engine, fileData, installedDependencyVersions, minimumDependencyVersions, standardStructure } = params;
+        const { engine, fileData, installedDependencyVersions, minimumDependencyVersions, standardStructure, repoUrl } = params;
         const msg = `\n==========================\nRUNNING FILE CHECKS..\n==========================`;
         logger_1.logger.info(msg);
         const failures = [];
@@ -41,7 +41,7 @@ function runEngineOnFiles(params) {
                 results.forEach((result) => {
                     var _a, _b;
                     logger_1.logger.debug(JSON.stringify(result));
-                    if (result.result) {
+                    if (result.result && !configManager_1.ConfigManager.isExempt(repoUrl, result.name)) {
                         fileFailures.push({
                             ruleFailure: result.name,
                             level: (_a = result.event) === null || _a === void 0 ? void 0 : _a.type,

package/dist/core/engine/engineRunner.test.js

@@ -35,6 +35,7 @@ describe('runEngineOnFiles', () => {
         installedDependencyVersions: {},
         minimumDependencyVersions: {},
         standardStructure: {},
+        repoUrl: 'https://github.com/mock/repo',
     };
     beforeEach(() => {
         jest.clearAllMocks();

package/dist/utils/configManager.js

@@ -63,6 +63,39 @@ class ConfigManager {
             return ConfigManager.configs[archetype];
         });
     }
+    static loadExemptions(localConfigPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const exemptionsPath = path.join(localConfigPath, 'exemptions.json');
+            try {
+                const exemptionsData = yield fs_1.default.promises.readFile(exemptionsPath, 'utf-8');
+                const exemptionsJson = JSON.parse(exemptionsData);
+                ConfigManager.exemptions = exemptionsJson.exemptions;
+                logger_1.logger.info(`Loaded ${ConfigManager.exemptions.length} exemptions`);
+            }
+            catch (error) {
+                logger_1.logger.warn(`Failed to load exemptions: ${error}`);
+                ConfigManager.exemptions = [];
+            }
+        });
+    }
+    static getExemptions() {
+        return ConfigManager.exemptions;
+    }
+    static getExemptionExpirationDate(repoUrl, ruleName) {
+        const exemption = ConfigManager.exemptions.find(exemption => exemption.repoUrl === repoUrl &&
+            exemption.rule === ruleName);
+        return exemption ? new Date(exemption.expirationDate) : undefined;
+    }
+    static isExempt(repoUrl, ruleName) {
+        const now = new Date();
+        const result = ConfigManager.exemptions.some(exemption => exemption.repoUrl === repoUrl &&
+            exemption.rule === ruleName &&
+            new Date(exemption.expirationDate) > now);
+        if (result) {
+            logger_1.logger.error(`Exempting rule ${ruleName} for repo ${repoUrl} until ${ConfigManager.getExemptionExpirationDate(repoUrl, ruleName)}`);
+        }
+        return result;
+    }
     static initialize(params) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -176,3 +209,4 @@ class ConfigManager {
 }
 exports.ConfigManager = ConfigManager;
 ConfigManager.configs = {};
+ConfigManager.exemptions = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-fidelity",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "cli for opinionated framework adherence checks",
   "main": "dist/xfidelity",
   "bin": {

package/src/core/engine/analyzer.ts

@@ -20,7 +20,13 @@ export async function analyzeCodebase(params: AnalyzeCodebaseParams): Promise<Re
     
     logger.info(`STARTING..`);
 
+    // Load exemptions
+    if (localConfigPath) {
+        await ConfigManager.loadExemptions(localConfigPath);
+    }
+
     const telemetryData = await collectTelemetryData({ repoPath, configServer});
+    const repoUrl = telemetryData.repoUrl;
 
     // Send telemetry for analysis start
     await sendTelemetry({
@@ -76,7 +82,8 @@ export async function analyzeCodebase(params: AnalyzeCodebaseParams): Promise<Re
         fileData,
         installedDependencyVersions,
         minimumDependencyVersions,
-        standardStructure
+        standardStructure,
+        repoUrl
     });
 
     const finishMsg = `\n==========================\nCHECKS COMPLETED..\n==========================`;

package/src/core/engine/engineRunner.test.ts

@@ -29,6 +29,7 @@ describe('runEngineOnFiles', () => {
         installedDependencyVersions: {},
         minimumDependencyVersions: {},
         standardStructure: {},
+        repoUrl: 'https://github.com/mock/repo',
     };
 
     beforeEach(() => {

package/src/core/engine/engineRunner.ts

@@ -1,12 +1,12 @@
 import { EngineResult, RuleResult } from 'json-rules-engine';
 import { ScanResult, RuleFailure } from '../../types/typeDefs';
 import { logger } from '../../utils/logger';
-import { REPO_GLOBAL_CHECK } from '../../utils/configManager';
+import { REPO_GLOBAL_CHECK, ConfigManager } from '../../utils/configManager';
 
 import { RunEngineOnFilesParams } from '../../types/typeDefs';
 
 export async function runEngineOnFiles(params: RunEngineOnFilesParams): Promise<ScanResult[]> {
-    const { engine, fileData, installedDependencyVersions, minimumDependencyVersions, standardStructure } = params;
+    const { engine, fileData, installedDependencyVersions, minimumDependencyVersions, standardStructure, repoUrl } = params;
     const msg = `\n==========================\nRUNNING FILE CHECKS..\n==========================`;
     logger.info(msg);
     const failures: ScanResult[] = [];
@@ -32,7 +32,7 @@ export async function runEngineOnFiles(params: RunEngineOnFilesParams): Promise<
             const { results }: EngineResult = await engine.run(facts);
             results.forEach((result: RuleResult) => {
                 logger.debug(JSON.stringify(result));
-                if (result.result) {
+                if (result.result && !ConfigManager.isExempt(repoUrl, result.name)) {
                     fileFailures.push({
                         ruleFailure: result.name,
                         level: result.event?.type,

package/src/types/typeDefs.ts

@@ -53,6 +53,14 @@ export interface RunEngineOnFilesParams {
     installedDependencyVersions: any;
     minimumDependencyVersions: any;
     standardStructure: any;
+    repoUrl: string;
+}
+
+export interface Exemption {
+    repoUrl: string;
+    rule: string;
+    expirationDate: string;
+    reason: string;
 }
 
 export interface AnalyzeCodebaseParams {

package/src/utils/configManager.ts

@@ -1,6 +1,6 @@
 import { axiosClient } from "./axiosClient";
 import { logger, setLogPrefix } from "./logger";
-import { ArchetypeConfig, ExecutionConfig, GetConfigParams, InitializeParams, LoadLocalConfigParams, RuleConfig } from "../types/typeDefs";
+import { ArchetypeConfig, ExecutionConfig, GetConfigParams, InitializeParams, LoadLocalConfigParams, RuleConfig, Exemption } from "../types/typeDefs";
 import { archetypes } from "../archetypes";
 import { options } from '../core/cli';
 import fs from 'fs';
@@ -12,6 +12,7 @@ export const REPO_GLOBAL_CHECK = 'REPO_GLOBAL_CHECK';
 
 export class ConfigManager {
     private static configs: { [key: string]: ExecutionConfig } = {};
+    private static exemptions: Exemption[] = [];
 
     public static getLoadedConfigs(): string[] {
         return Object.keys(ConfigManager.configs);
@@ -31,6 +32,44 @@ export class ConfigManager {
         return ConfigManager.configs[archetype];
     }
 
+    public static async loadExemptions(localConfigPath: string): Promise<void> {
+        const exemptionsPath = path.join(localConfigPath, 'exemptions.json');
+        try {
+            const exemptionsData = await fs.promises.readFile(exemptionsPath, 'utf-8');
+            const exemptionsJson = JSON.parse(exemptionsData);
+            ConfigManager.exemptions = exemptionsJson.exemptions;
+            logger.info(`Loaded ${ConfigManager.exemptions.length} exemptions`);
+        } catch (error) {
+            logger.warn(`Failed to load exemptions: ${error}`);
+            ConfigManager.exemptions = [];
+        }
+    }
+
+    public static getExemptions(): Exemption[] {
+        return ConfigManager.exemptions;
+    }
+
+    public static getExemptionExpirationDate(repoUrl: string, ruleName: string): Date | undefined {
+        const exemption = ConfigManager.exemptions.find(exemption => 
+            exemption.repoUrl === repoUrl &&
+            exemption.rule === ruleName
+        );
+        return exemption ? new Date(exemption.expirationDate) : undefined;
+    }
+
+    public static isExempt(repoUrl: string, ruleName: string): boolean {
+        const now = new Date();
+        const result =  ConfigManager.exemptions.some(exemption => 
+            exemption.repoUrl === repoUrl &&
+            exemption.rule === ruleName &&
+            new Date(exemption.expirationDate) > now
+        );
+        if (result) {
+            logger.error(`Exempting rule ${ruleName} for repo ${repoUrl} until ${ConfigManager.getExemptionExpirationDate(repoUrl, ruleName)}`);
+        }
+        return result;
+    }
+
     private static async initialize(params: InitializeParams): Promise<ExecutionConfig> {
         const { archetype, logPrefix } = params;
         const configServer = options.configServer;