test: Bootstrap integ/smoke tests (#137)

Author: Reno

package-lock.json

@@ -47,11 +47,15 @@
         "postinteg:local:nightwatch:chrome": "kill $(lsof -t -i:8080)",
         "preinteg:local:nightwatch:firefox": "http-server ./build/dev -s &",
         "integ:local:nightwatch:firefox": "nightwatch -e firefox",
-        "postinteg:local:nightwatch:firefox": "kill $(lsof -t -i:8080)"
+        "postinteg:local:nightwatch:firefox": "kill $(lsof -t -i:8080)",
+        "smoke:local": "cross-env URL=$URL MONITOR_ID=$MONITOR ENDPOINT=$ENDPOINT npx playwright test --config=playwright.local.config.ts --headed",
+        "smoke": "cross-env URL=$URL MONITOR_ID=$MONITOR ENDPOINT=$ENDPOINT npx playwright test --headed",
+        "smoke:headless": "cross-env URL=$URL MONITOR_ID=$MONITOR ENDPOINT=$ENDPOINT npx playwright test"
     },
     "devDependencies": {
         "@babel/plugin-transform-runtime": "^7.16.0",
         "@babel/preset-env": "~7.6.3",
+        "@playwright/test": "^1.21.1",
         "@types/jest": "^27.0.2",
         "@types/ua-parser-js": "^0.7.35",
         "@types/uuid": "^8.3.0",

package.json

@@ -0,0 +1,20 @@
+// playwright.config.js
+// @ts-check
+const { devices } = require('@playwright/test');
+
+const config = {
+    forbidOnly: !!process.env.CI,
+    testDir: 'src/__smoke-test__',
+    retries: process.env.CI ? 2 : 0,
+    use: {
+        trace: 'on-first-retry'
+    },
+    projects: [
+        {
+            name: 'chromium',
+            use: { ...devices['Desktop Chrome'] }
+        }
+    ]
+};
+
+module.exports = config;

playwright.config.ts

@@ -0,0 +1,26 @@
+// playwright.local.config.js
+// @ts-check
+const { devices } = require('@playwright/test');
+
+const config = {
+    forbidOnly: !!process.env.CI,
+    testDir: 'src/__smoke-test__',
+    retries: process.env.CI ? 2 : 0,
+    webServer: {
+        command: 'npm run server',
+        url: 'http://localhost:8080/',
+        timeout: 120 * 1000,
+        reuseExistingServer: !process.env.CI
+    },
+    use: {
+        trace: 'on-first-retry'
+    },
+    projects: [
+        {
+            name: 'chromium',
+            use: { ...devices['Desktop Chrome'] }
+        }
+    ]
+};
+
+module.exports = config;

playwright.local.config.ts

@@ -0,0 +1,83 @@
+import { test, expect } from '@playwright/test';
+import {
+    PERFORMANCE_NAVIGATION_EVENT_TYPE,
+    PERFORMANCE_RESOURCE_EVENT_TYPE,
+    PAGE_VIEW_EVENT_TYPE,
+    SESSION_START_EVENT_TYPE
+} from '../plugins/utils/constant';
+
+// Environment variables set through CLI command
+const ENDPOINT = process.env.ENDPOINT;
+const MONITOR_ID = process.env.MONITOR;
+const TEST_URL = process.env.URL || 'http://localhost:8080/smoke.html';
+
+const TARGET_URL = ENDPOINT + MONITOR_ID + '/';
+
+function getEventsByType(requestBody, eventType) {
+    return requestBody.RumEvents.filter((e) => e.type === eventType);
+}
+
+/**
+ * Returns true if the request is a successful PutRumEvents request
+ */
+function isDataPlaneRequest(response): boolean {
+    const request = response.request();
+    return (
+        request.method() === 'POST' &&
+        response.status() === 200 &&
+        response.url() === TARGET_URL
+    );
+}
+
+// Run the tests in parallel
+test.describe.configure({ mode: 'parallel' });
+
+test('when web client calls PutRumEvents then the response code is 200', async ({
+    page
+}) => {
+    // Open page
+    await page.goto(TEST_URL);
+
+    // Test will timeout if no successful dataplane request is found
+    await page.waitForResponse(async (response) =>
+        isDataPlaneRequest(response)
+    );
+});
+
+test('when web client calls PutRumEvents then the payload contains all events', async ({
+    page
+}) => {
+    // Expected number of events per type
+    const SESSION_START_COUNT = 1;
+    const PAGEVIEW_COUNT = 1;
+    const NAVIGATION_COUNT = 1;
+    const RESOURCE_EVENT_COUNT = 1;
+
+    // Open page
+    await page.goto(TEST_URL);
+
+    // Test will timeout if no successful dataplane request is found
+    const response = await page.waitForResponse(async (response) =>
+        isDataPlaneRequest(response)
+    );
+
+    // Parse payload to verify event count
+    const requestBody = JSON.parse(response.request().postData());
+
+    const session = getEventsByType(requestBody, SESSION_START_EVENT_TYPE);
+    const navigation = getEventsByType(
+        requestBody,
+        PERFORMANCE_NAVIGATION_EVENT_TYPE
+    );
+    const pageView = getEventsByType(requestBody, PAGE_VIEW_EVENT_TYPE);
+    const resource = getEventsByType(
+        requestBody,
+        PERFORMANCE_RESOURCE_EVENT_TYPE
+    );
+
+    // Verify no events are dropped
+    expect(session.length).toEqual(SESSION_START_COUNT);
+    expect(pageView.length).toEqual(PAGEVIEW_COUNT);
+    expect(navigation.length).toEqual(NAVIGATION_COUNT);
+    expect(resource.length).toEqual(RESOURCE_EVENT_COUNT);
+});

src/__smoke-test__/dataplane-integ.spec.ts

@@ -27,3 +27,6 @@ export const JS_ERROR_EVENT_TYPE = 'com.amazon.rum.js_error_event';
 
 // Page view event
 export const PAGE_VIEW_EVENT_TYPE = 'com.amazon.rum.page_view_event';
+
+// Session start event
+export const SESSION_START_EVENT_TYPE = 'com.amazon.rum.session_start_event';

src/plugins/utils/constant.ts

@@ -12,6 +12,7 @@
         "**/__tests__",
         "**/__integ__",
         "**/__mocks__",
+        "**/__smoke-test__",
         "src/index-browser.ts",
         "src/loader",
         "src/test-utils"

tsconfig.json

@@ -14,6 +14,7 @@
         "**/__tests__",
         "**/__integ__",
         "**/__mocks__",
+        "**/__smoke-test__",
         "src/index.ts",
         "src/loader",
         "src/test-utils"