chore(notifications): enable eslint and remove telint (#13091)

* chore(notifications): enable eslint and remove telint * chore(notifications): run yarn lint:fix * chore(notifications): manual fix of linter reported errors * apply suggestions * fix lint regressions caused by rebasing
aws-amplify · Mar 20, 2024 · 1a6d358 · 1a6d358
1 parent f6055cb
commit 1a6d358
Show file tree

Hide file tree

Showing 61 changed files with 208 additions and 155 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -50,7 +50,7 @@ module.exports = {
 		'packages/datastore-storage-adapter',
 		// 'packages/geo',
 		// 'packages/interactions',
-		'packages/notifications',
+		// 'packages/notifications',
 		// 'packages/predictions',
 		// 'packages/pubsub',
 		// 'packages/react-native',

diff --git a/...ts__/pushNotifications/providers/pinpoint/apis/initializePushNotifications.native.test.ts b/...ts__/pushNotifications/providers/pinpoint/apis/initializePushNotifications.native.test.ts
@@ -47,7 +47,7 @@ const mockGetConstants = jest.fn();
 const mockRegisterHeadlessTask = jest.fn();
 
 describe('initializePushNotifications (native)', () => {
-	let initializePushNotifications;
+	let initializePushNotifications: () => void;
 	const { NativeEvent } = pushModuleConstants;
 	// create mocks
 	const mockEventListenerRemover = { remove: jest.fn() };

diff --git a/packages/notifications/jest.config.js b/packages/notifications/jest.config.js
@@ -3,7 +3,7 @@ module.exports = {
 	coverageThreshold: {
 		global: {
 			branches: 73,
-			functions: 90,
+			functions: 89,
 			lines: 91,
 			statements: 92,
 		},

diff --git a/packages/notifications/package.json b/packages/notifications/package.json
@@ -21,7 +21,8 @@
 		"clean": "npm run clean:size && rimraf dist lib lib-esm",
 		"clean:size": "rimraf dual-publish-tmp tmp*",
 		"format": "echo \"Not implemented\"",
-		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
+		"lint": "eslint '**/*.{ts,tsx}' && npm run ts-coverage",
+		"lint:fix": "eslint '**/*.{ts,tsx}' --fix",
 		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.21"
 	},
 	"typesVersions": {

diff --git a/packages/notifications/src/eventListeners/eventListeners.ts b/packages/notifications/src/eventListeners/eventListeners.ts
@@ -1,9 +1,17 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { EventListener, EventListenerRemover, EventType } from './types';
+import {
+	EventListener,
+	EventListenerHandler,
+	EventListenerRemover,
+	EventType,
+} from './types';
 
-const eventListeners: Record<string, Set<EventListener<Function>>> = {};
+const eventListeners: Record<
+	string,
+	Set<EventListener<EventListenerHandler>>
+> = {};
 
 export const notifyEventListeners = (type: EventType, ...args: any[]): void => {
 	eventListeners[type]?.forEach(listener => {
@@ -17,15 +25,11 @@ export const notifyEventListenersAndAwaitHandlers = (
 ): Promise<void[]> =>
 	Promise.all<void>(
 		Array.from(eventListeners[type] ?? []).map(async listener => {
-			try {
-				await listener.handleEvent(...args);
-			} catch (err) {
-				throw err;
-			}
+			await listener.handleEvent(...args);
 		}),
 	);
 
-export const addEventListener = <EventHandler extends Function>(
+export const addEventListener = <EventHandler extends EventListenerHandler>(
 	type: EventType,
 	handler: EventHandler,
 ): EventListenerRemover => {
@@ -40,7 +44,10 @@ export const addEventListener = <EventHandler extends Function>(
 		},
 	};
 	eventListeners[type].add(listener);
+
 	return {
-		remove: () => listener.remove(),
+		remove: () => {
+			listener.remove();
+		},
 	};
 };
diff --git a/packages/notifications/src/eventListeners/types.ts b/packages/notifications/src/eventListeners/types.ts
@@ -4,13 +4,15 @@
 import { InAppMessageInteractionEvent } from '../inAppMessaging/types';
 import { PushNotificationEvent } from '../pushNotifications/types';
 
-export interface EventListener<EventHandler extends Function> {
+export type EventListenerHandler = (...args: any[]) => unknown;
+
+export interface EventListener<EventHandler extends EventListenerHandler> {
 	handleEvent: EventHandler;
-	remove: () => void;
+	remove(): void;
 }
 
 export type EventType = InAppMessageInteractionEvent | PushNotificationEvent;
 
-export type EventListenerRemover = {
-	remove: () => void;
-};
+export interface EventListenerRemover {
+	remove(): void;
+}
diff --git a/packages/notifications/src/inAppMessaging/errors/assertServiceError.ts b/packages/notifications/src/inAppMessaging/errors/assertServiceError.ts
@@ -5,6 +5,7 @@ import {
 	AmplifyErrorCode,
 	ServiceError,
 } from '@aws-amplify/core/internals/utils';
+
 import { InAppMessagingError } from './InAppMessagingError';
 
 export function assertServiceError(

diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/clearMessages.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/clearMessages.ts
@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { defaultStorage } from '@aws-amplify/core';
-import { STORAGE_KEY_SUFFIX, PINPOINT_KEY_PREFIX } from '../utils';
 
+import { PINPOINT_KEY_PREFIX, STORAGE_KEY_SUFFIX } from '../utils';
 import { InAppMessagingValidationErrorCode } from '../../../errors';
 import { assertIsInitialized } from '../../../utils';
 
@@ -22,5 +22,6 @@ import { assertIsInitialized } from '../../../utils';
 export async function clearMessages(): Promise<void> {
 	assertIsInitialized();
 	const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;
-	return await defaultStorage.removeItem(key);
+
+	await defaultStorage.removeItem(key);
 }
diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/dispatchEvent.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/dispatchEvent.ts
@@ -5,7 +5,10 @@ import flatten from 'lodash/flatten.js';
 import { defaultStorage } from '@aws-amplify/core';
 
 import { notifyEventListeners } from '../../../../eventListeners';
-import { assertServiceError } from '../../../errors';
+import {
+	InAppMessagingValidationErrorCode,
+	assertServiceError,
+} from '../../../errors';
 import { InAppMessage } from '../../../types';
 import { assertIsInitialized } from '../../../utils';
 import { DispatchEventInput } from '../types';
@@ -15,6 +18,7 @@ import {
 	getConflictHandler,
 	processInAppMessages,
 } from '../utils';
+
 import { syncMessages } from './syncMessages';
 import { setConflictHandler } from './setConflictHandler';
 

diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/identifyUser.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/identifyUser.ts
@@ -3,9 +3,10 @@
 
 import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import {
-	updateEndpoint,
 	UpdateEndpointException,
+	updateEndpoint,
 } from '@aws-amplify/core/internals/providers/pinpoint';
+
 import { InAppMessagingValidationErrorCode } from '../../../errors';
 import {
 	CATEGORY,
@@ -22,7 +23,7 @@ import { assertIsInitialized } from '../../../utils';
  * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
  * the same `userId`.
  *
- * @param {IdentifyUserParameters} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ * @param input The input object that conforms to {@link IdentifyUserInput} used to construct requests sent to Pinpoint's UpdateEndpoint
  *  API.
  * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
  * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
@@ -66,11 +67,8 @@ import { assertIsInitialized } from '../../../utils';
  *     },
  * });
  */
-export const identifyUser = async ({
-	userId,
-	userProfile,
-	options,
-}: IdentifyUserInput): Promise<void> => {
+export const identifyUser = async (input: IdentifyUserInput): Promise<void> => {
+	const { userId, userProfile, options } = input;
 	assertIsInitialized();
 	const { credentials, identityId } = await resolveCredentials();
 	const { appId, region } = resolveConfig();

diff --git a/...ages/notifications/src/inAppMessaging/providers/pinpoint/apis/initializeInAppMessaging.ts b/...ages/notifications/src/inAppMessaging/providers/pinpoint/apis/initializeInAppMessaging.ts
@@ -2,14 +2,16 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { sessionListener } from '@aws-amplify/core/internals/utils';
+import { Hub, HubCapsule } from '@aws-amplify/core';
+
 import { InAppMessage, InAppMessagingEvent } from '../../../types';
 import { addEventListener } from '../../../../eventListeners';
 import { recordAnalyticsEvent } from '../utils/helpers';
 import { PinpointMessageEvent } from '../types';
-import { Hub, HubCapsule } from '@aws-amplify/core';
-import { dispatchEvent } from './dispatchEvent';
 import { incrementMessageCounts, sessionStateChangeHandler } from '../utils';
-import { isInitialized, initialize } from '../../../utils';
+import { initialize, isInitialized } from '../../../utils';
+
+import { dispatchEvent } from './dispatchEvent';
 
 /**
  * Initialize and set up in-app messaging category. This API needs to be called to enable other InAppMessaging APIs.

diff --git a/...ages/notifications/src/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.ts b/...ages/notifications/src/inAppMessaging/providers/pinpoint/apis/notifyMessageInteraction.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { notifyEventListeners } from '../../../../eventListeners';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
 import { assertIsInitialized } from '../../../utils';
 import { NotifyMessageInteractionInput } from '../types/inputs';
 

diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageActionTaken.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageActionTaken.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { addEventListener } from '../../../../eventListeners';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
 import { assertIsInitialized } from '../../../utils';
 import { OnMessageActionTakenInput } from '../types/inputs';
 import { OnMessageActionTakenOutput } from '../types/outputs';
@@ -25,5 +26,6 @@ export function onMessageActionTaken(
 	input: OnMessageActionTakenInput,
 ): OnMessageActionTakenOutput {
 	assertIsInitialized();
+
 	return addEventListener('messageActionTaken', input);
 }
diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageDismissed.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageDismissed.ts
@@ -5,6 +5,7 @@ import { addEventListener } from '../../../../eventListeners';
 import { OnMessageDismissedOutput } from '../types/outputs';
 import { OnMessageDismissedInput } from '../types/inputs';
 import { assertIsInitialized } from '../../../utils';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
 
 /**
  * Registers a callback that will be invoked on `messageDismissed` events.
@@ -25,5 +26,6 @@ export function onMessageDismissed(
 	input: OnMessageDismissedInput,
 ): OnMessageDismissedOutput {
 	assertIsInitialized();
+
 	return addEventListener('messageDismissed', input);
 }
diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageDisplayed.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageDisplayed.ts
@@ -5,14 +5,15 @@ import { addEventListener } from '../../../../eventListeners';
 import { OnMessageDisplayedOutput } from '../types/outputs';
 import { OnMessageDisplayedInput } from '../types/inputs';
 import { assertIsInitialized } from '../../../utils';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
 
 /**
  * Registers a callback that will be invoked on `messageDisplayed` events.
  *
  * @param {OnMessageDisplayedInput} input - The input object that holds the callback handler.
  * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown when the provided parameters or library
  * configuration is incorrect, or if In App messaging hasn't been initialized.
- * @returns {OnMessageDismissedOutput} - An object that holds a remove method to stop listening to events.
+ * @returns {OnMessageDisplayedOutput} - An object that holds a remove method to stop listening to events.
  * @example
  * ```ts
  * onMessageDisplayed((message) => {
@@ -25,5 +26,6 @@ export function onMessageDisplayed(
 	input: OnMessageDisplayedInput,
 ): OnMessageDisplayedOutput {
 	assertIsInitialized();
+
 	return addEventListener('messageDisplayed', input);
 }
diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageReceived.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/onMessageReceived.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { addEventListener } from '../../../../eventListeners';
+import { InAppMessagingValidationErrorCode } from '../../../errors';
 import { assertIsInitialized } from '../../../utils';
 import { OnMessageReceivedInput } from '../types/inputs';
 import { OnMessageReceivedOutput } from '../types/outputs';
@@ -25,5 +26,6 @@ export function onMessageReceived(
 	input: OnMessageReceivedInput,
 ): OnMessageReceivedOutput {
 	assertIsInitialized();
+
 	return addEventListener('messageReceived', input);
 }
diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/setConflictHandler.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/setConflictHandler.ts
@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { InAppMessagingValidationErrorCode } from '../../../errors';
 import { assertIsInitialized } from '../../../utils';
 import { SetConflictHandlerInput } from '../types';
 import { setConflictHandler as setConflictHandlerInteral } from '../utils';

diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/syncMessages.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/apis/syncMessages.ts
@@ -5,19 +5,20 @@ import { InAppMessagingAction } from '@aws-amplify/core/internals/utils';
 import { resolveEndpointId } from '@aws-amplify/core/internals/providers/pinpoint';
 import { defaultStorage } from '@aws-amplify/core';
 import {
-	resolveConfig,
-	resolveCredentials,
-	getInAppMessagingUserAgentString,
-	STORAGE_KEY_SUFFIX,
-	PINPOINT_KEY_PREFIX,
-	CATEGORY,
-	CHANNEL_TYPE,
-} from '../utils';
-import {
-	getInAppMessages,
 	GetInAppMessagesInput,
 	GetInAppMessagesOutput,
+	getInAppMessages,
 } from '@aws-amplify/core/internals/aws-clients/pinpoint';
+
+import {
+	CATEGORY,
+	CHANNEL_TYPE,
+	PINPOINT_KEY_PREFIX,
+	STORAGE_KEY_SUFFIX,
+	getInAppMessagingUserAgentString,
+	resolveConfig,
+	resolveCredentials,
+} from '../utils';
 import {
 	InAppMessagingValidationErrorCode,
 	assertServiceError,
@@ -80,6 +81,7 @@ async function fetchInAppMessages() {
 		);
 		const { InAppMessageCampaigns: messages } =
 			response.InAppMessagesResponse ?? {};
+
 		return messages;
 	} catch (error) {
 		assertServiceError(error);

diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/types/inputs.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/types/inputs.ts
@@ -1,18 +1,19 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { IdentifyUserOptions } from './options';
-import {
-	InAppMessageConflictHandler,
-	OnMessageInteractionEventHandler,
-} from './types';
 import {
 	InAppMessage,
 	InAppMessageInteractionEvent,
 	InAppMessagingEvent,
 	InAppMessagingIdentifyUserInput,
 } from '../../../types';
 
+import { IdentifyUserOptions } from './options';
+import {
+	InAppMessageConflictHandler,
+	OnMessageInteractionEventHandler,
+} from './types';
+
 /**
  * Input type for Pinpoint identifyUser API.
  */
@@ -52,7 +53,7 @@ export type OnMessageActionTakenInput = OnMessageInteractionEventHandler;
 /**
  * Input type for NotifyMessageInteraction API.
  */
-export type NotifyMessageInteractionInput = {
+export interface NotifyMessageInteractionInput {
 	message: InAppMessage;
 	type: InAppMessageInteractionEvent;
-};
+}
diff --git a/packages/notifications/src/inAppMessaging/providers/pinpoint/types/types.ts b/packages/notifications/src/inAppMessaging/providers/pinpoint/types/types.ts
@@ -5,16 +5,16 @@ import { InAppMessage } from '../../../types';
 
 export type InAppMessageCountMap = Record<string, number>;
 
-export type DailyInAppMessageCounter = {
+export interface DailyInAppMessageCounter {
 	count: number;
 	lastCountTimestamp: string;
-};
+}
 
-export type InAppMessageCounts = {
+export interface InAppMessageCounts {
 	sessionCount: number;
 	dailyCount: number;
 	totalCount: number;
-};
+}
 
 export type MetricsComparator = (
 	metricsVal: number,