@mytmpvpn/mytmpvpn-common 6.1.0 → 6.2.0

package/dist/src/errors.d.ts

@@ -4,6 +4,9 @@ export declare class MyTmpVpnError extends Error {
 export declare class InvalidUserConfigError extends MyTmpVpnError {
     constructor(msg: string);
 }
+export declare class NegativeBalanceError extends MyTmpVpnError {
+    constructor(balance: number);
+}
 export declare class InvalidVpnConfigError extends MyTmpVpnError {
     constructor(msg: string);
 }

package/dist/src/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MaxDeleteAfterError = exports.MinDeleteAfterError = exports.NotEnoughPeanutsError = exports.MaxPeanutsError = exports.MinPeanutsError = exports.InvalidVpnConfigError = exports.InvalidUserConfigError = exports.MyTmpVpnError = void 0;
+exports.MaxDeleteAfterError = exports.MinDeleteAfterError = exports.NotEnoughPeanutsError = exports.MaxPeanutsError = exports.MinPeanutsError = exports.InvalidVpnConfigError = exports.NegativeBalanceError = exports.InvalidUserConfigError = exports.MyTmpVpnError = void 0;
 const peanuts_1 = require("./models/peanuts");
 class MyTmpVpnError extends Error {
     constructor(msg) {
@@ -18,6 +18,14 @@ class InvalidUserConfigError extends MyTmpVpnError {
     }
 }
 exports.InvalidUserConfigError = InvalidUserConfigError;
+class NegativeBalanceError extends MyTmpVpnError {
+    constructor(balance) {
+        super(`Negative peanuts balance: ${(0, peanuts_1.peanutsToClient)(balance)}.`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, NotEnoughPeanutsError.prototype);
+    }
+}
+exports.NegativeBalanceError = NegativeBalanceError;
 class InvalidVpnConfigError extends MyTmpVpnError {
     constructor(msg) {
         super(msg);

package/dist/src/models/peanuts.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.peanutsToClient = void 0;
 function peanutsToClient(peanuts) {
-    return Number.parseFloat(peanuts.toFixed(2));
+    return peanuts ? Number.parseFloat(peanuts.toFixed(2)) : 0;
 }
 exports.peanutsToClient = peanutsToClient;

package/dist/src/models/vpn.d.ts

@@ -50,3 +50,8 @@ export declare function getVpnFrom(vpnId: string, state: VpnState, config: VpnCo
 export declare function vpnIdToWgFileName(vpnId: string): string;
 export declare function vpnToClient(vpn: Vpn): Vpn;
 export declare function metricsToClient(metrics: VpnMetrics | undefined): VpnMetrics;
+/**
+ * Extract the creation date from a VPN ID
+ * VPN ID format: {dateToId(createdAt)}@{region}
+ */
+export declare function getCreationDateFromVpnId(vpnId: string): Date;

package/dist/src/models/vpn.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.metricsToClient = exports.vpnToClient = exports.vpnIdToWgFileName = exports.getVpnFrom = exports.newVpn = exports.checkValidConfig = exports.validateVpnNbAgainstQuota = exports.vpnAgainstQuotaPredicate = exports.getVpnConfigTypes = exports.VpnType = exports.fromRank = exports.toRank = exports.VpnState = void 0;
+exports.getCreationDateFromVpnId = exports.metricsToClient = exports.vpnToClient = exports.vpnIdToWgFileName = exports.getVpnFrom = exports.newVpn = exports.checkValidConfig = exports.validateVpnNbAgainstQuota = exports.vpnAgainstQuotaPredicate = exports.getVpnConfigTypes = exports.VpnType = exports.fromRank = exports.toRank = exports.VpnState = void 0;
 const errors_1 = require("../errors");
 const peanuts_1 = require("./peanuts");
 const loglevel_1 = require("loglevel");
@@ -42,20 +42,25 @@ function validateVpnId(vpnId) {
     return vpnId;
 }
 function validateMaxPeanuts(peanuts, currentBalance, vpnConfigLimits) {
-    let result = peanuts;
+    // No matter what, if currentBalance is negative, we fail
+    if (currentBalance <= 0) {
+        throw new errors_1.NegativeBalanceError(currentBalance);
+    }
     if (peanuts <= 0) {
-        result = Math.min(currentBalance, vpnConfigLimits.maxPeanutsFieldMaxValue);
+        // result = Math.min(currentBalance, vpnConfigLimits.maxPeanutsFieldMaxValue)
+        // This is always safe as it means run as long as there are enough peanuts
+        return -1;
     }
-    if (result > currentBalance) {
-        throw new errors_1.NotEnoughPeanutsError(result, currentBalance);
+    if (peanuts > currentBalance) {
+        throw new errors_1.NotEnoughPeanutsError(peanuts, currentBalance);
     }
-    if (result < vpnConfigLimits.maxPeanutsFieldMinValue) {
-        throw new errors_1.MinPeanutsError(vpnConfigLimits.maxPeanutsFieldMinValue, result, currentBalance);
+    if (peanuts < vpnConfigLimits.maxPeanutsFieldMinValue) {
+        throw new errors_1.MinPeanutsError(vpnConfigLimits.maxPeanutsFieldMinValue, peanuts, currentBalance);
     }
-    if (result > vpnConfigLimits.maxPeanutsFieldMaxValue) {
-        throw new errors_1.MaxPeanutsError(vpnConfigLimits.maxPeanutsFieldMaxValue, result, currentBalance);
+    if (peanuts > vpnConfigLimits.maxPeanutsFieldMaxValue) {
+        throw new errors_1.MaxPeanutsError(vpnConfigLimits.maxPeanutsFieldMaxValue, peanuts, currentBalance);
     }
-    return result;
+    return peanuts;
 }
 function validateDeleteAfter(deleteAfter, vpnConfigLimits) {
     if (deleteAfter === undefined) {
@@ -271,3 +276,16 @@ function metricsToClient(metrics) {
         };
 }
 exports.metricsToClient = metricsToClient;
+/**
+ * Extract the creation date from a VPN ID
+ * VPN ID format: {dateToId(createdAt)}@{region}
+ */
+function getCreationDateFromVpnId(vpnId) {
+    validateVpnId(vpnId);
+    const tokens = vpnId.split('@');
+    if (tokens.length !== 2) {
+        throw new errors_1.MyTmpVpnError(`Invalid VPN ID format: ${vpnId}`);
+    }
+    return idToDate(tokens[0]);
+}
+exports.getCreationDateFromVpnId = getCreationDateFromVpnId;

package/dist/test/models.test.js

@@ -121,7 +121,7 @@ describe('Testing vpnId to Wireguard file name functions ', () => {
     });
 });
 describe('Testing vpn config', () => {
-    it('Should set maxPeanuts to the validPeanutsConfig maximum when set to negative', async () => {
+    it('Should keep maxPeanuts to -1 when specified', async () => {
         const validatedConfig = (0, vpn_1.checkValidConfig)('userId', 2, {
             maxPeanutsFieldMinValue: 0,
             maxPeanutsFieldMaxValue: 1,
@@ -133,12 +133,12 @@ describe('Testing vpn config', () => {
             deleteAfter: 1
         });
         expect(validatedConfig).toEqual({
-            maxPeanuts: 1,
+            maxPeanuts: -1,
             type: vpn_1.VpnType.WireGuard,
             deleteAfter: 1
         });
     });
-    it('Should set maxPeanuts to the validPeanutsConfig maximum when null', async () => {
+    it('Should set maxPeanuts to -1 when null', async () => {
         const validatedConfig = (0, vpn_1.checkValidConfig)('userId', 2, {
             maxPeanutsFieldMinValue: 0,
             maxPeanutsFieldMaxValue: 1,
@@ -150,12 +150,12 @@ describe('Testing vpn config', () => {
             deleteAfter: 1
         });
         expect(validatedConfig).toEqual({
-            maxPeanuts: 1,
+            maxPeanuts: -1,
             type: vpn_1.VpnType.WireGuard,
             deleteAfter: 1
         });
     });
-    it('Should set maxPeanuts to the validPeanutsConfig maximum when undefined', async () => {
+    it('Should set maxPeanuts to -1 when undefined', async () => {
         const validatedConfig = (0, vpn_1.checkValidConfig)('userId', 2, {
             maxPeanutsFieldMinValue: 0,
             maxPeanutsFieldMaxValue: 1,
@@ -167,11 +167,35 @@ describe('Testing vpn config', () => {
             deleteAfter: 1
         });
         expect(validatedConfig).toEqual({
-            maxPeanuts: 1,
+            maxPeanuts: -1,
             type: vpn_1.VpnType.WireGuard,
             deleteAfter: 1
         });
     });
+    it('Should shout when currentBalance is negative', async () => {
+        expect(() => (0, vpn_1.checkValidConfig)('userId', -1, {
+            maxPeanutsFieldMinValue: 2,
+            maxPeanutsFieldMaxValue: 3,
+            deleteAfterFieldMinValue: 1,
+            deleteAfterFieldMaxValue: 3,
+        }, {
+            maxPeanuts: -1,
+            type: vpn_1.VpnType.WireGuard,
+            deleteAfter: 1
+        })).toThrow(new errors_1.NegativeBalanceError(-1));
+    });
+    it('Should shout when currentBalance is zero', async () => {
+        expect(() => (0, vpn_1.checkValidConfig)('userId', 0, {
+            maxPeanutsFieldMinValue: 2,
+            maxPeanutsFieldMaxValue: 3,
+            deleteAfterFieldMinValue: 1,
+            deleteAfterFieldMaxValue: 3,
+        }, {
+            maxPeanuts: -1,
+            type: vpn_1.VpnType.WireGuard,
+            deleteAfter: 1
+        })).toThrow(new errors_1.NegativeBalanceError(0));
+    });
     it('Should shout when maxPeanuts is Infinity', async () => {
         expect(() => (0, vpn_1.checkValidConfig)('userId', 2, {
             maxPeanutsFieldMinValue: 2,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-common",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Common library for all MyTmpVpn related projects",
   "types": "dist/index.d.ts",
   "files": [
@@ -36,7 +36,7 @@
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "eslint": "^8.57.1",
     "eslint-config-standard-with-typescript": "^37.0.0",
-    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.6.0",
     "jest": "^27.5.1",