feat: addapt to severity string enum

Author: pedrogude

packages/certification-service/code/src/evaluate/graphqlEvaluate.js

@@ -5,15 +5,15 @@
 const { ESLint } = require("eslint");
 const graphqlPlugin = require("@graphql-eslint/eslint-plugin");
 const path = require("path");
-const { WARN_SEVERITY } = require("./severity");
+const { WARN_SEVERITY, ERROR_SEVERITY } = require("./severity");
 const { configValue } = require("../config/config");
 const GRAPHQL_FILE_EXTENSIONS = configValue("cerws.certification.protocol.GRAPHQL.file-extensions", [
   "graphql",
   "graphqls",
   "gql",
 ]);
 
-const evaluateGraphqlRepo = async (rootFolder, config) => {
+const evaluateGraphqlApi = async (rootFolder, config) => {
   return await runEslint(
     rootFolder,
     {
@@ -29,7 +29,7 @@ const evaluateGraphqlFile = async (file, config) => {
     path.dirname(file),
     {
       graphQLConfig: { schema: file },
-      config,
+      graphqlCustomConfig: config,
     },
     [file],
   );
@@ -45,7 +45,7 @@ const runEslint = async (cwd, config, files) => {
   if (config?.graphqlCustomConfig?.rulesConfig?.rules) {
     rules = config.graphqlCustomConfig.rulesConfig.rules;
   } else {
-    rules = graphqlPlugin.configs["flat/schema-all"].rules;
+    rules = graphqlPlugin.configs["flat/schema-recommended"].rules;
   }
 
   const eslint = new ESLint({
@@ -71,13 +71,14 @@ const runEslint = async (cwd, config, files) => {
   results.forEach((file) => {
     file.messages.forEach((message) => {
       const customSeverity = config.graphqlCustomConfig?.rulesConfig?.severities[message.ruleId];
-      message.customSeverity = typeof customSeverity === "number" ? customSeverity : WARN_SEVERITY;
+      message.customSeverity =
+        typeof customSeverity === "number" ? customSeverity : message.severity === 1 ? WARN_SEVERITY : ERROR_SEVERITY;
     });
   });
   return results;
 };
 
 module.exports = {
-  evaluateGraphqlRepo,
+  evaluateGraphqlApi,
   evaluateGraphqlFile,
 };

packages/certification-service/code/src/format/issue.js

@@ -1,14 +1,20 @@
 // SPDX-FileCopyrightText: 2025 Industria de Diseño Textil S.A. INDITEX
 //
 // SPDX-License-Identifier: Apache-2.0
+const { INFO_SEVERITY, WARN_SEVERITY, ERROR_SEVERITY } = require("../evaluate/severity");
 const { cleanFileName } = require("../verify/utils");
+const severity = {
+  [INFO_SEVERITY]: "INFO",
+  [WARN_SEVERITY]: "WARN",
+  [ERROR_SEVERITY]: "ERROR",
+};
 
 const fromSpectralIssue = (issue, filePath, tempDir) => {
   return {
     fileName: cleanFileName(filePath, tempDir),
     code: issue.code,
     message: issue.message,
-    severity: issue.severity,
+    severity: severity[issue.severity],
     range: {
       start: {
         line: issue.range?.start?.line,
@@ -28,7 +34,7 @@ const fromProtlintIssue = (issue, filePath, tempDir) => {
     fileName: cleanFileName(filePath, tempDir),
     code: issue.rule,
     message: issue.message,
-    severity: issue.severity,
+    severity: severity[issue.severity],
     range: {
       start: {
         line: issue.line,
@@ -48,7 +54,7 @@ const fromMarkdownlintIssue = (issue) => {
     fileName: issue.fileName,
     code: issue.ruleNames.join(", "),
     message: issue.ruleDescription,
-    severity: issue.severity,
+    severity: severity[issue.severity],
     range: {
       start: {
         line: issue.lineNumber,
@@ -69,7 +75,7 @@ const fromEslintIssue = (issue, filePath, tempDir) => {
     fileName: cleanFileName(filePath, tempDir),
     code: issue.messageId || issue.ruleId,
     message: issue.message,
-    severity: issue.customSeverity,
+    severity: severity[issue.customSeverity],
     range: {
       start: {
         line: issue.line,

packages/certification-service/code/src/verify/lint.js

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 const { evaluate } = require("../evaluate/spectralEvaluate");
-const { evaluateGraphqlRepo, evaluateGraphqlFile } = require("../evaluate/graphqlEvaluate");
+const { evaluateGraphqlApi, evaluateGraphqlFile } = require("../evaluate/graphqlEvaluate");
 const evaluateProtolint = require("../evaluate/protolintEvaluate");
 const { markdownEvaluate } = require("../evaluate/markdownEvaluate");
 const { mkdirSync } = require("fs");
@@ -32,7 +32,7 @@ const lintFileWithMarkdownLint = async (file, ruleset) => {
 
 const lintGraphql = async (rootFolder, config = {}) => {
   logger.info(`Linting graphql folder ${rootFolder}`);
-  return await evaluateGraphqlRepo(rootFolder, config);
+  return await evaluateGraphqlApi(rootFolder, config);
 };
 
 const lintGraphqlFile = async (file, config = {}) => {

packages/certification-service/code/test/evaluate/graphqlEvaluate.test.js

@@ -2,11 +2,11 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-const { evaluateGraphqlRepo, evaluateGraphqlFile } = require("../../src/evaluate/graphqlEvaluate");
+const { evaluateGraphqlApi, evaluateGraphqlFile } = require("../../src/evaluate/graphqlEvaluate");
 const { ESLint } = require("eslint");
 const graphqlPlugin = require("@graphql-eslint/eslint-plugin");
 const path = require("path");
-const { WARN_SEVERITY, INFO_SEVERITY } = require("../../src/evaluate/severity");
+const { WARN_SEVERITY, INFO_SEVERITY, ERROR_SEVERITY } = require("../../src/evaluate/severity");
 const { getAppLogger } = require("../../src/log");
 
 jest.mock("eslint");
@@ -24,7 +24,7 @@ describe("graphqlEvaluate", () => {
     jest.clearAllMocks();
   });
 
-  describe("evaluateGraphqlRepo", () => {
+  describe("evaluateGraphqlApi", () => {
     test("should run ESLint for repository", async () => {
       const mockLintFiles = jest.fn().mockResolvedValue([]);
 
@@ -35,7 +35,7 @@ describe("graphqlEvaluate", () => {
       const mockRootFolder = "/mock/root/folder";
       const mockConfig = {};
 
-      const result = await evaluateGraphqlRepo(mockRootFolder, mockConfig);
+      const result = await evaluateGraphqlApi(mockRootFolder, mockConfig);
 
       expect(ESLint).toHaveBeenCalledWith({
         overrideConfigFile: true,
@@ -53,7 +53,7 @@ describe("graphqlEvaluate", () => {
           plugins: {
             "@graphql-eslint": graphqlPlugin,
           },
-          rules: graphqlPlugin.configs["flat/schema-all"].rules,
+          rules: graphqlPlugin.configs["flat/schema-recommended"].rules,
         },
       });
 
@@ -135,7 +135,7 @@ describe("graphqlEvaluate", () => {
         "/mock/root/folder/**/*.graphqls",
         "/mock/root/folder/**/*.gql",
       ];
-      const result = await evaluateGraphqlRepo(mockRootFolder, mockConfig);
+      const result = await evaluateGraphqlApi(mockRootFolder, mockConfig);
 
       expect(ESLint).toHaveBeenCalledWith({
         overrideConfigFile: true,
@@ -186,7 +186,7 @@ describe("graphqlEvaluate", () => {
                 range: [1304, 1521],
                 text: "",
               },
-              customSeverity: WARN_SEVERITY,
+              customSeverity: ERROR_SEVERITY,
             },
           ],
           suppressedMessages: [],
@@ -234,7 +234,7 @@ describe("graphqlEvaluate", () => {
           plugins: {
             "@graphql-eslint": graphqlPlugin,
           },
-          rules: graphqlPlugin.configs["flat/schema-all"].rules,
+          rules: graphqlPlugin.configs["flat/schema-recommended"].rules,
         },
       });
 

packages/certification-service/code/test/format/issue.test.js

@@ -35,7 +35,7 @@ describe("Issue Conversion Functions", () => {
       fileName: "file.yaml",
       code: "contact-email",
       message: "Definition must have a contact email",
-      severity: 1,
+      severity: "WARN",
       range: issue.range,
       path: issue.path,
     });
@@ -55,7 +55,7 @@ describe("Issue Conversion Functions", () => {
       fileName: "proto.proto",
       code: "ENUM_NAMES_LOWER_SNAKE_CASE",
       message: 'Enum name "Brand" must be underscore_separated_names',
-      severity: 1,
+      severity: "WARN",
       range: {
         start: { line: 125, character: 2 },
         end: { line: 125, character: 2 },
@@ -84,7 +84,7 @@ describe("Issue Conversion Functions", () => {
       fileName: "test/README.md",
       code: "MD012, no-multiple-blanks",
       message: "Multiple consecutive blank lines",
-      severity: 1,
+      severity: "WARN",
       range: {
         start: { line: 3, character: 1 },
         end: { line: 3, character: 1 },
@@ -116,7 +116,7 @@ describe("Issue Conversion Functions", () => {
       fileName: "schema.graphqls",
       code: "alphabetize",
       message: 'type "Color" should be before type "MasterData"',
-      severity: 2,
+      severity: "INFO",
       range: {
         start: { line: 91, character: 6 },
         end: { line: 91, character: 11 },
@@ -142,7 +142,7 @@ describe("Issue Conversion Functions", () => {
       fileName: "schema.graphql",
       code: "custom-rules/my-custom-rule",
       message: "The field `Query.executeExampleMethod` has no valid name!",
-      severity: 2,
+      severity: "INFO",
       range: {
         start: { line: 7, character: 3 },
         end: { line: 16, character: 20 },

packages/certification-service/code/test/verify/graphqlLinter.test.js

@@ -91,7 +91,7 @@ describe("GraphqlLinter", () => {
           fileName: "file1.graphql",
           code: "alphabetize",
           message: 'type "Color" should be before type "MasterData"',
-          severity: INFO_SEVERITY,
+          severity: "INFO",
           range: {
             start: { line: 91, character: 6 },
             end: { line: 91, character: 11 },

packages/certification-service/code/test/verify/lint.test.js

@@ -0,0 +1,90 @@
+const { lintGraphql, lintGraphqlFile } = require("../../src/verify/lint");
+const { evaluateGraphqlApi, evaluateGraphqlFile } = require("../../src/evaluate/graphqlEvaluate");
+const { WARN_SEVERITY } = require("../../src/evaluate/severity");
+
+jest.mock("../../src/evaluate/graphqlEvaluate", () => ({
+  evaluateGraphqlApi: jest.fn(),
+  evaluateGraphqlFile: jest.fn(),
+}));
+
+describe("GraphQL Linter", () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe("GraphQL Linter", () => {
+    const graphqlLinterExpectedResult = [
+      {
+        filePath: "/test/folder/schema.graphql",
+        messages: [
+          {
+            ruleId: "@graphql-eslint/require-description",
+            severity: 2,
+            message: 'Description is required for input "Article"',
+            line: 41,
+            column: 7,
+            nodeType: null,
+            messageId: "require-description",
+            endLine: 41,
+            endColumn: 14,
+            customSeverity: 1,
+          },
+        ],
+        suppressedMessages: [],
+        errorCount: 12,
+        fatalErrorCount: 0,
+        warningCount: 0,
+        fixableErrorCount: 0,
+        fixableWarningCount: 0,
+        source: "",
+        usedDeprecatedRules: [],
+      },
+    ];
+
+    const linterConfig = {
+      plugins: {},
+      rulesConfig: {
+        rules: {
+          "@graphql-eslint/require-description": "error",
+        },
+        severities: {
+          "@graphql-eslint/require-description": WARN_SEVERITY,
+        },
+      },
+    };
+    test("lintGraphql should call evaluateGraphqlApi without config", async () => {
+      evaluateGraphqlApi.mockResolvedValue(graphqlLinterExpectedResult);
+
+      const result = await lintGraphql("/test/folder");
+
+      expect(evaluateGraphqlApi).toHaveBeenCalledWith("/test/folder", {});
+      expect(result).toStrictEqual(graphqlLinterExpectedResult);
+    });
+
+    test("lintGraphql should call evaluateGraphqlApi with config", async () => {
+      evaluateGraphqlApi.mockResolvedValue(graphqlLinterExpectedResult);
+
+      const result = await lintGraphql("/test/folder", linterConfig);
+
+      expect(evaluateGraphqlApi).toHaveBeenCalledWith("/test/folder", linterConfig);
+      expect(result).toStrictEqual(graphqlLinterExpectedResult);
+    });
+
+    test("lintGraphqlFile should call evaluateGraphqlFile without config", async () => {
+      evaluateGraphqlFile.mockResolvedValue(graphqlLinterExpectedResult);
+
+      const result = await lintGraphqlFile("/test/folder/schema.graphql");
+
+      expect(evaluateGraphqlFile).toHaveBeenCalledWith("/test/folder/schema.graphql", {});
+      expect(result).toStrictEqual(graphqlLinterExpectedResult);
+    });
+    test("lintGraphqlFile should call evaluateGraphqlFile with config", async () => {
+      evaluateGraphqlFile.mockResolvedValue(graphqlLinterExpectedResult);
+
+      const result = await lintGraphqlFile("/test/folder/schema.graphql", linterConfig);
+
+      expect(evaluateGraphqlFile).toHaveBeenCalledWith("/test/folder/schema.graphql", linterConfig);
+      expect(result).toStrictEqual(graphqlLinterExpectedResult);
+    });
+  });
+});