Add initial support for apps.checklist

src/apps.js

@@ -187,7 +187,7 @@ const APPS_FIELDS_PREFIXED = [ 'apps.id', 'apps.appStoreId', 'apps.installationS
     'apps.health', 'apps.containerId', 'apps.manifestJson', 'apps.accessRestrictionJson', 'apps.memoryLimit', 'apps.cpuQuota',
     'apps.label', 'apps.notes', 'apps.tagsJson', 'apps.taskId', 'apps.reverseProxyConfigJson', 'apps.servicesConfigJson', 'apps.operatorsJson',
     'apps.sso', 'apps.debugModeJson', 'apps.enableBackup', 'apps.proxyAuth', 'apps.containerIp', 'apps.crontab',
-    'apps.creationTime', 'apps.updateTime', 'apps.enableAutomaticUpdate', 'apps.upstreamUri',
+    'apps.creationTime', 'apps.updateTime', 'apps.enableAutomaticUpdate', 'apps.upstreamUri', 'apps.checklistJson',
     'apps.enableMailbox', 'apps.mailboxDisplayName', 'apps.mailboxName', 'apps.mailboxDomain', 'apps.enableInbox', 'apps.inboxName', 'apps.inboxDomain',
     'apps.enableTurn', 'apps.enableRedis', 'apps.storageVolumeId', 'apps.storageVolumePrefix', 'apps.ts', 'apps.healthTime', '(apps.icon IS NOT NULL) AS hasIcon', '(apps.appStoreIcon IS NOT NULL) AS hasAppStoreIcon' ].join(',');
 
@@ -576,7 +576,7 @@ function removeInternalFields(app) {
         'accessRestriction', 'manifest', 'portBindings', 'iconUrl', 'memoryLimit', 'cpuQuota', 'operators',
         'sso', 'debugMode', 'reverseProxyConfig', 'enableBackup', 'creationTime', 'updateTime', 'ts', 'tags',
         'label', 'notes', 'secondaryDomains', 'redirectDomains', 'aliasDomains', 'env', 'enableAutomaticUpdate',
-        'storageVolumeId', 'storageVolumePrefix', 'mounts', 'enableTurn', 'enableRedis',
+        'storageVolumeId', 'storageVolumePrefix', 'mounts', 'enableTurn', 'enableRedis', 'checklist',
         'enableMailbox', 'mailboxDisplayName', 'mailboxName', 'mailboxDomain', 'enableInbox', 'inboxName', 'inboxDomain');
 
     removeCertificateKeys(result);
@@ -632,6 +632,10 @@ function postProcess(result) {
     result.tags = safe.JSON.parse(result.tagsJson) || [];
     delete result.tagsJson;
 
+    assert(result.checklistJson === null || typeof result.checklistJson === 'string');
+    result.checklist = safe.JSON.parse(result.checklistJson) || {};
+    delete result.checklistJson;
+
     assert(result.reverseProxyConfigJson === null || typeof result.reverseProxyConfigJson === 'string');
     result.reverseProxyConfig = safe.JSON.parse(result.reverseProxyConfigJson) || {};
     delete result.reverseProxyConfigJson;
@@ -841,6 +845,7 @@ async function add(id, appStoreId, manifest, subdomain, domain, portBindings, da
         env = data.env || {},
         label = data.label || null,
         tagsJson = data.tags ? JSON.stringify(data.tags) : null,
+        checklistJson = data.checklist ? JSON.stringify(data.checklist) : null,
         mailboxName = data.mailboxName || null,
         mailboxDomain = data.mailboxDomain || null,
         mailboxDisplayName = data.mailboxDisplayName || '',
@@ -858,11 +863,11 @@ async function add(id, appStoreId, manifest, subdomain, domain, portBindings, da
 
     queries.push({
         query: 'INSERT INTO apps (id, appStoreId, manifestJson, installationState, runState, accessRestrictionJson, memoryLimit, cpuQuota, '
-            + 'sso, debugModeJson, mailboxName, mailboxDomain, label, tagsJson, reverseProxyConfigJson, servicesConfigJson, icon, '
+            + 'sso, debugModeJson, mailboxName, mailboxDomain, label, tagsJson, reverseProxyConfigJson, checklistJson, servicesConfigJson, icon, '
             + 'enableMailbox, mailboxDisplayName, upstreamUri, enableTurn, enableRedis) '
-            + ' VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
+            + ' VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
         args: [ id, appStoreId, manifestJson, installationState, runState, accessRestrictionJson, memoryLimit, cpuQuota,
-            sso, debugModeJson, mailboxName, mailboxDomain, label, tagsJson, reverseProxyConfigJson, servicesConfigJson, icon,
+            sso, debugModeJson, mailboxName, mailboxDomain, label, tagsJson, reverseProxyConfigJson, checklistJson, servicesConfigJson, icon,
             enableMailbox, mailboxDisplayName, upstreamUri, enableTurn, enableRedis ]
     });
 
@@ -936,6 +941,7 @@ async function updateWithConstraints(id, app, constraints) {
     assert(!('redirectDomains' in app) || Array.isArray(app.redirectDomains));
     assert(!('aliasDomains' in app) || Array.isArray(app.aliasDomains));
     assert(!('tags' in app) || Array.isArray(app.tags));
+    assert(!('checklist' in app) || typeof app.checklist === 'object');
     assert(!('env' in app) || typeof app.env === 'object');
 
 
@@ -997,7 +1003,7 @@ async function updateWithConstraints(id, app, constraints) {
 
     const fields = [ ], values = [ ];
     for (const p in app) {
-        if (p === 'manifest' || p === 'tags' || p === 'accessRestriction' || p === 'debugMode' || p === 'error' || p === 'reverseProxyConfig' || p === 'servicesConfig' || p === 'operators') {
+        if (p === 'manifest' || p === 'tags' || p === 'checklist' || p === 'accessRestriction' || p === 'debugMode' || p === 'error' || p === 'reverseProxyConfig' || p === 'servicesConfig' || p === 'operators') {
             fields.push(`${p}Json = ?`);
             values.push(JSON.stringify(app[p]));
         } else if (p !== 'portBindings' && p !== 'subdomain' && p !== 'domain' && p !== 'secondaryDomains' && p !== 'redirectDomains' && p !== 'aliasDomains' && p !== 'env' && p !== 'mounts') {
@@ -1325,6 +1331,7 @@ async function install(data, auditSource) {
         env = data.env || {},
         label = data.label || null,
         tags = data.tags || [],
+        checklist = data.manifest.checklist || {},
         overwriteDns = 'overwriteDns' in data ? data.overwriteDns : false,
         skipDnsSetup = 'skipDnsSetup' in data ? data.skipDnsSetup : false,
         enableTurn = 'enableTurn' in data ? data.enableTurn : true,
@@ -1414,6 +1421,7 @@ async function install(data, auditSource) {
         env,
         label,
         tags,
+        checklist,
         icon,
         enableMailbox,
         upstreamUri,
@@ -1992,6 +2000,8 @@ async function updateApp(app, data, auditSource) {
     error = await checkManifest(manifest);
     if (error) throw error;
 
+    // TODO check if checklist needs to be adjusted either here or in the apptask
+
     const updateConfig = { skipBackup, manifest, appStoreId }; // this will clear appStoreId when updating from a repo and set it if passed in for update route
 
     // prevent user from installing a app with different manifest id over an existing app