Fix issue found while testing

Author: stephen-carter-at-sf

packages/code-analyzer-eslint-engine/src/engine.ts

@@ -137,13 +137,13 @@ export class ESLintEngine extends Engine {
         const lintResults: ESLint.LintResult[] = await this._runESLintWorkerTask.run(runTaskInput);
 
         const engineResults: EngineRunResults = {
-            violations: this.toViolations(lintResults)
+            violations: this.toViolations(lintResults, new Set(ruleNames))
         };
         this.emitRunRulesProgressEvent(100);
         return engineResults;
     }
 
-    private toViolations(eslintResults: ESLint.LintResult[]): Violation[] {
+    private toViolations(eslintResults: ESLint.LintResult[], specifiedRules: Set<string>): Violation[] {
         const violations: Violation[] = [];
         for (const eslintResult of eslintResults) {
             for (const resultMsg of eslintResult.messages) {
@@ -152,7 +152,13 @@ export class ESLintEngine extends Engine {
                     continue;
                 }
                 const violation: Violation = toViolation(eslintResult.filePath, resultMsg);
-                violations.push(violation);
+
+                if (specifiedRules.has(violation.ruleName)) {
+                    violations.push(violation);
+                } else {
+                    // This may be possible if a user tries to suppress an eslint rule in their code that isn't available. We just ignore it but debug it just in case.
+                    this.emitLogEvent(LogLevel.Debug, getMessage('ViolationFoundFromUnregisteredRule', violation.ruleName, JSON.stringify(violation,null,2)))
+                }
             }
         }
         return violations;

packages/code-analyzer-eslint-engine/src/messages.ts

@@ -66,6 +66,11 @@ const MESSAGE_CATALOG : { [key: string]: string } = {
         `The eslint engine encountered an unexpected error thrown from '%s':\n%s\n\n` +
         'ESLint options used:\n%s',
 
+    ViolationFoundFromUnregisteredRule:
+        `A rule with name '%s' produced a violation, but this rule was not registered with the 'eslint' engine so it will not be included in the results.\n` +
+        `This may occur if in your file you are using inline comments to attempt to disable or configure this rule even though it is unknown to ESLint and Code Analyzer.\n` +
+        `Ignored Violation:\n%s`,
+
     UnusedESLintConfigFile:
         `The ESLint configuration file '%s' was found but not applied.\n` +
         `To apply this configuration file, set it as the eslint_config_file value in your Code Analyzer configuration. For example:\n` +

packages/code-analyzer-eslint-engine/test/engine.test.ts

@@ -651,6 +651,41 @@ describe('Typical tests for the runRules method of ESLintEngine', () => {
         const relevantDebugEvents: LogEvent[] = logEvents.filter(e => e.logLevel === LogLevel.Debug && e.message.includes("has been replaced with"));
         expect(relevantDebugEvents.length).toBeGreaterThan(0);
     });
+
+    it('When scanning a file that has a directive for a unknown rule, we should not error but issue debug log for it', async () => {
+        const engine: Engine = await createEngineFromPlugin({
+            ...DEFAULT_CONFIG_FOR_TESTING
+        });
+        const logEvents: LogEvent[] = [];
+        engine.onEvent(EventType.LogEvent, (event: LogEvent) => logEvents.push(event));
+
+        const runOptions: RunOptions = createRunOptions(new Workspace('id', [
+            path.join(testDataFolder, 'workspaceWithDirectiveAboutUnknownRule')]));
+
+        const results: EngineRunResults = await engine.runRules(['no-unused-vars'], runOptions);
+
+        expect(results.violations).toHaveLength(1);
+        expect(results.violations[0].ruleName).toEqual('no-unused-vars');
+
+        const filteredViolation: Violation = {
+            ruleName: "oops-rule",
+            message: "Definition for rule 'oops-rule' was not found.",
+            codeLocations: [{
+                file: path.join(testDataFolder, 'workspaceWithDirectiveAboutUnknownRule', 'containsDirectiveForUnknownRule.js'),
+                startLine: 4,
+                startColumn: 1,
+                endLine: 4,
+                endColumn: 31
+            }],
+            primaryLocationIndex: 0
+        };
+
+        expect(logEvents).toContainEqual({
+            type: EventType.LogEvent,
+            logLevel: LogLevel.Debug,
+            message: getMessage('ViolationFoundFromUnregisteredRule', 'oops-rule', JSON.stringify(filteredViolation, null, 2))
+        });
+    });
 });
 
 describe('Tests for the getEngineVersion method of ESLint Engine', () => {

packages/code-analyzer-eslint-engine/test/test-data/workspaceWithDirectiveAboutUnknownRule/containsDirectiveForUnknownRule.js

@@ -0,0 +1,6 @@
+// The "oops-rule" is unknown to our base configuration and so we shouldn't report any issues here, but instead
+// issue debug log.
+
+/* eslint-disable oops-rule */
+function helloWorld() {
+}