@prosopo/load-balancer 2.6.17 → 2.8.0

package/CHANGELOG.md

@@ -1,5 +1,207 @@
 # @prosopo/load-balancer
 
+## 2.8.0
+### Minor Changes
+
+- 04d0f1a: weighted random provider selection
+
+### Patch Changes
+
+- Updated dependencies [1e3a838]
+  - @prosopo/config@3.1.20
+  - @prosopo/common@3.1.20
+  - @prosopo/types@3.5.3
+
+## 2.7.12
+### Patch Changes
+
+- 5659b24: Release 3.4.4
+- Updated dependencies [f912439]
+- Updated dependencies [5659b24]
+  - @prosopo/common@3.1.19
+  - @prosopo/types@3.5.2
+  - @prosopo/util@3.1.4
+  - @prosopo/config@3.1.19
+
+## 2.7.11
+### Patch Changes
+
+- 50c4120: Release 3.4.3
+- Updated dependencies [52cd544]
+- Updated dependencies [b117ba3]
+- Updated dependencies [50c4120]
+  - @prosopo/types@3.5.1
+  - @prosopo/common@3.1.18
+  - @prosopo/util@3.1.3
+  - @prosopo/config@3.1.18
+
+## 2.7.10
+### Patch Changes
+
+- 618703f: Release 3.4.2
+- Updated dependencies [618703f]
+- Updated dependencies [e20ad6b]
+  - @prosopo/common@3.1.17
+  - @prosopo/types@3.5.0
+  - @prosopo/util@3.1.2
+  - @prosopo/config@3.1.17
+
+## 2.7.9
+### Patch Changes
+
+- 11303d9: Release 3.4.0
+- 18cb28b: Release 3.4.1
+- Updated dependencies [11303d9]
+- Updated dependencies [18cb28b]
+- Updated dependencies [11303d9]
+  - @prosopo/common@3.1.16
+  - @prosopo/types@3.4.1
+  - @prosopo/util@3.1.1
+  - @prosopo/config@3.1.16
+
+## 2.7.8
+### Patch Changes
+
+- f3f7aec: Release 3.4.0
+- Updated dependencies [f3f7aec]
+- Updated dependencies [6768f14]
+  - @prosopo/common@3.1.15
+  - @prosopo/types@3.4.0
+  - @prosopo/util@3.1.0
+  - @prosopo/config@3.1.15
+
+## 2.7.7
+### Patch Changes
+
+- Release 3.3.1
+- 0824221: Release 3.2.4
+- Updated dependencies [97edf3f]
+- Updated dependencies
+- Updated dependencies [0824221]
+  - @prosopo/types@3.3.0
+  - @prosopo/common@3.1.14
+  - @prosopo/util@3.0.17
+  - @prosopo/config@3.1.14
+
+## 2.7.6
+### Patch Changes
+
+- 008d112: Release 3.3.0
+- Updated dependencies [509be28]
+- Updated dependencies [008d112]
+  - @prosopo/types@3.2.1
+  - @prosopo/common@3.1.13
+  - @prosopo/util@3.0.16
+  - @prosopo/config@3.1.13
+
+## 2.7.5
+### Patch Changes
+
+- 0824221: Release 3.2.4
+- Updated dependencies [cf48565]
+- Updated dependencies [0824221]
+  - @prosopo/types@3.2.0
+  - @prosopo/common@3.1.12
+  - @prosopo/util@3.0.15
+  - @prosopo/config@3.1.12
+
+## 2.7.4
+### Patch Changes
+
+- 1a23649: Release 3.2.3
+- Updated dependencies [0d1a33e]
+- Updated dependencies [0d1a33e]
+- Updated dependencies [1a23649]
+  - @prosopo/types@3.1.4
+  - @prosopo/common@3.1.11
+  - @prosopo/util@3.0.14
+  - @prosopo/config@3.1.11
+
+## 2.7.3
+### Patch Changes
+
+- 657a827: Release 3.2.2
+- Updated dependencies [657a827]
+  - @prosopo/common@3.1.10
+  - @prosopo/types@3.1.3
+  - @prosopo/util@3.0.13
+  - @prosopo/config@3.1.10
+
+## 2.7.2
+### Patch Changes
+
+- 4440947: fix type-only tsc compilation
+- 7bdaca6: Release 3.2.1
+- Updated dependencies [4440947]
+- Updated dependencies [7bdaca6]
+- Updated dependencies [809b984]
+- Updated dependencies [1249ce0]
+- Updated dependencies [809b984]
+  - @prosopo/common@3.1.9
+  - @prosopo/types@3.1.2
+  - @prosopo/util@3.0.12
+  - @prosopo/config@3.1.9
+
+## 2.7.1
+### Patch Changes
+
+- 1f980c4: Fix types mismatch in decryption
+- 6fe8570: Release 3.2.0
+- Updated dependencies [1f980c4]
+- Updated dependencies [6fe8570]
+  - @prosopo/types@3.1.1
+  - @prosopo/common@3.1.8
+  - @prosopo/util@3.0.11
+  - @prosopo/config@3.1.8
+
+## 2.7.0
+### Minor Changes
+
+- 8bdc7f0: Using detector to select provider
+
+### Patch Changes
+
+- f304be9: Release 3.1.13
+- Updated dependencies [f304be9]
+- Updated dependencies [8bdc7f0]
+  - @prosopo/common@3.1.7
+  - @prosopo/types@3.1.0
+  - @prosopo/util@3.0.10
+  - @prosopo/config@3.1.7
+
+## 2.6.21
+### Patch Changes
+
+- Updated dependencies [9eed772]
+  - @prosopo/config@3.1.6
+  - @prosopo/common@3.1.6
+  - @prosopo/types@3.0.10
+
+## 2.6.20
+### Patch Changes
+
+- 6960643: lint detect missing and unneccessary imports
+- Updated dependencies [6960643]
+  - @prosopo/common@3.1.5
+  - @prosopo/types@3.0.9
+
+## 2.6.19
+### Patch Changes
+
+- Updated dependencies [30e7d4d]
+  - @prosopo/config@3.1.5
+  - @prosopo/common@3.1.4
+  - @prosopo/types@3.0.8
+
+## 2.6.18
+### Patch Changes
+
+- Updated dependencies [44ffda2]
+- Updated dependencies [a49b538]
+  - @prosopo/config@3.1.4
+  - @prosopo/common@3.1.3
+  - @prosopo/types@3.0.7
+
 ## 2.6.17
 ### Patch Changes
 

package/README.md

@@ -0,0 +1,49 @@
+# @prosopo/load-balancer
+
+Provider load balancer for Procaptcha
+
+## Provider Selection Config
+
+Each provider in the json has the following properties:
+
+```typescript
+{
+  address: string;      // Provider account address
+  url: string;          // Provider API endpoint
+  datasetId: string;    // Dataset identifier
+  weight?: number;      // Optional weight (1-100, defaults to 1)
+}
+```
+
+### Weight Field
+
+The `weight` field controls how often a provider is selected:
+
+- **Range**: 1-100 (values outside this range are automatically coerced)
+- **Default**: 1 (if not specified)
+- **Type**: Integer (decimal values are rounded)
+- **Effect**: Higher weight = more traffic
+
+#### Examples
+
+```json
+{
+  "provider1": {
+    "address": "...",
+    "url": "https://provider1.example.com",
+    "datasetId": "...",
+    "weight": 1
+  },
+  "provider2": {
+    "address": "...",
+    "url": "https://provider2.example.com",
+    "datasetId": "...",
+    "weight": 3
+  }
+}
+```
+
+In this example:
+- Total weight = 4
+- Provider 1 receives ~25% of traffic
+- Provider 2 receives ~75% of traffic

package/dist/balancer.js

@@ -0,0 +1,52 @@
+import { ProsopoEnvError } from "@prosopo/common";
+import { z } from "zod";
+const HardcodedProviderSchema = z.object({
+  address: z.string(),
+  url: z.string(),
+  datasetId: z.string(),
+  weight: z.number().optional().default(1).transform((val) => {
+    const weight = Math.round(val);
+    return Math.max(1, Math.min(100, weight));
+  })
+});
+const convertHostedProvider = (provider) => {
+  const providers = Object.values(provider).map(
+    (p) => HardcodedProviderSchema.parse(p)
+  );
+  return providers.sort((a, b) => a.url.localeCompare(b.url));
+};
+const loadBalancer = async (environment) => {
+  if (environment === "production") {
+    const providers = await fetch(
+      "https://provider-list.prosopo.io/",
+      {
+        method: "GET",
+        mode: "cors"
+      }
+    ).then((res) => res.json());
+    return convertHostedProvider(providers);
+  }
+  if (environment === "staging") {
+    const providers = await fetch(
+      "https://provider-list.prosopo.io/staging.json",
+      { method: "GET", mode: "cors" }
+    ).then((res) => res.json());
+    return convertHostedProvider(providers);
+  }
+  if (environment === "development") {
+    return [
+      {
+        address: "5EjTA28bKSbFPPyMbUjNtArxyqjwq38r1BapVmLZShaqEedV",
+        url: "http://localhost:9229",
+        datasetId: "0x9f460e81ac9c71b486f796a21bb36e2263694756a6621134d110da217fd3ef25",
+        weight: 1
+      }
+    ];
+  }
+  throw new ProsopoEnvError("CONFIG.UNKNOWN_ENVIRONMENT", {
+    context: { environment }
+  });
+};
+export {
+  loadBalancer
+};

package/dist/cjs/balancer.cjs

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const common = require("@prosopo/common");
+const zod = require("zod");
+const HardcodedProviderSchema = zod.z.object({
+  address: zod.z.string(),
+  url: zod.z.string(),
+  datasetId: zod.z.string(),
+  weight: zod.z.number().optional().default(1).transform((val) => {
+    const weight = Math.round(val);
+    return Math.max(1, Math.min(100, weight));
+  })
+});
+const convertHostedProvider = (provider) => {
+  const providers = Object.values(provider).map(
+    (p) => HardcodedProviderSchema.parse(p)
+  );
+  return providers.sort((a, b) => a.url.localeCompare(b.url));
+};
+const loadBalancer = async (environment) => {
+  if (environment === "production") {
+    const providers = await fetch(
+      "https://provider-list.prosopo.io/",
+      {
+        method: "GET",
+        mode: "cors"
+      }
+    ).then((res) => res.json());
+    return convertHostedProvider(providers);
+  }
+  if (environment === "staging") {
+    const providers = await fetch(
+      "https://provider-list.prosopo.io/staging.json",
+      { method: "GET", mode: "cors" }
+    ).then((res) => res.json());
+    return convertHostedProvider(providers);
+  }
+  if (environment === "development") {
+    return [
+      {
+        address: "5EjTA28bKSbFPPyMbUjNtArxyqjwq38r1BapVmLZShaqEedV",
+        url: "http://localhost:9229",
+        datasetId: "0x9f460e81ac9c71b486f796a21bb36e2263694756a6621134d110da217fd3ef25",
+        weight: 1
+      }
+    ];
+  }
+  throw new common.ProsopoEnvError("CONFIG.UNKNOWN_ENVIRONMENT", {
+    context: { environment }
+  });
+};
+exports.loadBalancer = loadBalancer;

package/dist/cjs/index.cjs

@@ -1,38 +1,8 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const common = require("@prosopo/common");
-const convertHostedProvider = (provider) => {
-  return Object.values(provider);
-};
-const loadBalancer = async (environment) => {
-  if (environment === "production") {
-    const providers = await fetch(
-      "https://provider-list.prosopo.io/",
-      {
-        method: "GET",
-        mode: "cors"
-      }
-    ).then((res) => res.json());
-    return convertHostedProvider(providers);
-  }
-  if (environment === "staging") {
-    const providers = await fetch(
-      "https://provider-list.prosopo.io/staging.json",
-      { method: "GET", mode: "cors" }
-    ).then((res) => res.json());
-    return convertHostedProvider(providers);
-  }
-  if (environment === "development") {
-    return [
-      {
-        address: "5EjTA28bKSbFPPyMbUjNtArxyqjwq38r1BapVmLZShaqEedV",
-        url: "http://localhost:9229",
-        datasetId: "0x9f460e81ac9c71b486f796a21bb36e2263694756a6621134d110da217fd3ef25"
-      }
-    ];
-  }
-  throw new common.ProsopoEnvError("CONFIG.UNKNOWN_ENVIRONMENT", {
-    context: { environment }
-  });
-};
-exports.loadBalancer = loadBalancer;
+const providers = require("./providers.cjs");
+const balancer = require("./balancer.cjs");
+exports._resetCache = providers._resetCache;
+exports.getRandomActiveProvider = providers.getRandomActiveProvider;
+exports.selectWeightedProvider = providers.selectWeightedProvider;
+exports.loadBalancer = balancer.loadBalancer;

package/dist/cjs/providers.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./index.cjs");
+const balancer = require("./balancer.cjs");
+let cachedProviders = [];
+function _resetCache() {
+  cachedProviders = [];
+}
+function selectWeightedProvider(providers, entropy) {
+  if (providers.length === 0) {
+    throw new Error("No providers available");
+  }
+  const totalWeight = providers.reduce((sum, p) => sum + p.weight, 0);
+  const randomValue = entropy % totalWeight;
+  let cumulativeWeight = 0;
+  for (const provider of providers) {
+    cumulativeWeight += provider.weight;
+    if (randomValue < cumulativeWeight) {
+      return provider;
+    }
+  }
+  const selectedProvider = providers[providers.length - 1];
+  if (!selectedProvider) {
+    throw new Error("No providers available");
+  }
+  return selectedProvider;
+}
+const getRandomActiveProvider = async (env, entropy) => {
+  if (cachedProviders.length === 0) {
+    cachedProviders = await balancer.loadBalancer(env);
+  }
+  const randomProviderObj = selectWeightedProvider(cachedProviders, entropy);
+  return {
+    providerAccount: randomProviderObj.address,
+    provider: {
+      url: randomProviderObj.url,
+      datasetId: randomProviderObj.datasetId
+    }
+  };
+};
+exports._resetCache = _resetCache;
+exports.getRandomActiveProvider = getRandomActiveProvider;
+exports.selectWeightedProvider = selectWeightedProvider;

package/dist/index.js

@@ -1,38 +1,8 @@
-import { ProsopoEnvError } from "@prosopo/common";
-const convertHostedProvider = (provider) => {
-  return Object.values(provider);
-};
-const loadBalancer = async (environment) => {
-  if (environment === "production") {
-    const providers = await fetch(
-      "https://provider-list.prosopo.io/",
-      {
-        method: "GET",
-        mode: "cors"
-      }
-    ).then((res) => res.json());
-    return convertHostedProvider(providers);
-  }
-  if (environment === "staging") {
-    const providers = await fetch(
-      "https://provider-list.prosopo.io/staging.json",
-      { method: "GET", mode: "cors" }
-    ).then((res) => res.json());
-    return convertHostedProvider(providers);
-  }
-  if (environment === "development") {
-    return [
-      {
-        address: "5EjTA28bKSbFPPyMbUjNtArxyqjwq38r1BapVmLZShaqEedV",
-        url: "http://localhost:9229",
-        datasetId: "0x9f460e81ac9c71b486f796a21bb36e2263694756a6621134d110da217fd3ef25"
-      }
-    ];
-  }
-  throw new ProsopoEnvError("CONFIG.UNKNOWN_ENVIRONMENT", {
-    context: { environment }
-  });
-};
+import { _resetCache, getRandomActiveProvider, selectWeightedProvider } from "./providers.js";
+import { loadBalancer } from "./balancer.js";
 export {
-  loadBalancer
+  _resetCache,
+  getRandomActiveProvider,
+  loadBalancer,
+  selectWeightedProvider
 };

package/dist/providers.js

@@ -0,0 +1,43 @@
+import "./index.js";
+import { loadBalancer } from "./balancer.js";
+let cachedProviders = [];
+function _resetCache() {
+  cachedProviders = [];
+}
+function selectWeightedProvider(providers, entropy) {
+  if (providers.length === 0) {
+    throw new Error("No providers available");
+  }
+  const totalWeight = providers.reduce((sum, p) => sum + p.weight, 0);
+  const randomValue = entropy % totalWeight;
+  let cumulativeWeight = 0;
+  for (const provider of providers) {
+    cumulativeWeight += provider.weight;
+    if (randomValue < cumulativeWeight) {
+      return provider;
+    }
+  }
+  const selectedProvider = providers[providers.length - 1];
+  if (!selectedProvider) {
+    throw new Error("No providers available");
+  }
+  return selectedProvider;
+}
+const getRandomActiveProvider = async (env, entropy) => {
+  if (cachedProviders.length === 0) {
+    cachedProviders = await loadBalancer(env);
+  }
+  const randomProviderObj = selectWeightedProvider(cachedProviders, entropy);
+  return {
+    providerAccount: randomProviderObj.address,
+    provider: {
+      url: randomProviderObj.url,
+      datasetId: randomProviderObj.datasetId
+    }
+  };
+};
+export {
+  _resetCache,
+  getRandomActiveProvider,
+  selectWeightedProvider
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prosopo/load-balancer",
-	"version": "2.6.17",
+	"version": "2.8.0",
 	"description": "Provider load balancer",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -21,7 +21,8 @@
 		"build": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.esm.config.ts --mode $NODE_ENV",
 		"build:tsc": "tsc --build --verbose",
 		"build:cjs": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV",
-		"typecheck": "tsc --build --declaration --emitDeclarationOnly"
+		"test": "NODE_ENV=${NODE_ENV:-test}; npx vitest run --config ./vite.test.config.ts --mode $NODE_ENV",
+		"typecheck": "tsc --project tsconfig.types.json"
 	},
 	"repository": {
 		"type": "git",
@@ -34,20 +35,17 @@
 	},
 	"homepage": "https://github.com/prosopo/captcha#readme",
 	"dependencies": {
-		"@prosopo/common": "3.1.2",
-		"@prosopo/config": "3.1.3",
-		"@prosopo/types": "3.0.6",
-		"@typegoose/auto-increment": "4.13.0",
-		"axios": "1.10.0",
-		"esbuild": "0.25.6",
-		"express": "4.21.2",
-		"openpgp": "5.11.3",
-		"webpack-dev-server": "5.2.2"
+		"@prosopo/common": "3.1.20",
+		"@prosopo/config": "3.1.20",
+		"@prosopo/types": "3.5.3",
+		"zod": "3.23.8"
 	},
 	"devDependencies": {
+		"@types/node": "22.10.2",
 		"@vitest/coverage-v8": "3.0.9",
 		"concurrently": "9.0.1",
 		"del-cli": "6.0.0",
+		"dotenv": "17.2.1",
 		"npm-run-all": "4.1.5",
 		"tslib": "2.7.0",
 		"tsx": "4.20.3",

package/vite.test.config.ts

@@ -0,0 +1,33 @@
+// Copyright 2021-2025 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import fs from "node:fs";
+import path from "node:path";
+import { ViteTestConfig } from "@prosopo/config";
+import dotenv from "dotenv";
+process.env.NODE_ENV = "test";
+// if .env.test exists at this level, use it, otherwise use the one at the root
+const envFile = `.env.${process.env.NODE_ENV || "development"}`;
+let envPath = envFile;
+if (fs.existsSync(envFile)) {
+	envPath = path.resolve(envFile);
+} else if (fs.existsSync(`../../${envFile}`)) {
+	envPath = path.resolve(`../../${envFile}`);
+} else {
+	throw new Error(`No ${envFile} file found`);
+}
+
+dotenv.config({ path: envPath });
+
+export default ViteTestConfig();