diff --git a/.gitignore b/.gitignore index eb7c4a22..60274643 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ test/data/led_file report.xml .DS_Store .tsbuildinfo +.prettierrc diff --git a/src/application-manager.d.ts b/src/application-manager.d.ts index fd96afee..ee77c42d 100644 --- a/src/application-manager.d.ts +++ b/src/application-manager.d.ts @@ -7,15 +7,11 @@ import { ServiceAction } from './device-api/common'; import { DeviceStatus, InstancedAppState } from './types/state'; import type { Image } from './compose/images'; -import ServiceManager from './compose/service-manager'; import DeviceState from './device-state'; import { APIBinder } from './api-binder'; import * as config from './config'; -import NetworkManager from './compose/network-manager'; -import VolumeManager from './compose/volume-manager'; - import { CompositionStep, CompositionStepAction, @@ -48,10 +44,6 @@ class ApplicationManager extends EventEmitter { public deviceState: DeviceState; public apiBinder: APIBinder; - public services: ServiceManager; - public volumes: VolumeManager; - public networks: NetworkManager; - public proxyvisor: any; public timeSpentFetching: number; public fetchesInProgress: number; diff --git a/src/application-manager.js b/src/application-manager.js index 9ddd8321..25a97ec2 100644 --- a/src/application-manager.js +++ b/src/application-manager.js @@ -21,11 +21,11 @@ import { import * as dbFormat from './device-state/db-format'; -import { Network } from './compose/network'; -import { ServiceManager } from './compose/service-manager'; import * as Images from './compose/images'; -import { NetworkManager } from './compose/network-manager'; -import { VolumeManager } from './compose/volume-manager'; +import { Network } from './compose/network'; +import * as networkManager from './compose/network-manager'; +import * as volumeManager from './compose/volume-manager'; +import * as serviceManager from './compose/service-manager'; import * as compositionSteps from './compose/composition-steps'; import { Proxyvisor } from './proxyvisor'; @@ -159,9 +159,6 @@ export class ApplicationManager extends EventEmitter { this.deviceState = deviceState; this.apiBinder = apiBinder; - this.services = new ServiceManager(); - this.networks = new NetworkManager(); - this.volumes = new VolumeManager(); this.proxyvisor = new Proxyvisor({ applications: this, }); @@ -173,9 +170,6 @@ export class ApplicationManager extends EventEmitter { this.actionExecutors = compositionSteps.getExecutors({ lockFn: this._lockingIfNecessary, - services: this.services, - networks: this.networks, - volumes: this.volumes, applications: this, callbacks: { containerStarted: (id) => { @@ -202,7 +196,7 @@ export class ApplicationManager extends EventEmitter { ); this.router = createApplicationManagerRouter(this); Images.on('change', this.reportCurrentState); - this.services.on('change', this.reportCurrentState); + serviceManager.on('change', this.reportCurrentState); } reportCurrentState(data) { @@ -227,14 +221,14 @@ export class ApplicationManager extends EventEmitter { // But also run it in on startup await cleanup(); await this.localModeManager.init(); - await this.services.attachToRunning(); - await this.services.listenToEvents(); + await serviceManager.attachToRunning(); + await serviceManager.listenToEvents(); } // Returns the status of applications and their services getStatus() { return Promise.join( - this.services.getStatus(), + serviceManager.getStatus(), Images.getStatus(), config.get('currentCommit'), function (services, images, currentCommit) { @@ -366,9 +360,9 @@ export class ApplicationManager extends EventEmitter { getCurrentForComparison() { return Promise.join( - this.services.getAll(), - this.networks.getAll(), - this.volumes.getAll(), + serviceManager.getAll(), + networkManager.getAll(), + volumeManager.getAll(), config.get('currentCommit'), this._buildApps, ); @@ -376,9 +370,9 @@ export class ApplicationManager extends EventEmitter { getCurrentApp(appId) { return Promise.join( - this.services.getAllByAppId(appId), - this.networks.getAllByAppId(appId), - this.volumes.getAllByAppId(appId), + serviceManager.getAllByAppId(appId), + networkManager.getAllByAppId(appId), + volumeManager.getAllByAppId(appId), config.get('currentCommit'), this._buildApps, ).get(appId); @@ -515,14 +509,14 @@ export class ApplicationManager extends EventEmitter { } compareNetworksForUpdate({ current, target }) { - return this._compareNetworksOrVolumesForUpdate(this.networks, { + return this._compareNetworksOrVolumesForUpdate(networkManager, { current, target, }); } compareVolumesForUpdate({ current, target }) { - return this._compareNetworksOrVolumesForUpdate(this.volumes, { + return this._compareNetworksOrVolumesForUpdate(volumeManager, { current, target, }); @@ -1343,13 +1337,13 @@ export class ApplicationManager extends EventEmitter { } stopAll({ force = false, skipLock = false } = {}) { - return Promise.resolve(this.services.getAll()) + return Promise.resolve(serviceManager.getAll()) .map((service) => { return this._lockingIfNecessary( service.appId, { force, skipLock }, () => { - return this.services + return serviceManager .kill(service, { removeContainer: false, wait: true }) .then(() => { delete this._containerStarted[service.containerId]; @@ -1395,7 +1389,7 @@ export class ApplicationManager extends EventEmitter { if (intId == null) { throw new Error(`Invalid id: ${id}`); } - containerIdsByAppId[intId] = this.services.getContainerIdMap(intId); + containerIdsByAppId[intId] = serviceManager.getContainerIdMap(intId); }); return config.get('localMode').then((localMode) => { @@ -1403,7 +1397,7 @@ export class ApplicationManager extends EventEmitter { cleanupNeeded: Images.isCleanupNeeded(), availableImages: Images.getAvailable(), downloading: Images.getDownloadingImageIds(), - supervisorNetworkReady: this.networks.supervisorNetworkReady(), + supervisorNetworkReady: networkManager.supervisorNetworkReady(), delta: config.get('delta'), containerIds: Promise.props(containerIdsByAppId), localMode, @@ -1480,7 +1474,7 @@ export class ApplicationManager extends EventEmitter { } removeAllVolumesForApp(appId) { - return this.volumes.getAllByAppId(appId).then((volumes) => + return volumeManager.getAllByAppId(appId).then((volumes) => volumes.map((v) => ({ action: 'removeVolume', current: v, diff --git a/src/compose/composition-steps.ts b/src/compose/composition-steps.ts index 4514e57f..d20d86f8 100644 --- a/src/compose/composition-steps.ts +++ b/src/compose/composition-steps.ts @@ -7,12 +7,12 @@ import type { Image } from './images'; import * as images from './images'; import Network from './network'; import Service from './service'; -import ServiceManager from './service-manager'; +import * as serviceManager from './service-manager'; import Volume from './volume'; import { checkTruthy } from '../lib/validation'; -import { NetworkManager } from './network-manager'; -import VolumeManager from './volume-manager'; +import * as networkManager from './network-manager'; +import * as volumeManager from './volume-manager'; interface BaseCompositionStepArgs { force?: boolean; @@ -136,9 +136,6 @@ interface CompositionCallbacks { export function getExecutors(app: { lockFn: LockingFn; - services: ServiceManager; - networks: NetworkManager; - volumes: VolumeManager; applications: ApplicationManager; callbacks: CompositionCallbacks; }) { @@ -152,7 +149,7 @@ export function getExecutors(app: { }, async () => { const wait = _.get(step, ['options', 'wait'], false); - await app.services.kill(step.current, { + await serviceManager.kill(step.current, { removeContainer: false, wait, }); @@ -168,7 +165,7 @@ export function getExecutors(app: { skipLock: step.skipLock || _.get(step, ['options', 'skipLock']), }, async () => { - await app.services.kill(step.current); + await serviceManager.kill(step.current); app.callbacks.containerKilled(step.current.containerId); if (_.get(step, ['options', 'removeImage'])) { await images.removeByDockerId(step.current.config.image); @@ -179,7 +176,7 @@ export function getExecutors(app: { remove: async (step) => { // Only called for dead containers, so no need to // take locks - await app.services.remove(step.current); + await serviceManager.remove(step.current); }, updateMetadata: (step) => { const skipLock = @@ -192,7 +189,7 @@ export function getExecutors(app: { skipLock: skipLock || _.get(step, ['options', 'skipLock']), }, async () => { - await app.services.updateMetadata(step.current, step.target); + await serviceManager.updateMetadata(step.current, step.target); }, ); }, @@ -204,9 +201,9 @@ export function getExecutors(app: { skipLock: step.skipLock || _.get(step, ['options', 'skipLock']), }, async () => { - await app.services.kill(step.current, { wait: true }); + await serviceManager.kill(step.current, { wait: true }); app.callbacks.containerKilled(step.current.containerId); - const container = await app.services.start(step.target); + const container = await serviceManager.start(step.target); app.callbacks.containerStarted(container.id); }, ); @@ -218,7 +215,7 @@ export function getExecutors(app: { }); }, start: async (step) => { - const container = await app.services.start(step.target); + const container = await serviceManager.start(step.target); app.callbacks.containerStarted(container.id); }, updateCommit: async (step) => { @@ -232,7 +229,7 @@ export function getExecutors(app: { skipLock: step.skipLock || _.get(step, ['options', 'skipLock']), }, async () => { - await app.services.handover(step.current, step.target); + await serviceManager.handover(step.current, step.target); }, ); }, @@ -281,19 +278,19 @@ export function getExecutors(app: { } }, createNetwork: async (step) => { - await app.networks.create(step.target); + await networkManager.create(step.target); }, createVolume: async (step) => { - await app.volumes.create(step.target); + await volumeManager.create(step.target); }, removeNetwork: async (step) => { - await app.networks.remove(step.current); + await networkManager.remove(step.current); }, removeVolume: async (step) => { - await app.volumes.remove(step.current); + await volumeManager.remove(step.current); }, ensureSupervisorNetwork: async () => { - app.networks.ensureSupervisorNetwork(); + networkManager.ensureSupervisorNetwork(); }, }; diff --git a/src/compose/network-manager.ts b/src/compose/network-manager.ts index b5fe3c45..3fa52988 100644 --- a/src/compose/network-manager.ts +++ b/src/compose/network-manager.ts @@ -12,150 +12,147 @@ import { Network } from './network'; import log from '../lib/supervisor-console'; import { ResourceRecreationAttemptError } from './errors'; -export class NetworkManager { - public getAll(): Bluebird { - return this.getWithBothLabels().map((network: { Name: string }) => { - return docker - .getNetwork(network.Name) - .inspect() - .then((net) => { - return Network.fromDockerNetwork(net); - }); - }); - } - - public getAllByAppId(appId: number): Bluebird { - return this.getAll().filter((network: Network) => network.appId === appId); - } - - public async get(network: { name: string; appId: number }): Promise { - const dockerNet = await docker - .getNetwork(Network.generateDockerName(network.appId, network.name)) - .inspect(); - return Network.fromDockerNetwork(dockerNet); - } - - public async create(network: Network) { - try { - const existing = await this.get({ - name: network.name, - appId: network.appId, - }); - if (!network.isEqualConfig(existing)) { - throw new ResourceRecreationAttemptError('network', network.name); - } - - // We have a network with the same config and name - // already created, we can skip this - } catch (e) { - if (!NotFoundError(e)) { - logger.logSystemEvent(logTypes.createNetworkError, { - network: { name: network.name, appId: network.appId }, - error: e, - }); - throw e; - } - - // If we got a not found error, create the network - await network.create(); - } - } - - public async remove(network: Network) { - // We simply forward this to the network object, but we - // add this method to provide a consistent interface - await network.remove(); - } - - public supervisorNetworkReady(): Bluebird { - return Bluebird.resolve( - fs.stat(`/sys/class/net/${constants.supervisorNetworkInterface}`), - ) - .then(() => { - return docker - .getNetwork(constants.supervisorNetworkInterface) - .inspect(); - }) - .then((network) => { - return ( - network.Options['com.docker.network.bridge.name'] === - constants.supervisorNetworkInterface && - network.IPAM.Config[0].Subnet === constants.supervisorNetworkSubnet && - network.IPAM.Config[0].Gateway === constants.supervisorNetworkGateway - ); - }) - .catchReturn(NotFoundError, false) - .catchReturn(ENOENT, false); - } - - public ensureSupervisorNetwork(): Bluebird { - const removeIt = () => { - return Bluebird.resolve( - docker.getNetwork(constants.supervisorNetworkInterface).remove(), - ).then(() => { - return docker - .getNetwork(constants.supervisorNetworkInterface) - .inspect(); - }); - }; - - return Bluebird.resolve( - docker.getNetwork(constants.supervisorNetworkInterface).inspect(), - ) +export function getAll(): Bluebird { + return getWithBothLabels().map((network: { Name: string }) => { + return docker + .getNetwork(network.Name) + .inspect() .then((net) => { - if ( - net.Options['com.docker.network.bridge.name'] !== - constants.supervisorNetworkInterface || - net.IPAM.Config[0].Subnet !== constants.supervisorNetworkSubnet || - net.IPAM.Config[0].Gateway !== constants.supervisorNetworkGateway - ) { - return removeIt(); - } else { - return Bluebird.resolve( - fs.stat(`/sys/class/net/${constants.supervisorNetworkInterface}`), - ) - .catch(ENOENT, removeIt) - .return(); - } - }) - .catch(NotFoundError, () => { - log.debug(`Creating ${constants.supervisorNetworkInterface} network`); - return Bluebird.resolve( - docker.createNetwork({ - Name: constants.supervisorNetworkInterface, - Options: { - 'com.docker.network.bridge.name': - constants.supervisorNetworkInterface, - }, - IPAM: { - Driver: 'default', - Config: [ - { - Subnet: constants.supervisorNetworkSubnet, - Gateway: constants.supervisorNetworkGateway, - }, - ], - }, - }), - ); + return Network.fromDockerNetwork(net); }); - } + }); +} - private getWithBothLabels() { - return Bluebird.join( - docker.listNetworks({ - filters: { - label: ['io.resin.supervised'], - }, - }), - docker.listNetworks({ - filters: { - label: ['io.balena.supervised'], - }, - }), - (legacyNetworks, currentNetworks) => { - return _.unionBy(currentNetworks, legacyNetworks, 'Id'); - }, - ); +export function getAllByAppId(appId: number): Bluebird { + return getAll().filter((network: Network) => network.appId === appId); +} + +export async function get(network: { + name: string; + appId: number; +}): Promise { + const dockerNet = await docker + .getNetwork(Network.generateDockerName(network.appId, network.name)) + .inspect(); + return Network.fromDockerNetwork(dockerNet); +} + +export async function create(network: Network) { + try { + const existing = await get({ + name: network.name, + appId: network.appId, + }); + if (!network.isEqualConfig(existing)) { + throw new ResourceRecreationAttemptError('network', network.name); + } + + // We have a network with the same config and name + // already created, we can skip this + } catch (e) { + if (!NotFoundError(e)) { + logger.logSystemEvent(logTypes.createNetworkError, { + network: { name: network.name, appId: network.appId }, + error: e, + }); + throw e; + } + + // If we got a not found error, create the network + await network.create(); } } + +export async function remove(network: Network) { + // We simply forward this to the network object, but we + // add this method to provide a consistent interface + await network.remove(); +} + +export function supervisorNetworkReady(): Bluebird { + return Bluebird.resolve( + fs.stat(`/sys/class/net/${constants.supervisorNetworkInterface}`), + ) + .then(() => { + return docker.getNetwork(constants.supervisorNetworkInterface).inspect(); + }) + .then((network) => { + return ( + network.Options['com.docker.network.bridge.name'] === + constants.supervisorNetworkInterface && + network.IPAM.Config[0].Subnet === constants.supervisorNetworkSubnet && + network.IPAM.Config[0].Gateway === constants.supervisorNetworkGateway + ); + }) + .catchReturn(NotFoundError, false) + .catchReturn(ENOENT, false); +} + +export function ensureSupervisorNetwork(): Bluebird { + const removeIt = () => { + return Bluebird.resolve( + docker.getNetwork(constants.supervisorNetworkInterface).remove(), + ).then(() => { + return docker.getNetwork(constants.supervisorNetworkInterface).inspect(); + }); + }; + + return Bluebird.resolve( + docker.getNetwork(constants.supervisorNetworkInterface).inspect(), + ) + .then((net) => { + if ( + net.Options['com.docker.network.bridge.name'] !== + constants.supervisorNetworkInterface || + net.IPAM.Config[0].Subnet !== constants.supervisorNetworkSubnet || + net.IPAM.Config[0].Gateway !== constants.supervisorNetworkGateway + ) { + return removeIt(); + } else { + return Bluebird.resolve( + fs.stat(`/sys/class/net/${constants.supervisorNetworkInterface}`), + ) + .catch(ENOENT, removeIt) + .return(); + } + }) + .catch(NotFoundError, () => { + log.debug(`Creating ${constants.supervisorNetworkInterface} network`); + return Bluebird.resolve( + docker.createNetwork({ + Name: constants.supervisorNetworkInterface, + Options: { + 'com.docker.network.bridge.name': + constants.supervisorNetworkInterface, + }, + IPAM: { + Driver: 'default', + Config: [ + { + Subnet: constants.supervisorNetworkSubnet, + Gateway: constants.supervisorNetworkGateway, + }, + ], + }, + }), + ); + }); +} + +function getWithBothLabels() { + return Bluebird.join( + docker.listNetworks({ + filters: { + label: ['io.resin.supervised'], + }, + }), + docker.listNetworks({ + filters: { + label: ['io.balena.supervised'], + }, + }), + (legacyNetworks, currentNetworks) => { + return _.unionBy(currentNetworks, legacyNetworks, 'Id'); + }, + ); +} diff --git a/src/compose/service-manager.ts b/src/compose/service-manager.ts index 814fd452..4784cce1 100644 --- a/src/compose/service-manager.ts +++ b/src/compose/service-manager.ts @@ -32,322 +32,428 @@ type ServiceManagerEventEmitter = StrictEventEmitter< EventEmitter, ServiceManagerEvents >; +const events: ServiceManagerEventEmitter = new EventEmitter(); interface KillOpts { removeContainer?: boolean; wait?: boolean; } -export class ServiceManager extends (EventEmitter as new () => ServiceManagerEventEmitter) { - // Whether a container has died, indexed by ID - private containerHasDied: Dictionary = {}; - private listening = false; - // Volatile state of containers, indexed by containerId (or random strings if - // we don't yet have an id) - private volatileState: Dictionary> = {}; +export const on: typeof events['on'] = events.on.bind(events); +export const once: typeof events['once'] = events.once.bind(events); +export const removeListener: typeof events['removeListener'] = events.removeListener.bind( + events, +); +export const removeAllListeners: typeof events['removeAllListeners'] = events.removeAllListeners.bind( + events, +); - public constructor() { - super(); - } +// Whether a container has died, indexed by ID +const containerHasDied: Dictionary = {}; +let listening = false; +// Volatile state of containers, indexed by containerId (or random strings if +// we don't yet have an id) +const volatileState: Dictionary> = {}; - public async getAll( - extraLabelFilters: string | string[] = [], - ): Promise { - const filterLabels = ['supervised'].concat(extraLabelFilters); - const containers = await this.listWithBothLabels(filterLabels); +export async function getAll( + extraLabelFilters: string | string[] = [], +): Promise { + const filterLabels = ['supervised'].concat(extraLabelFilters); + const containers = await listWithBothLabels(filterLabels); - const services = await Bluebird.map(containers, async (container) => { - try { - const serviceInspect = await docker - .getContainer(container.Id) - .inspect(); - const service = Service.fromDockerContainer(serviceInspect); - // We know that the containerId is set below, because `fromDockerContainer` - // always sets it - const vState = this.volatileState[service.containerId!]; - if (vState != null && vState.status != null) { - service.status = vState.status; - } - return service; - } catch (e) { - if (NotFoundError(e)) { - return null; - } - throw e; + const services = await Bluebird.map(containers, async (container) => { + try { + const serviceInspect = await docker.getContainer(container.Id).inspect(); + const service = Service.fromDockerContainer(serviceInspect); + // We know that the containerId is set below, because `fromDockerContainer` + // always sets it + const vState = volatileState[service.containerId!]; + if (vState != null && vState.status != null) { + service.status = vState.status; + } + return service; + } catch (e) { + if (NotFoundError(e)) { + return null; } - }); - - return services.filter((s) => s != null) as Service[]; - } - - public async get(service: Service) { - // Get the container ids for special network handling - const containerIds = await this.getContainerIdMap(service.appId!); - const services = ( - await this.getAll(`service-id=${service.serviceId}`) - ).filter((currentService) => - currentService.isEqualConfig(service, containerIds), - ); - - if (services.length === 0) { - const e: StatusCodeError = new Error( - 'Could not find a container matching this service definition', - ); - e.statusCode = 404; throw e; } - return services[0]; - } + }); - public async getStatus() { - const services = await this.getAll(); - const status = _.clone(this.volatileState); + return services.filter((s) => s != null) as Service[]; +} - for (const service of services) { - if (service.containerId == null) { - throw new InternalInconsistencyError( - `containerId not defined in ServiceManager.getStatus: ${service}`, - ); - } - if (status[service.containerId] == null) { - status[service.containerId] = _.pick(service, [ - 'appId', - 'imageId', - 'status', - 'releaseId', - 'commit', - 'createdAt', - 'serviceName', - ]) as Partial; - } - } +export async function get(service: Service) { + // Get the container ids for special network handling + const containerIds = await getContainerIdMap(service.appId!); + const services = ( + await getAll(`service-id=${service.serviceId}`) + ).filter((currentService) => + currentService.isEqualConfig(service, containerIds), + ); - return _.values(status); - } - - public async getByDockerContainerId( - containerId: string, - ): Promise { - const container = await docker.getContainer(containerId).inspect(); - if ( - container.Config.Labels['io.balena.supervised'] == null && - container.Config.Labels['io.resin.supervised'] == null - ) { - return null; - } - return Service.fromDockerContainer(container); - } - - public async updateMetadata( - service: Service, - metadata: { imageId: number; releaseId: number }, - ) { - const svc = await this.get(service); - if (svc.containerId == null) { - throw new InternalInconsistencyError( - `No containerId provided for service ${service.serviceName} in ServiceManager.updateMetadata. Service: ${service}`, - ); - } - - await docker.getContainer(svc.containerId).rename({ - name: `${service.serviceName}_${metadata.imageId}_${metadata.releaseId}`, - }); - } - - public async handover(current: Service, target: Service) { - // We set the running container to not restart so that in case of a poweroff - // it doesn't come back after boot. - await this.prepareForHandover(current); - await this.start(target); - await this.waitToKill( - current, - target.config.labels['io.balena.update.handover-timeout'], + if (services.length === 0) { + const e: StatusCodeError = new Error( + 'Could not find a container matching this service definition', ); - await this.kill(current); + e.statusCode = 404; + throw e; } + return services[0]; +} - public async killAllLegacy(): Promise { - // Containers haven't been normalized (this is an updated supervisor) - // so we need to stop and remove them - const supervisorImageId = ( - await docker.getImage(constants.supervisorImage).inspect() - ).Id; +export async function getStatus() { + const services = await getAll(); + const status = _.clone(volatileState); - for (const container of await docker.listContainers({ all: true })) { - if (container.ImageID !== supervisorImageId) { - await this.killContainer(container.Id, { - serviceName: 'legacy', - }); - } - } - } - - public kill(service: Service, opts: KillOpts = {}) { + for (const service of services) { if (service.containerId == null) { throw new InternalInconsistencyError( - `Attempt to kill container without containerId! Service :${service}`, + `containerId not defined in ServiceManager.getStatus: ${service}`, ); } - return this.killContainer(service.containerId, service, opts); + if (status[service.containerId] == null) { + status[service.containerId] = _.pick(service, [ + 'appId', + 'imageId', + 'status', + 'releaseId', + 'commit', + 'createdAt', + 'serviceName', + ]) as Partial; + } } - public async remove(service: Service) { - logger.logSystemEvent(LogTypes.removeDeadService, { service }); - const existingService = await this.get(service); + return _.values(status); +} - if (existingService.containerId == null) { +export async function getByDockerContainerId( + containerId: string, +): Promise { + const container = await docker.getContainer(containerId).inspect(); + if ( + container.Config.Labels['io.balena.supervised'] == null && + container.Config.Labels['io.resin.supervised'] == null + ) { + return null; + } + return Service.fromDockerContainer(container); +} + +export async function updateMetadata( + service: Service, + metadata: { imageId: number; releaseId: number }, +) { + const svc = await get(service); + if (svc.containerId == null) { + throw new InternalInconsistencyError( + `No containerId provided for service ${service.serviceName} in ServiceManager.updateMetadata. Service: ${service}`, + ); + } + + await docker.getContainer(svc.containerId).rename({ + name: `${service.serviceName}_${metadata.imageId}_${metadata.releaseId}`, + }); +} + +export async function handover(current: Service, target: Service) { + // We set the running container to not restart so that in case of a poweroff + // it doesn't come back after boot. + await prepareForHandover(current); + await start(target); + await waitToKill( + current, + target.config.labels['io.balena.update.handover-timeout'], + ); + await kill(current); +} + +export async function killAllLegacy(): Promise { + // Containers haven't been normalized (this is an updated supervisor) + const supervisorImageId = ( + await docker.getImage(constants.supervisorImage).inspect() + ).Id; + + for (const container of await docker.listContainers({ all: true })) { + if (container.ImageID !== supervisorImageId) { + await killContainer(container.Id, { + serviceName: 'legacy', + }); + } + } +} + +export function kill(service: Service, opts: KillOpts = {}) { + if (service.containerId == null) { + throw new InternalInconsistencyError( + `Attempt to kill container without containerId! Service :${service}`, + ); + } + return killContainer(service.containerId, service, opts); +} + +export async function remove(service: Service) { + logger.logSystemEvent(LogTypes.removeDeadService, { service }); + const existingService = await get(service); + + if (existingService.containerId == null) { + throw new InternalInconsistencyError( + `No containerId provided for service ${service.serviceName} in ServiceManager.updateMetadata. Service: ${service}`, + ); + } + + try { + await docker.getContainer(existingService.containerId).remove({ v: true }); + } catch (e) { + if (!NotFoundError(e)) { + logger.logSystemEvent(LogTypes.removeDeadServiceError, { + service, + error: e, + }); + throw e; + } + } +} +export function getAllByAppId(appId: number) { + return getAll(`app-id=${appId}`); +} + +export async function stopAllByAppId(appId: number) { + for (const app of await getAllByAppId(appId)) { + await kill(app, { removeContainer: false }); + } +} + +export async function create(service: Service) { + const mockContainerId = config.newUniqueKey(); + try { + const existing = await get(service); + if (existing.containerId == null) { throw new InternalInconsistencyError( `No containerId provided for service ${service.serviceName} in ServiceManager.updateMetadata. Service: ${service}`, ); } - - try { - await docker - .getContainer(existingService.containerId) - .remove({ v: true }); - } catch (e) { - if (!NotFoundError(e)) { - logger.logSystemEvent(LogTypes.removeDeadServiceError, { - service, - error: e, - }); - throw e; - } - } - } - public getAllByAppId(appId: number) { - return this.getAll(`app-id=${appId}`); - } - - public async stopAllByAppId(appId: number) { - for (const app of await this.getAllByAppId(appId)) { - await this.kill(app, { removeContainer: false }); - } - } - - public async create(service: Service) { - const mockContainerId = config.newUniqueKey(); - try { - const existing = await this.get(service); - if (existing.containerId == null) { - throw new InternalInconsistencyError( - `No containerId provided for service ${service.serviceName} in ServiceManager.updateMetadata. Service: ${service}`, - ); - } - return docker.getContainer(existing.containerId); - } catch (e) { - if (!NotFoundError(e)) { - logger.logSystemEvent(LogTypes.installServiceError, { - service, - error: e, - }); - throw e; - } - - const deviceName = await config.get('name'); - if (!isValidDeviceName(deviceName)) { - throw new Error( - 'The device name contains a newline, which is unsupported by balena. ' + - 'Please fix the device name', - ); - } - - // Get all created services so far - if (service.appId == null) { - throw new InternalInconsistencyError( - 'Attempt to start a service without an existing application ID', - ); - } - const serviceContainerIds = await this.getContainerIdMap(service.appId); - const conf = service.toDockerContainer({ - deviceName, - containerIds: serviceContainerIds, + return docker.getContainer(existing.containerId); + } catch (e) { + if (!NotFoundError(e)) { + logger.logSystemEvent(LogTypes.installServiceError, { + service, + error: e, }); - const nets = serviceNetworksToDockerNetworks( - service.extraNetworksToJoin(), + throw e; + } + + const deviceName = await config.get('name'); + if (!isValidDeviceName(deviceName)) { + throw new Error( + 'The device name contains a newline, which is unsupported by balena. ' + + 'Please fix the device name', ); + } - logger.logSystemEvent(LogTypes.installService, { service }); - this.reportNewStatus(mockContainerId, service, 'Installing'); - - const container = await docker.createContainer(conf); - service.containerId = container.id; - - await Promise.all( - _.map((nets || {}).EndpointsConfig, (endpointConfig, name) => - docker.getNetwork(name).connect({ - Container: container.id, - EndpointConfig: endpointConfig, - }), - ), + // Get all created services so far + if (service.appId == null) { + throw new InternalInconsistencyError( + 'Attempt to start a service without an existing application ID', ); + } + const serviceContainerIds = await getContainerIdMap(service.appId); + const conf = service.toDockerContainer({ + deviceName, + containerIds: serviceContainerIds, + }); + const nets = serviceNetworksToDockerNetworks(service.extraNetworksToJoin()); - logger.logSystemEvent(LogTypes.installServiceSuccess, { service }); - return container; + logger.logSystemEvent(LogTypes.installService, { service }); + reportNewStatus(mockContainerId, service, 'Installing'); + + const container = await docker.createContainer(conf); + service.containerId = container.id; + + await Promise.all( + _.map((nets || {}).EndpointsConfig, (endpointConfig, name) => + docker.getNetwork(name).connect({ + Container: container.id, + EndpointConfig: endpointConfig, + }), + ), + ); + + logger.logSystemEvent(LogTypes.installServiceSuccess, { service }); + return container; + } finally { + reportChange(mockContainerId); + } +} + +export async function start(service: Service) { + let alreadyStarted = false; + let containerId: string | null = null; + + try { + const container = await create(service); + containerId = container.id; + logger.logSystemEvent(LogTypes.startService, { service }); + + reportNewStatus(containerId, service, 'Starting'); + + let shouldRemove = false; + let err: Error | undefined; + try { + await container.start(); + } catch (e) { + // Get the statusCode from the original cause and make sure it's + // definitely an int for comparison reasons + const maybeStatusCode = PermissiveNumber.decode(e.statusCode); + if (isLeft(maybeStatusCode)) { + shouldRemove = true; + err = new Error(`Could not parse status code from docker error: ${e}`); + throw err; + } + const statusCode = maybeStatusCode.right; + const message = e.message; + + // 304 means the container was already started, precisely what we want + if (statusCode === 304) { + alreadyStarted = true; + } else if ( + statusCode === 500 && + _.isString(message) && + message.trim().match(/exec format error$/) + ) { + // Provide a friendlier error message for "exec format error" + const deviceType = await config.get('deviceType'); + err = new Error( + `Application architecture incompatible with ${deviceType}: exec format error`, + ); + throw err; + } else { + // rethrow the same error + err = e; + throw e; + } } finally { - this.reportChange(mockContainerId); + if (shouldRemove) { + // If starting the container fialed, we remove it so that it doesn't litter + await container.remove({ v: true }).catch(_.noop); + logger.logSystemEvent(LogTypes.startServiceError, { + service, + error: err, + }); + } + } + + const serviceId = service.serviceId; + const imageId = service.imageId; + if (serviceId == null || imageId == null) { + throw new InternalInconsistencyError( + `serviceId and imageId not defined for service: ${service.serviceName} in ServiceManager.start`, + ); + } + + logger.attach(container.id, { serviceId, imageId }); + + if (!alreadyStarted) { + logger.logSystemEvent(LogTypes.startServiceSuccess, { service }); + } + + service.config.running = true; + return container; + } finally { + if (containerId != null) { + reportChange(containerId); } } +} - public async start(service: Service) { - let alreadyStarted = false; - let containerId: string | null = null; +export function listenToEvents() { + if (listening) { + return; + } - try { - const container = await this.create(service); - containerId = container.id; - logger.logSystemEvent(LogTypes.startService, { service }); + listening = true; - this.reportNewStatus(containerId, service, 'Starting'); + const listen = async () => { + const stream = await docker.getEvents({ + filters: { type: ['container'] } as any, + }); - let remove = false; - let err: Error | undefined; - try { - await container.start(); - } catch (e) { - // Get the statusCode from the original cause and make sure it's - // definitely an int for comparison reasons - const maybeStatusCode = PermissiveNumber.decode(e.statusCode); - if (isLeft(maybeStatusCode)) { - remove = true; - err = new Error( - `Could not parse status code from docker error: ${e}`, - ); - throw err; - } - const statusCode = maybeStatusCode.right; - const message = e.message; + stream.on('error', (e) => { + log.error(`Error on docker events stream:`, e); + }); + const parser = JSONStream.parse(); + parser.on('data', async (data: { status: string; id: string }) => { + if (data != null) { + const status = data.status; + if (status === 'die' || status === 'start') { + try { + let service: Service | null = null; + try { + service = await getByDockerContainerId(data.id); + } catch (e) { + if (!NotFoundError(e)) { + throw e; + } + } + if (service != null) { + events.emit('change'); + if (status === 'die') { + logger.logSystemEvent(LogTypes.serviceExit, { service }); + containerHasDied[data.id] = true; + } else if (status === 'start' && containerHasDied[data.id]) { + delete containerHasDied[data.id]; + logger.logSystemEvent(LogTypes.serviceRestart, { + service, + }); - // 304 means the container was already started, precisely what we want - if (statusCode === 304) { - alreadyStarted = true; - } else if ( - statusCode === 500 && - _.isString(message) && - message.trim().match(/exec format error$/) - ) { - // Provide a friendlier error message for "exec format error" - const deviceType = await config.get('deviceType'); - err = new Error( - `Application architecture incompatible with ${deviceType}: exec format error`, - ); - throw err; - } else { - // rethrow the same error - err = e; - throw e; - } - } finally { - if (remove) { - // If starting the container fialed, we remove it so that it doesn't litter - await container.remove({ v: true }).catch(_.noop); - logger.logSystemEvent(LogTypes.startServiceError, { - service, - error: err, - }); + const serviceId = service.serviceId; + const imageId = service.imageId; + if (serviceId == null || imageId == null) { + throw new InternalInconsistencyError( + `serviceId and imageId not defined for service: ${service.serviceName} in ServiceManager.listenToEvents`, + ); + } + logger.attach(data.id, { + serviceId, + imageId, + }); + } + } + } catch (e) { + log.error('Error on docker event:', e, e.stack); + } } } + }); + return new Promise((resolve, reject) => { + parser + .on('error', (e: Error) => { + log.error('Error on docker events stream:', e); + reject(e); + }) + .on('end', resolve); + stream.pipe(parser); + }); + }; + + Bluebird.resolve(listen()) + .catch((e) => { + log.error('Error listening to events:', e, e.stack); + }) + .finally(() => { + listening = false; + setTimeout(listenToEvents, 1000); + }); + + return; +} + +export async function attachToRunning() { + const services = await getAll(); + for (const service of services) { + if (service.status === 'Running') { const serviceId = service.serviceId; const imageId = service.imageId; if (serviceId == null || imageId == null) { @@ -356,302 +462,187 @@ export class ServiceManager extends (EventEmitter as new () => ServiceManagerEve ); } - logger.attach(container.id, { serviceId, imageId }); - - if (!alreadyStarted) { - logger.logSystemEvent(LogTypes.startServiceSuccess, { service }); - } - - service.config.running = true; - return container; - } finally { - if (containerId != null) { - this.reportChange(containerId); + if (service.containerId == null) { + throw new InternalInconsistencyError( + `containerId not defined for service: ${service.serviceName} in ServiceManager.attachToRunning`, + ); } + logger.attach(service.containerId, { + serviceId, + imageId, + }); } } - - public listenToEvents() { - if (this.listening) { - return; - } - - this.listening = true; - - const listen = async () => { - const stream = await docker.getEvents({ - filters: { type: ['container'] } as any, - }); - - stream.on('error', (e) => { - log.error(`Error on docker events stream:`, e); - }); - const parser = JSONStream.parse(); - parser.on('data', async (data: { status: string; id: string }) => { - if (data != null) { - const status = data.status; - if (status === 'die' || status === 'start') { - try { - let service: Service | null = null; - try { - service = await this.getByDockerContainerId(data.id); - } catch (e) { - if (!NotFoundError(e)) { - throw e; - } - } - if (service != null) { - this.emit('change'); - if (status === 'die') { - logger.logSystemEvent(LogTypes.serviceExit, { service }); - this.containerHasDied[data.id] = true; - } else if ( - status === 'start' && - this.containerHasDied[data.id] - ) { - delete this.containerHasDied[data.id]; - logger.logSystemEvent(LogTypes.serviceRestart, { - service, - }); - - const serviceId = service.serviceId; - const imageId = service.imageId; - if (serviceId == null || imageId == null) { - throw new InternalInconsistencyError( - `serviceId and imageId not defined for service: ${service.serviceName} in ServiceManager.listenToEvents`, - ); - } - logger.attach(data.id, { - serviceId, - imageId, - }); - } - } - } catch (e) { - log.error('Error on docker event:', e, e.stack); - } - } - } - }); - - return new Promise((resolve, reject) => { - parser - .on('error', (e: Error) => { - log.error('Error on docker events stream:', e); - reject(e); - }) - .on('end', resolve); - stream.pipe(parser); - }); - }; - - Bluebird.resolve(listen()) - .catch((e) => { - log.error('Error listening to events:', e, e.stack); - }) - .finally(() => { - this.listening = false; - setTimeout(() => this.listenToEvents(), 1000); - }); - - return; - } - - public async attachToRunning() { - const services = await this.getAll(); - for (const service of services) { - if (service.status === 'Running') { - const serviceId = service.serviceId; - const imageId = service.imageId; - if (serviceId == null || imageId == null) { - throw new InternalInconsistencyError( - `serviceId and imageId not defined for service: ${service.serviceName} in ServiceManager.start`, - ); - } - - if (service.containerId == null) { - throw new InternalInconsistencyError( - `containerId not defined for service: ${service.serviceName} in ServiceManager.attachToRunning`, - ); - } - logger.attach(service.containerId, { - serviceId, - imageId, - }); - } - } - } - - public async getContainerIdMap(appId: number): Promise> { - return _(await this.getAllByAppId(appId)) - .keyBy('serviceName') - .mapValues('containerId') - .value() as Dictionary; - } - - private reportChange(containerId?: string, status?: Partial) { - if (containerId != null) { - if (status != null) { - this.volatileState[containerId] = {}; - _.merge(this.volatileState[containerId], status); - } else if (this.volatileState[containerId] != null) { - delete this.volatileState[containerId]; - } - } - this.emit('change'); - } - - private reportNewStatus( - containerId: string, - service: Partial, - status: string, - ) { - this.reportChange( - containerId, - _.merge( - { status }, - _.pick(service, ['imageId', 'appId', 'releaseId', 'commit']), - ), - ); - } - - private killContainer( - containerId: string, - service: Partial = {}, - { removeContainer = true, wait = false }: KillOpts = {}, - ): Bluebird { - // To maintain compatibility of the `wait` flag, this function is not - // async, but it feels like whether or not the promise should be waited on - // should performed by the caller - // TODO: Remove the need for the wait flag - - return Bluebird.try(() => { - logger.logSystemEvent(LogTypes.stopService, { service }); - if (service.imageId != null) { - this.reportNewStatus(containerId, service, 'Stopping'); - } - - const containerObj = docker.getContainer(containerId); - const killPromise = Bluebird.resolve(containerObj.stop()) - .then(() => { - if (removeContainer) { - return containerObj.remove({ v: true }); - } - }) - .catch((e) => { - // Get the statusCode from the original cause and make sure it's - // definitely an int for comparison reasons - const maybeStatusCode = PermissiveNumber.decode(e.statusCode); - if (isLeft(maybeStatusCode)) { - throw new Error( - `Could not parse status code from docker error: ${e}`, - ); - } - const statusCode = maybeStatusCode.right; - - // 304 means the container was already stopped, so we can just remove it - if (statusCode === 304) { - logger.logSystemEvent(LogTypes.stopServiceNoop, { service }); - // Why do we attempt to remove the container again? - if (removeContainer) { - return containerObj.remove({ v: true }); - } - } else if (statusCode === 404) { - // 404 means the container doesn't exist, precisely what we want! - logger.logSystemEvent(LogTypes.stopRemoveServiceNoop, { - service, - }); - } else { - throw e; - } - }) - .tap(() => { - delete this.containerHasDied[containerId]; - logger.logSystemEvent(LogTypes.stopServiceSuccess, { service }); - }) - .catch((e) => { - logger.logSystemEvent(LogTypes.stopServiceError, { - service, - error: e, - }); - }) - .finally(() => { - if (service.imageId != null) { - this.reportChange(containerId); - } - }); - - if (wait) { - return killPromise; - } - return; - }); - } - - private async listWithBothLabels( - labelList: string[], - ): Promise { - const listWithPrefix = (prefix: string) => - docker.listContainers({ - all: true, - filters: { - label: _.map(labelList, (v) => `${prefix}${v}`), - }, - }); - - const [legacy, current] = await Promise.all([ - listWithPrefix('io.resin.'), - listWithPrefix('io.balena.'), - ]); - - return _.unionBy(legacy, current, 'Id'); - } - - private async prepareForHandover(service: Service) { - const svc = await this.get(service); - if (svc.containerId == null) { - throw new InternalInconsistencyError( - `No containerId provided for service ${service.serviceName} in ServiceManager.prepareForHandover. Service: ${service}`, - ); - } - const container = docker.getContainer(svc.containerId); - await container.update({ RestartPolicy: {} }); - return await container.rename({ - name: `old_${service.serviceName}_${service.imageId}_${service.imageId}_${service.releaseId}`, - }); - } - - private waitToKill(service: Service, timeout: number | string) { - const pollInterval = 100; - timeout = checkInt(timeout, { positive: true }) || 60000; - const deadline = Date.now() + timeout; - - const handoverCompletePaths = service.handoverCompleteFullPathsOnHost(); - - const wait = (): Bluebird => - Bluebird.any( - handoverCompletePaths.map((file) => - fs.stat(file).then(() => fs.unlink(file).catch(_.noop)), - ), - ).catch(async () => { - if (Date.now() < deadline) { - await Bluebird.delay(pollInterval); - return wait(); - } else { - log.info( - `Handover timeout has passed, assuming handover was completed for service ${service.serviceName}`, - ); - } - }); - - log.info( - `Waiting for handover to be completed for service: ${service.serviceName}`, - ); - - return wait().then(() => { - log.success(`Handover complete for service ${service.serviceName}`); - }); - } } -export default ServiceManager; +export async function getContainerIdMap( + appId: number, +): Promise> { + return _(await getAllByAppId(appId)) + .keyBy('serviceName') + .mapValues('containerId') + .value() as Dictionary; +} + +function reportChange(containerId?: string, status?: Partial) { + if (containerId != null) { + if (status != null) { + volatileState[containerId] = { ...status }; + } else if (volatileState[containerId] != null) { + delete volatileState[containerId]; + } + } + events.emit('change'); +} + +function reportNewStatus( + containerId: string, + service: Partial, + status: string, +) { + reportChange( + containerId, + _.merge( + { status }, + _.pick(service, ['imageId', 'appId', 'releaseId', 'commit']), + ), + ); +} + +function killContainer( + containerId: string, + service: Partial = {}, + { removeContainer = true, wait = false }: KillOpts = {}, +): Bluebird { + // To maintain compatibility of the `wait` flag, this function is not + // async, but it feels like whether or not the promise should be waited on + // should performed by the caller + // TODO: Remove the need for the wait flag + + return Bluebird.try(() => { + logger.logSystemEvent(LogTypes.stopService, { service }); + if (service.imageId != null) { + reportNewStatus(containerId, service, 'Stopping'); + } + + const containerObj = docker.getContainer(containerId); + const killPromise = Bluebird.resolve(containerObj.stop()) + .then(() => { + if (removeContainer) { + return containerObj.remove({ v: true }); + } + }) + .catch((e) => { + // Get the statusCode from the original cause and make sure it's + // definitely an int for comparison reasons + const maybeStatusCode = PermissiveNumber.decode(e.statusCode); + if (isLeft(maybeStatusCode)) { + throw new Error( + `Could not parse status code from docker error: ${e}`, + ); + } + const statusCode = maybeStatusCode.right; + + // 304 means the container was already stopped, so we can just remove it + if (statusCode === 304) { + logger.logSystemEvent(LogTypes.stopServiceNoop, { service }); + // Why do we attempt to remove the container again? + if (removeContainer) { + return containerObj.remove({ v: true }); + } + } else if (statusCode === 404) { + // 404 means the container doesn't exist, precisely what we want! + logger.logSystemEvent(LogTypes.stopRemoveServiceNoop, { + service, + }); + } else { + throw e; + } + }) + .tap(() => { + delete containerHasDied[containerId]; + logger.logSystemEvent(LogTypes.stopServiceSuccess, { service }); + }) + .catch((e) => { + logger.logSystemEvent(LogTypes.stopServiceError, { + service, + error: e, + }); + }) + .finally(() => { + if (service.imageId != null) { + reportChange(containerId); + } + }); + + if (wait) { + return killPromise; + } + return; + }); +} + +async function listWithBothLabels( + labelList: string[], +): Promise { + const listWithPrefix = (prefix: string) => + docker.listContainers({ + all: true, + filters: { + label: _.map(labelList, (v) => `${prefix}${v}`), + }, + }); + + const [legacy, current] = await Promise.all([ + listWithPrefix('io.resin.'), + listWithPrefix('io.balena.'), + ]); + + return _.unionBy(legacy, current, 'Id'); +} + +async function prepareForHandover(service: Service) { + const svc = await get(service); + if (svc.containerId == null) { + throw new InternalInconsistencyError( + `No containerId provided for service ${service.serviceName} in ServiceManager.prepareForHandover. Service: ${service}`, + ); + } + const container = docker.getContainer(svc.containerId); + await container.update({ RestartPolicy: {} }); + return await container.rename({ + name: `old_${service.serviceName}_${service.imageId}_${service.imageId}_${service.releaseId}`, + }); +} + +function waitToKill(service: Service, timeout: number | string) { + const pollInterval = 100; + timeout = checkInt(timeout, { positive: true }) || 60000; + const deadline = Date.now() + timeout; + + const handoverCompletePaths = service.handoverCompleteFullPathsOnHost(); + + const wait = (): Bluebird => + Bluebird.any( + handoverCompletePaths.map((file) => + fs.stat(file).then(() => fs.unlink(file).catch(_.noop)), + ), + ).catch(async () => { + if (Date.now() < deadline) { + await Bluebird.delay(pollInterval); + return wait(); + } else { + log.info( + `Handover timeout has passed, assuming handover was completed for service ${service.serviceName}`, + ); + } + }); + + log.info( + `Waiting for handover to be completed for service: ${service.serviceName}`, + ); + + return wait().then(() => { + log.success(`Handover complete for service ${service.serviceName}`); + }); +} diff --git a/src/compose/volume-manager.ts b/src/compose/volume-manager.ts index 8a3d88c4..a75ed59b 100644 --- a/src/compose/volume-manager.ts +++ b/src/compose/volume-manager.ts @@ -17,143 +17,139 @@ export interface VolumeNameOpts { appId: number; } -export class VolumeManager { - public async get({ name, appId }: VolumeNameOpts): Promise { - return Volume.fromDockerVolume( - await docker.getVolume(Volume.generateDockerName(appId, name)).inspect(), - ); - } +export async function get({ name, appId }: VolumeNameOpts): Promise { + return Volume.fromDockerVolume( + await docker.getVolume(Volume.generateDockerName(appId, name)).inspect(), + ); +} - public async getAll(): Promise { - const volumeInspect = await this.listWithBothLabels(); - return volumeInspect.map((inspect) => Volume.fromDockerVolume(inspect)); - } +export async function getAll(): Promise { + const volumeInspect = await listWithBothLabels(); + return volumeInspect.map((inspect) => Volume.fromDockerVolume(inspect)); +} - public async getAllByAppId(appId: number): Promise { - const all = await this.getAll(); - return _.filter(all, { appId }); - } +export async function getAllByAppId(appId: number): Promise { + const all = await getAll(); + return _.filter(all, { appId }); +} - public async create(volume: Volume): Promise { - // First we check that we're not trying to recreate a - // volume - try { - const existing = await this.get({ - name: volume.name, - appId: volume.appId, +export async function create(volume: Volume): Promise { + // First we check that we're not trying to recreate a + // volume + try { + const existing = await get({ + name: volume.name, + appId: volume.appId, + }); + + if (!volume.isEqualConfig(existing)) { + throw new ResourceRecreationAttemptError('volume', volume.name); + } + } catch (e) { + if (!NotFoundError(e)) { + logger.logSystemEvent(LogTypes.createVolumeError, { + volume: { name: volume.name }, + error: e, }); - - if (!volume.isEqualConfig(existing)) { - throw new ResourceRecreationAttemptError('volume', volume.name); - } - } catch (e) { - if (!NotFoundError(e)) { - logger.logSystemEvent(LogTypes.createVolumeError, { - volume: { name: volume.name }, - error: e, - }); - throw e; - } - - await volume.create(); + throw e; } - } - // We simply forward this to the volume object, but we - // add this method to provide a consistent interface - public async remove(volume: Volume) { - await volume.remove(); - } - - public async createFromLegacy(appId: number): Promise { - const name = defaultLegacyVolume(); - const legacyPath = Path.join( - constants.rootMountPoint, - 'mnt/data/resin-data', - appId.toString(), - ); - - try { - return await this.createFromPath({ name, appId }, {}, legacyPath); - } catch (e) { - logger.logSystemMessage( - `Warning: could not migrate legacy /data volume: ${e.message}`, - { error: e }, - 'Volume migration error', - ); - } - } - - public async createFromPath( - { name, appId }: VolumeNameOpts, - config: Partial, - oldPath: string, - ): Promise { - const volume = Volume.fromComposeObject(name, appId, config); - - await this.create(volume); - const inspect = await docker - .getVolume(Volume.generateDockerName(volume.appId, volume.name)) - .inspect(); - - const volumePath = Path.join( - constants.rootMountPoint, - 'mnt/data', - ...inspect.Mountpoint.split(Path.sep).slice(3), - ); - - await safeRename(oldPath, volumePath); - return volume; - } - - public async removeOrphanedVolumes( - referencedVolumes: string[], - ): Promise { - // Iterate through every container, and track the - // references to a volume - // Note that we're not just interested in containers - // which are part of the private state, and instead - // *all* containers. This means we don't remove - // something that's part of a sideloaded container - const [dockerContainers, dockerVolumes] = await Promise.all([ - docker.listContainers(), - docker.listVolumes(), - ]); - - const containerVolumes = _(dockerContainers) - .flatMap((c) => c.Mounts) - .filter((m) => m.Type === 'volume') - // We know that the name must be set, if the mount is - // a volume - .map((m) => m.Name as string) - .uniq() - .value(); - const volumeNames = _.map(dockerVolumes.Volumes, 'Name'); - - const volumesToRemove = _.difference( - volumeNames, - containerVolumes, - // Don't remove any volume which is still referenced - // in the target state - referencedVolumes, - ); - await Promise.all(volumesToRemove.map((v) => docker.getVolume(v).remove())); - } - - private async listWithBothLabels(): Promise { - const [legacyResponse, currentResponse] = await Promise.all([ - docker.listVolumes({ - filters: { label: ['io.resin.supervised'] }, - }), - docker.listVolumes({ - filters: { label: ['io.balena.supervised'] }, - }), - ]); - - const legacyVolumes = _.get(legacyResponse, 'Volumes', []); - const currentVolumes = _.get(currentResponse, 'Volumes', []); - return _.unionBy(legacyVolumes, currentVolumes, 'Name'); + await volume.create(); } } -export default VolumeManager; +// We simply forward this to the volume object, but we +// add this method to provide a consistent interface +export async function remove(volume: Volume) { + await volume.remove(); +} + +export async function createFromLegacy(appId: number): Promise { + const name = defaultLegacyVolume(); + const legacyPath = Path.join( + constants.rootMountPoint, + 'mnt/data/resin-data', + appId.toString(), + ); + + try { + return await createFromPath({ name, appId }, {}, legacyPath); + } catch (e) { + logger.logSystemMessage( + `Warning: could not migrate legacy /data volume: ${e.message}`, + { error: e }, + 'Volume migration error', + ); + } +} + +export async function createFromPath( + { name, appId }: VolumeNameOpts, + config: Partial, + oldPath: string, +): Promise { + const volume = Volume.fromComposeObject(name, appId, config); + + await create(volume); + const inspect = await docker + .getVolume(Volume.generateDockerName(volume.appId, volume.name)) + .inspect(); + + const volumePath = Path.join( + constants.rootMountPoint, + 'mnt/data', + ...inspect.Mountpoint.split(Path.sep).slice(3), + ); + + await safeRename(oldPath, volumePath); + return volume; +} + +export async function removeOrphanedVolumes( + referencedVolumes: string[], +): Promise { + // Iterate through every container, and track the + // references to a volume + // Note that we're not just interested in containers + // which are part of the private state, and instead + // *all* containers. This means we don't remove + // something that's part of a sideloaded container + const [dockerContainers, dockerVolumes] = await Promise.all([ + docker.listContainers(), + docker.listVolumes(), + ]); + + const containerVolumes = _(dockerContainers) + .flatMap((c) => c.Mounts) + .filter((m) => m.Type === 'volume') + // We know that the name must be set, if the mount is + // a volume + .map((m) => m.Name as string) + .uniq() + .value(); + const volumeNames = _.map(dockerVolumes.Volumes, 'Name'); + + const volumesToRemove = _.difference( + volumeNames, + containerVolumes, + // Don't remove any volume which is still referenced + // in the target state + referencedVolumes, + ); + await Promise.all(volumesToRemove.map((v) => docker.getVolume(v).remove())); +} + +async function listWithBothLabels(): Promise { + const [legacyResponse, currentResponse] = await Promise.all([ + docker.listVolumes({ + filters: { label: ['io.resin.supervised'] }, + }), + docker.listVolumes({ + filters: { label: ['io.balena.supervised'] }, + }), + ]); + + const legacyVolumes = _.get(legacyResponse, 'Volumes', []); + const currentVolumes = _.get(currentResponse, 'Volumes', []); + return _.unionBy(legacyVolumes, currentVolumes, 'Name'); +} diff --git a/src/device-api/v2.ts b/src/device-api/v2.ts index eaef1615..d07ba145 100644 --- a/src/device-api/v2.ts +++ b/src/device-api/v2.ts @@ -9,6 +9,8 @@ import * as config from '../config'; import * as db from '../db'; import * as logger from '../logger'; import * as images from '../compose/images'; +import * as volumeManager from '../compose/volume-manager'; +import * as serviceManager from '../compose/service-manager'; import { spawnJournalctl } from '../lib/journald'; import { appNotFoundMessage, @@ -152,7 +154,7 @@ export function createV2Api(router: Router, applications: ApplicationManager) { // It's kinda hacky to access the services and db via the application manager // maybe refactor this code Bluebird.join( - applications.services.getStatus(), + serviceManager.getStatus(), images.getStatus(), db.models('app').select(['appId', 'commit', 'name']), ( @@ -358,7 +360,7 @@ export function createV2Api(router: Router, applications: ApplicationManager) { }); router.get('/v2/containerId', async (req, res) => { - const services = await applications.services.getAll(); + const services = await serviceManager.getAll(); if (req.query.serviceName != null || req.query.service != null) { const serviceName = req.query.serviceName || req.query.service; @@ -392,7 +394,7 @@ export function createV2Api(router: Router, applications: ApplicationManager) { const currentRelease = await config.get('currentCommit'); const pending = applications.deviceState.applyInProgress; - const containerStates = (await applications.services.getAll()).map((svc) => + const containerStates = (await serviceManager.getAll()).map((svc) => _.pick( svc, 'status', @@ -484,7 +486,7 @@ export function createV2Api(router: Router, applications: ApplicationManager) { referencedVolumes.push(Volume.generateDockerName(vol.appId, vol.name)); }); }); - await applications.volumes.removeOrphanedVolumes(referencedVolumes); + await volumeManager.removeOrphanedVolumes(referencedVolumes); res.json({ status: 'success', }); diff --git a/src/lib/migration.ts b/src/lib/migration.ts index 87759eb9..b4b7f968 100644 --- a/src/lib/migration.ts +++ b/src/lib/migration.ts @@ -12,6 +12,8 @@ const rimrafAsync = Bluebird.promisify(rimraf); import { ApplicationManager } from '../application-manager'; import * as config from '../config'; import * as db from '../db'; +import * as volumeManager from '../compose/volume-manager'; +import * as serviceManager from '../compose/service-manager'; import DeviceState from '../device-state'; import * as constants from '../lib/constants'; import { BackupError, DatabaseParseError, NotFoundError } from '../lib/errors'; @@ -243,13 +245,13 @@ export async function normaliseLegacyDatabase( } log.debug('Killing legacy containers'); - await application.services.killAllLegacy(); + await serviceManager.killAllLegacy(); log.debug('Migrating legacy app volumes'); const targetApps = await application.getTargetApps(); for (const appId of _.keys(targetApps)) { - await application.volumes.createFromLegacy(parseInt(appId, 10)); + await volumeManager.createFromLegacy(parseInt(appId, 10)); } await config.set({ @@ -302,7 +304,7 @@ export async function loadBackupFromMigration( if (volumes[volumeName] != null) { log.debug(`Creating volume ${volumeName} from backup`); // If the volume exists (from a previous incomplete run of this restoreBackup), we delete it first - await deviceState.applications.volumes + await volumeManager .get({ appId, name: volumeName }) .then((volume) => { return volume.remove(); @@ -314,7 +316,7 @@ export async function loadBackupFromMigration( throw error; }); - await deviceState.applications.volumes.createFromPath( + await volumeManager.createFromPath( { appId, name: volumeName }, volumes[volumeName], path.join(backupPath, volumeName), diff --git a/test/lib/mocked-device-api.ts b/test/lib/mocked-device-api.ts index f139bcfa..8380e082 100644 --- a/test/lib/mocked-device-api.ts +++ b/test/lib/mocked-device-api.ts @@ -1,11 +1,10 @@ import { Router } from 'express'; import { fs } from 'mz'; -import { stub } from 'sinon'; import { ApplicationManager } from '../../src/application-manager'; -import { NetworkManager } from '../../src/compose/network-manager'; -import { ServiceManager } from '../../src/compose/service-manager'; -import { VolumeManager } from '../../src/compose/volume-manager'; +import * as networkManager from '../../src/compose/network-manager'; +import * as serviceManager from '../../src/compose/service-manager'; +import * as volumeManager from '../../src/compose/volume-manager'; import * as config from '../../src/config'; import * as db from '../../src/db'; import { createV1Api } from '../../src/device-api/v1'; @@ -133,20 +132,25 @@ function buildRoutes(appManager: ApplicationManager): Router { return router; } +const originalNetGetAll = networkManager.getAllByAppId; +const originalVolGetAll = volumeManager.getAllByAppId; +const originalSvcGetStatus = serviceManager.getStatus; function setupStubs() { - stub(ServiceManager.prototype, 'getStatus').resolves(STUBBED_VALUES.services); - stub(NetworkManager.prototype, 'getAllByAppId').resolves( - STUBBED_VALUES.networks, - ); - stub(VolumeManager.prototype, 'getAllByAppId').resolves( - STUBBED_VALUES.volumes, - ); + // @ts-expect-error Assigning to a RO property + networkManager.getAllByAppId = async () => STUBBED_VALUES.networks; + // @ts-expect-error Assigning to a RO property + volumeManager.getAllByAppId = async () => STUBBED_VALUES.volumes; + // @ts-expect-error Assigning to a RO property + serviceManager.getStatus = async () => STUBBED_VALUES.services; } function restoreStubs() { - (ServiceManager.prototype as any).getStatus.restore(); - (NetworkManager.prototype as any).getAllByAppId.restore(); - (VolumeManager.prototype as any).getAllByAppId.restore(); + // @ts-expect-error Assigning to a RO property + networkManager.getAllByAppId = originalNetGetAll; + // @ts-expect-error Assigning to a RO property + volumeManager.getAllByAppId = originalVolGetAll; + // @ts-expect-error Assigning to a RO property + serviceManager.getStatus = originalSvcGetStatus; } interface SupervisorAPIOpts {