x-fidelity 3.10.0 → 3.12.0

package/.github/CODEOWNERS

@@ -0,0 +1,15 @@
+# Default owners for everything in the repo
+* @zotoio/core-team
+
+# Specific ownership rules
+/src/core/ @zotoio/core-team
+/src/facts/ @zotoio/rules-team
+/src/operators/ @zotoio/rules-team
+/src/plugins/ @zotoio/plugin-team
+/src/server/ @zotoio/api-team
+/src/types/ @zotoio/core-team
+/src/utils/ @zotoio/core-team
+/website/ @zotoio/docs-team
+
+# Notification test team
+/src/notifications/ @zotoio/notification-team

package/.xfi-config.json

@@ -34,5 +34,23 @@
     ],
     "additionalFacts": ["customFact"],
     "additionalOperators": ["customOperator"],
-    "additionalPlugins": ["xfiPluginSimpleExample"]
+    "additionalPlugins": ["xfiPluginSimpleExample"],
+    "notifications": {
+        "recipients": {
+            "email": [
+                "io@zoto.io"
+            ],
+            "slack": [
+                "U123456",
+                "U789012"
+            ],
+            "teams": [
+                "user1@example.com",
+                "user2@example.com"
+            ]
+        },
+        "codeOwners": true,
+        "notifyOnSuccess": false,
+        "notifyOnFailure": true
+    }
 }

package/CHANGELOG.md

@@ -1,3 +1,52 @@
+# [3.12.0](https://github.com/zotoio/x-fidelity/compare/v3.11.0...v3.12.0) (2025-03-10)
+
+
+### Bug Fixes
+
+* add HTML email support with plain text fallback ([ec0f252](https://github.com/zotoio/x-fidelity/commit/ec0f2529d4f05ca570cd4b11db07ede2d4d21113))
+* correct string interpolation syntax in notification template ([092b64d](https://github.com/zotoio/x-fidelity/commit/092b64d3f614d505c7a792bd7a559e10aed3192c))
+* correct template literal syntax in notification manager ([f5720c2](https://github.com/zotoio/x-fidelity/commit/f5720c230051d8e38bbc95024a02d7298d2299f5))
+* escape nested template literals in notification template ([4feb497](https://github.com/zotoio/x-fidelity/commit/4feb497255615b93655ba7bba8729e55b56b4016))
+* **notify:** email formatting fixes ([06e80a8](https://github.com/zotoio/x-fidelity/commit/06e80a81bab30c1ab03d202d0649306fe331debd))
+* remove duplicate fileIssues declaration in notification manager ([d5678a1](https://github.com/zotoio/x-fidelity/commit/d5678a1620fae5b78ee475b95ee2248051d17c8f))
+* remove local directory paths from notification file links ([d55da96](https://github.com/zotoio/x-fidelity/commit/d55da9637477b0b14acb45d99a8a1a4b9e661c30))
+* remove trailing comma in .xfi-config.json ([41c7368](https://github.com/zotoio/x-fidelity/commit/41c7368a7e7ba8b989f3d8bf2fc0ce9e3e4d1183))
+* replace nested template literals with string concatenation ([89712cf](https://github.com/zotoio/x-fidelity/commit/89712cf77e231863e5bcb6c214fedf5b9f0d1f3f))
+* resolve TypeScript errors with yaml imports and variable declarations ([af2ea8e](https://github.com/zotoio/x-fidelity/commit/af2ea8ee80d48b9dddb1f586d61285518aee0b1c))
+* use repoPath from results metadata instead of undefined variable ([36b42fa](https://github.com/zotoio/x-fidelity/commit/36b42fae14895ba147955806efcf3cc94ec1d306))
+
+
+### Features
+
+* add failed rule names to notification template for each file ([d09d019](https://github.com/zotoio/x-fidelity/commit/d09d019bc1f9eff2f5c375185aec7f8f54fb7f96))
+* add severity levels to failed rules in notification output ([a90ffe7](https://github.com/zotoio/x-fidelity/commit/a90ffe724c440f60f1f1c59be0ec3074316c28c1))
+* add YAML results attachment to email notifications ([e2671b4](https://github.com/zotoio/x-fidelity/commit/e2671b46081168b1ac911f595a05f3301f8df780))
+* enhance notification formatting with HTML and color-coded severity ([f034a85](https://github.com/zotoio/x-fidelity/commit/f034a858c0da629d7fc134818babcbf28fa7b03e))
+* enhance notification templates with clickable links and emojis ([3afbd5d](https://github.com/zotoio/x-fidelity/commit/3afbd5db68cfbb604407e791f58c184961e7dc78))
+* support GitHub Enterprise links in notifications ([092867f](https://github.com/zotoio/x-fidelity/commit/092867fd3948e1bfcc10e8ecfc312686f37c9afa))
+* use git commands to extract GitHub repo details ([8f35471](https://github.com/zotoio/x-fidelity/commit/8f3547145a612444b9320c0b5d1b75529edfaa4a))
+
+# [3.11.0](https://github.com/zotoio/x-fidelity/compare/v3.10.0...v3.11.0) (2025-03-09)
+
+
+### Bug Fixes
+
+* Remove duplicate import statement in notifications test ([f5c6468](https://github.com/zotoio/x-fidelity/commit/f5c6468063c1575610cd4b54aad84b97d4884437))
+* **results:** fix missing filesystem match details ([bc62faf](https://github.com/zotoio/x-fidelity/commit/bc62faff20e69fa6977e1ceee1bc22ad578cf2ba))
+* update NotificationManager mock to properly handle registerProvider ([6102837](https://github.com/zotoio/x-fidelity/commit/6102837f206938500885faf33560a91235a41885))
+
+
+### Features
+
+* add CODEOWNERS and notification test config ([5dc2904](https://github.com/zotoio/x-fidelity/commit/5dc29047d86f33b27fc9603077884b4df3f37330))
+* add debug logging for notification flow ([0e6af6b](https://github.com/zotoio/x-fidelity/commit/0e6af6b1583636935561f85a33c0bbea830905a5))
+* add detailed debug logging for email notifications ([18d929b](https://github.com/zotoio/x-fidelity/commit/18d929b3cc49b538c6ea3330d51d2670b090f7ba))
+* add email notification configuration to node-fullstack archetype ([424c5a0](https://github.com/zotoio/x-fidelity/commit/424c5a007c1b9eabeaffbca375cac131142ff7c9))
+* add notification system with email, slack and teams providers ([95d4ade](https://github.com/zotoio/x-fidelity/commit/95d4ade7de8db30c1592087ffa8dd78845c4ee47))
+* add notification team to CODEOWNERS file ([edb648e](https://github.com/zotoio/x-fidelity/commit/edb648e7378239ae7b6f672b9ce73c97e820a82a))
+* add package version to XFI_RESULT metadata ([1ee061a](https://github.com/zotoio/x-fidelity/commit/1ee061a971bbf63d18014f529a3353d4efb63482))
+* add xfiVersion field to ResultMetadata interface ([e59b187](https://github.com/zotoio/x-fidelity/commit/e59b18725b98781f547e58c5d9581d2ad7d5949f))
+
 # [3.10.0](https://github.com/zotoio/x-fidelity/compare/v3.9.1...v3.10.0) (2025-03-08)
 
 

package/dist/core/cli.js

@@ -35,7 +35,8 @@ function initCLI() {
             info: (obj) => console.log(JSON.stringify(obj)),
             error: (obj) => console.error(JSON.stringify(obj)),
             warn: (obj) => console.warn(JSON.stringify(obj)),
-            debug: (obj) => console.debug(JSON.stringify(obj))
+            debug: (obj) => console.debug(JSON.stringify(obj)),
+            trace: (obj) => console.trace(JSON.stringify(obj))
         };
         global.logger = fallbackLogger;
     }

package/dist/core/engine/analyzer.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.analyzeCodebase = analyzeCodebase;
 const logger_1 = require("../../utils/logger");
 const configManager_1 = require("../configManager");
+const package_json_1 = require("../../../package.json");
 const openaiUtils_1 = require("../../utils/openaiUtils");
 const telemetry_1 = require("../../utils/telemetry");
 const repoFilesystemFacts_1 = require("../../facts/repoFilesystemFacts");
@@ -172,7 +173,8 @@ function analyzeCodebase(params) {
                 exemptCount: exemptCount,
                 options: cli_1.options,
                 repoPath,
-                repoUrl
+                repoUrl,
+                xfiVersion: package_json_1.version
             }
         };
         // Send telemetry for analysis end

package/dist/demoConfig/node-fullstack.json

@@ -59,6 +59,20 @@
             ".*\\.(ts|tsx|js|jsx)$",
             ".*\\/xfiTestMatch\\.json$",
             ".*\\/README\\.md$"
-        ]
+        ],
+        "notifications": {
+            "enabled": true,
+            "providers": ["email"],
+            "recipients": {
+                "email": ["io@zoto.io"]
+            },
+            "codeOwners": true,
+            "notifyOnSuccess": true,
+            "notifyOnFailure": true,
+            "customTemplates": {
+                "success": "All checks passed successfully! 🎉\n\nArchetype: ${archetype}\nFiles analyzed: ${fileCount}\nExecution time: ${executionTime}s",
+                "failure": "Issues found in codebase:\n\nArchetype: ${archetype}\nTotal issues: ${totalIssues}\n- Warnings: ${warningCount}\n- Errors: ${errorCount}\n- Fatalities: ${fatalityCount}\n\nAffected files:\n${affectedFiles}"
+            }
+        }
     }
 }

package/dist/demoConfig/rules/newSdkFeatureNotAdoped-global-rule.json

@@ -12,10 +12,10 @@
                 "fact": "globalFileAnalysis",
                 "params": {
                     "newPatterns": [
-                        "logger\\.info\\("
+                        "const plugin: XFiPlugin = {"
                     ],
                     "legacyPatterns": [
-                        "logger\\.debug\\("
+                        "import {.*FactDefn.*} from '\\.\\./types/typeDefs';"
                     ],
                     "fileFilter": ".*\\.(ts|js)$",
                     "resultFact": "sdkUsageAnalysis"

package/dist/demoConfig/rules/noDatabases-iterative-rule.json

@@ -11,7 +11,11 @@
             {
                 "fact": "repoFileAnalysis",
                 "params": {
-                    "checkPattern": ["oracle", "mysql", "mssql", "postgres", "sqlite", "mongodb", "cassandra", "redis", "rethinkdb", "neo4j", "couchdb"],
+                    "checkPattern": [
+                        "[\\s\\'\\\"\\.](oracle)[\\s\\'\\\"\\.]",
+                        "[\\s\\'\\\"\\.](postgres)[\\s\\'\\\"\\.]", 
+                        "[\\s\\'\\\"\\.](mongodb)[\\s\\'\\\"\\.]"
+                    ],
                     "resultFact": "fileResultsDB"
                 },
                 "operator": "fileContains",

package/dist/demoConfig/rules/sensitiveLogging-iterative-rule.json

@@ -23,11 +23,9 @@
                     "checkPattern": [
                         "(api[_-]?key|auth[_-]?token|access[_-]?token|secret[_-]?key)",
                         "(aws[_-]?access[_-]?key[_-]?id|aws[_-]?secret[_-]?access[_-]?key)",
-                        "(password|passphrase)",
                         "(private[_-]?key|ssh[_-]?key)",
                         "(oauth[_-]?token|jwt[_-]?token)",
-                        "db[_-]?password",
-                        "(declare)"
+                        "db[_-]?password"
                     ],
                     "resultFact": "fileResults"
                 },

package/dist/facts/repoFilesystemFacts.js

@@ -130,11 +130,11 @@ function repoFileAnalysis(params, almanac) {
             return result;
         }
         //if there is already a resultFact for this file, we need to append
-        // const existingResult = almanac.factValue(params.resultFact);
-        // if (Object.keys(existingResult).includes('result')) {
-        //     logger.error(JSON.stringify(existingResult));
-        //     result.result = existingResult.result;
-        // }
+        const existingResult = almanac.factValue(params.resultFact);
+        if (Object.keys(existingResult).includes('result')) {
+            logger_1.logger.error(JSON.stringify(existingResult));
+            result.result = existingResult.result;
+        }
         const analysis = [];
         const lines = fileContent.split('\n');
         logger_1.logger.debug({ lineCount: lines.length }, 'Processing file lines');
@@ -196,8 +196,8 @@ function repoFileAnalysis(params, almanac) {
                 result.result[resultLength + i] = fileAnalysis[i];
             }
         }
-        //result.result. = analysis;
-        almanac.addRuntimeFact(params.resultFact, result);
+        result.result = analysis;
+        almanac.addRuntimeFact(params.resultFact, result.result);
         return result;
         // testing match on 'oracle'
         // testing match on 'declare'

package/dist/index.js

@@ -62,6 +62,7 @@ const prettyjson_1 = __importDefault(require("prettyjson"));
 const analyzer_1 = require("./core/engine/analyzer");
 const configServer_1 = require("./server/configServer");
 const telemetry_1 = require("./utils/telemetry");
+const notifications_1 = require("./notifications");
 // Function to handle errors and send telemetry
 const handleError = (error) => __awaiter(void 0, void 0, void 0, function* () {
     yield (0, telemetry_1.sendTelemetry)({
@@ -85,6 +86,16 @@ logger_1.logger.debug({ options: cli_1.options }, 'Startup options');
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
+            // Initialize notification system
+            const notificationConfig = {
+                enabled: process.env.NOTIFICATIONS_ENABLED === 'true',
+                providers: (process.env.NOTIFICATION_PROVIDERS || '').split(',').filter(Boolean),
+                codeOwnersPath: process.env.CODEOWNERS_PATH || '.github/CODEOWNERS',
+                codeOwnersEnabled: process.env.CODEOWNERS_ENABLED !== 'false', // Default to true
+                notifyOnSuccess: process.env.NOTIFY_ON_SUCCESS === 'true',
+                notifyOnFailure: process.env.NOTIFY_ON_FAILURE !== 'false', // Default to true
+            };
+            const notificationManager = yield (0, notifications_1.initializeNotifications)(notificationConfig);
             if (cli_1.options.examine && process.env.NODE_ENV !== 'test') {
                 const { validateArchetypeConfig } = yield Promise.resolve().then(() => __importStar(require('./core/validateConfig')));
                 validateArchetypeConfig();
@@ -103,6 +114,21 @@ function main() {
                     });
                     const resultString = JSON.stringify(resultMetadata);
                     const prettyResult = prettyjson_1.default.render(resultMetadata.XFI_RESULT);
+                    // Add debug logging before notification check
+                    logger_1.logger.debug({
+                        notificationsEnabled: process.env.NOTIFICATIONS_ENABLED,
+                        notificationConfig: notificationConfig,
+                        hasNotificationManager: !!notificationManager
+                    }, 'Checking notification status');
+                    // Send notifications if enabled
+                    if (notificationConfig.enabled) {
+                        logger_1.logger.debug('Notifications are enabled, preparing to send report');
+                        logger_1.logger.debug({
+                            affectedFilesCount: resultMetadata.XFI_RESULT.issueDetails.length
+                        }, 'Preparing notification data');
+                        // Pass the repo config to the notification manager
+                        yield notificationManager.sendReport(resultMetadata);
+                    }
                     // if results are found, there were issues found in the codebase
                     if (resultMetadata.XFI_RESULT.totalIssues > 0) {
                         logger_1.logger.warn(`WARNING: lo-fi attributes detected in codebase. ${resultMetadata.XFI_RESULT.warningCount} are warnings, ${resultMetadata.XFI_RESULT.fatalityCount} are fatal.`);

package/dist/index.test.js

@@ -56,6 +56,7 @@ jest.mock('./utils/logger', () => ({
         warn: jest.fn(),
         error: jest.fn(),
         debug: jest.fn(),
+        trace: jest.fn()
     },
     setLogPrefix: jest.fn(),
     setLogLevel: jest.fn(),

package/dist/notifications/index.d.ts

@@ -0,0 +1,3 @@
+import { NotificationManager } from './notificationManager';
+import { NotificationConfig } from '../types/notificationTypes';
+export declare function initializeNotifications(config: NotificationConfig): Promise<NotificationManager>;

package/dist/notifications/index.js

@@ -0,0 +1,120 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeNotifications = initializeNotifications;
+const notificationManager_1 = require("./notificationManager");
+const emailProvider_1 = require("./providers/emailProvider");
+const slackProvider_1 = require("./providers/slackProvider");
+const teamsProvider_1 = require("./providers/teamsProvider");
+const logger_1 = require("../utils/logger");
+function initializeNotifications(config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!config.enabled) {
+            logger_1.logger.info('Notifications are disabled');
+            return notificationManager_1.NotificationManager.getInstance(config);
+        }
+        const notificationManager = notificationManager_1.NotificationManager.getInstance(config);
+        // Register configured providers
+        for (const providerName of config.providers) {
+            switch (providerName) {
+                case 'email':
+                    const emailConfig = loadEmailConfig();
+                    if (emailConfig) {
+                        notificationManager.registerProvider(new emailProvider_1.EmailProvider(emailConfig));
+                    }
+                    break;
+                case 'slack':
+                    const slackConfig = loadSlackConfig();
+                    if (slackConfig) {
+                        notificationManager.registerProvider(new slackProvider_1.SlackProvider(slackConfig));
+                    }
+                    break;
+                case 'teams':
+                    const teamsConfig = loadTeamsConfig();
+                    if (teamsConfig) {
+                        notificationManager.registerProvider(new teamsProvider_1.TeamsProvider(teamsConfig));
+                    }
+                    break;
+                default:
+                    logger_1.logger.warn(`Unknown notification provider: ${providerName}`);
+            }
+        }
+        return notificationManager;
+    });
+}
+function loadEmailConfig() {
+    try {
+        const config = {
+            host: process.env.NOTIFICATION_EMAIL_HOST || '',
+            port: parseInt(process.env.NOTIFICATION_EMAIL_PORT || '587'),
+            secure: process.env.NOTIFICATION_EMAIL_SECURE === 'true',
+            auth: {
+                user: process.env.NOTIFICATION_EMAIL_USER || '',
+                pass: process.env.NOTIFICATION_EMAIL_PASS || '',
+            },
+            from: process.env.NOTIFICATION_EMAIL_FROM || 'x-fidelity@noreply.com',
+        };
+        // Add debug logging
+        logger_1.logger.debug({
+            emailConfig: Object.assign(Object.assign({}, config), { auth: {
+                    user: config.auth.user,
+                    pass: '****' // Mask password
+                } })
+        }, 'Email configuration loaded');
+        // Validate required fields
+        if (!config.host || !config.auth.user || !config.auth.pass) {
+            logger_1.logger.warn('Missing required email configuration fields', {
+                hasHost: !!config.host,
+                hasUser: !!config.auth.user,
+                hasPass: !!config.auth.pass
+            });
+            return null;
+        }
+        return config;
+    }
+    catch (error) {
+        logger_1.logger.error(error, 'Failed to load email configuration');
+        return null;
+    }
+}
+function loadSlackConfig() {
+    try {
+        const webhookUrl = process.env.NOTIFICATION_SLACK_WEBHOOK;
+        if (!webhookUrl) {
+            logger_1.logger.warn('Slack webhook URL not configured');
+            return null;
+        }
+        return {
+            webhookUrl,
+            channel: process.env.NOTIFICATION_SLACK_CHANNEL,
+        };
+    }
+    catch (error) {
+        logger_1.logger.error(error, 'Failed to load Slack configuration');
+        return null;
+    }
+}
+function loadTeamsConfig() {
+    try {
+        const webhookUrl = process.env.NOTIFICATION_TEAMS_WEBHOOK;
+        if (!webhookUrl) {
+            logger_1.logger.warn('Teams webhook URL not configured');
+            return null;
+        }
+        return {
+            webhookUrl
+        };
+    }
+    catch (error) {
+        logger_1.logger.error(error, 'Failed to load Teams configuration');
+        return null;
+    }
+}

package/dist/notifications/notificationManager.d.ts

@@ -0,0 +1,19 @@
+import { ResultMetadata } from '../types/typeDefs';
+import { NotificationProvider, NotificationConfig } from '../types/notificationTypes';
+export declare class NotificationManager {
+    private static instance;
+    private providers;
+    private config;
+    private codeOwners;
+    private constructor();
+    static getInstance(config: NotificationConfig): NotificationManager;
+    registerProvider(provider: NotificationProvider): void;
+    sendReport(results: ResultMetadata): Promise<void>;
+    private mergeNotificationConfig;
+    private getRecipients;
+    private loadCodeOwners;
+    private getCodeOwnersForFiles;
+    private matchesGlob;
+    private getAffectedFiles;
+    private generateReportContent;
+}