@saleor/eslint-plugin-saleor-app/rules/logger.cjs

ESLint plugin for Saleor Apps

"use strict";
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
  for (var name in all)
    __defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
  if (from && typeof from === "object" || typeof from === "function") {
    for (let key of __getOwnPropNames(from))
      if (!__hasOwnProp.call(to, key) && key !== except)
        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  }
  return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  // If the importer is in node compatibility mode or this is not an ESM
  // file that has been converted to a CommonJS file using a Babel-
  // compatible transform (i.e. "__esModule" has not been set), then set
  // "default" to the CommonJS "module.exports" for node compatibility.
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);

// src/rules/logger.ts
var logger_exports = {};
__export(logger_exports, {
  loggerRules: () => loggerRules
});
module.exports = __toCommonJS(logger_exports);
var import_utils = require("@typescript-eslint/utils");
var tsutils = __toESM(require("tsutils"), 1);
var import_typescript = __toESM(require("typescript"), 1);
var loggerRules = import_utils.ESLintUtils.RuleCreator.withoutDocs({
  create(context, options) {
    const propertiesToCheck = new Set(options[0]);
    return {
      CallExpression(node) {
        if (node.callee.type === "MemberExpression" && node.callee.object.type === "Identifier" && propertiesToCheck.has(node.callee.object.name)) {
          const loggerData = node.arguments.find(
            (arg) => arg.type === "ObjectExpression"
          );
          if (loggerData) {
            const objectProperties = loggerData.properties;
            const parserServices = import_utils.ESLintUtils.getParserServices(context);
            const checker = parserServices.program.getTypeChecker();
            objectProperties.forEach((property) => {
              const tsNode = parserServices.esTreeNodeToTSNodeMap.get(property);
              const tsNodeType = checker.getTypeAtLocation(tsNode);
              if (property.type === "Property" && property.shorthand && property.value.type === "Identifier") {
                if (tsutils.isObjectType(tsNodeType) || tsutils.isGenericType(tsNodeType) || tsutils.isInterfaceType(tsNodeType) || tsutils.isSpreadElement(tsNode) || tsutils.isClassExpression(tsNode) || tsutils.isClassDeclaration(tsNode) || tsutils.isEmptyObjectType(tsNodeType)) {
                  context.report({
                    node: property,
                    messageId: "noShorthand"
                  });
                }
                if (tsutils.isArrayTypeNode(tsNode)) {
                  context.report({
                    node: property,
                    messageId: "noArray"
                  });
                }
                if (tsutils.isTypeFlagSet(tsNodeType, import_typescript.default.TypeFlags.Any) || tsutils.isTypeFlagSet(tsNodeType, import_typescript.default.TypeFlags.Unknown) || tsutils.isGenericType(tsNodeType)) {
                  context.report({
                    node: property,
                    messageId: "noUnknowns"
                  });
                }
              }
            });
          }
        }
      }
    };
  },
  meta: {
    type: "problem",
    docs: {
      description: "Invalid logs usage - object shorthand property"
    },
    messages: {
      noShorthand: "Potential PII leak: object shorthand property used with object value inside logger arguments. Pass only specific fields from the object to the logger.",
      noArray: "Potential PII leak: object shorthand property used with array value inside logger arguments. Please use `redactLogArray` method.",
      noUnknowns: "Potential PII leak: object shorthand property used with unknown value inside logger arguments. Please use only known values."
    },
    schema: [
      {
        type: "array",
        items: {
          type: "string",
          title: "Override logger names to check",
          default: ["logger"]
        }
      }
    ]
  },
  defaultOptions: [["logger"]]
});
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
  loggerRules
});