@mytmpvpn/mytmpvpn-common 2.0.0 → 2.1.1

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

@@ -31,4 +31,5 @@ interface Vpn {
 declare function getVpnConfigTypes(): VpnType[];
 declare function newVpn(region: string, config: VpnConfig, state: VpnState): Vpn;
 declare function getVpnFrom(vpnId: string, state: VpnState, config: VpnConfig): Vpn;
-export { VpnState, type VpnMetrics, VpnType, type VpnConfig, type Vpn, rank, newVpn, getVpnFrom, getVpnConfigTypes };
+declare function vpnIdToWgFileName(vpnId: string): string;
+export { VpnState, type VpnMetrics, VpnType, type VpnConfig, type Vpn, rank, newVpn, getVpnFrom, getVpnConfigTypes, vpnIdToWgFileName };

package/dist/src/models/vpn.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVpnConfigTypes = exports.getVpnFrom = exports.newVpn = exports.rank = exports.VpnType = exports.VpnState = void 0;
+exports.vpnIdToWgFileName = exports.getVpnConfigTypes = exports.getVpnFrom = exports.newVpn = exports.rank = exports.VpnType = exports.VpnState = void 0;
 var VpnState;
 (function (VpnState) {
     VpnState["Failed"] = "Failed";
@@ -29,10 +29,21 @@ function getVpnConfigTypes() {
     });
 }
 exports.getVpnConfigTypes = getVpnConfigTypes;
+function throwIfNotValidVpnId(vpnId) {
+    // e.g: YYYYMMDDHHmmssmss@az-test-7
+    if (!/\d{4}[01]\d[0-3]\d[0-2]\d[0-5]\d[0-5]\d\d{3}@[a-z]{2}-[a-z]+-\d/.test(vpnId)) {
+        throw new Error(`Incorrect vpnId: \'${vpnId}\'`);
+    }
+}
 function newVpn(region, config, state) {
+    // e.g: ap-northeast-3
+    if (!/[a-z]{2}-[a-z]+-[1-9]+/.test(region)) {
+        throw new Error(`Incorrect region: \'${region}\'`);
+    }
     const createdAt = new Date();
-    // Replace ':' in the id as it's forbiden in DDB
     const vpnId = `${dateToId(createdAt)}@${region}`;
+    // Assert we will be able to deserialize later on...
+    throwIfNotValidVpnId(vpnId);
     return {
         vpnId,
         createdAt,
@@ -43,9 +54,10 @@ function newVpn(region, config, state) {
 }
 exports.newVpn = newVpn;
 function getVpnFrom(vpnId, state, config) {
+    throwIfNotValidVpnId(vpnId);
     const tokens = vpnId.split('@');
     if (tokens.length !== 2) {
-        throw new Error(`Bad vpnId format: ${vpnId}`);
+        throw new Error(`Incorrect vpnId: ${vpnId}`);
     }
     /* eslint-disable @typescript-eslint/no-non-null-assertion */
     const createdAt = idToDate(tokens[0]);
@@ -79,3 +91,60 @@ function idToDate(id) {
     const millis = id.substring(14);
     return new Date(`${year}-${month}-${day}T${hour}:${minute}:${second}.${millis}Z`);
 }
+// The WireGuard Mobile Application has requirements for the wireguard configuration file:
+// 1. must have extension '.conf'
+// 2. file name must match the following regexp: "[a-zA-Z0-9_=+.-]{1,15}")
+// https://git.zx2c4.com/wireguard-android/tree/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java#n19
+// This function is to transform from vpnIn to Wireguard mobile application requirements
+function vpnIdToWgFileName(vpnId) {
+    throwIfNotValidVpnId(vpnId);
+    // The vpnId is made of YYYYMMDDHHmmssmss@region
+    // Let's keep it simple: vpn is mostly temporary, so keeping 
+    // the year is useless. 
+    // Also the milliseconds are useless.
+    // Finally, the region itself is of the following format: ap-northeast-3
+    // We can compressing with something like:
+    // MMDDHHmmssapne3.conf
+    const ddhhmmss = vpnId.substring(4, 14);
+    const seps = vpnId.substring(18).split(/-/);
+    const ccld = seps[0];
+    let location;
+    switch (seps[1]) {
+        case 'north':
+            location = 'n';
+            break;
+        case 'northeast':
+            location = 'ne';
+            break;
+        case 'east':
+            location = 'e';
+            break;
+        case 'southeast':
+            location = 'se';
+            break;
+        case 'south':
+            location = 's';
+            break;
+        case 'southwest':
+            location = 'sw';
+            break;
+        case 'west':
+            location = 'w';
+            break;
+        case 'northwest':
+            location = 'nw';
+            break;
+        case 'central':
+            location = 'c';
+            break;
+        default:
+            '';
+            break;
+    }
+    const number = seps[2];
+    // Let's make sure the end file is of 15 char max
+    const result = `${ddhhmmss}${ccld}${location}${number}`.substring(0, 15);
+    console.log(`Transforming ${vpnId} to ${result}`);
+    return result;
+}
+exports.vpnIdToWgFileName = vpnIdToWgFileName;

package/dist/test/models.test.js

@@ -11,3 +11,55 @@ describe('Testing VpnState', () => {
         expect((0, vpn_1.rank)(vpn_1.VpnState.Deprovisioning) <= (0, vpn_1.rank)(vpn_1.VpnState.Deleted)).toBe(true);
     });
 });
+describe('Testing Vpn constructors', () => {
+    it('Should shout when regions is empty', async () => {
+        expect(() => (0, vpn_1.newVpn)('', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created))
+            .toThrow(new Error("Incorrect region: \'\'"));
+    });
+    it('Should shout when regions is bad format', async () => {
+        expect(() => (0, vpn_1.newVpn)('foo', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created))
+            .toThrow(new Error("Incorrect region: \'foo\'"));
+    });
+    it('Should create vpn with all fields set', async () => {
+        const vpn = (0, vpn_1.newVpn)('az-test-7', { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }, vpn_1.VpnState.Created);
+        expect(vpn.createdAt).toBeDefined();
+        expect(vpn.region).toEqual('az-test-7');
+        expect(vpn.state).toEqual(vpn_1.VpnState.Created);
+        expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard });
+        expect(vpn.vpnId).toBeDefined();
+    });
+    it('Should deserialize a vpn with all fields set', async () => {
+        const vpn = (0, vpn_1.getVpnFrom)('20030902012345678@az-test-7', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard });
+        expect(vpn.createdAt).toEqual(new Date('2003-09-02T01:23:45.678Z'));
+        expect(vpn.region).toEqual('az-test-7');
+        expect(vpn.state).toEqual(vpn_1.VpnState.Created);
+        expect(vpn.config).toEqual({ maxPeanuts: -1, type: vpn_1.VpnType.WireGuard });
+        expect(vpn.vpnId).toBeDefined();
+    });
+    it('Should shout when vpnId is empty', async () => {
+        expect(() => (0, vpn_1.getVpnFrom)('', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }))
+            .toThrow(new Error("Incorrect vpnId: \'\'"));
+    });
+    it('Should shout when vpnId has bad format', async () => {
+        expect(() => (0, vpn_1.getVpnFrom)('foo', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }))
+            .toThrow(new Error("Incorrect vpnId: \'foo\'"));
+    });
+    it('Should shout when vpnId does not hold a region in good format', async () => {
+        expect(() => (0, vpn_1.getVpnFrom)('20030902012345678@test', vpn_1.VpnState.Created, { maxPeanuts: -1, type: vpn_1.VpnType.WireGuard }))
+            .toThrow(new Error("Incorrect vpnId: \'20030902012345678@test\'"));
+    });
+});
+describe('Testing vpnId to Wireguard file name functions ', () => {
+    it('Should shout when vpnId is empty', async () => {
+        expect(() => (0, vpn_1.vpnIdToWgFileName)(''))
+            .toThrow(new Error("Incorrect vpnId: \'\'"));
+    });
+    it('Should shout when vpnId is bad format', async () => {
+        expect(() => (0, vpn_1.vpnIdToWgFileName)('foo'))
+            .toThrow(new Error("Incorrect vpnId: \'foo\'"));
+    });
+    it('Should shout when region has bad format', async () => {
+        expect(() => (0, vpn_1.vpnIdToWgFileName)('20030902012345678@test'))
+            .toThrow(new Error("Incorrect vpnId: \'20030902012345678@test\'"));
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-common",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Common library for all MyTmpVpn related projects",
   "types": "dist/index.d.ts",
   "files": [