peachsim 0.1.1635 → 0.1.1641

package/src/swift-distribution.ts

@@ -5,6 +5,7 @@
 // build carries, and unpacks it under the peach home
 // (docs/swift-distribution.md). no path here asks Contrast to compile.
 import fs from 'node:fs'
+import os from 'node:os'
 import path from 'node:path'
 import { installVerifiedTarball } from '@contrast/runtime-delivery'
 import { rnxHomeDir } from './home-paths'
@@ -16,7 +17,17 @@ import {
   swiftDistributionKey,
 } from './swift-distribution-contract'
 import lockJson from './swift-distribution.lock.json' with { type: 'json' }
-import { swiftToolchain } from './swift-toolchain'
+import {
+  confineSwiftScratch,
+  installSwiftWasmSdk,
+  swiftCompiler,
+  swiftCompilerInstallSteps,
+  swiftHostCompilerArchive,
+  swiftToolchain,
+  swiftToolchainBin,
+  verifySwiftHostCompiler,
+  type SwiftWasmSdk,
+} from './swift-toolchain'
 
 export const SWIFT_ENDPOINT_ENV = 'PEACH_SWIFT_ENDPOINT'
 
@@ -51,9 +62,9 @@ export async function swiftDistributionRoot(
       `peach has no Swift distribution for ${process.platform}-${process.arch}; it ships for macOS arm64 and Linux x64 and arm64`,
     )
   }
-  // the archive is useless without its compiler, so a missing or wrong
-  // toolchain fails before the download
-  swiftToolchain(lock.release, lock)
+  // the archive is useless without its compiler, so the toolchain installs
+  // or fails before the download
+  await installSwiftToolchain(lock.release, lock, signal)
   const dir = path.join(rnxHomeDir(), 'swift', `${lock.id}-${host}`)
   let pending = installs.get(dir)
   if (pending?.controller.signal.aborted) pending = undefined
@@ -126,6 +137,93 @@ export async function swiftDistributionRoot(
   }
 }
 
+/**
+ * the pinned compiler and wasm SDK, installed on first use without root: the
+ * compiler under PEACH_HOME/swift/toolchains (macOS: ~/Library/Developer/Toolchains) unless CONTRAST_SWIFT_TOOLCHAINS
+ * or an existing /opt/swift install selects another (swiftToolchainBin), the
+ * SDK in the --swift-sdks-path directory, PEACH_HOME/swift/sdks by default.
+ * a compiler in a directory the user selected is verified, never replaced.
+ */
+async function installSwiftToolchain(
+  release: string,
+  sdk: SwiftWasmSdk,
+  signal?: AbortSignal,
+): Promise<void> {
+  process.env.PEACH_SWIFT_SDKS_PATH ??= path.join(rnxHomeDir(), 'swift', 'sdks')
+  if (swiftToolchainReady(release, sdk)) return
+  const root = path.resolve(swiftToolchainBin(release), '../..')
+  // macOS installs where the locator looks first, the user's Toolchains
+  // directory, and only into a directory without a compiler; linux installs
+  // into the Peach-owned directory.
+  const owned =
+    process.platform === 'darwin'
+      ? path.join(os.homedir(), 'Library/Developer/Toolchains', `${release}.xctoolchain`)
+      : path.join(rnxHomeDir(), 'swift', 'toolchains', release)
+  const selectedCompiler =
+    process.platform === 'darwin' && fs.existsSync(path.join(root, 'usr/bin/swift'))
+  if (
+    release.includes('-custom-') &&
+    root === owned &&
+    !selectedCompiler &&
+    !swiftCompilerReady(release)
+  ) {
+    const archive = swiftHostCompilerArchive(release)
+    process.stderr.write(`peach: installing Swift compiler ${release} to ${root}…\n`)
+    await installVerifiedTarball({
+      signal,
+      url: archive.url,
+      digest: { algorithm: 'sha256', encoding: 'hex', value: archive.checksum },
+      destDir: root,
+      installedMarker: 'compiler.json',
+      stripComponents: 1,
+      label: `Swift compiler ${release}`,
+      verify: (dir) => verifySwiftHostCompiler(release, dir),
+    })
+  }
+  try {
+    swiftCompiler(release)
+  } catch (error) {
+    const reason = error instanceof Error ? error.message : String(error)
+    throw new Error(
+      `Swift compiler ${release} is unavailable or differs from its pin: ${reason}\n${swiftCompilerInstallSteps(release)}\nthen run the command again; it installs the SDK.`,
+      { cause: error },
+    )
+  }
+  if (swiftToolchainReady(release, sdk)) return
+  signal?.throwIfAborted()
+  const directory = process.env.PEACH_SWIFT_SDKS_PATH
+  process.stderr.write(`peach: installing Swift SDK ${sdk.wasmSdkId} to ${directory}…\n`)
+  try {
+    installSwiftWasmSdk(release, sdk)
+  } catch (error) {
+    const reason = error instanceof Error ? error.message : String(error)
+    throw new Error(
+      `could not install Swift SDK ${sdk.wasmSdkId} to ${directory}: ${reason}`,
+      {
+        cause: error,
+      },
+    )
+  }
+}
+
+function swiftCompilerReady(release: string): boolean {
+  try {
+    swiftCompiler(release)
+    return true
+  } catch {
+    return false
+  }
+}
+
+function swiftToolchainReady(release: string, sdk: SwiftWasmSdk): boolean {
+  try {
+    swiftToolchain(release, sdk)
+    return true
+  } catch {
+    return false
+  }
+}
+
 /** the module this process compiles app Swift against: the checkout beside a
  *  source peach, else the distribution, else null. `required` callers compile
  *  nothing without it, so a checkout's toolchain error surfaces to them. */
@@ -134,6 +232,7 @@ export async function resolveSwiftModule({
   signal,
 }: { required?: boolean; signal?: AbortSignal } = {}): Promise<SwiftModule | null> {
   signal?.throwIfAborted()
+  confineSwiftScratch(path.join(rnxHomeDir(), 'cache', 'swift-tmp'))
   const checkout = path.resolve(import.meta.dirname, '../../sootsim-swift')
   if (fs.existsSync(path.join(checkout, 'toolchain.json'))) {
     // a checkout is implicit: without its toolchain, apps run without their

package/src/swift-host.ts

@@ -15,6 +15,8 @@ import { authHeaderValue, resolveCliAuth } from '../cli/auth'
 import { resolveContrastBackendOrigin } from './backend-origin'
 import { cacheDir } from './home-paths'
 import iosSdk from './ios-sdk-frameworks.json' with { type: 'json' }
+import { type NativeAppIdentity } from './native-app-identity'
+import { readNativeAppIdentityFromXcodeTarget } from './native-app-identity-project'
 import { swiftBinaryModules } from './swift-binary-modules'
 import {
   compileSwiftProjectUnit,
@@ -28,6 +30,7 @@ import {
 } from './swift-compile'
 import { designTimeValues } from './swift-design-time'
 import { swiftDistributionRoot, swiftModuleToolchain } from './swift-distribution'
+import { compileXcodeObjCImplementations } from './swift-objc-compile'
 import {
   swiftImplicitResourcePaths,
   swiftMetalSourceFiles,
@@ -267,7 +270,9 @@ export function openXcodeProject(
   moduleRoot: string | undefined,
   configuration?: string,
 ): string {
-  const app = readXcodeAppTarget(xcodeproj, target, configuration)
+  const app = readXcodeAppTarget(xcodeproj, target, configuration, {
+    prepareGeneratedSources: true,
+  })
   const root = app.rootDir
   xcodeProjects.set(root, {
     xcodeproj,
@@ -312,20 +317,20 @@ function swiftPackages(
   projectGaps: Map<string, string>
   binaries: SwiftPackageBinary[]
 } {
-  const stamp = (file: string | null) =>
-    file && fs.existsSync(file) ? fs.statSync(file).mtimeMs : 0
+  const stamp = (file: string) =>
+    fs.existsSync(file)
+      ? createHash('sha256').update(fs.readFileSync(file)).digest('hex')
+      : null
   const key = JSON.stringify([
     app.linkedProducts,
-    app.packageResolved,
-    stamp(app.packageResolved),
+    app.packageResolved.map((file) => [file, stamp(file)]),
     app.localPackageDirs.map((dir) => stamp(path.join(dir, 'Package.swift'))),
     app.linkedProducts.map(({ source }) =>
       source.kind === 'local' ? stamp(path.join(source.dir, 'Package.swift')) : 0,
     ),
   ])
-  // the package key is cheap stamps; the stand-in key covers the generation
-  // inputs the stamps cannot see (artifact contents, peach's modules, the
-  // emitter), so a changed input rebuilds instead of reusing stale output.
+  // resolution follows lock and manifest contents even when a checkout restores
+  // timestamps. the stand-in key also covers artifacts, peach modules and emitter.
   let cached = entry.packages
   if (cached?.key !== key) {
     const packages = resolveSwiftPackages({
@@ -345,6 +350,13 @@ function swiftPackages(
     }
     entry.packages = cached
   }
+  if (
+    entry.moduleRoot &&
+    [app, ...app.frameworks].some((target) =>
+      target.allSources.some((file) => /\.mm?$/.test(file)),
+    )
+  )
+    compileXcodeObjCImplementations(app, cached.binaries, entry.moduleRoot)
   // a reached binary target with stand-ins for every module it ships
   // resolves as provided, so what depends on it compiles; the rest keep
   // their reason with why no stand-in was built. surfaces peach already
@@ -450,11 +462,26 @@ function xcodeLayout(root: string): XcodeLayout | null {
     registered.xcodeproj,
     registered.target,
     registered.configuration,
+    { prepareGeneratedSources: true },
   )
+  const implementations = [app, ...app.frameworks].flatMap((target) =>
+    target.allSources
+      .filter((file) => /\.mm?$/i.test(file))
+      .map((file) => `${target.name}: ${path.relative(app.rootDir, file)}`),
+  )
+  if (implementations.length > 0 && !registered.moduleRoot)
+    throw new Error(
+      `Peach cannot compile Objective-C implementations in Xcode targets until the runtime and shared Swift object bridge are available:\n${implementations.map((file) => `  ${file}`).join('\n')}`,
+    )
   const appSources = app.allSources.filter(
     (file) => file.endsWith('.swift') || file.endsWith('.metal'),
   )
-  const files = new Set([...app.projectFiles, ...appSources, ...app.resources])
+  const files = new Set([
+    ...app.projectFiles,
+    ...app.packageResolved,
+    ...appSources,
+    ...app.resources,
+  ])
   if (app.infoPlistFile) files.add(app.infoPlistFile)
   const targetDirs = new Map(
     [...appSources, ...app.resources].map((file) => [file, XCODE_APP_DIR]),
@@ -605,10 +632,18 @@ function xcodeManifest(layout: XcodeLayout): string {
 
 // preflight the entire input tree before reading any source or resource bytes.
 // a nested package is a separate compile unit; ignored build trees never enter it.
-function packageFiles(root: string): string[] {
+function packageFiles(root: string, includeBuildInputs = true): string[] {
   const canonicalRoot = fs.realpathSync(root)
   const xcode = xcodeLayout(canonicalRoot)
-  return xcode ? xcode.files : sourceTreeFiles(canonicalRoot, canonicalRoot)
+  if (!xcode) return sourceTreeFiles(canonicalRoot, canonicalRoot)
+  if (includeBuildInputs) return xcode.files
+  const buildInputs = new Set(xcode.app.projectFiles)
+  return xcode.files.filter(
+    (file) =>
+      !buildInputs.has(file) ||
+      xcode.targetDirs.has(file) ||
+      xcode.packages.targets.some((target) => target.files.includes(file)),
+  )
 }
 
 // remote dependencies are enumerated from peach's checkout cache, while app
@@ -668,16 +703,18 @@ function isPackageSource(file: string): boolean {
 }
 
 export function sourceFiles(root: string): string[] {
-  return packageFiles(root).filter(isPackageSource)
+  return packageFiles(root, false).filter(isPackageSource)
 }
 
 // project files and the xcconfigs their settings read are build inputs, never resources
 function resourceCandidateFiles(root: string): string[] {
-  return packageFiles(root).filter(
+  return packageFiles(root, false).filter(
     (file) =>
       !isPackageSource(file) &&
       !file.endsWith('.xcconfig') &&
-      !['project.pbxproj', 'project.xcproj'].includes(path.basename(file)),
+      !['project.pbxproj', 'project.xcproj', 'Package.resolved'].includes(
+        path.basename(file),
+      ),
   )
 }
 
@@ -685,6 +722,7 @@ function resourceCandidateFiles(root: string): string[] {
 export function swiftProjectAppInfo(packagePath: string): {
   name: string
   icon: { bytes: Buffer; contentType: string } | null
+  identity: NativeAppIdentity | null
 } {
   const registered = xcodeProjects.get(packagePath)
   const app = registered
@@ -747,12 +785,17 @@ export function swiftProjectAppInfo(packagePath: string): {
     }
     break
   }
-  return { name: app?.name ?? path.basename(packagePath), icon }
+  return {
+    name: app?.name ?? path.basename(packagePath),
+    icon,
+    identity: app ? readNativeAppIdentityFromXcodeTarget(app) : null,
+  }
 }
 
 // the hosted compile service caps what a project sends it; a local compile
 // reads the author's own files, so nothing caps them there.
 const HOSTED_LIMITS = {
+  sourceBytes: MAX_SWIFT_COMPILE_SOURCE_BYTES,
   resources: MAX_SWIFT_COMPILE_RESOURCES,
   resourceBytes: MAX_SWIFT_COMPILE_RESOURCE_BYTES,
   resourceTotalBytes: MAX_SWIFT_COMPILE_RESOURCE_TOTAL_BYTES,
@@ -761,6 +804,7 @@ const HOSTED_LIMITS = {
   imageTotalBytes: MAX_SWIFT_COMPILE_IMAGE_TOTAL_BYTES,
 }
 const LOCAL_LIMITS: typeof HOSTED_LIMITS = {
+  sourceBytes: Infinity,
   resources: Infinity,
   resourceBytes: Infinity,
   resourceTotalBytes: Infinity,
@@ -969,7 +1013,7 @@ export function buildSwiftBundleFiles(
   const xcode = xcodeLayout(packagePath)
   const bundles =
     xcode?.resourceBundles ??
-    swiftResourceBundles(inputs ?? packageSources(packagePath), relative)
+    swiftResourceBundles(inputs ?? packageSources(packagePath, hosted), relative)
   const addFile = (key: string, bytes: Buffer) => {
     if (
       Object.keys(files).length >= limits.resources ||
@@ -1175,6 +1219,7 @@ export function standinLibraries(
 
 function packageSources(
   packagePath: string,
+  hosted = false,
   linked: ReadonlySet<SwiftStandin> = new Set(),
 ): Record<string, string> {
   const xcode = xcodeLayout(packagePath)
@@ -1184,13 +1229,14 @@ function packageSources(
     ),
   )
   const files: Record<string, string> = {}
+  const limits = inputLimits(hosted)
   for (const file of sourceFiles(packagePath)) {
     const relative = path.relative(packagePath, file).split(path.sep).join(path.posix.sep)
     if (manifests.has(file)) continue
     files[xcode ? xcodeInputKey(xcode, file, relative) : relative] = readPackageFile(
       packagePath,
       file,
-      MAX_SWIFT_COMPILE_SOURCE_BYTES,
+      limits.sourceBytes,
     ).toString('utf8')
   }
   if (xcode) {
@@ -1221,7 +1267,11 @@ function packageSnapshot(project: SwiftProject, entry: string): SwiftPackageSnap
   const linked = layout
     ? standinLibraries(layout.binaries, layout.standins, layout.app.rootDir)
     : new Map<string, SwiftStandin[]>()
-  const files = packageSources(project.packagePath, new Set([...linked.values()].flat()))
+  const files = packageSources(
+    project.packagePath,
+    Boolean(project.hosted),
+    new Set([...linked.values()].flat()),
+  )
   const native = nativeSourceDescriptor(project.packagePath)
   return {
     files,
@@ -1262,7 +1312,7 @@ function packageSnapshot(project: SwiftProject, entry: string): SwiftPackageSnap
           glue: readPackageFile(
             project.packagePath,
             path.join(project.packagePath, NATIVE_GLUE),
-            MAX_SWIFT_COMPILE_SOURCE_BYTES,
+            inputLimits(Boolean(project.hosted)).sourceBytes,
           ).toString('utf8'),
         }
       : {}),
@@ -1351,10 +1401,11 @@ async function compile(
     throw new SwiftMissingModulesError(await missingModulesMessage(packagePath, missing))
   const artifact = await compileSwiftProjectUnit(input, {
     // the compile rewrites Sources/App in its root before swiftpm builds, and
-    // its lock orders one process only: two vites on one root (a lane's dev
-    // server and a capture, or two checkouts) build each other's sources. so
-    // each app and module checkout gets its own root, which keeps the same
-    // app's incremental build across restarts.
+    // a root lock orders every process using it, so two vites on one root
+    // (a lane's dev server and a capture, or two checkouts) queue instead of
+    // building each other's sources. each app and module checkout still gets
+    // its own root, so they do not queue and the same app keeps its
+    // incremental build across restarts.
     buildRoot: (() => {
       if (process.env.CONTRAST_SWIFT_BUILD_ROOT)
         return process.env.CONTRAST_SWIFT_BUILD_ROOT
@@ -1411,6 +1462,21 @@ const API_GAP_PATTERNS: [RegExp, (match: RegExpExecArray) => string][] = [
     (match) => `${match[1]}.${match[2]}`,
   ],
   [/^'([^']+)' is unavailable/, (match) => match[1]!],
+  // an instance api Peach declares static, or the reverse
+  [
+    /^(?:static|instance) member '([^']+)' cannot be used on (?:instance of )?type '([^']+)'/,
+    (match) => `${match[2]}.${match[1]}`,
+  ],
+  // an overridable api Peach declares in an extension
+  [
+    /^(?:non-@objc )?[\w ]+ '([^']+)' is declared in extension of '([^']+)' and cannot be overridden/,
+    (match) => `${match[2]}.${match[1]}`,
+  ],
+  // a form of a macro Peach's expansion does not accept
+  [
+    /^(@\w+) requires an initial value/,
+    (match) => `${match[1]} without an initial value`,
+  ],
   [/^no such module '([^']+)'/, (match) => `module ${match[1]}`],
 ]
 
@@ -1425,7 +1491,7 @@ export function swiftApiGapReport(output: string): string | null {
     const file = diagnostic[1]!
       .replace(new RegExp(`^(?:${XCODE_APP_DIR}|${XCODE_FRAMEWORKS_DIR}/[^/]+)/`), '')
       .replace(new RegExp(`^${XCODE_PACKAGES_DIR}/`), '')
-    const message = diagnostic[4]!
+    const message = diagnostic[4]!.trim()
     const rule = API_GAP_PATTERNS.find(([pattern]) => pattern.test(message))
     const key = rule ? rule[1](rule[0].exec(message)!) : message
     const table = rule ? gaps : other
@@ -1591,6 +1657,7 @@ async function compileRemote(
     },
     origin,
     signal,
+    (stage) => console.error(`Peach: compiling ${path.basename(packagePath)}: ${stage}`),
   )
   // the app's JS calls with the hash its own `one typegen` wrote; glue the
   // service rendered from another One would reject every call as stale.
@@ -1726,9 +1793,8 @@ export function swiftPackageWatchFiles(
   packagePath = fs.realpathSync(packagePath)
   return [
     ...(xcodeProjects.has(packagePath) ? [] : [path.join(packagePath, 'Package.swift')]),
-    ...sourceFiles(packagePath),
+    ...packageFiles(packagePath),
     ...nativeSourceFiles(packagePath),
-    ...resourceCandidateFiles(packagePath),
     ...(moduleRoot
       ? swiftModuleInputFiles(moduleRoot).map((file) => path.join(moduleRoot, file))
       : []),
@@ -1744,14 +1810,14 @@ export async function swiftPackageMetadata(
   signal?: AbortSignal,
 ): Promise<SwiftEntryModuleArgs> {
   packagePath = fs.realpathSync(packagePath)
+  const project = projectFor(packagePath, hosted, signal)
+  const limits = inputLimits(Boolean(project.hosted))
   const mains = sourceFiles(packagePath).filter(
     (file) =>
       file.endsWith('.swift') &&
       swiftApplicationEntry(
         file,
-        readPackageFile(packagePath, file, MAX_SWIFT_COMPILE_SOURCE_BYTES).toString(
-          'utf8',
-        ),
+        readPackageFile(packagePath, file, limits.sourceBytes).toString('utf8'),
       ),
   )
   const native = nativeSourceDescriptor(packagePath)
@@ -1760,7 +1826,6 @@ export async function swiftPackageMetadata(
       `swift package ${packageName} needs exactly one application entry source or generated native modules; found ${mains.length}`,
     )
   }
-  const project = projectFor(packagePath, hosted, signal)
   const entry =
     mains.length === 1
       ? path.relative(packagePath, mains[0]).split(path.sep).join(path.posix.sep)

package/src/swift-icu.ts

@@ -4,7 +4,7 @@ import { existsSync, readFileSync } from 'node:fs'
 import path from 'node:path'
 import { promisify } from 'node:util'
 import { gzip } from 'node:zlib'
-import { swiftSdkOptions } from './swift-toolchain.ts'
+import { swiftEnvironment, swiftSdkOptions } from './swift-toolchain.ts'
 
 /**
  * the icu common data a swift artifact reserves and its host fills
@@ -73,17 +73,23 @@ async function load(toolchainBin: string, sdk: string): Promise<Buffer> {
   // missing piece instead of shelling out to sdk configure.
   if (!existsSync(swift))
     throw new Error(`swift-icu: no swift at ${swift} for the ${sdk} SDK's icu data`)
-  const { stdout: listed } = await run(swift, ['sdk', 'list', ...swiftSdkOptions()])
+  const { stdout: listed } = await run(swift, ['sdk', 'list', ...swiftSdkOptions()], {
+    env: swiftEnvironment(),
+  })
   if (!listed.split('\n').some((line) => line.trim() === sdk))
     throw new Error(`swift-icu: ${sdk} is not installed for ${swift}`)
-  const { stdout } = await run(swift, [
-    'sdk',
-    'configure',
-    ...swiftSdkOptions(),
-    '--show-configuration',
-    sdk,
-    'wasm32-unknown-wasip1',
-  ])
+  const { stdout } = await run(
+    swift,
+    [
+      'sdk',
+      'configure',
+      ...swiftSdkOptions(),
+      '--show-configuration',
+      sdk,
+      'wasm32-unknown-wasip1',
+    ],
+    { env: swiftEnvironment() },
+  )
   const resources = /^swiftStaticResourcesPath: (.+)$/m.exec(stdout)?.[1]?.trim()
   if (!resources) throw new Error(`swift-icu: ${sdk} names no static resources`)
   // a copy, so the 42 MB archive it was sliced from can be collected