13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
--------------------------------------------------------------------------------
/lib/metrics/Histogram.js:
--------------------------------------------------------------------------------
1 |
2 | const perf_hooks = require("perf_hooks");
3 |
4 | module.exports = class Histogram {
5 |
6 | /**
7 | * - Histogram - Keeps a resevoir of statistically relevant values biased towards the last 5 minutes to explore their distribution
8 | * - count: The number of observed values.
9 | * - min: The lowest observed value.
10 | * - max: The highest observed value.
11 | * - mean: The average of all observed values.
12 | * - dev: The standard deviation of all observed values.
13 | * - med: median, 50% of all values in the resevoir are at or below this value.
14 | * - p75: See median, 75% percentile.
15 | * - p95: See median, 95% percentile.
16 | * - p99: See median, 99% percentile.
17 | * - p999: See median, 99.9% percentile.
18 | * @param {object} [options]
19 | * @class Histogram
20 | */
21 | constructor(options) {
22 | if (options?.reset) this._reset = options?.reset;
23 | this._handle = perf_hooks.createHistogram();
24 | }
25 |
26 | update(value) {
27 | this.lastUpdate = Date.now();
28 | this._handle.record(typeof value == "number" && value > 0 ? value : 1);
29 | }
30 |
31 | reset() {
32 | this._handle.reset();
33 | }
34 |
35 | toJSON(options) {
36 | this.lastJSON = Date.now();
37 |
38 | const rc = {
39 | count: this._handle.count,
40 | min: this._handle.min,
41 | max: this._handle.max,
42 | mean: this._handle.mean,
43 | dev: this._handle.stddev,
44 | med: this._handle.percentile(50),
45 | p25: this._handle.percentile(25),
46 | p75: this._handle.percentile(75),
47 | p95: this._handle.percentile(95),
48 | p99: this._handle.percentile(99),
49 | };
50 | if (this._reset || options?.reset) this.reset();
51 | return rc;
52 | }
53 | }
54 |
55 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "0.200.0",
3 | "type": "commonjs",
4 | "author": "Vlad Seryakov",
5 | "name": "backendjs",
6 | "description": "A library for building backends",
7 | "main": "lib/index",
8 | "homepage": "https://github.com/vseryakov/backendjs",
9 | "repository": {
10 | "type": "git",
11 | "url": "https://github.com/vseryakov/backendjs.git"
12 | },
13 | "dependencies": {
14 | "express": "5.2.1",
15 | "formidable": "3.5.4",
16 | "mime-types": "3.0.2",
17 | "qs": "6.14.0",
18 | "ws": "8.18.3",
19 | "fast-xml-parser": "5.3.3"
20 | },
21 | "devDependencies": {
22 | "eslint": "8.57.1",
23 | "esbuild": "0.27.2",
24 | "docdash": "github:vseryakov/docdash"
25 | },
26 | "peerDependencies": {
27 | "croner": "9.1.0",
28 | "nodemailer": "7.0.12",
29 | "nats": "2.29.3",
30 | "pg": "8.16.3",
31 | "redis": "3.1.2",
32 | "sharp": "0.34.5",
33 | "unix-dgram": "2.0.7",
34 | "web-push": "3.6.7"
35 | },
36 | "keywords": [
37 | "webservice",
38 | "websockets",
39 | "aws",
40 | "database",
41 | "API",
42 | "DynamoDB",
43 | "Sqlite",
44 | "Elasticsearch",
45 | "PostgreSQL",
46 | "NATS",
47 | "Redis",
48 | "pubsub",
49 | "jobs",
50 | "cron"
51 | ],
52 | "engines": {
53 | "node": ">=22.0"
54 | },
55 | "license": "BSD-3-Clause",
56 | "bin": {
57 | "bkjs": "./bin/bkjs",
58 | "bksh": "./bin/bkjs"
59 | },
60 | "files": [
61 | "LICENSE",
62 | "bin",
63 | "lib/",
64 | "web/",
65 | "tools/"
66 | ],
67 | "scripts": {
68 | "build": "npm run docs",
69 | "devbuild": "npm run build",
70 | "node": "./bkjs install-node",
71 | "deps": "PATH=$(pwd)/nodejs/bin:$PATH npm install",
72 | "test": "node --test --test-concurrency=1 tests/**/*.test.js tests/**/*-test.js",
73 | "docs": "rm -rf docs/web && bksh -help-config > docs/src/config.md && jsdoc -c docs/jsdoc.js"
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/tools/bkjs-dynamodb:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | #
3 | # Author: Vlad Seryakov vseryakov@gmail.com
4 | # Sep 2013
5 | #
6 |
7 | case "$BKJS_CMD" in
8 |
9 | help|dynamodb-help)
10 | echo ""
11 | echo " dynamodb-init - download and install local DynamoDB, start the server"
12 | echo " dynamodb-get [-force] - install local DynamoDB server in $BKJS_HOME/dynamodb"
13 | echo " dynamodb-run [-memmax SZ] - run local DynamoDB server installed in $BKJS_HOME/dynamodb, data files in $BKJS_HOME/var"
14 | echo " dynamodb-stop - stop local DynamoDB server"
15 | echo " dynamodb-reset - remove local DynamoDB database and restart the server"
16 | ;;
17 |
18 | dynamodb-init)
19 | ($0 dynamodb-get $(get_all_args))
20 | ($0 dynamodb-run $(get_all_args))
21 | exit
22 | ;;
23 |
24 | dynamodb-get)
25 | [ "$DYNAMODB_PREFIX" = "" ] && DYNAMODB_PREFIX=$BKJS_HOME/dynamodb
26 | [ "$(get_flag -force)" != "" -a "$DYNAMODB_PREFIX" != "" ] && rm -rf $DYNAMODB_PREFIX
27 | if [ ! -d $DYNAMODB_PREFIX ]; then
28 | mkdir -p $DYNAMODB_PREFIX
29 | curl -L -o ddb.tgz http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest.tar.gz
30 | tar -C $DYNAMODB_PREFIX -xzf ddb.tgz
31 | rm -f ddb.tgz
32 | fi
33 | exit
34 | ;;
35 |
36 | dynamodb-run)
37 | [ "$DYNAMODB_PREFIX" = "" ] && DYNAMODB_PREFIX=$BKJS_HOME/dynamodb
38 | mkdir -p $BKJS_HOME/var $BKJS_HOME/log
39 | params="-Xmx$(get_arg -memmax 256M)"
40 | export DDB_LOCAL_TELEMETRY=0
41 | (cd $BKJS_HOME/var && exec nohup java $params -Djava.library.path=$DYNAMODB_PREFIX/DynamoDBLocal_lib -jar $DYNAMODB_PREFIX/DynamoDBLocal.jar -sharedDb -disableTelemetry -dbPath $BKJS_HOME/var -port 8181 >>$BKJS_HOME/log/ddb.log 2>&1 &)
42 | exit
43 | ;;
44 |
45 | dynamodb-stop)
46 | pkill -f DynamoDBLocal
47 | exit
48 | ;;
49 |
50 | dynamodb-reset)
51 | $0 dynamodb-stop
52 | rm -rf $BKJS_HOME/var/*_us-east-1.db
53 | $0 dynamodb-run
54 | exit
55 | ;;
56 |
57 | esac
58 |
59 |
--------------------------------------------------------------------------------
/web/js/app-passkey.js:
--------------------------------------------------------------------------------
1 | //
2 | // Author: Vlad Seryakov vseryakov@gmail.com
3 | // alpinejs-app 2024
4 | //
5 |
6 | // Passkey support
7 |
8 | (() => {
9 |
10 | var app = window.app;
11 |
12 | app.passkey = {
13 |
14 | reg_path: "/passkey/register",
15 | login_path: "/passkey/login",
16 |
17 | init(callback) {
18 | if (this.client) return;
19 | import("/js/webauthn.min.mjs").then(mod => {
20 | this.client = mod.client;
21 | app.call(callback)
22 | }).catch(err => {
23 | app.call(callback, err);
24 | });
25 | },
26 |
27 | start(options, callback) {
28 | app.send({ url: this.reg_path, data: options?.data }, callback);
29 | },
30 |
31 | finish(config, options, callback) {
32 | this.client.register(options?.name || app.user?.name, config?.challenge, {
33 | attestation: true,
34 | userHandle: config?.id,
35 | domain: config?.domain,
36 | }).then(data => {
37 | app.send({ url: this.reg_path, body: Object.assign(data || {}, options?.body) }, callback);
38 | }).catch(err => {
39 | app.call(callback, err);
40 | });
41 | },
42 |
43 | register(options, callback) {
44 | this.start(options, (err, config) => {
45 | if (err) return app.call(callback, err);
46 | this.finish(config, options, callback);
47 | });
48 | },
49 |
50 | login(options, callback) {
51 | app.fetch({ url: this.login_path }, (err, config) => {
52 | if (err) return app.call(callback, err);
53 |
54 | this.client.authenticate(app.util.split(options?.ids), config.challenge, {
55 | domain: config.domain,
56 | }).then(data => {
57 | app.send({ url: this.login_path, body: Object.assign(data, options?.body) }, callback);
58 | }).catch(err => {
59 | app.call(callback, err);
60 | });
61 | });
62 | },
63 | }
64 |
65 | })();
66 |
--------------------------------------------------------------------------------
/examples/config/web/index.html:
--------------------------------------------------------------------------------
1 |
2 |
27 |
32 |
33 |
28 | 
29 | Alpinejs-app Components and Backendjs Playground
30 |
31 |
29 | Alpinejs-app Components and Backendjs Playground
30 |
34 |
35 | Toggle `index.template` ->
36 | (Template is set to )
37 |
38 |
39 | Render Test HTML plugin below
40 |
41 |
42 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
43 |
44 |
45 |
46 |
47 |
48 |
37 |
42 |
38 |
39 | Backendjs Config Example
40 |
41 |
39 | Backendjs Config Example
40 |
49 |
59 |
60 |
--------------------------------------------------------------------------------
/web/js/app-dom.js:
--------------------------------------------------------------------------------
1 | /*
2 | * app client
3 | * Vlad Seryakov vseryakov@gmail.com 2018
4 | */
5 |
6 | /* global document window */
7 |
8 | (() => {
9 | var app = window.app;
10 |
11 | app.util = {
12 |
13 | // Inject CSS/Script resources into the current page, all urls are loaded at the same time by default.
14 | // - `options.series` - load urls one after another
15 | // - `options.async` if set then scripts executed as soon as loaded otherwise executing scripts will be in the order provided
16 | // - `options.callback` will be called with (el, opts) args for customizations after loading each url or on error
17 | // - `options.attrs` is an object with attributes to set like nonce, ...
18 | // - `options.timeout` - call the callback after timeout
19 | loadResources(urls, options, callback)
20 | {
21 | if (typeof options == "function") callback = options, options = null;
22 | if (typeof urls == "string") urls = [urls];
23 | app[`forEach${options?.series ? "Series" : ""}`](urls, (url, next) => {
24 | let el;
25 | const ev = () => { app.call(options?.callback, el, options); next() }
26 | if (/\.css/.test(url)) {
27 | el = app.$elem("link", "rel", "stylesheet", "type", "text/css", "href", url, "load", ev, "error", ev)
28 | } else {
29 | el = app.$elem('script', "async", !!options?.async, "src", url, "load", ev, "error", ev)
30 | }
31 | for (const p in options?.attrs) app.$attr(el, p, options.attrs[p]);
32 | document.head.appendChild(el);
33 | }, options?.timeout > 0 ? () => { setTimeout(callback, options.timeout) } : callback);
34 | },
35 |
36 | // Return a random hex string
37 | random(size)
38 | {
39 | var s = "", u = new Uint8Array(size || 16), h = "0123456789abcdef";
40 | window.crypto.getRandomValues(u);
41 | for (let i = 0; i < u.length; i++) s += h.charAt(u[i] >> 4) + h.charAt(u[i] & 0x0F);
42 | return s;
43 | },
44 | }
45 |
46 | })();
47 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | #  Backend library for Node.js
2 |
3 | A Node.js library to create Web apps with minimal dependencies.
4 |
5 | ## Features:
6 |
7 | * Express 5 is used for the API access.
8 | * Authentication is based on signed requests using API key and secret, similar to Amazon AWS signing requests.
9 | * Web sessions with CSRF protection, Webauthn/Passkeys.
10 | * Web server runs in separate processes to utilize multiple CPU cores.
11 | * WebSocket connections are processed by the same Express routes.
12 | * Rate limiter based on TokenBucket algorithm can be run in-process or in Redis.
13 | * PUB/SUB modes of operations using Redis, NATS.
14 | * Async jobs processing using queue implementation on top of SQS, Redis, NATS, jobs can be scheduled or run on-demand in separate processes.
15 | * REPL (command line) interface for debugging and looking into server internals.
16 | * Push notifications via Webpush.
17 | * Can be used with any MVC, MVVC or other types of frameworks that work on top of, or with the included Express server.
18 | * Simple DB layer for CRUD operations like Get/Select/Put/Del/Update for supported databases (SQLite, PostreSQL, DynamoDB, ElasticSearch).
19 | * AWS support is very well integrated by using APIs directly without AWS SDK, includes EC2, ECS, S3, DynamoDB, SQS, CloudWatch and more.
20 | * Includes a simple log watcher to monitor the log files and CloudWatch logs.
21 | * Runtime metrics about CPU, DB, requests, cache, memory, rate limits, AWS X-Ray spans.
22 | * The backend process can be used directly in Docker containers without shim init.
23 |
24 | ## NOTE: work in progress, major refactor, the NPM version is stable
25 |
26 | ## Documentation
27 |
28 | Visit the [documentation](https://vseryakov.github.io/backendjs/docs/web/index.html).
29 |
30 | ## Installation
31 |
32 | npm install backendjs --save
33 |
34 | or clone the repo
35 |
36 | git clone https://github.com/vseryakov/backendjs.git
37 |
38 | ## License
39 | [MIT](/LICENSE)
40 |
41 | ## Author
42 | Vlad Seryakov
43 |
44 |
--------------------------------------------------------------------------------
/lib/queue/eventbridge.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const logger = require(__dirname + '/../logger');
7 | const lib = require(__dirname + '/../lib');
8 | const aws = require(__dirname + '/../aws');
9 | const QueueClient = require(__dirname + "/client");
10 |
11 | const eventbridgeClient = {
12 | name: "eventbridge",
13 |
14 | create: function(options) {
15 | if (/^eventbridge:\/\//.test(options?.url)) return new EventBridgeClient(options);
16 | }
17 | };
18 | module.exports = eventbridgeClient;
19 |
20 | /**
21 | * Queue client using AWS EventBridge.
22 | *
23 | * The URL must look like: `eventbridge://?[params]`.
24 | *
25 | * @example
26 | *
27 | * -queue-events=eventbridge://
28 | * -queue-events=eventbridge://?bk-endpoint=12345
29 | * -queue-events=eventbridge://?bk-bus=mybus
30 | * -queue-events=eventbridge://?bk-source=mysource
31 | * @memberOf module:queue
32 | */
33 |
34 | class EventBridgeClient extends QueueClient {
35 |
36 | constructor(options) {
37 | super(options);
38 | this.name = eventbridgeClient.name;
39 | this.applyOptions();
40 | this.emit("ready");
41 | }
42 |
43 | submit(events, options, callback) {
44 | logger.dev("submit:", this.url, events, options);
45 |
46 | var entries = [];
47 | if (!Array.isArray(events)) events = [events];
48 | for (const event of events) {
49 | if (!event) continue;
50 | entries.push({
51 | Source: options.source || this.options.source || this.queueName,
52 | DetailType: event.subject || options.subject || this.options.subject,
53 | Details: lib.stringify(event),
54 | EventBusName: options.eventBusName || this.options.bus,
55 | TraceHeader: options.traceHeader,
56 | });
57 | }
58 |
59 | aws.queryEvents("PutEvents", { EndpointId: this.options.endpoint, Entries: entries }, options, callback);
60 | }
61 | }
62 |
63 |
--------------------------------------------------------------------------------
/lib/lib/hash.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const crypto = require('node:crypto');
7 | const logger = require(__dirname + '/../logger');
8 | const lib = require(__dirname + '/../lib');
9 |
10 | /**
11 | * Hash wrapper without exceptions for node crypto createHash
12 | * @param {string|Buffer} data - data to hash
13 | * @param {string} [algorithm] - sha1 is default, any supported hash algorithm by node:crypto
14 | * @param {string} [encode] - encoding, base64 by default
15 | * @return {string} calculated hash or empty string on error
16 | * @memberof module:lib
17 | * @method hash
18 | */
19 | lib.hash = function (data, algorithm, encode)
20 | {
21 | encode = encode === "binary" ? undefined : encode || "base64";
22 | try {
23 | return crypto.createHash(algorithm || "sha1").update(data || "").digest(encode);
24 | } catch (e) {
25 | logger.error('hash:', algorithm, encode, e.stack);
26 | return "";
27 | }
28 | }
29 |
30 | /**
31 | * 32-bit MurmurHash3 implemented by bryc (github.com/bryc)
32 | * @param {string} key input string
33 | * @return {number} hash number
34 | * @memberof module:lib
35 | * @method murmurHash3
36 | */
37 | lib.murmurHash3 = function(key, seed = 0)
38 | {
39 | if (typeof key != "string") return 0;
40 |
41 | var k, p1 = 3432918353, p2 = 461845907, h = seed | 0;
42 |
43 | for (var i = 0, b = key.length & -4; i < b; i += 4) {
44 | k = key[i+3] << 24 | key[i+2] << 16 | key[i+1] << 8 | key[i];
45 | k = Math.imul(k, p1); k = k << 15 | k >>> 17;
46 | h ^= Math.imul(k, p2); h = h << 13 | h >>> 19;
47 | h = Math.imul(h, 5) + 3864292196 | 0;
48 | }
49 |
50 | k = 0;
51 | switch (key.length & 3) {
52 | case 3: k ^= key[i+2] << 16;
53 | case 2: k ^= key[i+1] << 8;
54 | case 1: k ^= key[i];
55 | k = Math.imul(k, p1); k = k << 15 | k >>> 17;
56 | h ^= Math.imul(k, p2);
57 | }
58 |
59 | h ^= key.length;
60 | h ^= h >>> 16; h = Math.imul(h, 2246822507);
61 | h ^= h >>> 13; h = Math.imul(h, 3266489909);
62 | h ^= h >>> 16;
63 |
64 | return h >>> 0;
65 | }
66 |
--------------------------------------------------------------------------------
/lib/api/routing.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | /**
7 | * @module api/routing
8 | */
9 |
10 | const lib = require(__dirname + '/../lib');
11 | const api = require(__dirname + '/../api');
12 | const logger = require(__dirname + '/../logger');
13 |
14 | const mod = {
15 | name: "api.routing",
16 | args: [
17 | { name: "err-(.+)", descr: "Error messages for various cases" },
18 | { name: "path-(.+)", type: "regexpobj", reverse: 1, nocamel: 1, obj: 'path', descr: "Locations to be re-routed to other path, this is done inside the server at the beginning, only the path is replaced, same format and placeholders as in redirect-url, use ! in front of regexp to remove particular redirect from the list", example: "-api-routing-path-^/user/get /user/read" },
19 | { name: "auth-(.+)", type: "regexpobj", reverse: 1, nocamel: 1, obj: 'auth', descr: "URL path to be re-routed to other path after the authentication is successful, this is done inside the server, only the path is replaced, same format and placeholders as in redirect-url", example: "-api-routing-auth-^/user/get /user/read" },
20 | { name: "reset", type: "callback", callback: function(v) { if (v) this.reset() }, descr: "Reset all rules" },
21 | ],
22 | };
23 |
24 | /**
25 | * Routing rewriting
26 | */
27 | module.exports = mod;
28 |
29 | mod.reset = function()
30 | {
31 | delete this.path;
32 | delete this.auth;
33 | }
34 |
35 | /**
36 | * Check if the current request must be re-routed to another endpoint,
37 | * returns true if the url has been replaced
38 | */
39 | mod.check = function(req, name)
40 | {
41 | var rules = this[name];
42 | if (!rules) return;
43 |
44 | const location = req.options.host + req.options.path;
45 | for (const p in rules) {
46 | if (lib.testRegexpObj(req.options.path, rules[p]) || lib.testRegexpObj(location, rules[p])) {
47 | req.signatureUrl = req.url;
48 | api.replacePath(req, api.checkRedirectPlaceholders(req, p));
49 | logger.debug("check:", this.name, name, location, "switch to:", p, req.url);
50 | return true;
51 | }
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/tests/limiter.test.js:
--------------------------------------------------------------------------------
1 |
2 | const { describe, it, before, after } = require('node:test');
3 | const assert = require('node:assert/strict');
4 | const { app, lib, cache } = require("../");
5 | const { ainit } = require("./utils");
6 |
7 | var opts = {
8 | name: "test",
9 | rate: 1,
10 | max: 1,
11 | interval: 100,
12 | cacheName: process.env.BKJS_ROLES || "local",
13 | pace: 5,
14 | count: 5,
15 | delays: 4,
16 | };
17 |
18 | describe("Limiter tests", async () => {
19 |
20 | before(async () => {
21 | await ainit({ nodb: 1, cache: 1, roles: process.env.BKJS_ROLES });
22 | });
23 |
24 | it("should delay the pace", async () => (
25 | new Promise((resolve, reject) => {
26 | var list = [], delays = 0;
27 | for (let i = 0; i < opts.count; i++) list.push(i);
28 |
29 | lib.forEachSeries(list, (i, next2) => {
30 | lib.doWhilst(
31 | function(next3) {
32 | cache.limiter(opts, (delay) => {
33 | opts.delay = delay;
34 | setTimeout(next3, delay);
35 | });
36 | },
37 | function() {
38 | if (opts.delay) delays++;
39 | return opts.delay;
40 | },
41 | function() {
42 | setTimeout(next2, opts.pace);
43 | });
44 | }, () => {
45 | assert.strictEqual(delays, opts.delays);
46 | resolve();
47 | });
48 | })
49 | ));
50 |
51 | it("should wait and continue", async () => {
52 | opts.retry = 2;
53 | await cache.alimiter(opts);
54 | const { delay } = await cache.acheckLimiter(opts);
55 | assert.ok(!delay && opts._retries == 2);
56 | });
57 |
58 | it("should fail after first run", async () => (
59 | new Promise((resolve, reject) => {
60 | opts.retry = 1;
61 | delete opts._retries;
62 | cache.limiter(opts, (delay, info) => {
63 | cache.checkLimiter(opts, (delay, info) => {
64 | assert.ok(delay && opts._retries == 1);
65 | resolve();
66 | });
67 | });
68 | })
69 | ));
70 |
71 | after(async () => {
72 | await app.astop();
73 | });
74 |
75 | });
76 |
--------------------------------------------------------------------------------
/tests/logwatcher.test.js:
--------------------------------------------------------------------------------
1 |
2 | const fs = require("fs");
3 | const { describe, it } = require('node:test');
4 | const assert = require('node:assert/strict');
5 | const { app, lib, logwatcher } = require("../");
6 |
7 | describe("Logwatcher tests", () => {
8 |
9 | var argv = ["-logwatcher-send-error", "none://",
10 | "-logwatcher-send-test", "none://",
11 | "-logwatcher-send-ignore", "none://",
12 | "-logwatcher-send-warning", "none://",
13 | "-logwatcher-send-any", "none://",
14 | "-logwatcher-matches-test", "TEST: ",
15 | "-logwatcher-ignore-error", "error2",
16 | "-logwatcher-ignore-warning", "warning2",
17 | "-logwatcher-once-test2", "test2",
18 | "-logwatcher-matches-any", "line:[0-9]+",
19 | "-logwatcher-interval", "1",
20 | "-app-log-file", "/tmp/message.log",
21 | "-app-err-file", "/tmp/error.log",
22 | "-db-pool", "none",
23 | ];
24 | var lines = [
25 | " ERROR: error1",
26 | " continue error1",
27 | "]: WARN: warning1",
28 | "]: WARN: warning2",
29 | " backtrace test line:123",
30 | "[] TEST: test1",
31 | "[] TEST: test2 shown",
32 | "[] TEST: test2 skipped",
33 | "[] TEST: test2 skipped",
34 | "[] ERROR: error2",
35 | "no error string",
36 | "no error string",
37 | "no error string",
38 | "no error string",
39 | "no error string",
40 | "no error string",
41 | " backtrace test line:456",
42 | ];
43 |
44 | logwatcher.files = logwatcher.files.filter((x) => (x.name));
45 |
46 | app.parseArgs(argv);
47 | fs.writeFileSync(app.errFile, lines.join("\n"));
48 | fs.writeFileSync(app.logFile, lines.join("\n"));
49 |
50 | it("process log files", (t, callback) => {
51 | logwatcher.run((err, rc) => {
52 | assert.ifError(err);
53 | assert.equal(lib.objKeys(rc?.errors).length, 5);
54 | callback(err);
55 | });
56 | });
57 | })
58 |
59 |
--------------------------------------------------------------------------------
/examples/modules/bk_system.js:
--------------------------------------------------------------------------------
1 | //
2 | // Author: Vlad Seryakov vseryakov@gmail.com
3 | // backendjs 2018
4 | //
5 |
6 | const { modules, api, ipc, core, lib, logger } = require('backendjs');
7 |
8 | // System management
9 | const mod = {
10 | name: "bk_system",
11 | };
12 | module.exports = mod;
13 |
14 | // Create API endpoints and routes
15 | mod.configureWeb = function(options, callback)
16 | {
17 | api.app.post(/^\/system\/([^/]+)\/?(.+)?/, (req, res) => {
18 |
19 | switch (req.params[0]) {
20 | case "restart":
21 | ipc.sendMsg(`${req.params[1] || "api"}:restart`);
22 | res.json({});
23 | break;
24 |
25 | case "init":
26 | if (req.params[1]) {
27 | ipc.broadcast(app.id + ":server", req.params[1] + ":" + req.params[0]);
28 | }
29 | res.json({});
30 | break;
31 |
32 | case "params":
33 | var args = [];
34 | Object.keys(modules).forEach((n) => {
35 | if (modules[n].args) args.push([n, app.modules[n].args]);
36 | });
37 | switch (req.params[1]) {
38 | case 'get':
39 | res.json(args.reduce((data, x) => {
40 | x[1].forEach((y) => {
41 | if (!y._name) return;
42 | var val = lib.objGet(modules[x[0]], y._name);
43 | if (val == null && !options.total) return;
44 | data[y._key] = typeof val == "undefined" ? null : val;
45 | });
46 | return data;
47 | }, { "-home": app.home, "-log": logger.level }));
48 | break;
49 |
50 | case "info":
51 | res.json(args.reduce((data, x) => {
52 | x[1].forEach((y) => {
53 | data[(x[0] ? x[0] + "-" : "") + y.name] = y;
54 | });
55 | return data;
56 | }, {}));
57 | break;
58 | default:
59 | api.sendReply(res, 400, "Invalid command");
60 | }
61 | break;
62 |
63 | default:
64 | api.sendReply(res, 400, "Invalid command");
65 | }
66 | });
67 | }
68 |
69 |
--------------------------------------------------------------------------------
/examples/config/web/config.html:
--------------------------------------------------------------------------------
1 |
2 |
50 | You need top login in order to manage the config.
51 |
52 |
53 |
54 |
55 | Login
56 |
57 |
58 |
3 |
45 |
--------------------------------------------------------------------------------
/web/js/app-sanitizer.js:
--------------------------------------------------------------------------------
1 | /*
2 | * app client
3 | * Vlad Seryakov vseryakov@gmail.com 2018
4 | */
5 |
6 | /* global window */
7 |
8 | (() => {
9 | var app = window.app;
10 |
11 | function isattr(attr, list)
12 | {
13 | const name = attr.nodeName.toLowerCase();
14 | if (list.includes(name)) {
15 | if (sanitizer._attrs.has(name)) {
16 | return sanitizer._urls.test(attr.nodeValue) || sanitizer._data.test(attr.nodeValue);
17 | }
18 | return true;
19 | }
20 | return list.some((x) => (x instanceof RegExp && x.test(name)));
21 | }
22 |
23 | // Based on Bootstrap internal sanitizer
24 | function sanitizer(html, list)
25 | {
26 | if (!html || typeof html != "string") return list ? [] : html;
27 | const body = app.$parse(html);
28 | const elements = [...body.querySelectorAll('*')];
29 | for (const el of elements) {
30 | const name = el.nodeName.toLowerCase();
31 | if (sanitizer._tags[name]) {
32 | const allow = [...sanitizer._tags['*'], ...sanitizer._tags[name] || []];
33 | for (const attr of [...el.attributes]) {
34 | if (!isattr(attr, allow)) el.removeAttribute(attr.nodeName);
35 | }
36 | } else {
37 | el.remove();
38 | }
39 | }
40 | return list ? Array.from(body.childNodes) : body.innerHTML;
41 | }
42 |
43 | sanitizer._attrs = new Set(['background','cite','href','itemtype','longdesc','poster','src','xlink:href'])
44 | sanitizer._urls = /^(?:(?:https?|mailto|ftp|tel|file|sms):|[^#&/:?]*(?:[#/?]|$))/i
45 | sanitizer._data = /^data:(?:image\/(?:bmp|gif|jpeg|jpg|png|tiff|webp)|video\/(?:mpeg|mp4|ogg|webm)|audio\/(?:mp3|oga|ogg|opus));base64,[\d+/a-z]+=*$/i
46 | sanitizer._tags = {
47 | '*': ['class', 'dir', 'id', 'lang', 'role', /^aria-[\w-]*$/i,
48 | 'data-bs-toggle', 'data-bs-target', 'data-bs-dismiss', 'data-bs-parent'],
49 | a: ['target', 'href', 'title', 'rel'], area: [],
50 | b: [], blockquote: [], br: [], button: [],
51 | col: [], code: [],
52 | div: [], em: [], hr: [],
53 | img: ['src', 'srcset', 'alt', 'title', 'width', 'height', 'style'],
54 | h1: [], h2: [], h3: [], h4: [], h5: [], h6: [],
55 | i: [], li: [], ol: [], p: [], pre: [],
56 | s: [], small: [], span: [], sub: [], sup: [], strong: [],
57 | table: [], thead: [], tbody: [], th: [], tr: [], td: [],
58 | u: [], ul: [],
59 | }
60 |
61 | app.sanitizer = sanitizer;
62 |
63 | })();
64 |
--------------------------------------------------------------------------------
/examples/kanban/web/index.html:
--------------------------------------------------------------------------------
1 |
2 |
4 |
44 |
5 |
6 | System Config
7 |
8 |
9 |
14 |
15 |
16 |
43 |
17 |
22 |
23 |
18 |
19 |
20 |
21 |
24 |
25 |
42 |
26 |
30 |
31 |
40 |
41 |
32 |
33 |
39 |
34 |
35 |
36 |
37 |
38 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
37 |
38 |
67 |
68 |
69 |
--------------------------------------------------------------------------------
/tools/bkjs-ec2-ami:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | case "$BKJS_CMD" in
4 |
5 | help|ec2-help)
6 | echo
7 | echo " ec2-create-ami [-tag NAME] [-prefix PREFIX] - create a new AMI from the given running instance by tag or the current instance"
8 | echo " ec2-create-launch-template-version [-name NAME] [-tag TAG] [-skip A B] [-image-name *] - create new launch template verson with the latest AMI, if no -name is given all existing templates matched by tag if given will be updated"
9 | echo " ec2-build-ami - [-image-id ID] [-image-name N] [-ssh-user alpine] - build a new AMI for Alpine Linux, runs alpine-build-ami-hook for actual setup, uses -aws-launch-instance, either -image-id or -image-name is required"
10 | echo " ec2-build-ami-hook - actual new AMI build script after it is launched and ssh is ready: INSTANCE_USER, INSTANCE_HOST, INSTANCE_ID, INSTANCE_IP, INSTANCE_ARCH are set"
11 | ;;
12 |
13 | ec2-create-ami)
14 | tag=$(get_arg -tag)
15 | [ -n "$tag" ] && instance_id=$(bkjs ec2-show -tag $tag -fmt id | head -1)
16 | instance_id=$(get_arg -instance-id $instance_id)
17 | $BKJS_BIN shell -no db,ipc -aws-create-image -wait -instance-id $instance_id $(get_all_args "-instance-id -tag")
18 | exit
19 | ;;
20 |
21 | ec2-create-launch-template-version)
22 | name=$(get_arg -name)
23 | skip=$(get_arg -skip)
24 | if [ -z "$name" ]; then
25 | tag=$(get_arg -tag)
26 | key=$(get_arg -key Name)
27 | [ "$tag" != "" ] && filter="--filter Name=tag:$key,Values=${tag}"
28 | name=$(aws ec2 describe-launch-templates $filter --query 'LaunchTemplates[*].LaunchTemplateName' --output text|sed 's/\t/\n/g'|sort|uniq)
29 | fi
30 | for c in $name; do
31 | if list_has $c $skip; then continue; fi
32 | $BKJS_BIN shell -no db,ipc -aws-create-launch-template-version -name $c $(get_all_args "-name -skip -tag -key")
33 | done
34 | exit
35 | ;;
36 |
37 | ec2-build-ami)
38 | run_bkjs_cmd ec2-launch-instance 1 -return -ssh-user alpine
39 | [ "$?" != "0" ] && exit 1
40 |
41 | # Run the hooks to do the actual work now
42 | run_bkjs_cmd $BKJS_CMD-hook 1
43 | exit
44 | ;;
45 |
46 | ec2-build-ami-hook)
47 | # Default hooks to build Alpine image
48 | ssh $INSTANCE_USER@$INSTANCE_HOST "doas apk add git && git clone --depth=1 https://github.com/vseryakov/backendjs.git && doas backendjs/bkjs setup-ec2 && doas reboot"
49 | echo
50 | echo "now you can ssh into $INSTANCE_ID AS ec2-user@$INSTANCE_HOST"
51 | exit
52 | ;;
53 |
54 | esac
55 |
--------------------------------------------------------------------------------
/tests/jobs.test.js:
--------------------------------------------------------------------------------
1 |
2 | const cluster = require("node:cluster");
3 | const { app, lib, jobs, cache } = require("../");
4 | const { ainit, astop, testJob } = require("./utils");
5 |
6 | jobs.testJob = testJob;
7 |
8 | if (cluster.isWorker) {
9 | return app.start({ worker: 1, roles: process.env.BKJS_ROLES || "redis", config: __dirname + "/bkjs.conf" }, () => {
10 | process.exit();
11 | });
12 | }
13 |
14 | const { describe, it, before, after } = require('node:test');
15 | const assert = require('node:assert/strict');
16 | const { promisify } = require("util");
17 |
18 | const submitJob = promisify(jobs.submitJob.bind(jobs));
19 |
20 | describe("Jobs tests", async () => {
21 |
22 | var opts = {
23 | queueName: process.env.BKJS_ROLES || "redis",
24 | };
25 |
26 | before(async () => {
27 | await ainit({ jobs: 1, roles: process.env.BKJS_ROLES || "redis" })
28 | await cache.adel(opts.queueName);
29 | await cache.adel("#" + opts.queueName);
30 | });
31 |
32 | after(async () => {
33 | await astop();
34 | });
35 |
36 |
37 | await it("run simple job", async () => {
38 | var file = "/tmp/job1.test";
39 | lib.unlinkSync(file);
40 |
41 | await jobs.submitJob({ job: { "jobs.testJob": { file, data: "job" } } }, opts);
42 | await lib.sleep(200)
43 |
44 | var data = lib.readFileSync(file);
45 | assert.match(data, /job/);
46 | });
47 |
48 | await it("run cancel job", async () => {
49 | const file = "/tmp/job2.test";
50 | lib.unlinkSync(file);
51 |
52 | await submitJob({ job: { "jobs.testJob": { file, cancel: "job2", timeout: 5000 } } }, opts);
53 | await lib.sleep(500)
54 |
55 | jobs.cancelJob("job2");
56 | await lib.sleep(500);
57 |
58 | var data = lib.readFileSync(file);
59 | assert.match(data, /cancelled/);
60 | });
61 |
62 | it("run local job", async () => {
63 | const file = "/tmp/job3.test";
64 | lib.unlinkSync(file);
65 |
66 | await submitJob({ job: { "jobs.testJob": { file, data: "local" } } }, { queueName: "local" });
67 | await lib.sleep(100)
68 |
69 | var data = lib.readFileSync(file);
70 | assert.match(data, /local/);
71 |
72 | });
73 |
74 | it("run worker job", async() => {
75 | var file = "/tmp/job4.test";
76 | lib.unlinkSync(file);
77 |
78 | await submitJob({ job: { "jobs.testJob": { file, data: "worker" } } }, { queueName: "worker" });
79 | await lib.sleep(500)
80 |
81 | var data = lib.readFileSync(file);
82 | assert.match(data, /worker/);
83 | });
84 | });
85 |
86 |
87 |
--------------------------------------------------------------------------------
/tools/bkjs-nats:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | #
3 | # Author: Vlad Seryakov vseryakov@gmail.com
4 | # Sep 2013
5 | #
6 |
7 | case "$BKJS_CMD" in
8 |
9 | help|nats-help)
10 | echo ""
11 | echo " nats-get - install local NATS server in $BKJS_HOME/bin"
12 | echo " nats-getcli - install NATS command line tool in $BKJS_HOME/bin"
13 | echo " nats-run - run local NATS server installed in $BKJS_HOME/bin"
14 | echo " nats-stop - stop local NATS server"
15 | ;;
16 |
17 | nats-get)
18 | platform=$(to_lower $PLATFORM)
19 | curl -L -o /tmp/nats.tgz https://github.com/nats-io/nats-server/releases/download/v2.9.15/nats-server-v2.9.15-$platform-$OS_ARCH.tar.gz
20 | tar --strip-components=1 -C /tmp -xzf /tmp/nats.tgz
21 | mv /tmp/nats-server $BKJS_HOME/bin
22 | rm -rf /tmp/nats.tgz
23 | if [ ! -f $BKJS_HOME/etc/nats.conf ]; then
24 | echo 'listen: localhost:4222' >> $BKJS_HOME/etc/nats.conf
25 | echo 'http: localhost:8222' >> $BKJS_HOME/etc/nats.conf
26 | echo 'syslog: true' >> $BKJS_HOME/etc/nats.conf
27 | echo 'logtime: false' >> $BKJS_HOME/etc/nats.conf
28 | echo "pid_file: $BKJS_HOME/var/nats.pid" >> $BKJS_HOME/etc/nats.conf
29 | echo 'jetstream: {' >> $BKJS_HOME/etc/nats.conf
30 | echo " store_dir: \"$BKJS_HOME/var\"" >> $BKJS_HOME/etc/nats.conf
31 | echo ' max_file: 1G' >> $BKJS_HOME/etc/nats.conf
32 | echo '}' >> $BKJS_HOME/etc/nats.conf
33 | echo 'cluster {' >> $BKJS_HOME/etc/nats.conf
34 | echo ' name: nats' >> $BKJS_HOME/etc/nats.conf
35 | echo ' #listen: 0.0.0.0:6222' >> $BKJS_HOME/etc/nats.conf
36 | echo ' routes: [' >> $BKJS_HOME/etc/nats.conf
37 | echo ' nats-route://nats:6222' >> $BKJS_HOME/etc/nats.conf
38 | echo ' ]' >> $BKJS_HOME/etc/nats.conf
39 | echo '}' >> $BKJS_HOME/etc/nats.conf
40 | fi
41 | exit
42 | ;;
43 |
44 | nats-getcli)
45 | platform=$(to_lower $PLATFORM)
46 | curl -L -o /tmp/nats.zip https://github.com/nats-io/natscli/releases/download/v0.0.35/nats-0.0.35-$platform-$OS_ARCH.zip
47 | unzip -j /tmp/nats.zip -d /tmp '*/nats'
48 | mv /tmp/nats $BKJS_HOME/bin
49 | rm -rf /tmp/nats.zip
50 | exit
51 | ;;
52 |
53 | nats-run)
54 | name=$(get_arg -name $(uname -n|cut -f1 -d.))
55 | mkdir -p $BKJS_HOME/var $BKJS_HOME/log
56 | exec nohup nats-server -n $name -c $BKJS_HOME/etc/nats.conf >>$BKJS_HOME/log/message.log 2>&1 &
57 | exit
58 | ;;
59 |
60 | nats-stop)
61 | pkill -f nats
62 | exit
63 | ;;
64 |
65 | nats-init-monit)
66 | $0 monit-init -name nats -start "$BKJS_BIN nats-run" -stop "$BKJS_BIN nats-stop"
67 | exit
68 | ;;
69 |
70 | esac
71 |
72 |
--------------------------------------------------------------------------------
/examples/config/modules/config.js:
--------------------------------------------------------------------------------
1 | //
2 | // Author: Vlad Seryakov vseryakov@gmail.com
3 | // backendjs 2025
4 | //
5 |
6 | const { db, api, lib } = require('../../../lib/index');
7 |
8 | // Config module
9 | const mod = {
10 | name: "config",
11 | args: [
12 | { name: "roles", type: "list", descr: "List of roles that can access this module, ex: -config-roles admin,user" },
13 | ],
14 | tables: {
15 | bk_config: {
16 | name: { primary: 1 },
17 | ctime: { type: "now", primary: 2 },
18 | type: {},
19 | value: {},
20 | mtime: { type: "now" },
21 | },
22 | },
23 | roles: ["admin"],
24 | };
25 | module.exports = mod;
26 |
27 | // Create API endpoints
28 | mod.configureWeb = function(options, callback)
29 | {
30 | api.app.use("/config",
31 | api.express.Router().
32 | use(perms).
33 | get("/list", select).
34 | post("/put", put).
35 | post("/update", update).
36 | post("/del", del));
37 |
38 | callback();
39 | }
40 |
41 | function perms(req, res, next)
42 | {
43 | if (!lib.isFlag(mod.roles, req.user?.roles)) {
44 | return api.sendReply(res, 403, "access denied");
45 | }
46 | next();
47 | }
48 |
49 | function select(req, res)
50 | {
51 | var data = [];
52 | db.scan("bk_config", {}, { sync: 1 }, (rows) => {
53 | data.push(...rows);
54 | }, (err) => {
55 | api.sendJSON(req, err, { count: data.length, data });
56 | });
57 | }
58 |
59 | function put(req, res)
60 | {
61 | var query = api.toParams(req, {
62 | name: { required: 1 },
63 | type: {},
64 | value: {},
65 | });
66 | if (typeof query == "string") return api.sendReply(res, 400, query);
67 |
68 | db.put("bk_config", query, (err) => {
69 | api.sendJSON(req, err);
70 | });
71 | }
72 |
73 | function update(req, res)
74 | {
75 | var query = api.toParams(req, {
76 | ctime: { type: "int", required: 1 },
77 | name: { required: 1 },
78 | type: {},
79 | value: {},
80 | });
81 | if (typeof query == "string") return api.sendReply(res, 400, query);
82 |
83 | db.update("bk_config", query, (err) => {
84 | api.sendJSON(req, err);
85 | });
86 | }
87 |
88 | function del(req, res)
89 | {
90 | var query = api.toParams(req, {
91 | ctime: { type: "int", required: 1 },
92 | name: { required: 1 },
93 | });
94 | if (typeof query == "string") return api.sendReply(res, 400, query);
95 |
96 | db.del("bk_config", query, (err) => {
97 | api.sendJSON(req, err);
98 | });
99 | }
100 |
--------------------------------------------------------------------------------
/examples/kanban/README.md:
--------------------------------------------------------------------------------
1 | # Kanban Board - Alpine.js Implementation
2 |
3 | A full-featured Kanban board application built with Alpine.js and Alpinejs-app, featuring drag-and-drop, real-time updates, and SQLite/PostgreSQL persistence.
4 |
5 | ## Tech Stack
6 |
7 | - **Framework**: Backendjs with Alpinejs-app
8 | - **Database**: SQLite (local) / PostgreSQL (production)
9 | - **Deployment**: none
10 | - **Styling**: Bootstrap 5
11 | - **Drag & Drop**: native
12 | - **Animations**: Alpine.js
13 | - **Charts**: charts.css
14 | - **Validation**: backendjs
15 |
16 | ## Local Development
17 |
18 | The app uses a dual-database setup:
19 | - **Local Development**: node:sqlite
20 | - **Production**: PostgreSQL
21 |
22 | ### First Time Setup
23 |
24 | ```bash
25 | npm install
26 | npm run setup # Resets, migrates, and seeds the SQLite database
27 | npm run dev
28 | ```
29 |
30 | Visit [http://localhost:8000](http://localhost:8000)
31 |
32 | > **Note**: Migration files are included in the repo, so you don't need to generate them.
33 |
34 | ### Subsequent Runs
35 |
36 | ```bash
37 | npm run dev
38 | ```
39 |
40 | ## Database Setup
41 |
42 | The app uses a dual-database setup:
43 | - **Local Development**: node:sqlite
44 | - **Production**: PostgreSQL
45 |
46 | ### Local Database (SQLite)
47 |
48 | ```bash
49 | npm run setup # This automatically resets, migrates, and seeds
50 | ```
51 |
52 | ## Project Structure
53 |
54 | ```
55 | src/
56 | ├── web/
57 | │ ├── card.js # Card component
58 | │ ├── board.js # Board component
59 | │ └── index.html # Home page
60 | ├── modules/
61 | │ ├── board.js # Board API
62 | │ └── card.js # Card API
63 | tools/
64 | └── seed.js # DB seed file
65 | kanban.db # Local SQLite database
66 | ```
67 |
68 | ## Features
69 |
70 | - ✅ Create and manage multiple boards
71 | - ✅ Four fixed lists per board (Todo, In-Progress, QA, Done)
72 | - ✅ Create, edit, and delete cards
73 | - ✅ Drag-and-drop cards within and between lists
74 | - ✅ Assign users to cards
75 | - ✅ Add tags to cards with color coding
76 | - ✅ Add comments to cards
77 | - ✅ Mark cards as complete
78 | - ✅ Responsive design with Bootstrap theme
79 | - ✅ Board overview charts
80 | - ✅ Alpinejs-app for dynamic updates
81 | - ✅ Locality of behavior with inline event handlers
82 | - ✅ Native HTML dialogs
83 | - ✅ Error handling with loading states
84 | - ✅ Dual-database support (SQLite + PostgreSQL)
85 |
86 | ## Learn More
87 |
88 | - [Backendjs Documentation](https://vseryakov.github.io/backendjs/docs/web/index.html)
89 | - [Alpinejs-app Documentation](https://github.com/vseryakov/alpinejs-app)
90 | - [Alpine.js Documentation](https://alpinejs.dev/)
91 | - [Boostrap Documentation](https://getboostrap.com/)
92 |
93 | ## License
94 |
95 | MIT
96 |
--------------------------------------------------------------------------------
/tools/bkjs-ecs-agent:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | #
3 | # Author: Vlad Seryakov vseryakov@gmail.com
4 | # Aug 2024
5 | #
6 |
7 | case "$BKJS_CMD" in
8 |
9 | help|docker-help)
10 | echo ""
11 | echo " ecs-setup-agent - setup ECS agent to start in the current runlevel later, updates iptables"
12 | echo " ecs-start-agent - start ECS agent as a docker container if not running, start docker if not running"
13 | echo " ecs-stop-agent - stop ECS agent"
14 | ;;
15 |
16 | ecs-setup-agent)
17 | sysctl -w net.ipv4.conf.all.route_localnet=1
18 | iptables -t nat -A PREROUTING -p tcp -d 169.254.170.2 --dport 80 -j DNAT --to-destination 127.0.0.1:51679
19 | iptables -t nat -A OUTPUT -d 169.254.170.2 -p tcp -m tcp --dport 80 -j REDIRECT --to-ports 51679
20 |
21 | mkdir -p /etc/ecs/ /var/log/ecs /var/lib/ecs/data
22 | touch /etc/ecs/ecs.config
23 |
24 | conf=/etc/monit.d/ecs-agent.conf
25 | if [ ! -f $conf ]; then
26 | msg Setup ECS agent...
27 |
28 | $BKJS_BIN setup-rsyslog-docker -tag ID
29 | killall -HUP rsyslogd
30 |
31 | mkdir -p /etc/monit.d
32 | cycles=$(get_arg -cycles 2)
33 | cycles2=$(( $cycles*2 ))
34 | echo "check program ecs-agent with path \"$BKJS_BIN ecs-start-agent\" every $cycles cycles" >$conf
35 | echo " if status != 0 for 2 times within ${cycles2} cycles then alert" >> $conf
36 |
37 | rc-update add docker
38 | fi
39 | exit
40 | ;;
41 |
42 | ecs-start-agent)
43 | if ! rc-service docker status; then
44 | rc-service docker start
45 | exit 0
46 | fi
47 |
48 | if docker top ecs-agent; then
49 | exit 0
50 | fi
51 |
52 | cluster=$(imds meta-data/tags/instance/ECS_CLUSTER)
53 |
54 | exec docker run -d --name ecs-agent \
55 | --restart=unless-stopped \
56 | --volume=/var/run:/var/run \
57 | --volume=/var/log/ecs/:/log \
58 | --volume=/var/lib/ecs/data:/data \
59 | --volume=/etc/ecs:/etc/ecs \
60 | --volume=/sbin:/host/sbin \
61 | --volume=/lib:/lib \
62 | --volume=/usr/lib:/usr/lib \
63 | --volume=/proc:/host/proc \
64 | --volume=/sys/fs/cgroup:/sys/fs/cgroup \
65 | --net=host \
66 | --env-file=/etc/ecs/ecs.config \
67 | --env=ECS_CLUSTER=${cluster:-default} \
68 | --env=ECS_LOGFILE=/log/ecs-agent.log \
69 | --env=ECS_DATADIR=/data \
70 | --env=ECS_ENABLE_TASK_IAM_ROLE=true \
71 | --env=ECS_ENABLE_TASK_IAM_ROLE_NETWORK_HOST=true \
72 | --env=ECS_AVAILABLE_LOGGING_DRIVERS='["json-file","awslogs","syslog","none"]' \
73 | --env=ECS_ENABLE_AWSLOGS_EXECUTIONROLE_OVERRIDE=true \
74 | --cap-add=sys_admin \
75 | --cap-add=net_admin \
76 | public.ecr.aws/ecs/amazon-ecs-agent:latest
77 | ;;
78 |
79 | ecs-stop-agent)
80 | exec docker rm -f ecs-agent
81 | ;;
82 |
83 | esac
84 |
--------------------------------------------------------------------------------
/lib/metrics.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | *
5 | * Based on https://github.com/felixge/node-measured
6 | */
7 |
8 | /**
9 | * Metrics library
10 | * @module metrics
11 | */
12 |
13 | exports.name = "metrics";
14 |
15 | /** @var {Counter} */
16 | exports.Counter = require('./metrics/Counter');
17 |
18 | /** @var {Histogram} */
19 | exports.Histogram = require('./metrics/Histogram');
20 |
21 | /** @var {Meter} */
22 | exports.Meter = require('./metrics/Meter');
23 |
24 | /** @var {Timer} */
25 | exports.Timer = require('./metrics/Timer');
26 |
27 | /** @var {TokenBucket} */
28 | exports.TokenBucket = require('./metrics/TokenBucket');
29 |
30 | /** @var {Trace} */
31 | exports.Trace = require('./metrics/Trace');
32 |
33 | /** @var {FakeTrace} */
34 | exports.FakeTrace = require('./metrics/FakeTrace');
35 |
36 | /**
37 | * Convert all metrics for all propeties.
38 | * Options:
39 | * - reset - true to reset all metrics
40 | * - take - regexp for variable that should use `take` i.e. resetable counters
41 | * - skip - regexp of properties to ignore
42 | * @memberof module:metrics
43 | * @method toJSON
44 | */
45 | exports.toJSON = function(obj, options)
46 | {
47 | var rc = {};
48 | for (const p in obj) {
49 | const type = typeof obj[p];
50 | if (!obj[p] || type == "function") continue;
51 | if (options?.skip?.test && options.skip.test(p)) continue;
52 |
53 | if (typeof obj[p].toJSON == "function") {
54 | rc[p] = obj[p].toJSON(options);
55 | } else
56 | if (type == "object") {
57 | rc[p] = this.toJSON(obj[p], options);
58 | } else
59 | if (type == "number") {
60 | rc[p] = obj[p];
61 | if (options?.take?.test && options.take.test(p)) {
62 | obj[p] = 0;
63 | }
64 | }
65 | }
66 | return rc;
67 | }
68 |
69 | /**
70 | * Increments a counter in an object, creates a new var if not exist or not a number
71 | *
72 | * @param {object} obj
73 | * @param {string} name
74 | * @param {number} [coount=1]
75 | * @return {number}
76 | * @memberof module:metrics
77 | * @method incr
78 | */
79 | exports.incr = function(obj, name, count)
80 | {
81 | if (typeof obj[name] != "number") obj[name] = 0;
82 | obj[name] += typeof count == "number" ? count : 1;
83 | return obj[name];
84 | }
85 |
86 | /**
87 | * Return the value for the given var and resets it to 0
88 | * @param {object} obj
89 | * @param {string} name
90 | * @return {number}
91 | * @memberof module:metrics
92 | * @method take
93 | */
94 | exports.take = function(obj, name)
95 | {
96 | if (typeof obj[name] !== "number") return 0;
97 | const n = obj[name];
98 | obj[name] = 0;
99 | return n;
100 | }
101 |
102 |
--------------------------------------------------------------------------------
/lib/queue/json.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const lib = require(__dirname + '/../lib');
7 | const logger = require(__dirname + '/../logger');
8 | const QueueClient = require(__dirname + "/client");
9 | const fs = require("fs");
10 |
11 | const jsonClient = {
12 | name: "json",
13 |
14 | create: function(options) {
15 | if (/^json:\/\//.test(options?.url)) return new JSONClient(options);
16 | }
17 | };
18 | module.exports = jsonClient;
19 |
20 | /**
21 | * Queue client using JSON files, one event per line.
22 | *
23 | * File name format: queueName-YYYY-MM-DDTHH:MM:SS.MSECZ-SEQNUM
24 | *
25 | * The URL must look like: `json://...`.
26 | * If no path is given it is placed in the current directory.
27 | *
28 | * Files are rotated by size or number of lines whatever is met first,
29 | * use cache config options `bk-size` and `bk-count` to set
30 | *
31 | * @example
32 | * -queue-events json://
33 | * -queue-events json:///path/accesslog-?bk-count=1000&bk-size=1000000
34 | * @memberOf module:queue
35 | */
36 |
37 | class JSONClient extends QueueClient {
38 |
39 | file
40 | name
41 | seq = 0
42 | size = 0;
43 | count = 0;
44 |
45 | constructor(options) {
46 | super(options);
47 | this.name = jsonClient.name;
48 | this.applyOptions();
49 | this.emit("ready");
50 | }
51 |
52 | submit(events, options, callback) {
53 | logger.dev("submit:", this.url, events, options);
54 |
55 | lib.series([
56 | (next) => {
57 | if (this.file) return next();
58 | this.name = `${this.pathname || ""}-${this.queueName}-${new Date().toISOString()}-${this.seq++}.json`;
59 | fs.open(this.name, 'w', (err, handle) => {
60 | if (!err) this.file = handle;
61 | next(err);
62 | });
63 | },
64 |
65 | (next) => {
66 | if (!Array.isArray(events)) events = [events];
67 | fs.write(this.file, events.map(x => {
68 | var line = JSON.stringify(x) + "\n";
69 | this.count++;
70 | this.size += line.length;
71 | return line;
72 | }).join(""), next);
73 | },
74 |
75 | (next) => {
76 | if ((this.options.size > 0 && this.size >= this.options.size) ||
77 | (this.options.count > 0 && this.count >= this.options.count)) {
78 | logger.debug("submit:", this.url, "closing", this.name, this.size, this.count);
79 | this.file = null;
80 | this.size = this.count = 0;
81 | }
82 | next();
83 | },
84 |
85 | ], callback, true);
86 | }
87 | }
88 |
89 |
--------------------------------------------------------------------------------
/lib/api/redirect.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 | const util = require("util");
6 | const lib = require(__dirname + '/../lib');
7 | const logger = require(__dirname + '/../logger');
8 |
9 | /**
10 | * @module api/redirect
11 | */
12 |
13 | const mod = {
14 | name: "api.redirect",
15 | args: [
16 | { name: "err-(.+)", descr: "Error messages for various cases" },
17 | { name: "url", type: "regexpmap", descr: "Add to the list a JSON object with property name defining a location regexp to be matched early against in order to redirect using the value of the property, if the regexp starts with !, that means it must be removed from the list, variables can be used for substitution: @HOST@, @PATH@, @URL@, @BASE@, @DIR@, @QUERY@, status code can be prepended to the location", example: "{ '^[^/]+/path/$': '/path2/index.html', '.+/$': '301:@PATH@/index.html' }" },
18 | { name: "login-(.+)", type: "regexpobj", reverse: 1, nocamel: 1, obj: "login", descr: "Define a location where to redirect if no login is provided, same format and placeholders as in redirect-url", example: "api-redirect-login-^/admin/=/login.html" },
19 | { name: "reset", type: "callback", callback: function(v) { if (v) this.reset() }, descr: "Reset all rules" },
20 | ],
21 |
22 | };
23 |
24 | /**
25 | * configuration based request redirection
26 | */
27 |
28 | module.exports = mod;
29 |
30 | mod.reset = function()
31 | {
32 | delete this.url;
33 | delete this.login;
34 | }
35 |
36 | /**
37 | * Check a request for possible redirection condition based on the configuration.
38 | * This is used by API servers for early redirections. It returns null
39 | * if no redirects or errors happend, otherwise an object with status that is expected by the `api.sendStatus` method.
40 | * The options is expected to contain the following cached request properties:
41 | * - path - from req.path or the request pathname only
42 | * - host - from req.hostname or the hostname part only
43 | * - port - port from the host: header if specified
44 | * - secure - if the protocol is https
45 | */
46 | mod.check = function(req, name = "url")
47 | {
48 | var url = req.url, location = req.options.host + url;
49 | var rules = this[name];
50 | for (var i in rules) {
51 | const rx = util.types.isRegExp(rules[i]?.rx) ? rules[i].rx : util.types.isRegExp(rules[i]) ? rules[i] : null;
52 | if (rx && (rx.test(url) || rx.test(location))) {
53 | let loc = !lib.isNumeric(i) ? i : rules[i].value || "";
54 | if (!loc) continue;
55 | var status = 302;
56 | if (loc[0]== "3" && loc[1] == "0" && loc[3] == ":") {
57 | status = lib.toNumber(loc.substr(0, 3), { dflt: 302 });
58 | loc = loc.substr(4);
59 | }
60 | loc = this.checkRedirectPlaceholders(req, loc);
61 | logger.debug("checkRedirectRules:", name, location, req.options.path, "=>", status, loc, "rule:", i, rules[i]);
62 | return { status: status, url: loc };
63 | }
64 | }
65 | return null;
66 | }
67 |
--------------------------------------------------------------------------------
/lib/metrics/Meter.js:
--------------------------------------------------------------------------------
1 |
2 | const ExponentiallyMovingWeightedAverage = require('./ExponentiallyMovingWeightedAverage');
3 |
4 |
5 | module.exports = class Meter {
6 |
7 | /**
8 | * - Meter - Things that are measured as events / interval.
9 | * - count: The total of all values added to the meter.
10 | * - rate: The rate of the meter since the last toJSON() call.
11 | * - mean: The average rate since the meter was started.
12 | * - m1: The rate of the meter biased towards the last 1 minute.
13 | * - m5: The rate of the meter biased towards the last 5 minutes.
14 | * - m15: The rate of the meter biased towards the last 15 minutes.
15 | * @param {object} [options]
16 | * @class Meter
17 | */
18 | constructor(options) {
19 | if (options?.reset) this._reset = options?.reset;
20 | this._unit = options?.unit || 1000;
21 | this._interval = options?.interval || 5000;
22 | this._init();
23 | }
24 |
25 | _init() {
26 | this._m1Rate = new ExponentiallyMovingWeightedAverage(60000, this._interval);
27 | this._m5Rate = new ExponentiallyMovingWeightedAverage(5 * 60000, this._interval);
28 | this._m15Rate = new ExponentiallyMovingWeightedAverage(15 * 60000, this._interval);
29 | this._count = this._sum = 0;
30 | }
31 |
32 | mark(value) {
33 | if (!this._timer) this.start();
34 | value = typeof value == "number" && value || 1;
35 | this._count += value;
36 | this._sum += value;
37 | this._m1Rate.update(value);
38 | this._m5Rate.update(value);
39 | this._m15Rate.update(value);
40 | this.lastMark = Date.now();
41 | }
42 |
43 | start() {
44 | clearInterval(this._timer);
45 | this._timer = setInterval(this._tick.bind(this), this._interval);
46 | this.startTime = this.lastJSON = this.lastMark = Date.now();
47 | }
48 |
49 | end() {
50 | clearInterval(this._timer);
51 | delete this._timer;
52 | }
53 |
54 | _tick() {
55 | this._m1Rate.tick();
56 | this._m5Rate.tick();
57 | this._m15Rate.tick();
58 | }
59 |
60 | reset() {
61 | this.end();
62 | this._init();
63 | }
64 |
65 | meanRate() {
66 | if (this._count === 0) return 0;
67 | return this._count / (Date.now() - this.startTime) * this._unit;
68 | }
69 |
70 | currentRate() {
71 | var now = Date.now();
72 | var duration = now - this.lastJSON;
73 | var rate = duration ? this._sum / duration * this._unit : 0;
74 | this._sum = 0;
75 | this.lastJSON = now;
76 | return rate;
77 | }
78 |
79 | toJSON(options) {
80 | const rc = {
81 | count: this._count,
82 | rate: this.currentRate(),
83 | mean: this.meanRate(),
84 | m1: this._m1Rate.rate(this._unit),
85 | m5: this._m5Rate.rate(this._unit),
86 | m15: this._m15Rate.rate(this._unit),
87 | };
88 | if (this._reset || options?.reset) this.reset();
89 | return rc;
90 | }
91 |
92 | }
93 |
94 |
--------------------------------------------------------------------------------
/lib/lib/uuid.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const crypto = require('crypto');
7 | const lib = require(__dirname + '/../lib');
8 |
9 | /**
10 | * Unique Id (UUID v4) without any special characters and in lower case
11 | * @param {string} [prefix] - prepend with prefix
12 | * @return {string}
13 | * @memberof module:lib
14 | * @method uuid
15 | */
16 | lib.uuid = function(prefix)
17 | {
18 | return (prefix || "") + crypto.randomUUID().replace(/[-]/g, '').toLowerCase();
19 | }
20 |
21 | /**
22 | * Generate a 22 chars slug from an UUID
23 | * @param {object} [options]
24 | * @param {string} [options.alphabet] - chars allowed in hashids, default is lib.uriSafe
25 | * @param {string} [options.prefix] - repend with prefix
26 | * @return {string}
27 | * @memberof module:lib
28 | * @method slug
29 | */
30 | lib.slug = function(options)
31 | {
32 | var bits = "0000" + BigInt("0x" + lib.uuid()).toString(2);
33 | var bytes = [];
34 | for (let i = 0; i < bits.length; i += 6) bytes.push(bits.substr(i, 6));
35 | const alphabet = options?.alphabet || lib.uriSafe;
36 | return (options?.prefix || "") + bytes.map((x) => alphabet[parseInt(x, 2) % alphabet.length]).join("");
37 | }
38 |
39 | /**
40 | * Short unique id within a microsecond
41 | * @param {string} [prefix] - prepend with prefix
42 | * @param {object} [options] - same options as for {@link module:lib.getHashid}
43 | * @return {string} generated hash
44 | * @memberof module:lib
45 | * @method suuid
46 | */
47 | lib.suuid = function(prefix, options)
48 | {
49 | var hashid = this.getHashid(options);
50 | var s = hashid.encode(lib.clock(), hashid._counter);
51 | return prefix ? prefix + s : s;
52 | }
53 |
54 | /**
55 | * Generate a SnowFlake unique id as 64-bit number
56 | * Format: time - 41 bit, node - 10 bit, counter - 12 bit
57 | * Properties can be provided:
58 | * - now - time, if not given local epoch clock is used in microseconds
59 | * - epoch - local epoch type, default is milliseconds, `m` for microseconds, `s` for seconds
60 | * - node - node id, limited to max 1024
61 | * - radix - default is 10, use any value between 2 - 36 for other numeric encoding
62 | */
63 | lib.sfuuid = function(options)
64 | {
65 | var node = options?.node || lib.sfuuidNode;
66 | if (node === undefined) {
67 | var intf = lib.networkInterfaces()[0];
68 | if (intf) lib.sfuuidNode = node = lib.murmurHash3(intf.mac);
69 | }
70 | var now = options?.now || lib.localEpoch(options?.epoch);
71 | var n = BigInt(now) << 22n | (BigInt(node % 1024) << 12n) | BigInt(lib.sfuuidCounter++ % 4096);
72 | return n.toString(options?.radix || 10);
73 | }
74 |
75 | lib.sfuuidCounter = 0;
76 |
77 | // Parse an id into original components: now, node, counter
78 | lib.sfuuidParse = function(id)
79 | {
80 | const _map = { now: [22n, 64n], node: [12n, 10n], counter: [0n, 12n] };
81 | const rc = {};
82 | try {
83 | id = rc.id = BigInt(id);
84 | for (const p in _map) {
85 | rc[p] = Number((id & (((1n << _map[p][1]) - 1n) << _map[p][0])) >> _map[p][0]);
86 | }
87 | } catch (e) {}
88 | return rc;
89 | }
90 |
91 |
92 |
--------------------------------------------------------------------------------
/tools/bkjs-docker:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | #
3 | # Author: Vlad Seryakov vseryakov@gmail.com
4 | # Nov 2021
5 | #
6 |
7 | case "$BKJS_CMD" in
8 |
9 | help|docker-help)
10 | echo ""
11 | echo " docker-build-tag -t TAG [-version V] [-path .] [-root H] - build an image for the specified tag"
12 | echo " docker-run-tag -t TAG [-path .] [-force] - run a container for the specified tag"
13 | echo " docker-restart NAME - restart a container, for use with bkrsync"
14 | echo " docker-compose-get - install docker compose plugin in /usr/local/bin"
15 | echo " docker-ecr-login-get - install ECR login utility for docker in ~/bin"
16 | echo " docker-init-binfmt - initialize local docker to support multiple platforms in the default builder by using binfmt"
17 | ;;
18 |
19 | docker-build-tag)
20 | tag=$(get_arg -tag)
21 | version=$(get_arg -version)
22 | path=$(get_arg -path .)
23 | root=$(get_arg -root .)
24 |
25 | [ ! -f $path/Dockerfile.$tag ] && echo "$BKJS_CMD: no Dockerfile.$tag found in $path" && exit 1
26 |
27 | [ -f $path/path.$tag ] && path="$root$(head -1 $path/path.$tag)"
28 | [ ! -d $root ] && echo "$BKJS_CMD: invalid $tag context path: $root" && exit 1
29 |
30 | if [ ! -f $root/.dockerignore -a -f $path/dockerignore.$tag ]; then
31 | cp $path/dockerignore.$tag $root/.dockerignore
32 | dockerignore=yes
33 | fi
34 |
35 | [ -f $path/build.$tag ] && cmd=$(cat $path/build.$tag|tr '\n' ' ')
36 | [ ! -z $version ] && cmd="$cmd -t $tag:$version"
37 |
38 | cmd="docker build --rm --progress=plain -t $tag -f $path/Dockerfile.$tag $cmd $root"
39 | debug $cmd
40 |
41 | $cmd
42 | rc=$?
43 |
44 | [ "$dockerignore" = "yes" ] && rm -f $root/.dockerignore
45 | exit $rc
46 | ;;
47 |
48 | docker-run-tag)
49 | tag=$(get_arg -tag)
50 | path=$(get_arg -path .)
51 |
52 | [ -z $tag ] && echo "$BKJS_CMD: -tag must be provided" && exit 1
53 | [ -f $path/run.$tag ] && cmd=$(cat $path/run.$tag|tr '\n' ' ')
54 |
55 | if [ "$(get_flag -force)" != "" ]; then
56 | pids=$(docker ps -aq -f name=$tag)
57 | [ ! -z $pids ] && docker rm -f $pids
58 | fi
59 |
60 | cmd="docker run -d --name $tag ${cmd:-$tag} $(get_all_args "-tag -path -force")"
61 | debug $cmd
62 |
63 | $cmd
64 | exit
65 | ;;
66 |
67 | docker-restart)
68 | exec docker restart $BKJS_ARGV0
69 | ;;
70 |
71 | docker-init-binfmt)
72 | docker run --rm --privileged linuxkit/binfmt:312ed1cb899fae229b5303ac6c0510ac58f331c8
73 | exit
74 | ;;
75 |
76 | docker-compose-get)
77 | wget -L -O /usr/local/bin/docker-compose https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)
78 | chmod 755 /usr/local/bin/docker-compose
79 | ln -s /usr/local/bin/docker-compose /usr/libexec/docker/cli-plugins/docker-compose
80 | exit
81 | ;;
82 |
83 | docker-ecr-login-get)
84 | go install github.com/awslabs/amazon-ecr-credential-helper/ecr-login/cli/docker-credential-ecr-login@latest
85 | mv ~/go/bin/docker-credential-ecr-login $BKJS_HOME/bin
86 | echo "{ \"auths\": {}, \"credsStore\": \"ecr-login\" }" > ~/.docker/config.json
87 | exit
88 | ;;
89 |
90 | esac
91 |
--------------------------------------------------------------------------------
/web/js/app-send.js:
--------------------------------------------------------------------------------
1 | /*!
2 | * alpinejs-app client
3 | * Vlad Seryakov vseryakov@gmail.com 2018
4 | */
5 |
6 | (() => {
7 | var app = window.app;
8 |
9 | // Send a request using app.fetch, call the callback with error and result.
10 | // - options can be a string with url or an object with options.url, options.body and options.method properties
11 | // - POST is default
12 | //
13 | app.send = function(options, callback)
14 | {
15 | if (app.isS(options)) options = { url: options };
16 | if (!options.headers) options.headers = {};
17 | options.headers["bk-tz"] = (new Date()).getTimezoneOffset();
18 | for (const p in app.headers) {
19 | options.headers[p] ??= app.headers[p];
20 | }
21 | for (const p in options.body) {
22 | if (options.body[p] === undefined) delete options.body[p];
23 | }
24 | options.method ??= 'POST';
25 | app.emit("send:start");
26 |
27 | app.fetch(options, (err, data, info) => {
28 | app.emit("send:stop");
29 |
30 | var h = info?.headers["bk-csrf"] || "";
31 | switch (h) {
32 | case "":
33 | break;
34 | case "0":
35 | if (!app.headers) break;
36 | delete app.headers["bk-csrf"];
37 | break;
38 | default:
39 | if (!app.headers) app.headers = {};
40 | app.headers["bk-csrf"] = h;
41 | }
42 |
43 | if (err) {
44 | if (options.alert) {
45 | var a = app.isS(options.alert);
46 | app.emit("alert", "error", a || err, { safe: !a });
47 | }
48 | } else {
49 | if (options.info_msg || options.success_msg) {
50 | app.emit("alert", options.info_msg ? "info" : "success", options.info_msg || options.success_msg);
51 | }
52 | }
53 | app.call(callback, err, data, info);
54 | });
55 | }
56 |
57 | // Send file(s) as multi-part upload in the `options.files` object. Optional form inputs
58 | // can be specified in the `options.body` object.
59 | app.sendFile = function(options, callback)
60 | {
61 | var body = new FormData();
62 | for (const p in options.files) {
63 | const file = options.files[p];
64 | if (!file?.files?.length) continue;
65 | body.append(p, file.files[0]);
66 | }
67 |
68 | const add = (k, v) => {
69 | body.append(k, app.isF(v) ? v() : v === null || v === true ? "" : v);
70 | }
71 |
72 | const build = (key, val) => {
73 | if (val === undefined) return;
74 | if (Array.isArray(val)) {
75 | for (const i in val) build(`${key}[${app.isO(val[i]) ? i : ""}]`, val[i]);
76 | } else
77 | if (app.isObject(val)) {
78 | for (const n in val) build(`${key}[${n}]`, val[n]);
79 | } else {
80 | add(key, val);
81 | }
82 | }
83 | for (const p in options.body) {
84 | build(p, options.body[p]);
85 | }
86 | for (const p in options.json) {
87 | const blob = new Blob([JSON.stringify(options.json[p])], { type: "application/json" });
88 | body.append(p, blob);
89 | }
90 |
91 | var req = { url: options.url, body };
92 | for (const p in options) {
93 | req[p] ??= options[p];
94 | }
95 | app.send(req, callback);
96 | }
97 |
98 | })();
99 |
--------------------------------------------------------------------------------
/lib/util/shell.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const { app, shell, lib, logger, ipc } = require('../modules');
7 |
8 | /**
9 | * @module shell
10 | */
11 |
12 | /**
13 | * Shell command interface for `bksh`
14 | *
15 | * Run `bksh -help` to see all registered shell commands.
16 | *
17 | * Special global command-line arguments:
18 | *
19 | * - `-noexit` - keep the shell running after executing the command
20 | * - `-exit` - exit with error if no shell command found
21 | * - `-exit-timeout MS` - will be set to ms to wait before exit for async actions to finish
22 | * - `-shell-delay MS` - will wait before running the command to allow initialization complete
23 | *
24 | * Shell functions must be defined in `shell.commands` object,
25 | * where `myCommand` is the command name in camel case for `-my-command`
26 | *
27 | * The function may return special values:
28 | * - `stop` - stop processing commands and create REPL
29 | * - `continue` - do not exit and continue processing other commands or end with REPL
30 | *
31 | * all other values will result in returning from the run assuming the command will decide what to do, exit or continue running, no REPL is created
32 | *
33 | * @example
34 | * const { shell } = require("backendjs");
35 | *
36 | * shell.commands.myCommand = function(options) {
37 | * console.log("hello");
38 | * return "continue"
39 | * }
40 | * // Calling `bksh -my-command` it will run this command.
41 | */
42 | module.exports = Shell;
43 |
44 | function Shell(options)
45 | {
46 | require("../shell/aws");
47 | require("../shell/db");
48 | require("../shell/shell");
49 | require("../shell/users");
50 |
51 | shell.exitTimeout = lib.getArgInt("-exit-timeout", 1000);
52 | var delay = lib.getArgInt("-shell-delay");
53 |
54 | app.runMethods("configureShell", options, (err) => {
55 | if (options.done) process.exit();
56 |
57 | if (app.isPrimary) {
58 | ipc.initServer();
59 | } else {
60 | ipc.initWorker();
61 | }
62 | var cmd;
63 |
64 | for (var i = 1; i < process.argv.length; i++) {
65 | if (process.argv[i][0] != '-') continue;
66 | var name = lib.toCamel(process.argv[i].substr(1));
67 | if (typeof shell.commands[name] != "function") continue;
68 | cmd = name;
69 | if (delay) {
70 | return setTimeout(shell.commands[name].bind(shell, options), delay);
71 | }
72 | var rc = shell.commands[name](options);
73 | logger.debug("start:", shell.name, name, rc);
74 |
75 | if (rc == "stop") break;
76 | if (rc == "continue") continue;
77 | if (lib.isArg("-noexit")) continue;
78 | return;
79 | }
80 | if (!cmd && lib.isArg("-exit")) {
81 | return shell.exit("no shell command found");
82 | }
83 | if (app.isPrimary) {
84 | const repl = app.createRepl({ file: app.repl.file, size: app.repl.size });
85 | repl.on('exit', () => {
86 | app.runMethods("shutdownShell", { sync: 1 }, () => {
87 | setTimeout(() => { process.exit() }, shell.exitTimeout);
88 | });
89 | });
90 | }
91 | });
92 | }
93 |
94 |
--------------------------------------------------------------------------------
/lib/util/redis.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2025
4 | */
5 |
6 | const net = require('net');
7 | const logger = require(__dirname + '/../logger');
8 | const lib = require(__dirname + '/../lib');
9 |
10 | const mod = {
11 | name: "redis",
12 | args: [
13 | { name: "host", descr: "Default Redis host" },
14 | { name: "port", type: "int", descr: "Default Redis port" },
15 | ],
16 | port: 6379,
17 | Client,
18 | };
19 | module.exports = mod;
20 |
21 | var Parser;
22 |
23 | class Client {
24 | callbacks = [];
25 |
26 | constructor(options)
27 | {
28 | this.options = Object.assign({ port: mod.port, host: mod.host }, options);
29 |
30 | Parser = Parser || require('redis-parser');
31 |
32 | this.parser = new Parser({
33 | returnBuffers: this.options.returnBuffers,
34 | returnReply: data => {
35 | const cb = this.callbacks[0];
36 | if (typeof cb != "function" || cb(null, data) !== -1999) this.callbacks.shift();
37 | },
38 | returnError: err => {
39 | const cb = this.callbacks[0];
40 | if (typeof cb != "function" || cb(err) !== -1999) this.callbacks.shift();
41 | }
42 | });
43 |
44 | this.connect();
45 | }
46 |
47 | connect()
48 | {
49 | this.connecting = true;
50 | this.callbacks = [];
51 |
52 | this.socket = net.createConnection(this.options, () => {
53 | this.ready = true;
54 | delete this.connecting;
55 | });
56 |
57 | this.socket.on('data', (data) => {
58 | this.parser.execute(data);
59 | }).on('error', (err) => {
60 | const cb = this.callbacks.shift();
61 | if (typeof cb == "function") cb(err);
62 | }).on('close', () => {
63 | delete this.ready;
64 | delete this.socket;
65 | });
66 | }
67 |
68 | call(...args)
69 | {
70 | if (!this.ready) return;
71 | this.callbacks.push(args.at(-1));
72 | this.socket.write(this.encode(args));
73 | }
74 |
75 | multi(...args)
76 | {
77 | if (!this.ready) return;
78 | var replies = [], error, callback = args.at(-1);
79 | var cmds = args.filter(lib.isArray);
80 | this.callbacks.push((err, reply) => {
81 | error = error || err;
82 | replies.push(err || reply);
83 | if (replies.length != cmds.length) return -1999;
84 | if (typeof callback == "function") callback(error, replies);
85 | });
86 | this.socket.write(cmds.map(this.encode).join("") + "\r\n");
87 | }
88 |
89 | destroy()
90 | {
91 | this.destroyed = true;
92 | if (this.socket) this.socket.destroy();
93 | }
94 |
95 | encode(cmd)
96 | {
97 | if (!lib.isArray(cmd)) return "";
98 | var rc = `*${cmd.length}\r\n`;
99 | for (let arg of cmd) {
100 | if (typeof arg == "function") continue;
101 | if (typeof arg != "string") arg = String(arg);
102 | rc += `$${Buffer.byteLength(arg)}\r\n${arg}\r\n`;
103 | }
104 | return rc;
105 | }
106 |
107 | }
108 |
--------------------------------------------------------------------------------
/lib/lib/lru.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const lib = require(__dirname + "/../lib");
7 |
8 | lib.LRUCache = class LRUCache {
9 |
10 | /**
11 | * Simple LRU cache in memory, supports get,put,del operations only, TTL can be specified in milliseconds as future time
12 | * @param {number} [max] - max number of items in the cache
13 | * @class LRUCache
14 | * @example
15 | * const { lib } = require("backendjs")
16 | *
17 | * const lru = new lib.LRUCache(1000)
18 | *
19 | */
20 | constructor(max) {
21 | this.max = max || 10000;
22 | this.map = new Map();
23 | this.head = {};
24 | this.tail = this.head.next = { prev: this.head };
25 | }
26 |
27 | /**
28 | * Return an item by key
29 | * @param {string} key
30 | * @return {any|undefined} an item if found
31 | * @memberof LRUCache
32 | * @method get
33 | */
34 | get(key) {
35 | const node = this.map.get(key);
36 | if (node === undefined) return;
37 | if (node.ttl && node.ttl < Date.now()) {
38 | this.del(key);
39 | return;
40 | }
41 | node.prev.next = node.next;
42 | node.next.prev = node.prev;
43 | this.tail.prev.next = node;
44 | node.prev = this.tail.prev;
45 | node.next = this.tail;
46 | this.tail.prev = node;
47 | return node.value;
48 | }
49 |
50 | /**
51 | * Put an item into cache, if total number of items exceed the max then the oldest item is removed
52 | * @param {string} key
53 | * @param {any} value
54 | * @param {number} [ttl] in milliseconds
55 | * @memberof LRUCache
56 | * @method put
57 | */
58 | put(key, value, ttl) {
59 | if (this.get(key) !== undefined) {
60 | this.tail.prev.value = value;
61 | return true;
62 | }
63 | if (this.map.size === this.max) {
64 | this.map.delete(this.head.next.key);
65 | this.head.next = this.head.next.next;
66 | this.head.next.prev = this.head;
67 | }
68 | const node = { value, ttl };
69 | this.map.set(key, node);
70 | this.tail.prev.next = node;
71 | node.prev = this.tail.prev;
72 | node.next = this.tail;
73 | this.tail.prev = node;
74 | }
75 |
76 | /**
77 | * Remove a item from cache
78 | * @param {string} key
79 | * @return {boolean} true if removed
80 | * @memberof LRUCache
81 | * @method del
82 | */
83 | del(key) {
84 | const node = this.map.get(key);
85 | if (node === undefined) return false;
86 | node.prev.next = node.next;
87 | node.next.prev = node.prev;
88 | if (node == this.head) this.head = node.next;
89 | if (node == this.tail) this.tail = node.prev;
90 | this.map.delete(key);
91 | return true;
92 | }
93 |
94 | /**
95 | * @memberof LRUCache
96 | * @method clean
97 | */
98 | clean() {
99 | const now = Date.now(), s = this.map.size;
100 | for (const [key, val] of this.map) {
101 | if (val.ttl && val.ttl < now) this.del(key);
102 | }
103 | return s - this.map.size;
104 | }
105 | }
106 |
107 |
--------------------------------------------------------------------------------
/examples/config/web/config.js:
--------------------------------------------------------------------------------
1 |
2 | app.components.config = class extends app.AlpineComponent {
3 |
4 | rows = [];
5 | types = [];
6 | query = "";
7 |
8 | onCreate() {
9 | this.show();
10 |
11 | app.$("input", this.$el)?.focus();
12 | }
13 |
14 | refresh() {
15 | this.show();
16 | }
17 |
18 | close() {
19 | app.render("index")
20 | }
21 |
22 | filter() {
23 | var list = this.rows, q = this.query;
24 | if (q) list = this.rows.filter((x) => (x.type.includes(q) || x.name.includes(q) || x.value.includes(q)));
25 | list.sort((a,b) => (a.type < b.type ? -1 : a.type > b.type ? 1 : app.util.toNumber(a.sort) - app.util.toNumber(b.sort) || (a.ctime - b.ctime)));
26 |
27 | var types = {};
28 | list.forEach((x) => {
29 | x.icon = x.status == "ok" ? "fa-check" : "fa-ban";
30 | x.text = x.name + " = " + x.value;
31 | if (!types[x.type]) types[x.type] = [];
32 | types[x.type].push(x);
33 | });
34 | return Object.keys(types).map(x => ({ type: x, rows: types[x], q }));
35 | }
36 |
37 | show() {
38 | app.fetch('/config/list', (err, rc) => {
39 | if (err) return app.emit("alert", "error", err);
40 | this.rows = app.util.isArray(rc.data, []);
41 | });
42 | }
43 |
44 | edit(data) {
45 | var popup;
46 | popup = bootpopup({
47 | title: "Config Details",
48 | horizontal: 1,
49 | backdrop: false,
50 | keyboard: false,
51 | alert: 1,
52 | empty: 1,
53 | size: "xlarge",
54 | size_label: "col-sm-3",
55 | size_input: "col-sm-9",
56 | class_content: "modal-content border-3 border-blue bg-light min-vh-70",
57 | content: [
58 | { input: { name: "type", label: "Type:", value: data.type } },
59 | { input: { name: "name", label: "Name:", value: data.name, } },
60 | { textarea: { name: "value", class: "form-control", label: "Value:", rows: 5, value: data.value } },
61 | ],
62 | buttons: ["cancel", "Save", data.name && "Copy", data.name && "Delete"],
63 |
64 | Save: (d) => {
65 | if (!d.type || !d.name || !d.value) return popup.showAlert("Type, name and value are required");
66 | d.ctime = data.ctime;
67 | app.fetch({ url: `/config/${d.ctime ? "update" : "put"}`, body: d, post: 1 }, (err) => {
68 | if (err) return popup.showAlert(err);
69 | this.show();
70 | popup.close();
71 | });
72 | return null;
73 | },
74 |
75 | Copy: (d) => {
76 | app.fetch({ url: '/config/put', body: d, post: 1 }, (err) => {
77 | if (err) return popup.showAlert(err);
78 | this.show();
79 | popup.close();
80 | });
81 | return null;
82 | },
83 |
84 | Delete: (d) => {
85 | app.ui.showConfirm.call(this, "Delete this parameter?", () => {
86 | app.fetch({ url: '/config/del', body: { ctime: data.ctime, name: data.name }, post: 1 }, (err) => {
87 | if (err) return popup.showAlert(err);
88 | this.show();
89 | popup.close();
90 | });
91 | });
92 | return null;
93 | },
94 | });
95 | }
96 | }
97 |
--------------------------------------------------------------------------------
/tests/acl.test.js:
--------------------------------------------------------------------------------
1 |
2 | const { describe, it } = require('node:test');
3 | const assert = require('node:assert/strict');
4 | const { api, app, logger, lib } = require("../");
5 |
6 | describe("Auth tests", () => {
7 |
8 | var argv = [
9 | "-api-acl-allow-admin", "auth, admin, manager, -userallow, -manageronly",
10 | "-api-acl-allow-manager", "manager, user, -useronly",
11 | "-api-acl-allow-user", "user, userallow",
12 | "-api-acl-authenticated", "auth",
13 |
14 | "-api-acl-deny-manager", "useronly",
15 | "-api-acl-deny-user", "userdeny",
16 |
17 | "-api-acl-add-auth", "^/auth",
18 | "-api-acl-add-admin", "^/admin",
19 | "-api-acl-add-manager", "^/manager",
20 | "-api-acl-add-user", "^/user",
21 | "-api-acl-add-userallow", "^/allow",
22 | "-api-acl-add-userdeny", "^/userdeny",
23 | "-api-acl-add-useronly", "^/useronly",
24 | "-api-acl-add-manageronly", "^/manageronly",
25 | ];
26 |
27 | var checks = [
28 | { status: 403, path: "/system" },
29 | { status: 403, path: "/system", roles: "admin" },
30 |
31 | { status: 200, path: "/auth" },
32 | { status: 200, path: "/auth", roles: "admin" },
33 | { status: 200, path: "/auth", roles: "user" },
34 |
35 | { status: 403, path: "/admin" },
36 | { status: 403, path: "/admin", roles: "user" },
37 | { status: 403, path: "/admin", roles: "manager" },
38 | { status: 200, path: "/admin", roles: "admin" },
39 |
40 | { status: 403, path: "/allow" },
41 | { status: 200, path: "/allow", roles: "user" },
42 | { status: 403, path: "/allow", roles: "manager" },
43 | { status: 403, path: "/allow", roles: "admin" },
44 |
45 | { status: 200, path: "/user", roles: "user" },
46 | { status: 403, path: "/user", roles: "admin" },
47 | { status: 200, path: "/user", roles: "manager" },
48 |
49 | { status: 200, path: "/useronly", roles: "user", code: "DENY" },
50 | { status: 403, path: "/useronly", roles: "manager", code: "DENY" },
51 |
52 | { status: 200, path: "/userdeny", roles: "manager" },
53 | { status: 403, path: "/userdeny", roles: "user", code: "DENY" },
54 |
55 | { status: 403, path: "/manager" },
56 | { status: 403, path: "/manager", roles: "user" },
57 | { status: 200, path: "/manager", roles: "manager" },
58 | { status: 200, path: "/manager", roles: "admin" },
59 |
60 | { status: 200, path: "/manageronly", roles: "manager" },
61 | { status: 403, path: "/manageronly", roles: "user" },
62 | { status: 403, path: "/manageronly", roles: "admin" },
63 |
64 | ];
65 |
66 | api.acl.reset();
67 | app.parseArgs(argv);
68 | var req = { user: {}, options: {} };
69 |
70 | logger.setLevel(process.env.BKJS_TEST_LOG)
71 |
72 | it("checks all acls", (t, callback) => {
73 |
74 | lib.forEachSeries(checks, (check, next) => {
75 | req.user.id = check.roles || "anon";
76 | req.user.roles = lib.strSplit(check.roles);
77 | req.options.path = check.path;
78 | logger.debug("checking:", check);
79 | api.access.authorize(req, (err) => {
80 | logger.debug("checked:", err);
81 | assert.ok((err?.status || 200) === check.status, lib.objDescr({ check, err }));
82 | if (err && check.code !== undefined) {
83 | assert.ok((err.code || "") === check.code, lib.objDescr({ check, err }));
84 | }
85 | next();
86 | });
87 | }, callback);
88 | });
89 |
90 | });
91 |
--------------------------------------------------------------------------------
/lib/aws/sqs.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const lib = require(__dirname + '/../lib');
7 | const aws = require(__dirname + '/../aws');
8 |
9 | /**
10 | * AWS SQS API request
11 | * @memberOf module:aws
12 | */
13 | aws.querySQS = function(action, obj, options, callback)
14 | {
15 | this.queryEndpoint("sqs", '2012-11-05', action, obj, options, callback);
16 | }
17 |
18 | /**
19 | * Receive message(s) from the SQS queue, the callback will receive a list with messages if no error.
20 | * The following options can be specified:
21 | * - count - how many messages to receive
22 | * - timeout - how long to wait, in milliseconds, this is for Long Poll
23 | * - visibilityTimeout - the duration (in milliseconds) that the received messages are hidden from subsequent retrieve requests
24 | * - attempt - request attempt id for FIFO queues
25 | * after being retrieved by a ReceiveMessage request.
26 | * @memberOf module:aws
27 | */
28 | aws.sqsReceiveMessage = function(url, options, callback)
29 | {
30 | if (typeof options == "function") callback = options, options = null;
31 |
32 | var params = { QueueUrl: url };
33 | if (options) {
34 | if (options.count) params.MaxNumberOfMessages = options.count;
35 | if (options.visibilityTimeout > 999) params.VisibilityTimeout = Math.round(options.visibilityTimeout/1000);
36 | if (options.timeout > 999) params.WaitTimeSeconds = Math.round(options.timeout/1000);
37 | if (options.attempt) params.ReceiveRequestAttemptId = options.attempt;
38 | }
39 | this.querySQS("ReceiveMessage", params, options, function(err, obj) {
40 | var rows = [];
41 | if (!err) rows = lib.objGet(obj, "ReceiveMessageResponse.ReceiveMessageResult.Message", { list: 1 });
42 | if (typeof callback == "function") callback(err, rows);
43 | });
44 | }
45 |
46 | /**
47 | * Send a message to the SQS queue.
48 | * The options can specify the following:
49 | * - delay - how long to delay this message in milliseconds
50 | * - group - a group id for FIFO queues
51 | * - unique - deduplication id for FIFO queues
52 | * - attrs - an object with additional message attributes to send, use only string, numbers or binary values,
53 | * all other types will be converted into strings
54 | * @memberOf module:aws
55 | */
56 | aws.sqsSendMessage = function(url, body, options, callback)
57 | {
58 | if (typeof options == "function") callback = options, options = null;
59 |
60 | var params = { QueueUrl: url, MessageBody: body };
61 | if (options) {
62 | if (options.delay > 999) params.DelaySeconds = Math.round(options.delay/1000);
63 | if (options.group) params.MessageGroupId = options.group;
64 | if (options.unique) params.MessageDeduplicationId = options.unique;
65 | if (options.attrs) {
66 | var n = 1;
67 | for (var p in options.attrs) {
68 | var type = typeof options.attrs[p] == "number" ? "Number" : typeof options.attrs[p] == "string" ? "String" : "Binary";
69 | params["MessageAttribute." + n + ".Name"] = p;
70 | params["MessageAttribute." + n + ".Value." + type + "Value"] = options.attrs[p];
71 | params["MessageAttribute." + n + ".Value.DataType"] = type;
72 | n++;
73 | }
74 | }
75 | }
76 | this.querySQS("SendMessage", params, options, function(err, obj) {
77 | var rows = [];
78 | if (!err) rows = lib.objGet(obj, "ReceiveMessageResponse.ReceiveMessageResult.Message", { list: 1 });
79 | if (typeof callback == "function") callback(err, rows);
80 | });
81 | }
82 |
--------------------------------------------------------------------------------
/tests/jwt.test.js:
--------------------------------------------------------------------------------
1 |
2 | const { describe, it } = require('node:test');
3 | const assert = require('node:assert/strict');
4 | const { lib } = require("../");
5 |
6 | const JWT = lib.JWT;
7 |
8 | const secret = 'a-secret'
9 |
10 | describe("JWT tests", async () => {
11 |
12 | it('Issuer (correct - string)', async () => {
13 | const tok =
14 | 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2MzMwNDY0MDAsImlzcyI6ImNvcnJlY3QtaXNzdWVyIn0.gF8S6M2QcfTTscgxeyihNk28JAOa8mfL1bXPb3_E3rk'
15 |
16 | const rc = await JWT.verify(tok, secret, { alg: "HS256", iss: 'correct-issuer' })
17 |
18 | assert.partialDeepStrictEqual(rc, {
19 | payload: {
20 | iss: 'correct-issuer'
21 | }
22 | });
23 | })
24 |
25 | it('Token Expired', async () => {
26 | const tok =
27 | 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzMwNDYxMDAsImV4cCI6MTYzMzA0NjQwMH0.H-OI1TWAbmK8RonvcpPaQcNvOKS9sxinEOsgKwjoiVo'
28 | const { err } = await JWT.verify(tok, secret)
29 | assert.match(err?.message, /expired/);
30 | })
31 |
32 | it('HS512 sign & verify & decode', async () => {
33 | var payload = { message: 'hello world' }
34 | const tok = await JWT.sign(payload, secret, "HS512")
35 | const expected =
36 | 'eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJtZXNzYWdlIjoiaGVsbG8gd29ybGQifQ.RqVLgExB_GXF1-9T-k4V4HjFmiuQKTEjVSiZd-YL0WERIlywZ7PfzAuTZSJU4gg8cscGamQa030cieEWrYcywg'
37 |
38 | assert.strictEqual(tok.token, expected)
39 |
40 | const rc = await JWT.verify(tok.token, secret)
41 |
42 | assert.partialDeepStrictEqual(rc, {
43 | header: {
44 | alg: 'HS512',
45 | typ: 'JWT',
46 | },
47 | payload: {
48 | message: 'hello world',
49 | },
50 | })
51 | })
52 |
53 | it('EdDSA sign & verify w/ CryptoKey', async () => {
54 | const alg = 'EdDSA'
55 | const payload = { message: 'hello world' }
56 |
57 | const keyPair = await crypto.subtle.generateKey({ name: 'Ed25519', namedCurve: 'Ed25519' }, true, ['sign', 'verify'])
58 |
59 | const tok = await JWT.sign(payload, keyPair.privateKey, alg)
60 |
61 | const rc1 = await JWT.verify(tok.token, keyPair.privateKey, alg)
62 | assert.partialDeepStrictEqual(rc1, { payload })
63 |
64 | const rc2 = await JWT.verify(tok.token, keyPair.publicKey, alg)
65 | assert.partialDeepStrictEqual(rc2, { payload })
66 | })
67 |
68 | it(`PS384 sign & verify`, async () => {
69 | const alg = "PS384"
70 | const payload = { message: 'hello world' }
71 |
72 | const keyPair = await crypto.subtle.generateKey({
73 | hash: JWT.algorithms[alg].hash.name,
74 | modulusLength: 2048,
75 | publicExponent: new Uint8Array([1, 0, 1]),
76 | name: 'RSA-PSS',
77 | }, true, ['sign', 'verify']);
78 |
79 | var exported = await crypto.subtle.exportKey('pkcs8', keyPair.privateKey)
80 | const pemPrivateKey = `-----BEGIN PRIVATE KEY-----\n${Buffer.from(exported).toString("base64")}\n-----END PRIVATE KEY-----`
81 |
82 | exported = await crypto.subtle.exportKey('spki', keyPair.publicKey)
83 | const pemPublicKey = `-----BEGIN PUBLIC KEY-----\n${Buffer.from(exported).toString("base64")}\n-----END PUBLIC KEY-----`
84 |
85 | const jwkPublicKey = await crypto.subtle.exportKey('jwk', keyPair.publicKey)
86 |
87 | const tok = await JWT.sign(payload, pemPrivateKey, alg)
88 |
89 | const rc1 = await JWT.verify(tok.token, pemPublicKey, alg)
90 | assert.partialDeepStrictEqual(rc1, { payload })
91 |
92 | const rc2 = await JWT.verify(tok.token, pemPrivateKey, alg)
93 | assert.partialDeepStrictEqual(rc2, { payload })
94 |
95 | const rc3 = await JWT.verify(tok.token, jwkPublicKey, alg)
96 | assert.partialDeepStrictEqual(rc3, { payload })
97 |
98 | })
99 |
100 | })
101 |
--------------------------------------------------------------------------------
/lib/push/webpush.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Author: Vlad Seryakov vseryakov@gmail.com
3 | * backendjs 2018
4 | */
5 |
6 | const logger = require(__dirname + '/../logger');
7 | const lib = require(__dirname + '/../lib');
8 | const api = require(__dirname + '/../api');
9 |
10 | const mod = {
11 | name: "webpush",
12 |
13 | create: function(options) {
14 | if (!webpush) webpush = require("web-push");
15 | if (["webpush", "wp"].includes(options?.type)) return new WebpushClient(options);
16 | },
17 |
18 | configure: function(options) {
19 | api.hooks.add('access', '', '/js/webpush.js', function(req, status, cb) {
20 | req.res.header("Service-Worker-Allowed", "/");
21 | cb();
22 | });
23 | },
24 |
25 | properties: ["actions", "badge", "body", "dir", "icon", "image", "lang", "renotify", "requireInteraction", "silent", "tag", "timestamp", "vibrate"],
26 | };
27 |
28 | module.exports = mod;
29 |
30 | var webpush;
31 |
32 | /**
33 | * Send a Web push notification using the `web-push` npm module, referer to it for details how to generate VAPID credentials to
34 | * configure this module with 3 required parameters:
35 | *
36 | * - `key` - VAPID private key
37 | * - `pubkey` - VAPID public key
38 | * - `email` - an admin email for the VAPID subject
39 | *
40 | * The device token must be generated in the browser after successful subscription:
41 | *
42 | * navigator.serviceWorker.register("/js/webpush.js", { scope: "/" }).then(function(registration) {
43 | * registration.pushManager.subscribe({ userVisibleOnly: true, applicationServerKey: vapidKeyPublic }).then(function(subscription) {
44 | * bkjs.send({ url: '/user/update', data: { pushkey: "wp://" + window.btoa(JSON.stringify(subscription)) }, type: "POST" });
45 | * }).catch((err) => {})
46 | * });
47 | */
48 |
49 | class WebpushClient {
50 |
51 | constructor(options) {
52 | this.type = options.type;
53 | this.key = options.key;
54 | this.pubkey = options.pubkey;
55 | this.subject = `mailto:${options.email}`;
56 | this.app = options.app;
57 | this.queue = 0;
58 | }
59 |
60 | close(callback) {
61 | lib.tryCall(callback);
62 | }
63 |
64 | send(dev, options, callback) {
65 | if (!dev?.id) return lib.tryCall(callback, lib.newError("invalid device:" + dev.id));
66 |
67 | var to = lib.jsonParse(Buffer.from(dev.id, "base64").toString());
68 | if (!to) return lib.tryCall(callback, lib.newError("invalid device id:" + dev.id));
69 |
70 | var msg = { title: options.title, body: options.msg, data: {} };
71 | for (const p of mod.properties) {
72 | if (typeof options[p] != "undefined") msg[p] = options[p];
73 | }
74 |
75 | if (options.id) msg.data.id = String(options.id);
76 | if (options.url) msg.data.url = String(options.url);
77 | if (options.type) msg.data.type = String(options.type);
78 | if (options.user_id) msg.data.user_id = options.user_id;
79 | for (const p in options.payload) msg.data[p] = options.payload[p];
80 |
81 | const opts = {
82 | vapidDetails: {
83 | subject: this.subject,
84 | publicKey: this.pubkey,
85 | privateKey: this.key,
86 | }
87 | }
88 | this.queue++;
89 | webpush.sendNotification(to, lib.stringify(msg), opts).
90 | then(() => {
91 | this.queue--;
92 | logger.debug("send:", mod.name, dev, msg);
93 | lib.tryCall(callback);
94 | }).
95 | catch((err) => {
96 | this.queue--;
97 | logger.error("send:", mod.name, err, dev, msg);
98 | lib.tryCall(callback, err);
99 | });
100 | return true;
101 | }
102 | }
103 |
--------------------------------------------------------------------------------
/docs/web/scripts/search.js:
--------------------------------------------------------------------------------
1 |
2 | var searchAttr = 'data-search-mode';
3 | function contains(a,m){
4 | return (a.textContent || a.innerText || "").toUpperCase().indexOf(m) !== -1;
5 | };
6 |
7 | //on search
8 | document.getElementById("nav-search").addEventListener("keyup", (event) => {
9 | var search = this.value.toUpperCase();
10 |
11 | if (!search) {
12 | //no search, show all results
13 | document.documentElement.removeAttribute(searchAttr);
14 |
15 | document.querySelectorAll("nav > ul > li:not(.level-hide)").forEach(function(elem) {
16 | elem.style.display = "block";
17 | });
18 |
19 | if (typeof hideAllButCurrent === "function"){
20 | //let's do what ever collapse wants to do
21 | hideAllButCurrent();
22 | } else {
23 | //menu by default should be opened
24 | document.querySelectorAll("nav > ul > li > ul li").forEach(function(elem) {
25 | elem.style.display = "block";
26 | });
27 | }
28 | } else {
29 | //we are searching
30 | document.documentElement.setAttribute(searchAttr, '');
31 |
32 | //show all parents
33 | document.querySelectorAll("nav > ul > li").forEach(function(elem) {
34 | elem.style.display = "block";
35 | });
36 | document.querySelectorAll("nav > ul").forEach(function(elem) {
37 | elem.style.display = "block";
38 | });
39 | //hide all results
40 | document.querySelectorAll("nav > ul > li > ul li").forEach(function(elem) {
41 | elem.style.display = "none";
42 | });
43 | //show results matching filter
44 | document.querySelectorAll("nav > ul > li > ul a").forEach(function(elem) {
45 | if (!contains(elem.parentNode, search)) {
46 | return;
47 | }
48 | elem.parentNode.style.display = "block";
49 | });
50 | //hide parents without children
51 | document.querySelectorAll("nav > ul > li").forEach(function(parent) {
52 | var countSearchA = 0;
53 | parent.querySelectorAll("a").forEach(function(elem) {
54 | if (contains(elem, search)) {
55 | countSearchA++;
56 | }
57 | });
58 |
59 | var countUl = 0;
60 | var countUlVisible = 0;
61 | parent.querySelectorAll("ul").forEach(function(ulP) {
62 | // count all elements that match the search
63 | if (contains(ulP, search)) {
64 | countUl++;
65 | }
66 |
67 | // count all visible elements
68 | var children = ulP.children
69 | for (i=0; i30 | YOUR WORKSPACE 31 |
32 |Boards
33 |34 | Choose a board to jump into your Kanban flow. 35 |
36 |
39 |
42 |
43 |
44 |
45 |
46 |
66 |
47 |
52 |
53 |
54 |
55 | No boards yet
48 |49 | Create your first board to get started. 50 |
51 |
56 |
64 |
65 |
57 |
58 |
59 |
60 | Open board
61 |
62 |
63 |