config: Replace supervisorOfflineMode and offlineMode with unmanaged

Change-type: major
Signed-off-by: Cameron Diver <cameron@balena.io>

src/api-binder.coffee

@@ -57,9 +57,9 @@ module.exports = class APIBinder
 		@readyForUpdates = false
 
 	healthcheck: =>
-		@config.getMany([ 'appUpdatePollInterval', 'offlineMode', 'connectivityCheckEnabled' ])
+		@config.getMany([ 'appUpdatePollInterval', 'unmanaged', 'connectivityCheckEnabled' ])
 		.then (conf) =>
-			if conf.offlineMode
+			if conf.unmanaged
 				return true
 			timeSinceLastFetch = process.hrtime(@lastTargetStateFetch)
 			timeSinceLastFetchMs = timeSinceLastFetch[0] * 1000 + timeSinceLastFetch[1] / 1e6
@@ -72,9 +72,9 @@ module.exports = class APIBinder
 			release()
 
 	initClient: =>
-		@config.getMany([ 'offlineMode', 'apiEndpoint', 'currentApiKey'  ])
-		.then ({ offlineMode, apiEndpoint, currentApiKey }) =>
-			if offlineMode
+		@config.getMany([ 'unmanaged', 'apiEndpoint', 'currentApiKey'  ])
+		.then ({ unmanaged, apiEndpoint, currentApiKey }) =>
+			if unmanaged
 				console.log('Offline Mode is set, skipping API client initialization')
 				return
 			baseUrl = url.resolve(apiEndpoint, '/v5/')
@@ -102,9 +102,9 @@ module.exports = class APIBinder
 				@loadBackupFromMigration(retryDelay)
 
 	start: =>
-		@config.getMany([ 'apiEndpoint', 'offlineMode', 'bootstrapRetryDelay' ])
-		.then ({ apiEndpoint, offlineMode, bootstrapRetryDelay }) =>
-			if offlineMode
+		@config.getMany([ 'apiEndpoint', 'unmanaged', 'bootstrapRetryDelay' ])
+		.then ({ apiEndpoint, unmanaged, bootstrapRetryDelay }) =>
+			if unmanaged
 				console.log('Offline Mode is set, skipping API binder initialization')
 				# If we are offline because there is no apiEndpoint, there's a chance
 				# we've went through a deprovision. We need to set the initialConfigReported
@@ -258,14 +258,14 @@ module.exports = class APIBinder
 
 	provisionDependentDevice: (device) =>
 		@config.getMany([
-			'offlineMode'
+			'unmanaged'
 			'provisioned'
 			'apiTimeout'
 			'userId'
 			'deviceId'
 		])
 		.then (conf) =>
-			if conf.offlineMode
+			if conf.unmanaged
 				throw new Error('Cannot provision dependent device in offline mode')
 			if !conf.provisioned
 				throw new Error('Device must be provisioned to provision a dependent device')
@@ -283,12 +283,12 @@ module.exports = class APIBinder
 
 	patchDevice: (id, updatedFields) =>
 		@config.getMany([
-			'offlineMode'
+			'unmanaged'
 			'provisioned'
 			'apiTimeout'
 		])
 		.then (conf) =>
-			if conf.offlineMode
+			if conf.unmanaged
 				throw new Error('Cannot update dependent device in offline mode')
 			if !conf.provisioned
 				throw new Error('Device must be provisioned to update a dependent device')

src/config/functions.ts

@@ -9,7 +9,6 @@ import supervisorVersion = require('../lib/supervisor-version');
 import * as constants from '../lib/constants';
 import * as osRelease from '../lib/os-release';
 import { ConfigValue } from '../lib/types';
-import { checkTruthy } from '../lib/validation';
 
 // A provider for schema entries with source 'func'
 type ConfigProviderFunctionGetter = () => Bluebird<any>;
@@ -47,17 +46,6 @@ export function createProviderFunctions(
 					});
 			},
 		},
-		offlineMode: {
-			get: () => {
-				return config
-					.getMany(['apiEndpoint', 'supervisorOfflineMode'])
-					.then(({ apiEndpoint, supervisorOfflineMode }) => {
-						return (
-							checkTruthy(supervisorOfflineMode as boolean) || !apiEndpoint
-						);
-					});
-			},
-		},
 		provisioned: {
 			get: () => {
 				return config

src/config/index.ts

@@ -46,13 +46,11 @@ class Config extends EventEmitter {
 			default: constants.defaultMixpanelToken,
 		},
 		bootstrapRetryDelay: { source: 'config.json', default: 30000 },
-		supervisorOfflineMode: { source: 'config.json', default: false },
 		hostname: { source: 'config.json', mutable: true },
 		persistentLogging: { source: 'config.json', default: false, mutable: true },
 
 		version: { source: 'func' },
 		currentApiKey: { source: 'func' },
-		offlineMode: { source: 'func' },
 		provisioned: { source: 'func' },
 		osVersion: { source: 'func' },
 		osVariant: { source: 'func' },
@@ -282,15 +280,15 @@ class Config extends EventEmitter {
 			'uuid',
 			'deviceApiKey',
 			'apiSecret',
-			'offlineMode',
-		]).then(({ uuid, deviceApiKey, apiSecret, offlineMode }) => {
+			'unmanaged',
+		]).then(({ uuid, deviceApiKey, apiSecret, unmanaged }) => {
 			// These fields need to be set regardless
 			if (uuid == null || apiSecret == null) {
 				uuid = uuid || this.newUniqueKey();
 				apiSecret = apiSecret || this.newUniqueKey();
 			}
 			return this.set({ uuid, apiSecret }).then(() => {
-				if (offlineMode) {
+				if (unmanaged) {
 					return;
 				}
 				if (!deviceApiKey) {

src/device-config.coffee

@@ -132,10 +132,10 @@ module.exports = class DeviceConfig
 		target = _.clone(targetState.local?.config ? {})
 		steps = []
 		Promise.all [
-			@config.getMany([ 'deviceType', 'offlineMode' ])
+			@config.getMany([ 'deviceType', 'unmanaged' ])
 			@getConfigBackend()
 		]
-		.then ([{ deviceType, offlineMode }, configBackend ]) =>
+		.then ([{ deviceType, unmanaged }, configBackend ]) =>
 			configChanges = {}
 			humanReadableConfigChanges = {}
 			match = {
@@ -163,7 +163,7 @@ module.exports = class DeviceConfig
 				return
 
 			# Check if we need to perform special case actions for the VPN
-			if !checkTruthy(offlineMode) &&
+			if !checkTruthy(unmanaged) &&
 				!_.isEmpty(target['SUPERVISOR_VPN_CONTROL']) &&
 					@checkBoolChanged(current, target, 'SUPERVISOR_VPN_CONTROL')
 						steps.push({

src/device-state.coffee

@@ -140,12 +140,12 @@ module.exports = class DeviceState extends EventEmitter
 		@applications.on('change', @reportCurrentState)
 
 	healthcheck: =>
-		@config.getMany([ 'appUpdatePollInterval', 'offlineMode' ])
+		@config.getMany([ 'appUpdatePollInterval', 'unmanaged' ])
 		.then (conf) =>
 			cycleTime = process.hrtime(@lastApplyStart)
 			cycleTimeMs = cycleTime[0] * 1000 + cycleTime[1] / 1e6
 			cycleTimeWithinInterval = cycleTimeMs - @applications.timeSpentFetching < 2 * conf.appUpdatePollInterval
-			applyTargetHealthy = conf.offlineMode or !@applyInProgress or @applications.fetchesInProgress > 0 or cycleTimeWithinInterval
+			applyTargetHealthy = conf.unmanaged or !@applyInProgress or @applications.fetchesInProgress > 0 or cycleTimeWithinInterval
 			return applyTargetHealthy
 
 	migrateLegacyApps: (balenaApi) =>
@@ -255,7 +255,7 @@ module.exports = class DeviceState extends EventEmitter
 		@config.getMany([
 			'initialConfigSaved', 'listenPort', 'apiSecret', 'osVersion', 'osVariant',
 			'version', 'provisioned', 'apiEndpoint', 'connectivityCheckEnabled', 'legacyAppsPresent',
-			'targetStateSet', 'offlineMode'
+			'targetStateSet', 'unmanaged'
 		])
 		.then (conf) =>
 			@applications.init()
@@ -297,8 +297,8 @@ module.exports = class DeviceState extends EventEmitter
 			.then =>
 				@triggerApplyTarget({ initial: true })
 
-	initNetworkChecks: ({ apiEndpoint, connectivityCheckEnabled, offlineMode }) =>
-		return if validation.checkTruthy(offlineMode)
+	initNetworkChecks: ({ apiEndpoint, connectivityCheckEnabled, unmanaged }) =>
+		return if validation.checkTruthy(unmanaged)
 		network.startConnectivityCheck apiEndpoint, connectivityCheckEnabled, (connected) =>
 			@connected = connected
 		@config.on 'change', (changedConfig) ->

src/event-tracker.ts

@@ -11,7 +11,7 @@ export type EventTrackProperties = Dictionary<any>;
 
 interface InitArgs {
 	uuid: string;
-	offlineMode: boolean;
+	unmanaged: boolean;
 	mixpanelHost: { host: string; path: string } | null;
 	mixpanelToken: string;
 }
@@ -41,7 +41,7 @@ export class EventTracker {
 	}
 
 	public init({
-		offlineMode,
+		unmanaged,
 		mixpanelHost,
 		mixpanelToken,
 		uuid,
@@ -52,7 +52,7 @@ export class EventTracker {
 				uuid,
 				supervisorVersion,
 			};
-			if (offlineMode || mixpanelHost == null) {
+			if (unmanaged || mixpanelHost == null) {
 				return;
 			}
 			this.client = Mixpanel.init(mixpanelToken, {

src/logger.ts

@@ -17,7 +17,7 @@ interface LoggerSetupOptions {
 	apiEndpoint: string;
 	uuid: string;
 	deviceApiKey: string;
-	offlineMode: boolean;
+	unmanaged: boolean;
 	enableLogs: boolean;
 	localMode: boolean;
 }
@@ -59,7 +59,7 @@ export class Logger {
 		apiEndpoint,
 		uuid,
 		deviceApiKey,
-		offlineMode,
+		unmanaged,
 		enableLogs,
 		localMode,
 	}: LoggerSetupOptions) {
@@ -68,7 +68,7 @@ export class Logger {
 
 		this.backend = localMode ? this.localBackend : this.balenaBackend;
 
-		this.backend.offlineMode = offlineMode;
+		this.backend.unmanaged = unmanaged;
 		this.backend.publishEnabled = enableLogs;
 	}
 

src/logging-backends/balena-backend.ts

@@ -70,7 +70,7 @@ export class BalenaLogBackend extends LogBackend {
 	}
 
 	public log(message: LogMessage) {
-		if (this.offlineMode || !this.publishEnabled) {
+		if (this.unmanaged || !this.publishEnabled) {
 			return;
 		}
 

src/logging-backends/log-backend.ts

@@ -1,7 +1,7 @@
 export type LogMessage = Dictionary<any>;
 
 export abstract class LogBackend {
-	public offlineMode: boolean;
+	public unmanaged: boolean;
 	public publishEnabled: boolean = true;
 
 	public abstract log(message: LogMessage): void;

src/supervisor.coffee

@@ -17,7 +17,7 @@ startupConfigFields = [
 	'apiEndpoint'
 	'apiSecret'
 	'apiTimeout'
-	'offlineMode'
+	'unmanaged'
 	'deviceApiKey'
 	'mixpanelToken'
 	'mixpanelHost'
@@ -57,7 +57,7 @@ module.exports = class Supervisor extends EventEmitter
 					apiEndpoint: conf.apiEndpoint,
 					uuid: conf.uuid,
 					deviceApiKey: conf.deviceApiKey,
-					offlineMode: checkTruthy(conf.offlineMode),
+					unmanaged: checkTruthy(conf.unmanaged),
 					enableLogs: checkTruthy(conf.loggingEnabled),
 					localMode: checkTruthy(conf.localMode)
 				})

test/09-event-tracker.spec.coffee

@@ -25,7 +25,7 @@ describe 'EventTracker', ->
 
 	it 'initializes in offline mode', ->
 		promise = @eventTrackerOffline.init({
-			offlineMode: true
+			unmanaged: true
 			uuid: 'foobar'
 			mixpanelHost: { host: '', path: '' }
 		})

test/11-api-binder.spec.coffee

@@ -140,7 +140,7 @@ describe 'APIBinder', ->
 			initModels.call(this, '/config-apibinder-offline.json')
 
 		it 'does not generate a key if the device is in offline mode', ->
-			@config.get('offlineMode').then (mode) =>
+			@config.get('unmanaged').then (mode) =>
 				# Ensure offline mode is set
 				expect(mode).to.equal(true)
 				# Check that there is no deviceApiKey
@@ -153,7 +153,7 @@ describe 'APIBinder', ->
 				initModels.call(this, '/config-apibinder-offline2.json')
 
 			it 'does not generate a key with the minimal config', ->
-				@config.get('offlineMode').then (mode) =>
+				@config.get('unmanaged').then (mode) =>
 					expect(mode).to.equal(true)
 					@config.getMany([ 'deviceApiKey', 'uuid' ]).then (conf) ->
 						expect(conf['deviceApiKey']).to.be.empty

test/12-logger.spec.coffee

@@ -31,7 +31,7 @@ describe 'Logger', ->
 			apiEndpoint: 'https://example.com'
 			uuid: 'deadbeef'
 			deviceApiKey: 'secretkey'
-			offlineMode: false
+			unmanaged: false
 			enableLogs: true
 			localMode: false
 		})

test/data/testconfig-apibinder-offline.json

@@ -1 +1,16 @@
-{"applicationName":"supertestrpi3","applicationId":78373,"deviceType":"raspberrypi3","userId":1001,"username":"someone","appUpdatePollInterval":3000,"listenPort":2345,"vpnPort":443,"apiEndpoint":"http://0.0.0.0:3000","vpnEndpoint":"vpn.resin.io","registryEndpoint":"registry2.resin.io","deltaEndpoint":"https://delta.resin.io","mixpanelToken":"baz","apiKey":"boo","version":"2.0.6+rev3.prod","supervisorOfflineMode":true}
+{
+	"applicationName": "supertestrpi3",
+	"applicationId": 78373,
+	"deviceType": "raspberrypi3",
+	"userId": 1001,
+	"username": "someone",
+	"appUpdatePollInterval": 3000,
+	"listenPort": 2345,
+	"vpnPort": 443,
+	"vpnEndpoint": "vpn.resin.io",
+	"registryEndpoint": "registry2.resin.io",
+	"deltaEndpoint": "https://delta.resin.io",
+	"mixpanelToken": "baz",
+	"apiKey": "boo",
+	"version": "2.0.6+rev3.prod"
+}