@webqit/webflo 0.8.77 → 0.9.1

package/src/{services → services-pi}/certbot/index.js

@@ -4,27 +4,27 @@
  */
 import Fs from 'fs';
 import { spawn } from 'child_process';
-import _arrFrom from '@webqit/util/arr/from.js';
-import * as _server from '../../config/server.js';
+import { _from as _arrFrom } from '@webqit/util/arr/index.js';
 
 /**
  * @description
  */
 export const desc = {
-    generate: 'Deploys a remote origin into the local directory.',
+    generate: 'Generate an SSL cert for a domain or list of domains.',
 };
 
 /**
  * Reads SSL from file.
  * 
- * @param Ui        Ui
  * @param string    allDomains
- * @param object    flags
- * @param object    layout
  * 
  * @return object
  */
-export async function generate(Ui, allDomains, flags = {}, layout = {}) {
+export async function generate(allDomains) {
+    const cx = this || {};
+    if (!cx.config.runtime?.Server) {
+        throw new Error(`The Server configurator "config.runtime.Server" is required in context.`);
+    }
     const domains = _arrFrom(allDomains).reduce((all, d) => all.concat(d.split(',')), []).filter(d => d.trim());
     const args = [
         'certonly',
@@ -41,34 +41,40 @@ export async function generate(Ui, allDomains, flags = {}, layout = {}) {
     process.stdin.pipe(child.stdin);
 
     child.stdout.on('data', data => {
-        Ui.log('[' + Ui.style.keyword('CERTBOT') + '][' + Ui.style.var('OUT') + ']:', data + '');
+        if (cx.logger) {
+            cx.logger.log('[' + cx.logger.style.keyword('CERTBOT') + '][' + cx.logger.style.var('OUT') + ']:', data + '');
+        }
     });
 
     child.stderr.on('data', data => {
-        Ui.log('[' + Ui.style.keyword('CERTBOT') + '][' + Ui.style.err('ERR') + ']:', (data + '').trim());
+        if (cx.logger) {
+            cx.logger.log('[' + cx.logger.style.keyword('CERTBOT') + '][' + cx.logger.style.err('ERR') + ']:', (data + '').trim());
+        }
     });
     
     child.on('error', data => {
-        Ui.error(data);
+        cx.logger && cx.logger.error(data);
         process.exit();
     });
 
     child.on('exit', async exitCode => {
-        const server = await _server.read(flags, layout);
+        const serverConfig = new cx.config.runtime.Server(cx);
+        const server = await serverConfig.read();
         const domain = domains[0], certDir = `/etc/letsencrypt/live/${domain}`;
-        if (!exitCode && (flags['auto-config'] || flags.c)) {
+        if (!exitCode && cx.flags && (cx.flags['auto-config'] || cx.flags.c)) {
             if (Fs.existsSync(certDir)) {
-                Ui.log('Automatically configuring the server with the generated cert.');
+                cx.logger && cx.logger.log('Automatically configuring the server with the generated cert.');
                 if (!server.https) {
                     server.https = {};
                 }
                 server.https.keyfile = `${certDir}/privkey.pem`;
                 server.https.certfile = `${certDir}/fullchain.pem`;
-                await _server.write(server);
+                await serverConfig.write(server);
             } else {
-                Ui.log(`Generated cert files not found in ${certDir}; be sure to configure the server with the valid cert files.`);
+                cx.logger && cx.logger.log(`Generated cert files not found in ${certDir}; be sure to configure the server with the valid cert files.`);
             }
         }
         process.exit();
     });
+
 }

package/src/services-pi/index.js

@@ -0,0 +1,9 @@
+
+/**
+ * @imports
+ */
+import * as certbot from './certbot/index.js';
+
+export {
+    certbot,
+}

package/src/static-pi/index.js

@@ -0,0 +1,11 @@
+
+/**
+ * @imports
+import * as client from './client/index.js';
+import * as server from './server/index.js';
+ */
+
+export {
+    //client,
+    //server,
+}

package/src/webflo.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+
+/**
+ * @imports
+ */
+import Url from 'url';
+import Path from 'path';
+import { read as readJsonFile } from '@webqit/backpack/src/dotfiles/DotJson.js';
+import logger from '@webqit/backpack/src/cli/Ui.js';
+import * as WebfloPI from './index.js';
+import Context from './Context.js';
+import Cli from './Cli.js';
+
+const dirSelf = Path.dirname(Url.fileURLToPath(import.meta.url));
+const webfloJson = readJsonFile(Path.join(dirSelf, '../package.json'));
+const appJson = readJsonFile('./package.json');
+
+/**
+ * @cx
+ */
+const cx = Context.create({
+    webflo: { title: webfloJson.title, version: webfloJson.version },
+    app: { title: appJson.title, version: appJson.version },
+    logger,
+    config: WebfloPI.config,
+    middlewares: [ WebfloPI.deployment.origins.webhook, ],
+});
+
+/**
+ * @cli
+ */
+const cli = new Cli(WebfloPI);
+await cli.exec(cx);

package/test/index.test.js

@@ -0,0 +1,26 @@
+/**
+ * @imports
+ */
+import Context from "../src/Context.js";
+import * as WebfloPI from '../src/index.js';
+
+let client = {
+    handle: function(httpEvent) {
+        return new httpEvent.Response({ abcd: '1234' }, {
+            status: 302,
+            headers: {
+                //location: '/dddd',
+                cookies: {
+                    cookie1: { value: 'value1' },
+                    cookie2: { value: 'value2' },
+                }
+            }
+        });
+    },
+};
+
+const cx = Context.create({ config: WebfloPI.config, });
+const clientCallback = (_cx, hostName, defaultClientCallback) => client;
+const app = await WebfloPI.runtime.server.start.call(cx, clientCallback);
+
+const response = await app.go('http://localhost/', { headers: { range: 'bytes=0-5, 6' } } );

package/src/build/client/index.js

@@ -1,261 +0,0 @@
-
-/**
- * imports
- */
-import Fs from 'fs';
-import Url from 'url';
-import Path from 'path';
-import Webpack from 'webpack';
-import { _beforeLast } from '@webqit/util/str/index.js';
-import { _isObject, _isArray, _isEmpty } from '@webqit/util/js/index.js';
-import * as DotJs from '@webqit/backpack/src/dotfiles/DotJs.js';
-import * as client from '../../config/client.js'
-
-
-/**
- * @description
- */
-export const desc = {
-    build: 'Creates the application Client Build.',
-};
-
-/**
- * @build
- */
-export async function build(Ui, flags = {}, layout = {}) {
-
-    const config = await client.read(flags, layout);
-    // Consistent forward slashing
-    const forwardSlash = str => str.replace(/\\/g, '/');
-    var modulesDir = forwardSlash(Url.fileURLToPath(Path.join(import.meta.url, '../../../runtime/client')));
-    
-    var workerDirSplit = Path.resolve(layout.WORKER_DIR).replace(/\\/g, '/').split('/');
-    var workerParams = config.worker || {};
-    const workerBundlingConfig = workerParams.bundling || {};
-
-    var clientDirSplit = Path.resolve(layout.CLIENT_DIR).replace(/\\/g, '/').split('/');
-    var clientParams = config; // Yes root config object
-    const clientBundlingConfig = clientParams.bundling || {};
-
-    var waiting;
-
-    // -------------------
-    // Create the Service Worker file
-    // -------------------
-
-    if (!_isEmpty(workerParams)) {
-
-        Ui.log('');
-        Ui.title(`SERVICE WORKER BUILD`);
-
-        const workerBuild = { imports: {}, code: [], };
-        workerBuild.imports[modulesDir + '/Worker.js'] = 'Worker';
-       
-        // ------------------
-        // >> Routes mapping
-        buildRoutes(workerBuild, Ui, Path.resolve(layout.WORKER_DIR), 'Worker-Side Routing:');
-        workerBuild.code.push(``);
-        workerBuild.code.push(`// >> Worker Params`);
-        buildParams(workerBuild, workerParams, 'params');
-        workerBuild.code.push(``);
-        workerBuild.code.push(`// >> Worker Instantiation`);
-        workerBuild.code.push(`Worker.call(null, layout, params);`);
-        // ------------------
-        
-        // ------------------
-        // >> Write to file...
-        workerBundlingConfig.intermediate = workerBundlingConfig.intermediate || `${clientDirSplit.join('/')}/worker.js`;
-        workerBundlingConfig.output = workerBundlingConfig.output || {
-            filename: 'worker.js',
-            path: Path.resolve(layout.PUBLIC_DIR),
-        };
-        waiting = Ui.waiting(Ui.f`Writing the Service Worker file: ${workerBundlingConfig.intermediate}`);
-        waiting.start();
-        DotJs.write(workerBuild, workerBundlingConfig.intermediate, 'Service Worker File');
-        waiting.stop();
-        Ui.info(Ui.f`Service Worker file: ${workerBundlingConfig.intermediate}`);
-        // ------------------
-    }
-
-    // -------------------
-    // Create the Client file
-    // -------------------
-
-    Ui.log('');
-    Ui.title(`CLIENT BUILD`);
-
-    const clientBuild = { imports: {}, code: [], };
-    clientBuild.imports[modulesDir + '/Runtime.js'] = 'Runtime';
-
-    // ------------------
-    // >> Routes mapping
-    buildRoutes(clientBuild, Ui, Path.resolve(layout.CLIENT_DIR), 'Client-Side Routing:');
-    clientBuild.code.push(``);
-    clientBuild.code.push(`// >> Runtime Params`);
-    buildParams(clientBuild, clientParams, 'params');
-    clientBuild.code.push(``);
-    clientBuild.code.push(`// >> Runtime Instantiation`);
-    clientBuild.code.push(`Runtime.call(null, layout, params);`);
-    // ------------------
-    
-    // ------------------
-    // >> Write to file...
-    clientBundlingConfig.intermediate = clientBundlingConfig.intermediate || clientDirSplit.join('/') + '/bundle.js';
-    clientBundlingConfig.output = clientBundlingConfig.output || {
-        filename: 'bundle.js',
-        path: Path.resolve(layout.PUBLIC_DIR),
-    };
-    waiting = Ui.waiting(`Writing the client entry file: ${clientBundlingConfig.intermediate}`);
-    waiting.start();
-    DotJs.write(clientBuild, clientBundlingConfig.intermediate, 'Runtime Build File');
-    waiting.stop();
-    Ui.info(Ui.f`Runtime Build file: ${clientBundlingConfig.intermediate}`);
-    // ------------------
-
-    // -------------------
-    // Run webpack
-    // -------------------
-    
-    if (clientParams.bundling || workerParams.bundling) {
-        Ui.log('');
-        Ui.title(`BUNDLES`);
-    }
-    if (workerParams.bundling !== false) {
-        await createBundle(Ui, workerBundlingConfig, 'Bundling the Service Worker Build file');
-    }
-    if (clientParams.bundling !== false) {
-        clientBundlingConfig.experiments = clientBundlingConfig.experiments || {};
-        if (!('outputModule' in clientBundlingConfig.experiments)) {
-            clientBundlingConfig.experiments.outputModule = true;
-            clientBundlingConfig.externalsType = 'module';
-        }
-        if (clientBundlingConfig.experiments.outputModule !== false) {
-            clientBundlingConfig.output = clientBundlingConfig.output || {};
-            clientBundlingConfig.output.environment = clientBundlingConfig.output.environment || {};
-            if (!('module' in clientBundlingConfig.output)) {
-                clientBundlingConfig.output.module = true;
-                clientBundlingConfig.output.environment.module = true;
-            }
-        }
-        await createBundle(Ui, clientBundlingConfig, 'Bundling the Runtime Build file');
-    }
-    
-}
-
-/**
- * Creates a bundle using webpack
- * 
- * @param {object} config 
- * @param {string} desc 
- * 
- * @return void
- */
-const createBundle = (Ui, config, desc) => {
-    const intermediateFile = config.intermediate;
-    config = { ...config };
-    if (!config.entry) {
-        config.entry = config.intermediate;
-    }
-    delete config.intermediate;
-    return new Promise(resolve => {
-        var waiting = Ui.waiting(`${desc} ...`);
-        Ui.log('');
-        Ui.info(Ui.f`FROM: ${config.entry}`);
-        Ui.info(Ui.f`TO: ${config.output.path + '/' + config.output.filename}`);
-        Ui.log('');
-        waiting.start();
-
-        // Run
-        var compiler = Webpack(config);
-        compiler.run((err, stats) => {
-            waiting.stop();
-            if (err) {
-                Ui.title(`Errors!`);
-                Ui.error(err);
-            }
-            Ui.log(stats.toString({
-                colors: true,
-            }));
-            // Remove intermediate build
-            Fs.unlinkSync(intermediateFile);
-            resolve();
-        });
-    });
-};
-
-/**
- * Initializes a server on the given working directory.
- * 
- * @param object params
- * 
- * @return void
- */
-const buildRoutes = (build, Ui, entry, desc) => {
-    // -------------------
-    // Helper functions
-    // -------------------
-    // Directory walking
-    const walk = (dir, callback) => {
-        Fs.readdirSync(dir).forEach(f => {
-            let resource = Path.join(dir, f);
-            if (Fs.statSync(resource).isDirectory()) {
-                walk(resource, callback);
-            } else {
-                var ext = Path.extname(resource) || '';
-                callback(resource, ext);
-            }
-        });
-    };
-
-    Ui.log('');
-    Ui.title(desc);
-
-    // >> Routes mapping
-    build.code.push(`// >> ` + desc);
-    build.code.push(`const layout = {};`);
-
-    var indexCount = 0;
-    if (entry && Fs.existsSync(entry)) {
-        var clientDirname = entry.replace(/\\/g, '/').split('/').pop();
-        walk(entry, (file, ext) => {
-            //relativePath = relativePath.replace(/\\/g, '/');
-            if (file.replace(/\\/g, '/').endsWith('/index.js')) {
-                var relativePath = Path.relative(entry, file).replace(/\\/g, '/');
-                // Import code
-                var routeName = 'index' + (++ indexCount);
-                // IMPORTANT: we;re taking a step back here so that the parent-child relationship for 
-                // the directories be involved
-                build.imports[`../${clientDirname}/${relativePath}`] = '* as ' + routeName;
-                // Definition code
-                var routePath = _beforeLast('/' + relativePath, '/index.js');
-                build.code.push(`layout['${routePath || '/'}'] = ${routeName};`);
-                // Show
-                Ui.log(`> ./${relativePath}`);
-            }
-        });
-    }
-    if (!indexCount) {
-        Ui.log(`> (none)`);
-    }
-};
-
-const buildParams = (build, params, varName = null, indentation = 0) => {
-    if (varName) build.code.push(`const ${varName} = {`);
-    Object.keys(params).forEach(name => {
-        var _name = `    ${'    '.repeat(indentation)}${(_isArray(params) ? '' : (name.includes(' ') ? `'${name}'` : name) + ': ')}`;
-        if ([ 'boolean', 'number' ].includes(typeof params[name])) {
-            build.code.push(`${_name}${params[name]},`);
-        } else if (_isArray(params[name])) {
-            build.code.push(`${_name}[`);
-            buildParams(build, params[name], null, indentation + 1);
-            build.code.push(`    ${'    '.repeat(indentation)}],`);
-        } else if (_isObject(params[name])) {
-            build.code.push(`${_name}{`);
-            buildParams(build, params[name], null, indentation + 1);
-            build.code.push(`    ${'    '.repeat(indentation)}},`);
-        } else {
-            build.code.push(`${_name}'${params[name]}',`);
-        }
-    });
-    if (varName) build.code.push(`};`);
-};

package/src/build/index.js

@@ -1,5 +0,0 @@
-
-/**
- * exports
- */
-export * as client from './client/index.js';

package/src/config/client.js

@@ -1,191 +0,0 @@
-
-/**
- * imports
- */
- import Fs from 'fs';
- import Path from 'path';
-import _merge from '@webqit/util/obj/merge.js';
-import _before from '@webqit/util/str/before.js';
-import _after from '@webqit/util/str/after.js';
-import _isNumeric from '@webqit/util/js/isNumeric.js';
-import { DotJson, anyExists } from '@webqit/backpack/src/dotfiles/index.js';
-
-/**
- * Reads WORKER from file.
- * 
- * @param object    flags
- * @param object    layout
- * 
- * @return object
- */
-export async function read(flags = {}, layout = {}) {
-    const ext = flags.env ? `.${flags.env}` : '';
-    const configDir = Path.join(layout.ROOT || ``, `./.webqit/webflo/config/`);
-    const fileName = ext => `${configDir}/client${ext}.json`;
-    const availableExt = anyExists([ext, '', '.example'], fileName);
-    const config = DotJson.read(fileName(availableExt));
-    return _merge({
-        bundling: {},
-        // -----------------
-        // SERVICE WORKER
-        // -----------------
-        worker: {
-            scope: '/',
-            cache_name: 'cache_v0',
-            cache_only_url_list: [],
-            cache_first_url_list: [],
-            network_first_url_list: [],
-            network_only_url_list: [],
-            skip_waiting: false,
-            lifecycle_logs: true,
-            // -----------------
-            support_push: false,
-            push_registration_url: '',
-            push_deregistration_url: '',
-            push_public_key: '',
-            bundling: {},
-        },
-    }, config);
-};
-
-/**
- * Writes WORKER to file.
- * 
- * @param object    config
- * @param object    flags
- * @param object    layout
- * 
- * @return void
- */
-export async function write(config, flags = {}, layout = {}) {
-    const ext = flags.env ? `.${flags.env}` : '';
-    const configDir = Path.join(layout.ROOT || ``, `./.webqit/webflo/config/`);
-    const fileName = ext => `${configDir}/client${ext}.json`;
-    DotJson.write(config, fileName(ext));
-};
-
-/**
- * Configures WORKER.
- * 
- * @param object    config
- * @param object    choices
- * @param object    layout
- * 
- * @return Array
- */
-export async function questions(config, choices = {}, layout = {}) {
-
-    // Increment cache
-    if (config.worker.cache_name && config.worker.cache_name.indexOf('_v') > -1 && _isNumeric(_after(config.worker.cache_name, '_v'))) {
-        config.worker.cache_name = _before(config.worker.cache_name, '_v') + '_v' + (parseInt(_after(config.worker.cache_name, '_v')) + 1);
-    }
-
-    // Questions
-    return [
-        // -----------------
-        // BUNDLING PARAMS
-        // -----------------
-        {
-            name: 'bundling',
-            initial: config.bundling,
-            controls: {
-                name: 'Bundling params',
-            },
-            questions: [],
-        },
-        // -----------------
-        // SERVICE WORKER
-        // -----------------
-        {
-            name: 'worker',
-            initial: config.worker,
-            controls: {
-                name: 'Service Worker',
-            },
-            questions: [
-                {
-                    name: 'scope',
-                    type: 'text',
-                    message: 'Specify the Service Worker scope',
-                    initial: config.scope,
-                },
-                {
-                    name: 'cache_name',
-                    type: 'text',
-                    message: 'Enter the Service Worker cache name',
-                    initial: config.cache_name,
-                },
-                {
-                    name: 'cache_only_url_list',
-                    type: 'list',
-                    message: 'Specify URLs for a "cache-only" fetching strategy (comma-separated, globe supported)',
-                    initial: (config.cache_only_url_list || []).join(', '),
-                },
-                {
-                    name: 'cache_first_url_list',
-                    type: 'list',
-                    message: 'Specify URLs for a "cache-first-then-network" fetching strategy (comma-separated, globe supported)',
-                    initial: (config.cache_first_url_list || []).join(', '),
-                },
-                {
-                    name: 'network_first_url_list',
-                    type: 'list',
-                    message: 'Specify URLs for a "network-first-then-cache" fetching strategy (comma-separated, globe supported)',
-                    initial: (config.network_first_url_list || []).join(', '),
-                },
-                {
-                    name: 'network_only_url_list',
-                    type: 'list',
-                    message: 'Specify URLs for a "network-only" fetching strategy (comma-separated, globe supported)',
-                    initial: (config.network_only_url_list || []).join(', '),
-                },
-                {
-                    name: 'skip_waiting',
-                    type: 'toggle',
-                    message: 'Choose whether to skip the "waiting" state for updated Service Workers',
-                    active: 'YES',
-                    inactive: 'NO',
-                    initial: config.skip_waiting,
-                },
-                {
-                    name: 'lifecycle_logs',
-                    type: 'toggle',
-                    message: 'Choose whether to show logs',
-                    active: 'YES',
-                    inactive: 'NO',
-                    initial: config.lifecycle_logs,
-                },
-                // ------------- notification --------------
-                {
-                    name: 'support_push',
-                    type: 'toggle',
-                    message: 'Support push-notifications?',
-                    active: 'YES',
-                    inactive: 'NO',
-                    initial: config.support_push,
-                },
-                {
-                    name: 'push_registration_url',
-                    type: (prev, answers) => answers.support_push ? 'text' : null,
-                    message: 'Enter the URL for push notification subscription',
-                    initial: config.push_registration_url,
-                    validation: ['important'],
-                },
-                {
-                    name: 'push_deregistration_url',
-                    type: (prev, answers) => answers.support_push ? 'text' : null,
-                    message: 'Enter the URL for push notification unsubscription',
-                    initial: config.push_deregistration_url,
-                    validation: ['important'],
-                },
-                {
-                    name: 'push_key',
-                    type: (prev, answers) => answers.support_push ? 'text' : null,
-                    message: 'Enter the Public Key for push notification subscription',
-                    initial: config.push_key,
-                    validation: ['important'],
-                },
-            ],
-        },
-    ];
-};