make turn service optional

part of #810

src/apps.js

@@ -42,6 +42,7 @@ exports = module.exports = {
     setEnvironment,
     setMailbox,
     setInbox,
+    setTurn,
     setLocation,
     setStorage,
     repair,
@@ -106,6 +107,7 @@ exports = module.exports = {
     ISTATE_PENDING_CONFIGURE: 'pending_configure', // infra update
     ISTATE_PENDING_RECREATE_CONTAINER: 'pending_recreate_container', // env change or addon change
     ISTATE_PENDING_LOCATION_CHANGE: 'pending_location_change',
+    ISTATE_PENDING_SERVICES_CHANGE: 'pending_services_change',
     ISTATE_PENDING_DATA_DIR_MIGRATION: 'pending_data_dir_migration',
     ISTATE_PENDING_RESIZE: 'pending_resize',
     ISTATE_PENDING_DEBUG: 'pending_debug',
@@ -198,7 +200,7 @@ const APPS_FIELDS_PREFIXED = [ 'apps.id', 'apps.appStoreId', 'apps.installationS
     'apps.sso', 'apps.debugModeJson', 'apps.enableBackup', 'apps.proxyAuth', 'apps.containerIp', 'apps.crontab',
     'apps.creationTime', 'apps.updateTime', 'apps.enableAutomaticUpdate', 'apps.upstreamUri',
     'apps.enableMailbox', 'apps.mailboxDisplayName', 'apps.mailboxName', 'apps.mailboxDomain', 'apps.enableInbox', 'apps.inboxName', 'apps.inboxDomain',
-    'apps.storageVolumeId', 'apps.storageVolumePrefix', 'apps.ts', 'apps.healthTime', '(apps.icon IS NOT NULL) AS hasIcon', '(apps.appStoreIcon IS NOT NULL) AS hasAppStoreIcon' ].join(',');
+    'apps.enableTurn', 'apps.storageVolumeId', 'apps.storageVolumePrefix', 'apps.ts', 'apps.healthTime', '(apps.icon IS NOT NULL) AS hasIcon', '(apps.appStoreIcon IS NOT NULL) AS hasAppStoreIcon' ].join(',');
 
 // const PORT_BINDINGS_FIELDS = [ 'hostPort', 'type', 'environmentVariable', 'appId' ].join(',');
 const LOCATION_FIELDS = [ 'appId', 'subdomain', 'domain', 'type', 'certificateJson' ];
@@ -593,7 +595,7 @@ function removeInternalFields(app) {
         'accessRestriction', 'manifest', 'portBindings', 'iconUrl', 'memoryLimit', 'cpuShares', 'operators',
         'sso', 'debugMode', 'reverseProxyConfig', 'enableBackup', 'creationTime', 'updateTime', 'ts', 'tags',
         'label', 'secondaryDomains', 'redirectDomains', 'aliasDomains', 'env', 'enableAutomaticUpdate',
-        'storageVolumeId', 'storageVolumePrefix', 'mounts',
+        'storageVolumeId', 'storageVolumePrefix', 'mounts', 'enableTurn',
         'enableMailbox', 'mailboxDisplayName', 'mailboxName', 'mailboxDomain', 'enableInbox', 'inboxName', 'inboxDomain');
 
     removeCertificateKeys(result);
@@ -840,6 +842,7 @@ async function add(id, appStoreId, manifest, subdomain, domain, portBindings, da
         servicesConfigJson = data.servicesConfig ? JSON.stringify(data.servicesConfig) : null,
         enableMailbox = data.enableMailbox || false,
         upstreamUri = data.upstreamUri || '',
+        enableTurn = 'enableTurn' in data ? data.enableTurn : true,
         icon = data.icon || null;
 
     const queries = [];
@@ -847,11 +850,11 @@ async function add(id, appStoreId, manifest, subdomain, domain, portBindings, da
     queries.push({
         query: 'INSERT INTO apps (id, appStoreId, manifestJson, installationState, runState, accessRestrictionJson, memoryLimit, cpuShares, '
             + 'sso, debugModeJson, mailboxName, mailboxDomain, label, tagsJson, reverseProxyConfigJson, servicesConfigJson, icon, '
-            + 'enableMailbox, mailboxDisplayName, upstreamUri) '
-            + ' VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
+            + 'enableMailbox, mailboxDisplayName, upstreamUri, enableTurn) '
+            + ' VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
         args: [ id, appStoreId, manifestJson, installationState, runState, accessRestrictionJson, memoryLimit, cpuShares,
             sso, debugModeJson, mailboxName, mailboxDomain, label, tagsJson, reverseProxyConfigJson, servicesConfigJson, icon,
-            enableMailbox, mailboxDisplayName, upstreamUri ]
+            enableMailbox, mailboxDisplayName, upstreamUri, enableTurn ]
     });
 
     queries.push({
@@ -1324,6 +1327,7 @@ async function install(data, auditSource) {
         tags = data.tags || [],
         overwriteDns = 'overwriteDns' in data ? data.overwriteDns : false,
         skipDnsSetup = 'skipDnsSetup' in data ? data.skipDnsSetup : false,
+        enableTurn = 'enableTurn' in data ? data.enableTurn : true,
         appStoreId = data.appStoreId,
         upstreamUri = data.upstreamUri || '',
         manifest = data.manifest;
@@ -1411,6 +1415,7 @@ async function install(data, auditSource) {
         icon,
         enableMailbox,
         upstreamUri,
+        enableTurn,
         runState: exports.RSTATE_RUNNING,
         installationState: exports.ISTATE_PENDING_INSTALL
     };
@@ -1733,6 +1738,29 @@ async function setInbox(app, data, auditSource) {
     return { taskId };
 }
 
+async function setTurn(app, enableTurn, auditSource) {
+    assert.strictEqual(typeof app, 'object');
+    assert.strictEqual(typeof enableTurn, 'boolean');
+    assert.strictEqual(typeof auditSource, 'object');
+
+    const appId = app.id;
+    let error = checkAppState(app, exports.ISTATE_PENDING_SERVICES_CHANGE);
+    if (error) throw error;
+
+    if (!app.manifest.addons?.turn) throw new BoxError(BoxError.BAD_FIELD, 'App does not use turn addon');
+    if (!app.manifest.addons.turn.optional) throw new BoxError(BoxError.BAD_FIELD, 'turn service is not optional');
+
+    const task = {
+        args: {},
+        values: { enableTurn }
+    };
+    const taskId = await addTask(appId, exports.ISTATE_PENDING_SERVICES_CHANGE, task, auditSource);
+
+    await eventlog.add(eventlog.ACTION_APP_CONFIGURE, auditSource, { appId, app, enableTurn, taskId });
+
+    return { taskId };
+}
+
 async function setAutomaticBackup(app, enable, auditSource) {
     assert.strictEqual(typeof app, 'object');
     assert.strictEqual(typeof enable, 'boolean');