@connecttomahdi/rxdb 17.0.0-beta.17

package/scripts/generate-plugins-package-json.mjs

@@ -0,0 +1,133 @@
+
+/**
+ * Generates the package.json files for the plugins.
+ * @link https://github.com/pubkey/rxdb/pull/4196#issuecomment-1364369523
+ */
+
+import path from 'path';
+import fs from 'fs';
+import {
+    sync as rimrafSync
+} from 'rimraf';
+import assert from 'assert';
+import { fileURLToPath } from 'node:url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function run() {
+    const rootPackageJsonPath = path.join(__dirname, '../', 'package.json');
+    const packageJson = JSON.parse(
+        await fs.promises.readFile(
+            rootPackageJsonPath
+        )
+    );
+    const pluginsFolderPath = path.join(__dirname, '../plugins');
+
+    const pluginsSrcFolderPath = path.join(__dirname, '../src/plugins');
+
+    // recreate plugins folder
+    await rimrafSync(pluginsFolderPath, {});
+    await fs.promises.mkdir(pluginsFolderPath);
+
+    // write package.json files
+    const usedPluginNames = new Set();
+    const plugins = packageJson.exports;
+    Object.keys(plugins)
+        .filter(pluginPath => pluginPath !== '.' && pluginPath !== './package.json')
+        .forEach((pluginPath) => {
+            console.log(pluginPath);
+            const pluginName = pluginPath.split('/').pop();
+            usedPluginNames.add(pluginName);
+
+            // Ensure the configuration is correct and all plugins are defined equally
+            const pluginRootConfig = plugins[pluginPath];
+            if (pluginName !== 'core') {
+                assert.strictEqual(
+                    pluginRootConfig.types,
+                    './dist/types/plugins/' + pluginName + '/index.d.ts'
+                );
+                assert.strictEqual(
+                    pluginRootConfig.require,
+                    './dist/cjs/plugins/' + pluginName + '/index.js'
+                );
+                assert.strictEqual(
+                    pluginRootConfig.import,
+                    './dist/esm/plugins/' + pluginName + '/index.js'
+                );
+                assert.strictEqual(
+                    pluginRootConfig.default,
+                    './dist/esm/plugins/' + pluginName + '/index.js'
+                );
+            }
+
+            // write plugin package.json
+            const pluginFolderName = pluginName === 'core' ? '' : 'plugins/' + pluginName + '/';
+            const pluginPackageContent = {
+                'name': 'rxdb-plugins-' + pluginName,
+                'description': 'This package.json file is generated by the "npm run build:plugins" script, do not edit it manually!',
+                'sideEffects': false,
+                'types': '../../dist/types/' + pluginFolderName + 'index.d.ts',
+                'exports': {
+                    '.': {
+                        'default': {
+                            'types': './index.d.ts',
+                            'import': './index.mjs',
+                            'default': './index.cjs'
+                        }
+                    },
+                    './package.json': './package.json'
+                },
+                'main': './index.cjs',
+                'module': './index.mjs'
+            };
+
+            const pluginFolderPath = path.join(pluginsFolderPath, pluginName);
+            fs.mkdirSync(pluginFolderPath);
+            fs.writeFileSync(
+                path.join(pluginFolderPath, 'package.json'),
+                JSON.stringify(pluginPackageContent, null, 4),
+                'utf-8'
+            );
+
+            // write index file
+            fs.writeFileSync(
+                path.join(pluginFolderPath, 'index.mjs'),
+                'export * from \'../../dist/esm/' + pluginFolderName + 'index.js\';\n',
+                'utf-8'
+            );
+            fs.writeFileSync(
+                path.join(pluginFolderPath, 'index.cjs'),
+                'const pkg = require(\'../../dist/cjs/' + pluginFolderName + 'index.js\');\n' +
+                'module.exports = pkg;\n',
+                'utf-8'
+            );
+            fs.writeFileSync(
+                path.join(pluginFolderPath, 'index.ts'),
+                'export * from \'../../dist/types/' + pluginFolderName + 'index\';\n',
+                'utf-8'
+            );
+
+            // @link https://stackoverflow.com/q/72457791/3443137
+            ['mts', 'cts'].forEach(fileEnding => {
+                fs.writeFileSync(
+                    path.join(pluginFolderPath, 'index.d.' + fileEnding),
+                    'export * from \'../../dist/types/' + pluginFolderName + 'index\';\n',
+                    'utf-8'
+                );
+            });
+
+
+        });
+
+
+
+    // ensure we did not forget any plugin
+    const pluginsSrc = await fs.promises.readdir(pluginsSrcFolderPath);
+    pluginsSrc.forEach(pluginName => {
+        if (!usedPluginNames.has(pluginName)) {
+            throw new Error('Plugin folders exists but is not defined in package.json: ' + pluginName);
+        }
+    });
+
+}
+run();

package/scripts/install-foundationdb.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+set -e
+
+echo "# installing FoundationDB client:"
+wget -O foundationdb-client.deb https://github.com/apple/foundationdb/releases/download/7.3.59/foundationdb-clients_7.3.59-1_amd64.deb
+sudo dpkg -i foundationdb-client.deb
+rm foundationdb-client.deb
+
+
+echo "# installing FoundationDB server:"
+wget -O foundationdb-server.deb https://github.com/apple/foundationdb/releases/download/7.3.59/foundationdb-server_7.3.59-1_amd64.deb
+sudo dpkg -i foundationdb-server.deb
+rm foundationdb-server.deb
+

package/scripts/module_package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/scripts/module_package_no_side.json

@@ -0,0 +1 @@
+{ "type": "module", "sideEffects": false }

package/scripts/postinstall.js

@@ -0,0 +1,33 @@
+
+
+/**
+ * this file is similar to the one of core-js
+ * So you can disable the output-spam with the same params
+ * and we also have the same colors
+ * @link https://github.com/zloirock/core-js/blob/381c366b8cdc84050bb0ef7184a6e80f45bf5903/packages/core-js/scripts/postinstall.js
+ * @link https://github.com/opencollective/opencollective-postinstall/blob/master/index.js
+ */
+
+const env = process.env;
+const ADBLOCK = is(env.ADBLOCK);
+const CI = is(env.CI);
+const COLOR = is(env.npm_config_color);
+const DISABLE_OPENCOLLECTIVE = is(env.DISABLE_OPENCOLLECTIVE);
+const SILENT = !!~['silent', 'error', 'warn'].indexOf(env.npm_config_loglevel);
+const SHOW = false;
+
+function is(it) {
+    return !!it && it !== '0' && it !== 'false';
+}
+
+function log(it) {
+    // eslint-disable-next-line no-control-regex
+    console.log(COLOR ? it : it.replace(/\u001B\[\d+m/g, ''));
+}
+
+if (SHOW && !ADBLOCK && !CI && !DISABLE_OPENCOLLECTIVE && !SILENT) {
+    log('\u001b[96m\u001b[1mThank you for using RxDB ( https://rxdb.info/ ) \u001b[96m\u001b[1m \n');
+    log('\u001B[96mHelp me to improve RxDB by answering a few questions ( < 2 minutes): \u001B[0m');
+    log('\u001B[96m>\u001B[94m Open the survey at https://rxdb.info/survey.html \u001B[0m');
+    log('\u001b[96m\u001b[1mThank you \u001b[96m\u001b[1m \n');
+}

package/scripts/profile.mjs

@@ -0,0 +1,31 @@
+/**
+ * this script processes the profile and cleans up afterwards
+ * @link https://nodejs.org/en/docs/guides/simple-profiling/
+ */
+import path from 'path';
+import walkSync from 'walk-sync';
+import shell from 'shelljs';
+import del from 'delete';
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const run = async () => {
+    const isolateFolder = path.join(__dirname, '../');
+    const files = walkSync(isolateFolder);
+    const isolateFile = files.find(name => name.startsWith('isolate-'));
+    if (!isolateFile) throw new Error('no isolate-* file found');
+    const isolatePath = isolateFolder + '/' + isolateFile;
+    const cmd = 'node --prof-process ' + isolatePath + ' > processed.txt';
+    if (shell.exec(cmd).code !== 0) {
+        console.error('processing ' + isolatePath + ' failed');
+        process.exit(1);
+    }
+
+    await del.promise([isolatePath]);
+
+    console.log('DONE - open processed.txt');
+};
+
+run();

package/scripts/set-version.mjs

@@ -0,0 +1,162 @@
+/**
+ * Set the version before a release.
+ * The new version number is passed via args
+ */
+
+
+import path from 'node:path';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const args = process.argv;
+const version = args[2];
+console.log('new version: ' + version);
+const isBeta = version.includes('beta');
+console.log('isBeta: ' + isBeta);
+
+
+const rootPath = path.join(
+    __dirname,
+    '../'
+);
+
+async function run() {
+
+    // update version in package.json
+    const packageJson = JSON.parse(
+        await fs.promises.readFile(
+            path.join(rootPath, 'package.json')
+        )
+    );
+    packageJson.version = version;
+    await fs.promises.writeFile(
+        path.join(rootPath, 'package.json'),
+        JSON.stringify(packageJson, null, 2)
+    );
+
+
+    // update changelog
+    const changelogFlagStart = '<!-- CHANGELOG NEWEST -->';
+    const changelogFlagEnd = '<!-- /CHANGELOG NEWEST -->';
+    const changelogReleaseBelowFlag = '<!-- RELEASE BELOW -->';
+
+    const changelogContent = await fs.promises.readFile(
+        path.join(rootPath, 'CHANGELOG.md'),
+        'utf-8'
+    );
+    let changelogRows = changelogContent.split('\n');
+
+    if (
+        !changelogRows.includes(changelogFlagStart) ||
+        !changelogRows.includes(changelogFlagEnd) ||
+        !changelogRows.includes(changelogReleaseBelowFlag)
+    ) {
+        throw new Error('changelog flag missing');
+    }
+    const indexReleaseBelow = changelogRows.indexOf(changelogReleaseBelowFlag);
+
+    const indexStart = changelogRows.indexOf(changelogFlagStart);
+    const indexEnd = changelogRows.indexOf(changelogFlagEnd);
+
+    let newRows = changelogRows.slice(indexStart + 1, indexEnd);
+    newRows = newRows
+        .filter(row => !row.startsWith('<!-- '))
+        .filter(row => !row.startsWith('### '));
+    newRows.push('');
+
+
+    /**
+     * Write to release-body.md so the github action
+     * knows what to use as release body
+     */
+    let releaseBodyRows = [
+        // add this line for a backlink and to have a big image appear in peoples github newsfeed.
+        `<p align="center">
+            <a href="https://rxdb.info/">
+                <img src="https://rxdb.info/files/logo/rxdb_javascript_database.svg" width="380px" alt="JavaScript Database" />
+            </a>
+        </p>`,
+        '',
+    ];
+    releaseBodyRows.push(newRows.slice(0));
+    releaseBodyRows.push([
+        '',
+        '',
+        '**NOTICE:** An overview about all releases can be found [at the changelog](https://github.com/pubkey/rxdb/blob/master/CHANGELOG.md)'
+    ]);
+    releaseBodyRows.push([
+        '### Join RxDB:',
+        '- 💬 [Join the RxDB Chat](https://rxdb.info/chat)',
+        '- ⭐ [Star the RxDB Repo](https://github.com/pubkey/rxdb)',
+        '- 📰 [Subscribe to the newsletter](https://rxdb.info/newsletter)',
+        '- 🐦 [Follow at Twitter](https://twitter.com/intent/user?screen_name=rxdbjs)',
+        '- 🔗 [Follow at LinkedIn](https://www.linkedin.com/company/rxdb)'
+    ]);
+    releaseBodyRows = releaseBodyRows.flat();
+
+    await fs.promises.writeFile(
+        path.join(rootPath, 'release-body.md'),
+        releaseBodyRows.join('\n'),
+        'utf-8'
+    );
+
+    changelogRows = changelogRows.slice(indexReleaseBelow + 1);
+
+    const date = new Date();
+    const month = date.toLocaleString('en', { month: 'long' });
+    const day = date.getDate();
+    const year = date.getFullYear();
+    const newVersionHeader = `### ${version} (${day} ${month} ${year})\n`;
+
+
+    /**
+     * If it is a beta release, the changes must stay inside of the newest-flag
+     */
+    if (isBeta) {
+        changelogRows.unshift(changelogReleaseBelowFlag);
+        changelogRows.unshift('');
+        changelogRows.unshift(changelogFlagEnd);
+        changelogRows.unshift('');
+        changelogRows.unshift('');
+        changelogRows = newRows.concat(changelogRows);
+        changelogRows.unshift('');
+        changelogRows.unshift('');
+        changelogRows.unshift(newVersionHeader);
+        changelogRows.unshift('');
+        changelogRows.unshift('');
+        changelogRows.unshift('<!-- ADD new changes here! -->\n');
+        changelogRows.unshift('');
+        changelogRows.unshift(changelogFlagStart);
+        changelogRows.unshift('');
+    } else {
+        changelogRows = newRows.concat(changelogRows);
+        changelogRows.unshift(newVersionHeader);
+        changelogRows.unshift('');
+        changelogRows.unshift(changelogReleaseBelowFlag);
+        changelogRows.unshift('');
+        changelogRows.unshift(changelogFlagEnd);
+        changelogRows.unshift('');
+        changelogRows.unshift('<!-- ADD new changes here! -->\n');
+        changelogRows.unshift('');
+        changelogRows.unshift(changelogFlagStart);
+    }
+
+    changelogRows.unshift('# RxDB Changelog\n');
+    changelogRows.unshift('');
+
+    // remove unnecessary linebreaks
+    let newChangelogContent = changelogRows.join('\n');
+    newChangelogContent = newChangelogContent.replace(/### /g, '\n### ');
+    newChangelogContent = newChangelogContent.replace(/\n{3,}/g, '\n\n');
+    console.log(newChangelogContent);
+
+    await fs.promises.writeFile(
+        path.join(rootPath, 'CHANGELOG.md'),
+        newChangelogContent,
+        'utf-8'
+    );
+}
+
+run();

package/scripts/start-cloud-signaling-server.mjs

@@ -0,0 +1,120 @@
+import {
+    startSignalingServerSimplePeer
+} from '../plugins/replication-webrtc/index.mjs';
+import { createServer } from 'node:https';
+import { createServer as createHttpServer } from 'node:http';
+import fs from 'fs';
+import path from 'path';
+import url from 'url';
+import { wait } from 'async-test-util';
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
+
+/**
+ * This script starts the public signaling server for RxDB at wss://signaling.rxdb.info
+ * which can be used for prototypes and try-outs. You should never
+ * use that in production, instead you should host your own signaling server.
+ *
+ * Letsencrypt certbot setup:
+ * > certbot certonly --agree-tos --preferred-challenges http -d signaling.rxdb.info --webroot -w /rxdb/scripts/acme-challenge
+ *
+ *
+ */
+
+const sslKeyPath = '/etc/letsencrypt/live/signaling.rxdb.info/privkey.pem';
+const sslCertPath = '/etc/letsencrypt/live/signaling.rxdb.info/fullchain.pem';
+const certbotChallengePath = path.join(__dirname, 'acme-challenge', '.well-known', 'acme-challenge');
+
+async function run() {
+    console.log('# Start Cloud Signaling Server');
+
+
+    /**
+     * Start http server at port 80 to automatically solve
+     * the certbot challenges
+     */
+    console.log('# Start http server');
+    const httpServer = createHttpServer((request, response) => {
+        console.log('# port 80 request to ' + request.url);
+        response.writeHead(200, { 'Content-Type': 'text/plain' });
+
+        if (!fs.existsSync(certbotChallengePath)) {
+            console.log('challenge dir not exists at ' + certbotChallengePath);
+            response.end('could not read certfile at ' + certbotChallengePath, 'utf-8');
+            return;
+        }
+
+        const files = fs.readdirSync(certbotChallengePath).filter(f => f !== '.gittouch');
+        console.log('acme files:');
+        console.dir(files);
+
+        const filename = files[0];
+        let content = 'no certbot challenge';
+        if (filename) {
+            const filepath = path.join(certbotChallengePath, filename);
+            try {
+                content = fs.readFileSync(filepath);
+                console.log('acme file content:');
+                console.log(content);
+            } catch (err) {
+                console.log('# ERROR: could not read file content at ' + filepath);
+                console.dir(err);
+
+                response.end('could not read certfile at ' + filepath, 'utf-8');
+                return;
+            }
+        }
+        response.end(content, 'utf-8');
+    });
+    httpServer.listen(80, () => {
+        console.log('# Start http server is up');
+    });
+
+
+    const serverOptions = readCertsSync();
+    const server = createServer(serverOptions);
+
+    console.log('# Start wss server');
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const signalingServer = await startSignalingServerSimplePeer({
+        server
+    });
+    console.log('# WSS server is up');
+
+    server.listen(443, () => {
+        console.log('# Started Server on 443');
+    });
+
+
+    /**
+     * Refresh httpd's certs when certs change on disk. The timeout stuff
+     * "ensures" that all 3 relevant files are updated, and accounts for
+     * sometimes trigger-happy fs.watch.
+     * @link https://stackoverflow.com/a/74076392/3443137
+     *
+     * We have to watch the parent dir, not the file itself
+     * otherwise it will not detect the changes.
+     * @link https://github.com/nodejs/node/issues/5039#issuecomment-178561688
+     */
+    fs.watch(path.join(sslKeyPath, '../'), { persistent: false, recursive: false }, async () => {
+        console.log('# ssl certificate has changed -> update https secure context');
+
+        // wait a bit in case it first changed the key and afterwards changed the cert
+        await wait(2000);
+        server.setSecureContext(readCertsSync());
+        console.log('# ssl certificate has changed -> secure context changed');
+    });
+
+}
+
+/**
+ * Auto reload when ceritficate has changed
+ */
+function readCertsSync() {
+    return {
+        key: fs.readFileSync(sslKeyPath),
+        cert: fs.readFileSync(sslCertPath)
+    };
+}
+
+run();