Release 0.15.6 (#1506)

Fix for Resource temporarily unavailable error for CLN channel alias list
Security fix for npm vulnerabilities

Author: ShahanaFarooqui

.github/README.md

@@ -55,20 +55,17 @@ To download from master (*not recommended*):
 ```
 $ git clone https://github.com/Ride-The-Lightning/RTL.git
 $ cd RTL
-$ npm install --omit=dev --legacy-peer-deps
+$ npm ci --omit=dev --legacy-peer-deps
 ```
 #### Or: Update existing dependencies
 ```
 $ cd RTL
 $ git reset --hard HEAD
 $ git clean -f -d
 $ git pull
-$ npm install --omit=dev --legacy-peer-deps
+$ npm ci --omit=dev --legacy-peer-deps
 ```
 
-#### Error on npm install
-If there is an error with `upstream dependency conflict` message then replace `npm install --omit=dev` with `npm install --omit=dev --legacy-peer-deps`.
-
 ### <a name="prep"></a>Prep for Execution
 RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app.
 

.github/docs/Core_lightning_setup.md

@@ -33,7 +33,7 @@ To download from master (*not recommended*):
 ```
 $ git clone https://github.com/Ride-The-Lightning/RTL.git
 $ cd RTL
-$ npm install --omit=dev --legacy-peer-deps
+$ npm ci --omit=dev --legacy-peer-deps
 ```
 
 #### Or: Update existing build
@@ -42,12 +42,9 @@ $ cd RTL
 $ git reset --hard HEAD
 $ git clean -f -d
 $ git pull
-$ npm install --omit=dev --legacy-peer-deps
+$ npm ci --omit=dev --legacy-peer-deps
 ```
 
-#### Error on npm install
-If there is an error with `upstream dependency conflict` message then replace `npm install --omit=dev` with `npm install --omit=dev --legacy-peer-deps`.
-
 ### <a name="prep"></a>Prep for Execution
 RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app
 * Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`

.github/docs/Eclair_setup.md

@@ -28,20 +28,17 @@ To download from master (*not recommended*) follow the below instructions:
 ```
 $ git clone https://github.com/Ride-The-Lightning/RTL.git
 $ cd RTL
-$ npm install --omit=dev --legacy-peer-deps
+$ npm ci --omit=dev --legacy-peer-deps
 ```
 #### Or: Update existing build
 ```
 $ cd RTL
 $ git reset --hard HEAD
 $ git clean -f -d
 $ git pull
-$ npm install --omit=dev --legacy-peer-deps
+$ npm ci --omit=dev --legacy-peer-deps
 ```
 
-#### Error on npm install
-If there is an error with `upstream dependency conflict` message then replace `npm install --omit=dev` with `npm install --omit=dev --legacy-peer-deps`.
-
 ### <a name="prep"></a>Prep for Execution
 RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app. 
 * Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`..

CONTRIBUTING.md

@@ -43,8 +43,8 @@ Contributions via code is the most sought after contribution and something we en
 * Pull the code from the release (current eg Release-0.12.2) branch into your local workspace via github commandline/GUI.
 
 ##### Install Dependencies
-* Assuming that nodejs (v14 & above) and npm are already installed on your local machine. Go into your RTL root folder and run `npm install`. 
-* Use `npm install --legacy-peer-deps` if there is any dependency conflict.
+* Assuming that nodejs (v14 & above) and npm are already installed on your local machine. Go into your RTL root folder and run `npm ci`. 
+* Use `npm ci --legacy-peer-deps` if there is any dependency conflict.
 * Sometimes after installation, user receives a message from npm to fix dependency vulnerability by running `npm audit fix`. Please do not follow this step as it can break some of the working RTL code on your machine. We audit and fix these vulnerabilities as soon as possible at our end.
 
 ##### Node Backend Server for Development

Dockerfile

@@ -7,7 +7,7 @@ WORKDIR /RTL
 COPY package.json /RTL/package.json
 COPY package-lock.json /RTL/package-lock.json
 
-RUN npm install --legacy-peer-deps
+RUN npm ci --legacy-peer-deps
 
 COPY . .
 

backend/controllers/cln/channels.js

@@ -14,11 +14,12 @@ export const listPeerChannels = (req, res, next) => {
     options.url = req.session.selectedNode.settings.lnServerUrl + '/v1/listpeerchannels';
     request.post(options).then((body) => {
         logger.log({ selectedNode: req.session.selectedNode, level: 'INFO', fileName: 'Channels', msg: 'Peer Channels List Received', data: body.channels });
-        return Promise.all(body.channels?.map((channel) => {
+        const getPeerAliasesTasks = body.channels.map((channel) => () => {
             channel.to_them_msat = channel.total_msat - channel.to_us_msat;
-            channel.balancedness = (channel.total_msat === 0) ? 1 : (1 - Math.abs((channel.to_us_msat - (channel.total_msat - channel.to_us_msat)) / channel.total_msat)).toFixed(3);
+            channel.balancedness = (channel.total_msat === 0) ? 1 : (1 - Math.abs((channel.to_us_msat - channel.to_them_msat) / channel.total_msat)).toFixed(3);
             return getAlias(req.session.selectedNode, channel, 'peer_id');
-        })).then((values) => {
+        });
+        common.runWithConcurrencyLimit(getPeerAliasesTasks, 20, () => {
             logger.log({ selectedNode: req.session.selectedNode, level: 'INFO', fileName: 'Channels', msg: 'Peer Channels List With Aliases Received', data: body.channels });
             return res.status(200).json(body.channels || []);
         });

backend/controllers/cln/network.js

@@ -4,6 +4,7 @@ import { Common } from '../../utils/common.js';
 let options = null;
 const logger = Logger;
 const common = Common;
+const aliasCache = new Map();
 export const getRoute = (req, res, next) => {
     logger.log({ selectedNode: req.session.selectedNode, level: 'INFO', fileName: 'Network', msg: 'Getting Network Routes..' });
     options = common.getOptions(req);
@@ -80,20 +81,28 @@ export const listNodes = (req, res, next) => {
     });
 };
 export const getAlias = (selNode, peer, id) => {
-    options.url = selNode.settings.lnServerUrl + '/v1/listnodes';
-    if (!peer[id]) {
+    const peerId = peer[id];
+    if (!peerId) {
         logger.log({ selectedNode: selNode, level: 'ERROR', fileName: 'Network', msg: 'Empty Peer ID' });
         peer.alias = '';
-        return peer;
+        return Promise.resolve(peer);
     }
-    options.body = { id: peer[id] };
+    if (aliasCache.has(peerId)) {
+        peer.alias = aliasCache.get(peerId);
+        return Promise.resolve(peer);
+    }
+    options.url = selNode.settings.lnServerUrl + '/v1/listnodes';
+    options.body = { id: peerId };
     return request.post(options).then((body) => {
         logger.log({ selectedNode: selNode, level: 'DEBUG', fileName: 'Network', msg: 'Peer Alias Finished', data: body });
-        peer.alias = body.nodes[0] && body.nodes[0].alias ? body.nodes[0].alias : peer[id].substring(0, 20);
+        const alias = body.nodes?.[0]?.alias || peerId.substring(0, 20);
+        aliasCache.set(peerId, alias);
+        peer.alias = alias;
         return peer;
     }).catch((errRes) => {
         common.handleError(errRes, 'Network', 'Peer Alias Error', selNode);
-        peer.alias = peer[id].substring(0, 20);
+        const alias = peerId.substring(0, 20);
+        peer.alias = alias;
         return peer;
     });
 };

backend/utils/common.js

@@ -608,6 +608,39 @@ export class CommonService {
             const dataStr = foundDataLine ? foundDataLine.substring((foundDataLine.indexOf(search_string)) + search_string.length) : '{}';
             return JSON.parse(dataStr);
         };
+        this.runWithConcurrencyLimit = (tasks, limit, done) => {
+            const results = new Array(tasks.length);
+            let nextIndex = 0;
+            let activeCount = 0;
+            const runNext = () => {
+                if (nextIndex >= tasks.length) {
+                    if (activeCount === 0) {
+                        done(results); // all tasks are finished
+                    }
+                    return;
+                }
+                const currentIndex = nextIndex++;
+                activeCount++;
+                const task = tasks[currentIndex];
+                if (typeof task !== 'function') {
+                    results[currentIndex] = { error: new Error('Invalid task at index ' + currentIndex) };
+                    activeCount--;
+                    runNext();
+                    return;
+                }
+                Promise.resolve().then(() => task()).then((result) => {
+                    results[currentIndex] = result;
+                }).catch((err) => {
+                    results[currentIndex] = { error: err };
+                }).finally(() => {
+                    activeCount--;
+                    runNext();
+                });
+            };
+            for (let i = 0; i < limit && i < tasks.length; i++) {
+                runNext();
+            }
+        };
     }
 }
 export const Common = new CommonService();