@aws-amplify/core 4.4.1 → 4.4.2-api-logging.2

package/src/Providers/APIProvider/loggerConnectivity.ts

@@ -0,0 +1,49 @@
+import Observable, { ZenObservable } from 'zen-observable-ts';
+import { ReachabilityMonitor } from './LoggerReachability';
+
+type ConnectionStatus = {
+	online: boolean;
+};
+
+// TODO: refactor this to a singleton that supports numerous observers
+export default class LoggerConnectivity {
+	private connectionStatus: ConnectionStatus;
+	private observer: ZenObservable.SubscriptionObserver<ConnectionStatus>;
+	private subscription: ZenObservable.Subscription;
+	private timeout: ReturnType<typeof setTimeout>;
+	constructor() {
+		this.connectionStatus = {
+			online: false,
+		};
+	}
+
+	status(): Observable<ConnectionStatus> {
+		if (this.observer) {
+			throw new Error('Subscriber already exists');
+		}
+		return new Observable(observer => {
+			this.observer = observer;
+
+			this.subscription = ReachabilityMonitor.subscribe(({ online }) => {
+				this.connectionStatus.online = online;
+
+				const observerResult = { ...this.connectionStatus };
+
+				observer.next(observerResult);
+			});
+
+			return () => {
+				clearTimeout(this.timeout);
+				this.unsubscribe();
+			};
+		});
+	}
+
+	unsubscribe() {
+		if (this.subscription) {
+			clearTimeout(this.timeout);
+			this.subscription.unsubscribe();
+			this.observer = undefined;
+		}
+	}
+}

package/src/Providers/index.ts

@@ -1 +1,2 @@
 export * from './AWSCloudWatchProvider';
+export { APILoggingProvider } from './APIProvider';

package/src/Util/Constants.ts

@@ -22,6 +22,8 @@ const RETRY_ERROR_CODES = [
 	'ResourceNotFoundException',
 	'InvalidSequenceTokenException',
 ];
+const API_LOGGING_PROVIDER_NAME = 'API';
+const API_LOGGING_PROVIDER_CATEGORY = 'Logging';
 
 export {
 	AWS_CLOUDWATCH_BASE_BUFFER_SIZE,
@@ -31,4 +33,6 @@ export {
 	AWS_CLOUDWATCH_PROVIDER_NAME,
 	NO_CREDS_ERROR_STRING,
 	RETRY_ERROR_CODES,
+	API_LOGGING_PROVIDER_NAME,
+	API_LOGGING_PROVIDER_CATEGORY,
 };

package/src/Util/Reachability.ts

@@ -1,4 +1,4 @@
-import { browserOrNode, isWebWorker } from '@aws-amplify/core';
+import { browserOrNode, isWebWorker } from '../JS';
 import Observable, { ZenObservable } from 'zen-observable-ts';
 
 type NetworkStatus = {
@@ -32,9 +32,10 @@ export default class ReachabilityNavigator implements Reachability {
 				globalObj.removeEventListener('online', notifyOnline);
 				globalObj.removeEventListener('offline', notifyOffline);
 
-				ReachabilityNavigator._observers = ReachabilityNavigator._observers.filter(
-					_observer => _observer !== observer
-				);
+				ReachabilityNavigator._observers =
+					ReachabilityNavigator._observers.filter(
+						_observer => _observer !== observer
+					);
 			};
 		});
 	}
@@ -43,9 +44,10 @@ export default class ReachabilityNavigator implements Reachability {
 	private static _observerOverride(status: NetworkStatus): void {
 		for (const observer of ReachabilityNavigator._observers) {
 			if (observer.closed) {
-				ReachabilityNavigator._observers = ReachabilityNavigator._observers.filter(
-					_observer => _observer !== observer
-				);
+				ReachabilityNavigator._observers =
+					ReachabilityNavigator._observers.filter(
+						_observer => _observer !== observer
+					);
 				continue;
 			}
 			observer.next(status);

package/src/Util/Retry.ts

@@ -1,6 +1,6 @@
 import { DelayFunction } from '../types';
 import { ConsoleLogger as Logger } from '../Logger/ConsoleLogger';
-const logger = new Logger('Util');
+const logger = new Logger('Retry');
 
 export class NonRetryableError extends Error {
 	public readonly nonRetryable = true;
@@ -30,7 +30,7 @@ export async function retry(
 	logger.debug(
 		`${
 			functionToRetry.name
-		} attempt #${attempt} with this vars: ${JSON.stringify(args)}`
+		} attempt #${attempt} with these vars: ${JSON.stringify(args)}`
 	);
 
 	try {

package/src/Util/StringUtils.ts

@@ -1,12 +1,8 @@
+import { browserOrNode } from '../../';
 export function urlSafeEncode(str: string) {
 	return str
 		.split('')
-		.map(char =>
-			char
-				.charCodeAt(0)
-				.toString(16)
-				.padStart(2, '0')
-		)
+		.map(char => char.charCodeAt(0).toString(16).padStart(2, '0'))
 		.join('');
 }
 
@@ -16,3 +12,16 @@ export function urlSafeDecode(hex: string) {
 		.map(char => String.fromCharCode(parseInt(char, 16)))
 		.join('');
 }
+export const getStringByteSize = (str: string): number => {
+	if (browserOrNode().isBrowser || Blob !== undefined) {
+		return new Blob([str]).size;
+	}
+
+	if (Buffer !== undefined) {
+		return Buffer.byteLength(str, 'utf8');
+	}
+
+	throw new Error(
+		'Cannot compute string length. Blob and Buffer are undefined'
+	);
+};

package/src/types/types.ts

@@ -1,62 +1,88 @@
-import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
-import { Credentials } from '@aws-sdk/types';
-
-export interface AmplifyConfig {
-	Analytics?: object;
-	Auth?: object;
-	API?: object;
-	Logging?: object;
-	Storage?: object;
-	Cache?: object;
-	Geo?: object;
-	ssr?: boolean;
-}
-
-export interface ICredentials {
-	accessKeyId: string;
-	sessionToken: string;
-	secretAccessKey: string;
-	identityId: string;
-	authenticated: boolean;
-	// Long term creds do not provide an expiration date
-	expiration?: Date;
-}
-
-/**
- * @private
- * Internal use of Amplify only
- */
-
-export type DelayFunction = (
-	attempt: number,
-	args?: any[],
-	error?: Error
-) => number | false;
-
-export interface LoggingProvider {
-	// return the name of you provider
-	getProviderName(): string;
-
-	// return the name of you category
-	getCategoryName(): string;
-
-	// configure the plugin
-	configure(config?: object): object;
-
-	// take logs and push to provider
-	pushLogs(logs: InputLogEvent[]): void;
-}
-
-export interface AWSCloudWatchProviderOptions {
-	logGroupName?: string;
-	logStreamName?: string;
-	region?: string;
-	credentials?: Credentials;
-	endpoint?: string;
-}
-
-export interface CloudWatchDataTracker {
-	eventUploadInProgress: boolean;
-	logEvents: InputLogEvent[];
-	verifiedLogGroup?: LogGroup;
-}
+import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
+import { Credentials } from '@aws-sdk/types';
+import { LOG_TYPE } from '../Logger/ConsoleLogger';
+export interface AmplifyConfig {
+	Analytics?: object;
+	Auth?: object;
+	API?: object;
+	Logging?: object;
+	Storage?: object;
+	Cache?: object;
+	Geo?: object;
+	ssr?: boolean;
+}
+
+export interface ICredentials {
+	accessKeyId: string;
+	sessionToken: string;
+	secretAccessKey: string;
+	identityId: string;
+	authenticated: boolean;
+	// Long term creds do not provide an expiration date
+	expiration?: Date;
+}
+
+/**
+ * @private
+ * Internal use of Amplify only
+ */
+
+export type DelayFunction = (
+	attempt: number,
+	args?: any[],
+	error?: Error
+) => number | false;
+
+export interface LoggingProvider {
+	// return the name of you provider
+	getProviderName(): string;
+
+	// return the name of you category
+	getCategoryName(): string;
+
+	// configure the plugin
+	configure(config?: object): object;
+
+	// take logs and push to provider
+	pushLogs?(logs: InputLogEvent[]): void;
+
+	// push a single log event
+	pushLog?(log: GenericLogEvent): void;
+}
+
+export interface AWSCloudWatchProviderOptions {
+	logGroupName?: string;
+	logStreamName?: string;
+	region?: string;
+	credentials?: Credentials;
+	endpoint?: string;
+}
+
+export interface CloudWatchDataTracker {
+	eventUploadInProgress: boolean;
+	logEvents: InputLogEvent[];
+	verifiedLogGroup?: LogGroup;
+}
+
+export interface APILoggingProviderOptions {
+	endpoint: string;
+	apiKey?: string;
+	enabled?: boolean;
+	level?: LOG_TYPE;
+	excludeClassList?: string[];
+	metadata?: { [key: string]: any };
+	eventFormat?: EVENT_FORMAT;
+	bufferInterval?: number;
+}
+
+export enum EVENT_FORMAT {
+	GENERIC = 'GENERIC',
+	CLOUDWATCH = 'CLOUDWATCH',
+}
+export interface GenericLogEvent {
+	level: string;
+	source: string;
+	timestamp: number;
+	message?: string;
+	data?: object;
+}