github-repository-provider 7.24.8 → 7.25.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-repository-provider",
-  "version": "7.24.8",
+  "version": "7.25.1",
   "publishConfig": {
     "access": "public"
   },
@@ -32,17 +32,17 @@
   "dependencies": {
     "content-entry": "^3.0.2",
     "fetch-link-util": "^1.0.4",
-    "fetch-rate-limit-util": "^1.1.6",
+    "fetch-rate-limit-util": "^2.0.2",
     "matching-iterator": "^2.0.0",
     "node-fetch": "3.1.0",
     "one-time-execution-method": "^2.0.9",
-    "repository-provider": "^26.0.3"
+    "repository-provider": "^26.1.1"
   },
   "devDependencies": {
     "ava": "^3.15.0",
     "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.9.0",
+    "repository-provider-test-support": "^1.9.1",
     "semantic-release": "^18.0.1"
   },
   "engines": {

package/src/github-branch.mjs

@@ -18,13 +18,16 @@ export class GithubBranch extends Branch {
    * @return {Promise<ConentEntry>} written content with sha values set
    */
   async writeEntry(entry) {
-    const json = await this.provider.fetchJSON(`repos/${this.slug}/git/blobs`, {
-      method: "POST",
-      body: JSON.stringify({
-        content: await entry.string,
-        encoding: "utf8"
-      })
-    });
+    const { json } = await this.provider.fetchJSON(
+      `repos/${this.slug}/git/blobs`,
+      {
+        method: "POST",
+        body: JSON.stringify({
+          content: await entry.string,
+          encoding: "utf8"
+        })
+      }
+    );
 
     entry.sha = json.sha;
 
@@ -36,7 +39,7 @@ export class GithubBranch extends Branch {
    * @param {string} sha
    */
   async baseTreeSha(sha) {
-    const json = await this.provider.fetchJSON(
+    const { json } = await this.provider.fetchJSON(
       `repos/${this.slug}/git/commits/${sha}`
     );
     return json.tree.sha;
@@ -66,24 +69,27 @@ export class GithubBranch extends Branch {
     const shaLatestCommit = await this.refId();
     const shaBaseTree = await this.baseTreeSha(shaLatestCommit);
 
-    let json = await this.provider.fetchJSON(`repos/${this.slug}/git/trees`, {
-      method: "POST",
-      body: JSON.stringify({
-        base_tree: shaBaseTree,
-        tree: updates.map(u => {
-          return {
-            path: u.name,
-            sha: u.sha,
-            type: "blob",
-            mode: "100" + u.mode.toString(8)
-          };
+    let { json } = await this.provider.fetchJSON(
+      `repos/${this.slug}/git/trees`,
+      {
+        method: "POST",
+        body: JSON.stringify({
+          base_tree: shaBaseTree,
+          tree: updates.map(u => {
+            return {
+              path: u.name,
+              sha: u.sha,
+              type: "blob",
+              mode: "100" + u.mode.toString(8)
+            };
+          })
         })
-      })
-    });
+      }
+    );
 
     const shaNewTree = json.sha;
 
-    json = await this.provider.fetchJSON(`repos/${this.slug}/git/commits`, {
+    const r = await this.provider.fetchJSON(`repos/${this.slug}/git/commits`, {
       method: "POST",
       body: JSON.stringify({
         message,
@@ -92,7 +98,7 @@ export class GithubBranch extends Branch {
       })
     });
 
-    const sha = json.sha;
+    const sha = r.json.sha;
 
     return await this.provider.fetchJSON(
       `repos/${this.slug}/git/refs/heads/${this.name}`,
@@ -111,7 +117,7 @@ export class GithubBranch extends Branch {
    * @param {string} name
    */
   async entry(name) {
-    const json = await this.provider.fetchJSON(
+    const { json } = await this.provider.fetchJSON(
       `repos/${this.slug}/contents/${name}?ref=${this.ref}`
     );
 
@@ -135,7 +141,7 @@ export class GithubBranch extends Branch {
    * @return {Object[]}
    */
   async tree(treeSha) {
-    const json = await this.provider.fetchJSON(
+    const { json } = await this.provider.fetchJSON(
       `repos/${this.slug}/git/trees/${treeSha}?recursive=1`
     );
     return json.tree;
@@ -187,7 +193,7 @@ class LazyBufferContentEntry extends BufferContentEntryMixin(ContentEntry) {
     }
 
     const branch = this.branch;
-    const json = await branch.provider.fetchJSON(
+    const { json } = await branch.provider.fetchJSON(
       `repos/${branch.slug}/contents/${this.name}?ref=${branch.ref}`
     );
 

package/src/github-owner.mjs

@@ -39,12 +39,12 @@ export class GithubOwner extends RepositoryGroup {
     );
 
     if (response.ok) {
-      this.provider.info(`Repository ${name} created`);
+      this.info(`Repository ${name} created`);
       options.defaultBranchName = "main";
       return this.addRepository(name, options);
     }
 
-    this.provider.error(`Repository ${name} creation error ${response.status}`);
+    this.error(`Repository ${name} creation error ${response.status}`);
   }
 
   /**

package/src/github-provider.mjs

@@ -9,7 +9,7 @@ import { GithubOwner } from "./github-owner.mjs";
 import { GithubPullRequest } from "./github-pull-request.mjs";
 export { GithubRepository, GithubBranch, GithubOwner, GithubPullRequest };
 
-const domain = "github.com";
+const host = "github.com";
 
 /**
  * <!-- skip-example -->
@@ -42,31 +42,40 @@ export class GithubProvider extends MultiGroupProvider {
    * @return {string} default instance environment name prefix
    */
   static get instanceIdentifier() {
-    return "GITHUB_";
+    return "GITHUB_"; // "GH_" "GH_ENTERPRISE_"
   }
 
   static get attributes() {
     return {
       ...super.attributes,
+      host: {
+        type: "string",
+        env: ["{{instanceIdentifier}}HOST", "GH_HOST"],
+        default: "github.com"
+      },
       ssh: {
         type: "url",
-        default: `git@${domain}:`
+        default: `git@${host}:`
       },
       url: {
         type: "url",
         env: ["{{instanceIdentifier}}SERVER_URL"],
         set: value => (value.endsWith("/") ? value : value + "/"),
-        default: `https://${domain}/`
+        default: `https://${host}/`
       },
       api: {
         type: "url",
         env: ["{{instanceIdentifier}}API_URL"],
         set: value => value.replace(/\/$/, ""),
-        default: `https://api.${domain}`
+        default: `https://api.${host}`
       },
       "authentication.token": {
         type: "string",
-        env: ["{{instanceIdentifier}}TOKEN", "GH_TOKEN"],
+        // @see https://cli.github.com/manual/gh_help_environment
+        env: [
+          "{{instanceIdentifier}}TOKEN",
+          "GH_TOKEN" // declare GH_ as identifier
+        ],
         additionalAttributes: { "authentication.type": "token" },
         private: true,
         mandatory: true
@@ -90,14 +99,15 @@ export class GithubProvider extends MultiGroupProvider {
 
   fetch(url, options = {}) {
     return rateLimitHandler(
-      () =>
-        fetch(new URL(url, this.api), {
-          ...options,
-          headers: {
-            authorization: `token ${this.authentication.token}`,
-            ...options.headers
-          }
-        }),
+      fetch,
+      new URL(url, this.api),
+      {
+        ...options,
+        headers: {
+          authorization: `token ${this.authentication.token}`,
+          ...options.headers
+        }
+      },
       (millisecondsToWait, rateLimitRemaining, nthTry, response) => {
         this.rateLimitRemaining = rateLimitRemaining;
 
@@ -117,18 +127,24 @@ export class GithubProvider extends MultiGroupProvider {
   }
 
   async fetchJSON(url, options) {
-    let i = 1;
-    while (true) {
+    for (let i = 1; ; i++) {
       try {
         const response = await this.fetch(url, options);
-        if (!response.ok) {
+        if (response.ok) {
+          return { response, json: await response.json() };
+        }
+
+        if (i >= 3 || response.status == 401) {
+          // none repeatable
           throw new Error(
-            `Unable to fetch ${response.url} (${response.status}) try #${i}`
+            `Unable to fetch ${response.url} (${response.status})`
           );
         }
-        return await response.json();
+        this.info(
+          `Unable to fetch ${response.url} (${response.status}) try #${i}`
+        );
       } catch (e) {
-        if (i++ >= 3) {
+        if (i >= 3) {
           throw e;
         }
         this.error(e);
@@ -140,9 +156,9 @@ export class GithubProvider extends MultiGroupProvider {
    * {@link https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user}
    */
   async initializeRepositories() {
-    for (let page = 1; ; page++) {
-      try {
-        const json = await this.fetchJSON(
+    try {
+      for (let page = 1; ; page++) {
+        const { json } = await this.fetchJSON(
           `user/repos?page=${page}&per_page=100`,
           {
             headers: {
@@ -162,10 +178,8 @@ export class GithubProvider extends MultiGroupProvider {
             r
           );
         });
-      } catch (e) {
-        return;
       }
-    }
+    } catch {}
   }
 
   /**
@@ -182,9 +196,9 @@ export class GithubProvider extends MultiGroupProvider {
     return super.repositoryBases.concat([
       this.url,
       "git+" + this.url,
-      `git+ssh://${domain}`,
-      `git://${domain}/`,
-      `git@${domain}:`
+      `git+ssh://${host}`,
+      `git://${host}/`,
+      `git@${host}:`
     ]);
   }
 

package/src/github-pull-request.mjs

@@ -43,8 +43,8 @@ export class GithubPullRequest extends PullRequest {
 
       do {
         const provider = repository.provider;
-        const response = await provider.fetch(next);
-        for (const node of await response.json()) {
+        const { response, json } = await provider.fetchJSON(next);
+        for (const node of json) {
           const [source, dest] = await Promise.all(
             [node.head, node.base].map(r =>
               provider.branch([r.repo.full_name, r.ref].join("#"))
@@ -72,7 +72,7 @@ export class GithubPullRequest extends PullRequest {
       return p;
     }
 
-    const json = await destination.provider.fetchJSON(
+    const { json } = await destination.provider.fetchJSON(
       `repos/${destination.repository.slug}/pulls`,
       {
         method: "POST",

package/src/github-repository.mjs

@@ -37,16 +37,7 @@ export class GithubRepository extends Repository {
     let next = `repos/${this.slug}/${typeName}`;
 
     do {
-      const response = await this.provider.fetch(next);
-
-      if (!response.ok) {
-        this.error(
-          `Unable to fetch ${typeName} ${response.status} ${response.url}`
-        );
-        return;
-      }
-
-      const json = await response.json();
+      const { response, json } = await this.provider.fetchJSON(next);
       json.forEach(b => this[addMethodName](b.name, b));
       next = getHeaderLink(response.headers);
     } while (next);
@@ -112,7 +103,9 @@ export class GithubRepository extends Repository {
   async refId(ref) {
     ref = ref.replace(/^refs\//, "");
 
-    const json = await this.provider.fetchJSON(`repos/${this.slug}/git/ref/${ref}`);
+    const { json } = await this.provider.fetchJSON(
+      `repos/${this.slug}/git/ref/${ref}`
+    );
 
     // TODO why does this happen ?
     if (!json.object.sha) {
@@ -147,7 +140,7 @@ export class GithubRepository extends Repository {
       console.log(res);
       */
     } else {
-      const json = await this.provider.fetchJSON(
+      const { json } = await this.provider.fetchJSON(
         `repos/${this.slug}/git/ref/heads/${
           from === undefined ? this.defaultBranchName : from.name
         }`
@@ -204,9 +197,9 @@ export class GithubRepository extends Repository {
     let next = `repos/${this.slug}/hooks`;
 
     do {
-      const response = await this.provider.fetch(next);
+      const { response, json } = await this.provider.fetchJSON(next);
 
-      for (const h of await response.json()) {
+      for (const h of json) {
         const id = h.id;
         delete h.id;
         new this.hookClass(this, id, new Set(h.events), {