decap-cms-backend-github 3.8.3 → 3.9.0-beta.1

package/dist/esm/API.js

@@ -642,22 +642,36 @@ export default class API {
       const branchesWithFilter = await Promise.all(branches.map(b => this.filterOpenAuthoringBranches(b)));
       branches = branchesWithFilter.filter(b => b.filter).map(b => b.branch);
     } else {
-      // backwards compatibility code, get relevant pull requests and migrate them
-      const pullRequests = await this.getPullRequests(undefined, PullRequestState.Open, pr => !pr.head.repo.fork && withoutCmsLabel(pr, this.cmsLabelPrefix));
+      // One fetch, two filters. `getPullRequests` re-requests the list for
+      // each predicate, and both calls here pass the same `head`/`state`, so
+      // the two below issued a byte-identical
+      // `GET /pulls?base=…&state=open&per_page=100` on every collection load —
+      // 2.0s + 1.8s of it when the request goes through a proxy. The predicate
+      // is applied client-side anyway, so the page only needs fetching once.
+      const openPullRequests = await this.getPullRequests(undefined, PullRequestState.Open, () => true);
+
+      // Backwards compatibility: entries created before the CMS labelled its
+      // pull requests. Effectively always empty on a repo that has only ever
+      // been edited by a current CMS.
+      const unlabeled = openPullRequests.filter(pr => !pr.head.repo.fork && withoutCmsLabel(pr, this.cmsLabelPrefix));
       let prCount = 0;
-      for (const pr of pullRequests) {
+      for (const pr of unlabeled) {
         if (!migrationNotified) {
           migrationNotified = true;
           alert(oneLine`
-            Decap CMS is adding labels to ${pullRequests.length} of your Editorial Workflow
+            Decap CMS is adding labels to ${unlabeled.length} of your Editorial Workflow
             entries. The "Workflow" tab will be unavailable during this migration. You may use other
             areas of the CMS during this time. Note that closing the CMS will pause the migration.
           `);
         }
         prCount = prCount + 1;
-        await this.migratePullRequest(pr, `${prCount} of ${pullRequests.length}`);
+        await this.migratePullRequest(pr, `${prCount} of ${unlabeled.length}`);
       }
-      const cmsPullRequests = await this.getPullRequests(undefined, PullRequestState.Open, pr => withCmsLabel(pr, this.cmsLabelPrefix));
+
+      // Migration is what puts the label on, so when it ran the list has to be
+      // read again — the page fetched above predates those labels. Conditional
+      // rather than unconditional precisely because that path is the rare one.
+      const cmsPullRequests = unlabeled.length ? await this.getPullRequests(undefined, PullRequestState.Open, pr => withCmsLabel(pr, this.cmsLabelPrefix)) : openPullRequests.filter(pr => withCmsLabel(pr, this.cmsLabelPrefix));
       branches = cmsPullRequests.map(pr => pr.head.ref);
     }
     return branches;
@@ -1218,7 +1232,7 @@ export default class API {
   }
 
   /**
-   * Constants for note formatting to aid with PR comment to note conversion
+   * How a notes issue is recognised on the host.
    */
   static NOTES_LABEL = 'decap-cms-notes';
   static NOTE_ISSUE_PREFIX = 'Notes: ';

package/dist/esm/implementation.js

@@ -262,7 +262,7 @@ export default class GitHub {
       useOpenAuthoring: this.useOpenAuthoring,
       initialWorkflowStatus: this.options.initialWorkflowStatus,
       baseUrl: this.baseUrl,
-      getUser: args => this.currentUser(args)
+      getUser: this.currentUser.bind(this)
     });
     const user = await this.api.user();
     const isCollab = await this.api.hasWriteAccess().catch(error => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "decap-cms-backend-github",
   "description": "GitHub backend for Decap CMS",
-  "version": "3.8.3",
+  "version": "3.9.0-beta.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -34,9 +34,9 @@
     "lodash": "^4.17.11",
     "prop-types": "^15.7.2",
     "react": "^19.1.0",
-    "decap-cms-lib-auth": "3.3.2",
-    "decap-cms-lib-util": "3.8.3",
-    "decap-cms-ui-default": "3.9.2"
+    "decap-cms-lib-auth": "3.3.3-beta.0",
+    "decap-cms-lib-util": "3.9.0-beta.1",
+    "decap-cms-ui-default": "3.9.3-beta.0"
   },
   "browser": {
     "path": "path-browserify"

package/src/API.ts

@@ -899,28 +899,46 @@ export default class API {
       );
       branches = branchesWithFilter.filter(b => b.filter).map(b => b.branch);
     } else {
-      // backwards compatibility code, get relevant pull requests and migrate them
-      const pullRequests = await this.getPullRequests(
+      // One fetch, two filters. `getPullRequests` re-requests the list for
+      // each predicate, and both calls here pass the same `head`/`state`, so
+      // the two below issued a byte-identical
+      // `GET /pulls?base=…&state=open&per_page=100` on every collection load —
+      // 2.0s + 1.8s of it when the request goes through a proxy. The predicate
+      // is applied client-side anyway, so the page only needs fetching once.
+      const openPullRequests = await this.getPullRequests(
         undefined,
         PullRequestState.Open,
+        () => true,
+      );
+
+      // Backwards compatibility: entries created before the CMS labelled its
+      // pull requests. Effectively always empty on a repo that has only ever
+      // been edited by a current CMS.
+      const unlabeled = openPullRequests.filter(
         pr => !pr.head.repo.fork && withoutCmsLabel(pr, this.cmsLabelPrefix),
       );
       let prCount = 0;
-      for (const pr of pullRequests) {
+      for (const pr of unlabeled) {
         if (!migrationNotified) {
           migrationNotified = true;
           alert(oneLine`
-            Decap CMS is adding labels to ${pullRequests.length} of your Editorial Workflow
+            Decap CMS is adding labels to ${unlabeled.length} of your Editorial Workflow
             entries. The "Workflow" tab will be unavailable during this migration. You may use other
             areas of the CMS during this time. Note that closing the CMS will pause the migration.
           `);
         }
         prCount = prCount + 1;
-        await this.migratePullRequest(pr, `${prCount} of ${pullRequests.length}`);
+        await this.migratePullRequest(pr, `${prCount} of ${unlabeled.length}`);
       }
-      const cmsPullRequests = await this.getPullRequests(undefined, PullRequestState.Open, pr =>
-        withCmsLabel(pr, this.cmsLabelPrefix),
-      );
+
+      // Migration is what puts the label on, so when it ran the list has to be
+      // read again — the page fetched above predates those labels. Conditional
+      // rather than unconditional precisely because that path is the rare one.
+      const cmsPullRequests = unlabeled.length
+        ? await this.getPullRequests(undefined, PullRequestState.Open, pr =>
+            withCmsLabel(pr, this.cmsLabelPrefix),
+          )
+        : openPullRequests.filter(pr => withCmsLabel(pr, this.cmsLabelPrefix));
       branches = cmsPullRequests.map(pr => pr.head.ref);
     }
 
@@ -1556,10 +1574,10 @@ export default class API {
   }
 
   /**
-   * Constants for note formatting to aid with PR comment to note conversion
+   * How a notes issue is recognised on the host.
    */
-  private static readonly NOTES_LABEL = 'decap-cms-notes';
-  private static readonly NOTE_ISSUE_PREFIX = 'Notes: ';
+  static readonly NOTES_LABEL = 'decap-cms-notes';
+  static readonly NOTE_ISSUE_PREFIX = 'Notes: ';
 
   /**
    * Parse a GitHub comment into a Note object

package/src/__tests__/API.spec.js

@@ -724,6 +724,42 @@ describe('github API', () => {
     });
   });
 
+  describe('listUnpublishedBranches', () => {
+    function pullRequest(ref, labels) {
+      return { head: { ref, repo: { fork: false } }, labels: labels.map(name => ({ name })) };
+    }
+
+    it('reads the open pull request list once when nothing needs migrating', async () => {
+      const api = new API({ branch: 'main', repo: 'owner/repo' });
+      api.requestAllPages = jest
+        .fn()
+        .mockResolvedValue([pullRequest('cms/posts/a-post', ['decap-cms/pending_review'])]);
+
+      await expect(api.listUnpublishedBranches()).resolves.toEqual(['cms/posts/a-post']);
+
+      // The labelled and unlabelled sets are two filters over the same
+      // `GET /pulls?base=…&state=open` page, so asking for both must not cost
+      // two identical round trips.
+      expect(api.requestAllPages).toHaveBeenCalledTimes(1);
+    });
+
+    it('re-reads the list after a migration, because migrating is what adds the label', async () => {
+      const api = new API({ branch: 'main', repo: 'owner/repo' });
+      const unlabeled = pullRequest('cms/posts/legacy', []);
+      api.requestAllPages = jest
+        .fn()
+        .mockResolvedValueOnce([unlabeled])
+        .mockResolvedValueOnce([pullRequest('cms/posts/legacy', ['decap-cms/draft'])]);
+      api.migratePullRequest = jest.fn().mockResolvedValue(undefined);
+      global.alert = jest.fn();
+
+      await expect(api.listUnpublishedBranches()).resolves.toEqual(['cms/posts/legacy']);
+
+      expect(api.migratePullRequest).toHaveBeenCalledTimes(1);
+      expect(api.requestAllPages).toHaveBeenCalledTimes(2);
+    });
+  });
+
   describe('listFiles', () => {
     it('should get files by depth', async () => {
       const api = new API({ branch: 'master', repo: 'owner/repo' });

package/src/implementation.tsx

@@ -358,7 +358,7 @@ export default class GitHub implements Implementation {
       useOpenAuthoring: this.useOpenAuthoring,
       initialWorkflowStatus: this.options.initialWorkflowStatus,
       baseUrl: this.baseUrl,
-      getUser: args => this.currentUser(args),
+      getUser: this.currentUser.bind(this),
     });
     const user = await this.api!.user();
     const isCollab = await this.api!.hasWriteAccess().catch(error => {