[antispam] experimenting (WIP)

Author: GuillaumeDua

.github/workflows/scripts/antispam.js

@@ -1,16 +1,39 @@
+const configuration = {
+    label_if_suspicious: false,
+    comment_if_suspicious: false,
+    close_if_suspicious: false,
+};
+
+async function collect_user_information_report({ user }) {
+    // we might also create a (pre-)report for spam to GH using the following informations:
+    return `> [!WARNING] About the author:
+> 
+> | information | value |
+> | ----------- | ----- |
+> | email       | ${user.email}    |
+> | login       | ${user.login}    |
+> | name        | ${user.name}     |
+> | location    | ${user.location} |
+> | blog        | ${user.blog}     |
+> | location    | ${user.location} |
+`
+}
+
 async function when_suspicious({ github, context, failed_checks }){
 
-    // might wanna use a score of confidence (how suspicious it is), then react on that
+    // REFACTO: might wanna use a score of confidence (how suspicious it is), then react on that
 
     const { owner, repo } = context.repo;
     const issueNumber = context.payload.number; // either issue or PR
 
-    // await github.rest.issues.addLabels({
-    //     owner,
-    //     repo,
-    //     issue_number: issueNumber,
-    //     labels: ["suspicious"]
-    // });
+    if (! configuration.label_if_suspicious) {
+        await github.rest.issues.addLabels({
+            owner,
+            repo,
+            issue_number: issueNumber,
+            labels: ["suspicious"]
+        });
+    }
 
     const reasons = failed_checks.map(check => `- ${check.reason}`).join("\n> ");
     const commentBody = `> [!WARNING] This issue/PR has been automatically flagged as [suspicious] as it might not meet contribution requirements.
@@ -22,21 +45,23 @@ ${reasons}
 `;
 
     console.log("Body of the produced comment:\n", commentBody);
-    // await github.rest.issues.createComment({
-    //     owner,
-    //     repo,
-    //     issue_number: issueNumber,
-    //     body: `${commentBody}`
-    // });
-
-    // TODO: if too many or critical checks failed, then consider immediatly closing:
-
-    // await github.rest.issues.update({
-    //     owner,
-    //     repo,
-    //     issue_number: issueNumber,
-    //     state: "closed"
-    // });
+
+    if (configuration.comment_if_suspicious) {
+        await github.rest.issues.createComment({
+            owner,
+            repo,
+            issue_number: issueNumber,
+            body: `${commentBody}`
+        });
+    }
+    if (configuration.close_if_suspicious) {
+        await github.rest.issues.update({
+            owner,
+            repo,
+            issue_number: issueNumber,
+            state: "closed"
+        });
+    }
 }
 
 class Check {
@@ -129,12 +154,6 @@ module.exports = async ({ github, context, core }) => {
 
     when_suspicious({ github, context, failed_checks});
 
-    // we might also create a (pre-)report for spam using the following informations:
-    //  user.email
-    //  user.login
-    //  user.name
-    //  user.location
-    //  user.blog
-    //  user.location
-    //  user.email
+    const user_information_as_comment = collect_user_information_report();
+    // do stuffs with user_information_as_comment
 };