feat: add public configuration file

octosync.example.yaml

@@ -0,0 +1,5 @@
+# The direction option available values are: bidirectional, github-to-jira or jira-to-github
+direction:
+  comments: bidirectional
+  issue_creation: bidirectional
+  issue_closing: bidirectional

packages/utils/package.json

@@ -19,5 +19,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8f3c3a731c82e6f65dae2bc3f9eb1e752eac6dc8"
+  "gitHead": "8f3c3a731c82e6f65dae2bc3f9eb1e752eac6dc8",
+  "dependencies": {
+    "js-yaml": "^4.1.0"
+  }
 }

packages/utils/src/hooks/useEnv.ts

@@ -1,3 +1,5 @@
+import { getPublicConfig } from "../publicConf";
+
 export function useEnv() {
   const {
     NODE_ENV = "development",
@@ -20,6 +22,10 @@ export function useEnv() {
     JIRA_CUSTOM_GITHUB_ISSUE_NUMBER_FIELD = "",
   } = process.env;
 
+  console.log({ NODE_ENV });
+
+  const PUBLIC_CONFIG = getPublicConfig(NODE_ENV === "development");
+
   const CUSTOM_GITHUB_REPO_FIELD = `customfield_${JIRA_CUSTOM_GITHUB_REPOSITORY_FIELD}`;
   const CUSTOM_ISSUE_NUMBER_FIELD = `customfield_${JIRA_CUSTOM_GITHUB_ISSUE_NUMBER_FIELD}`;
 
@@ -38,5 +44,6 @@ export function useEnv() {
     JIRA_DONE_STATUS_NAME,
     JIRA_CUSTOM_GITHUB_REPOSITORY_FIELD: CUSTOM_GITHUB_REPO_FIELD,
     JIRA_CUSTOM_GITHUB_ISSUE_NUMBER_FIELD: CUSTOM_ISSUE_NUMBER_FIELD,
+    PUBLIC_CONFIG,
   };
 }

packages/utils/src/publicConf.ts

@@ -0,0 +1,55 @@
+import fs from "fs";
+import yaml from "js-yaml";
+import { homedir } from "node:os";
+
+function getFilePath(devMode: boolean) {
+  let filePath = "";
+
+  if (devMode) {
+    filePath = `../../octosync.example.yaml`;
+  } else {
+    filePath = `${homedir()}/octosync.yaml`;
+  }
+
+  return filePath;
+}
+
+export function getPublicConfig(devMode: boolean): PublicConfig {
+  const filePath = getFilePath(devMode);
+
+  try {
+    const fileContents = fs.readFileSync(filePath, "utf8");
+    const data = yaml.load(fileContents);
+
+    return data as PublicConfig;
+  } catch (error) {
+    console.warn(
+      `Custom octosync.yaml file not found @ ${filePath}. Returning default public configuration.`
+    );
+
+    return {
+      direction: {
+        comments: "bidirectional",
+        issue_closing: "bidirectional",
+        issue_creation: "bidirectional",
+      },
+    };
+  }
+}
+
+export function writePublicConfig() {
+  // TODO
+  // - Run this method right after installation
+  // - Check if file exists in the home directory
+  // - Write to file if it doesn't exist
+}
+
+export type Direction = "bidirectional" | "github-to-jira" | "jira-to-github";
+
+export interface PublicConfig {
+  direction: {
+    comments: Direction;
+    issue_creation: Direction;
+    issue_closing: Direction;
+  };
+}

packages/webhooks/src/github/index.ts

@@ -41,6 +41,16 @@ webhook.post("/github", async (req, res) => {
 
     switch (action) {
       case "opened":
+        const {
+          PUBLIC_CONFIG: {
+            direction: { issue_creation },
+          },
+        } = useEnv();
+
+        if (issue_creation === "jira-to-github") {
+          return;
+        }
+
         await handleOpenedIssue({
           clients: {
             github: {
@@ -57,6 +67,16 @@ webhook.post("/github", async (req, res) => {
         });
         break;
       case "closed":
+        const {
+          PUBLIC_CONFIG: {
+            direction: { issue_closing },
+          },
+        } = useEnv();
+
+        if (issue_closing === "jira-to-github") {
+          return;
+        }
+
         const success = await handleClosedIssue({ title });
 
         if (!success) {
@@ -66,6 +86,16 @@ webhook.post("/github", async (req, res) => {
 
         break;
       case "created":
+        const {
+          PUBLIC_CONFIG: {
+            direction: { comments },
+          },
+        } = useEnv();
+
+        if (comments === "jira-to-github") {
+          return;
+        }
+
         const result = await handleIssueCommentCreation({
           clients: {
             github: {

packages/webhooks/src/jira/index.ts

@@ -31,6 +31,16 @@ webhook.post("/jira", async (req, res) => {
 
     switch (webhookEvent) {
       case "jira:issue_created":
+        const {
+          PUBLIC_CONFIG: {
+            direction: { issue_creation },
+          },
+        } = useEnv();
+
+        if (issue_creation === "github-to-jira") {
+          return;
+        }
+
         // This means that this issue has already been created,
         // and this hook must finish executing immediately.
         if (jiraLabels?.includes(CONTROL_LABELS.FROM_GITHUB)) {
@@ -57,6 +67,16 @@ webhook.post("/jira", async (req, res) => {
           issueNumber: issue.number.toString(),
         });
       case "jira:issue_updated":
+        const {
+          PUBLIC_CONFIG: {
+            direction: { issue_closing },
+          },
+        } = useEnv();
+
+        if (issue_closing === "github-to-jira") {
+          return;
+        }
+
         if (status.name === JIRA_DONE_STATUS_NAME) {
           await github.updateIssue({
             issueNumber:
@@ -67,6 +87,16 @@ webhook.post("/jira", async (req, res) => {
           });
         }
       case "comment_created":
+        const {
+          PUBLIC_CONFIG: {
+            direction: { comments },
+          },
+        } = useEnv();
+
+        if (comments === "github-to-jira") {
+          return;
+        }
+
         const commentBody = comment?.body;
 
         if (!commentBody) {