core-3nweb-client-lib 0.53.0 → 0.53.2

package/build/api-defs/web3n.d.ts

@@ -82,6 +82,11 @@ declare namespace web3n {
 		 * domain in the address.
 		 */
 		noServiceRecord?: true;
+
+		/**
+		 * malformedRecord flag indicates that 3NWeb service value is malformed.
+		 */
+		malformedRecord?: true;
 	}
 
 	interface EncryptionException {

package/build/lib-client/networks.d.ts

@@ -1,7 +1,8 @@
 import { NetClient, RequestFn, OpenServiceEventsSource } from './request-utils';
 import { LogError } from './logging/log-to-file';
 export type ServiceTypeDNSLabel = 'mailerid' | 'asmail' | '3nstorage';
-export type ServiceLocatorMaker = (serviceLabel: ServiceTypeDNSLabel | 'report', logError: LogError) => ServiceLocator;
+export type DNSLabel = ServiceTypeDNSLabel | 'report' | 'w3nApp';
+export type ServiceLocatorMaker = (serviceLabel: DNSLabel, logError: LogError) => ServiceLocator;
 export type ServiceLocator = (address: string) => Promise<string>;
 export interface DnsResolver {
     resolveTxt: (hostname: string) => Promise<string[][]>;

package/build/lib-client/networks.js

@@ -34,16 +34,15 @@ function domainOfAddress(address) {
         return address.substring(indOfAt + 1);
     }
 }
-function checkAndPrepareURL(value) {
-    // XXX insert some value sanity check
-    return 'https://' + value;
-}
 function domainNotFoundExc(address, cause) {
     return (0, runtime_1.makeRuntimeException)('service-locating', { address, cause }, { domainNotFound: true });
 }
 function noServiceRecordExc(address) {
     return (0, runtime_1.makeRuntimeException)('service-locating', { address }, { noServiceRecord: true });
 }
+function noMalformedRecordExc(address) {
+    return (0, runtime_1.makeRuntimeException)('service-locating', { address }, { malformedRecord: true });
+}
 function noConnectionExc(cause) {
     return (0, runtime_1.makeRuntimeException)('connect', {
         connectType: 'dns',
@@ -94,7 +93,8 @@ const recordsStarts = {
     "3nstorage": '3nstorage=',
     asmail: 'asmail=',
     mailerid: 'mailerid=',
-    report: 'report='
+    report: 'report=',
+    w3nApp: 'w3n-app='
 };
 function getRecordAtStartOf(txt) {
     let service = undefined;
@@ -147,23 +147,6 @@ exports.TIMEOUT = "ETIMEOUT";
 // export const LOADIPHLPAPI = "ELOADIPHLPAPI";
 // export const ADDRGETNETWORKPARAMS = "EADDRGETNETWORKPARAMS";
 // export const CANCELLED = "ECANCELLED";
-// XXX
-//  - service exist in network.
-//  - we go from name to address to service location in a network, and a request function ?
-//    Or, should we assume that request function will engage with proper network, based on location,
-//    implying that location string should always map to one network: regular | tor | i2p.
-//    Implicit rule allows us not to force making request fn here, as well as naming system in one net,
-//    pointing to another. bank.xyz can be served by server <key>.onion, and vice versa.
-//
-//  - this function, ... doesn't have to change, as DnsResolver is given. May be  we should make a more
-//    general wrap, that gonna use this for DNS in regular net?
-//  - and, we may probably want to make function here as a reusable wrapper around different network request fns.
-//    Regular net request, may internally switch into proxy/hidding modes. Other networks provide anonymity,
-//    hence, these additional options should stay "inside" regular network request fn.
-//
-//  - should we have a reusable wrapper creator here, creating coherent pair of naming and request functions.
-//    Cause, if embedding doesn't have explicit implementation for Tor, both initial naming and net-maker functions
-//    should be coherent.
 const onionTLD = '.onion';
 const i2pTLD = '.i2p';
 function makeMissingImplementationException(networkType, location) {
@@ -269,12 +252,7 @@ function makeServiceLocatorInDNS(...resolvers) {
             }
             const recValue = extractPair(txtRecords, serviceLabel);
             if (recValue) {
-                if (serviceLabel === 'report') {
-                    return recValue;
-                }
-                else {
-                    return checkAndPrepareURL(recValue);
-                }
+                return postProcessValueFromDNS(serviceLabel, recValue, address);
             }
             else {
                 exc !== null && exc !== void 0 ? exc : (exc = noServiceRecordExc(address));
@@ -284,6 +262,24 @@ function makeServiceLocatorInDNS(...resolvers) {
     }
     return locateInDNS;
 }
+function postProcessValueFromDNS(serviceLabel, recordValue, address) {
+    switch (serviceLabel) {
+        case 'report':
+            return recordValue;
+        default:
+            return checkAndPrepareURLfromDNS(recordValue, address);
+    }
+}
+function checkAndPrepareURLfromDNS(value, address) {
+    value = `https://${value}`;
+    try {
+        new URL(value);
+        return value;
+    }
+    catch (err) {
+        throw noMalformedRecordExc(address);
+    }
+}
 const wellKnownPath = '/.well-known/3nweb.json';
 async function locateInWellKnown(request, address, serviceLabel) {
     const host = domainOfAddress(address);
@@ -295,12 +291,7 @@ async function locateInWellKnown(request, address, serviceLabel) {
         if (reply.status === 200) {
             const recValue = reply.data[serviceLabel];
             if (recValue) {
-                if (serviceLabel === 'report') {
-                    return recValue;
-                }
-                else {
-                    return checkAndPrepareURL(recValue);
-                }
+                return recValue;
             }
             else {
                 throw noServiceRecordExc(address);

package/build/lib-client/user-with-mid-session.js

@@ -29,7 +29,9 @@ class ServiceUser {
     set serviceURI(uriString) {
         const u = new URL(uriString);
         if (u.protocol !== 'https:') {
-            throw new Error("Url protocol must be https.");
+            if (!u.hostname.endsWith('.onion')) {
+                throw new Error("Url protocol must be https.");
+            }
         }
         if (!u.host) {
             throw new Error("Host name is missing.");
@@ -195,8 +197,14 @@ class ServiceUser {
     prepCallOpts(opts, isWS) {
         opts.sessionId = this.sessionId;
         if (opts.appPath) {
-            opts.url = (isWS ?
-                `wss${this.serviceURI.substring(5)}${opts.appPath}` : `${this.serviceURI}${opts.appPath}`);
+            if (isWS) {
+                const columnInd = this.serviceURI.indexOf(':');
+                const h = this.serviceURI.substring(0, columnInd);
+                opts.url = `${(h === 'https') ? 'wss' : 'ws'}${this.serviceURI.substring(columnInd)}${opts.appPath}`;
+            }
+            else {
+                opts.url = `${this.serviceURI}${opts.appPath}`;
+            }
         }
         else if (!opts.url) {
             throw new Error(`Missing both appPath and ready url in request options.`);

package/build/lib-client/user-with-pkl-session.d.ts

@@ -24,7 +24,7 @@ export declare abstract class ServiceUser {
     sessionId: string | undefined;
     private uri;
     get serviceURI(): string;
-    set serviceURI(uriString: string);
+    protected set serviceURI(uriString: string);
     private loginUrlPart;
     private logoutUrlEnd;
     private redirectedFrom;

package/build/lib-client/user-with-pkl-session.js

@@ -30,7 +30,9 @@ class ServiceUser {
     set serviceURI(uriString) {
         const u = new URL(uriString);
         if (u.protocol !== 'https:') {
-            throw new Error("Url protocol must be https.");
+            if (!u.hostname.endsWith('.onion')) {
+                throw new Error("Url protocol must be https.");
+            }
         }
         if (!u.host) {
             throw new Error("Host name is missing.");

package/build/lib-common-on-node/websocket-from-node.d.ts

@@ -1,11 +1,3 @@
-import { ConnectionStatus, RequestOpts } from '../lib-client/request-utils';
-import { type Envelope, type RawDuplex } from '../lib-common/ipc/generic-ipc';
-type Observer<T> = web3n.Observer<T>;
-export declare function openServiceEventsSrcFromNode(req: RequestOpts): Promise<{
-    status: number;
-    data: {
-        comm: RawDuplex<Envelope>;
-        watch: (obs: Observer<ConnectionStatus>) => (() => void);
-    };
-}>;
-export {};
+import { OpenServiceEventsSource } from '../lib-client/request-utils';
+import { Agent } from 'https';
+export declare function makeServiceEventsSourceFromNode(getAgent?: () => Agent | undefined): OpenServiceEventsSource;

package/build/lib-common-on-node/websocket-from-node.js

@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openServiceEventsSrcFromNode = openServiceEventsSrcFromNode;
+exports.makeServiceEventsSourceFromNode = makeServiceEventsSourceFromNode;
 const WebSocket = require("ws");
 const request_utils_1 = require("../lib-client/request-utils");
 const deferred_1 = require("../lib-common/processes/deferred");
@@ -25,22 +25,24 @@ const https_1 = require("https");
 const generic_ipc_1 = require("../lib-common/ipc/generic-ipc");
 const ws_ipc_1 = require("../lib-common/ipc/ws-ipc");
 const rxjs_1 = require("rxjs");
-async function openServiceEventsSrcFromNode(req) {
-    const { url, sessionId } = req;
-    const rep = await openSocketFromNode(url, sessionId);
-    if (rep.status !== 200) {
-        return rep;
-    }
-    const { comm, heartbeat } = makeJsonCommPoint(rep.data);
-    return {
-        status: rep.status,
-        data: {
-            comm,
-            watch: obs => {
-                const sub = heartbeat.subscribe(obs);
-                return () => sub.unsubscribe();
-            }
+function makeServiceEventsSourceFromNode(getAgent) {
+    return async function openServiceEventsSrcFromNode(req) {
+        const { url, sessionId } = req;
+        const rep = await openSocketFromNode(url, sessionId, getAgent);
+        if (rep.status !== 200) {
+            return rep;
         }
+        const { comm, heartbeat } = makeJsonCommPoint(rep.data);
+        return {
+            status: rep.status,
+            data: {
+                comm,
+                watch: obs => {
+                    const sub = heartbeat.subscribe(obs);
+                    return () => sub.unsubscribe();
+                }
+            }
+        };
     };
 }
 const MAX_TXT_BUFFER = 64 * 1024;
@@ -156,13 +158,12 @@ function makeHeartbeat(url) {
         otherBeat
     };
 }
-function openSocketFromNode(url, sessionId) {
-    if (!url.startsWith('wss://')) {
-        throw new Error(`Url protocol must be wss`);
-    }
+function openSocketFromNode(url, sessionId, getAgent) {
+    var _a;
+    ensureWebSocketUrlOK(url);
     const headers = {};
     headers[request_utils_1.SESSION_ID_HEADER] = sessionId;
-    const ws = new WebSocket(url, { headers, agent: https_1.globalAgent });
+    const ws = new WebSocket(url, { headers, agent: (_a = getAgent === null || getAgent === void 0 ? void 0 : getAgent()) !== null && _a !== void 0 ? _a : https_1.globalAgent });
     let opening = (0, deferred_1.defer)();
     const initOnError = (err) => {
         opening === null || opening === void 0 ? void 0 : opening.reject((0, http_1.makeConnectionException)(url, undefined, `WebSocket connection error: ${err.message}`));
@@ -193,4 +194,12 @@ function openSocketFromNode(url, sessionId) {
     });
     return opening.promise;
 }
+function ensureWebSocketUrlOK(href) {
+    const url = new URL(href);
+    if (url.protocol === 'ws:') {
+        if (!url.hostname.endsWith('.onion')) {
+            throw new Error(`Url protocol must be wss`);
+        }
+    }
+}
 Object.freeze(exports);

package/build/tests/libs-for-tests/core-runner.js

@@ -63,6 +63,7 @@ exports.testApp = {
 let numOfRunningCores = 0;
 const DATA_FOLDER = (0, path_1.join)(__dirname, '..', '..', '..', 'test-data');
 function resolveTxt(domain) {
+    // used non-promise dns method mocked for test data, hence, we use it here
     return new Promise((resolve, reject) => (0, dns_1.resolveTxt)(domain, (err, records) => {
         if (err) {
             reject(err);
@@ -74,7 +75,7 @@ function resolveTxt(domain) {
 }
 const { makeLocator, makeNet } = (0, networks_1.wrapNetworkFns)({ regular: {
         naming: [{ resolveTxt }],
-        openServiceEventsSource: websocket_from_node_1.openServiceEventsSrcFromNode,
+        openServiceEventsSource: (0, websocket_from_node_1.makeServiceEventsSourceFromNode)(),
         requests: (0, request_from_node_1.makeRequestFromNode)()
     } });
 class CoreRunner {

package/build/tests/libs-for-tests/setups.js

@@ -262,7 +262,7 @@ function domainFromUserId(userId) {
 function serviceWithMailerIdLogin() {
     const testSrv = (new URL(SIGNUP_URL)).host;
     const serviceUrl = `https://${testSrv}/asmail/retrieval/login/mailerid`;
-    const net = (0, request_utils_1.makeNetClient)((0, request_from_node_1.makeRequestFromNode)(), websocket_from_node_1.openServiceEventsSrcFromNode);
+    const net = (0, request_utils_1.makeNetClient)((0, request_from_node_1.makeRequestFromNode)(), (0, websocket_from_node_1.makeServiceEventsSourceFromNode)());
     async function isSessionValid(sessionId) {
         const rep = await net.doBodylessRequest({
             url: `https://${testSrv}/asmail/retrieval/${retrieval_1.listMsgs.genUrlEnd()}`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.53.0",
+  "version": "0.53.2",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",