cloudron 5.11.6 → 5.11.8

package/bin/cloudron-appstore

@@ -2,10 +2,17 @@
 
 'use strict';
 
-const { program } = require('commander'),
-    appstoreActions = require('../src/appstore-actions.js');
+const appstoreActions = require('../src/appstore-actions.js'),
+    Command = require('commander').Command;
 
-program.version(require('../package.json').version);
+const version = require('../package.json').version;
+
+const program = new Command();
+program.version(version);
+
+// global options. IMPORTANT: These cannot conflict with global options!
+program
+    .option('--appstore-token <token>', 'AppStore token');
 
 program.command('login')
     .description('Login to the appstore')
@@ -27,9 +34,13 @@ program.command('approve')
     .option('--appstore-id <appid@version>', 'Appstore id and version')
     .action(appstoreActions.approve);
 
-program.command('publish <version>')
-    .description('Tag the repo and publish')
-    .action(appstoreActions.publish);
+program.command('notify')
+    .description('Notify forum about successful app submission')
+    .action(appstoreActions.notify);
+
+program.command('tag <version>')
+    .description('Tag the repo')
+    .action(appstoreActions.tag);
 
 program.command('revoke')
     .description('Revoke a published app version')
@@ -47,6 +58,7 @@ program.command('upload')
     .action(appstoreActions.upload);
 
 program.command('versions')
+    .alias('list')
     .description('List published versions')
     .option('--appstore-id <id>', 'Appstore id')
     .option('--raw', 'Dump versions as json')

package/bin/cloudron-build

@@ -12,9 +12,9 @@ function collectArgs(value, collected) {
     return collected;
 }
 
-// global options
+// global options. IMPORTANT: These cannot conflict with global options!
 program.option('--server <server>', 'Cloudron domain')
-    .option('--token, --build-service-token <token>', 'Build service token')
+    .option('--build-token, --build-service-token <token>', 'Build service token')
     .option('--url, --set-build-service [buildservice url]', 'Set build service URL. This build service is automatically used for future calls from this project');
 
 program.command('build', { isDefault: true })
@@ -45,6 +45,7 @@ program.command('push')
     .option('--id <buildid>', 'Build ID')
     .option('--repository [repository url]', 'Set repository to push to. e.g registry/username/projectname')
     .option('--tag <docker image tag>', 'Docker image tag. Note that this does not include the repository name')
+    .option('--image <docker image>', 'Docker image of the form registry/repo:tag')
     .action(buildActions.push);
 
 program.command('status')

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "cloudron",
-  "version": "5.11.6",
+  "version": "5.11.8",
   "license": "MIT",
   "description": "Cloudron Commandline Tool",
   "main": "main.js",
-  "homepage": "https://git.cloudron.io/cloudron/cloudron-cli",
+  "homepage": "https://git.cloudron.io/platform/cloudron-cli",
   "repository": {
     "type": "git",
-    "url": "https://git.cloudron.io/cloudron/cloudron-cli.git"
+    "url": "https://git.cloudron.io/platform/cloudron-cli.git"
   },
   "scripts": {
     "test": "mocha test/test.js"

package/src/appstore-actions.js

@@ -25,7 +25,8 @@ exports = module.exports = {
     revoke,
     approve,
 
-    publish
+    tag,
+    notify
 };
 
 const NO_MANIFEST_FOUND_ERROR_STRING = 'No CloudronManifest.json found';
@@ -36,10 +37,12 @@ function requestError(response) {
     return `${response.statusCode} message: ${response.body.message || JSON.stringify(response.body)}`; // body is sometimes just a string like in 401
 }
 
-function createRequest(method, apiPath) {
+function createRequest(method, apiPath, options) {
+    const token = options.appstoreToken || config.appStoreToken();
+
     let url = `${config.appStoreOrigin()}${apiPath}`;
     if (url.includes('?')) url += '&'; else url += '?';
-    url += `accessToken=${config.appStoreToken()}`;
+    url += `accessToken=${token}`;
     const request = superagent(method, url);
     request.retry(3);
     request.ok(() => true);
@@ -63,7 +66,7 @@ async function getAppstoreId(appstoreId) {
     return [manifest.id, manifest.version];
 }
 
-async function authenticate(options) {
+async function authenticate(options) { // maybe we can use options.token to valid using a profile call?
     if (!options.hideBanner) {
         const webDomain = config.appStoreOrigin().replace('https://api.', '');
         console.log(`${webDomain} login` + ` (If you do not have one, sign up at https://${webDomain}/console.html#/register)`);
@@ -101,7 +104,8 @@ async function authenticate(options) {
     console.log('Login successful.');
 }
 
-async function login(options) {
+async function login(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
     await authenticate(options);
 }
 
@@ -110,11 +114,12 @@ function logout() {
     console.log('Done.');
 }
 
-async function info(options) {
+async function info(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
     const [id, version] = await getAppstoreId(options.appstoreId);
 
-    const response = await createRequest('GET', `/api/v1/developers/apps/${id}/versions/${version}`);
-    if (response.statusCode !== 200) throw new Error(`Failed to list domains: ${requestError(response)}`);
+    const response = await createRequest('GET', `/api/v1/developers/apps/${id}/versions/${version}`, options);
+    if (response.statusCode !== 200) return exit(new Error(`Failed to list versions: ${requestError(response)}`));
 
     const manifest = response.body.manifest;
     console.log('id: %s', manifest.id);
@@ -125,11 +130,12 @@ async function info(options) {
     console.log('contactEmail: %s', manifest.contactEmail);
 }
 
-async function listVersions(options) {
+async function listVersions(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
     const [id] = await getAppstoreId(options.appstoreId);
 
-    const response = await createRequest('GET', `/api/v1/developers/apps/${id}/versions`);
-    if (response.statusCode !== 200) throw new Error(`Failed to list domains: ${requestError(response)}`);
+    const response = await createRequest('GET', `/api/v1/developers/apps/${id}/versions`, options);
+    if (response.statusCode !== 200) return exit(new Error(`Failed to list versions: ${requestError(response)}`));
 
     if (response.body.versions.length === 0) return console.log('No versions found.');
 
@@ -150,17 +156,6 @@ async function listVersions(options) {
     console.log(t.toString());
 }
 
-async function addApp(manifest, baseDir) {
-    assert.strictEqual(typeof manifest, 'object');
-    assert.strictEqual(typeof baseDir, 'string');
-
-    const request = createRequest('POST', '/api/v1/developers/apps');
-    request.send({ id: manifest.id });
-    const response = await request;
-    if (response.statusCode === 409) return; // already exists
-    if (response.statusCode !== 201) return exit(`Failed to add app: ${requestError(response)}`);
-}
-
 function parseChangelog(file, version) {
     let changelog = '';
     const data = safe.fs.readFileSync(file, 'utf8');
@@ -184,9 +179,10 @@ function parseChangelog(file, version) {
     return changelog;
 }
 
-async function addVersion(manifest, baseDir) {
+async function addVersion(manifest, baseDir, options) {
     assert.strictEqual(typeof manifest, 'object');
     assert.strictEqual(typeof baseDir, 'string');
+    assert.strictEqual(typeof options, 'object');
 
     let iconFilePath = null;
     if (manifest.icon) {
@@ -220,7 +216,7 @@ async function addVersion(manifest, baseDir) {
         if (!manifest.changelog) throw new Error('Bad changelog format or missing changelog for this version');
     }
 
-    const request = createRequest('POST', `/api/v1/developers/apps/${manifest.id}/versions`);
+    const request = createRequest('POST', `/api/v1/developers/apps/${manifest.id}/versions`, options);
     if (iconFilePath) request.attach('icon', iconFilePath);
     request.attach('manifest', Buffer.from(JSON.stringify(manifest)), 'manifest');
     const response = await request;
@@ -228,9 +224,10 @@ async function addVersion(manifest, baseDir) {
     if (response.statusCode !== 204) throw new Error(`Failed to publish version: ${requestError(response)}`);
 }
 
-async function updateVersion(manifest, baseDir) {
+async function updateVersion(manifest, baseDir, options) {
     assert.strictEqual(typeof manifest, 'object');
     assert.strictEqual(typeof baseDir, 'string');
+    assert.strictEqual(typeof options, 'object');
 
     let iconFilePath = null;
     if (manifest.icon) {
@@ -262,59 +259,15 @@ async function updateVersion(manifest, baseDir) {
         if (!manifest.changelog) throw new Error('Could not read changelog or missing version changes');
     }
 
-    const request = createRequest('PUT', `/api/v1/developers/apps/${manifest.id}/versions/${manifest.version}`);
+    const request = createRequest('PUT', `/api/v1/developers/apps/${manifest.id}/versions/${manifest.version}`, options);
     if (iconFilePath) request.attach('icon', iconFilePath);
     request.attach('manifest', Buffer.from(JSON.stringify(manifest)), 'manifest');
     const response = await request;
     if (response.statusCode !== 204) throw new Error(`Failed to publish version: ${requestError(response)}`);
 }
 
-async function revokeVersion(appstoreId, version) {
-    assert.strictEqual(typeof appstoreId, 'string');
-    assert.strictEqual(typeof version, 'string');
-
-    const response = await createRequest('POST', `/api/v1/developers/apps/${appstoreId}/versions/${version}/revoke`);
-    if (response.statusCode !== 200) return exit(`Failed to revoke version: ${requestError(response)}`);
-
-    console.log('version revoked.');
-}
-
-async function approveVersion(appstoreId, version) {
-    assert.strictEqual(typeof appstoreId, 'string');
-    assert.strictEqual(typeof version, 'string');
-
-    const response = await createRequest('POST', `/api/v1/developers/apps/${appstoreId}/versions/${version}/approve`);
-    if (response.statusCode !== 200) return exit(`Failed to approve version: ${requestError(response)}`);
-
-    console.log('Approved.');
-    console.log('');
-
-    const response2 = await createRequest('GET', `/api/v1/developers/apps/${appstoreId}/versions/${version}`);
-    if (response2.statusCode !== 200) return exit(`Failed to list apps: ${requestError(response)}`);
-
-    console.log('Changelog for forum update: ' + response2.body.manifest.forumUrl);
-    console.log('');
-    console.log('[' + version + ']');
-    console.log(response2.body.manifest.changelog);
-    console.log('');
-}
-
-async function submitAppForReview(manifest) {
-    assert.strictEqual(typeof manifest, 'object');
-
-    const response = await createRequest('POST', `/api/v1/developers/apps/${manifest.id}/versions/${manifest.version}/submit`);
-    if (response.statusCode === 404) {
-        console.log(`No version ${manifest.version} found. Please use 'cloudron apsptore upload' first`);
-        return exit('Failed to submit app for review.');
-    }
-
-    if (response.statusCode !== 200) return exit(`Failed to submit app: ${requestError(response)}`);
-
-    console.log('App submitted for review.');
-    console.log('You will receive an email when approved.');
-}
-
-async function upload(options) {
+async function upload(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
     // try to find the manifest of this project
     const manifestFilePath = locateManifest();
     if (!manifestFilePath) return exit(NO_MANIFEST_FOUND_ERROR_STRING);
@@ -328,8 +281,19 @@ async function upload(options) {
     const appConfig = config.getAppConfig(sourceDir);
 
     // image can be passed in options for buildbot
-    const dockerImage = options.image ? options.image : appConfig.dockerImage;
-    manifest.dockerImage = dockerImage;
+    if (options.image) {
+        manifest.dockerImage = options.image;
+    } else {
+        const gitCommit = execSync('git rev-parse HEAD', { encoding: 'utf8' }).trim();
+        if (appConfig.gitCommit !== gitCommit) {
+            console.log(`This build ${appConfig.dockerImage} was made from git hash ${appConfig.gitCommit} but you are now at ${gitCommit}`);
+            if (!appConfig.gitCommit) return exit('The build is stale');
+            const output = execSync(`git diff ${appConfig.gitCommit}..HEAD --name-only`, { encoding: 'utf8'});
+            const changedFiles = output.trim().split('\n').filter(filepath => !filepath.match(/(^CHANGELOG|README|CloudronManifest|test\|.git|screenshots|renovate|LICENSE|POSTINSTALL|.docker|logo)/));
+            if (changedFiles.length) return exit(`The build is stale. Changed files: ${changedFiles.join(',')}`);
+        }
+        manifest.dockerImage = appConfig.dockerImage;
+    }
 
     if (!manifest.dockerImage) exit('No docker image found, run `cloudron build` first');
 
@@ -339,16 +303,26 @@ async function upload(options) {
     const error = manifestFormat.checkAppstoreRequirements(manifest);
     if (error) return exit(error);
 
+    const [repo, tag] = manifest.dockerImage.split(':');
+    const [tagError, tagResponse] = await safe(superagent.get(`https://hub.docker.com/v2/repositories/${repo}/tags/${tag}`).ok(() => true));
+    if (tagError || tagResponse.statusCode !== 200) return exit(`Failed to find docker image in dockerhub. check https://hub.docker.com/r/${repo}/tags : ${requestError(tagResponse)}`);
+
     // ensure the app is known on the appstore side
     const baseDir = path.dirname(manifestFilePath);
-    await addApp(manifest, baseDir);
+
+    const request = createRequest('POST', '/api/v1/developers/apps', options);
+    request.send({ id: manifest.id });
+    const response = await request;
+    if (response.statusCode !== 409 && response.statusCode !== 201) return exit(`Failed to add app: ${requestError(response)}`); // 409 means already exists
     console.log(`Uploading ${manifest.id}@${manifest.version} (dockerImage: ${manifest.dockerImage}) for testing`);
 
-    const [error2] = await safe(options.force ? updateVersion(manifest, baseDir) : addVersion(manifest, baseDir));
+    const [error2] = await safe(options.force ? updateVersion(manifest, baseDir, options) : addVersion(manifest, baseDir, options));
     if (error2) return exit(error2);
 }
 
-function submit() {
+async function submit(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
+
     // try to find the manifest of this project
     const manifestFilePath = locateManifest();
     if (!manifestFilePath) return exit(NO_MANIFEST_FOUND_ERROR_STRING);
@@ -358,28 +332,57 @@ function submit() {
 
     const manifest = result.manifest;
 
-    submitAppForReview(manifest, exit);
+    const response = await createRequest('POST', `/api/v1/developers/apps/${manifest.id}/versions/${manifest.version}/submit`, options);
+    if (response.statusCode === 404) {
+        console.log(`No version ${manifest.version} found. Please use 'cloudron apsptore upload' first`);
+        return exit('Failed to submit app for review.');
+    }
+
+    if (response.statusCode !== 200) return exit(`Failed to submit app: ${requestError(response)}`);
+
+    console.log('App submitted for review.');
+    console.log('You will receive an email when approved.');
 }
 
-async function revoke(options) {
+async function revoke(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
     const [id, version] = await getAppstoreId(options.appstoreId);
     if (!version) return exit('--appstore-id must be of the format id@version');
 
     console.log(`Revoking ${id}@${version}`);
-    await revokeVersion(id, version);
+
+    const response = await createRequest('POST', `/api/v1/developers/apps/${id}/versions/${version}/revoke`, options);
+    if (response.statusCode !== 200) return exit(`Failed to revoke version: ${requestError(response)}`);
+
+    console.log('version revoked.');
 }
 
-async function approve(options) {
-    const [id, version] = await getAppstoreId(options.appstoreId);
+async function approve(localOptions, cmd) {
+    const options = cmd.optsWithGlobals();
+
+    const [appstoreId, version] = await getAppstoreId(options.appstoreId);
 
     if (!version) return exit('--appstore-id must be of the format id@version');
 
-    console.log(`Approving ${id}@${version}`);
+    console.log(`Approving ${appstoreId}@${version}`);
+
+    const response = await createRequest('POST', `/api/v1/developers/apps/${appstoreId}/versions/${version}/approve`, options);
+    if (response.statusCode !== 200) return exit(`Failed to approve version: ${requestError(response)}`);
 
-    await approveVersion(id, version);
+    console.log('Approved.');
+    console.log('');
+
+    const response2 = await createRequest('GET', `/api/v1/developers/apps/${appstoreId}/versions/${version}`, options);
+    if (response2.statusCode !== 200) return exit(`Failed to list apps: ${requestError(response)}`);
+
+    console.log('Changelog for forum update: ' + response2.body.manifest.forumUrl);
+    console.log('');
+    console.log('[' + version + ']');
+    console.log(response2.body.manifest.changelog);
+    console.log('');
 }
 
-async function tagRepository(version) {
+async function tag(version) {
     const basename = `${path.basename(process.cwd())}`;
     if (!basename.endsWith('-app')) return exit('Does not look like a app repo. Has to end with -app');
 
@@ -392,7 +395,7 @@ async function tagRepository(version) {
     if (!manifestFilePath) return exit('Could not locate CloudronManifest.json');
 
     const result = manifestFormat.parseFile(manifestFilePath);
-    if (result.error) throw new Error(`Invalid CloudronManifest.json: ${result.error.message}`);
+    if (result.error) return exit(new Error(`Invalid CloudronManifest.json: ${result.error.message}`));
     const { manifest } = result;
 
     const latestVersion = latestTag.match(/v(.*)/)[1];
@@ -441,22 +444,60 @@ async function tagRepository(version) {
     console.log(`Created tag v${version} and pushed branch ${branch}`);
 }
 
-async function publish(version, options) {
-    await tagRepository(version);
+// https://docs.nodebb.org/api/read/
+// https://docs.nodebb.org/api/write/
+async function notify() {
+    if (!process.env.NODEBB_API_TOKEN) return exit('NODEBB_API_TOKEN env var has to be set');
+    const apiToken = process.env.NODEBB_API_TOKEN;
 
     const manifestFilePath = locateManifest();
     if (!manifestFilePath) return exit('Could not locate CloudronManifest.json');
 
-    const latestRenovateCommit = safe.child_process.execSync('git log -n 1 --committer=renovatebot@cloudron.io --pretty="format:%h,%aI,%s"', { encoding: 'utf8' });
-    if (!latestRenovateCommit) return exit('Could not find a commit from renovate bot');
+    const result = manifestFormat.parseFile(manifestFilePath);
+    if (result.error) return exit(new Error(`Invalid CloudronManifest.json: ${result.error.message}`));
+    const { manifest } = result;
 
-    const [ abbrevHash, commitDate ] = latestRenovateCommit.split(',');
-    const cleanDate = commitDate.replace(/T.*/, '').replace(/[-]/g, '');
-    const repoDir = path.dirname(manifestFilePath);
-    const repoName = path.basename(repoDir).replace('-app', '');
-    const dockerImage = options.image || `cloudron/${repoName}:${cleanDate}-${abbrevHash}`;
+    let postContent = null;
+    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 changelog = parseChangelog(changelogPath, manifest.version);
+        if (!changelog) return exit('Bad changelog format or missing changelog for this version');
+        postContent = `[${manifest.version}]\n${changelog}\n`;
+    } else {
+        postContent = `[${manifest.version}]\n${manifest.changelog}\n`;
+    }
+
+    if (!manifest.forumUrl) return exit(new Error('CloudronManifest.json does not have a forumUrl'));
+    const categoryMatch = manifest.forumUrl.match(/category\/(.*)\//);
+    if (!categoryMatch) return exit('Unable to detect category id');
+    const categoryId = categoryMatch[1];
+
+    const categoryResponse = await superagent.get(`https://forum.cloudron.io/api/v3/categories/${categoryId}/topics`).set('Authorization', `Bearer ${apiToken}`).ok(() => true);
+    if (categoryResponse.statusCode !== 200) return exit(`Unable to get topics of category: ${requestError(categoryResponse)}`);
+    const topic = categoryResponse.body.response.topics.find(t => t.title.includes('Package Updates'));
+    if (!topic) return exit('Could not find the Package Update topic');
+    const topicId = topic.tid;
+
+    const pageCountResponse = await superagent.get(`https://forum.cloudron.io/api/topic/pagination/${topicId}`).set('Authorization', `Bearer ${apiToken}`).ok(() => true);
+    if (pageCountResponse.statusCode !== 200) return exit(`Unable to get page count of topic: ${requestError(pageCountResponse)}`);
+    const pageCount = pageCountResponse.body.pagination.pageCount;
+
+    for (let page = 1; page <= pageCount; page++) {
+        const pageResponse = await superagent.get(`https://forum.cloudron.io/api/topic/${topicId}?page=${page}`).set('Authorization', `Bearer ${apiToken}`).ok(() => true);
+        if (pageResponse.statusCode !== 200) return exit(`Unable to get topics of category: ${requestError(pageResponse)}`);
+        for (const post of pageResponse.body.posts) { // post.content is html!
+            if (post.content.includes(`[${manifest.version}]`)) return exit(`Version ${manifest.version} is already on the forum.\n${post.content}`);
+        }
+    }
 
-    await upload({ image: dockerImage, force: false });
-    await submit();
-    await approve();
+    // https://docs.nodebb.org/api/write/#tag/topics/paths/~1topics~1%7Btid%7D/post
+    const postData = {
+        content: postContent,
+        toPid: 0 // which post is this post a reply to
+    };
+    const postResponse = await superagent.post(`https://forum.cloudron.io/api/v3/topics/${topicId}`).set('Authorization', `Bearer ${apiToken}`).send(postData).ok(() => true);
+    if (postResponse.statusCode !== 200) return exit(`Unable to create changelog post: ${requestError(postResponse)}`);
+    console.log('Posted to forum');
 }

package/src/build-actions.js

@@ -331,6 +331,7 @@ async function build(localOptions, cmd) {
         config.setAppConfig(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) {
@@ -363,14 +364,21 @@ async function push(localOptions, cmd) {
     const options = cmd.optsWithGlobals();
 
     if (!options.id) return exit('buildId is required');
-    if (!options.repository) return exit('repository is required');
-    if (!options.tag) return exit('tag is required');
+    let repository, tag;
+    if (options.image) {
+        [repository, tag] = options.image.split(':');
+    } else {
+        if (!options.repository) return exit('repository is required');
+        if (!options.tag) return exit('tag is required');
+        repository = options.repository;
+        tag = options.tag;
+    }
 
     const buildServiceConfig = getBuildServiceConfig(options);
 
     const response = await superagent.post(`${buildServiceConfig.url}/api/v1/builds/${options.id}/push`)
         .query({ accessToken: buildServiceConfig.token })
-        .send({ dockerImageRepo: options.repository, dockerImageTag: options.tag })
+        .send({ dockerImageRepo: repository, dockerImageTag: tag })
         .ok(() => true);
     if (response.statusCode !== 201) return exit(`Failed to push: ${requestError(response)}`);