partial refactor, tests, and vscode config

Author: pirafrank

.env.sample

@@ -0,0 +1 @@
+GITHUB_TOKEN="gh123abc"

.gitignore

@@ -1 +1,2 @@
 node_modules
+.env

.vscode/launch.json

@@ -0,0 +1,48 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "--version",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}/github.js",
+      "args": [
+        "--version"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "--help",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}/github.js",
+      "args": [
+        "--help"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "branch exists",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}/github.js",
+      "args": [
+        "branch",
+        "--owner", "pirafrank",
+        "--repo", "test-repo",
+        "--branch", "main"
+      ],
+      "envFile": "${workspaceFolder}/.env"
+    }
+  ]
+}

README.md

@@ -72,6 +72,14 @@ node github.js commit \
   --commitMessage 'stuff'
 ```
 
+## Tests
+
+Create a `.env` file with your `GITHUB_TOKEN`, then run:
+
+```sh
+npm test
+```
+
 ## License
 
 MIT

dummy/file1.txt

@@ -0,0 +1 @@
+test file 1

dummy/file2.txt

@@ -0,0 +1 @@
+test file 2

github.js

@@ -1,153 +1,12 @@
-const fs = require("fs");
-const { createClient, cacheExchange, fetchExchange } = require("@urql/core");
 const yargs = require("yargs");
 const CURRENT_VERSION = require("./package.json").version;
 
-const GITHUB_GRAPHQL_URL =
-  process.env.GITHUB_GRAPHQL_URL || "https://api.github.com/graphql";
-
-const githubToken = process.env.GITHUB_TOKEN;
-if (!githubToken) {
-  throw new Error("ERROR: GITHUB_TOKEN environment variable not set.");
-}
-
-const client = createClient({
-  url: GITHUB_GRAPHQL_URL,
-  exchanges: [cacheExchange, fetchExchange],
-  fetchOptions: {
-    headers: {
-      Authorization: `Bearer ${githubToken}`,
-    },
-  },
-});
-
-function arrayHasElements(array) {
-  return (array && Array.isArray(array) && array.length > 0)
-}
-
-function extractChangedOrDeletedFiles(changedFiles, deletedFiles) {
-  const changedFilesExist = arrayHasElements(changedFiles);
-  const deletedFilesExist = arrayHasElements(deletedFiles);
-
-  if (!changedFilesExist && !deletedFilesExist) {
-    throw new Error("No files specified as changed or deleted. Quitting.");
-  }
-
-  return {
-    changedFiles: changedFilesExist ? changedFiles : [],
-    deletedFiles: deletedFilesExist ? deletedFiles : [],
-  }
-}
-
-async function fetchBranchData(repoOwner, repoName, branchName) {
-  const query = `
-    query($owner: String!, $repo: String!, $branch: String!) {
-      repository(owner: $owner, name: $repo) {
-        ref(qualifiedName: $branch) {
-          name,
-          target {
-            oid
-          }
-        }
-      }
-    }
-  `;
-
-  const variables = {
-    owner: repoOwner,
-    repo: repoName,
-    branch: branchName,
-  };
-
-  try {
-    const response = await client.query(query, variables);
-    return response
-  } catch (error) {
-    console.error(`Error while trying to fetching data from API: ${error.message}`);
-    throw error;
-  }
-}
-
-async function checkIfBranchExists(repoOwner, repoName, branchName) {
-  const response = await fetchBranchData(repoOwner, repoName, branchName);
-  // NB. if response.data.repository.ref is null the remote branch does not exist!
-  return response?.data?.repository?.ref || null;
-}
-
-async function getShaOfParentCommit(repoOwner, repoName, branchName) {
-  const response = await fetchBranchData(repoOwner, repoName, branchName);
-  return response?.data?.repository?.ref?.target?.oid || null;
-}
-
-async function createCommitOnBranch(
-  repoOwner, // Owner of the repository
-  repoName, // Name of the repository
-  branchName, // Name of the branch to commit to
-  changedFiles, // Array of paths of new or modified files
-  deletedFiles, // Array of paths of tracked deleted files
-  commitMessage, // Mandatory commit message
-  commitDescription = null // Optional commit description
-) {
-
-  const parentCommit = await getShaOfParentCommit(repoOwner, repoName, branchName);
-  if (!parentCommit) {
-    throw new Error("Could not get SHA of parent commit. Does the branch exist? Aborting.");
-  }
-
-  const graphqlRequest = {
-    query: `mutation ($input: CreateCommitOnBranchInput!) { createCommitOnBranch(input: $input) { commit { url } } }`,
-    variables: {
-      input: {
-        branch: {
-          repositoryNameWithOwner: repoOwner + "/" + repoName,
-          branchName: branchName,
-        },
-        message: {
-          headline: commitMessage,
-        },
-        fileChanges: {},
-        expectedHeadOid: parentCommit,
-      },
-    },
-  };
-
-  ({ changedFiles, deletedFiles } = extractChangedOrDeletedFiles(changedFiles, deletedFiles));
-  console.log("Changed files:", JSON.stringify(changedFiles, null, 2));
-  console.log("Deleted files:", JSON.stringify(deletedFiles, null, 2));
-
-  if (!commitMessage) { throw new Error("No commit message provided. Aborting."); }
-
-  if (commitDescription) {
-    graphqlRequest.variables.input.message.body = commitDescription;
-  }
-
-  const changedFilesGraphqlArray = changedFiles.map((file_path) => {
-    const contents = fs.readFileSync(file_path, { encoding: "base64" });
-    return { path: file_path, contents: contents };
-  });
-  if (changedFilesGraphqlArray && changedFilesGraphqlArray.length > 0) {
-    graphqlRequest.variables.input.fileChanges.additions = changedFilesGraphqlArray;
-  }
-
-  const deletedFilesGraphqlArray = deletedFiles.map((file_path) => {
-    return { path: file_path };
-  });
-  if (deletedFilesGraphqlArray && deletedFilesGraphqlArray.length > 0) {
-    graphqlRequest.variables.input.fileChanges.deletions = deletedFilesGraphqlArray;
-  }
-
-  try {
-    const response = await client
-      .mutation(graphqlRequest.query, graphqlRequest.variables)
-      .toPromise();
-    return response;
-  } catch (error) {
-    console.error(`Error while performing commit action via GraphQL API: ${error.message}`);
-    throw error;
-  }
-}
-
-module.exports = createCommitOnBranch;
+const {
+  init,
+  extractChangedOrDeletedFiles,
+  createCommitOnBranch,
+  checkIfBranchExists,
+} = require("./index");
 
 yargs
   .command(
@@ -208,6 +67,7 @@ yargs
         commitDescription,
       } = argv;
 
+      init();
       createCommitOnBranch(
         owner,
         repo,
@@ -248,6 +108,7 @@ yargs
     },
     (argv) => {
       const { owner, repo, branch } = argv;
+      init();
       checkIfBranchExists(owner, repo, branch)
         .then((response) => {
           const n = response ? "a" : "no";