balena-cli/lib/commands/devices/index.ts

/**
 * @license
 * Copyright 2016-2020 Balena Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { flags } from '@oclif/command';
import Command from '../../command';
import * as cf from '../../utils/common-flags';
import { expandForAppName } from '../../utils/helpers';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
import {
	applicationIdInfo,
	appToFleetFlagMsg,
	appToFleetOutputMsg,
	jsonInfo,
	warnify,
} from '../../utils/messages';
import { isV13 } from '../../utils/version';

import type { Application } from 'balena-sdk';

interface ExtendedDevice extends DeviceWithDeviceType {
	dashboard_url?: string;
	application_name?: string | null;
	device_type?: string | null;
}

interface FlagsDef {
	application?: string;
	app?: string;
	fleet?: string;
	help: void;
	json: boolean;
	v13: boolean;
}

export default class DevicesCmd extends Command {
	public static description = stripIndent`
		List all devices.

		List all of your devices.

		Devices can be filtered by fleet with the \`--fleet\` option.

		${applicationIdInfo.split('\n').join('\n\t\t')}

		${jsonInfo.split('\n').join('\n\t\t')}
	`;
	public static examples = [
		'$ balena devices',
		'$ balena devices --fleet MyFleet',
		'$ balena devices -f myorg/myfleet',
	];

	public static usage = 'devices';

	public static flags: flags.Input<FlagsDef> = {
		...(isV13()
			? {}
			: {
					application: {
						...cf.application,
						exclusive: ['app', 'fleet', 'v13'],
					},
					app: { ...cf.app, exclusive: ['application', 'fleet', 'v13'] },
			  }),
		fleet: { ...cf.fleet, exclusive: ['app', 'application'] },
		json: cf.json,
		help: cf.help,
		v13: cf.v13,
	};

	public static primary = true;

	public static authenticated = true;

	protected useAppWord = false;
	protected hasWarned = false;

	public async run() {
		const { flags: options } = this.parse<FlagsDef, {}>(DevicesCmd);
		this.useAppWord = !options.fleet && !options.v13 && !isV13();

		const balena = getBalenaSdk();

		if (
			(options.application || options.app) &&
			!options.json &&
			process.stderr.isTTY
		) {
			this.hasWarned = true;
			console.error(warnify(appToFleetFlagMsg));
		}
		// Consolidate application options
		options.application ||= options.app || options.fleet;

		let devices;

		if (options.application != null) {
			const { getApplication } = await import('../../utils/sdk');
			const application = await getApplication(balena, options.application);
			devices = (await balena.models.device.getAllByApplication(
				application.id,
				expandForAppName,
			)) as ExtendedDevice[];
		} else {
			devices = (await balena.models.device.getAll(
				expandForAppName,
			)) as ExtendedDevice[];
		}

		devices = devices.map(function (device) {
			device.dashboard_url = balena.models.device.getDashboardUrl(device.uuid);

			const belongsToApplication =
				device.belongs_to__application as Application[];
			device.application_name = belongsToApplication?.[0]?.app_name || null;

			device.uuid = options.json ? device.uuid : device.uuid.slice(0, 7);

			device.device_type = device.is_of__device_type?.[0]?.slug || null;
			return device;
		});

		const jName = this.useAppWord ? 'application_name' : 'fleet_name';
		const tName = this.useAppWord ? 'APPLICATION NAME' : 'FLEET';
		const fields = [
			'id',
			'uuid',
			'device_name',
			'device_type',
			options.json
				? `application_name => ${jName}`
				: `application_name => ${tName}`,
			'status',
			'is_online',
			'supervisor_version',
			'os_version',
			'dashboard_url',
		];

		if (options.json) {
			const { pickAndRename } = await import('../../utils/helpers');
			const mapped = devices.map((device) => pickAndRename(device, fields));
			console.log(JSON.stringify(mapped, null, 4));
		} else {
			if (!this.hasWarned && this.useAppWord && process.stderr.isTTY) {
				console.error(warnify(appToFleetOutputMsg));
			}
			const _ = await import('lodash');
			console.log(
				getVisuals().table.horizontal(
					devices.map((dev) => _.mapValues(dev, (val) => val ?? 'N/a')),
					fields,
				),
			);
		}
	}
}