@osano/osano-cmp-react-native 0.19.0 → 0.19.2

package/src/iab/tcf/iab-storage-utils.ts

@@ -29,27 +29,65 @@ export interface IABConsentData {
 	enableAdvertiserConsentMode?: boolean;
 }
 
-export const clearAllIABKeys = (): void => {
-	osanoLogger.info('🧹 Clearing all IAB consent keys...');
-
-	Object.values(IABKeys.LEGACY).forEach((key) => {
-		clearStorageFromDefault(key);
-	});
-
-	DEFAULT_STORAGE_KEYS.IABTCF.forEach((key) => {
-		clearStorageFromDefault(key);
-	});
-
-	CUSTOM_STORAGE_KEYS.forEach((key) => {
-		clearStorage(key);
-	});
-
-	osanoLogger.info(
-		'✅ All IAB consent keys cleared from both custom and default storage',
+let storageQueue = Promise.resolve();
+
+const enqueueStorageOperation = <T>(
+	operation: () => Promise<T>,
+): Promise<T> => {
+	const result = storageQueue.then(operation, operation);
+	storageQueue = result.then(
+		() => undefined,
+		(error) => {
+			osanoLogger.error(
+				`IAB storage operation failed: ${String(error)}`,
+				error instanceof Error ? error : undefined,
+			);
+		},
 	);
+	return result;
 };
 
-export const setAllIABKeys = (consentData: IABConsentData): void => {
+const enqueueSetStorage = (key: string, value: string) =>
+	enqueueStorageOperation(() => setStorage(key, value));
+
+const enqueueSetStorageToDefault = (key: string, value: string) =>
+	enqueueStorageOperation(() => setStorageToDefault(key, value));
+
+const enqueueSetIntStorageToDefault = (key: string, value: number) =>
+	enqueueStorageOperation(() => setIntStorageToDefault(key, value));
+
+export const clearAllIABKeys = (
+	additionalCustomKeys: string[] = [],
+): Promise<void> =>
+	enqueueStorageOperation(async () => {
+		osanoLogger.info('🧹 Clearing all IAB consent keys...');
+		const operations = [
+			...Object.values(IABKeys.LEGACY).map((key) =>
+				clearStorageFromDefault(key),
+			),
+			...DEFAULT_STORAGE_KEYS.IABTCF.map((key) => clearStorageFromDefault(key)),
+			...[...CUSTOM_STORAGE_KEYS, ...additionalCustomKeys].map((key) =>
+				clearStorage(key),
+			),
+		];
+		const failures = await Promise.all(
+			operations.map((operation) =>
+				operation.then(
+					() => ({ failed: false as const }),
+					(error: unknown) => ({ failed: true as const, error }),
+				),
+			),
+		);
+		const failure = failures.find((result) => result.failed);
+		if (failure?.failed) {
+			throw failure.error;
+		}
+		osanoLogger.info(
+			'✅ All IAB consent keys cleared from both custom and default storage',
+		);
+	});
+
+export const setAllIABKeys = (consentData: IABConsentData): Promise<void> => {
 	const {
 		tcString,
 		cmpId,
@@ -72,57 +110,66 @@ export const setAllIABKeys = (consentData: IABConsentData): void => {
 	const subjectToGDPR = gdprApplies ? '1' : '0';
 
 	// === Save to Custom Storage ===
-	setStorage(IABKeys.IABTCF.CMP_SDK_ID, cmpId.toString());
-	setStorage(IABKeys.IABTCF.CMP_SDK_VERSION, cmpVersion.toString());
-	setStorage(IABKeys.IABTCF.POLICY_VERSION, policyVersion);
-	setStorage(IABKeys.IABTCF.PUBLISHER_CC, publisherCC);
-	setStorage(IABKeys.IABTCF.GDPR_APPLIES, subjectToGDPR);
-	setStorage(
+	enqueueSetStorage(IABKeys.IABTCF.CMP_SDK_ID, cmpId.toString());
+	enqueueSetStorage(IABKeys.IABTCF.CMP_SDK_VERSION, cmpVersion.toString());
+	enqueueSetStorage(IABKeys.IABTCF.POLICY_VERSION, policyVersion);
+	enqueueSetStorage(IABKeys.IABTCF.PUBLISHER_CC, publisherCC);
+	enqueueSetStorage(IABKeys.IABTCF.GDPR_APPLIES, subjectToGDPR);
+	enqueueSetStorage(
 		IABKeys.IABTCF.PURPOSE_ONE_TREATMENT,
 		purposeOneTreatment ? '1' : '0',
 	);
-	setStorage(
+	enqueueSetStorage(
 		IABKeys.IABTCF.USE_NON_STANDARD_TEXTS,
 		useNonStandardStacks ? '1' : '0',
 	);
-	setStorage(IABKeys.IABTCF.VENDOR_CONSENTS, vendorConsentsString);
-	setStorage(
+	enqueueSetStorage(IABKeys.IABTCF.VENDOR_CONSENTS, vendorConsentsString);
+	enqueueSetStorage(
 		IABKeys.IABTCF.VENDOR_LEGITIMATE_INTERESTS,
 		vendorLegitimateInterestsString,
 	);
-	setStorage(IABKeys.IABTCF.PURPOSE_CONSENTS, purposeConsentsString);
-	setStorage(
+	enqueueSetStorage(IABKeys.IABTCF.PURPOSE_CONSENTS, purposeConsentsString);
+	enqueueSetStorage(
 		IABKeys.IABTCF.PURPOSE_LEGITIMATE_INTERESTS,
 		purposeLegitimateInterestsString,
 	);
-	setStorage(
+	enqueueSetStorage(
 		IABKeys.IABTCF.SPECIAL_FEATURES_OPT_INS,
 		specialFeatureOptinsString,
 	);
 
 	// === Save to Default Storage for AdMob Compatibility ===
 
-	setStorageToDefault(IABKeys.LEGACY.CMP_PRESENT, 'true');
-	setStorageToDefault(IABKeys.LEGACY.SUBJECT_TO_GDPR, subjectToGDPR);
-	setStorageToDefault(IABKeys.LEGACY.CONSENT_STRING, tcString);
-	setStorageToDefault(
+	enqueueSetStorageToDefault(IABKeys.LEGACY.CMP_PRESENT, 'true');
+	enqueueSetStorageToDefault(IABKeys.LEGACY.SUBJECT_TO_GDPR, subjectToGDPR);
+	enqueueSetStorageToDefault(IABKeys.LEGACY.CONSENT_STRING, tcString);
+	enqueueSetStorageToDefault(
 		IABKeys.LEGACY.PARSED_PURPOSE_CONSENTS,
 		purposeConsentsString,
 	);
-	setStorageToDefault(
+	enqueueSetStorageToDefault(
 		IABKeys.LEGACY.PARSED_VENDOR_CONSENTS,
 		vendorConsentsString,
 	);
 
-	setIntStorageToDefault(IABKeys.IABTCF.GDPR_APPLIES, gdprApplies ? 1 : 0);
-	setStorageToDefault(IABKeys.IABTCF.TC_STRING, tcString);
-	setStorageToDefault(IABKeys.IABTCF.PURPOSE_CONSENTS, purposeConsentsString);
-	setStorageToDefault(IABKeys.IABTCF.VENDOR_CONSENTS, vendorConsentsString);
-	setStorageToDefault(IABKeys.IABTCF.ADDTL_CONSENT, '');
+	enqueueSetIntStorageToDefault(
+		IABKeys.IABTCF.GDPR_APPLIES,
+		gdprApplies ? 1 : 0,
+	);
+	enqueueSetStorageToDefault(IABKeys.IABTCF.TC_STRING, tcString);
+	enqueueSetStorageToDefault(
+		IABKeys.IABTCF.PURPOSE_CONSENTS,
+		purposeConsentsString,
+	);
+	enqueueSetStorageToDefault(
+		IABKeys.IABTCF.VENDOR_CONSENTS,
+		vendorConsentsString,
+	);
+	enqueueSetStorageToDefault(IABKeys.IABTCF.ADDTL_CONSENT, '');
 
 	// Handle Google Consent Mode integration
 	if (enableAdvertiserConsentMode !== undefined) {
-		setIntStorageToDefault(
+		enqueueSetIntStorageToDefault(
 			IABKeys.IABTCF.ENABLE_ADVERTISER_CONSENT_MODE,
 			enableAdvertiserConsentMode ? 1 : 0,
 		);
@@ -143,24 +190,22 @@ export const setAllIABKeys = (consentData: IABConsentData): void => {
 	osanoLogger.debug(
 		`📊 Updated IAB keys: CMP=true, SubjectToGDPR=${subjectToGDPR}, PurposeConsents=${purposeConsentsString.length} chars, VendorConsents=${vendorConsentsString.length} chars`,
 	);
+	return enqueueStorageOperation(() => Promise.resolve());
 };
 
-export const setCustomIABKey = (key: string, value: string): void => {
-	setStorage(key, value);
-};
+export const setCustomIABKey = (key: string, value: string): Promise<string> =>
+	enqueueSetStorage(key, value);
 
-export const setDefaultIABKey = (key: string, value: string): void => {
-	setStorageToDefault(key, value);
-};
+export const setDefaultIABKey = (key: string, value: string): Promise<string> =>
+	enqueueSetStorageToDefault(key, value);
 
-export const setDefaultIABKeyAsInt = (key: string, value: number): void => {
-	setIntStorageToDefault(key, value);
-};
+export const setDefaultIABKeyAsInt = (
+	key: string,
+	value: number,
+): Promise<number> => enqueueSetIntStorageToDefault(key, value);
 
-export const clearCustomIABKey = (key: string): void => {
-	clearStorage(key);
-};
+export const clearCustomIABKey = (key: string): Promise<void> =>
+	enqueueStorageOperation(() => clearStorage(key));
 
-export const clearDefaultIABKey = (key: string): void => {
-	clearStorageFromDefault(key);
-};
+export const clearDefaultIABKey = (key: string): Promise<void> =>
+	enqueueStorageOperation(() => clearStorageFromDefault(key));

package/src/iab/tcf/middleware.ts

@@ -8,8 +8,12 @@ import {
 	setConsent,
 } from './actions';
 import { SET_CONSENT_DATA, setConsentData } from '../actions';
-import { clearAllIABKeys, setAllIABKeys } from './iab-storage-utils';
-import { clearStorage, getStorage, setStorage } from '../../native/OsanoCmp';
+import {
+	clearAllIABKeys,
+	setAllIABKeys,
+	setCustomIABKey,
+} from './iab-storage-utils';
+import { clearStorage, getStorage } from '../../native/OsanoCmp';
 import { getConsentString, getPurposeIds } from './selectors';
 import {
 	idRecordToBinaryString,
@@ -25,12 +29,18 @@ import { Platform } from 'react-native';
 import type { Store } from '../../hooks/useThunkReducer';
 import { osanoLogger } from '../../utils/OsanoLogger';
 
+const TCF_GPP_SECTIONS = ['tcfeuv2', 'tcfcav1'];
+
 export const makeMiddleware: IabMiddlewareFactory = (
 	initOptions: IabInitOptions,
 ) => {
 	const { createConsentPayload, gppSection, version } = initOptions;
 	const parseConsentString = makeParseConsentString(initOptions);
 	const formatConsentString = makeFormatConsentString(initOptions);
+	const clearStoredTcfConsent = (configId: string) =>
+		clearAllIABKeys(
+			TCF_GPP_SECTIONS.map((section) => `${section}_${configId}`),
+		);
 	return (store: Store<OsanoState & IabState, OsanoAction>) =>
 		(next: (action: OsanoAction) => OsanoState & IabState) =>
 		(action: OsanoAction) => {
@@ -64,6 +74,20 @@ export const makeMiddleware: IabMiddlewareFactory = (
 						}
 						store.dispatch(setConsent(payload));
 					};
+					// Wipe instead of rehydrating a granted string. A localStorage-only
+					// path left IABTCF_* behind; OsanoCmp covers every platform.
+					if (newState.consentInvalidated) {
+						newState.iab.consentStrings = {
+							...newState.iab.consentStrings,
+							[gppSection]: '',
+						};
+						store.dispatch(setConsentData(gppSection, ''));
+						clearStoredTcfConsent(configId).then(
+							() => resConsent(null),
+							() => resConsent(null),
+						);
+						break;
+					}
 					switch (Platform.OS) {
 						case 'ios':
 						case 'android':
@@ -87,20 +111,12 @@ export const makeMiddleware: IabMiddlewareFactory = (
 					break;
 				}
 				case CLEAR_CONSENT: {
-					switch (Platform.OS) {
-						case 'ios':
-						case 'android':
-							clearStorage(`${gppSection}_${configId}`);
-
-							clearAllIABKeys();
-							break;
-						default:
-							try {
-								window.localStorage.removeItem(`${gppSection}_${configId}`);
-							} catch {}
-							break;
-					}
+					newState.iab.consentStrings = {
+						...newState.iab.consentStrings,
+						[gppSection]: '',
+					};
 					store.dispatch(setConsentData(gppSection, ''));
+					clearStoredTcfConsent(configId).catch(() => {});
 					break;
 				}
 				case SET_ALL_PURPOSE_CONSENT: {
@@ -147,22 +163,10 @@ export const makeMiddleware: IabMiddlewareFactory = (
 				case SAVE_BEGIN: {
 					if (config && configId) {
 						const consentPayload = createConsentPayload(newState);
-						switch (Platform.OS) {
-							case 'ios':
-							case 'android':
-								try {
-									setStorage(
-										`${gppSection}_${configId}`,
-										JSON.stringify(consentPayload),
-									);
-								} catch (err) {
-									osanoLogger.error(
-										`Failed to save consent to device storage: ${err}`,
-										err instanceof Error ? err : undefined,
-									);
-								}
-								break;
-						}
+						setCustomIABKey(
+							`${gppSection}_${configId}`,
+							JSON.stringify(consentPayload),
+						);
 						store.dispatch(
 							setConsentData(gppSection, formatConsentString(config, newState)),
 						);
@@ -183,7 +187,7 @@ export const makeMiddleware: IabMiddlewareFactory = (
 						osanoLogger.info(`Setting new consent string -> ${value}`);
 						const consent = parseConsentString(value);
 
-						setStorage(storageKey, value);
+						setCustomIABKey(storageKey, value);
 
 						const consentData = {
 							tcString: value,

package/src/iab/tcf/reducer.ts

@@ -1,4 +1,4 @@
-import { CLEAR_CONSENT, RELOAD, SAVE_BEGIN, SET_CONFIG } from '../../actions';
+import { CLEAR_CONSENT, RELOAD, SET_CONFIG } from '../../actions';
 import type { OsanoAction, OsanoState } from '../../types/store';
 import {
 	SET_CONSENT,
@@ -21,8 +21,6 @@ import {
 import type { Config } from '../../types/consent-config';
 import type { IabInitOptions } from './types';
 import type { IabState } from '../types';
-import { Platform } from 'react-native';
-import { setStorage } from '../../native/OsanoCmp';
 
 export const initialState = {
 	iab: {
@@ -91,7 +89,7 @@ const updateOptions = (
 };
 
 export default function makeReducer(initOptions: IabInitOptions) {
-	const { createConsentPayload, gppSection, version } = initOptions;
+	const { createConsentPayload, version } = initOptions;
 	return (state: OsanoState & IabState, action: OsanoAction) => {
 		const { type, payload } = action;
 		switch (type) {
@@ -135,31 +133,6 @@ export default function makeReducer(initOptions: IabInitOptions) {
 				};
 			}
 
-			case SAVE_BEGIN: {
-				const config = state.config;
-				if (config?.configId && config.iabEnabled) {
-					const consentPayload = createConsentPayload(state);
-					switch (Platform.OS) {
-						case 'ios':
-						case 'android':
-							setStorage(
-								`${gppSection}_${config.configId}`,
-								JSON.stringify(consentPayload),
-							);
-							break;
-						default:
-							try {
-								window.localStorage.setItem(
-									`${gppSection}_${config.configId}`,
-									JSON.stringify(consentPayload),
-								);
-							} catch {}
-							break;
-					}
-				}
-				return state;
-			}
-
 			case CLEAR_CONSENT: {
 				const consentPayload = createConsentPayload();
 				return {

package/src/index.tsx

@@ -2,6 +2,7 @@ import React, { memo, useCallback, useEffect, useMemo, useRef } from 'react';
 import { Platform, UIManager } from 'react-native';
 import {
 	CLEAR_CONSENT,
+	SAVE_BEGIN,
 	reload,
 	setConfig,
 	setLocale,
@@ -105,7 +106,13 @@ export const Osano: React.FunctionComponent<
 						}),
 					);
 				}
-				return recordConsent(consentManager.current, consentedCategories);
+				dispatch({ type: SAVE_BEGIN, payload: consentedCategories });
+				return recordConsent(consentManager.current, consentedCategories).then(
+					(recordedConsent) => {
+						consentManager.current.triggerGoogleConsentUpdate(recordedConsent);
+						return recordedConsent;
+					},
+				);
 			},
 			[],
 		);
@@ -208,6 +215,7 @@ export const Osano: React.FunctionComponent<
 				})
 				.then((reloadProps) => {
 					// We need to reset the state when the configId or customerId changes
+					const consentInvalidated = consentManager.current.consentInvalidated;
 					dispatch(
 						reload({
 							// Pass config so init-time opt-out normalization runs on the
@@ -217,8 +225,14 @@ export const Osano: React.FunctionComponent<
 							configId: reloadProps.configId,
 							customerId: reloadProps.customerId,
 							consent: reloadProps.consent,
+							// Signals the IAB TCF middleware to wipe (not rehydrate) the
+							// stored TC string on this RELOAD; see its RELOAD handler.
+							consentInvalidated,
 						}),
 					);
+					if (consentManager.current.consentPromptRequired) {
+						dispatch(showDialog());
+					}
 					return reloadProps;
 				})
 				.catch(() => {

package/src/reducer.ts

@@ -127,6 +127,10 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 				...state,
 				consent,
 				savedConsent: { ...consent } as Record<ConsentCategoryType, boolean>,
+				// The user just re-consented, so the invalidation is resolved. Clear
+				// the marker so a later SET_CONFIG rehydrates this freshly-saved TCF
+				// payload instead of wiping it (the IAB middleware wipes while set).
+				consentInvalidated: false,
 			};
 		}
 		case CLEAR_CONSENT: {