chore: Fix test suite linter warnings (#165)

aws-observability · May 24, 2022 · ae60f2a · ae60f2a
1 parent 3269b13
commit ae60f2a
Show file tree

Hide file tree

Showing 23 changed files with 146 additions and 142 deletions.
diff --git a/package.json b/package.json
@@ -32,7 +32,7 @@
         "build:dev": "npm-run-all -s build build:webpack:dev",
         "release": "npm run build",
         "version": "standard-version",
-        "lint": "npx tslint --config ./tslint.json --project ./tsconfig.webpack.json --format verbose",
+        "lint": "npx tslint --config ./tslint.json --project ./tsconfig.json --format verbose",
         "lint:fix": "npm run lint -- --fix",
         "prettier": "npx prettier --check .",
         "prettier:fix": "npm run prettier -- --write",

diff --git a/src/__integ__/cookiesDisabled.test.ts b/src/__integ__/cookiesDisabled.test.ts
@@ -19,7 +19,7 @@ test('when cookies are disabled, no session start event is dispatched', async (t
 
     const json = JSON.parse(await REQUEST_BODY.textContent);
     const sessionStartEvents = json.RumEvents.filter(
-        (e) => e.eventType == SESSION_START_EVENT_TYPE
+        (e) => e.eventType === SESSION_START_EVENT_TYPE
     );
 
     await t.expect(sessionStartEvents.length).eql(0);

diff --git a/src/__integ__/cookiesEnabled.test.ts b/src/__integ__/cookiesEnabled.test.ts
@@ -18,7 +18,7 @@ test('when page is re-loaded with cookies enabled, session start is not dispatch
 
     const jsonA = JSON.parse(await REQUEST_BODY.textContent);
     const sessionStartEventsA = jsonA.RumEvents.filter(
-        (e) => e.type == SESSION_START_EVENT_TYPE
+        (e) => e.type === SESSION_START_EVENT_TYPE
     );
 
     await t
@@ -35,7 +35,7 @@ test('when page is re-loaded with cookies enabled, session start is not dispatch
 
     const jsonB = JSON.parse(await REQUEST_BODY.textContent);
     const sessionStartEventsB = jsonB.RumEvents.filter(
-        (e) => e.type == SESSION_START_EVENT_TYPE
+        (e) => e.type === SESSION_START_EVENT_TYPE
     );
 
     await t.expect(sessionStartEventsB.length).eql(0);
@@ -52,7 +52,7 @@ test('when page is loaded with cookies enabled, session start includes meta data
 
     const json = JSON.parse(await REQUEST_BODY.textContent);
     const sessionStartEvents = json.RumEvents.filter(
-        (e) => e.type == SESSION_START_EVENT_TYPE
+        (e) => e.type === SESSION_START_EVENT_TYPE
     );
 
     const metaData = JSON.parse(sessionStartEvents[0].metadata);

diff --git a/src/__tests__/CommandQueue.test.ts b/src/__tests__/CommandQueue.test.ts
@@ -174,7 +174,7 @@ describe('CommandQueue tests', () => {
             expect.objectContaining({
                 dispatchInterval: 10 * 1000,
                 sessionSampleRate: 0.8,
-                enableRumClient: false //prefer snippet config
+                enableRumClient: false // prefer snippet config
             })
         );
     });

diff --git a/src/dispatch/__tests__/Authentication.test.ts b/src/dispatch/__tests__/Authentication.test.ts
@@ -1,3 +1,4 @@
+// tslint:disable:max-line-length
 import { Authentication } from '../Authentication';
 import { CRED_KEY } from '../../utils/constants';
 import { DEFAULT_CONFIG } from '../../test-utils/test-utils';
@@ -44,7 +45,6 @@ describe('Authentication tests', () => {
         localStorage.removeItem(CRED_KEY);
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is in localStorage then authentication chain retrieves credential from localStorage', async () => {
         // Init
         const expiration = new Date(Date.now() + 3600 * 1000);
@@ -80,7 +80,6 @@ describe('Authentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is corrupt then authentication chain retrieves credential from basic authflow', async () => {
         // Init
         const config = {
@@ -107,7 +106,6 @@ describe('Authentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is not in localStorage then authentication chain retrieves credential from basic authflow', async () => {
         // Init
         const auth = new Authentication({
@@ -131,7 +129,6 @@ describe('Authentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential expires then authentication chain retrieves credential from basic authflow', async () => {
         // Init
         const expiration = new Date(0);
@@ -168,7 +165,6 @@ describe('Authentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is retrieved from basic auth then next credential is retrieved from localStorage', async () => {
         // Init
         const expiration = new Date(Date.now() + 3600 * 1000);
@@ -267,7 +263,6 @@ describe('Authentication tests', () => {
         expect(auth.ChainAnonymousCredentialsProvider()).rejects.toEqual(e);
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is in member then authentication chain retrieves credential from member', async () => {
         // Init
         const expiration = new Date(Date.now() + 3600 * 1000);
@@ -305,7 +300,6 @@ describe('Authentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credentials expire in member variable then authentication chain retrieves credential from basic auth flow', async () => {
         // Init
         assumeRole

diff --git a/src/dispatch/__tests__/DataPlaneClient.test.ts b/src/dispatch/__tests__/DataPlaneClient.test.ts
@@ -1,3 +1,4 @@
+// tslint:disable:max-line-length
 import * as Utils from '../../test-utils/test-utils';
 import { BeaconHttpHandler } from '../BeaconHttpHandler';
 import { FetchHttpHandler } from '@aws-sdk/fetch-http-handler';
@@ -76,7 +77,7 @@ describe('DataPlaneClient tests', () => {
         expect(signedRequest.headers['X-Amz-Content-Sha256']).toEqual(
             '57bbd361f5c5ab66d7dafb33d6c8bf714bbb140300fad06145b8d66c388b5d43'
         );
-        expect(signedRequest.headers['authorization']).toEqual(
+        expect(signedRequest.headers.authorization).toEqual(
             'AWS4-HMAC-SHA256 Credential=abc123/19700101/us-west-2/rum/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=bf3acf587b119ab12f0f8a86bf12acf7c460eb037584feb0ab5574f297def947'
         );
     });

diff --git a/src/dispatch/__tests__/EnhancedAuthentication.test.ts b/src/dispatch/__tests__/EnhancedAuthentication.test.ts
@@ -1,3 +1,4 @@
+// tslint:disable:max-line-length
 import { CRED_KEY } from '../../utils/constants';
 import { Credentials } from '@aws-sdk/types';
 import { EnhancedAuthentication } from '../EnhancedAuthentication';
@@ -46,7 +47,6 @@ describe('EnhancedAuthentication tests', () => {
         localStorage.removeItem(CRED_KEY);
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is in localStorage then authentication chain retrieves credential from localStorage', async () => {
         // Init
         const expiration = new Date(Date.now() + 3600 * 1000);
@@ -82,7 +82,6 @@ describe('EnhancedAuthentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is corrupt then authentication chain retrieves credential from basic authflow', async () => {
         // Init
         const config = {
@@ -110,7 +109,6 @@ describe('EnhancedAuthentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is not in the store authentication chain retrieves credential from basic authflow', async () => {
         // Init
         const auth = new EnhancedAuthentication({
@@ -133,7 +131,6 @@ describe('EnhancedAuthentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential expires then authentication chain retrieves credentials from basic authflow', async () => {
         // Init
         const expiration = new Date(0);
@@ -170,7 +167,6 @@ describe('EnhancedAuthentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is retrieved from basic auth then next credential is retrieved from localStorage', async () => {
         // Init
         const expiration = new Date(Date.now() + 3600 * 1000);
@@ -236,7 +232,9 @@ describe('EnhancedAuthentication tests', () => {
         });
 
         // Assert
-        expect(auth.ChainAnonymousCredentialsProvider()).toThrowError;
+        expect((auth: EnhancedAuthentication) => {
+            auth.ChainAnonymousCredentialsProvider();
+        }).toThrowError();
     });
 
     test('when getId fails then throw an error', async () => {
@@ -254,10 +252,11 @@ describe('EnhancedAuthentication tests', () => {
         });
 
         // Assert
-        expect(auth.ChainAnonymousCredentialsProvider()).toThrowError;
+        expect((auth: EnhancedAuthentication) => {
+            auth.ChainAnonymousCredentialsProvider();
+        }).toThrowError();
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credential is in member then authentication chain retrieves credential from member', async () => {
         // Init
         const expiration = new Date(Date.now() + 3600 * 1000);
@@ -295,7 +294,6 @@ describe('EnhancedAuthentication tests', () => {
         );
     });
 
-    // tslint:disable-next-line:max-line-length
     test('when credentials expire in member variable then authentication chain retrieves credential from basic auth flow', async () => {
         // Init
         getCredentials

diff --git a/src/event-cache/__tests__/EventCache.test.ts b/src/event-cache/__tests__/EventCache.test.ts
@@ -12,7 +12,7 @@ const getSession = jest.fn(() => ({
     eventCount: 1
 }));
 const getUserId = jest.fn(() => 'b');
-const getAttributes = jest.fn(() => {});
+const getAttributes = jest.fn();
 const incrementSessionEventCount = jest.fn();
 jest.mock('../../sessions/SessionManager', () => ({
     SessionManager: jest.fn().mockImplementation(() => ({
@@ -304,7 +304,6 @@ describe('EventCache tests', () => {
             eventCount: 1
         }));
         const getUserId = jest.fn(() => 'b');
-        const getAttributes = jest.fn(() => {});
         const incrementSessionEventCount = jest.fn();
         (SessionManager as any).mockImplementation(() => ({
             getSession,
@@ -332,11 +331,10 @@ describe('EventCache tests', () => {
             return {
                 sessionId: 'a',
                 record: true,
-                eventCount: eventCount
+                eventCount
             };
         });
         const getUserId = jest.fn(() => 'b');
-        const getAttributes = jest.fn(() => {});
         const incrementSessionEventCount = jest.fn();
         (SessionManager as any).mockImplementation(() => ({
             getSession,
@@ -364,10 +362,9 @@ describe('EventCache tests', () => {
 
     test('when event limit is zero then recordEvent records all events', async () => {
         // Init
-        let eventCount = 0;
+        const eventCount = 0;
         const getSession = jest.fn(() => ({ sessionId: 'a', record: true }));
         const getUserId = jest.fn(() => 'b');
-        const getAttributes = jest.fn(() => {});
         const incrementSessionEventCount = jest.fn();
         (SessionManager as any).mockImplementation(() => ({
             getSession,

diff --git a/src/orchestration/__tests__/Orchestration.test.ts b/src/orchestration/__tests__/Orchestration.test.ts
@@ -1,3 +1,4 @@
+// tslint:disable:max-line-length
 import { Orchestration } from '../Orchestration';
 import { Dispatch } from '../../dispatch/Dispatch';
 import { EventCache } from '../../event-cache/EventCache';
@@ -26,7 +27,7 @@ jest.mock('../../event-cache/EventCache', () => ({
     EventCache: jest.fn().mockImplementation(() => ({
         enable: enableEventCache,
         disable: disableEventCache,
-        recordPageView: recordPageView
+        recordPageView
     }))
 }));
 
@@ -38,10 +39,10 @@ const disablePlugins = jest.fn();
 
 jest.mock('../../plugins/PluginManager', () => ({
     PluginManager: jest.fn().mockImplementation(() => ({
-        addPlugin: addPlugin,
+        addPlugin,
         enable: enablePlugins,
         disable: disablePlugins,
-        updatePlugin: updatePlugin
+        updatePlugin
     }))
 }));
 
@@ -186,7 +187,7 @@ describe('Orchestration tests', () => {
 
     test('data collection defaults to only page views', async () => {
         // Init
-        new Orchestration('a', 'c', 'us-east-1', {});
+        const orchestration = new Orchestration('a', 'c', 'us-east-1', {});
         const expected = ['com.amazonaws.rum.page-view'];
         const actual = [];
 
@@ -224,7 +225,7 @@ describe('Orchestration tests', () => {
 
     test('when a config is passed to the http data collection then the config is added as a constructor arg', async () => {
         // Init
-        new Orchestration('a', 'c', 'us-east-1', {
+        const orchestration = new Orchestration('a', 'c', 'us-east-1', {
             telemetries: [['http', { trace: true }]]
         });