gcb-host 0.5.0 → 0.7.0

package/lib/public-repo.js

@@ -0,0 +1,94 @@
+import { ProviderConfigError } from 'gcb-core';
+/** How long one visibility check may take, including the body. */
+const CHECK_TIMEOUT_MS = 10_000;
+/**
+ * Run one unauthenticated repository request with a deadline and no redirects.
+ *
+ * @param fetchImpl - the transport for this host's proxy choice.
+ * @param apiBaseUrl - the API base, without a trailing path.
+ * @param repository - `owner/name`.
+ * @param options - API version, deadline and a label for the timeout message.
+ * @param handle - reads the response while the deadline is still active.
+ * @returns whatever the handler returns.
+ */
+export async function withRepositoryResponse(fetchImpl, apiBaseUrl, repository, options, handle) {
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), options.timeoutMs ?? CHECK_TIMEOUT_MS);
+    try {
+        const response = await fetchImpl(`${apiBaseUrl}/repos/${repository}`, {
+            method: 'GET',
+            headers: {
+                accept: 'application/vnd.github+json',
+                'x-github-api-version': options.apiVersion ?? '2022-11-28',
+                'user-agent': 'gcb',
+            },
+            signal: controller.signal,
+            redirect: 'error',
+        });
+        if (response.status === 403 || response.status === 429) {
+            const exhausted = response.status === 429 ||
+                response.headers.get('x-ratelimit-remaining') === '0' ||
+                response.headers.get('retry-after') !== null;
+            const label = options.label ?? 'repository';
+            throw new ProviderConfigError(exhausted
+                ? `GitHub rate-limited the unauthenticated ${label} check; retry later or allowlist the repository`
+                : `GitHub refused the unauthenticated ${label} check; check the access policy or allowlist the repository`);
+        }
+        return await handle(response);
+    }
+    catch (error) {
+        if (controller.signal.aborted) {
+            throw new ProviderConfigError(`GitHub timed out during the ${options.label ?? 'repository'} check; retry later`);
+        }
+        throw error;
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+/** Check a repository with no credential; only a confirmed public result is true. */
+export async function isPublicRepository(fetchImpl, apiBaseUrl, repository, apiVersion = '2022-11-28', timeoutMs = CHECK_TIMEOUT_MS) {
+    return withRepositoryResponse(fetchImpl, apiBaseUrl, repository, { apiVersion, timeoutMs, label: 'public-repository' }, async (response) => {
+        if (!response.ok)
+            return false;
+        const text = await response.text();
+        try {
+            const body = JSON.parse(text);
+            return body?.private === false;
+        }
+        catch {
+            return false;
+        }
+    });
+}
+/**
+ * Check whether a public repository is a fork of another, with no credential.
+ *
+ * @param fetchImpl - the transport for this host's proxy choice.
+ * @param apiBaseUrl - the API base, without a trailing path.
+ * @param repository - the possible fork, `owner/name`.
+ * @param parent - the possible parent/source, `owner/name`.
+ * @param apiVersion - GitHub API version header.
+ * @param timeoutMs - whole-request deadline.
+ * @returns true only when GitHub confirms the fork relationship.
+ */
+export async function isForkOfRepository(fetchImpl, apiBaseUrl, repository, parent, apiVersion = '2022-11-28', timeoutMs = CHECK_TIMEOUT_MS) {
+    return withRepositoryResponse(fetchImpl, apiBaseUrl, repository, { apiVersion, timeoutMs, label: 'fork' }, async (response) => {
+        if (!response.ok)
+            return false;
+        const text = await response.text();
+        try {
+            const body = JSON.parse(text);
+            if (body?.fork !== true)
+                return false;
+            const names = [body.parent?.full_name, body.source?.full_name]
+                .filter((name) => typeof name === 'string')
+                .map((name) => name.toLowerCase());
+            return names.includes(parent.toLowerCase());
+        }
+        catch {
+            return false;
+        }
+    });
+}
+//# sourceMappingURL=public-repo.js.map

package/lib/public-repo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-repo.js","sourceRoot":"","sources":["../src/public-repo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,kEAAkE;AAClE,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAYhC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,SAAoB,EACpB,UAAkB,EAClB,UAAkB,EAClB,OAA+B,EAC/B,MAAmD;IAEnD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,SAAS,IAAI,gBAAgB,CAAC,CAAC;IAC1F,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,UAAU,UAAU,EAAE,EAAE;YACpE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,6BAA6B;gBACrC,sBAAsB,EAAE,OAAO,CAAC,UAAU,IAAI,YAAY;gBAC1D,YAAY,EAAE,KAAK;aACpB;YACD,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAC;QACH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACvD,MAAM,SAAS,GACb,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,GAAG;gBACrD,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;YAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC;YAC5C,MAAM,IAAI,mBAAmB,CAC3B,SAAS;gBACP,CAAC,CAAC,2CAA2C,KAAK,iDAAiD;gBACnG,CAAC,CAAC,sCAAsC,KAAK,6DAA6D,CAC7G,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,IAAI,mBAAmB,CAC3B,+BAA+B,OAAO,CAAC,KAAK,IAAI,YAAY,qBAAqB,CAClF,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;AACH,CAAC;AAED,qFAAqF;AACrF,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,SAAoB,EACpB,UAAkB,EAClB,UAAkB,EAClB,UAAU,GAAG,YAAY,EACzB,SAAS,GAAG,gBAAgB;IAE5B,OAAO,sBAAsB,CAC3B,SAAS,EACT,UAAU,EACV,UAAU,EACV,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,mBAAmB,EAAE,EACrD,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjB,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,OAAO,KAAK,CAAC;QAC/B,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAiC,CAAC;YAC9D,OAAO,IAAI,EAAE,OAAO,KAAK,KAAK,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,SAAoB,EACpB,UAAkB,EAClB,UAAkB,EAClB,MAAc,EACd,UAAU,GAAG,YAAY,EACzB,SAAS,GAAG,gBAAgB;IAE5B,OAAO,sBAAsB,CAC3B,SAAS,EACT,UAAU,EACV,UAAU,EACV,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EACxC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjB,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,OAAO,KAAK,CAAC;QAC/B,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAIpB,CAAC;YACT,IAAI,IAAI,EAAE,IAAI,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YACtC,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC;iBAC3D,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC;iBAC1D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YACrC,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gcb-host",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Host-side gcb broker, configuration, providers and administration commands.",
   "license": "MIT",
   "author": "JounQin <admin@1stg.me>",
@@ -27,7 +27,7 @@
     }
   },
   "dependencies": {
-    "gcb-core": "0.5.0",
+    "gcb-core": "0.7.0",
     "node-fetch-native": "^1.6.7",
     "x-fetch": "^0.3.0",
     "yaml": "^2.9.1"