cloudron 6.0.0 → 7.0.1

package/src/appstore-actions.js

@@ -1,32 +1,14 @@
-/* jshint node:true */
-
-'use strict';
-
-const assert = require('assert'),
-    config = require('./config.js'),
-    execSync = require('child_process').execSync,
-    fs = require('fs'),
-    { exit, locateManifest } = require('./helper.js'),
-    manifestFormat = require('@cloudron/manifest-format'),
-    path = require('path'),
-    readline = require('./readline.js'),
-    safe = require('safetydance'),
-    superagent = require('@cloudron/superagent'),
-    Table = require('easy-table');
-
-exports = module.exports = {
-    login,
-    logout,
-    info,
-    listVersions,
-    submit,
-    upload,
-    revoke,
-    approve,
-    verifyManifest,
-
-    notify
-};
+import assert from 'assert';
+import * as config from './config.js';
+import { execSync } from 'child_process';
+import fs from 'fs';
+import { exit, locateManifest, parseChangelog } from './helper.js';
+import manifestFormat from '@cloudron/manifest-format';
+import path from 'path';
+import * as readline from './readline.js';
+import safe from '@cloudron/safetydance';
+import superagent from '@cloudron/superagent';
+import Table from 'easy-table';
 
 const NO_MANIFEST_FOUND_ERROR_STRING = 'No CloudronManifest.json found';
 
@@ -156,29 +138,6 @@ async function listVersions(localOptions, cmd) {
     console.log(t.toString());
 }
 
-function parseChangelog(file, version) {
-    let changelog = '';
-    const data = safe.fs.readFileSync(file, 'utf8');
-    if (!data) return null;
-    const lines = data.split('\n');
-
-    version = version.replace(/-.*/, ''); // remove any prerelease
-
-    let i;
-    for (i = 0; i < lines.length; i++) {
-        if (lines[i] === '[' + version + ']') break;
-    }
-
-    for (i = i + 1; i < lines.length; i++) {
-        if (lines[i] === '') continue;
-        if (lines[i][0] === '[') break;
-
-        changelog += lines[i] + '\n';
-    }
-
-    return changelog;
-}
-
 async function addVersion(manifest, baseDir, options) {
     assert.strictEqual(typeof manifest, 'object');
     assert.strictEqual(typeof baseDir, 'string');
@@ -210,8 +169,7 @@ async function addVersion(manifest, baseDir, options) {
     }
 
     if (manifest.changelog.slice(0, 7) === 'file://') {
-        let changelogPath = manifest.changelog.slice(7);
-        changelogPath = path.isAbsolute(changelogPath) ? changelogPath : path.join(baseDir, changelogPath);
+        const changelogPath = path.isAbsolute(manifest.changelog.slice(7)) ? manifest.changelog.slice(7) : path.join(baseDir, manifest.changelog.slice(7));
         manifest.changelog = parseChangelog(changelogPath, manifest.version);
         if (!manifest.changelog) throw new Error('Bad changelog format or missing changelog for this version');
     }
@@ -277,7 +235,7 @@ async function verifyManifest(localOptions, cmd) {
     const manifest = result.manifest;
 
     const sourceDir = path.dirname(manifestFilePath);
-    const appConfig = config.getAppConfig(sourceDir);
+    const appConfig = config.getAppBuildConfig(sourceDir);
 
     // image can be passed in options for buildbot
     if (options.image) {
@@ -324,7 +282,7 @@ async function upload(localOptions, cmd) {
     const manifest = result.manifest;
 
     const sourceDir = path.dirname(manifestFilePath);
-    const appConfig = config.getAppConfig(sourceDir);
+    const appConfig = config.getAppBuildConfig(sourceDir);
 
     // image can be passed in options for buildbot
     if (options.image) {
@@ -467,11 +425,11 @@ async function notify() {
     if (result.error) return exit(new Error(`Invalid CloudronManifest.json: ${result.error.message}`));
     const { manifest } = result;
 
-    let postContent = null;
+    let postContent;
     if (manifest.changelog.slice(0, 7) === 'file://') {
         const baseDir = path.dirname(manifestFilePath);
-        let changelogPath = manifest.changelog.slice(7);
-        changelogPath = path.isAbsolute(changelogPath) ? changelogPath : path.join(baseDir, changelogPath);
+        const manifestChangelogPath = manifest.changelog.slice(7);
+        const changelogPath = path.isAbsolute(manifestChangelogPath) ? manifestChangelogPath : path.join(baseDir, manifestChangelogPath);
         const changelog = parseChangelog(changelogPath, manifest.version);
         if (!changelog) return exit('Bad changelog format or missing changelog for this version');
         postContent = `[${manifest.version}]\n${changelog}\n`;
@@ -511,3 +469,17 @@ async function notify() {
     if (postResponse.status !== 200) return exit(`Unable to create changelog post: ${requestError(postResponse)}`);
     console.log('Posted to forum');
 }
+
+export default {
+    login,
+    logout,
+    info,
+    listVersions,
+    submit,
+    upload,
+    revoke,
+    approve,
+    verifyManifest,
+
+    notify
+};

package/src/backup-tools.js

@@ -1,24 +1,14 @@
-#!/usr/bin/env node
-
-'use strict';
-
-exports = module.exports = {
-    encrypt,
-    decrypt,
-    encryptFilename,
-    decryptFilename,
-    decryptDir
-};
-
-const assert = require('assert'),
-    crypto = require('crypto'),
-    debug = require('debug')('cloudron-backup'),
-    fs = require('fs'),
-    path = require('path'),
-    readlinePromises = require('readline/promises'),
-    safe = require('safetydance'),
-    stream = require('stream/promises'),
-    TransformStream = require('stream').Transform;
+import assert from 'assert';
+import crypto from 'crypto';
+import createDebug from 'debug';
+import fs from 'fs';
+import path from 'path';
+import readlinePromises from 'readline/promises';
+import safe from '@cloudron/safetydance';
+import stream from 'stream/promises';
+import { Transform as TransformStream } from 'stream';
+
+const debug = createDebug('cloudron-backup');
 
 function encryptFilePath(filePath, encryption) {
     assert.strictEqual(typeof filePath, 'string');
@@ -52,9 +42,9 @@ function decryptFilePath(filePath, encryption) {
             const buffer = Buffer.from(part, 'base64');
             const iv = buffer.subarray(0, 16);
 
-            const decrypt = crypto.createDecipheriv('aes-256-cbc', Buffer.from(encryption.filenameKey, 'hex'), iv);
-            const plainText = decrypt.update(buffer.subarray(16));
-            const plainTextString = Buffer.concat([ plainText, decrypt.final() ]).toString('utf8');
+            const decipher = crypto.createDecipheriv('aes-256-cbc', Buffer.from(encryption.filenameKey, 'hex'), iv);
+            const plainText = decipher.update(buffer.subarray(16));
+            const plainTextString = Buffer.concat([ plainText, decipher.final() ]).toString('utf8');
             const hmac = crypto.createHmac('sha256', Buffer.from(encryption.filenameHmacKey, 'hex'));
             if (!hmac.update(plainTextString).digest().subarray(0, 16).equals(iv)) return { error: new Error(`mac error decrypting part ${part} of path ${filePath}`) };
 
@@ -332,3 +322,11 @@ async function decryptFilename(filePath, options) {
     if (error) return exit(error);
     console.log(decryptedFilePath);
 }
+
+export default {
+    encrypt,
+    decrypt,
+    encryptFilename,
+    decryptFilename,
+    decryptDir
+};

package/src/build-actions.js

@@ -1,31 +1,20 @@
-'use strict';
-
-exports = module.exports = {
-    login,
-    build,
-    logs,
-    status,
-    push
-};
-
-const assert = require('assert'),
-    config = require('./config.js'),
-    crypto = require('crypto'),
-    { EventSource } = require('eventsource'),
-    execSync = require('child_process').execSync,
-    exit = require('./helper.js').exit,
-    fs = require('fs'),
-    helper = require('./helper.js'),
-    manifestFormat = require('@cloudron/manifest-format'),
-    micromatch = require('micromatch'),
-    os = require('os'),
-    path = require('path'),
-    readline = require('./readline.js'),
-    safe = require('safetydance'),
-    stream = require('stream/promises'),
-    superagent = require('@cloudron/superagent'),
-    tar = require('tar-fs'),
-    { URL } = require('url');
+import assert from 'assert';
+import * as config from './config.js';
+import crypto from 'crypto';
+import { EventSource } from 'eventsource';
+import { execSync } from 'child_process';
+import { exit } from './helper.js';
+import fs from 'fs';
+import * as helper from './helper.js';
+import manifestFormat from '@cloudron/manifest-format';
+import micromatch from 'micromatch';
+import os from 'os';
+import path from 'path';
+import * as readline from './readline.js';
+import safe from '@cloudron/safetydance';
+import stream from 'stream/promises';
+import superagent from '@cloudron/superagent';
+import tar from 'tar-fs';
 
 function requestError(response) {
     if (response.status === 401 || response.status === 403) return 'Invalid token. Use cloudron build login again.';
@@ -33,68 +22,42 @@ function requestError(response) {
     return `${response.status} message: ${response.body?.message || response.text || null}`;
 }
 
-// analyzes options and merges with any existing build service config
-async function resolveBuildServiceConfig(options) {
-    const buildService = config.getBuildServiceConfig();
-    if (!buildService.type) buildService.type = 'local'; // default
-
-    if (options.local) {
-        buildService.type = 'local';
-    } else if (options.setBuildService) { // stash for future use
-        buildService.token = null;
-        buildService.url = null;
-        buildService.type = 'remote';
-
-        let url;
-        if (typeof options.setBuildService === 'string') {
-            url = options.setBuildService;
-        } else {
-            url = await readline.question('Enter build service URL: ', { });
-        }
-
-        if (url.indexOf('://') === -1) url = `https://${url}`;
-        buildService.url = url;
-    }
-
-    if (options.buildServiceToken) buildService.token = options.buildServiceToken;
-
-    config.setBuildServiceConfig(buildService);
-
-    return buildService;
-}
 
 async function login(localOptions, cmd) {
     const options = cmd.optsWithGlobals();
 
-    const buildServiceConfig = await resolveBuildServiceConfig(options);
+    const buildServiceConfig = config.getBuildServiceConfig();
+
+    let url = options.buildServiceUrl || buildServiceConfig.url;
+    if (!url) {
+        url = await readline.question('Build Service URL: ', {});
+        if (!url) return exit('No build service URL provided.');
+    }
+    if (url.indexOf('://') === -1) url = `https://${url}`;
 
-    console.log('Build Service login' + ` (${buildServiceConfig.url}):`);
+    console.log(`Build Service login (${url}):`);
 
     const token = options.buildServiceToken || await readline.question('Token: ', {});
 
-    const response = await superagent.get(`${buildServiceConfig.url}/api/v1/profile`).query({ accessToken: token }).ok(() => true);
+    const response = await superagent.get(`${url}/api/v1/profile`).query({ accessToken: token }).ok(() => true);
     if (response.status === 401 || response.status === 403) return exit(`Authentication error: ${requestError(response)}`);
     if (response.status !== 200) return exit(`Unexpected response: ${requestError(response)}`);
 
-    buildServiceConfig.token = token;
-    config.setBuildServiceConfig(buildServiceConfig);
+    config.setBuildServiceConfig({ type: 'remote', url, token });
 
     console.log('Login successful.');
 }
 
-async function followBuildLog(buildId, raw) {
+function logout() {
+    config.setBuildServiceConfig({});
+    console.log('Logged out.');
+}
+
+async function followBuildLog(buildServiceConfig, buildId, raw) {
     assert.strictEqual(typeof buildId, 'string');
     assert.strictEqual(typeof raw, 'boolean');
 
-    const rawUrl = config.getBuildServiceConfig().url;
-    let tmp;
-    try {
-        tmp = new URL(rawUrl);
-    } catch {
-        tmp = new URL(`http://${rawUrl}`);  // if it fails, prepend http://
-    }
-
-    const es = new EventSource(`${tmp.origin}/api/v1/builds/${buildId}/logstream?accessToken=${config.getBuildServiceConfig().token}`);
+    const es = new EventSource(`${buildServiceConfig.url}/api/v1/builds/${buildId}/logstream?accessToken=${buildServiceConfig.token}`);
 
     let prevId = null, prevWasStatus = false;
 
@@ -155,9 +118,7 @@ async function followBuildLog(buildId, raw) {
     });
 }
 
-async function getStatus(buildId) {
-    const buildServiceConfig = config.getBuildServiceConfig();
-
+async function getStatus(buildServiceConfig, buildId) {
     const response2 = await superagent.get(`${buildServiceConfig.url}/api/v1/builds/${buildId}`)
         .query({ accessToken: buildServiceConfig.token })
         .ok(() => true);
@@ -165,7 +126,7 @@ async function getStatus(buildId) {
     return response2.body.status;
 }
 
-function dockerignoreMatcher(dockerignorePath) {
+export function dockerignoreMatcher(dockerignorePath) {
     let patterns = [];
 
     if (fs.existsSync(dockerignorePath)) {
@@ -183,8 +144,8 @@ function dockerignoreMatcher(dockerignorePath) {
         patterns = patterns.filter(function (line) { return line.length !== 0; });
     }
 
-    return function ignore(path) {
-        return micromatch([ path ], patterns, { dot: true }).length == 1;
+    return function ignore(filePath) {
+        return micromatch([ filePath ], patterns, { dot: true }).length == 1;
     };
 }
 
@@ -225,9 +186,9 @@ async function buildLocal(manifest, sourceDir, appConfig, options) {
     const match = /.*@sha256:(.*)/.exec(result.trim());
     if (!match) exit('Failed to detect sha256');
 
-    appConfig.dockerImage = `${dockerImage}`;
+    appConfig.dockerImage = dockerImage;
     appConfig.dockerImageSha256 = match[1]; // stash this separately for now
-    config.setAppConfig(sourceDir, appConfig);
+    config.setAppBuildConfig(sourceDir, appConfig);
 }
 
 async function buildRemote(manifest, sourceDir, appConfig, options) {
@@ -290,16 +251,16 @@ async function buildRemote(manifest, sourceDir, appConfig, options) {
     const buildId = response.body.id;
     console.log(`BuildId: ${buildId}`);
 
-    const [logsError] = await safe(followBuildLog(buildId, !!options.raw));
+    const [logsError] = await safe(followBuildLog(buildServiceConfig, buildId, !!options.raw));
     if (logsError) console.log(`Failed to get logs: ${logsError.message}`);
 
-    const [statusError, status] = await safe(getStatus(buildId));
+    const [statusError, buildStatus] = await safe(getStatus(buildServiceConfig, buildId));
     if (statusError) return exit(`Failed to get status: ${statusError.message}`);
-    if (status !== 'success') return exit('Failed to build app. See log output above.');
+    if (buildStatus !== 'success') return exit('Failed to build app. See log output above.');
 
     appConfig.dockerImage = dockerImage;
     // appConfig.dockerImageSha256 = match[1]; // stash this separately for now
-    config.setAppConfig(sourceDir, appConfig);
+    config.setAppBuildConfig(sourceDir, appConfig);
 
     console.log(`Docker image: ${dockerImage}`);
     console.log('\nBuild successful');
@@ -320,8 +281,8 @@ async function build(localOptions, cmd) {
     const manifest = result.manifest;
     const sourceDir = path.dirname(manifestFilePath);
 
-    const appConfig = config.getAppConfig(sourceDir);
-    const buildServiceConfig = await resolveBuildServiceConfig(options);
+    const appConfig = config.getAppBuildConfig(sourceDir);
+    const buildServiceConfig = config.getBuildServiceConfig();
 
     let repository = appConfig.repository;
     if (!repository || options.setRepository) {
@@ -337,41 +298,48 @@ async function build(localOptions, cmd) {
         if (parts.length > 1) exit(`repository should not be a URL. Try again without ${parts[0]}://`);
 
         appConfig.repository = repository;
-        config.setAppConfig(sourceDir, appConfig);
+        config.setAppBuildConfig(sourceDir, appConfig);
     }
 
     appConfig.gitCommit = execSync('git rev-parse HEAD', { encoding: 'utf8' }).trim(); // when the build gets saved, save the gitCommit also
-    if (buildServiceConfig.type === 'local') {
-        await buildLocal(manifest, sourceDir, appConfig, options);
-    } else if (buildServiceConfig.type === 'remote' && buildServiceConfig.url) {
+    if (buildServiceConfig.type === 'remote' && buildServiceConfig.url) {
         await buildRemote(manifest, sourceDir, appConfig, options);
     } else {
-        exit('Unknown build service type or missing build service url. Rerun with --reset-build-service');
+        await buildLocal(manifest, sourceDir, appConfig, options);
     }
 }
 
 async function logs(localOptions, cmd) {
     const options = cmd.optsWithGlobals();
 
+    const buildServiceConfig = config.getBuildServiceConfig();
+    if (buildServiceConfig.type !== 'remote') return exit('This command only works with the build service. Use cloudron build login first.');
+
     if (!options.id) return exit('buildId is required');
 
-    const [logsError] = await safe(followBuildLog(options.id, !!options.raw));
+    const [logsError] = await safe(followBuildLog(buildServiceConfig, options.id, !!options.raw));
     if (logsError) console.log(`Failed to get logs: ${logsError.message}`);
 }
 
 async function status(localOptions, cmd) {
     const options = cmd.optsWithGlobals();
 
+    const buildServiceConfig = config.getBuildServiceConfig();
+    if (buildServiceConfig.type !== 'remote') return exit('This command only works with the build service. Use cloudron build login first.');
+
     if (!options.id) return exit('buildId is required');
 
-    const [statusError, status] = await safe(getStatus(options.id));
+    const [statusError, buildStatus] = await safe(getStatus(buildServiceConfig, options.id));
     if (statusError) return exit(`Failed to get status: ${statusError.message}`);
-    console.log(status);
+    console.log(buildStatus);
 }
 
 async function push(localOptions, cmd) {
     const options = cmd.optsWithGlobals();
 
+    const buildServiceConfig = config.getBuildServiceConfig();
+    if (buildServiceConfig.type !== 'remote') return exit('This command only works with the build service. Use cloudron build login first.');
+
     if (!options.id) return exit('buildId is required');
     let repository, tag;
     if (options.image) {
@@ -383,18 +351,64 @@ async function push(localOptions, cmd) {
         tag = options.tag;
     }
 
-    const buildServiceConfig = await resolveBuildServiceConfig(options);
-
     const response = await superagent.post(`${buildServiceConfig.url}/api/v1/builds/${options.id}/push`)
         .query({ accessToken: buildServiceConfig.token })
         .send({ dockerImageRepo: repository, dockerImageTag: tag })
         .ok(() => true);
     if (response.status !== 201) return exit(`Failed to push: ${requestError(response)}`);
 
-    const [logsError] = await safe(followBuildLog(options.id, !!options.raw));
+    const [logsError] = await safe(followBuildLog(buildServiceConfig, options.id, !!options.raw));
     if (logsError) console.log(`Failed to get logs: ${logsError.message}`);
 
-    const [statusError, status] = await safe(getStatus(options.id));
+    const [statusError, buildStatus] = await safe(getStatus(buildServiceConfig, options.id));
     if (statusError) return exit(`Failed to get status: ${statusError.message}`);
-    if (status !== 'success') return exit('Failed to push app. See log output above.');
+    if (buildStatus !== 'success') return exit('Failed to push app. See log output above.');
+}
+
+async function clear(/* localOptions, cmd */) {
+    // const options = cmd.optsWithGlobals();
+
+    // try to find the manifest of this project
+    const manifestFilePath = helper.locateManifest();
+    if (!manifestFilePath) return exit('No CloudronManifest.json found');
+
+    const sourceDir = path.dirname(manifestFilePath);
+
+    config.unsetAppBuildConfig(sourceDir);
 }
+
+async function info(/* localOptions, cmd */) {
+    // const options = cmd.optsWithGlobals();
+
+    const buildService = config.getBuildServiceConfig();
+    console.log(`Build service type: ${buildService.type || 'local'}`);
+    if (buildService.type === 'remote') console.log(`Build service URL: ${buildService.url}`);
+
+    // try to find the manifest of this project
+    const manifestFilePath = helper.locateManifest();
+    if (!manifestFilePath) return exit();
+
+    const sourceDir = path.dirname(manifestFilePath);
+    const appConfig = config.getAppBuildConfig(sourceDir);
+
+    console.log('Build info');
+    if (appConfig?.dockerImage) {
+        console.log(`  Image: ${appConfig.dockerImage}`); // repo:tag
+        console.log(`  Git commit: ${appConfig.gitCommit || '-'}`);
+        console.log(`  Image SHA256: ${appConfig.dockerImageSha256 || '-'}`);
+    } else {
+        console.log('  Image: not built');
+    }
+}
+
+export default {
+    login,
+    logout,
+    build,
+    logs,
+    status,
+    push,
+    clear,
+    info,
+    dockerignoreMatcher
+};

package/src/completion.js

@@ -1,11 +1,7 @@
-/* jshint node:true */
+import * as helper from './helper.js';
+import util from 'util';
 
-'use strict';
-
-const helper = require('./helper.js'),
-    util = require('util');
-
-exports = module.exports = function (options, cmd) {
+export default function (options, cmd) {
     var completion = '';
 
     const commands = [];
@@ -39,4 +35,4 @@ exports = module.exports = function (options, cmd) {
     }
 
     console.log(completion);
-};
+}