@checkdigit/eslint-plugin 7.18.0-PR.143-b47c → 7.18.0-PR.143-cf9d

package/src/athena/visitor.ts

@@ -1,9 +1,5 @@
 // athena/visitor.ts
 
-import debug from 'debug';
-
-const log = debug('athena:visitor');
-
 import type {
   AggrFunc,
   BaseFrom,
@@ -70,20 +66,23 @@ export interface VisitorMap {
 // nodes without an intermediate cast.
 // -------------------------------------------------------------------
 
+function hasNodeType(node: unknown, type: string): boolean {
+  return typeof node === 'object' && node !== null && (node as { type?: unknown }).type === type;
+}
+
 export function isUnnestFrom(node: unknown): node is UnnestFrom {
-  return typeof node === 'object' && node !== null && (node as { type?: unknown }).type === 'unnest';
+  return hasNodeType(node, 'unnest');
 }
 
 export function isDual(node: unknown): node is Dual {
-  return typeof node === 'object' && node !== null && (node as { type?: unknown }).type === 'dual';
+  return hasNodeType(node, 'dual');
 }
 
 export function isValuesFrom(node: unknown): node is ValuesFrom {
   if (typeof node !== 'object' || node === null) {
     return false;
   }
-  const expr = (node as { expr?: unknown }).expr;
-  return typeof expr === 'object' && expr !== null && (expr as { type?: unknown }).type === 'values';
+  return hasNodeType((node as { expr?: unknown }).expr, 'values');
 }
 
 export function isTableExpr(node: unknown): node is TableExpr {
@@ -94,27 +93,16 @@ export function isTableExpr(node: unknown): node is TableExpr {
   return typeof expr === 'object' && expr !== null && 'ast' in expr;
 }
 
+function isRegularFromItem(node: unknown): boolean {
+  return typeof node === 'object' && node !== null && !isUnnestFrom(node) && !isDual(node) && !isTableExpr(node);
+}
+
 export function isJoin(node: unknown): node is Join {
-  return (
-    !isUnnestFrom(node) &&
-    !isDual(node) &&
-    !isTableExpr(node) &&
-    typeof node === 'object' &&
-    node !== null &&
-    'join' in node
-  );
+  return isRegularFromItem(node) && 'join' in (node as object);
 }
 
 export function isBaseFrom(node: unknown): node is BaseFrom {
-  return (
-    !isUnnestFrom(node) &&
-    !isDual(node) &&
-    !isTableExpr(node) &&
-    !isJoin(node) &&
-    typeof node === 'object' &&
-    node !== null &&
-    'table' in node
-  );
+  return isRegularFromItem(node) && !isJoin(node) && 'table' in (node as object);
 }
 
 export function hasArrayIndex(node: ColumnRefItem): node is ColumnRefWithIndex {
@@ -237,6 +225,17 @@ function walkFrom(node: From, visitor: VisitorMap): void {
   visitor.visitBaseFrom?.(node);
 }
 
+/** Normalise select.from (null / single item / array) to a From[]. */
+export function fromClauseItems(select: Select): From[] {
+  if (Array.isArray(select.from)) {
+    return select.from;
+  }
+  if (select.from !== null) {
+    return [select.from];
+  }
+  return [];
+}
+
 // -------------------------------------------------------------------
 // Core walk — dispatches per node type and recurses into children.
 // -------------------------------------------------------------------
@@ -254,15 +253,7 @@ export function walk(node: unknown, visitor: VisitorMap): void {
       visitor.visitWith?.(withItem);
       walk(withItem.stmt.ast, visitor);
     }
-    let fromItems: From[];
-    if (Array.isArray(sel.from)) {
-      fromItems = sel.from;
-    } else if (sel.from !== null) {
-      fromItems = [sel.from];
-    } else {
-      fromItems = [];
-    }
-    for (const fromItem of fromItems) {
+    for (const fromItem of fromClauseItems(sel)) {
       walkFrom(fromItem, visitor);
     }
     for (const col of sel.columns) {
@@ -307,30 +298,6 @@ export function extractColumnRefs(expr: unknown): ColumnRefItem[] {
   return refs;
 }
 
-/** Return the path string from the first json_extract_scalar / json_extract call found. */
-export function extractJsonExtractPath(expr: unknown): string | undefined {
-  let path: string | undefined;
-  walkExpr(expr, {
-    visitFunction(node) {
-      if (path !== undefined) {
-        return;
-      }
-      const fnName = node.name.name[0]?.value;
-      if (fnName === 'json_extract_scalar' || fnName === 'json_extract') {
-        const pathArg = node.args?.value[1];
-        if (pathArg !== undefined) {
-          const val = (pathArg as unknown as { value?: unknown }).value;
-          if (typeof val === 'string') {
-            path = val;
-          }
-        }
-        log('extractJsonExtractPath, function:', fnName, path);
-      }
-    },
-  });
-  return path;
-}
-
 export interface JsonExtractCall {
   ref: ColumnRefItem;
   path: string;
@@ -366,6 +333,11 @@ export function extractJsonExtractCalls(expr: unknown): JsonExtractCall[] {
   return calls;
 }
 
+/** Return the path string from the first json_extract_scalar / json_extract call found. */
+export function extractJsonExtractPath(expr: unknown): string | undefined {
+  return extractJsonExtractCalls(expr)[0]?.path;
+}
+
 /** Return the JSONPath-style string from a bracket accessor (col['key']), or undefined. */
 export function extractBracketAccessorPath(expr: unknown): string | undefined {
   let path: string | undefined;
@@ -397,13 +369,12 @@ export function hasFunctionCalls(expr: unknown): boolean {
   return found;
 }
 
-/** Return true when the expression tree contains any CAST / TRY_CAST to ARRAY<…>. */
-export function containsCastToArray(expr: unknown): boolean {
+function containsCastToType(expr: unknown, dataType: 'ARRAY' | 'MAP'): boolean {
   let found = false;
   walkExpr(expr, {
     visitCast(node) {
       const target = (node as unknown as { target?: { dataType?: string }[] }).target?.[0];
-      if (target?.dataType === 'ARRAY') {
+      if (target?.dataType === dataType) {
         found = true;
       }
     },
@@ -411,16 +382,12 @@ export function containsCastToArray(expr: unknown): boolean {
   return found;
 }
 
+/** Return true when the expression tree contains any CAST / TRY_CAST to ARRAY<…>. */
+export function containsCastToArray(expr: unknown): boolean {
+  return containsCastToType(expr, 'ARRAY');
+}
+
 /** Return true when the expression tree contains any CAST / TRY_CAST to MAP<…>. */
 export function containsCastToMap(expr: unknown): boolean {
-  let found = false;
-  walkExpr(expr, {
-    visitCast(node) {
-      const target = (node as unknown as { target?: { dataType?: string }[] }).target?.[0];
-      if (target?.dataType === 'MAP') {
-        found = true;
-      }
-    },
-  });
-  return found;
+  return containsCastToType(expr, 'MAP');
 }

package/src/openapi/generate-schema.ts

@@ -86,8 +86,9 @@ function getRequestParametersSchema(
     return;
   }
 
-  let parameters = getParameters(operation.parameters, document);
-  parameters = parameters.filter((parameter) => parameter.in === parameterType);
+  const parameters = getParameters(operation.parameters, document).filter(
+    (parameter) => parameter.in === parameterType,
+  );
   if (parameters.length === 0) {
     return;
   }
@@ -95,8 +96,7 @@ function getRequestParametersSchema(
   const parametersSchema = Object.fromEntries(
     parameters.map((parameter) => [
       parameterType === 'header' ? parameter.name.toLowerCase() : parameter.name,
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-      parameter.schema ?? ({ type: 'string' } as v31.SchemaObject),
+      parameter.schema ?? { type: 'string' as const },
     ]),
   );
   const requiredParameterNames = parameters
@@ -113,17 +113,8 @@ function getRequestParametersSchema(
 }
 
 function getBodySchema(contents: Record<string, v31.MediaTypeObject> | undefined): v31.SchemaObject | undefined {
-  if (contents === undefined) {
-    return undefined;
-  }
-
-  const schema = Object.values(contents)[0]?.schema;
-  if (schema !== undefined && Object.keys(schema).length === 0) {
-    // empty schema should be treated as undefined
-    return undefined;
-  }
-
-  return schema;
+  const schema = Object.values(contents ?? {})[0]?.schema;
+  return schema !== undefined && Object.keys(schema).length > 0 ? schema : undefined;
 }
 
 function getRequestBodySchema(operation: v31.OperationObject, document: v31.Document) {
@@ -201,15 +192,10 @@ function getResponseHeadersSchema(
     Object.entries(headers).map(([name, header]) => [name.toLowerCase(), resolve(document, header)]),
   );
   const resolvedHeaderSchemas = Object.fromEntries(
-    Object.entries(resolvedHeaders).map(([name, header]) => [
-      name,
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-      header.schema ?? ({ type: 'string' } as v31.SchemaObject),
-    ]),
+    Object.entries(resolvedHeaders).map(([name, header]) => [name, header.schema ?? { type: 'string' as const }]),
   );
   const requiredHeaderNames = Object.entries(resolvedHeaders)
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    .filter(([_name, header]) => header.required === true)
+    .filter(([, header]) => header.required === true)
     .map(([name]) => name);
   return {
     type: 'object',
@@ -282,12 +268,10 @@ function getOperationId(
 
   // KISS, we could try to to come up with a better naming convension in case of name collision, but it's probably better to leave it to the service to decide a appropriate operationId
   let operationIdIndex = 1;
-  // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-  while (operationIds.has(`${operationId}${operationIdIndex}`)) {
+  while (operationIds.has(`${operationId}${operationIdIndex.toString()}`)) {
     operationIdIndex += 1;
   }
-  // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-  return `${operationId}${operationIdIndex}`;
+  return `${operationId}${operationIdIndex.toString()}`;
 }
 
 function updateOpenapiSchemaDefinitionsReferences(
@@ -315,6 +299,11 @@ function updateOpenapiSchemaDefinitionsReferences(
   return value;
 }
 
+function getFirehoseLoggedExtension(obj: object): unknown {
+  const record = obj as Record<string, unknown>;
+  return record['x-firehose-logged'] ?? record['x-firehoseLogged'];
+}
+
 function buildApiSchemaFromDocument(
   document: v31.Document,
   organization: string,
@@ -333,24 +322,19 @@ function buildApiSchemaFromDocument(
   const apiSchemas: Record<string, Record<string, OperationSchemas>> = {};
   const allSchemas: ApiSchemas = { apis: apiSchemas };
   const operationIds = new Set<string>();
-  const documentFirehoseLogged =
-    (document as Record<string, unknown>)['x-firehose-logged'] ??
-    (document as Record<string, unknown>)['x-firehoseLogged'];
+  const documentFirehoseLogged = getFirehoseLoggedExtension(document);
   log('document firehose logged value', documentFirehoseLogged);
 
   for (const [path, pathItems] of Object.entries(document.paths)) {
     // convert openapi path to koa router path, e.g. "/user/{userId}" --> "/user/:userId"
-    // eslint-disable-next-line prefer-named-capture-group
-    const koaPath = path.replaceAll(/\{([^}]+)\}/gu, ':$1');
+    const koaPath = path.replaceAll(/\{(?<param>[^}]+)\}/gu, ':$<param>');
     const pathSchemas: Record<string, OperationSchemas> = {};
     apiSchemas[`${serverPathname}${koaPath}`] = pathSchemas;
 
     for (const method of ALL_OPERATION_METHODS) {
       const operation = pathItems?.[method];
       if (operation !== undefined) {
-        const operationFirehoseLogged =
-          (operation as Record<string, unknown>)['x-firehose-logged'] ??
-          (operation as Record<string, unknown>)['x-firehoseLogged'];
+        const operationFirehoseLogged = getFirehoseLoggedExtension(operation);
         log('operation firehose logged value', operationFirehoseLogged);
         const effectiveFirehoseLogged = operationFirehoseLogged ?? documentFirehoseLogged;
         if (effectiveFirehoseLogged !== true) {

package/src/openapi/service-schema-generator.ts

@@ -11,6 +11,10 @@ const log = debug('eslint-plugin:athena:service-schema-generator');
 const GITHUB_ORGANIZATIONS = ['checkdigit', 'rebolt-checkdigit'] as const;
 const SWAGGER_SCHEMA_DEREF_FILENAME = 'swagger.schema.deref.json';
 
+function errorMessageFromError(error: unknown): string {
+  return error instanceof Error ? error.message : String(error);
+}
+
 interface ServiceEndpoint {
   path: string;
   yamlContent: string;
@@ -66,8 +70,7 @@ function readServiceConfig(
   if (apiRoot === undefined || apiEndpoints === undefined || apiEndpoints.length === 0) {
     return null;
   }
-  const pkgOrg = packageJson.name?.slice(1).split('/')[0] ?? org;
-  const pkgServiceName = packageJson.name?.slice(1).split('/')[1] ?? serviceName;
+  const [pkgOrg = org, pkgServiceName = serviceName] = packageJson.name?.slice(1).split('/') ?? [];
   return { organization: pkgOrg, serviceName: pkgServiceName, apiRoot, endpoints: apiEndpoints };
 }
 
@@ -116,9 +119,7 @@ function findServiceInNodeModules(serviceName: string): ServiceSource | null {
       }
       log(`[schema-generator] no swagger schema inside node_modules/@${org}/${serviceName}`);
     } catch (error) {
-      log(
-        `[schema-generator] error reading node_modules/@${org}/${serviceName}: ${error instanceof Error ? error.message : String(error)}`,
-      );
+      log(`[schema-generator] error reading node_modules/@${org}/${serviceName}: ${errorMessageFromError(error)}`);
     }
   }
   return null;
@@ -158,9 +159,7 @@ export function generateSchemasForService(
         log(`[schema-generator] cached schema to ${dir}/${SWAGGER_SCHEMA_DEREF_FILENAME}`);
       }
     } catch (error) {
-      log(
-        `[schema-generator] error processing endpoint ${endpoint}: ${error instanceof Error ? error.message : String(error)}`,
-      );
+      log(`[schema-generator] error processing endpoint ${endpoint}: ${errorMessageFromError(error)}`);
     }
   }