@chipmobilesdk/rn-ads 0.5.1 → 0.7.0

package/src/testing/index.ts

@@ -16,85 +16,23 @@
  * so test doubles cannot reach a production bundle.
  */
 
-import type { FullScreenFormat, Reward, Unsubscribe } from '../config/types';
-import type { Scheduler } from '../core/timers';
+import type { AdFormat, FullScreenFormat, Reward, Unsubscribe } from '../config/types';
+export { createTestClock, type TestClock } from './clock';
+import { createTestClock, type TestClock } from './clock';
+
+import { testAdUnitFor } from '../engine/testAdUnits';
 import type {
 	AdsEngine,
 	ConsentPort,
 	EngineAdEvent,
 	EngineAdHandle,
+	EngineBannerProps,
 	EngineConsentInfo,
 	EngineConsentOptions,
 	EnginePrivacy,
 	EngineRequestOptions,
 } from '../engine/port';
 
-/**
- * A clock a test can move by hand.
- *
- * Retry backoff, app-open expiry, the undecided-state warning, and the
- * ad-originated-return windows are all time-dependent, and all four must be
- * assertable exactly rather than approximately. Advancing a clock makes "two
- * retries, 2s then 4s" a precise assertion; sleeping would make it a flaky one.
- *
- * Callbacks fire in due order, and a callback scheduled *during* an advance is
- * honored within the same advance if its deadline has also passed — matching how
- * real timers behave when work chains.
- */
-export interface TestClock {
-	now(): number;
-	advance(ms: number): void;
-	readonly scheduler: Scheduler;
-	pending(): number;
-}
-
-export function createTestClock(startMs = 1_000_000): TestClock {
-	let current = startMs;
-	let sequence = 0;
-	const timers = new Map<number, { at: number; callback: () => void }>();
-
-	const scheduler: Scheduler = {
-		setTimeout(callback, ms) {
-			sequence += 1;
-			timers.set(sequence, { at: current + ms, callback });
-			return sequence;
-		},
-		clearTimeout(handle) {
-			timers.delete(handle as number);
-		},
-	};
-
-	return {
-		now: () => current,
-		advance(ms) {
-			const target = current + ms;
-			// Loop rather than iterate once: a fired callback may schedule another
-			// timer that is also due before `target`, which is exactly what a retry
-			// chain does.
-			for (;;) {
-				let nextId: number | null = null;
-				let nextAt = Number.POSITIVE_INFINITY;
-				for (const [id, timer] of timers) {
-					if (timer.at <= target && timer.at < nextAt) {
-						nextAt = timer.at;
-						nextId = id;
-					}
-				}
-				if (nextId === null) {
-					break;
-				}
-				const timer = timers.get(nextId)!;
-				timers.delete(nextId);
-				current = timer.at;
-				timer.callback();
-			}
-			current = target;
-		},
-		scheduler,
-		pending: () => timers.size,
-	};
-}
-
 export type FakeConsentCall =
 	| { readonly kind: 'requestInfoUpdate'; readonly options: EngineConsentOptions }
 	| { readonly kind: 'showFormIfRequired' }
@@ -203,6 +141,20 @@ export interface FakeAdsEngine extends AdsEngine {
 	failConsentInfoRead(cause?: unknown): void;
 }
 
+/**
+ * Runs `task` on the next microtask, which is when a provider's callbacks would
+ * arrive. Written out because React Native's type declarations omit
+ * `queueMicrotask`, although Hermes has it.
+ */
+function nextMicrotask(task: () => void): void {
+	Promise.resolve().then(task);
+}
+
+/** The fake engine's banner component. */
+function FakeBanner(_props: EngineBannerProps): null {
+	return null;
+}
+
 export function createFakeAdsEngine(options: FakeEngineOptions = {}): FakeAdsEngine {
 	const calls: FakeEngineCall[] = [];
 	const consentCalls: FakeConsentCall[] = [];
@@ -344,6 +296,14 @@ export function createFakeAdsEngine(options: FakeEngineOptions = {}): FakeAdsEng
 			return options.available !== false;
 		},
 
+		// Renders nothing. A test finds it in the tree by its `adUnitId` prop and
+		// calls `onLoaded`, `onFailed`, `onImpression` or `onClicked` itself, which
+		// is how a banner is driven without mocking a native module (ADS-12).
+		banner: {
+			isAvailable: () => options.available !== false,
+			Component: FakeBanner,
+		},
+
 		async initialize(privacy) {
 			record({ kind: 'initialize', privacy });
 			if (options.failInitialize !== undefined) {
@@ -375,7 +335,7 @@ export function createFakeAdsEngine(options: FakeEngineOptions = {}): FakeAdsEng
 			if (!options.neverCallBack) {
 				// `show` is called with a listener already attached, so this one
 				// can go out directly on the next microtask.
-				queueMicrotask(() => {
+				nextMicrotask(() => {
 					for (const listener of Array.from(listeners.get(handle.id) ?? [])) {
 						listener({ type: 'opened' });
 					}
@@ -395,7 +355,7 @@ export function createFakeAdsEngine(options: FakeEngineOptions = {}): FakeAdsEng
 			const queued = pending.get(handle.id);
 			if (queued) {
 				pending.delete(handle.id);
-				queueMicrotask(() => {
+				nextMicrotask(() => {
 					for (const target of Array.from(listeners.get(handle.id) ?? [])) {
 						target(queued);
 					}
@@ -461,3 +421,16 @@ export function createFakeAdsEngine(options: FakeEngineOptions = {}): FakeAdsEng
 		},
 	};
 }
+
+export { adsEngineChecks, runAdsEngineConformance } from './conformance';
+export type { AdsEngineHarness, AdsEngineSubject } from './conformance';
+
+/** Google's official test ad unit for each format, as the package substitutes them (FR-011). */
+export function allTestAdUnits(): Readonly<Record<AdFormat, string>> {
+	return {
+		banner: testAdUnitFor('banner'),
+		interstitial: testAdUnitFor('interstitial'),
+		rewarded: testAdUnitFor('rewarded'),
+		app_open: testAdUnitFor('app_open'),
+	};
+}