fix: await async updated handlers during install (#202)

* fix #200

Author: john-u

jest.config.js

@@ -3,8 +3,10 @@ module.exports = {
 	//
 	// For our previous nyc watermark config, see
 	// https://github.com/SmartThingsCommunity/smartapp-sdk-nodejs/blob/79983de15646dd3be84d2b3e82d409f9bc632959/package.json#L72
+	collectCoverageFrom: ['lib/**/*.js'],
 	coverageReporters: ['json', 'text'],
 	testEnvironment: 'node',
+	testPathIgnorePatterns: ['test/data'],
 	testMatch: ['**/test/**/*.[jt]s?(x)'],
 	setupFiles: ['<rootDir>/config/jest.setup.js']
 }

lib/smart-app.js

@@ -41,18 +41,18 @@ class SmartApp {
 			this._log.warn(msg)
 		})
 		this._initializedHandler = null
-		this._installedHandler = ((ctx, installData) => {
-			this._updatedHandler(ctx, installData)
+		this._installedHandler = (async (ctx, installData) => {
+			await this._updatedHandler(ctx, installData)
 		})
 		this._updatedHandler = (() => { })
-		this._uninstalledHandler = (() => {})
-		this._oauthHandler = (() => {})
+		this._uninstalledHandler = (() => { })
+		this._oauthHandler = (() => { })
 		this._deviceCommandHandler = null
 		this._defaultDeviceCommandHandler = ((ctx, deviceId, cmd) => {
 			this._log.warn(`No command handler for ${JSON.stringify(cmd)} of device ${deviceId}`)
 		})
 		this._deviceCommands = {}
-		this._executeHandler = (() => {})
+		this._executeHandler = (() => { })
 		this._localizationEnabled = false
 		this._apiUrl = options.apiUrl
 		this._refreshUrl = options.refreshUrl

package-lock.json

@@ -50,6 +50,7 @@
   "devDependencies": {
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.0",
+    "@types/jest": "^26.0.24",
     "conventional-changelog-eslint": "~3.0.1",
     "dotenv": "^8.1.0",
     "jest": "^26.6.3",
@@ -63,6 +64,7 @@
     "typedoc": "^0.17.7",
     "typedoc-plugin-markdown": "^2.2.17",
     "typescript": "^3.9.3",
+    "uuid": "^8.3.2",
     "xo": "~0.39.1"
   },
   "xo": {

package.json

@@ -0,0 +1,61 @@
+const { v4: uuid } = require('uuid')
+
+exports.INSTALL = {
+	lifecycle: 'INSTALL',
+	executionId: uuid(),
+	locale: 'en',
+	version: '0.1.0',
+	client: {
+		os: 'ios',
+		version: '0.0.0',
+		language: 'en-US'
+	},
+	installData: {
+		authToken: uuid(),
+		refreshToken: uuid(),
+		installedApp: {
+			installedAppId: uuid(),
+			locationId: uuid(),
+			config: {}
+		}
+	},
+	settings: {}
+}
+
+exports.UNINSTALL = {
+	lifecycle: 'UNINSTALL',
+	executionId: uuid(),
+	locale: 'en-US',
+	version: '0.1.0',
+	uninstallData: {
+		installedApp: {
+			installedAppId: uuid(),
+			locationId: uuid(),
+			config: {},
+			permissions: []
+		}
+	},
+	settings: {}
+}
+
+exports.UPDATE = {
+	lifecycle: 'UPDATE',
+	executionId: uuid(),
+	locale: 'en',
+	version: '0.1.0',
+	client: {
+		os: 'ios',
+		version: '0.0.0',
+		language: 'en-US'
+	},
+	updateData: {
+		authToken: uuid(),
+		refreshToken: uuid(),
+		installedApp: {
+			installedAppId: uuid(),
+			locationId: uuid(),
+			config: {}
+		}
+	},
+	settings: {}
+}

test/data/lifecycles.js

@@ -1,94 +1,83 @@
-const SmartApp = require('../../../lib/smart-app')
+const { SmartApp } = require('../../../lib/smart-app')
+const { INSTALL, UNINSTALL, UPDATE } = require('../../data/lifecycles')
 
 describe('installation-lifecycle-spec', () => {
 	let app
-	let expectedData
 	let receivedEvent
 	let receivedData
 
 	beforeEach(() => {
-		app = new SmartApp({logUnhandledRejections: false})
-		expectedData = {
-			authToken: 'string',
-			refreshToken: 'string',
-			installedApp: {
-				installedAppId: 'd692699d-e7a6-400d-a0b7-d5be96e7a564',
-				locationId: 'e675a3d9-2499-406c-86dc-8a492a886494',
-				config: {}
-			}
-		}
+		app = new SmartApp({ logUnhandledRejections: false })
+		receivedEvent = undefined
+		receivedData = undefined
 	})
 
-	it('should handle INSTALL lifecycle', async () => {
+	it('handles INSTALL lifecycle with installed handler', async () => {
 		app.installed((_, installData) => {
 			receivedData = installData
 		})
-		await app.handleMockCallback({
-			lifecycle: 'INSTALL',
-			executionId: 'e6903fe6-f88f-da69-4c12-e2802606ccbc',
-			locale: 'en',
-			version: '0.1.0',
-			client: {
-				os: 'ios',
-				version: '0.0.0',
-				language: 'en-US'
-			},
-			installData: expectedData,
-			settings: {}
+
+		await app.handleMockCallback(INSTALL)
+
+		expect(receivedData).toStrictEqual(INSTALL.installData)
+	})
+
+	it('handles INSTALL lifecycle with updated handler when no installed handler defined', async () => {
+		app.updated((_, installData) => {
+			receivedData = installData
 		})
 
-		expect(receivedData).toStrictEqual(expectedData)
+		await app.handleMockCallback(INSTALL)
+
+		expect(receivedData).toStrictEqual(INSTALL.installData)
 	})
 
-	it('should handle UNINSTALL lifecycle', async () => {
-		const expectedEvent = {
-			'installedApp': {
-				'installedAppId': 'd46a1c60-b6bd-4f82-b124-028e0f14a4f4',
-				'locationId': 'e1e66eab-1eab-4f09-9bb6-91da6585576d',
-				'config': {},
-				'permissions': []
-			}
-		}
+	it('handles INSTALL lifecycle rejection with async updated handler when no installed handler defined', async () => {
+		app.updated(async () => {
+			await Promise.reject(new Error('something failed'))
+		})
+
+		const response = app.handleMockCallback(INSTALL)
+
+		await expect(response).resolves.toStrictEqual(
+			expect.objectContaining({ statusCode: 500, message: expect.stringContaining('something failed') })
+		)
+	})
+
+	it('handles INSTALL lifecycle with installed handler when both installed and updated handlers defined', async () => {
+		app.installed((_, installData) => {
+			receivedData = installData
+		})
+
+		const updateHandler = jest.fn(() => {
+			receivedData = null
+		})
+
+		app.updated(updateHandler)
+
+		await app.handleMockCallback(INSTALL)
+
+		expect(updateHandler).not.toBeCalled()
+		expect(receivedData).toStrictEqual(INSTALL.installData)
+	})
+
+	it('handles UNINSTALL lifecycle', async () => {
 		app.uninstalled((_, event) => {
 			receivedEvent = event
 		})
-		await app.handleMockCallback({
-			'lifecycle': 'UNINSTALL',
-			'executionId': 'e139dc1f-ee24-3c1a-309e-48669006817f',
-			'locale': 'en-US',
-			'version': '0.1.0',
-			'uninstallData': {
-				'installedApp': {
-					'installedAppId': 'd46a1c60-b6bd-4f82-b124-028e0f14a4f4',
-					'locationId': 'e1e66eab-1eab-4f09-9bb6-91da6585576d',
-					'config': {},
-					'permissions': []
-				}
-			},
-			'settings': {}
-		})
 
-		expect(receivedEvent).toStrictEqual(expectedEvent)
+		await app.handleMockCallback(UNINSTALL)
+
+		expect(receivedEvent).toStrictEqual(UNINSTALL.uninstallData)
 	})
 
-	it('should handle UPDATE lifecycle', async () => {
+	it('handles UPDATE lifecycle', async () => {
 		app.updated((_, updateData) => {
 			receivedData = updateData
 		})
-		await app.handleMockCallback({
-			lifecycle: 'UPDATE',
-			executionId: 'e6903fe6-f88f-da69-4c12-e2802606ccbc',
-			locale: 'en',
-			version: '0.1.0',
-			client: {
-				os: 'ios',
-				version: '0.0.0',
-				language: 'en-US'
-			},
-			updateData: expectedData,
-			settings: {}
-		})
 
-		expect(receivedData).toStrictEqual(expectedData)
+		await app.handleMockCallback(UPDATE)
+
+		expect(receivedData).toStrictEqual(UPDATE.updateData)
 	})
 })