Function getHistory

src/lib/command/util/history.ts:87–130

(
		client: SmartThingsClient,
		limit: number,
		perRequestLimit: number,
		params: DeviceHistoryRequest,
)

export const calculateRequestLimit = (limit: number): number => limit > maxItemsPerRequest ? maxItemsPerRequest : limit

export const getHistory = async (
		client: SmartThingsClient,
		limit: number,
		perRequestLimit: number,
		params: DeviceHistoryRequest,
): Promise<DeviceActivity[]> => {
	// if limit is > ${maxHistoryItemsPerRequest} we need a loop;
	// warn user if more than some number of requests will be made
	if (limit > perRequestLimit) {
		const requestsToMake = Math.ceil(limit / maxItemsPerRequest)
		if (requestsToMake > maxRequestsBeforeWarning) {
			// prompt user if it's okay to continue
			const answer = await select({
				message: `Querying ${limit} history items will result in ${requestsToMake} requests.\n` +
					'Are you sure you want to continue?',
				choices: [
					{ name: 'Yes, I understand this might take a long time and/or hit API rate limits.', value: 'yes' },
					{ name: 'No, cancel the request.', value: 'cancel' },
					{
						name: `Continue but limit results to ${maxItemsPerRequest * maxRequestsBeforeWarning}`,
						value: 'reduce',
					},
				],
			})
			if (answer === 'reduce') {
				limit = maxRequestsBeforeWarning * maxItemsPerRequest
			} else if (answer === 'cancel') {
				return cancelCommand('user canceled request')
			}
		}
	}
	const history = await client.history.devices(params)
	const items: DeviceActivity[] = [...history.items]
	while (items.length < limit && history.hasNext()) {
		await history.next()
		// The API allows the user to continue to view history from before the specified "after"
		// with paging so we stop processing if we get items that come before the specified "after".
		if ((params.after && history.items[0].epoch <= params.after)) {
			break
		}
		items.push(...history.items.slice(0, limit - items.length))
	}
	return items
}