@chipmobilesdk/rn-payment 0.4.0 → 0.5.0

package/src/testing/conformance.ts

@@ -0,0 +1,169 @@
+/**
+ * What any `ProviderPort` must do (IOS-12, PAY-13).
+ *
+ * The same checks run against the fake store and against the Play adapter over a
+ * simulated binding (or the real one, from a demo screen on a device), so a test
+ * that drives the fake proves something about the device path. Each check builds
+ * its own port over the same small store, through a harness.
+ */
+import {
+	ensure,
+	runChecks,
+	type Check,
+	type ConformanceReport,
+} from '@chipmobilesdk/rn-core/testing';
+
+import type { ProviderPort } from '../adapter/port';
+import type { ProductType } from '../config/types';
+
+export interface StoreProductSpec {
+	readonly storeProductId: string;
+	readonly productType: ProductType;
+	/** As the store formats it; the port must pass it through untouched. */
+	readonly formattedPrice: string;
+}
+
+export interface OwnedPurchaseSpec {
+	readonly storeProductId: string;
+	readonly token: string;
+	readonly state: 'purchased' | 'pending';
+}
+
+export interface StoreScenario {
+	readonly products: readonly StoreProductSpec[];
+	readonly owned: readonly OwnedPurchaseSpec[];
+}
+
+export interface ProviderSubject {
+	readonly port: ProviderPort;
+	/** How the next purchase flow the user starts ends. */
+	nextPurchaseEnds(outcome: 'bought' | 'cancelled'): void;
+	/** The billing service goes away underneath the app. */
+	dropService(): void;
+}
+
+export interface ProviderHarness {
+	create(scenario: StoreScenario): ProviderSubject;
+}
+
+/** The store every check runs against. */
+export const CONFORMANCE_STORE: StoreScenario = {
+	products: [
+		{
+			storeProductId: 'conformance.remove_ads',
+			productType: 'one_time_permanent',
+			formattedPrice: '€1.99',
+		},
+		{
+			storeProductId: 'conformance.coins',
+			productType: 'one_time_consumable',
+			formattedPrice: '€0.99',
+		},
+	],
+	owned: [
+		{ storeProductId: 'conformance.remove_ads', token: 'token-owned', state: 'purchased' },
+		{ storeProductId: 'conformance.coins', token: 'token-pending', state: 'pending' },
+	],
+};
+
+export const providerPortChecks: readonly Check<ProviderHarness>[] = [
+	{
+		name: 'connects, and disconnects safely before a connect and twice',
+		async run(harness) {
+			const { port } = harness.create(CONFORMANCE_STORE);
+			await port.disconnect();
+			const outcome = await port.connect();
+			ensure(outcome.ok, `connect failed: ${JSON.stringify(outcome)}`);
+			await port.disconnect();
+			await port.disconnect();
+		},
+	},
+	{
+		name: 'reports a dropped service to observers, and nothing after unsubscribing',
+		async run(harness) {
+			const subject = harness.create(CONFORMANCE_STORE);
+			const seen: boolean[] = [];
+			const stop = subject.port.observeConnection(connected => seen.push(connected));
+			await subject.port.connect();
+			ensure(seen.at(-1) === true, `after connect observers saw ${JSON.stringify(seen)}`);
+			subject.dropService();
+			ensure(seen.at(-1) === false, `after the drop observers saw ${JSON.stringify(seen)}`);
+			stop();
+			const before = seen.length;
+			await subject.port.connect();
+			ensure(seen.length === before, 'notified after unsubscribing');
+		},
+	},
+	{
+		name: 'returns the requested products with the store-formatted price',
+		async run(harness) {
+			const { port } = harness.create(CONFORMANCE_STORE);
+			await port.connect();
+			const products = await port.queryProducts(['conformance.remove_ads'], 'one_time_permanent');
+			ensure(products.length === 1, `expected one product, got ${products.length}`);
+			const [product] = products;
+			ensure(product?.storeProductId === 'conformance.remove_ads', 'wrong product returned');
+			ensure(product.productType === 'one_time_permanent', `product type ${product.productType}`);
+			ensure(product.formattedPrice === '€1.99', `price ${product.formattedPrice}`);
+		},
+	},
+	{
+		name: 'flags a pending purchase rather than filtering it out',
+		async run(harness) {
+			const { port } = harness.create(CONFORMANCE_STORE);
+			await port.connect();
+			const owned = await port.queryOwned();
+			const pending = owned.find(purchase => purchase.token === 'token-pending');
+			const bought = owned.find(purchase => purchase.token === 'token-owned');
+			ensure(pending?.state === 'pending', `pending purchase reported as ${pending?.state}`);
+			ensure(bought?.state === 'purchased', `bought purchase reported as ${bought?.state}`);
+		},
+	},
+	{
+		name: 'reports a bought purchase for the product that was requested',
+		async run(harness) {
+			const subject = harness.create(CONFORMANCE_STORE);
+			await subject.port.connect();
+			subject.nextPurchaseEnds('bought');
+			const outcome = await subject.port.launchPurchase({
+				storeProductId: 'conformance.coins',
+				productType: 'one_time_consumable',
+			});
+			ensure(outcome.ok, `purchase failed: ${JSON.stringify(outcome)}`);
+			ensure(
+				outcome.purchase.storeProductId === 'conformance.coins',
+				'purchase for another product',
+			);
+			ensure(outcome.purchase.token !== '', 'purchase has no token to finalize');
+		},
+	},
+	{
+		name: 'reports a cancelled flow as user_cancelled',
+		async run(harness) {
+			const subject = harness.create(CONFORMANCE_STORE);
+			await subject.port.connect();
+			subject.nextPurchaseEnds('cancelled');
+			const outcome = await subject.port.launchPurchase({
+				storeProductId: 'conformance.remove_ads',
+				productType: 'one_time_permanent',
+			});
+			ensure(!outcome.ok, 'a cancelled flow reported a purchase');
+			ensure(outcome.reason === 'user_cancelled', `reason ${outcome.reason}`);
+		},
+	},
+	{
+		name: 'acknowledges and consumes safely twice',
+		async run(harness) {
+			const { port } = harness.create(CONFORMANCE_STORE);
+			await port.connect();
+			await port.acknowledge('token-owned');
+			await port.acknowledge('token-owned');
+			await port.consume('token-pending');
+			await port.consume('token-pending');
+		},
+	},
+];
+
+export function runProviderPortConformance(harness: ProviderHarness): Promise<ConformanceReport> {
+	return runChecks(() => harness, providerPortChecks);
+}