test: add missing cases for unhandled events (#184)

Author: john-u

config/jest.setup.js

@@ -0,0 +1,5 @@
+/* eslint no-undef: 'off' */
+
+process.on('unhandledRejection', error => {
+	fail(error)
+})

jest.config.js

@@ -5,5 +5,6 @@ module.exports = {
 	// https://github.com/SmartThingsCommunity/smartapp-sdk-nodejs/blob/79983de15646dd3be84d2b3e82d409f9bc632959/package.json#L72
 	coverageReporters: ['json', 'text'],
 	testEnvironment: 'node',
-	testMatch: ['**/test/**/*.[jt]s?(x)']
+	testMatch: ['**/test/**/*.[jt]s?(x)'],
+	setupFiles: ['<rootDir>/config/jest.setup.js']
 }

test/unit/smartapp-page-spec.js

@@ -1,9 +1,12 @@
-const assert = require('assert').strict
 const SmartApp = require('../../lib/smart-app')
 
 describe('smartapp-page-spec', () => {
+	let app
+	beforeEach(() => {
+		app = new SmartApp()
+	})
+
 	it('should set page ID', () => {
-		const app = new SmartApp()
 		app.appId('xxx')
 		app.page('eaMainPage', (ctx, page) => {
 			page.section('whenDoorOpensAndCloses', section => {
@@ -56,7 +59,7 @@ describe('smartapp-page-spec', () => {
 				disableRemoveApp: false
 			}}
 
-			assert.deepStrictEqual(initResponse.configurationData, expectedInitResponse)
+			expect(initResponse.configurationData).toStrictEqual(expectedInitResponse)
 		})
 
 		// Page configuration callback
@@ -109,7 +112,8 @@ describe('smartapp-page-spec', () => {
 					]
 				}
 			}
-			assert.deepStrictEqual(pageResponse.configurationData, expectedPageResponse)
+
+			expect(pageResponse.configurationData).toStrictEqual(expectedPageResponse)
 		})
 
 		// Default page handler configuration callback
@@ -182,12 +186,12 @@ describe('smartapp-page-spec', () => {
 					]
 				}
 			}
-			assert.deepStrictEqual(pageResponse.configurationData, expectedPageResponse)
+
+			expect(pageResponse.configurationData).toStrictEqual(expectedPageResponse)
 		})
 	})
 
 	it('should configure event logger', () => {
-		const app = new SmartApp()
 		app.appId('xxx')
 		app.enableEventLogging(4)
 		app.page('eaMainPage', (ctx, page) => {
@@ -218,9 +222,7 @@ describe('smartapp-page-spec', () => {
 		})
 	})
 
-	it('default page handler', () => {
-		const app = new SmartApp()
-
+	test('default page handler', () => {
 		app.handleMockCallback({
 			lifecycle: 'CONFIGURATION',
 			executionId: 'abcf6e72-60f4-1f27-341b-449ad9e2192e',
@@ -263,13 +265,12 @@ describe('smartapp-page-spec', () => {
 					]
 				}
 			}
-			assert.deepStrictEqual(pageResponse.configurationData, expectedPageResponse)
+
+			expect(pageResponse.configurationData).toStrictEqual(expectedPageResponse)
 		})
 	})
 
-	it('default page handler without pageId', () => {
-		const app = new SmartApp()
-
+	test('default page handler without pageId', () => {
 		app.handleMockCallback({
 			lifecycle: 'CONFIGURATION',
 			executionId: 'abcf6e72-60f4-1f27-341b-449ad9e2192e',
@@ -312,7 +313,37 @@ describe('smartapp-page-spec', () => {
 					]
 				}
 			}
-			assert.deepStrictEqual(pageResponse.configurationData, expectedPageResponse)
+
+			expect(pageResponse.configurationData).toStrictEqual(expectedPageResponse)
 		})
 	})
+
+	it('should respond with error when config phase is not supported', async () => {
+		const unsupportedConfigPhase = {
+			lifecycle: 'CONFIGURATION',
+			executionId: '00000000-0000-0000-0000-000000000000',
+			locale: 'en',
+			version: '0.1.0',
+			client: {
+				os: 'ios',
+				version: '0.0.0',
+				language: 'fr'
+			},
+			configurationData: {
+				installedAppId: '00000000-0000-0000-0000-000000000000',
+				phase: 'UNSUPPORTED',
+				pageId: '',
+				previousPageId: '',
+				config: {}
+			},
+			settings: {}
+		}
+
+		const expectedPageResponse = {
+			message: 'Server error: \'Error: Unsupported config phase: UNSUPPORTED\'',
+			statusCode: 500
+		}
+
+		await expect(app.handleMockCallback(unsupportedConfigPhase)).resolves.toStrictEqual(expectedPageResponse)
+	})
 })

test/unit/smartapp-spec.js

@@ -1,4 +1,4 @@
-const assert = require('assert').strict
+const Log = require('../../lib/util/log')
 const SmartApp = require('../../lib/smart-app')
 
 describe('smartapp-spec', () => {
@@ -19,11 +19,11 @@ describe('smartapp-spec', () => {
 		}
 	})
 
-	it('should handle INSTALL event', () => {
+	it('should handle INSTALL event', async () => {
 		app.installed((_, installData) => {
 			receivedData = installData
 		})
-		app.handleMockCallback({
+		await app.handleMockCallback({
 			lifecycle: 'INSTALL',
 			executionId: 'e6903fe6-f88f-da69-4c12-e2802606ccbc',
 			locale: 'en',
@@ -36,34 +36,15 @@ describe('smartapp-spec', () => {
 			installData: expectedData,
 			settings: {}
 		})
-		assert.strictEqual(receivedData, expectedData)
-	})
 
-	it('should handle UNINSTALL event', () => {
-		app.uninstalled((_, uninstallData) => {
-			receivedData = uninstallData
-		})
-		app.handleMockCallback({
-			lifecycle: 'UNINSTALL',
-			executionId: 'e6903fe6-f88f-da69-4c12-e2802606ccbc',
-			locale: 'en',
-			version: '0.1.0',
-			client: {
-				os: 'ios',
-				version: '0.0.0',
-				language: 'en-US'
-			},
-			uninstallData: expectedData,
-			settings: {}
-		})
-		assert.strictEqual(receivedData, expectedData)
+		expect(receivedData).toStrictEqual(expectedData)
 	})
 
-	it('should handle UPDATE event', () => {
+	it('should handle UPDATE event', async () => {
 		app.updated((_, updateData) => {
 			receivedData = updateData
 		})
-		app.handleMockCallback({
+		await app.handleMockCallback({
 			lifecycle: 'UPDATE',
 			executionId: 'e6903fe6-f88f-da69-4c12-e2802606ccbc',
 			locale: 'en',
@@ -76,6 +57,31 @@ describe('smartapp-spec', () => {
 			updateData: expectedData,
 			settings: {}
 		})
-		assert.strictEqual(receivedData, expectedData)
+
+		expect(receivedData).toStrictEqual(expectedData)
+	})
+
+	it('should warn when event type is unhandled', async () => {
+		const logSpy = jest.spyOn(Log.prototype, 'warn')
+
+		const unhandledEvent = {
+			lifecycle: 'EVENT',
+			eventData: {
+				installedApp: {
+					installedAppId: '00000000-0000-0000-0000-000000000000'
+				},
+				events: [
+					{
+						eventType: 'UNHANDLED_EVENT'
+					}
+				]
+			}
+		}
+
+		await expect(app.handleMockCallback(unhandledEvent)).resolves.not.toThrow()
+		expect(logSpy).toBeCalledTimes(1)
+		expect(logSpy).toBeCalledWith('Unhandled event of type UNHANDLED_EVENT')
+
+		logSpy.mockClear()
 	})
 })