fix: fix failure to output JSON or YAML history

.changeset/clever-trees-hang.md

@@ -0,0 +1,5 @@
+---
+"@smartthings/cli": patch
+---
+
+fixed bug when outputting JSON or YAML device or location history

packages/cli/src/__tests__/commands/devices/history.test.ts

@@ -3,7 +3,6 @@ import {
 	calculateOutputFormat,
 	chooseDevice,
 	IOFormat,
-	jsonFormatter,
 	writeOutput,
 } from '@smartthings/cli-lib'
 import { Device, DeviceActivity, DevicesEndpoint, HistoryEndpoint, PaginatedList, SmartThingsClient } from '@smartthings/core-sdk'
@@ -14,29 +13,14 @@ import { calculateRequestLimit, getHistory, writeDeviceEventsTable } from '../..
 jest.mock('../../../lib/commands/history-util')
 
 describe('DeviceHistoryCommand', () => {
+	const chooseDeviceMock = jest.mocked(chooseDevice).mockResolvedValue('deviceId')
 	const getDeviceSpy = jest.spyOn(DevicesEndpoint.prototype, 'get').mockImplementation()
 	const historySpy = jest.spyOn(HistoryEndpoint.prototype, 'devices').mockImplementation()
-	const deviceSelectionMock = jest.mocked(chooseDevice).mockResolvedValue('deviceId')
 	const calculateOutputFormatMock = jest.mocked(calculateOutputFormat).mockReturnValue(IOFormat.COMMON)
 	const writeDeviceEventsTableMock = jest.mocked(writeDeviceEventsTable)
-	const calculateHistoryRequestLimitMock = jest.mocked(calculateRequestLimit)
+	const calculateRequestLimitMock = jest.mocked(calculateRequestLimit)
 	const getHistoryMock = jest.mocked(getHistory)
 
-	it('prompts user to select device', async () => {
-		getDeviceSpy.mockResolvedValueOnce({ locationId: 'locationId' } as Device)
-		historySpy.mockResolvedValueOnce({
-			items: [],
-			hasNext: (): boolean => false,
-		} as unknown as PaginatedList<DeviceActivity>)
-		await expect(DeviceHistoryCommand.run(['deviceId'])).resolves.not.toThrow()
-
-		expect(deviceSelectionMock).toHaveBeenCalledWith(
-			expect.any(DeviceHistoryCommand),
-			'deviceId',
-			{ allowIndex: true },
-		)
-	})
-
 	it('queries history and writes event table interactively', async () => {
 		getDeviceSpy.mockResolvedValueOnce({ locationId: 'locationId' } as Device)
 		historySpy.mockResolvedValueOnce({
@@ -46,8 +30,13 @@ describe('DeviceHistoryCommand', () => {
 
 		await expect(DeviceHistoryCommand.run(['deviceId'])).resolves.not.toThrow()
 
+		expect(calculateRequestLimitMock).toHaveBeenCalledTimes(1)
+		expect(calculateRequestLimitMock).toHaveBeenCalledWith(20)
+		expect(chooseDeviceMock).toHaveBeenCalledTimes(1)
+		expect(chooseDeviceMock).toHaveBeenCalledWith(expect.any(DeviceHistoryCommand), 'deviceId', { allowIndex: true })
 		expect(getDeviceSpy).toHaveBeenCalledTimes(1)
 		expect(getDeviceSpy).toHaveBeenCalledWith('deviceId')
+		expect(calculateOutputFormatMock).toHaveBeenCalledTimes(1)
 		expect(historySpy).toHaveBeenCalledTimes(1)
 		expect(historySpy).toHaveBeenCalledWith({
 			deviceId: 'deviceId',
@@ -56,23 +45,28 @@ describe('DeviceHistoryCommand', () => {
 		expect(writeDeviceEventsTableMock).toHaveBeenCalledTimes(1)
 	})
 
-	it('queries history and write event table directly', async () => {
-		const buildOutputFormatterMock = jest.mocked(buildOutputFormatter)
+	it('writes non-table output when specified', async () => {
+		const outputFormatterMock = jest.fn().mockReturnValueOnce('formatted output')
+		const buildOutputFormatterMock = jest.mocked(buildOutputFormatter<DeviceActivity[]>)
 		const writeOutputMock = jest.mocked(writeOutput)
 
-		calculateHistoryRequestLimitMock.mockReturnValueOnce(20)
+		const items = [{ deviceId: 'device-1' }] as DeviceActivity[]
+
+		calculateRequestLimitMock.mockReturnValueOnce(20)
 		getDeviceSpy.mockResolvedValueOnce({ locationId: 'locationId' } as Device)
-		historySpy.mockResolvedValueOnce({
-			items: [],
-			hasNext: (): boolean => false,
-		} as unknown as PaginatedList<DeviceActivity>)
 		calculateOutputFormatMock.mockReturnValueOnce(IOFormat.JSON)
-		buildOutputFormatterMock.mockReturnValueOnce(jsonFormatter(4))
+		buildOutputFormatterMock.mockReturnValueOnce(outputFormatterMock)
+		getHistoryMock.mockResolvedValueOnce(items)
 
 		await expect(DeviceHistoryCommand.run(['deviceId'])).resolves.not.toThrow()
 
+		expect(calculateRequestLimitMock).toHaveBeenCalledTimes(1)
+		expect(calculateRequestLimitMock).toHaveBeenCalledWith(20)
+		expect(chooseDeviceMock).toHaveBeenCalledTimes(1)
+		expect(chooseDeviceMock).toHaveBeenCalledWith(expect.any(DeviceHistoryCommand), 'deviceId', { allowIndex: true })
 		expect(getDeviceSpy).toHaveBeenCalledTimes(1)
 		expect(getDeviceSpy).toHaveBeenCalledWith('deviceId')
+		expect(calculateOutputFormatMock).toHaveBeenCalledTimes(1)
 		expect(getHistoryMock).toHaveBeenCalledTimes(1)
 		expect(getHistoryMock).toHaveBeenCalledWith(
 			expect.any(SmartThingsClient),
@@ -84,7 +78,10 @@ describe('DeviceHistoryCommand', () => {
 			}),
 		)
 		expect(buildOutputFormatterMock).toHaveBeenCalledTimes(1)
+		expect(outputFormatterMock).toHaveBeenCalledTimes(1)
+		expect(outputFormatterMock).toHaveBeenCalledWith(items)
 		expect(writeOutputMock).toHaveBeenCalledTimes(1)
+		expect(writeOutputMock).toHaveBeenCalledWith('formatted output', undefined)
 
 		expect(historySpy).toHaveBeenCalledTimes(0)
 		expect(writeDeviceEventsTableMock).toHaveBeenCalledTimes(0)

packages/cli/src/__tests__/commands/locations/history.test.ts

@@ -1,25 +1,27 @@
+import { DeviceActivity, HistoryEndpoint, PaginatedList, SmartThingsClient } from '@smartthings/core-sdk'
+
 import {
 	buildOutputFormatter,
 	calculateOutputFormat,
 	IOFormat,
-	jsonFormatter,
 	writeOutput,
 } from '@smartthings/cli-lib'
-import { DeviceActivity, HistoryEndpoint, PaginatedList, SmartThingsClient } from '@smartthings/core-sdk'
+
 import LocationHistoryCommand from '../../../commands/locations/history'
 import { calculateRequestLimit, getHistory, writeDeviceEventsTable } from '../../../lib/commands/history-util'
 import { chooseLocation } from '../../../commands/locations'
+import LocationDeviceHistoryCommand from '../../../commands/locations/history'
 
 
 jest.mock('../../../lib/commands/history-util')
 jest.mock('../../../commands/locations')
 
 describe('LocationHistoryCommand', () => {
-	const mockChooseLocation = jest.mocked(chooseLocation).mockResolvedValue('locationId')
+	const chooseLocationMock = jest.mocked(chooseLocation).mockResolvedValue('locationId')
 	const historySpy = jest.spyOn(HistoryEndpoint.prototype, 'devices').mockImplementation()
 	const calculateOutputFormatMock = jest.mocked(calculateOutputFormat).mockReturnValue(IOFormat.COMMON)
 	const writeDeviceEventsTableMock = jest.mocked(writeDeviceEventsTable)
-	const calculateHistoryRequestLimitMock = jest.mocked(calculateRequestLimit)
+	const calculateRequestLimitMock = jest.mocked(calculateRequestLimit)
 	const getHistoryMock = jest.mocked(getHistory)
 
 	it('queries history and writes event table interactively', async () => {
@@ -30,7 +32,10 @@ describe('LocationHistoryCommand', () => {
 
 		await expect(LocationHistoryCommand.run(['locationId'])).resolves.not.toThrow()
 
-		expect(mockChooseLocation).toHaveBeenCalledTimes(1)
+		expect(calculateRequestLimitMock).toHaveBeenCalledTimes(1)
+		expect(calculateRequestLimitMock).toHaveBeenCalledWith(20)
+		expect(chooseLocationMock).toHaveBeenCalledTimes(1)
+		expect(chooseLocationMock).toHaveBeenCalledWith(expect.any(LocationDeviceHistoryCommand), 'locationId', true, true)
 		expect(calculateOutputFormatMock).toHaveBeenCalledTimes(1)
 		expect(historySpy).toHaveBeenCalledTimes(1)
 		expect(historySpy).toHaveBeenCalledWith({
@@ -41,18 +46,23 @@ describe('LocationHistoryCommand', () => {
 	})
 
 	it('queries history and write event table directly', async () => {
-		const buildOutputFormatterMock = jest.mocked(buildOutputFormatter)
+		const outputFormatterMock = jest.fn().mockReturnValueOnce('formatted output')
+		const buildOutputFormatterMock = jest.mocked(buildOutputFormatter<DeviceActivity[]>)
 		const writeOutputMock = jest.mocked(writeOutput)
 
-		calculateHistoryRequestLimitMock.mockReturnValueOnce(20)
+		const items = [{ deviceId: 'device-1' }] as DeviceActivity[]
+
+		calculateRequestLimitMock.mockReturnValueOnce(20)
 		calculateOutputFormatMock.mockReturnValueOnce(IOFormat.JSON)
-		buildOutputFormatterMock.mockReturnValueOnce(jsonFormatter(4))
+		buildOutputFormatterMock.mockReturnValueOnce(outputFormatterMock)
+		getHistoryMock.mockResolvedValueOnce(items)
 
 		await expect(LocationHistoryCommand.run(['locationId'])).resolves.not.toThrow()
 
-		expect(calculateHistoryRequestLimitMock).toHaveBeenCalledTimes(1)
-		expect(calculateHistoryRequestLimitMock).toHaveBeenCalledWith(20)
-		expect(mockChooseLocation).toHaveBeenCalledTimes(1)
+		expect(calculateRequestLimitMock).toHaveBeenCalledTimes(1)
+		expect(calculateRequestLimitMock).toHaveBeenCalledWith(20)
+		expect(chooseLocationMock).toHaveBeenCalledTimes(1)
+		expect(chooseLocationMock).toHaveBeenCalledWith(expect.any(LocationDeviceHistoryCommand), 'locationId', true, true)
 		expect(calculateOutputFormatMock).toHaveBeenCalledTimes(1)
 		expect(getHistoryMock).toHaveBeenCalledTimes(1)
 		expect(getHistoryMock).toHaveBeenCalledWith(
@@ -63,9 +73,11 @@ describe('LocationHistoryCommand', () => {
 				locationId: 'locationId',
 			}),
 		)
-		expect(writeDeviceEventsTableMock).toHaveBeenCalledTimes(0)
 		expect(buildOutputFormatterMock).toHaveBeenCalledTimes(1)
+		expect(outputFormatterMock).toHaveBeenCalledTimes(1)
+		expect(outputFormatterMock).toHaveBeenCalledWith(items)
 		expect(writeOutputMock).toHaveBeenCalledTimes(1)
+		expect(writeOutputMock).toHaveBeenCalledWith('formatted output', undefined)
 
 		expect(historySpy).toHaveBeenCalledTimes(0)
 		expect(writeDeviceEventsTableMock).toHaveBeenCalledTimes(0)

packages/cli/src/commands/devices/history.ts

@@ -1,3 +1,5 @@
+import { DeviceActivity } from '@smartthings/core-sdk'
+
 import {
 	APICommand,
 	buildOutputFormatter,
@@ -53,8 +55,8 @@ export default class DeviceHistoryCommand extends APICommand<typeof DeviceHistor
 			const history = await this.client.history.devices(params)
 			await writeDeviceEventsTable(this, history, { utcTimeFormat: this.flags.utc })
 		} else {
-			const items = getHistory(this.client, limit, perRequestLimit, params)
-			const outputFormatter = buildOutputFormatter(this)
+			const items = await getHistory(this.client, limit, perRequestLimit, params)
+			const outputFormatter = buildOutputFormatter<DeviceActivity[]>(this)
 			await writeOutput(outputFormatter(items), this.flags.output)
 		}
 	}

packages/cli/src/commands/locations/history.ts

@@ -1,3 +1,5 @@
+import { DeviceActivity } from '@smartthings/core-sdk'
+
 import {
 	APICommand,
 	buildOutputFormatter,
@@ -51,8 +53,8 @@ export default class LocationDeviceHistoryCommand extends APICommand<typeof Loca
 			const history = await this.client.history.devices(params)
 			await writeDeviceEventsTable(this, history, { includeName: true, utcTimeFormat: this.flags.utc })
 		} else {
-			const items = getHistory(this.client, limit, perRequestLimit, params)
-			const outputFormatter = buildOutputFormatter(this)
+			const items = await getHistory(this.client, limit, perRequestLimit, params)
+			const outputFormatter = buildOutputFormatter<DeviceActivity[]>(this)
 			await writeOutput(outputFormatter(items), this.flags.output)
 		}
 	}