add more test cases

Author: Hweinstock

plugins/eslint-plugin-aws-toolkits/lib/rules/no-json-stringify-in-log.ts

@@ -8,7 +8,11 @@ import { Rule } from 'eslint'
 
 export const errMsg = 'Avoid using JSON.stringify within logging and error messages, prefer %O.'
 
-function isJsonStringifyCall(node: any) {
+/**
+ * Check if a given expression is a JSON.stringify call.
+ */
+
+function isJsonStringifyCall(node: any): boolean {
     return (
         node.type === AST_NODE_TYPES.CallExpression &&
         node.callee.type === AST_NODE_TYPES.MemberExpression &&
@@ -19,6 +23,39 @@ function isJsonStringifyCall(node: any) {
     )
 }
 
+/**
+ * Check if node is representing syntax of the form getLogger().f(msg) for some f and msg.
+ *
+ */
+function isLoggerCall(node: any): boolean {
+    return (
+        node.callee.type === AST_NODE_TYPES.MemberExpression &&
+        node.callee.object.type === AST_NODE_TYPES.CallExpression &&
+        node.callee.object.callee.type === AST_NODE_TYPES.Identifier &&
+        node.callee.object.callee.name === 'getLogger'
+    )
+}
+
+/**
+ * Use two simple heuristics to detect `disguised` logger calls. This is when we log without getLogger.
+ * Ex.
+ *      const logger = getLogger()
+ *      logger.debug(m)
+ * To catch these we try two checks:
+ *  1) If the left side is an identifier including the word logger
+ *  2) If the left side is a property of some object, including the word logger.
+ */
+function isDisguisedLoggerCall(node: any): boolean {
+    return (
+        (node.callee.type === AST_NODE_TYPES.MemberExpression &&
+            node.callee.object.type === AST_NODE_TYPES.Identifier &&
+            node.callee.object.name.toLowerCase().includes('logger')) ||
+        (node.callee.type === AST_NODE_TYPES.MemberExpression &&
+            node.callee.object.type === AST_NODE_TYPES.MemberExpression &&
+            node.callee.object.property.name.toLowerCase().includes('logger'))
+    )
+}
+
 export default ESLintUtils.RuleCreator.withoutDocs({
     meta: {
         docs: {
@@ -36,13 +73,8 @@ export default ESLintUtils.RuleCreator.withoutDocs({
     create(context) {
         return {
             CallExpression(node) {
-                // Look for a getLogger().f() call.
-                if (
-                    node.callee.type === AST_NODE_TYPES.MemberExpression &&
-                    node.callee.object.type === AST_NODE_TYPES.CallExpression &&
-                    node.callee.object.callee.type === AST_NODE_TYPES.Identifier &&
-                    node.callee.object.callee.name === 'getLogger'
-                ) {
+                // Look for a getLogger().f() call or a disguised one, see isDisguisedLoggerCall for more info.
+                if (isLoggerCall(node) || isDisguisedLoggerCall(node)) {
                     // For each argument to the call above, check if it contains a JSON.stringify
                     node.arguments.forEach((arg) => {
                         // Check if arg itself if a JSON.stringify call

plugins/eslint-plugin-aws-toolkits/test/rules/no-json-stringify-in-log.test.ts

@@ -14,6 +14,8 @@ getRuleTester().run('no-json-stringify-in-log', rules['no-json-stringify-in-log'
         'getLogger().debug(`this does not include anything`)',
         'getLogger().debug(`another example ${JSON.notString(something)}`)',
         'getLogger().fakeFunction(`another example ${JSON.notString(something)}`)',
+        'this.deps.devLogger?.debug("crashMonitoring: CLEAR_STATE: Succeeded")',
+        'getLogger().debug(`called startBuilderIdSetup()`)',
     ],
 
     invalid: [
@@ -37,5 +39,17 @@ getRuleTester().run('no-json-stringify-in-log', rules['no-json-stringify-in-log'
             code: 'getLogger().verbose(`provideDebugConfigurations: debugconfigs: ${JSON.stringify(configs)}`)',
             errors: [errMsg],
         },
+        {
+            code: 'devLogger?.debug(`crashMonitoring: CHECKED: Result of cleaning up crashed instances\nBEFORE: ${JSON.stringify(before)}\nAFTER:  ${JSON.stringify(after)}\nACTUAL: ${JSON.stringify(afterActual)}`)',
+            errors: [errMsg, errMsg, errMsg],
+        },
+        {
+            code: 'getLogger().warn(`skipping invalid item in telemetry cache: ${JSON.stringify(item)}\n`)',
+            errors: [errMsg],
+        },
+        {
+            code: 'this.deps.devLogger?.debug(`crashMonitoring: CLEAR_STATE: Succeeded ${JSON.stringify(item)}`)',
+            errors: [errMsg],
+        },
     ],
 })