Improve heuristic for detecting "false" LGTM strings

Author: hyperupcall

index.js

@@ -17,7 +17,7 @@ async function run() {
   // Merge if they say they have access
   if (context.eventName === "issue_comment" || context.eventName === "pull_request_review") {
     const bodyLower = getPayloadBody().toLowerCase();
-    if (bodyLower.includes("lgtm") && !bodyLower.includes("lgtm but")) {
+    if (hasValidLgtmSubstring(bodyLower)) {
       new Actor().mergeIfHasAccess();
     } else if (bodyLower.includes("@github-actions close")) {
       new Actor().closePROrIssueIfInCodeowners();
@@ -273,6 +273,27 @@ function getFilesNotOwnedByCodeOwner(owner, files, cwd) {
   return contents.includes("@" + login.toLowerCase() + " ") || contents.includes("@" + login.toLowerCase() + "\n")
 }
 
+/**
+ *
+ * @param {string} bodyLower
+ */
+function hasValidLgtmSubstring(bodyLower) {
+  if (bodyLower.includes("lgtm")) {
+    if (bodyLower.includes("lgtm but")) return false
+    if (bodyLower.includes("lgtm, but")) return false
+
+    const charBefore = bodyLower.charAt(bodyLower.indexOf("lgtm") - 1)
+    const charAfter = bodyLower.charAt(bodyLower.indexOf("lgtm") + "lgtm".length)
+    if (charBefore === "\"" || charAfter === "\"") return false
+    if (charBefore === "'" || charAfter === "'") return false
+    if (charBefore === "`" || charAfter === "`") return false
+
+    return true
+  }
+
+  return false
+}
+
 
 /**
  *
@@ -349,7 +370,8 @@ async function createOrAddLabel(octokit, repoDeets, labelConfig) {
 module.exports = {
   getFilesNotOwnedByCodeOwner,
   findCodeOwnersForChangedFiles,
-  githubLoginIsInCodeowners
+  githubLoginIsInCodeowners,
+  hasValidLgtmSubstring
 }
 
 // @ts-ignore

index.test.js

@@ -1,4 +1,4 @@
-const { getFilesNotOwnedByCodeOwner, findCodeOwnersForChangedFiles, githubLoginIsInCodeowners } = require(".");
+const { getFilesNotOwnedByCodeOwner, findCodeOwnersForChangedFiles, githubLoginIsInCodeowners, hasValidLgtmSubstring } = require(".");
 
 test("determine who owns a set of files", () => {
   const noFiles = findCodeOwnersForChangedFiles(["root-codeowners/one.two.js"], "./test-code-owners-repo");
@@ -53,3 +53,30 @@ describe(githubLoginIsInCodeowners, () => {
     expect(noOrt).toEqual(false);
   });
 })  
+
+describe(hasValidLgtmSubstring, () => {
+  test("allows lgtm", () => {
+    const isValidSubstring = hasValidLgtmSubstring("this lgtm!");
+    expect(isValidSubstring).toEqual(true);
+  });
+  test("denies lgtm but", () => {
+    const isValidSubstring = hasValidLgtmSubstring("this lgtm but");
+    expect(isValidSubstring).toEqual(false);
+  });
+  test("denies lgtm but", () => {
+    const isValidSubstring = hasValidLgtmSubstring("this lgtm, but");
+    expect(isValidSubstring).toEqual(false);
+  });
+  test("denies lgtm in double quotes", () => {
+    const isValidSubstring = hasValidLgtmSubstring("\"lgtm\"");
+    expect(isValidSubstring).toEqual(false);
+  });
+  test("denies lgtm in single quotes", () => {
+    const isValidSubstring = hasValidLgtmSubstring("'lgtm");
+    expect(isValidSubstring).toEqual(false);
+  });
+  test("denies lgtm in inline code blocks", () => {
+    const isValidSubstring = hasValidLgtmSubstring("lgtm`");
+    expect(isValidSubstring).toEqual(false);
+  });
+})