New changes format in request body

mheap · mheap · commit 4ca361e10928 · 2020-02-06T07:04:27.000Z
This allows us to provide files as an object and paves the way for
supporting multiple commits in a single push
diff --git a/create-or-update-files.js b/create-or-update-files.js
@@ -2,7 +2,7 @@ module.exports = function(octokit, opts) {
   return new Promise(async (resolve, reject) => {
     // Up front validation
     try {
-      for (let req of ["owner", "repo", "branch", "message"]) {
+      for (let req of ["owner", "repo", "branch"]) {
         if (!opts[req]) {
           return reject(`'${req}' is a required parameter`);
         }
@@ -19,8 +19,7 @@ module.exports = function(octokit, opts) {
         base,
         branch: branchName,
         createBranch,
-        changes,
-        message
+        changes
       } = opts;
 
       let branchAlreadyExists = true;
@@ -59,58 +58,65 @@ module.exports = function(octokit, opts) {
       // Create blobs
       const treeItems = [];
       for (let change of changes) {
-        if (!change.contents) {
-          return reject(
-            `No file contents provided for ${change.path || "Un-named file"}`
-          );
+        let message = change.message;
+        if (!message) {
+          return reject(`changes[].message is a required parameter`);
+        }
+        if (!change.files || Object.keys(change.files).length === 0) {
+          return reject(`changes[].files is a required parameter`);
         }
 
-        if (!change.path) {
-          return reject(
-            `No file path provided for the following contents: ${change.contents.substr(
-              0,
-              30
-            )}...`
-          );
+        for (let fileName in change.files) {
+          let properties = change.files[fileName] || "";
+
+          let contents = properties.contents || properties;
+          let mode = properties.mode || "100644";
+
+          if (!contents) {
+            return reject(`No file contents provided for ${fileName}`);
+          }
+
+          let file = (
+            await octokit.git.createBlob({
+              owner,
+              repo,
+              content: Buffer.from(contents).toString("base64"),
+              encoding: "base64"
+            })
+          ).data;
+
+          treeItems.push({
+            path: fileName,
+            sha: file.sha,
+            mode: mode,
+            type: "blob"
+          });
         }
 
-        let file = (
-          await octokit.git.createBlob({
+        // Add those blobs to a tree
+        let tree = (
+          await octokit.git.createTree({
             owner,
             repo,
-            content: Buffer.from(change.contents).toString("base64"),
-            encoding: "base64"
+            tree: treeItems,
+            base_tree: baseTree
           })
         ).data;
 
-        treeItems.push({
-          path: change.path,
-          sha: file.sha,
-          mode: "100644",
-          type: "blob"
-        });
-      }
-
-      // Add those blobs to a tree
-      let tree = (
-        await octokit.git.createTree({
-          owner,
-          repo,
-          tree: treeItems,
-          base_tree: baseTree
-        })
-      ).data;
+        // Create a commit that points to that tree
+        let commit = (
+          await octokit.git.createCommit({
+            owner,
+            repo,
+            message,
+            tree: tree.sha,
+            parents: [baseTree]
+          })
+        ).data;
 
-      // Create a commit that points to that tree
-      let commit = (
-        await octokit.git.createCommit({
-          owner,
-          repo,
-          message,
-          tree: tree.sha,
-          parents: [baseTree]
-        })
-      ).data;
+        // Update the base tree if we have another commit to make
+        baseTree = commit.sha;
+      }
 
       // Create a ref that points to that tree
       let action = "createRef";
@@ -128,7 +134,7 @@ module.exports = function(octokit, opts) {
           repo,
           force: true,
           ref: `${updateRefBase}heads/${branchName}`,
-          sha: commit.sha
+          sha: baseTree
         })
       ).data;
 
diff --git a/create-or-update-files.test.js b/create-or-update-files.test.js
@@ -15,33 +15,25 @@ const validRequest = {
   branch: "new-branch-name",
   createBranch: true,
   base: "base-branch-name",
-  message: "Your commit message",
   changes: [
     {
-      path: "test.md",
-      contents: `# This is a test
-
-I hope it works`
-    },
-    {
-      path: "test2.md",
-      contents: `Something else`
+      message: "Your commit message",
+      files: {
+        "test.md": `# This is a test
+
+I hope it works`,
+        "test2.md": {
+          contents: `Something else`
+        }
+      }
     }
   ]
 };
 
 // Destructuring for easier access later
-let {
-  owner,
-  repo,
-  base,
-  branch,
-  createBranch,
-  changes,
-  message
-} = validRequest;
-
-for (let req of ["owner", "repo", "branch", "message"]) {
+let { owner, repo, base, branch, createBranch, changes } = validRequest;
+
+for (let req of ["owner", "repo", "branch"]) {
   const body = { ...validRequest };
   delete body[req];
   test(`missing parameter (${req})`, () => {
@@ -79,35 +71,73 @@ test(`branch does not exist, provided base does not exist`, async () => {
   );
 });
 
-test(`no file contents provided (no title)`, async () => {
+test(`no commit message`, async () => {
+  const repoDefaultBranch = "master";
+  mockGetRef(branch, `sha-${branch}`, true);
+  mockGetRef(base, `sha-${base}`, true);
+  mockGetRef(repoDefaultBranch, `sha-${repoDefaultBranch}`, true);
+
+  const body = {
+    ...validRequest,
+    changes: [
+      {
+        files: {
+          "test.md": null
+        }
+      }
+    ]
+  };
+  await expect(run(body)).rejects.toEqual(
+    `changes[].message is a required parameter`
+  );
+});
+
+test(`no files provided (empty object)`, async () => {
+  const repoDefaultBranch = "master";
   mockGetRef(branch, `sha-${branch}`, true);
   mockGetRef(base, `sha-${base}`, true);
-  const body = { ...validRequest, changes: [{}] };
+  mockGetRef(repoDefaultBranch, `sha-${repoDefaultBranch}`, true);
+
+  const body = {
+    ...validRequest,
+    changes: [{ message: "Test Commit", files: {} }]
+  };
   await expect(run(body)).rejects.toEqual(
-    `No file contents provided for Un-named file`
+    `changes[].files is a required parameter`
   );
 });
 
-test(`no file contents provided (with title)`, async () => {
+test(`no files provided (missing object)`, async () => {
+  const repoDefaultBranch = "master";
   mockGetRef(branch, `sha-${branch}`, true);
   mockGetRef(base, `sha-${base}`, true);
-  const body = { ...validRequest, changes: [{ path: "test.md" }] };
+  mockGetRef(repoDefaultBranch, `sha-${repoDefaultBranch}`, true);
+
+  const body = { ...validRequest, changes: [{ message: "Test Commit" }] };
   await expect(run(body)).rejects.toEqual(
-    `No file contents provided for test.md`
+    `changes[].files is a required parameter`
   );
 });
 
-test(`no file path provided`, async () => {
+test(`no file contents provided`, async () => {
+  const repoDefaultBranch = "master";
   mockGetRef(branch, `sha-${branch}`, true);
   mockGetRef(base, `sha-${base}`, true);
+  mockGetRef(repoDefaultBranch, `sha-${repoDefaultBranch}`, true);
+
   const body = {
     ...validRequest,
     changes: [
-      { contents: "I wonder how long this text can be before it gets cut off" }
+      {
+        message: "This is a test",
+        files: {
+          "test.md": null
+        }
+      }
     ]
   };
   await expect(run(body)).rejects.toEqual(
-    `No file path provided for the following contents: I wonder how long this text ca...`
+    `No file contents provided for test.md`
   );
 });
 
diff --git a/package.json b/package.json
@@ -1,10 +1,12 @@
 {
   "name": "octokit-commit-multiple-files",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Octokit plugin to create/update multiple files at once",
   "main": "index.js",
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "lint": "eslint *.js",
+    "lint-fix": "eslint --fix *.js"
   },
   "keywords": [
     "github",
