octokit-load-balancer 1.0.1 → 1.0.3

package/README.md

@@ -7,7 +7,6 @@
 
 ## Features
 
-- **Multiple App Support** - Pool multiple GitHub Apps for higher aggregate rate limits
 - **Smart Selection** - Always picks the app with the most available rate limit
 - **Auto Key Detection** - Automatically detects raw PEM vs base64 encoded private keys
 - **TypeScript First** - Full type definitions using Octokit types
@@ -16,7 +15,7 @@
 ## Installation
 
 ```bash
-npm install octokit-load-balancer octokit @octokit/auth-app
+npm install octokit-load-balancer
 ```
 
 ## Usage
@@ -47,7 +46,7 @@ await octokit.rest.repos.get({ owner: 'your-org', repo: 'your-repo' });
 
 Every time you call `getApp(config)`:
 
-1. Creates Octokit instances for all valid app configs
+1. Creates Octokit instances for each app
 2. Fetches rate limits for all apps in parallel
 3. Returns the Octokit with the highest remaining rate limit
 
@@ -60,37 +59,6 @@ Every time you call `getApp(config)`:
 
 App configs use `GitHubAppConfig` (re-exported from `@octokit/auth-app`'s `StrategyOptions`). All apps must have valid `appId` and `privateKey` — incomplete configs will throw an error.
 
-## Comparison with @octokit/plugin-throttling
+## Scalability
 
-[`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) handles rate limits by queuing and retrying requests. This library takes a different approach: distribute load across multiple GitHub Apps to maximize available quota.
-
-|                    | octokit-load-balancer              | plugin-throttling         |
-| ------------------ | ---------------------------------- | ------------------------- |
-| Strategy           | Pick app with most remaining quota | Queue and retry on limits |
-| Multiple apps      | Yes                                | No                        |
-| Handles exhaustion | Throws                             | Waits and retries         |
-
-Choose based on your situation:
-
-- **Need more than 5000 requests/hour?** → Create multiple GitHub Apps and use this library to distribute load across them (N apps = N × 5000 req/hr)
-- **Single app, need graceful handling?** → Use plugin-throttling to wait and retry
-
-## Debugging
-
-Enable debug logs with the `DEBUG` environment variable:
-
-```bash
-DEBUG=octokit-load-balancer node your-script.js
-```
-
-Output:
-
-```
-[octokit-load-balancer] Using 2 valid app configs
-[octokit-load-balancer] Rate limits: app[0]: 4500/5000, app[1]: 4900/5000
-[octokit-load-balancer] Selected app[1] with 4900/5000 remaining
-```
-
-## License
-
-MIT
+This library is designed for high-throughput scenarios where a single GitHub App's rate limit (5,000 requests/hour) isn't enough. By distributing requests across multiple apps, you get N × 5,000 requests/hour.

package/dist/index.js

@@ -32,8 +32,8 @@ async function getApp(config) {
   if (!Array.isArray(config?.apps)) {
     throw new Error("Invalid config: apps must be an array");
   }
-  if (typeof config?.baseUrl !== "string") {
-    throw new Error("Invalid config: baseUrl must be a string");
+  if (typeof config?.baseUrl !== "string" || !config.baseUrl) {
+    throw new Error("Invalid config: baseUrl must be a non-empty string");
   }
   if (config.apps.length === 0) {
     throw new Error("Invalid config: apps array is empty");
@@ -44,9 +44,8 @@ async function getApp(config) {
       `Invalid config: ${invalidApps.length} app(s) missing required appId or privateKey`
     );
   }
-  const validApps = config.apps;
-  log(`Using ${validApps.length} valid app configs`);
-  const octokits = validApps.map((app) => createOctokit(app, config.baseUrl));
+  log(`Using ${config.apps.length} app configs`);
+  const octokits = config.apps.map((app) => createOctokit(app, config.baseUrl));
   const rateLimits = await Promise.all(
     octokits.map((o, i) => getRateLimit(o, i))
   );
@@ -83,7 +82,7 @@ function decodePrivateKey(key) {
 function createOctokit(appConfig, baseUrl) {
   return new import_octokit.Octokit({
     authStrategy: import_auth_app.createAppAuth,
-    baseUrl: baseUrl || "https://api.github.com",
+    baseUrl,
     auth: {
       appId: appConfig.appId,
       installationId: appConfig.installationId,

package/dist/index.mjs

@@ -6,8 +6,8 @@ async function getApp(config) {
   if (!Array.isArray(config?.apps)) {
     throw new Error("Invalid config: apps must be an array");
   }
-  if (typeof config?.baseUrl !== "string") {
-    throw new Error("Invalid config: baseUrl must be a string");
+  if (typeof config?.baseUrl !== "string" || !config.baseUrl) {
+    throw new Error("Invalid config: baseUrl must be a non-empty string");
   }
   if (config.apps.length === 0) {
     throw new Error("Invalid config: apps array is empty");
@@ -18,9 +18,8 @@ async function getApp(config) {
       `Invalid config: ${invalidApps.length} app(s) missing required appId or privateKey`
     );
   }
-  const validApps = config.apps;
-  log(`Using ${validApps.length} valid app configs`);
-  const octokits = validApps.map((app) => createOctokit(app, config.baseUrl));
+  log(`Using ${config.apps.length} app configs`);
+  const octokits = config.apps.map((app) => createOctokit(app, config.baseUrl));
   const rateLimits = await Promise.all(
     octokits.map((o, i) => getRateLimit(o, i))
   );
@@ -57,7 +56,7 @@ function decodePrivateKey(key) {
 function createOctokit(appConfig, baseUrl) {
   return new Octokit({
     authStrategy: createAppAuth,
-    baseUrl: baseUrl || "https://api.github.com",
+    baseUrl,
     auth: {
       appId: appConfig.appId,
       installationId: appConfig.installationId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octokit-load-balancer",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Load balance across multiple GitHub App instances, always picking the one with most available rate limit",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -41,7 +41,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/frankie303/octokit-load-balancer"
+    "url": "git+https://github.com/frankie303/octokit-load-balancer.git"
   },
   "peerDependencies": {
     "@octokit/auth-app": "^7.0.0",