create-octane-xplat 0.13.0 → 0.15.0

package/template/src/app.spec.tsrx

@@ -1,4 +1,4 @@
-// Starter spec — `pnpm test:ios` runs this inside the real iOS runtime
+// Starter spec — `pnpm test:ios` / `pnpm test:android` run in the real mobile runtime
 // (same renderer, native views, and services your app uses).
 //
 // mountXplat() renders a component onto the test host page and unmounts it
@@ -6,7 +6,7 @@
 // gesture observers as real touches — that proves your wiring, not OS
 // hit-testing (device journeys like that belong to Maestro).
 import { describe, expect, it } from 'vitest'
-import { useEffect, useState } from 'octane'
+import { useEffect, useState, useSyncExternalStore } from 'octane'
 import { Pressable, Text, TextInput, View } from '@octane-xplat/ui'
 import {
 	type TextInputView,
@@ -130,3 +130,81 @@ describe('starter app on device', () => {
 		})
 	})
 })
+
+// Observable cleanup contracts: every effect subscribe must pair with a
+// cleanup at unmount, delayed work must stop firing, and a re-mount must not
+// leave the previous root subscribed.
+let activeEffects = 0
+let ticks = 0
+
+function IntervalCounter() @{
+	useEffect(() => {
+		activeEffects += 1
+		const timer = setInterval(() => {
+			ticks += 1
+		}, 15)
+
+		return () => {
+			activeEffects -= 1
+			clearInterval(timer)
+		}
+	}, [])
+
+	<Text>interval</Text>
+}
+
+const listeners = new Set<() => void>()
+
+function StoreReader() @{
+	const count = useSyncExternalStore(
+		(callback) => {
+			listeners.add(callback)
+			return () => {
+				listeners.delete(callback)
+			}
+		},
+		() => listeners.size,
+	)
+
+	<Text>{'subs: ' + count}</Text>
+}
+
+describe('mount/unmount cleanup', () => {
+	it('runs effect cleanups and stops delayed work at unmount', async () => {
+		ticks = 0
+		for (let i = 0; i < 3; i++) {
+			const { unmount } = await mountXplat(IntervalCounter)
+			expect(activeEffects, 'each mount subscribes exactly once').toBe(1)
+			await unmount()
+			expect(activeEffects, 'unmount runs the effect cleanup').toBe(0)
+		}
+
+		// The cleared interval must not fire after the last unmount.
+		const settled = ticks
+		await new Promise((resolve) => setTimeout(resolve, 60))
+		expect(ticks, 'interval work continued after unmount').toBe(settled)
+	})
+
+	it('releases external-store subscriptions at unmount', async () => {
+		for (let i = 0; i < 3; i++) {
+			const { unmount } = await mountXplat(StoreReader)
+			expect(listeners.size, 'each mount subscribes exactly once').toBe(1)
+			await unmount()
+			expect(listeners.size, 'unmount releases the subscription').toBe(0)
+		}
+	})
+
+	it('re-mounting replaces the previous root instead of leaking it', async () => {
+		await mountXplat(IntervalCounter)
+		expect(activeEffects).toBe(1)
+		// mountXplat drops the previous root — its cleanup must already have run.
+		await mountXplat(IntervalCounter)
+		expect(activeEffects, 'previous root stayed subscribed after re-mount').toBe(1)
+	})
+
+	it('finishes automatic cleanup before the next case', () => {
+		expect(activeEffects).toBe(0)
+		expect(listeners.size).toBe(0)
+	})
+
+})

package/template/src/failure-reporting.spec.ts

@@ -0,0 +1,11 @@
+import { describe, expect, it } from 'vitest'
+
+// An intentionally failing assertion, marked expected-to-fail: it proves
+// assertion failures on device cross the WebSocket bridge and surface as
+// real Vitest failures (it.fails inverts the outcome, keeping the committed
+// suite green while pinning the failure-reporting path).
+describe('failure reporting', () => {
+	it.fails('a failed assertion on device is reported as a failure', () => {
+		expect('octane-xplat').toBe('a different string entirely')
+	})
+})

package/template/src/native-runtime.spec.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest'
+import { Device, isAndroid, isIOS, knownFolders } from '@nativescript/core'
+
+// This executes NativeScript's filesystem bridge in the actual mobile host.
+// Only this test's uniquely named temporary file is written and removed.
+describe('native runtime', () => {
+	it('round-trips a file through the native bridge', () => {
+		expect(isAndroid || isIOS).toBe(true)
+		expect(Device.os).toBe(isAndroid ? 'Android' : 'iOS')
+		const file = knownFolders.temp().getFile(`xplat-native-test-${Date.now()}.txt`)
+		try {
+			file.writeTextSync('octane-xplat')
+			expect(file.readTextSync()).toBe('octane-xplat')
+		} finally {
+			file.removeSync()
+		}
+	})
+})

package/template/tsconfig.json

@@ -6,13 +6,37 @@
 		"moduleResolution": "bundler",
 		"jsx": "preserve",
 		"jsxImportSource": "octane",
-		"moduleSuffixes": [".web", ""],
-		"customConditions": ["web"],
-		"lib": ["ESNext", "DOM", "DOM.Iterable"],
-		"types": ["vite/client"],
+		"moduleSuffixes": [
+			"",
+			".web",
+			".ios",
+			".android",
+			".mobile",
+			".native",
+			".macos",
+			".linux",
+			".windows"
+		],
+		"lib": [
+			"ESNext",
+			"DOM",
+			"DOM.Iterable"
+		],
+		"types": [
+			"vite/client",
+			"@nativescript/types"
+		],
 		"noEmit": true,
-		"skipLibCheck": true
+		"skipLibCheck": true,
+		"allowImportingTsExtensions": true
 	},
-	"include": ["src/**/*"],
-	"exclude": ["node_modules", "src/main.ts"]
+	"include": [
+		"src/**/*"
+	],
+	"exclude": [
+		"node_modules"
+	],
+	"files": [
+		"references.d.ts"
+	]
 }

package/template/vite.config.ts

@@ -1,13 +1,13 @@
 import { defineConfig } from 'vite'
 import { octane } from '@octanejs/vite-plugin'
-import { xplatBoundary, xplatNodeEnvDefine } from '@octane-xplat/cli/vite'
+import { xplatBoundary, xplatDevBridge, xplatNodeEnvDefine } from '@octane-xplat/cli/vite'
 
 // The web build. For native (iOS/Android), the same source runs through
 // @nativescript-community/vite-octane with `conditions: ['native']`, the
 // .ios/.android/.mobile suffix chain, and the unsuffixed native default — see
 // the octane-xplat repo's apps/mobile/vite.config.mts.
 export default defineConfig(({ mode }) => ({
-	plugins: [...octane(), xplatBoundary('web')],
+	plugins: [...octane(), xplatBoundary('web'), xplatDevBridge()],
 	define: xplatNodeEnvDefine(mode),
 	server: { port: 5200 },
 	resolve: {

package/template/tsconfig.native.json

@@ -1,18 +0,0 @@
-{
-	"compilerOptions": {
-		"strict": true,
-		"target": "ESNext",
-		"module": "ESNext",
-		"moduleResolution": "bundler",
-		"jsx": "preserve",
-		"jsxImportSource": "@nativescript-community/octane",
-		"moduleSuffixes": [".ios", ".android", ".mobile", ""],
-		"customConditions": ["native"],
-		"lib": ["ESNext"],
-		"types": ["@nativescript/types"],
-		"noEmit": true,
-		"skipLibCheck": true
-	},
-	"include": ["src/**/*", "references.d.ts"],
-	"exclude": ["node_modules", "platforms", "**/*.web.*"]
-}