spec-3nweb-server 1.8.8 → 1.8.10

package/build/asmail/resources/inbox.d.ts

@@ -33,9 +33,9 @@ export interface InboxParams {
     "authenticated/invites": AuthSenderInvites;
 }
 export declare class Inbox extends UserFiles<InboxParams> {
-    private metas;
-    private objFiles;
     private mailEventsSink;
+    private readonly metas;
+    private readonly objFiles;
     constructor(userId: string, path: string, mailEventsSink: MailEventsSink, writeBufferSize?: string | number, readBufferSize?: string | number);
     static make(userFolder: string, userId: string, mailEventsSink: MailEventsSink, writeBufferSize?: string | number, readBufferSize?: string | number): Promise<Inbox>;
     /**

package/build/asmail/resources/inbox.js

@@ -85,9 +85,9 @@ async function genMsgIdAndMakeFolder(delivPath, msgsFolder) {
 class Inbox extends user_files_1.UserFiles {
     constructor(userId, path, mailEventsSink, writeBufferSize, readBufferSize) {
         super(userId, path, writeBufferSize, readBufferSize);
+        this.mailEventsSink = mailEventsSink;
         this.metas = new MsgMetas(5 * 60 * 1000, (0, path_1.join)(this.path, 'delivery'), (0, path_1.join)(this.path, 'messages'));
         this.objFiles = new ObjFiles(5 * 60 * 1000, this.metas.deliveryFolder, this.metas.readyMsgsFolder);
-        this.mailEventsSink = mailEventsSink;
         Object.freeze(this);
     }
     static async make(userFolder, userId, mailEventsSink, writeBufferSize, readBufferSize) {

package/build/config/from-yaml.js

@@ -23,7 +23,7 @@ const default_confs_1 = require("./default-confs");
 function readYamlConfFile(path) {
     const txt = (0, fs_1.readFileSync)(path, 'utf8');
     const conf = yaml.load(txt);
-    if (conf.rootFolder) {
+    if (!conf.rootFolder) {
         conf.rootFolder = default_confs_1.DEFAULT_DATA_ROOT_PATH;
     }
     return conf;

package/build/lib-common/canonical-address.js

@@ -17,7 +17,7 @@
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkAndTransformAddress = exports.areAddressesEqual = exports.toCanonicalAddress = void 0;
-const punycode_1 = require("punycode");
+const punycode_1 = require("punycode/");
 /**
  * @param address
  * @return a canonical form of a given address.

package/build/main.js

@@ -24,6 +24,7 @@ const lib_1 = require("./lib");
 const signup_1 = require("./config/signup");
 const default_confs_1 = require("./config/default-confs");
 const file_1 = require("./lib-common/exceptions/file");
+const qrcode = require("qrcode-terminal");
 async function run(conf) {
     if (!conf.servicesConnect) {
         console.error(`❌ No connection settings found in configuration.`);
@@ -142,6 +143,7 @@ async function displaySignupInfo(conf) {
             const signupLink = signupLinkFrom(conf, undefined);
             if (signupLink) {
                 console.log(`Signup link:\n`, signupLink, `\n`);
+                displayAsQR(signupLink);
             }
         }
         else {
@@ -155,6 +157,10 @@ async function displaySignupInfo(conf) {
     console.log(`There are ${multiUserTokens.length} multi-user tokens.\n`);
     console.log(`There are ${singleUserTokens.length} single-user tokens.\n`);
 }
+function displayAsQR(str) {
+    qrcode.setErrorLevel('Q');
+    qrcode.generate(str, { small: true });
+}
 async function displayTokensList(conf) {
     const { multiUserTokens, singleUserTokens } = await (0, signup_1.readAllSignupTokens)(conf.rootFolder);
     if (multiUserTokens.length > 0) {
@@ -181,10 +187,6 @@ async function displayTokensList(conf) {
 async function displayTokenValue(conf, tokenId) {
     const ctx = await (0, signup_1.readTokenFile)(conf.rootFolder, tokenId);
     if (ctx) {
-        const signupLink = signupLinkFrom(conf, ctx.token);
-        if (signupLink) {
-            console.log(`\nSignup link:\n  ${signupLink}`);
-        }
         if (ctx.type === 'multi-domain') {
             console.log(`\nMulti-user signup context:`);
             console.log(`  domains:`, ctx.domains);
@@ -201,6 +203,11 @@ async function displayTokenValue(conf, tokenId) {
                 console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}`);
             }
         }
+        const signupLink = signupLinkFrom(conf, ctx.token);
+        if (signupLink) {
+            console.log(`\nSignup link:\n  ${signupLink}`);
+            displayAsQR(signupLink);
+        }
         console.log(``);
     }
     else {
@@ -241,6 +248,12 @@ async function createSingleUserToken(conf, userId) {
     console.log(``);
 }
 const cmd = (0, cli_1.parseProcessArgv)();
+process.on('unhandledRejection', (err, p) => {
+    console.error(' -- Unhandled rejection of promise:', err);
+});
+process.on('uncaughtException', err => {
+    console.error(' -- Unhandled exception:', err);
+});
 if (cmd.runCmd) {
     const conf = assembleConfig(cmd.runCmd.config);
     run(conf);

package/build/tests/protocols/asmail/retrieval/specs/events.js

@@ -33,6 +33,7 @@ exports.specs.definition = (setup) => (() => {
     let deliveryUrl;
     let user1;
     let sessionId;
+    let session2;
     (0, async_jasmine_1.beforeEachAsync)(async () => {
         asmailServer = setup().asmailServer;
         const retrievalUrl = await asmailServer.getRetrievalUrl();
@@ -40,23 +41,33 @@ exports.specs.definition = (setup) => (() => {
         deliveryUrl = await asmailServer.getDeliveryUrl();
         user1 = setup().user1;
         sessionId = await (0, test_utils_1.startSession)(user1, retrievalUrl);
+        session2 = await (0, test_utils_1.startSession)(user1, retrievalUrl);
     });
     (0, async_jasmine_1.itAsync)(`requires session to open web socket`, async () => {
         let rep = await (0, ws_utils_1.openSocket)(wsUrl, 'invalid session id');
         expect(rep.status).withContext('status for missing authorized session').toBe(retrieval_1.ERR_SC.needAuth);
     });
     (0, async_jasmine_1.itAsync)(`emits event on completion of message reception`, async () => {
-        let rep = await (0, ws_utils_1.openSocket)(wsUrl, sessionId);
-        expect(rep.status).toBe(retrieval_1.wsEventChannel.SC.ok);
-        const eventSrc = (0, ws_ipc_1.makeSubscriber)(rep.data, undefined);
-        const eventPromise = rxjs_1.Observable.create(obs => eventSrc.subscribe(retrieval_1.msgRecievedCompletely.EVENT_NAME, obs))
-            .take(1)
-            .toPromise();
+        globalThis.logTest = true;
+        function subscribeAndWaitInSession(rep) {
+            expect(rep.status).toBe(retrieval_1.wsEventChannel.SC.ok);
+            const eventSrc = (0, ws_ipc_1.makeSubscriber)(rep.data, undefined);
+            return rxjs_1.Observable.create(obs => eventSrc.subscribe(retrieval_1.msgRecievedCompletely.EVENT_NAME, obs))
+                .take(1)
+                .toPromise();
+        }
+        const eventPromises = [
+            subscribeAndWaitInSession(await (0, ws_utils_1.openSocket)(wsUrl, sessionId)),
+            subscribeAndWaitInSession(await (0, ws_utils_1.openSocket)(wsUrl, session2)),
+        ];
         // give some time for subscription to occur
         await (0, processes_1.sleep)(10);
         const msgId = await (0, test_utils_1.sendMsg)(deliveryUrl, user1.id, test_utils_1.msg);
-        const event = await eventPromise;
-        expect(typeof event).toBe('object');
-        expect(event.msgId).withContext(`message reception completion event should give a respective message id`).toBe(msgId);
+        for (const eventPromise of eventPromises) {
+            const event = await eventPromise;
+            expect(typeof event).toBe('object');
+            expect(event.msgId).withContext(`message reception completion event should give a respective message id`).toBe(msgId);
+        }
+        globalThis.logTest = false;
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.8.8",
+  "version": "1.8.10",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",
@@ -41,7 +41,8 @@
     "express": "^4.22.2",
     "js-yaml": "^4.3.0",
     "prompts": "^2.4.2",
-    "punycode": "^2.1.1",
+    "punycode": "^2.3.1",
+    "qrcode-terminal": "^0.12.0",
     "ws": "^7.5.11",
     "xsp-files": "^2.0.0"
   },
@@ -49,6 +50,7 @@
     "@types/express": "4.17.13",
     "@types/jasmine": "^3.9.1",
     "@types/node": "^16.11.7",
+    "@types/punycode": "^2.1.4",
     "@types/ws": "^4.0.0",
     "jasmine": "^3.9.0",
     "rxjs": "^5.3.0",

package/ts-code/asmail/resources/inbox.ts

@@ -56,8 +56,7 @@ type AuthSenderInvites = configApi.p.authSenderInvites.List;
 type AnonSenderInvites = configApi.p.anonSenderInvites.List;
 
 type MsgMeta = retrievalApi.MsgMeta;
-export type MsgEvents = retrievalApi.msgMainObjRecieved.Event |
-	retrievalApi.msgRecievedCompletely.Event;
+export type MsgEvents = retrievalApi.msgMainObjRecieved.Event | retrievalApi.msgRecievedCompletely.Event;
 
 export type MailEventsSink = (
 	userId: string, channel: string, event: MsgEvents
@@ -117,20 +116,16 @@ export interface InboxParams {
 
 export class Inbox extends UserFiles<InboxParams> {
 
-	private metas = new MsgMetas(
-		5*60*1000, join(this.path, 'delivery'), join(this.path, 'messages'));
+	private readonly metas = new MsgMetas(5*60*1000, join(this.path, 'delivery'), join(this.path, 'messages'));
 
-	private objFiles = new ObjFiles(
-		5*60*1000, this.metas.deliveryFolder, this.metas.readyMsgsFolder);
+	private readonly objFiles = new ObjFiles(5*60*1000, this.metas.deliveryFolder, this.metas.readyMsgsFolder);
 
-	private mailEventsSink: MailEventsSink;
-	
 	constructor(
-		userId: string, path: string, mailEventsSink: MailEventsSink,
+		userId: string, path: string,
+		private mailEventsSink: MailEventsSink,
 		writeBufferSize?: string|number, readBufferSize?: string|number
 	) {
 		super(userId, path, writeBufferSize, readBufferSize);
-		this.mailEventsSink = mailEventsSink;
 		Object.freeze(this);
 	}
 	
@@ -139,9 +134,7 @@ export class Inbox extends UserFiles<InboxParams> {
 		writeBufferSize?: string|number, readBufferSize?: string|number
 	): Promise<Inbox> {
 		const path = join(userFolder, 'mail');
-		const inbox = new Inbox(
-			userId, path, mailEventsSink, writeBufferSize, readBufferSize
-		);
+		const inbox = new Inbox(userId, path, mailEventsSink, writeBufferSize, readBufferSize);
 		await inbox.ensureUserExistsOnDisk();
 		return inbox;
 	}
@@ -285,9 +278,7 @@ export class Inbox extends UserFiles<InboxParams> {
 		this.objFiles.changeToReadingPathsInMsg(msgId);
 		
 		// raise event about completion of receiving a message
-		this.mailEventsSink(this.userId,
-			retrievalApi.msgRecievedCompletely.EVENT_NAME,
-			{ msgId });
+		this.mailEventsSink(this.userId, retrievalApi.msgRecievedCompletely.EVENT_NAME, { msgId });
 	}
 
 	private areAllMsgObjsComplete(

package/ts-code/asmail/resources/recipients.ts

@@ -317,9 +317,7 @@ export function makeRecipients(
 			}
 		} else {
 			const userFolder = userDataInRootFolder(rootFolder, userId);
-			inbox = await Inbox.make(
-				userFolder, userId, mailEventsSink, writeBufferSize, readBufferSize
-			);
+			inbox = await Inbox.make(userFolder, userId, mailEventsSink, writeBufferSize, readBufferSize);
 			boxes.set(userId, inbox);
 			return inbox;
 		}

package/ts-code/config/from-yaml.ts

@@ -24,7 +24,7 @@ export function readYamlConfFile(path: string): Configurations {
 	const txt = readFileSync(path, 'utf8');
 	const conf = yaml.load(txt) as Configurations;
 
-	if (conf.rootFolder) {
+	if (!conf.rootFolder) {
 		conf.rootFolder = DEFAULT_DATA_ROOT_PATH;
 	}
 

package/ts-code/lib-common/canonical-address.ts

@@ -15,7 +15,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
-import { toASCII } from 'punycode';
+import { toASCII } from 'punycode/';
 
 /**
  * @param address

package/ts-code/main.ts

@@ -29,6 +29,7 @@ import { Configurations, servicesApp, accountsApp, AppWithWSs } from './lib';
 import { addMultiDomainSignup, addSingleUserSignup, readAllSignupTokens, readNoTokensFile, readTokenFile } from './config/signup';
 import { DEFAULT_CONFIG_PATH } from './config/default-confs';
 import { Code } from './lib-common/exceptions/file';
+import * as qrcode from 'qrcode-terminal';
 
 async function run(conf: Configurations): Promise<void> {
 
@@ -159,6 +160,7 @@ async function displaySignupInfo(conf: Configurations): Promise<void> {
 			const signupLink = signupLinkFrom(conf, undefined);
 			if (signupLink) {
 				console.log(`Signup link:\n`, signupLink, `\n`);
+				displayAsQR(signupLink);
 			}
 		} else {
 			console.log(`Signup of users is allowed only with valid signup tokens.\n`);
@@ -174,6 +176,11 @@ async function displaySignupInfo(conf: Configurations): Promise<void> {
 	console.log(`There are ${singleUserTokens.length} single-user tokens.\n`);
 }
 
+function displayAsQR(str: string): void {
+	qrcode.setErrorLevel('Q');
+	qrcode.generate(str, { small: true });
+}
+
 async function displayTokensList(conf: Configurations): Promise<void> {
 	const {
 		multiUserTokens, singleUserTokens
@@ -203,10 +210,6 @@ async function displayTokenValue(
 ): Promise<void> {
 	const ctx = await readTokenFile(conf.rootFolder, tokenId);
 	if (ctx) {
-		const signupLink = signupLinkFrom(conf, ctx.token);
-		if (signupLink) {
-			console.log(`\nSignup link:\n  ${signupLink}`);
-		}
 		if (ctx.type === 'multi-domain') {
 			console.log(`\nMulti-user signup context:`);
 			console.log(`  domains:`, ctx.domains);
@@ -222,6 +225,11 @@ async function displayTokenValue(
 				console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}`);
 			}
 		}
+		const signupLink = signupLinkFrom(conf, ctx.token);
+		if (signupLink) {
+			console.log(`\nSignup link:\n  ${signupLink}`);
+			displayAsQR(signupLink);
+		}
 		console.log(``);
 	} else {
 		console.error(`Token ${tokenId} is not found.`);
@@ -269,6 +277,13 @@ async function createSingleUserToken(
 
 const cmd = parseProcessArgv();
 
+process.on('unhandledRejection', (err, p) => {
+	console.error(' -- Unhandled rejection of promise:', err);
+});
+process.on('uncaughtException', err => {
+	console.error(' -- Unhandled exception:', err);
+});
+
 if (cmd.runCmd) {
 	const conf = assembleConfig(cmd.runCmd.config!);
 	run(conf);

package/ts-code/tests/libs-for-tests/ws-utils.ts

@@ -22,8 +22,7 @@ import { defer } from '../../lib-common/processes';
 import { makeConnectionException } from '../../lib-common/exceptions/http';
 import { globalAgent as agent } from 'https';
 
-export function openSocket(url: string, sessionId: string):
-		Promise<Reply<WebSocket>> {
+export function openSocket(url: string, sessionId: string): Promise<Reply<WebSocket>> {
 	if (!url.startsWith('wss://')) { throw new Error(
 		`Url protocol must be wss`); }
 	const headers: any = {};

package/ts-code/tests/protocols/asmail/retrieval/specs/events.ts

@@ -34,6 +34,7 @@ specs.definition = (setup: () => TestSetup) => (() => {
 	let deliveryUrl: string;
 	let user1: User;
 	let sessionId: string;
+	let session2: string;
 
 	beforeEachAsync(async () => {
 		asmailServer = setup().asmailServer;
@@ -42,6 +43,7 @@ specs.definition = (setup: () => TestSetup) => (() => {
 		deliveryUrl = await asmailServer.getDeliveryUrl();
 		user1 = setup().user1;
 		sessionId = await startSession(user1, retrievalUrl);
+		session2 = await startSession(user1, retrievalUrl);
 	});
 	
 	itAsync(`requires session to open web socket`, async () => {
@@ -53,26 +55,39 @@ specs.definition = (setup: () => TestSetup) => (() => {
 	
 	itAsync(`emits event on completion of message reception`, async () => {
 
-		let rep = await openSocket(wsUrl, sessionId);
-		expect(rep.status).toBe(api.SC.ok);
-		
-		const eventSrc = makeSubscriber(rep.data, undefined);
+		globalThis.logTest = true;
+
+		function subscribeAndWaitInSession(rep: Awaited<ReturnType<typeof openSocket>>) {
+			expect(rep.status).toBe(api.SC.ok);
+			
+			const eventSrc = makeSubscriber(rep.data, undefined);
+
+			return (Observable.create(obs => eventSrc.subscribe<msgRecievedCompletely.Event>(
+				msgRecievedCompletely.EVENT_NAME, obs
+			)) as Observable<msgRecievedCompletely.Event>)
+			.take(1)
+			.toPromise();
+		}
 
-		const eventPromise = (Observable.create(
-			obs => eventSrc.subscribe<msgRecievedCompletely.Event>(
-			msgRecievedCompletely.EVENT_NAME, obs)) as Observable<msgRecievedCompletely.Event>)
-		.take(1)
-		.toPromise();
+		const eventPromises = [
+			subscribeAndWaitInSession(await openSocket(wsUrl, sessionId)),
+			subscribeAndWaitInSession(await openSocket(wsUrl, session2)),
+		];
 		
 		// give some time for subscription to occur
 		await sleep(10);
 		
 		const msgId = await sendMsg(deliveryUrl, user1.id, msg);
 
-		const event = await eventPromise;
-		expect(typeof event).toBe('object');
-		expect(event.msgId).withContext(`message reception completion event should give a respective message id`).toBe(msgId);
+		for (const eventPromise of eventPromises) {
+			const event = await eventPromise;
+			expect(typeof event).toBe('object');
+			expect(event.msgId).withContext(
+				`message reception completion event should give a respective message id`
+			).toBe(msgId);
+		}
 
+		globalThis.logTest = false;
 	});
 
 });