spec-3nweb-server 1.8.0 → 1.8.2

package/build/3nstorage/owner.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2017, 2022, 2024 3NSoft Inc.
+ Copyright (C) 2015 - 2017, 2022, 2024 - 2025 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -33,10 +33,10 @@ const archive_obj_version_1 = require("./routes/owner/archive-obj-version");
 const get_obj_status_1 = require("./routes/owner/get-obj-status");
 const api = require("../lib-common/service-api/3nstorage/owner");
 const mid_access_1 = require("../lib-server/mid-access");
+const WS_PING_PERIOD_MILLIS = 2 * 60 * 1000;
 function makeOwnerStorageApp(domain, sessions, users, midAuthorizer) {
     const app = new app_1.AppWithWSs();
-    const setupLoginRoutes = (app, urlPrefix) => (0, mid_access_1.addMailerIdLoginRoutes)(app, domain, urlPrefix, sessions, users.exists, midAuthorizer);
-    setHttpPart(app.http, setupLoginRoutes, sessions, users);
+    setHttpPart(app.http, domain, sessions, users, midAuthorizer);
     setWSPart(app, sessions, users);
     return app;
 }
@@ -55,7 +55,7 @@ function makeOwnerStorageForLocker(sessions, users) {
 }
 exports.makeOwnerStorageForLocker = makeOwnerStorageForLocker;
 function setWSPart(app, sessions, users) {
-    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart());
+    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart(), WS_PING_PERIOD_MILLIS);
     const storageEvents = new server_events_1.ServerEvents(undefined, api.events.all, sockets.socketGetter);
     // give events ipc to both ends
     sockets.addSocketIPC(storageEvents);
@@ -63,10 +63,10 @@ function setWSPart(app, sessions, users) {
     app.addWS(api.wsEventChannel.URL_END, sockets);
 }
 const MAX_CHUNK_SIZE = '0.5mb';
-function setHttpPart(app, setupLoginRoutes, sessions, users) {
+function setHttpPart(app, domain, sessions, users, midAuthorizer) {
     app.disable('etag');
     // Login
-    setupLoginRoutes(app, '/' + api.midLogin.URL_PART);
+    (0, mid_access_1.addMailerIdLoginRoutes)(app, domain, '/' + api.midLogin.URL_PART, sessions, users.exists, midAuthorizer);
     // *** Require authorized session for everything below ***
     app.use(sessions.ensureAuthorizedSession());
     app.post('/' + api.closeSession.URL_END, (0, body_parsers_1.emptyBody)(), (0, close_1.closeSession)());

package/build/asmail/retrieval.js

@@ -27,6 +27,7 @@ const remove_message_1 = require("./routes/retrieval/remove-message");
 const get_message_obj_1 = require("./routes/retrieval/get-message-obj");
 const api = require("../lib-common/service-api/asmail/retrieval");
 const mid_access_1 = require("../lib-server/mid-access");
+const WS_PING_PERIOD_MILLIS = 2 * 60 * 1000;
 function makeApp(domain, sessions, recipients, midAuthorizer) {
     const app = new app_1.AppWithWSs();
     setHttpPart(app.http, domain, sessions, recipients, midAuthorizer);
@@ -35,9 +36,8 @@ function makeApp(domain, sessions, recipients, midAuthorizer) {
 }
 exports.makeApp = makeApp;
 function setWSPart(app, sessions, recipients) {
-    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart());
-    const mailEvents = new server_events_1.ServerEvents(undefined, [api.msgRecievedCompletely.EVENT_NAME,
-        api.msgMainObjRecieved.EVENT_NAME], sockets.socketGetter);
+    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart(), WS_PING_PERIOD_MILLIS);
+    const mailEvents = new server_events_1.ServerEvents(undefined, [api.msgRecievedCompletely.EVENT_NAME, api.msgMainObjRecieved.EVENT_NAME], sockets.socketGetter);
     // give events ipc to both ends
     sockets.addSocketIPC(mailEvents);
     recipients.setMailEventsSink(mailEvents.eventsSink);

package/build/lib-common/ipc/generic-ipc.js

@@ -432,9 +432,9 @@ class EventsReceivingSide extends RequestingSide {
          * name, to which listener is attached.
          */
         this.listeners = new map_of_sets_1.MapOfSets();
-        this.channels = new IpcEventChannels((ipcChannel) => this.makeRequest(ipc_api_1.events.subscribe.REQ_NAME, ipcChannel)
-            .catch(err => this.completeEvent(ipcChannel, err)), (ipcChannel) => this.makeRequest(ipc_api_1.events.unsubscribe.REQ_NAME, ipcChannel)
-            .catch(err => { }));
+        this.channels = new IpcEventChannels(ipcChannel => this.makeRequest(ipc_api_1.events.subscribe.REQ_NAME, ipcChannel)
+            .catch(err => this.completeEvent(ipcChannel, err)), ipcChannel => this.makeRequest(ipc_api_1.events.unsubscribe.REQ_NAME, ipcChannel)
+            .catch(noop));
     }
     handleMsg(env) {
         if (env.type === 'event') {
@@ -581,6 +581,7 @@ class IpcEventChannels {
 }
 Object.freeze(IpcEventChannels.prototype);
 Object.freeze(IpcEventChannels);
+function noop() { }
 function makeSubscribingClient(channel, comm) {
     return (new EventsReceivingSide(channel, comm)).wrap();
 }

package/build/lib-server/web-sockets/app.d.ts

@@ -8,13 +8,14 @@ import { CheckSession, SessionParams } from '../resources/sessions';
 export type HttpServer = http.Server | https.Server;
 export declare class UserSockets {
     checkSession: CheckSession<SessionParams>;
+    private readonly pingMillis;
     /**
      * Only connections that match this path are accepted.
      */
     path: string;
     private clients;
     private ipcs;
-    constructor(checkSession: CheckSession<SessionParams>);
+    constructor(checkSession: CheckSession<SessionParams>, pingMillis: number);
     disconnect(): void;
     handleConnection(userId: string, client: WebSocket): void;
     addSocketIPC(ipc: SocketIPCs): void;

package/build/lib-server/web-sockets/app.js

@@ -124,8 +124,9 @@ function ensureSlashesOnFront(path) {
     return path;
 }
 class UserSockets {
-    constructor(checkSession) {
+    constructor(checkSession, pingMillis) {
         this.checkSession = checkSession;
+        this.pingMillis = pingMillis;
         /**
          * Only connections that match this path are accepted.
          */
@@ -140,7 +141,7 @@ class UserSockets {
         for (const ipc of this.ipcs) {
             ipc.attachIPC(userId, client);
         }
-        let pinger = new PingSender(client);
+        let pinger = new PingSender(client, this.pingMillis);
         client.on('close', () => {
             this.clients.remove(userId, client);
             pinger.close();
@@ -162,10 +163,12 @@ exports.UserSockets = UserSockets;
 Object.freeze(UserSockets.prototype);
 Object.freeze(UserSockets);
 class PingSender {
-    constructor(client) {
+    constructor(client, pingMillis) {
+        this.pingMillis = pingMillis;
         this.outstandingPong = 0;
         this.client = client;
-        this.fourMinCheck = setInterval(() => this.recurrentPing(), 4 * 60 * 1000);
+        this.pongTimeoutMillis = Math.round(this.pingMillis / 2);
+        this.fourMinCheck = setInterval(() => this.recurrentPing(), this.pingMillis);
         this.fourMinCheck.unref();
     }
     recurrentPing() {
@@ -175,7 +178,7 @@ class PingSender {
         if (this.outstandingPong === 0) {
         }
         else if (this.outstandingPong === 1) {
-            setTimeout(() => this.additionalPing(), 2 * 60 * 1000).unref();
+            setTimeout(() => this.additionalPing(), this.pongTimeoutMillis).unref();
         }
         else {
             this.client.close();

package/build/main.js

@@ -139,9 +139,16 @@ async function displaySignupInfo(conf) {
         if (conf.signup.noTokenFile) {
             const ctx = await (0, signup_1.readNoTokensFile)(conf.signup.noTokenFile);
             console.log(`Signup of user without token is allowed in domains:\n`, ctx.domains, `\n`);
+            const signupLink = signupLinkFrom(conf, undefined);
+            if (signupLink) {
+                console.log(`Signup link:\n`, signupLink, `\n`);
+            }
         }
         else {
             console.log(`Signup of users is allowed only with valid signup tokens.\n`);
+            if (conf.signup.serviceUrl) {
+                console.log(`Signup service url (from configuration file):\n`, conf.signup.serviceUrl, `\n`);
+            }
         }
     }
     const { multiUserTokens, singleUserTokens } = await (0, signup_1.readAllSignupTokens)(conf.rootFolder);
@@ -173,31 +180,50 @@ async function displayTokensList(conf) {
 }
 async function displayTokenValue(conf, tokenId) {
     const ctx = await (0, signup_1.readTokenFile)(conf.rootFolder, tokenId);
-    if (!ctx) {
+    if (ctx) {
+        const signupLink = signupLinkFrom(conf, ctx.token);
+        if (signupLink) {
+            console.log(`\nSignup link: ${signupLink}`);
+        }
+        if (ctx.type === 'multi-domain') {
+            console.log(`\nMulti-user signup context:`);
+            console.log(`  domains:`, ctx.domains);
+            console.log(`  value:`, ctx.token);
+            if (ctx.validTill) {
+                console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}\n`);
+            }
+            else {
+                console.log(``);
+            }
+        }
+        else if (ctx.type === 'single-user') {
+            console.log(`\nSingle-user signup context:`);
+            console.log(`  address:`, ctx.userId);
+            console.log(`  value:`, ctx.token);
+            if (ctx.validTill) {
+                console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}\n`);
+            }
+            else {
+                console.log(``);
+            }
+        }
+    }
+    else {
         console.error(`Token ${tokenId} is not found.`);
         process.exit(-1);
     }
-    else if (ctx.type === 'multi-domain') {
-        console.log(`\nMulti-user signup context:`);
-        console.log(`  domains:`, ctx.domains);
-        console.log(`  value:`, ctx.token);
-        if (ctx.validTill) {
-            console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}\n`);
-        }
-        else {
-            console.log(``);
-        }
+}
+function signupLinkFrom(conf, token = '') {
+    var _a;
+    if (!((_a = conf.signup) === null || _a === void 0 ? void 0 : _a.serviceUrl)) {
+        return;
     }
-    else if (ctx.type === 'single-user') {
-        console.log(`\nSingle-user signup context:`);
-        console.log(`  address:`, ctx.userId);
-        console.log(`  value:`, ctx.token);
-        if (ctx.validTill) {
-            console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}\n`);
-        }
-        else {
-            console.log(``);
-        }
+    try {
+        const url = new URL(conf.signup.serviceUrl);
+        return `3nweb://signup/${url.host}${url.pathname}${url.pathname.endsWith('/') ? '' : '/'}${token}`;
+    }
+    catch (err) {
+        return;
     }
 }
 async function createMultiUserToken(conf, domains) {

package/build/services.d.ts

@@ -25,6 +25,7 @@ export interface Configurations {
     };
     signup?: {
         noTokenFile?: string;
+        serviceUrl?: string;
     };
 }
 export declare function servicesApp(conf: Configurations, errLogger?: ErrLogger | 'console', logSetup?: 'console'): AppWithWSs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",