github-repository-provider 7.24.10 → 7.25.3

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2021 by arlac77
+Copyright (c) 2017-2022 by arlac77
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -36,13 +36,13 @@ console.log(entry.name);
 *   [GithubBranch](#githubbranch)
     *   [writeEntry](#writeentry)
         *   [Parameters](#parameters)
-    *   [baseTreeSha](#basetreesha)
-        *   [Parameters](#parameters-1)
     *   [commit](#commit)
-        *   [Parameters](#parameters-2)
+        *   [Parameters](#parameters-1)
     *   [entry](#entry)
-        *   [Parameters](#parameters-3)
+        *   [Parameters](#parameters-2)
     *   [maybeEntry](#maybeentry)
+        *   [Parameters](#parameters-3)
+    *   [baseTreeSha](#basetreesha)
         *   [Parameters](#parameters-4)
     *   [tree](#tree)
         *   [Parameters](#parameters-5)
@@ -99,14 +99,6 @@ Writes content into the branch
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ConentEntry>** written content with sha values set
 
-### baseTreeSha
-
-<https://developer.github.com/v3/git/commits/#get-a-commit>
-
-#### Parameters
-
-*   `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ### commit
 
 <https://developer.github.com/v3/git/trees/#create-a-tree>
@@ -133,6 +125,14 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `name`  
 
+### baseTreeSha
+
+<https://developer.github.com/v3/git/commits/#get-a-commit>
+
+#### Parameters
+
+*   `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ### tree
 
 *   **See**: <https://developer.github.com/v3/git/trees/>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-repository-provider",
-  "version": "7.24.10",
+  "version": "7.25.3",
   "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.2.0",
     "matching-iterator": "^2.0.0",
     "node-fetch": "3.1.0",
     "one-time-execution-method": "^2.0.9",
-    "repository-provider": "^26.1.0"
+    "repository-provider": "^26.1.2"
   },
   "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.2",
     "semantic-release": "^18.0.1"
   },
   "engines": {

package/src/github-branch.mjs

@@ -34,17 +34,6 @@ export class GithubBranch extends Branch {
     return entry;
   }
 
-  /**
-   * {@link https://developer.github.com/v3/git/commits/#get-a-commit}
-   * @param {string} sha
-   */
-  async baseTreeSha(sha) {
-    const { json } = await this.provider.fetchJSON(
-      `repos/${this.slug}/git/commits/${sha}`
-    );
-    return json.tree.sha;
-  }
-
   /**
    * {@link https://developer.github.com/v3/git/trees/#create-a-tree}
    * {@link https://developer.github.com/v3/git/commits/#create-a-commit}
@@ -135,6 +124,17 @@ export class GithubBranch extends Branch {
     }
   }
 
+  /**
+   * {@link https://developer.github.com/v3/git/commits/#get-a-commit}
+   * @param {string} sha
+   */
+  async baseTreeSha(sha) {
+    const { json } = await this.provider.fetchJSON(
+      `repos/${this.slug}/git/commits/${sha}`
+    );
+    return json.tree.sha;
+  }
+
   /**
    * @see https://developer.github.com/v3/git/trees/
    * @param {string } treeSha

package/src/github-provider.mjs

@@ -1,6 +1,6 @@
 import fetch from "node-fetch";
 import { replaceWithOneTimeExecutionMethod } from "one-time-execution-method";
-import { rateLimitHandler, defaultWaitDecide } from "fetch-rate-limit-util";
+import { stateActionHandler } from "fetch-rate-limit-util";
 
 import { MultiGroupProvider } from "repository-provider";
 import { GithubRepository } from "./github-repository.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,43 +42,39 @@ 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}`
-      },
-      /*
-      domain : {
-        type: "string",
-        env: ["GH_HOST"],
-        default: "github.com"
+        default: `https://api.${host}`
       },
-      */
       "authentication.token": {
         type: "string",
         // @see https://cli.github.com/manual/gh_help_environment
         env: [
           "{{instanceIdentifier}}TOKEN",
-          "GH_TOKEN",
-          "GITHUB_ENTERPRISE_TOKEN",
-          "GH_ENTERPRISE_TOKEN"
+          "GH_TOKEN" // declare GH_ as identifier
         ],
         additionalAttributes: { "authentication.type": "token" },
         private: true,
@@ -102,57 +98,30 @@ 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
-          }
-        }),
-      (millisecondsToWait, rateLimitRemaining, nthTry, response) => {
-        this.rateLimitRemaining = rateLimitRemaining;
-
-        const msecs = defaultWaitDecide(
-          millisecondsToWait,
-          rateLimitRemaining,
-          nthTry,
-          response
-        );
-
-        if (msecs > 0) {
-          this.warn(`Rate limit reached: waiting for ${msecs / 1000}s`);
-        }
-        return msecs;
+    return stateActionHandler(fetch, new URL(url, this.api), {
+      ...options,
+      headers: {
+        authorization: `token ${this.authentication.token}`,
+        ...options.headers
       }
-    );
+    });
   }
 
-  async fetchJSON(url, options) {
-    for (let i = 1; ; i++) {
-      try {
-        const response = await this.fetch(url, options);
-        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})`
-          );
-        }
-        this.info(
-          `Unable to fetch ${response.url} (${response.status}) try #${i}`
-        );
-      } catch (e) {
-        if (i >= 3) {
-          throw e;
+  fetchJSON(url, options = {}) {
+    return stateActionHandler(
+      fetch,
+      new URL(url, this.api),
+      {
+        ...options,
+        headers: {
+          authorization: `token ${this.authentication.token}`,
+          ...options.headers
         }
-        this.error(e);
+      },
+      async response => {
+        return { response, json: await response.json() };
       }
-    }
+    );
   }
 
   /**
@@ -199,9 +168,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}:`
     ]);
   }
 
@@ -224,11 +193,3 @@ replaceWithOneTimeExecutionMethod(
 );
 
 export default GithubProvider;
-
-/*
-{
-  "400" : { repeat: 3, timeout: 100 }
-  "401" : { repeat: 0 }
-  "500" : { repeat: 3, timeout: 100 }
-}
-*/