chore: add logger

Author: slawomirzaba

README.md

@@ -41,6 +41,8 @@ Wrap your app's root component with ContentpassSdkProvider. The provider require
 - `planId` - The ID of the plan you want to check the user's subscription status against (ask Contentpass team for details)
 - `issuer` - The OAuth 2.0 server URL (e.g. `https://my.contentpass.net`)
 - `redirectUrl` - the redirect URL of your app to which the OAuth2 server will redirect after the authentication
+- `samplingRate` - Optional: The rate at which the SDK will send impression events for unauthenticated users. Default is 0.05 (5%)
+- `logLevel` - Optional: The log level for the SDK. By default logger is disabled. Possible values are 'info', 'warn', 'error' and 'debug'
 
 
 ```jsx
@@ -52,6 +54,8 @@ const contentpassConfig = {
   planId: 'plan-id',
   issuer: 'https://my.contentpass.net',
   redirectUrl: 'com.yourapp://oauthredirect',
+  samplingRate: 0.1,
+  logLevel: 'info'
 };
 
 const App = () => {

package.json

@@ -151,6 +151,7 @@
   },
   "dependencies": {
     "@sentry/react-native": "^6.3.0",
+    "react-native-logs": "^5.3.0",
     "react-native-uuid": "^2.0.3"
   }
 }

sharedExample/src/contentpassConfig.ts

@@ -14,4 +14,5 @@ export const contentpassConfig: ContentpassConfig = {
 
   samplingRate: 1,
   redirectUrl: 'de.contentpass.demo://oauth',
+  logLevel: 'debug',
 };

src/Contentpass.ts

@@ -19,6 +19,7 @@ import type { ContentpassConfig } from './types/ContentpassConfig';
 import { reportError, setSentryExtraAttribute } from './sentryIntegration';
 import sendStats from './countImpressionUtils/sendStats';
 import sendPageViewEvent from './countImpressionUtils/sendPageViewEvent';
+import logger, { enableLogger } from './logger';
 
 const DEFAULT_SAMPLING_RATE = 0.05;
 
@@ -47,10 +48,16 @@ export default class Contentpass implements ContentpassInterface {
   private refreshTimer: NodeJS.Timeout | null = null;
 
   constructor(config: ContentpassConfig) {
+    if (config.logLevel) {
+      enableLogger(config.logLevel);
+    }
+
+    logger.debug('Contentpass initialised with config', config);
     if (
       config.samplingRate &&
       (config.samplingRate < 0 || config.samplingRate > 1)
     ) {
+      logger.error('Sampling rate must be between 0 and 1');
       throw new Error('Sampling rate must be between 0 and 1');
     }
     this.samplingRate = config.samplingRate || DEFAULT_SAMPLING_RATE;
@@ -62,6 +69,7 @@ export default class Contentpass implements ContentpassInterface {
   }
 
   public authenticate = async (): Promise<void> => {
+    logger.info('Starting authentication flow');
     let result: AuthorizeResult;
 
     try {
@@ -86,11 +94,13 @@ export default class Contentpass implements ContentpassInterface {
 
       throw err;
     }
+    logger.info('Authentication flow finished, checking subscription...');
 
     await this.onNewAuthState(result);
   };
 
   public registerObserver(observer: ContentpassObserver) {
+    logger.info('Registering observer');
     if (this.contentpassStateObservers.includes(observer)) {
       return;
     }
@@ -100,12 +110,14 @@ export default class Contentpass implements ContentpassInterface {
   }
 
   public unregisterObserver(observer: ContentpassObserver) {
+    logger.info('Unregistering observer');
     this.contentpassStateObservers = this.contentpassStateObservers.filter(
       (o) => o !== observer
     );
   }
 
   public logout = async () => {
+    logger.info('Logging out and clearing auth state');
     await this.authStateStorage.clearOidcAuthState();
     this.changeContentpassState({
       state: ContentpassStateType.UNAUTHENTICATED,
@@ -114,6 +126,7 @@ export default class Contentpass implements ContentpassInterface {
   };
 
   public recoverFromError = async () => {
+    logger.info('Recovering from error');
     this.changeContentpassState({
       state: ContentpassStateType.INITIALISING,
     });
@@ -138,6 +151,7 @@ export default class Contentpass implements ContentpassInterface {
   };
 
   private countPaidImpression = async () => {
+    logger.info('Counting paid impression');
     const impressionId = uuid.v4();
 
     await sendPageViewEvent(this.config.apiUrl, {
@@ -155,6 +169,7 @@ export default class Contentpass implements ContentpassInterface {
       return;
     }
 
+    logger.info('Counting sampled impression');
     await sendStats(this.config.apiUrl, {
       ea: 'load',
       ec: 'tcf-sampled',
@@ -167,38 +182,49 @@ export default class Contentpass implements ContentpassInterface {
   private initialiseAuthState = async () => {
     const authState = await this.authStateStorage.getOidcAuthState();
     if (authState) {
+      logger.debug('Found auth state in storage, initialising with it');
       await this.onNewAuthState(authState);
       return;
     }
 
+    logger.debug(
+      'No auth state found in storage, initialising unauthenticated'
+    );
     this.changeContentpassState({
       state: ContentpassStateType.UNAUTHENTICATED,
       hasValidSubscription: false,
     });
   };
 
   private onNewAuthState = async (authState: OidcAuthState) => {
+    logger.debug('New auth state received');
     this.oidcAuthState = authState;
     await this.authStateStorage.storeOidcAuthState(authState);
 
     const strategy = this.setupRefreshTimer();
     // if instant refresh, no need to check subscription as it will happen in the refresh
     if (strategy === RefreshTokenStrategy.INSTANTLY) {
+      logger.debug('Instant refresh, skipping subscription check');
       return;
     }
 
     try {
+      logger.info('Checking subscription');
       const contentpassToken = await fetchContentpassToken({
         issuer: this.config.issuer,
         propertyId: this.config.propertyId,
         idToken: this.oidcAuthState.idToken,
       });
       const hasValidSubscription = validateSubscription(contentpassToken);
+      logger.info({ hasValidSubscription }, 'Subscription check successful');
       this.changeContentpassState({
         state: ContentpassStateType.AUTHENTICATED,
         hasValidSubscription,
       });
     } catch (err: any) {
+      reportError(err, {
+        msg: 'Failed to fetch contentpass token and validate subscription',
+      });
       this.changeContentpassState({
         state: ContentpassStateType.ERROR,
         error: err,
@@ -211,13 +237,15 @@ export default class Contentpass implements ContentpassInterface {
       this.oidcAuthState?.accessTokenExpirationDate;
 
     if (!accessTokenExpirationDate) {
+      logger.warn('No access token expiration date provided');
       return RefreshTokenStrategy.NO_REFRESH;
     }
 
     const now = new Date();
     const expirationDate = new Date(accessTokenExpirationDate);
     const timeDiff = expirationDate.getTime() - now.getTime();
     if (timeDiff <= 0) {
+      logger.debug('Access token expired, refreshing instantly');
       this.refreshToken(0);
       return RefreshTokenStrategy.INSTANTLY;
     }
@@ -226,6 +254,7 @@ export default class Contentpass implements ContentpassInterface {
       clearTimeout(this.refreshTimer);
     }
 
+    logger.debug({ timeDiff }, 'Setting up refresh timer');
     this.refreshTimer = setTimeout(async () => {
       await this.refreshToken(0);
     }, timeDiff);
@@ -240,6 +269,7 @@ export default class Contentpass implements ContentpassInterface {
     }
 
     try {
+      logger.info('Refreshing token');
       const refreshResult = await refresh(
         {
           clientId: this.config.propertyId,
@@ -252,23 +282,26 @@ export default class Contentpass implements ContentpassInterface {
         }
       );
       await this.onNewAuthState(refreshResult);
+      logger.info('Token refreshed successfully');
     } catch (err: any) {
       await this.onRefreshTokenError(counter, err);
     }
   };
 
   private onRefreshTokenError = async (counter: number, err: Error) => {
-    reportError(err, {
-      msg: `Failed to refresh token after ${counter} retries`,
-    });
     // FIXME: add handling for specific error to not retry in every case
     if (counter < REFRESH_TOKEN_RETRIES) {
+      logger.warn({ err, counter }, 'Failed to refresh token, retrying');
       const delay = counter * 1000 * 10;
       await new Promise((resolve) => setTimeout(resolve, delay));
       await this.refreshToken(counter + 1);
       return;
     }
 
+    reportError(err, {
+      msg: `Failed to refresh token after ${counter} retries`,
+    });
+
     await this.logout();
   };
 

src/logger.ts

@@ -0,0 +1,24 @@
+import { consoleTransport, logger } from 'react-native-logs';
+import type { Severity } from './types/ContentpassConfig';
+
+const log = logger.createLogger({
+  // by default loggger is disabled
+  enabled: false,
+  transport: consoleTransport,
+  transportOptions: {
+    colors: {
+      info: 'blueBright',
+      warn: 'yellowBright',
+      error: 'redBright',
+    },
+  },
+});
+
+export const enableLogger = (severity: Severity) => {
+  log.setSeverity(severity);
+  log.enable();
+
+  log.debug('Logger enabled with severity', severity);
+};
+
+export default log;

src/sentryIntegration.ts

@@ -1,6 +1,7 @@
 import * as Sentry from '@sentry/react-native';
 import { defaultStackParser, makeFetchTransport } from '@sentry/react';
 import { getDefaultIntegrations } from '@sentry/react-native/dist/js/integrations/default';
+import logger from './logger';
 
 // as it's only the open source package, we want to have minimal sentry configuration here to not override sentry instance,
 // which can be used in the application
@@ -43,6 +44,7 @@ type ReportErrorOptions = {
 };
 
 export const reportError = (err: Error, { msg }: ReportErrorOptions = {}) => {
+  logger.error({ err }, msg || 'Unexpected error');
   if (msg) {
     sentryScope.addBreadcrumb({
       category: 'Error',

src/types/ContentpassConfig.ts

@@ -1,10 +1,13 @@
 /* istanbul ignore file */
 
+export type Severity = 'debug' | 'info' | 'warn' | 'error';
+
 export type ContentpassConfig = {
   propertyId: string;
   planId: string;
   redirectUrl: string;
   issuer: string;
   apiUrl: string;
   samplingRate?: number;
+  logLevel?: Severity;
 };

yarn.lock

@@ -1844,6 +1844,7 @@ __metadata:
     react-native-app-auth: ^8.0.0
     react-native-builder-bob: ^0.32.1
     react-native-encrypted-storage: ^4.0.3
+    react-native-logs: ^5.3.0
     react-native-uuid: ^2.0.3
     react-test-renderer: 18.3.1
     release-it: ^17.10.0
@@ -12588,6 +12589,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"react-native-logs@npm:^5.3.0":
+  version: 5.3.0
+  resolution: "react-native-logs@npm:5.3.0"
+  checksum: b7fa58007e737fe337fbd664529054cfe71a1fa8f2f4cf50621ffca0f50b44f70dcb7d37f3222093c7b36a287a79b00f1b84d243fb15dc67650c72b6c514343a
+  languageName: node
+  linkType: hard
+
 "react-native-uuid@npm:^2.0.3":
   version: 2.0.3
   resolution: "react-native-uuid@npm:2.0.3"