From f7d30f3a326c77d76a6db4438b1d222fd3faac3e Mon Sep 17 00:00:00 2001 From: seanperez Date: Fri, 21 Aug 2026 16:51:46 -0400 Subject: [PATCH 1/2] feat(init): add iOS project inspection foundations --- bun.lock | 14 + packages/cli-core/package.json | 2 + .../commands/init/ios/build-settings.test.ts | 496 +++++ .../src/commands/init/ios/build-settings.ts | 973 +++++++++ .../src/commands/init/ios/discovery.ts | 330 +++ .../init/ios/file-transaction.test.ts | 925 +++++++++ .../src/commands/init/ios/file-transaction.ts | 1163 +++++++++++ .../src/commands/init/ios/inspect.test.ts | 589 ++++++ .../cli-core/src/commands/init/ios/inspect.ts | 1662 ++++++++++++++++ .../src/commands/init/ios/pbx.test.ts | 116 ++ .../cli-core/src/commands/init/ios/pbx.ts | 129 ++ .../src/commands/init/ios/products.test.ts | 151 ++ .../src/commands/init/ios/products.ts | 59 + .../src/commands/init/ios/swift.test.ts | 879 ++++++++ .../cli-core/src/commands/init/ios/swift.ts | 1771 +++++++++++++++++ .../src/commands/init/ios/test-helpers.ts | 342 ++++ .../cli-core/src/commands/init/ios/types.ts | 228 +++ 17 files changed, 9829 insertions(+) create mode 100644 packages/cli-core/src/commands/init/ios/build-settings.test.ts create mode 100644 packages/cli-core/src/commands/init/ios/build-settings.ts create mode 100644 packages/cli-core/src/commands/init/ios/discovery.ts create mode 100644 packages/cli-core/src/commands/init/ios/file-transaction.test.ts create mode 100644 packages/cli-core/src/commands/init/ios/file-transaction.ts create mode 100644 packages/cli-core/src/commands/init/ios/inspect.test.ts create mode 100644 packages/cli-core/src/commands/init/ios/inspect.ts create mode 100644 packages/cli-core/src/commands/init/ios/pbx.test.ts create mode 100644 packages/cli-core/src/commands/init/ios/pbx.ts create mode 100644 packages/cli-core/src/commands/init/ios/products.test.ts create mode 100644 packages/cli-core/src/commands/init/ios/products.ts create mode 100644 packages/cli-core/src/commands/init/ios/swift.test.ts create mode 100644 packages/cli-core/src/commands/init/ios/swift.ts create mode 100644 packages/cli-core/src/commands/init/ios/test-helpers.ts create mode 100644 packages/cli-core/src/commands/init/ios/types.ts diff --git a/bun.lock b/bun.lock index 1b6b8490..87a03379 100644 --- a/bun.lock +++ b/bun.lock @@ -32,9 +32,11 @@ "clerk": "./src/cli.ts", }, "dependencies": { + "@bacons/xcode": "1.0.0-alpha.33", "@clack/prompts": "^1.7.0", "@clerk/cli-extras": "workspace:*", "@commander-js/extra-typings": "^15.0.0", + "@expo/plist": "0.0.18", "@napi-rs/keyring": "^1.3.0", "commander": "^15.0.0", "env-paths": "^4.0.0", @@ -72,6 +74,8 @@ "@babel/types": ["@babel/types@7.29.0", "", { "dependencies": { "@babel/helper-string-parser": "^7.27.1", "@babel/helper-validator-identifier": "^7.28.5" } }, "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A=="], + "@bacons/xcode": ["@bacons/xcode@1.0.0-alpha.33", "", { "dependencies": { "@expo/plist": "^0.0.18", "debug": "^4.3.4", "uuid": "^8.3.2" } }, "sha512-+vwXK3mLnW8NOYSHNpCa7sAYR7qWmIHM3xBbBkLailN81F1CdSVsJBH1TAnTMHb+rDEh5ehsZ8AQRNVxvhWR/Q=="], + "@changesets/apply-release-plan": ["@changesets/apply-release-plan@7.1.1", "", { "dependencies": { "@changesets/config": "^3.1.4", "@changesets/get-version-range-type": "^0.4.0", "@changesets/git": "^3.0.4", "@changesets/should-skip-package": "^0.1.2", "@changesets/types": "^6.1.0", "@manypkg/get-packages": "^1.1.3", "detect-indent": "^6.0.0", "fs-extra": "^7.0.1", "lodash.startcase": "^4.4.0", "outdent": "^0.5.0", "prettier": "^2.7.1", "resolve-from": "^5.0.0", "semver": "^7.5.3" } }, "sha512-9qPCm/rLx/xoOFXIHGB229+4GOL76S4MC+7tyOuTsR6+1jYlfFDQORdvwR5hDA6y4FL2BPt3qpbcQIS+dW85LA=="], "@changesets/assemble-release-plan": ["@changesets/assemble-release-plan@6.0.10", "", { "dependencies": { "@changesets/errors": "^0.2.0", "@changesets/get-dependents-graph": "^2.1.4", "@changesets/should-skip-package": "^0.1.2", "@changesets/types": "^6.1.0", "@manypkg/get-packages": "^1.1.3", "semver": "^7.5.3" } }, "sha512-rSDcqdJ9KbVyjpBIuCidhvZNIiVt1XaIYp73ycVQRIA5n/j6wQaEk0ChRLMUQ1vkxZe51PTQ9OIhbg6HQMW45A=="], @@ -122,6 +126,8 @@ "@commander-js/extra-typings": ["@commander-js/extra-typings@15.0.0", "", { "peerDependencies": { "commander": "~15.0.0" } }, "sha512-yeJlba62xqmkgELUsn7356MEnzLLu/fw2x4lofFqGnXh6YysRdEs2BaLeLtg1+KU0AXvMeqQvTTp+3hBEBK+EA=="], + "@expo/plist": ["@expo/plist@0.0.18", "", { "dependencies": { "@xmldom/xmldom": "~0.7.0", "base64-js": "^1.2.3", "xmlbuilder": "^14.0.0" } }, "sha512-+48gRqUiz65R21CZ/IXa7RNBXgAI/uPSdvJqoN9x1hfL44DNbUoWHgHiEXTx7XelcATpDwNTz6sHLfy0iNqf+w=="], + "@hono/node-server": ["@hono/node-server@1.19.14", "", { "peerDependencies": { "hono": "^4" } }, "sha512-GwtvgtXxnWsucXvbQXkRgqksiH2Qed37H9xHZocE5sA3N8O8O8/8FA3uclQXxXVzc9XBZuEOMK7+r02FmSpHtw=="], "@inquirer/external-editor": ["@inquirer/external-editor@1.0.3", "", { "dependencies": { "chardet": "^2.1.1", "iconv-lite": "^0.7.0" }, "peerDependencies": { "@types/node": ">=18" }, "optionalPeers": ["@types/node"] }, "sha512-RWbSrDiYmO4LbejWY7ttpxczuwQyZLBUyygsA9Nsv95hpzUWwnNTVQmAq3xuh7vNwCp07UTmE5i11XAEExx4RA=="], @@ -302,6 +308,8 @@ "@typescript/typescript-win32-x64": ["@typescript/typescript-win32-x64@7.0.2", "", { "os": "win32", "cpu": "x64" }, "sha512-0BQ3HkAHHlKLSp1qRvf3SUhGpGsDuhB/jgFw75guyqbxJqEaS0Cw/VFO8i2nHglJUzQCRtMMR/IBAKE3ETMC4g=="], + "@xmldom/xmldom": ["@xmldom/xmldom@0.7.13", "", {}, "sha512-lm2GW5PkosIzccsaZIz7tp8cPADSIlIHWDFTR1N0SzfinhhYgeIQjFMz4rYzanCScr3DqQLeomUDArp6MWKm+g=="], + "accepts": ["accepts@2.0.0", "", { "dependencies": { "mime-types": "^3.0.0", "negotiator": "^1.0.0" } }, "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng=="], "ajv": ["ajv@8.20.0", "", { "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2" } }, "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA=="], @@ -316,6 +324,8 @@ "array-union": ["array-union@2.1.0", "", {}, "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw=="], + "base64-js": ["base64-js@1.5.1", "", {}, "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA=="], + "better-path-resolve": ["better-path-resolve@1.0.0", "", { "dependencies": { "is-windows": "^1.0.0" } }, "sha512-pbnl5XzGBdrFU/wT4jqmJVPn2B6UHPBOhzMQkY/SPUPB6QtUXtmBHBIwCbXJol93mOpGMnQyP/+BB19q04xj7g=="], "body-parser": ["body-parser@2.3.0", "", { "dependencies": { "bytes": "^3.1.2", "content-type": "^2.0.0", "debug": "^4.4.3", "http-errors": "^2.0.1", "iconv-lite": "^0.7.2", "on-finished": "^2.4.1", "qs": "^6.15.2", "raw-body": "^3.0.2", "type-is": "^2.1.0" } }, "sha512-2cGmJupaNgg+QUwVLAucDuWuoMZ6EX9iHDRswZ5lsNYEmwPaRknMPCLZz07yTzVq/83p4o/wzbDZbBrTvGGTIw=="], @@ -658,12 +668,16 @@ "unpipe": ["unpipe@1.0.0", "", {}, "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ=="], + "uuid": ["uuid@8.3.2", "", { "bin": { "uuid": "dist/bin/uuid" } }, "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="], + "vary": ["vary@1.1.2", "", {}, "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg=="], "which": ["which@2.0.2", "", { "dependencies": { "isexe": "^2.0.0" }, "bin": { "node-which": "./bin/node-which" } }, "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA=="], "wrappy": ["wrappy@1.0.2", "", {}, "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="], + "xmlbuilder": ["xmlbuilder@14.0.0", "", {}, "sha512-ts+B2rSe4fIckR6iquDjsKbQFK2NlUk6iG5nf14mDEyldgoc2nEKZ3jZWMPTxGQwVgToSjt6VGIho1H8/fNFTg=="], + "yaml": ["yaml@2.9.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA=="], "zod": ["zod@4.4.3", "", {}, "sha512-ytENFjIJFl2UwYglde2jchW2Hwm4GJFLDiSXWdTrJQBIN9Fcyp7n4DhxJEiWNAJMV1/BqWfW/kkg71UDcHJyTQ=="], diff --git a/packages/cli-core/package.json b/packages/cli-core/package.json index 7932b943..9ef52764 100644 --- a/packages/cli-core/package.json +++ b/packages/cli-core/package.json @@ -17,9 +17,11 @@ "test": "bun test src/ --parallel" }, "dependencies": { + "@bacons/xcode": "1.0.0-alpha.33", "@clack/prompts": "^1.7.0", "@clerk/cli-extras": "workspace:*", "@commander-js/extra-typings": "^15.0.0", + "@expo/plist": "0.0.18", "@napi-rs/keyring": "^1.3.0", "commander": "^15.0.0", "env-paths": "^4.0.0", diff --git a/packages/cli-core/src/commands/init/ios/build-settings.test.ts b/packages/cli-core/src/commands/init/ios/build-settings.test.ts new file mode 100644 index 00000000..03c954b0 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/build-settings.test.ts @@ -0,0 +1,496 @@ +import { afterEach, describe, expect, test } from "bun:test"; +import { mkdir, mkdtemp, rm } from "node:fs/promises"; +import { join, resolve } from "node:path"; +import { tmpdir } from "node:os"; +import { inspectTargetBuildConfigurations } from "./build-settings.ts"; +import type { PbxObject, PbxObjects } from "./pbx.ts"; +import type { IOSDiagnostic } from "./types.ts"; + +const temporaryDirectories: string[] = []; + +afterEach(async () => { + await Promise.all(temporaryDirectories.splice(0).map((path) => rm(path, { recursive: true }))); +}); + +interface BuildSettingsFixtureOptions { + xcconfig?: string; + includedXCConfig?: string; + projectDirPath?: string; + targetBuildSettings?: Record; + projectConfigurationIds?: string[]; + targetConfigurationIds?: string[]; +} + +async function inspectFixture(options: BuildSettingsFixtureOptions = {}) { + const root = await mkdtemp(join(tmpdir(), "clerk-build-settings-")); + temporaryDirectories.push(root); + const projectPath = join(root, "Example.xcodeproj"); + const groupRootDirectory = resolve(root, options.projectDirPath ?? ""); + await mkdir(projectPath, { recursive: true }); + + const objects: PbxObjects = { + "project-list": { + isa: "XCConfigurationList", + buildConfigurations: options.projectConfigurationIds ?? ["project-debug"], + }, + "project-debug": { + isa: "XCBuildConfiguration", + name: "Debug", + buildSettings: { SDKROOT: "iphoneos" }, + }, + "target-list": { + isa: "XCConfigurationList", + buildConfigurations: options.targetConfigurationIds ?? ["target-debug"], + }, + "target-debug": { + isa: "XCBuildConfiguration", + name: "Debug", + ...(options.xcconfig ? { baseConfigurationReference: "target-xcconfig" } : {}), + buildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "com.example.Example", + DEVELOPMENT_TEAM: "ABCDE12345", + IPHONEOS_DEPLOYMENT_TARGET: "17.0", + SUPPORTED_PLATFORMS: "iphoneos iphonesimulator", + ...options.targetBuildSettings, + }, + }, + "target-release": { + isa: "XCBuildConfiguration", + name: "Release", + buildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "com.example.Example", + DEVELOPMENT_TEAM: "ABCDE12345", + IPHONEOS_DEPLOYMENT_TARGET: "17.0", + SUPPORTED_PLATFORMS: "iphoneos iphonesimulator", + }, + }, + "target-xcconfig": { + isa: "PBXFileReference", + path: "Config/Target.xcconfig", + sourceTree: "", + }, + }; + + if (options.xcconfig) { + await mkdir(join(groupRootDirectory, "Config"), { recursive: true }); + await Bun.write(join(groupRootDirectory, "Config", "Target.xcconfig"), options.xcconfig); + if (options.includedXCConfig != null) { + await Bun.write( + join(groupRootDirectory, "Config", "Included.xcconfig"), + options.includedXCConfig, + ); + } + } + + const projectObject: PbxObject = { + isa: "PBXProject", + projectDirPath: options.projectDirPath ?? "", + buildConfigurationList: "project-list", + }; + const targetObject: PbxObject = { + isa: "PBXNativeTarget", + name: "Example", + productName: "Example", + buildConfigurationList: "target-list", + }; + const diagnostics: IOSDiagnostic[] = []; + const configurations = await inspectTargetBuildConfigurations({ + root, + projectPath, + groupRootDirectory, + projectObject, + targetId: "target", + targetObject, + objects, + parents: new Map(), + diagnostics, + }); + return { configurations, diagnostics, root }; +} + +describe("inspectTargetBuildConfigurations", () => { + test("merges braced inherited values across project and target settings", async () => { + const projectObject: PbxObject = { + isa: "PBXProject", + buildConfigurationList: "project-list", + }; + const targetObject: PbxObject = { + isa: "PBXNativeTarget", + name: "Example", + productName: "Example", + buildConfigurationList: "target-list", + }; + const objects: PbxObjects = { + "project-list": { + isa: "XCConfigurationList", + buildConfigurations: ["project-debug"], + }, + "project-debug": { + isa: "XCBuildConfiguration", + name: "Debug", + buildSettings: { PRODUCT_BUNDLE_IDENTIFIER: "com.example", SDKROOT: "iphoneos" }, + }, + "target-list": { + isa: "XCConfigurationList", + buildConfigurations: ["target-debug"], + }, + "target-debug": { + isa: "XCBuildConfiguration", + name: "Debug", + buildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "${inherited}.MyApp", + IPHONEOS_DEPLOYMENT_TARGET: "17.0", + SUPPORTED_PLATFORMS: "iphoneos iphonesimulator", + }, + }, + }; + + const configurations = await inspectTargetBuildConfigurations({ + root: "/tmp/Example", + projectPath: "/tmp/Example/Example.xcodeproj", + groupRootDirectory: "/tmp/Example", + projectObject, + targetId: "target", + targetObject, + objects, + parents: new Map(), + diagnostics: [], + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.MyApp", + }); + }); + + test("keeps unsupported Xcode build-setting modifiers unresolved", async () => { + const projectObject: PbxObject = { + isa: "PBXProject", + buildConfigurationList: "project-list", + }; + const targetObject: PbxObject = { + isa: "PBXNativeTarget", + name: "Example", + productName: "Example", + buildConfigurationList: "target-list", + }; + const objects: PbxObjects = { + "project-list": { + isa: "XCConfigurationList", + buildConfigurations: ["project-debug"], + }, + "project-debug": { + isa: "XCBuildConfiguration", + name: "Debug", + buildSettings: { SDKROOT: "iphoneos" }, + }, + "target-list": { + isa: "XCConfigurationList", + buildConfigurations: ["target-debug"], + }, + "target-debug": { + isa: "XCBuildConfiguration", + name: "Debug", + buildSettings: { + PRODUCT_NAME: "My App", + PRODUCT_BUNDLE_IDENTIFIER: "com.example.$(PRODUCT_NAME:rfc1034identifier)", + IPHONEOS_DEPLOYMENT_TARGET: "17.0", + SUPPORTED_PLATFORMS: "iphoneos iphonesimulator", + }, + }, + }; + const diagnostics: IOSDiagnostic[] = []; + + const configurations = await inspectTargetBuildConfigurations({ + root: "/tmp/Example", + projectPath: "/tmp/Example/Example.xcodeproj", + groupRootDirectory: "/tmp/Example", + projectObject, + targetId: "target", + targetObject, + objects, + parents: new Map(), + diagnostics, + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "unresolved", + raw: "com.example.$(PRODUCT_NAME:rfc1034identifier)", + missingVariables: ["PRODUCT_NAME:rfc1034identifier"], + }); + expect(diagnostics).toEqual([ + expect.objectContaining({ + code: "xcode.unresolved-build-setting", + message: expect.stringContaining("PRODUCT_NAME:rfc1034identifier"), + }), + ]); + }); + + test("uses projectDirPath for group refs while keeping SRCROOT and PROJECT_DIR at the project container", async () => { + const { configurations, root } = await inspectFixture({ + projectDirPath: "Sources", + xcconfig: [ + "PRODUCT_BUNDLE_IDENTIFIER = com.example.$(PROJECT_NAME)", + "DEVELOPMENT_TEAM = $(PROJECT_DIR)", + "CODE_SIGN_ENTITLEMENTS = $(SRCROOT)/Example.entitlements", + ].join("\n"), + targetBuildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)", + DEVELOPMENT_TEAM: "$(inherited)", + CODE_SIGN_ENTITLEMENTS: "$(inherited)", + }, + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.Example", + }); + expect(configurations[0]?.model.developmentTeam).toMatchObject({ + state: "resolved", + value: root, + }); + expect(configurations[0]?.model.entitlementsPath).toMatchObject({ + state: "resolved", + value: join(root, "Example.entitlements"), + }); + }); + + test("surfaces device and simulator conditional build-setting differences", async () => { + const { configurations, diagnostics } = await inspectFixture({ + targetBuildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "com.example.Base", + "PRODUCT_BUNDLE_IDENTIFIER[sdk=iphoneos*]": "com.example.Device", + "PRODUCT_BUNDLE_IDENTIFIER[sdk=iphonesimulator*]": "com.example.Simulator", + }, + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "unresolved", + missingVariables: ["sdk-conditioned build setting"], + }); + expect(diagnostics).toContainEqual( + expect.objectContaining({ + code: "xcode.conflicting-build-setting", + message: expect.stringContaining( + "iphoneos=com.example.Device, iphonesimulator=com.example.Simulator", + ), + }), + ); + }); + + test("accepts matching device and simulator conditional build settings", async () => { + const { configurations } = await inspectFixture({ + targetBuildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "com.example.Base", + "PRODUCT_BUNDLE_IDENTIFIER[sdk=iphoneos*]": "com.example.Native", + "PRODUCT_BUNDLE_IDENTIFIER[sdk=iphonesimulator*]": "com.example.Native", + }, + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.Native", + }); + }); + + test("preserves the textual order of xcconfig assignments and includes", async () => { + const includeLast = await inspectFixture({ + xcconfig: [ + "PRODUCT_BUNDLE_IDENTIFIER = com.example.Before", + '#include "Included.xcconfig"', + ].join("\n"), + includedXCConfig: "PRODUCT_BUNDLE_IDENTIFIER = com.example.Included\n", + targetBuildSettings: { PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)" }, + }); + const assignmentLast = await inspectFixture({ + xcconfig: [ + '#include "Included.xcconfig"', + "PRODUCT_BUNDLE_IDENTIFIER = com.example.After", + ].join("\n"), + includedXCConfig: "PRODUCT_BUNDLE_IDENTIFIER = com.example.Included\n", + targetBuildSettings: { PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)" }, + }); + + expect(includeLast.configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.Included", + }); + expect(assignmentLast.configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.After", + }); + }); + + test("taints fallback settings when a required xcconfig include is missing", async () => { + const { configurations, diagnostics } = await inspectFixture({ + xcconfig: [ + "PRODUCT_BUNDLE_IDENTIFIER = com.example.Fallback", + '#include "Missing.xcconfig"', + ].join("\n"), + targetBuildSettings: { PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)" }, + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "unresolved", + missingVariables: ["required xcconfig include"], + }); + expect(diagnostics).toContainEqual( + expect.objectContaining({ + code: "xcode.unresolved-build-setting", + message: expect.stringContaining("Required xcconfig include"), + }), + ); + }); + + test("clears an earlier unknown-include taint only with a later literal assignment", async () => { + const { configurations } = await inspectFixture({ + xcconfig: [ + '#include "Missing.xcconfig"', + "PRODUCT_BUNDLE_IDENTIFIER = com.example.Resolved", + "TEAM_VALUE = ABCDE12345", + "DEVELOPMENT_TEAM = $(TEAM_VALUE)", + ].join("\n"), + targetBuildSettings: { + PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)", + DEVELOPMENT_TEAM: "$(inherited)", + }, + }); + + expect(configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.Resolved", + }); + expect(configurations[0]?.model.developmentTeam).toMatchObject({ + state: "unresolved", + missingVariables: ["required xcconfig include"], + }); + }); + + test("taints settings for variable include paths but permits a missing literal optional include", async () => { + const variable = await inspectFixture({ + xcconfig: [ + "PRODUCT_BUNDLE_IDENTIFIER = com.example.Fallback", + '#include? "$(CONFIG_DIR)/Optional.xcconfig"', + ].join("\n"), + targetBuildSettings: { PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)" }, + }); + const literalOptional = await inspectFixture({ + xcconfig: [ + '#include? "Missing.xcconfig"', + "PRODUCT_BUNDLE_IDENTIFIER = com.example.Resolved", + ].join("\n"), + targetBuildSettings: { PRODUCT_BUNDLE_IDENTIFIER: "$(inherited)" }, + }); + + expect(variable.configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "unresolved", + missingVariables: ["variable xcconfig include path"], + }); + expect(variable.diagnostics).toContainEqual( + expect.objectContaining({ + code: "xcode.unresolved-build-setting", + message: expect.stringContaining("path contains build-setting variables"), + }), + ); + expect(literalOptional.configurations[0]?.model.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.Resolved", + }); + }); + + test("keeps targets with variable-based platform settings as iOS candidates", async () => { + const { configurations, diagnostics } = await inspectFixture({ + targetBuildSettings: { + SDKROOT: "$(UNKNOWN_SDK)", + SUPPORTED_PLATFORMS: "$(UNKNOWN_PLATFORMS)", + IPHONEOS_DEPLOYMENT_TARGET: "", + }, + }); + + expect(configurations[0]?.isIOS).toBe(true); + expect(diagnostics).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + code: "xcode.unresolved-build-setting", + message: expect.stringContaining("SDKROOT"), + }), + expect.objectContaining({ + code: "xcode.unresolved-build-setting", + message: expect.stringContaining("SUPPORTED_PLATFORMS"), + }), + ]), + ); + }); + + test("keeps targets with include-tainted platform settings as iOS candidates", async () => { + const { configurations } = await inspectFixture({ + xcconfig: [ + '#include "Missing.xcconfig"', + "SDKROOT = $(UNKNOWN_SDK)", + "SUPPORTED_PLATFORMS = $(UNKNOWN_PLATFORMS)", + ].join("\n"), + targetBuildSettings: { + SDKROOT: "$(inherited)", + SUPPORTED_PLATFORMS: "$(inherited)", + IPHONEOS_DEPLOYMENT_TARGET: "", + }, + }); + + expect(configurations[0]?.isIOS).toBe(true); + }); + + test("still rejects targets with fully resolved non-iOS platform evidence", async () => { + const { configurations } = await inspectFixture({ + targetBuildSettings: { + SDKROOT: "watchos", + SUPPORTED_PLATFORMS: "watchos watchsimulator", + IPHONEOS_DEPLOYMENT_TARGET: "", + }, + }); + + expect(configurations[0]?.isIOS).toBe(false); + }); + + test("preserves dangling target configurations as blocking placeholders", async () => { + const { configurations, diagnostics } = await inspectFixture({ + targetConfigurationIds: ["target-debug", "missing-target-release"], + }); + + expect(configurations).toHaveLength(2); + expect(configurations[1]?.model).toMatchObject({ + name: "Unresolved (missing-target-release)", + bundleIdentifier: { state: "missing" }, + }); + expect(diagnostics).toContainEqual( + expect.objectContaining({ + code: "xcode.dangling-reference", + severity: "error", + message: expect.stringContaining("missing-target-release"), + }), + ); + }); + + test("taints target settings when the project configuration list is incomplete", async () => { + const { configurations, diagnostics } = await inspectFixture({ + projectConfigurationIds: ["project-debug", "missing-project-release"], + targetConfigurationIds: ["target-debug", "target-release"], + }); + + expect(configurations.map((configuration) => configuration.model.bundleIdentifier)).toEqual([ + expect.objectContaining({ + state: "unresolved", + missingVariables: ["incomplete project configuration list"], + }), + expect.objectContaining({ + state: "unresolved", + missingVariables: ["incomplete project configuration list"], + }), + ]); + expect(diagnostics).toContainEqual( + expect.objectContaining({ + code: "xcode.dangling-reference", + message: expect.stringContaining("missing-project-release"), + }), + ); + }); +}); diff --git a/packages/cli-core/src/commands/init/ios/build-settings.ts b/packages/cli-core/src/commands/init/ios/build-settings.ts new file mode 100644 index 00000000..1a350262 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/build-settings.ts @@ -0,0 +1,973 @@ +import { readFile } from "node:fs/promises"; +import { dirname, resolve, sep } from "node:path"; +import { parse as parseXCConfig } from "@bacons/xcode/xcconfig"; +import { pathIsSafelyWithinIOSRoot, pathIsWithinIOSRoot, relativeIOSPath } from "./discovery.ts"; +import { + asString, + asStringArray, + asStringRecord, + resolvePbxFilePath, + type PbxObject, + type PbxObjects, +} from "./pbx.ts"; +import type { + IOSBuildConfiguration, + IOSDiagnostic, + IOSSourceEvidence, + IOSValueResolution, +} from "./types.ts"; + +const MAX_XCCONFIG_DEPTH = 12; +const BUILD_SETTING_VARIABLE = /\$\(([^)]+)\)|\$\{([^}]+)\}/g; +const INSPECTED_BUILD_SETTING_KEYS = [ + "PRODUCT_BUNDLE_IDENTIFIER", + "DEVELOPMENT_TEAM", + "CODE_SIGN_ENTITLEMENTS", + "IPHONEOS_DEPLOYMENT_TARGET", + "SDKROOT", + "SUPPORTED_PLATFORMS", +] as const; +const INSPECTED_BUILD_SETTINGS = new Set(INSPECTED_BUILD_SETTING_KEYS); + +interface BuildContext { + label: "iphoneos" | "iphonesimulator"; + sdk: "iphoneos" | "iphonesimulator"; + arch: "arm64"; +} + +interface BuildSettingsEvaluation { + settings: Record; + /** Unknown inputs are tracked independently for each inspected setting. */ + settingTaints: Map; +} + +type XCConfigOperation = + | { kind: "include"; path: string; optional: boolean } + | { kind: "setting"; key: string; value: string; conditions?: XCConfigCondition[] }; + +const BUILD_CONTEXTS: BuildContext[] = [ + { label: "iphoneos", sdk: "iphoneos", arch: "arm64" }, + { label: "iphonesimulator", sdk: "iphonesimulator", arch: "arm64" }, +]; + +interface XCConfigCondition { + sdk?: string; + arch?: string; + config?: string; +} + +function wildcardMatches(value: string, pattern: string): boolean { + const escaped = pattern.replace(/[.+^${}()|[\]\\]/g, "\\$&").replaceAll("*", ".*"); + return new RegExp(`^${escaped}$`, "i").test(value); +} + +function conditionsMatch( + conditions: XCConfigCondition[] | undefined, + configuration: string, + context: BuildContext, +): boolean { + return (conditions ?? []).every((condition) => { + if (condition.sdk && !wildcardMatches(context.sdk, condition.sdk)) return false; + if (condition.arch && !wildcardMatches(context.arch, condition.arch)) return false; + if (condition.config && !wildcardMatches(configuration, condition.config)) return false; + return true; + }); +} + +function applySettings(base: Record, next: Record): void { + for (const [key, value] of Object.entries(next)) { + base[key] = value.replace(/\$(?:\(inherited\)|\{inherited\})/gi, base[key] ?? "").trim(); + } +} + +function cloneEvaluation(evaluation: BuildSettingsEvaluation): BuildSettingsEvaluation { + return { + settings: { ...evaluation.settings }, + settingTaints: cloneSettingTaints(evaluation.settingTaints), + }; +} + +function taintInspectedSettings(evaluation: BuildSettingsEvaluation, taint: string): void { + for (const key of INSPECTED_BUILD_SETTING_KEYS) { + addSettingTaint(evaluation.settingTaints, key, taint); + } +} + +function applyEvaluatedSetting( + evaluation: BuildSettingsEvaluation, + key: string, + value: string, + conditions: XCConfigCondition[] | undefined, +): void { + applySettings(evaluation.settings, { [key]: value }); + if (!INSPECTED_BUILD_SETTINGS.has(key)) return; + + // An unconditional literal assignment fully overrides any earlier unknown + // include for this setting. Inherited or variable-derived values may still + // depend on the skipped input, so retain their existing taint. + if ((conditions?.length ?? 0) === 0 && !hasBuildSettingVariable(value)) { + evaluation.settingTaints.delete(key); + } +} + +function hasBuildSettingVariable(value: string): boolean { + BUILD_SETTING_VARIABLE.lastIndex = 0; + const result = BUILD_SETTING_VARIABLE.test(value); + BUILD_SETTING_VARIABLE.lastIndex = 0; + return result; +} + +function unique(values: string[]): string[] { + return [...new Set(values)]; +} + +function addDiagnosticOnce(diagnostics: IOSDiagnostic[], diagnostic: IOSDiagnostic): void { + if ( + diagnostics.some( + (candidate) => candidate.code === diagnostic.code && candidate.message === diagnostic.message, + ) + ) { + return; + } + diagnostics.push(diagnostic); +} + +function parseXCConfigOperations(content: string): XCConfigOperation[] { + const operations: XCConfigOperation[] = []; + // @bacons/xcode intentionally exposes includes and assignments separately. + // Parsing one source line at a time retains their interleaving, which is + // significant because a later include can override an earlier assignment. + for (const line of content.split(/\r?\n/)) { + const parsed = parseXCConfig(line); + const include = parsed.includes[0]?.include; + if (include) { + operations.push({ + kind: "include", + path: include.path, + optional: include.optional, + }); + continue; + } + const setting = parsed.buildSettings[0]; + if (setting) { + operations.push({ + kind: "setting", + key: setting.key, + value: setting.value, + conditions: setting.conditions, + }); + } + } + return operations; +} + +function unresolvedXCConfig( + root: string, + path: string, + diagnostics: IOSDiagnostic[], + message: string, + taint: string, + inherited: BuildSettingsEvaluation, +): BuildSettingsEvaluation { + addDiagnosticOnce(diagnostics, { + code: "xcode.unresolved-build-setting", + severity: "warning", + message, + remedy: + "Check in the required xcconfig and use a literal include path before automating setup.", + evidence: [{ path: relativeIOSPath(root, path), keyPath: "include" }], + }); + const evaluation = cloneEvaluation(inherited); + taintInspectedSettings(evaluation, taint); + return evaluation; +} + +async function readXCConfigSettings( + root: string, + path: string, + configuration: string, + context: BuildContext, + diagnostics: IOSDiagnostic[], + inherited: BuildSettingsEvaluation = { settings: {}, settingTaints: new Map() }, + visited: Set = new Set(), + depth = 0, + optional = false, +): Promise { + if (depth >= MAX_XCCONFIG_DEPTH) { + const unresolved = unresolvedXCConfig( + root, + path, + diagnostics, + `Could not fully evaluate ${relativeIOSPath(root, path)} because xcconfig includes exceeded the inspection depth limit.`, + "xcconfig include depth", + inherited, + ); + return unresolved; + } + if (visited.has(path)) { + const unresolved = unresolvedXCConfig( + root, + path, + diagnostics, + `Could not fully evaluate ${relativeIOSPath(root, path)} because its xcconfig includes form a cycle.`, + "xcconfig include cycle", + inherited, + ); + return unresolved; + } + if (!(await pathIsSafelyWithinIOSRoot(root, path))) { + addDiagnosticOnce(diagnostics, { + code: "xcode.external-path", + severity: "warning", + message: `Skipped xcconfig outside the inspected project root: ${path}`, + evidence: [{ path }], + }); + const evaluation = cloneEvaluation(inherited); + // Even an optional include can exist outside the inspected root and + // override local values. Since we intentionally do not read it, its + // contribution remains unknown. + taintInspectedSettings(evaluation, "xcconfig outside project root"); + return evaluation; + } + + let content: string; + try { + const file = Bun.file(path); + if (!(await file.exists())) { + if (optional) { + return cloneEvaluation(inherited); + } + const unresolved = unresolvedXCConfig( + root, + path, + diagnostics, + `Required xcconfig include ${relativeIOSPath(root, path)} does not exist.`, + "required xcconfig include", + inherited, + ); + return unresolved; + } + if (file.size > 1_000_000) { + const unresolved = unresolvedXCConfig( + root, + path, + diagnostics, + `Could not evaluate ${relativeIOSPath(root, path)} because the xcconfig is too large to inspect safely.`, + "unreadable xcconfig include", + inherited, + ); + return unresolved; + } + content = await readFile(path, "utf8"); + } catch { + const unresolved = unresolvedXCConfig( + root, + path, + diagnostics, + `Could not read required xcconfig include ${relativeIOSPath(root, path)}.`, + "unreadable xcconfig include", + inherited, + ); + return unresolved; + } + + const nextVisited = new Set(visited); + nextVisited.add(path); + let evaluation = cloneEvaluation(inherited); + + for (const operation of parseXCConfigOperations(content)) { + if (operation.kind === "setting") { + if (!conditionsMatch(operation.conditions, configuration, context)) continue; + applyEvaluatedSetting(evaluation, operation.key, operation.value, operation.conditions); + continue; + } + // Paths containing build variables cannot be resolved safely without an + // Xcode build context. Leave those settings unresolved rather than guess. + if (hasBuildSettingVariable(operation.path)) { + taintInspectedSettings(evaluation, "variable xcconfig include path"); + addDiagnosticOnce(diagnostics, { + code: "xcode.unresolved-build-setting", + severity: "warning", + message: `${relativeIOSPath(root, path)} has an xcconfig include whose path contains build-setting variables.`, + remedy: "Use a literal checked-in include path before automating setup.", + evidence: [{ path: relativeIOSPath(root, path), keyPath: "include" }], + }); + continue; + } + const includePath = resolve(dirname(path), operation.path); + const included = await readXCConfigSettings( + root, + includePath, + configuration, + context, + diagnostics, + evaluation, + nextVisited, + depth + 1, + operation.optional, + ); + evaluation = included; + } + + return evaluation; +} + +function stripSurroundingQuotes(value: string): string { + const trimmed = value.trim(); + if ( + trimmed.length >= 2 && + ((trimmed.startsWith('"') && trimmed.endsWith('"')) || + (trimmed.startsWith("'") && trimmed.endsWith("'"))) + ) { + return trimmed.slice(1, -1); + } + return trimmed; +} + +function cloneSettingTaints(source: Map): Map { + return new Map([...source].map(([key, values]) => [key, [...values]])); +} + +function addSettingTaint(settingTaints: Map, key: string, taint: string): void { + settingTaints.set(key, unique([...(settingTaints.get(key) ?? []), taint])); +} + +function parseInlineBuildSettingKey( + rawKey: string, +): + | { key: string; conditions: XCConfigCondition[]; supported: true } + | { key: string; supported: false } { + const match = rawKey.match(/^([a-zA-Z_][a-zA-Z0-9_]*)((?:\[[^\]]+\])*)$/); + if (!match) return { key: rawKey, supported: false }; + const key = match[1]; + if (!key) return { key: rawKey, supported: false }; + const suffix = match[2] ?? ""; + if (!suffix) return { key, conditions: [], supported: true }; + + const conditions: XCConfigCondition[] = []; + let consumed = ""; + for (const conditionMatch of suffix.matchAll(/\[([a-zA-Z]+)=([^\]]+)\]/g)) { + consumed += conditionMatch[0]; + const rawType = conditionMatch[1]; + const value = conditionMatch[2]; + if (!rawType || !value) return { key, supported: false }; + const type = rawType.toLowerCase(); + if (!["sdk", "arch", "config"].includes(type)) { + return { key, supported: false }; + } + if (type === "sdk") conditions.push({ sdk: value }); + if (type === "arch") conditions.push({ arch: value }); + if (type === "config") conditions.push({ config: value }); + } + if (consumed !== suffix) return { key, supported: false }; + return { key, conditions, supported: true }; +} + +function applyInlineBuildSettings( + evaluation: BuildSettingsEvaluation, + rawSettings: Record, + configuration: string, + context: BuildContext, +): void { + const parsed = Object.entries(rawSettings).map(([rawKey, value], order) => ({ + parsedKey: parseInlineBuildSettingKey(rawKey), + value, + order, + })); + + // A PBX buildSettings value is a dictionary, not an ordered instruction + // stream. Apply unconditional values first, followed by increasingly + // specific matching conditions. This lets an SDK-qualified value override + // its base value regardless of serialization order. + parsed.sort((left, right) => { + const leftSpecificity = + left.parsedKey.supported && "conditions" in left.parsedKey + ? left.parsedKey.conditions.length + : Number.MAX_SAFE_INTEGER; + const rightSpecificity = + right.parsedKey.supported && "conditions" in right.parsedKey + ? right.parsedKey.conditions.length + : Number.MAX_SAFE_INTEGER; + return leftSpecificity - rightSpecificity || left.order - right.order; + }); + + for (const entry of parsed) { + if (!entry.parsedKey.supported) { + addSettingTaint( + evaluation.settingTaints, + entry.parsedKey.key, + "unsupported conditional build setting", + ); + continue; + } + if (!conditionsMatch(entry.parsedKey.conditions, configuration, context)) continue; + applyEvaluatedSetting(evaluation, entry.parsedKey.key, entry.value, entry.parsedKey.conditions); + } +} + +function resolveSetting( + key: string, + evaluation: BuildSettingsEvaluation, + builtins: Record, + evidence: IOSSourceEvidence, +): IOSValueResolution { + const settings = evaluation.settings; + const initial = settings[key]; + const taints = evaluation.settingTaints.get(key) ?? []; + if ((initial == null || initial.trim() === "") && taints.length === 0) { + return { state: "missing", evidence: [evidence] }; + } + + const missingVariables = new Set(taints); + const resolveValue = (raw: string, stack: Set): string => { + BUILD_SETTING_VARIABLE.lastIndex = 0; + return raw.replace(BUILD_SETTING_VARIABLE, (match, parenthesized, braced) => { + const variableWithModifier = String(parenthesized ?? braced); + // Xcode build-setting modifiers transform values (for example, + // `:rfc1034identifier`). Replacing only the base variable would silently + // produce a different value, so preserve the expression as unresolved. + if (variableWithModifier.includes(":")) { + missingVariables.add(variableWithModifier); + return match; + } + const variable = variableWithModifier.split(":", 1)[0] ?? variableWithModifier; + if (variable.toLowerCase() === "inherited") return ""; + if (stack.has(variable)) { + missingVariables.add(variable); + return `$(${variableWithModifier})`; + } + + const replacement = settings[variable] ?? builtins[variable]; + if (replacement == null) { + missingVariables.add(variable); + return `$(${variableWithModifier})`; + } + + const nextStack = new Set(stack); + nextStack.add(variable); + return resolveValue(replacement, nextStack); + }); + }; + + const raw = initial ?? ""; + const value = stripSurroundingQuotes(resolveValue(raw, new Set([key]))); + if (missingVariables.size > 0 || hasBuildSettingVariable(value)) { + return { + state: "unresolved", + raw, + missingVariables: [...missingVariables].sort(), + evidence: [evidence], + }; + } + + return { state: "resolved", value, evidence: [evidence] }; +} + +interface ConfigurationReference { + id: string; + object?: PbxObject; +} + +function configurationReferences( + listId: string | undefined, + objects: PbxObjects, + diagnostics: IOSDiagnostic[], + evidencePath: string, + owner: string, +): { references: ConfigurationReference[]; complete: boolean } { + if (!listId) { + addDiagnosticOnce(diagnostics, { + code: "xcode.dangling-reference", + severity: "error", + message: `${owner} has no XCConfigurationList reference.`, + remedy: "Repair the Xcode project build-configuration list before automating setup.", + evidence: [{ path: evidencePath, keyPath: "buildConfigurationList" }], + }); + return { references: [], complete: false }; + } + const list = objects[listId]; + if (list?.isa !== "XCConfigurationList") { + addDiagnosticOnce(diagnostics, { + code: "xcode.dangling-reference", + severity: "error", + message: `${owner} references a missing or invalid XCConfigurationList (${listId}).`, + remedy: "Repair the Xcode project build-configuration list before automating setup.", + evidence: [{ path: evidencePath, objectId: listId }], + }); + return { references: [], complete: false }; + } + + let complete = true; + const references = asStringArray(list.buildConfigurations).map((id) => { + const object = objects[id]; + if (object?.isa === "XCBuildConfiguration") return { id, object }; + complete = false; + addDiagnosticOnce(diagnostics, { + code: "xcode.dangling-reference", + severity: "error", + message: `${owner} references a missing or invalid XCBuildConfiguration (${id}).`, + remedy: + "Repair or remove the dangling build-configuration reference before automating setup.", + evidence: [{ path: evidencePath, objectId: listId, keyPath: "buildConfigurations" }], + }); + return { id }; + }); + return { references, complete }; +} + +async function settingsForConfiguration( + root: string, + projectPath: string, + projectDirectory: string, + groupRootDirectory: string, + configuration: PbxObject | undefined, + configurationName: string, + context: BuildContext, + objects: PbxObjects, + parents: Map, + diagnostics: IOSDiagnostic[], + inherited: BuildSettingsEvaluation = { + settings: {}, + settingTaints: new Map(), + }, +): Promise { + let evaluation = cloneEvaluation(inherited); + if (!configuration) return evaluation; + const baseReference = asString(configuration.baseConfigurationReference); + if (baseReference) { + const configPath = resolvePbxFilePath( + baseReference, + objects, + parents, + projectDirectory, + groupRootDirectory, + ); + if (configPath) { + if (hasBuildSettingVariable(configPath)) { + taintInspectedSettings(evaluation, "variable base xcconfig path"); + addDiagnosticOnce(diagnostics, { + code: "xcode.unresolved-build-setting", + severity: "warning", + message: "An XCBuildConfiguration base xcconfig path contains build-setting variables.", + remedy: "Use a literal checked-in base xcconfig path before automating setup.", + evidence: [ + { + path: relativeIOSPath(root, resolve(projectPath, "project.pbxproj")), + objectId: baseReference, + keyPath: "baseConfigurationReference", + }, + ], + }); + } else { + evaluation = await readXCConfigSettings( + root, + configPath, + configurationName, + context, + diagnostics, + evaluation, + ); + } + } else { + taintInspectedSettings(evaluation, "unresolved base xcconfig reference"); + addDiagnosticOnce(diagnostics, { + code: "xcode.dangling-reference", + severity: "error", + message: `Could not resolve an XCBuildConfiguration baseConfigurationReference (${baseReference}).`, + remedy: "Repair the base xcconfig file reference before automating setup.", + evidence: [ + { + path: relativeIOSPath(root, resolve(projectPath, "project.pbxproj")), + objectId: baseReference, + keyPath: "baseConfigurationReference", + }, + ], + }); + } + } + applyInlineBuildSettings( + evaluation, + asStringRecord(configuration.buildSettings), + configurationName, + context, + ); + return evaluation; +} + +export interface InspectedTargetConfiguration { + model: IOSBuildConfiguration; + settings: Record; + isIOS: boolean; +} + +interface EvaluatedBuildContext { + context: BuildContext; + evaluation: BuildSettingsEvaluation; + builtins: Record; +} + +function resolutionSignature(resolution: IOSValueResolution): string { + if (resolution.state === "resolved") return `resolved:${resolution.value}`; + if (resolution.state === "missing") return "missing"; + return `unresolved:${resolution.raw}:${resolution.missingVariables.join(",")}`; +} + +function resolutionDisplay(resolution: IOSValueResolution): string { + if (resolution.state === "resolved") return resolution.value; + return resolution.state === "missing" ? "" : ""; +} + +function resolveSettingAcrossContexts( + key: string, + contexts: EvaluatedBuildContext[], + evidence: IOSSourceEvidence, + targetName: string, + configurationName: string, + diagnostics: IOSDiagnostic[], +): IOSValueResolution { + const variants = contexts.map(({ context, evaluation, builtins }) => ({ + context, + resolution: resolveSetting(key, evaluation, builtins, evidence), + })); + const signatures = new Set(variants.map(({ resolution }) => resolutionSignature(resolution))); + if (signatures.size <= 1) + return variants[0]?.resolution ?? { state: "missing", evidence: [evidence] }; + + addDiagnosticOnce(diagnostics, { + code: "xcode.conflicting-build-setting", + severity: "warning", + message: `${targetName} ${configurationName} has different ${key} values by SDK: ${variants + .map(({ context, resolution }) => `${context.label}=${resolutionDisplay(resolution)}`) + .join(", ")}`, + remedy: "Make device and simulator values consistent or select the intended SDK explicitly.", + evidence: variants.flatMap(({ resolution }) => resolution.evidence), + }); + + return { + state: "unresolved", + raw: variants + .map(({ context, resolution }) => `${context.label}=${resolutionDisplay(resolution)}`) + .join("; "), + missingVariables: unique([ + "sdk-conditioned build setting", + ...variants.flatMap(({ resolution }) => + resolution.state === "unresolved" ? resolution.missingVariables : [], + ), + ]).sort(), + evidence: variants.flatMap(({ resolution }) => resolution.evidence), + }; +} + +function missingConfiguration( + root: string, + projectPath: string, + configurationId: string, +): InspectedTargetConfiguration { + const evidence: IOSSourceEvidence = { + path: relativeIOSPath(root, resolve(projectPath, "project.pbxproj")), + objectId: configurationId, + keyPath: "buildConfigurations", + }; + const missing: IOSValueResolution = { state: "missing", evidence: [evidence] }; + return { + model: { + name: `Unresolved (${configurationId})`, + bundleIdentifier: missing, + developmentTeam: missing, + entitlementsPath: missing, + deploymentTarget: missing, + }, + settings: {}, + // The product type identifies this as an application target, but the + // dangling configuration does not contain enough evidence to exclude iOS. + isIOS: true, + }; +} + +export async function inspectTargetBuildConfigurations(options: { + root: string; + projectPath: string; + groupRootDirectory: string; + projectObject: PbxObject; + targetId: string; + targetObject: PbxObject; + objects: PbxObjects; + parents: Map; + diagnostics: IOSDiagnostic[]; +}): Promise { + const { + root, + projectPath, + groupRootDirectory, + projectObject, + targetId, + targetObject, + objects, + parents, + diagnostics, + } = options; + const projectDirectory = dirname(projectPath); + const pbxprojRelativePath = relativeIOSPath(root, resolve(projectPath, "project.pbxproj")); + const projectConfigurationReferences = configurationReferences( + asString(projectObject.buildConfigurationList), + objects, + diagnostics, + pbxprojRelativePath, + "PBXProject", + ); + const projectConfigsByName = new Map( + projectConfigurationReferences.references.flatMap(({ object }) => + object ? [[asString(object.name) ?? "", object] as const] : [], + ), + ); + const targetName = asString(targetObject.name) ?? "App"; + const targetConfigurationReferences = configurationReferences( + asString(targetObject.buildConfigurationList), + objects, + diagnostics, + pbxprojRelativePath, + `Target ${targetName}`, + ); + const inspected: InspectedTargetConfiguration[] = []; + + for (const targetReference of targetConfigurationReferences.references.sort((a, b) => + (asString(a.object?.name) ?? a.id).localeCompare(asString(b.object?.name) ?? b.id), + )) { + const targetConfig = targetReference.object; + if (!targetConfig) { + inspected.push(missingConfiguration(root, projectPath, targetReference.id)); + continue; + } + const name = asString(targetConfig.name) ?? "Unnamed"; + const evaluatedContexts: EvaluatedBuildContext[] = []; + for (const context of BUILD_CONTEXTS) { + const inherited: BuildSettingsEvaluation = { + settings: {}, + settingTaints: new Map(), + }; + const projectSettings = await settingsForConfiguration( + root, + projectPath, + projectDirectory, + groupRootDirectory, + projectConfigsByName.get(name), + name, + context, + objects, + parents, + diagnostics, + inherited, + ); + const evaluation = await settingsForConfiguration( + root, + projectPath, + projectDirectory, + groupRootDirectory, + targetConfig, + name, + context, + objects, + parents, + diagnostics, + projectSettings, + ); + // A dangling project configuration cannot be attributed to Debug or + // Release, so keep completeness unknown even when another layer has a + // literal override. This is structural evidence, not an ordered + // xcconfig include that a later assignment can supersede. + if (!projectConfigurationReferences.complete) { + taintInspectedSettings(evaluation, "incomplete project configuration list"); + } + + const productName = + evaluation.settings.PRODUCT_NAME ?? asString(targetObject.productName) ?? targetName; + evaluatedContexts.push({ + context, + evaluation, + builtins: { + SRCROOT: projectDirectory, + PROJECT_DIR: projectDirectory, + PROJECT_NAME: + projectPath + .split(sep) + .at(-1) + ?.replace(/\.xcodeproj$/, "") ?? targetName, + TARGET_NAME: targetName, + PRODUCT_NAME: productName, + CONFIGURATION: name, + }, + }); + } + + const deviceContext = evaluatedContexts[0]; + if (!deviceContext) continue; + const evidence = (setting: string): IOSSourceEvidence => ({ + path: pbxprojRelativePath, + objectId: targetId, + keyPath: `buildConfigurations.${name}.buildSettings.${setting}`, + }); + const supportedPlatformsResolution = resolveSettingAcrossContexts( + "SUPPORTED_PLATFORMS", + evaluatedContexts, + evidence("SUPPORTED_PLATFORMS"), + targetName, + name, + diagnostics, + ); + const supportedPlatforms = + supportedPlatformsResolution.state === "resolved" ? supportedPlatformsResolution.value : ""; + const activeContexts = + supportedPlatformsResolution.state === "resolved" && + supportedPlatforms.trim() !== "" && + !/\biphonesimulator\b/.test(supportedPlatforms) + ? [deviceContext] + : evaluatedContexts; + const sdkRootResolution = resolveSettingAcrossContexts( + "SDKROOT", + activeContexts, + evidence("SDKROOT"), + targetName, + name, + diagnostics, + ); + const deploymentTarget = resolveSettingAcrossContexts( + "IPHONEOS_DEPLOYMENT_TARGET", + activeContexts, + evidence("IPHONEOS_DEPLOYMENT_TARGET"), + targetName, + name, + diagnostics, + ); + const sdkRoot = sdkRootResolution.state === "resolved" ? sdkRootResolution.value : ""; + const hasIOSSDK = sdkRootResolution.state === "resolved" && sdkRoot.includes("iphoneos"); + const hasIOSPlatform = + supportedPlatformsResolution.state === "resolved" && + /iphone(?:os|simulator)/.test(supportedPlatforms); + const hasPositiveIOSEvidence = + deploymentTarget.state !== "missing" || hasIOSSDK || hasIOSPlatform; + const hasUnknownPlatformEvidence = + sdkRootResolution.state === "unresolved" || + supportedPlatformsResolution.state === "unresolved"; + const hasResolvedNonIOSEvidence = + (sdkRootResolution.state === "resolved" && sdkRoot !== "" && !hasIOSSDK) || + (supportedPlatformsResolution.state === "resolved" && + supportedPlatforms !== "" && + !hasIOSPlatform); + const explicitlyNonIOS = + !hasPositiveIOSEvidence && !hasUnknownPlatformEvidence && hasResolvedNonIOSEvidence; + + const model: IOSBuildConfiguration = { + name, + bundleIdentifier: resolveSettingAcrossContexts( + "PRODUCT_BUNDLE_IDENTIFIER", + activeContexts, + evidence("PRODUCT_BUNDLE_IDENTIFIER"), + targetName, + name, + diagnostics, + ), + developmentTeam: resolveSettingAcrossContexts( + "DEVELOPMENT_TEAM", + activeContexts, + evidence("DEVELOPMENT_TEAM"), + targetName, + name, + diagnostics, + ), + entitlementsPath: resolveSettingAcrossContexts( + "CODE_SIGN_ENTITLEMENTS", + activeContexts, + evidence("CODE_SIGN_ENTITLEMENTS"), + targetName, + name, + diagnostics, + ), + deploymentTarget, + }; + const relevantSettings: Array<[string, IOSValueResolution]> = [ + ["PRODUCT_BUNDLE_IDENTIFIER", model.bundleIdentifier], + ["DEVELOPMENT_TEAM", model.developmentTeam], + ["CODE_SIGN_ENTITLEMENTS", model.entitlementsPath], + ["IPHONEOS_DEPLOYMENT_TARGET", model.deploymentTarget], + ["SDKROOT", sdkRootResolution], + ["SUPPORTED_PLATFORMS", supportedPlatformsResolution], + ]; + for (const [setting, resolution] of relevantSettings) { + if (resolution.state !== "unresolved") continue; + addDiagnosticOnce(diagnostics, { + code: "xcode.unresolved-build-setting", + severity: "warning", + message: `${targetName} ${name} has an unresolved ${setting} value (${resolution.missingVariables.join(", ") || "unknown variable"}).`, + remedy: "Make the setting resolvable from the project or its checked-in xcconfig files.", + evidence: resolution.evidence, + }); + } + + inspected.push({ + model, + settings: deviceContext.evaluation.settings, + isIOS: !explicitlyNonIOS, + }); + } + + return inspected; +} + +export function addBuildSettingConflictDiagnostics( + targetName: string, + configurations: IOSBuildConfiguration[], + diagnostics: IOSDiagnostic[], +): void { + const checks: Array<[string, (config: IOSBuildConfiguration) => IOSValueResolution]> = [ + ["PRODUCT_BUNDLE_IDENTIFIER", (config) => config.bundleIdentifier], + ["DEVELOPMENT_TEAM", (config) => config.developmentTeam], + ["CODE_SIGN_ENTITLEMENTS", (config) => config.entitlementsPath], + ]; + + for (const [setting, select] of checks) { + const values = configurations.map((configuration) => ({ + name: configuration.name, + resolution: select(configuration), + })); + const signatures = new Set( + values.map(({ resolution }) => + resolution.state === "resolved" + ? `resolved:${resolution.value}` + : resolution.state === "unresolved" + ? `unresolved:${resolution.raw}` + : "missing", + ), + ); + if (signatures.size <= 1) continue; + + diagnostics.push({ + code: "xcode.conflicting-build-setting", + severity: "warning", + message: `${targetName} has different ${setting} values across build configurations: ${values + .map( + ({ name, resolution }) => + `${name}=${ + resolution.state === "resolved" + ? resolution.value + : resolution.state === "unresolved" + ? "" + : "" + }`, + ) + .join(", ")}`, + remedy: "Select one configuration or make the values consistent before automating setup.", + evidence: values.flatMap((item) => item.resolution.evidence), + }); + } +} + +export function resolveEntitlementsAbsolutePath( + root: string, + projectPath: string, + resolution: IOSValueResolution, +): string | undefined { + if (resolution.state !== "resolved") return undefined; + const path = resolution.value; + const absolute = resolve(dirname(projectPath), path); + return pathIsWithinIOSRoot(root, absolute) ? absolute : undefined; +} diff --git a/packages/cli-core/src/commands/init/ios/discovery.ts b/packages/cli-core/src/commands/init/ios/discovery.ts new file mode 100644 index 00000000..0b83ceb3 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/discovery.ts @@ -0,0 +1,330 @@ +import { readdir, realpath } from "node:fs/promises"; +import { basename, dirname, isAbsolute, relative, resolve, sep } from "node:path"; +import type { IOSWorkspaceInspection } from "./types.ts"; + +const MAX_DISCOVERY_DEPTH = 3; +const MAX_EXHAUSTIVE_DISCOVERY_DEPTH = 24; +const MAX_DISCOVERY_DIRECTORIES = 10_000; +const MAX_DISCOVERED_CONTAINERS = 1_000; +const IGNORED_DIRECTORIES = new Set([ + ".build", + ".git", + ".swiftpm", + "build", + "Carthage", + "DerivedData", + "node_modules", + "Pods", + "SourcePackages", +]); + +export interface IOSContainerDiscovery { + projectPaths: string[]; + workspacePaths: string[]; + /** False when a bounded or unreadable traversal could have hidden another container. */ + complete: boolean; +} + +export interface IOSContainerDiscoveryOptions { + /** + * Traverse deeply enough for strict cross-target source-ownership proofs. + * Any traversal limit or read failure is returned as incomplete so callers + * can fail closed instead of treating a partial inventory as exhaustive. + */ + exhaustive?: boolean; +} + +interface ContainerWalkState { + complete: boolean; + directoriesVisited: number; + maxDepth: number; + includeHiddenDirectories: boolean; +} + +function isWithinRoot(root: string, path: string): boolean { + const rel = relative(root, path); + return rel === "" || (!rel.startsWith(`..${sep}`) && rel !== ".." && !isAbsolute(rel)); +} + +export function relativeIOSPath(root: string, path: string): string { + const rel = relative(root, path); + return rel === "" ? "." : rel.split(sep).join("/"); +} + +/** + * Checks both the lexical path and every existing filesystem ancestor. This + * prevents an in-root symlink from turning a supposedly local read into a read + * somewhere else on disk. Non-existent leaf paths are allowed only when their + * nearest existing ancestor is still within the real root. + */ +export async function pathIsSafelyWithinIOSRoot( + rootInput: string, + candidateInput: string, +): Promise { + const root = resolve(rootInput); + const candidate = resolve(candidateInput); + if (!isWithinRoot(root, candidate)) return false; + + let realRoot: string; + try { + realRoot = await realpath(root); + } catch { + return false; + } + + let existingAncestor = candidate; + const missingSegments: string[] = []; + let realAncestor: string | undefined; + while (isWithinRoot(root, existingAncestor)) { + try { + realAncestor = await realpath(existingAncestor); + break; + } catch { + if (existingAncestor === root) break; + missingSegments.unshift(basename(existingAncestor)); + const parent = dirname(existingAncestor); + if (parent === existingAncestor) break; + existingAncestor = parent; + } + } + + if (!realAncestor) return false; + return isWithinRoot(realRoot, resolve(realAncestor, ...missingSegments)); +} + +async function walkContainers( + directory: string, + depth: number, + projects: Set, + workspaces: Set, + state: ContainerWalkState, +): Promise { + if (state.directoriesVisited >= MAX_DISCOVERY_DIRECTORIES) { + state.complete = false; + return; + } + state.directoriesVisited += 1; + + let entries; + try { + entries = await readdir(directory, { withFileTypes: true }); + } catch { + state.complete = false; + return; + } + + entries.sort((a, b) => a.name.localeCompare(b.name)); + for (const entry of entries) { + if (!entry.isDirectory()) continue; + const absolutePath = resolve(directory, entry.name); + + if (entry.name.endsWith(".xcodeproj")) { + if (projects.size + workspaces.size >= MAX_DISCOVERED_CONTAINERS) { + state.complete = false; + continue; + } + projects.add(absolutePath); + continue; + } + + if (entry.name.endsWith(".xcworkspace")) { + // Xcode creates a private workspace inside every .xcodeproj. It is an + // implementation detail, not a user-selectable workspace. + if (!directory.endsWith(".xcodeproj")) { + if (projects.size + workspaces.size >= MAX_DISCOVERED_CONTAINERS) { + state.complete = false; + continue; + } + workspaces.add(absolutePath); + } + continue; + } + + if (IGNORED_DIRECTORIES.has(entry.name)) continue; + if (!state.includeHiddenDirectories && entry.name.startsWith(".")) continue; + if (depth >= state.maxDepth) { + state.complete = false; + continue; + } + await walkContainers(absolutePath, depth + 1, projects, workspaces, state); + } +} + +export async function discoverIOSContainers( + rootInput: string, + options: IOSContainerDiscoveryOptions = {}, +): Promise { + const root = resolve(rootInput); + const projects = new Set(); + const workspaces = new Set(); + const exhaustive = options.exhaustive === true; + const state: ContainerWalkState = { + complete: true, + directoriesVisited: 0, + maxDepth: exhaustive ? MAX_EXHAUSTIVE_DISCOVERY_DEPTH : MAX_DISCOVERY_DEPTH, + includeHiddenDirectories: exhaustive, + }; + + if (root.endsWith(".xcodeproj")) { + projects.add(root); + } else if (root.endsWith(".xcworkspace")) { + workspaces.add(root); + } else { + await walkContainers(root, 0, projects, workspaces, state); + } + + return { + projectPaths: [...projects].sort(), + workspacePaths: [...workspaces].sort(), + complete: state.complete, + }; +} + +function decodeXMLAttribute(value: string): string { + return value + .replaceAll(""", '"') + .replaceAll("'", "'") + .replaceAll("<", "<") + .replaceAll(">", ">") + .replaceAll("&", "&"); +} + +export function xmlAttribute(source: string, name: string): string | undefined { + let cursor = 0; + while (cursor < source.length) { + while (/\s/.test(source[cursor] ?? "")) cursor += 1; + const attributeName = /^[A-Za-z_:][A-Za-z0-9_.:-]*/.exec(source.slice(cursor))?.[0]; + if (!attributeName) { + cursor += 1; + continue; + } + cursor += attributeName.length; + while (/\s/.test(source[cursor] ?? "")) cursor += 1; + if (source[cursor] !== "=") continue; + cursor += 1; + while (/\s/.test(source[cursor] ?? "")) cursor += 1; + const quote = source[cursor]; + if (quote !== '"' && quote !== "'") continue; + const valueStart = ++cursor; + const valueEnd = source.indexOf(quote, valueStart); + if (valueEnd === -1) return undefined; + if (attributeName === name) { + return decodeXMLAttribute(source.slice(valueStart, valueEnd)); + } + cursor = valueEnd + 1; + } + return undefined; +} + +function resolveWorkspaceLocation( + base: string, + location: string | undefined, + containerBase: string, +): string { + if (!location) return base; + const separatorIndex = location.indexOf(":"); + const scheme = separatorIndex === -1 ? "group" : location.slice(0, separatorIndex); + const rawPath = separatorIndex === -1 ? location : location.slice(separatorIndex + 1); + if (scheme === "absolute") return resolve(rawPath); + if (scheme === "container") return resolve(containerBase, rawPath); + return resolve(base, rawPath); +} + +/** + * Masks XML comments without joining the bytes on either side. Removing a + * comment outright could synthesize markup from two otherwise inert fragments + * (for example, `leRef>`). + */ +function maskXMLComments(source: string): string { + const chunks: string[] = []; + let cursor = 0; + while (cursor < source.length) { + const start = source.indexOf("", start + 4); + const end = closing === -1 ? source.length : closing + 3; + chunks.push(" ".repeat(end - start)); + cursor = end; + } + return chunks.join(""); +} + +/** + * Reads only project references from an Xcode workspace. We deliberately do + * not use Xcode or resolve packages. Unsupported/external references remain + * visible in the workspace inventory but are not traversed. + */ +export async function inspectWorkspace( + rootInput: string, + workspacePath: string, +): Promise<{ inspection: IOSWorkspaceInspection; localProjectPaths: string[] }> { + const root = resolve(rootInput); + const contentsPath = resolve(workspacePath, "contents.xcworkspacedata"); + let xml = ""; + try { + if (!(await pathIsSafelyWithinIOSRoot(root, contentsPath))) { + throw new Error("external workspace"); + } + const file = Bun.file(contentsPath); + if (!(await file.exists()) || file.size > 2_000_000) throw new Error("unreadable workspace"); + xml = maskXMLComments(await file.text()); + } catch { + return { + inspection: { path: relativeIOSPath(root, workspacePath), projectPaths: [] }, + localProjectPaths: [], + }; + } + + const projectPaths = new Set(); + const localProjectPaths = new Set(); + const workspaceDirectory = dirname(workspacePath); + const groupBases = [workspaceDirectory]; + const elementPattern = /<(\/)?(Workspace|Group|FileRef)\b([^>]*)>/g; + for (const match of xml.matchAll(elementPattern)) { + const closing = match[1] === "/"; + const tag = match[2]; + const attributes = match[3] ?? ""; + if (tag === "Group") { + if (closing) { + if (groupBases.length > 1) groupBases.pop(); + } else { + const base = groupBases.at(-1) ?? workspaceDirectory; + groupBases.push( + resolveWorkspaceLocation(base, xmlAttribute(attributes, "location"), workspaceDirectory), + ); + if (attributes.trimEnd().endsWith("/")) groupBases.pop(); + } + continue; + } + if (closing || tag !== "FileRef") continue; + + const location = xmlAttribute(attributes, "location"); + const base = groupBases.at(-1) ?? workspaceDirectory; + const embeddedProject = + location === "self:" && workspaceDirectory.endsWith(".xcodeproj") + ? workspaceDirectory + : undefined; + if (!embeddedProject && !location?.endsWith(".xcodeproj")) continue; + const absolutePath = + embeddedProject ?? resolveWorkspaceLocation(base, location, workspaceDirectory); + const safelyLocal = await pathIsSafelyWithinIOSRoot(root, absolutePath); + projectPaths.add(safelyLocal ? relativeIOSPath(root, absolutePath) : absolutePath); + if (safelyLocal) localProjectPaths.add(absolutePath); + } + + return { + inspection: { + path: relativeIOSPath(root, workspacePath), + projectPaths: [...projectPaths].sort(), + }, + localProjectPaths: [...localProjectPaths].sort(), + }; +} + +export function pathIsWithinIOSRoot(rootInput: string, candidate: string): boolean { + return isWithinRoot(resolve(rootInput), resolve(candidate)); +} diff --git a/packages/cli-core/src/commands/init/ios/file-transaction.test.ts b/packages/cli-core/src/commands/init/ios/file-transaction.test.ts new file mode 100644 index 00000000..9af8b818 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/file-transaction.test.ts @@ -0,0 +1,925 @@ +import { afterEach, describe, expect, test } from "bun:test"; +import { + chmod, + lstat, + mkdir, + mkdtemp, + open, + readFile, + readdir, + rename, + rm, + symlink, + writeFile, +} from "node:fs/promises"; +import { tmpdir } from "node:os"; +import { dirname, join } from "node:path"; +import { + applyIOSExistingFileTransaction, + applyIOSFileTransaction, + hashIOSFileBytes, + IOSFileTransactionError, + type IOSCreateFileMutation, + type IOSExistingFileMutation, +} from "./file-transaction.ts"; + +const temporaryDirectories: string[] = []; + +async function temporaryRoot(): Promise { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-file-transaction-")); + temporaryDirectories.push(root); + return root; +} + +async function mutation(path: string, candidate: string): Promise { + const originalBytes = new Uint8Array(await readFile(path)); + const candidateBytes = new TextEncoder().encode(candidate); + const info = await lstat(path); + return { + path, + originalBytes, + originalHash: hashIOSFileBytes(originalBytes), + candidateBytes, + candidateHash: hashIOSFileBytes(candidateBytes), + mode: info.mode & 0o7777, + }; +} + +async function createMutation( + path: string, + candidate: string, + mode = 0o644, +): Promise { + const candidateBytes = new TextEncoder().encode(candidate); + const parent = await lstat(dirname(path)); + return { + kind: "create", + path, + expectedParentIdentity: { device: parent.dev, inode: parent.ino }, + candidateBytes, + candidateHash: hashIOSFileBytes(candidateBytes), + mode, + }; +} + +async function expectNoTemporaryFiles(root: string): Promise { + expect((await readdir(root)).filter((name) => name.includes(".clerk-"))).toEqual([]); +} + +async function expectRecoverableClaimedOriginals( + root: string, + expectedContents: string[], +): Promise { + const transactionFiles = (await readdir(root)).filter((name) => name.includes(".clerk-")); + const claimedOriginals = transactionFiles.filter((name) => name.endsWith(".claimed")); + expect(transactionFiles.filter((name) => name.endsWith(".tmp"))).toEqual([]); + expect( + (await Promise.all(claimedOriginals.map((name) => readFile(join(root, name), "utf8")))).sort(), + ).toEqual([...expectedContents].sort()); +} + +async function waitForCondition(condition: () => boolean | Promise): Promise { + for (let attempt = 0; attempt < 5_000; attempt++) { + if (await condition()) return; + await Bun.sleep(1); + } + throw new Error("Timed out waiting for the file transaction test condition."); +} + +async function waitForStagingFile(root: string): Promise { + await waitForCondition(async () => + (await readdir(root)).some((name) => name.includes(".clerk-")), + ); +} + +function errorText(value: unknown, seen = new Set()): string { + if (value == null || seen.has(value)) return ""; + if (typeof value !== "object") return String(value); + seen.add(value); + if (value instanceof AggregateError) { + return `${value.name}: ${value.message}\n${value.errors + .map((error) => errorText(error, seen)) + .join("\n")}`; + } + if (value instanceof Error) { + return `${value.name}: ${value.message}\n${errorText(value.cause, seen)}`; + } + return ""; +} + +afterEach(async () => { + await Promise.all( + temporaryDirectories.splice(0).map((path) => rm(path, { recursive: true, force: true })), + ); +}); + +describe("iOS existing-file transaction", () => { + test("stages and commits every file sequentially while preserving modes", async () => { + const root = await temporaryRoot(); + const firstPath = join(root, "project.pbxproj"); + const secondPath = join(root, "App.swift"); + await writeFile(firstPath, "original project\n"); + await writeFile(secondPath, "original source\n"); + await chmod(firstPath, 0o640); + await chmod(secondPath, 0o600); + const mutations = await Promise.all([ + mutation(firstPath, "candidate project\n"), + mutation(secondPath, "candidate source\n"), + ]); + let firstValidated = false; + let secondValidated = false; + + const result = await applyIOSExistingFileTransaction(mutations, [ + async () => { + await Promise.resolve(); + firstValidated = true; + return (await readFile(firstPath, "utf8")) === "candidate project\n"; + }, + async () => { + await Promise.resolve(); + secondValidated = true; + return (await readFile(secondPath, "utf8")) === "candidate source\n"; + }, + ]); + + expect(result).toEqual({ status: "applied" }); + expect(firstValidated).toBe(true); + expect(secondValidated).toBe(true); + expect(await readFile(firstPath, "utf8")).toBe("candidate project\n"); + expect(await readFile(secondPath, "utf8")).toBe("candidate source\n"); + expect((await lstat(firstPath)).mode & 0o7777).toBe(0o640); + expect((await lstat(secondPath)).mode & 0o7777).toBe(0o600); + await expectNoTemporaryFiles(root); + }); + + test("keeps the public destination present and both crash states recoverable", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original source\n"); + const prepared = await mutation(path, "candidate source\n"); + let backupPath: string | undefined; + const observed: string[] = []; + + const result = await applyIOSExistingFileTransaction([prepared], [async () => true], { + beforeExistingDestinationBackup: async (destinationPath) => { + expect(await readFile(destinationPath, "utf8")).toBe("original source\n"); + observed.push("before-backup"); + }, + afterExistingDestinationBackup: async (destinationPath, createdBackupPath) => { + backupPath = createdBackupPath; + expect(await readFile(destinationPath, "utf8")).toBe("original source\n"); + expect(await readFile(createdBackupPath, "utf8")).toBe("original source\n"); + const stagedPath = (await readdir(root)).find((name) => name.endsWith(".tmp")); + if (!stagedPath) throw new Error("expected the staged candidate to remain recoverable"); + expect(await readFile(join(root, stagedPath), "utf8")).toBe("candidate source\n"); + observed.push("backup-before-rename"); + }, + beforeExistingDestinationReplace: async (destinationPath, createdBackupPath) => { + expect(await readFile(destinationPath, "utf8")).toBe("original source\n"); + expect(await readFile(createdBackupPath, "utf8")).toBe("original source\n"); + observed.push("immediately-before-rename"); + }, + afterExistingDestinationReplace: async (destinationPath, createdBackupPath) => { + expect(await readFile(destinationPath, "utf8")).toBe("candidate source\n"); + expect(await readFile(createdBackupPath, "utf8")).toBe("original source\n"); + expect((await readdir(root)).filter((name) => name.endsWith(".tmp"))).toEqual([]); + observed.push("candidate-and-backup-after-rename"); + }, + }); + + expect(result).toEqual({ status: "applied" }); + expect(observed).toEqual([ + "before-backup", + "backup-before-rename", + "immediately-before-rename", + "candidate-and-backup-after-rename", + ]); + expect(backupPath).toBeDefined(); + await expect(lstat(backupPath!)).rejects.toMatchObject({ code: "ENOENT" }); + expect(await readFile(path, "utf8")).toBe("candidate source\n"); + await expectNoTemporaryFiles(root); + }); + + test("atomically restores the verified backup without an absent destination window", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original source\n"); + const prepared = await mutation(path, "candidate source\n"); + let backupPath: string | undefined; + + const result = await applyIOSExistingFileTransaction([prepared], [async () => false], { + afterExistingDestinationBackup: (_destinationPath, createdBackupPath) => { + backupPath = createdBackupPath; + }, + beforeRollbackDestinationReplace: async (destinationPath, originalSourcePath) => { + expect(await readFile(destinationPath, "utf8")).toBe("candidate source\n"); + expect(backupPath).toBe(originalSourcePath); + expect(await readFile(originalSourcePath, "utf8")).toBe("original source\n"); + }, + afterRollbackDestinationReplace: async (destinationPath) => { + expect(await readFile(destinationPath, "utf8")).toBe("original source\n"); + expect(backupPath).toBeDefined(); + await expect(lstat(backupPath!)).rejects.toMatchObject({ code: "ENOENT" }); + }, + }); + + expect(result).toEqual({ status: "rolled-back" }); + expect(await readFile(path, "utf8")).toBe("original source\n"); + await expectNoTemporaryFiles(root); + }); + + test("rolls back an after-rename failure without exposing candidate source bytes", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + const sensitiveCandidate = "pk_test_candidate_must_not_escape"; + await writeFile(path, "original source\n"); + const prepared = await mutation(path, sensitiveCandidate); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction([prepared], [async () => true], { + afterExistingDestinationReplace: () => { + throw new Error("forced after-rename failure"); + }, + }); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("commit-failed"); + expect(errorText(caught)).not.toContain(sensitiveCandidate); + expect(await readFile(path, "utf8")).toBe("original source\n"); + await expectNoTemporaryFiles(root); + }); + + test("runs every postcondition and rolls back every file byte-for-byte", async () => { + const root = await temporaryRoot(); + const firstPath = join(root, "project.pbxproj"); + const secondPath = join(root, "App.swift"); + const originalProject = new Uint8Array([0, 1, 2, 255]); + const originalSource = new TextEncoder().encode("// original\r\n"); + await writeFile(firstPath, originalProject); + await writeFile(secondPath, originalSource); + const sensitiveCandidate = "pk_test_candidate_must_not_escape"; + const mutations = await Promise.all([ + mutation(firstPath, `candidate ${sensitiveCandidate}`), + mutation(secondPath, `candidate ${sensitiveCandidate}`), + ]); + let throwingValidatorRan = false; + let falseValidatorRan = false; + + const result = await applyIOSExistingFileTransaction(mutations, [ + async () => { + throwingValidatorRan = true; + throw new Error(sensitiveCandidate); + }, + async () => { + falseValidatorRan = true; + return false; + }, + ]); + + expect(result).toEqual({ status: "rolled-back" }); + expect(JSON.stringify(result)).not.toContain(sensitiveCandidate); + expect(throwingValidatorRan).toBe(true); + expect(falseValidatorRan).toBe(true); + expect(new Uint8Array(await readFile(firstPath))).toEqual(originalProject); + expect(new Uint8Array(await readFile(secondPath))).toEqual(originalSource); + await expectNoTemporaryFiles(root); + }); + + test("rejects a candidate edit after an earlier postcondition validates it", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original source\n"); + const prepared = await mutation(path, "candidate source\n"); + let releaseValidated: (() => void) | undefined; + const validated = new Promise((resolve) => { + releaseValidated = resolve; + }); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction( + [prepared], + [ + async () => { + const matches = (await readFile(path, "utf8")) === "candidate source\n"; + releaseValidated?.(); + return matches; + }, + async () => { + await validated; + await writeFile(path, "newer user source\n"); + return true; + }, + ], + ); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(await readFile(path, "utf8")).toBe("newer user source\n"); + await expectRecoverableClaimedOriginals(root, ["original source\n"]); + }); + + test("cleans every staged candidate and preserves newer bytes when stale", async () => { + const root = await temporaryRoot(); + const firstPath = join(root, "project.pbxproj"); + const secondPath = join(root, "App.swift"); + await writeFile(firstPath, "original project\n"); + await writeFile(secondPath, "original source\n"); + const mutations = await Promise.all([ + mutation(firstPath, "candidate project\n"), + mutation(secondPath, "candidate source\n"), + ]); + await writeFile(firstPath, "newer user project\n"); + + const result = await applyIOSExistingFileTransaction(mutations, [async () => true]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(firstPath, "utf8")).toBe("newer user project\n"); + expect(await readFile(secondPath, "utf8")).toBe("original source\n"); + await expectNoTemporaryFiles(root); + }); + + test("returns stale when the original mode changed after preparation", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "candidate\n"); + await chmod(path, 0o600); + + const result = await applyIOSExistingFileTransaction([prepared], [async () => true]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(path, "utf8")).toBe("original\n"); + expect((await lstat(path)).mode & 0o7777).toBe(0o600); + await expectNoTemporaryFiles(root); + }); + + test("returns stale when the original mode changes during staging", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "x".repeat(16 * 1024 * 1024)); + const changeMode = (async () => { + await waitForStagingFile(root); + await chmod(path, 0o600); + })(); + + const [result] = await Promise.all([ + applyIOSExistingFileTransaction([prepared], [async () => true]), + changeMode, + ]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(path, "utf8")).toBe("original\n"); + expect((await lstat(path)).mode & 0o7777).toBe(0o600); + await expectNoTemporaryFiles(root); + }); + + test("returns stale when a same-byte file replaces the original during staging", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + const replacementPath = join(root, "external-replacement.tmp"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "x".repeat(16 * 1024 * 1024)); + await writeFile(replacementPath, "original\n"); + await chmod(replacementPath, 0o640); + const replacementIdentity = await lstat(replacementPath); + const replaceOriginal = (async () => { + await waitForStagingFile(root); + await rename(replacementPath, path); + })(); + + const [result] = await Promise.all([ + applyIOSExistingFileTransaction([prepared], [async () => true]), + replaceOriginal, + ]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(path, "utf8")).toBe("original\n"); + expect((await lstat(path)).ino).toBe(replacementIdentity.ino); + await expectNoTemporaryFiles(root); + }); + + test("rechecks identity immediately before each replacement commit", async () => { + const root = await temporaryRoot(); + const firstPath = join(root, "First.swift"); + const targetPath = join(root, "Target.swift"); + const replacementPath = join(root, "external-target.tmp"); + await writeFile(firstPath, "original first\n"); + await writeFile(targetPath, "original target\n"); + await chmod(targetPath, 0o640); + const intermediatePaths = Array.from({ length: 20 }, (_, index) => + join(root, `Intermediate-${index}.swift`), + ); + await Promise.all(intermediatePaths.map((path) => writeFile(path, "original middle\n"))); + await writeFile(replacementPath, "original target\n"); + await chmod(replacementPath, 0o640); + const replacementIdentity = await lstat(replacementPath); + const prepared = await Promise.all([ + mutation(firstPath, "candidate first\n"), + ...intermediatePaths.map((path) => mutation(path, "candidate middle\n")), + mutation(targetPath, "candidate target\n"), + ]); + const replaceTarget = (async () => { + await waitForCondition(async () => { + try { + return (await readFile(firstPath, "utf8")) === "candidate first\n"; + } catch { + return false; + } + }); + await rename(replacementPath, targetPath); + })(); + + const [result] = await Promise.all([ + applyIOSExistingFileTransaction(prepared, [async () => true]), + replaceTarget, + ]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(firstPath, "utf8")).toBe("original first\n"); + for (const path of intermediatePaths) { + expect(await readFile(path, "utf8")).toBe("original middle\n"); + } + expect(await readFile(targetPath, "utf8")).toBe("original target\n"); + expect((await lstat(targetPath)).ino).toBe(replacementIdentity.ino); + await expectNoTemporaryFiles(root); + }); + + test("preserves a replacement visible before the final atomic commit check", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + const replacementPath = join(root, "external-replacement.tmp"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "candidate\n"); + await writeFile(replacementPath, "newer user source\n"); + await chmod(replacementPath, 0o600); + const replacementIdentity = await lstat(replacementPath); + + const result = await applyIOSExistingFileTransaction([prepared], [async () => true], { + beforeExistingDestinationReplace: async (destinationPath) => { + await rename(replacementPath, destinationPath); + }, + }); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(path, "utf8")).toBe("newer user source\n"); + expect((await lstat(path)).ino).toBe(replacementIdentity.ino); + expect((await lstat(path)).mode & 0o7777).toBe(0o600); + await expectNoTemporaryFiles(root); + }); + + test("preserves writes through an already-open original file descriptor", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "candidate\n"); + const editor = await open(path, "r+"); + + let result; + try { + result = await applyIOSExistingFileTransaction( + [prepared], + [ + async () => { + await editor.truncate(0); + await editor.write("newer user source through open fd\n", 0, "utf8"); + await editor.chmod(0o600); + await editor.sync(); + return true; + }, + ], + ); + } finally { + await editor.close(); + } + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(path, "utf8")).toBe("newer user source through open fd\n"); + expect((await lstat(path)).mode & 0o7777).toBe(0o600); + await expectNoTemporaryFiles(root); + }); + + test("guards rollback with candidate hashes and reports an explicit failure", async () => { + const root = await temporaryRoot(); + const firstPath = join(root, "project.pbxproj"); + const secondPath = join(root, "App.swift"); + await writeFile(firstPath, "original project\n"); + await writeFile(secondPath, "original source\n"); + const sensitiveCandidate = "pk_test_candidate_must_not_escape"; + const mutations = await Promise.all([ + mutation(firstPath, `candidate project ${sensitiveCandidate}\n`), + mutation(secondPath, `candidate source ${sensitiveCandidate}\n`), + ]); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction(mutations, [ + async () => { + await writeFile(secondPath, "newer user source\n"); + return false; + }, + ]); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(errorText(caught)).not.toContain(sensitiveCandidate); + expect(await readFile(firstPath, "utf8")).toBe(`candidate project ${sensitiveCandidate}\n`); + expect(await readFile(secondPath, "utf8")).toBe("newer user source\n"); + await expectRecoverableClaimedOriginals(root, ["original project\n", "original source\n"]); + }); + + test("preserves a candidate whose mode changed before rollback", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "candidate\n"); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction( + [prepared], + [ + async () => { + await chmod(path, 0o600); + return false; + }, + ], + ); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(await readFile(path, "utf8")).toBe("candidate\n"); + expect((await lstat(path)).mode & 0o7777).toBe(0o600); + await expectRecoverableClaimedOriginals(root, ["original\n"]); + }); + + test("preserves a same-byte file that replaced the committed candidate inode", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + const replacementPath = join(root, "external-replacement.tmp"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "candidate\n"); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction( + [prepared], + [ + async () => { + await writeFile(replacementPath, "candidate\n"); + await chmod(replacementPath, 0o640); + await rename(replacementPath, path); + return false; + }, + ], + ); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(await readFile(path, "utf8")).toBe("candidate\n"); + expect((await lstat(path)).mode & 0o7777).toBe(0o640); + await expectRecoverableClaimedOriginals(root, ["original\n"]); + }); + + test("preserves a replacement visible before the final atomic rollback check", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + const replacementPath = join(root, "external-replacement.tmp"); + await writeFile(path, "original\n"); + await chmod(path, 0o640); + const prepared = await mutation(path, "candidate\n"); + await writeFile(replacementPath, "newer user source\n"); + await chmod(replacementPath, 0o600); + const replacementIdentity = await lstat(replacementPath); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction([prepared], [async () => false], { + beforeRollbackDestinationReplace: async (destinationPath) => { + await rename(replacementPath, destinationPath); + }, + }); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(await readFile(path, "utf8")).toBe("newer user source\n"); + expect((await lstat(path)).ino).toBe(replacementIdentity.ino); + expect((await lstat(path)).mode & 0o7777).toBe(0o600); + await expectRecoverableClaimedOriginals(root, ["original\n"]); + }); + + test("rejects invalid prepared hashes without exposing candidate bytes", async () => { + const root = await temporaryRoot(); + const path = join(root, "App.swift"); + await writeFile(path, "original\n"); + const prepared = await mutation(path, "pk_test_candidate_must_not_escape"); + prepared.candidateHash = hashIOSFileBytes("different bytes"); + + let caught: unknown; + try { + await applyIOSExistingFileTransaction([prepared], []); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("invalid-mutation"); + expect(errorText(caught)).not.toContain("pk_test_candidate_must_not_escape"); + expect(await readFile(path, "utf8")).toBe("original\n"); + await expectNoTemporaryFiles(root); + }); +}); + +describe("iOS create-file transaction", () => { + test("returns stale when the prepared parent directory was replaced", async () => { + const root = await temporaryRoot(); + const synchronizedRoot = join(root, "CoolApp"); + const displacedRoot = join(root, "CoolApp-before-replacement"); + const createdPath = join(synchronizedRoot, "CoolApp.entitlements"); + await mkdir(synchronizedRoot); + const prepared = await createMutation(createdPath, "candidate entitlements\n"); + await rename(synchronizedRoot, displacedRoot); + await mkdir(synchronizedRoot); + + const result = await applyIOSFileTransaction([prepared], [async () => true]); + + expect(result).toEqual({ status: "stale" }); + await expect(lstat(createdPath)).rejects.toMatchObject({ code: "ENOENT" }); + await expect(lstat(join(displacedRoot, "CoolApp.entitlements"))).rejects.toMatchObject({ + code: "ENOENT", + }); + await expectNoTemporaryFiles(synchronizedRoot); + await expectNoTemporaryFiles(displacedRoot); + }); + + test("fails closed when the prepared parent identity changes after create staging", async () => { + const root = await temporaryRoot(); + const synchronizedRoot = join(root, "CoolApp"); + const displacedRoot = join(root, "CoolApp-before-replacement"); + const createdPath = join(synchronizedRoot, "CoolApp.entitlements"); + const sourcePath = join(root, "CoolApp.swift"); + await mkdir(synchronizedRoot); + await writeFile(sourcePath, "original source\n"); + const prepared = [ + await createMutation(createdPath, "candidate entitlements\n"), + await mutation(sourcePath, "x".repeat(16 * 1024 * 1024)), + ]; + const replaceParentAfterCreateStage = (async () => { + await waitForStagingFile(root); + await rename(synchronizedRoot, displacedRoot); + await symlink(displacedRoot, synchronizedRoot, "dir"); + })(); + + const [result] = await Promise.all([ + applyIOSFileTransaction(prepared, [async () => true]), + replaceParentAfterCreateStage, + ]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(sourcePath, "utf8")).toBe("original source\n"); + await expect(lstat(createdPath)).rejects.toMatchObject({ code: "ENOENT" }); + await expectNoTemporaryFiles(displacedRoot); + await expectNoTemporaryFiles(root); + }); + + test("restores an existing file when a create parent moves after its candidate is linked", async () => { + const root = await temporaryRoot(); + const synchronizedRoot = join(root, "CoolApp"); + const displacedRoot = join(root, "CoolApp-before-replacement"); + const createdPath = join(synchronizedRoot, "CoolApp.entitlements"); + const projectPath = join(root, "project.pbxproj"); + const concurrentPath = join(synchronizedRoot, "concurrent-user-file"); + await mkdir(synchronizedRoot); + await writeFile(concurrentPath, "newer directory state\n"); + await writeFile(projectPath, "original project\n"); + const prepared = [ + await mutation(projectPath, "candidate project\n"), + await createMutation(createdPath, "candidate entitlements\n"), + ]; + + let caught: unknown; + try { + await applyIOSFileTransaction(prepared, [async () => true], { + beforeExistingDestinationReplace: async () => { + await rename(synchronizedRoot, displacedRoot); + await mkdir(synchronizedRoot); + }, + }); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(await readFile(projectPath, "utf8")).toBe("original project\n"); + await expect(lstat(createdPath)).rejects.toMatchObject({ code: "ENOENT" }); + expect(await readFile(join(displacedRoot, "concurrent-user-file"), "utf8")).toBe( + "newer directory state\n", + ); + }); + + test("restores a committed project file if the create parent changes during postvalidation", async () => { + const root = await temporaryRoot(); + const synchronizedRoot = join(root, "CoolApp"); + const displacedRoot = join(root, "CoolApp-before-replacement"); + const createdPath = join(synchronizedRoot, "CoolApp.entitlements"); + const projectPath = join(root, "project.pbxproj"); + await mkdir(synchronizedRoot); + await writeFile(projectPath, "original project\n"); + const sensitiveCandidate = "pk_test_candidate_must_not_escape"; + const prepared = [ + await createMutation(createdPath, sensitiveCandidate), + await mutation(projectPath, "candidate project\n"), + ]; + + let caught: unknown; + try { + await applyIOSFileTransaction(prepared, [ + async () => { + await rename(synchronizedRoot, displacedRoot); + await mkdir(synchronizedRoot); + return true; + }, + ]); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(errorText(caught)).not.toContain(sensitiveCandidate); + expect(await readFile(projectPath, "utf8")).toBe("original project\n"); + await expect(lstat(createdPath)).rejects.toMatchObject({ code: "ENOENT" }); + expect(await readFile(join(displacedRoot, "CoolApp.entitlements"), "utf8")).toBe( + sensitiveCandidate, + ); + }); + + test("creates an absent file alongside a replacement and preserves both modes", async () => { + const root = await temporaryRoot(); + const existingPath = join(root, "project.pbxproj"); + const createdPath = join(root, "CoolApp.entitlements"); + await writeFile(existingPath, "original project\n"); + await chmod(existingPath, 0o600); + + const result = await applyIOSFileTransaction( + [ + await createMutation(createdPath, "created entitlements\n", 0o640), + await mutation(existingPath, "candidate project\n"), + ], + [ + async () => (await readFile(createdPath, "utf8")) === "created entitlements\n", + async () => (await readFile(existingPath, "utf8")) === "candidate project\n", + ], + ); + + expect(result).toEqual({ status: "applied" }); + expect(await readFile(createdPath, "utf8")).toBe("created entitlements\n"); + expect(await readFile(existingPath, "utf8")).toBe("candidate project\n"); + expect((await lstat(createdPath)).mode & 0o7777).toBe(0o640); + expect((await lstat(createdPath)).nlink).toBe(1); + expect((await lstat(existingPath)).mode & 0o7777).toBe(0o600); + await expectNoTemporaryFiles(root); + }); + + test("treats a formerly absent path as stale without clobbering it", async () => { + const root = await temporaryRoot(); + const existingPath = join(root, "project.pbxproj"); + const createdPath = join(root, "CoolApp.entitlements"); + await writeFile(existingPath, "original project\n"); + const mutations = [ + await mutation(existingPath, "candidate project\n"), + await createMutation(createdPath, "candidate entitlements\n"), + ]; + await writeFile(createdPath, "newer user entitlements\n"); + + const result = await applyIOSFileTransaction(mutations, [async () => true]); + + expect(result).toEqual({ status: "stale" }); + expect(await readFile(existingPath, "utf8")).toBe("original project\n"); + expect(await readFile(createdPath, "utf8")).toBe("newer user entitlements\n"); + await expectNoTemporaryFiles(root); + }); + + test("removes a created file and restores replacements when validation fails", async () => { + const root = await temporaryRoot(); + const existingPath = join(root, "project.pbxproj"); + const createdPath = join(root, "CoolApp.entitlements"); + await writeFile(existingPath, "original project\n"); + + const result = await applyIOSFileTransaction( + [ + await mutation(existingPath, "candidate project\n"), + await createMutation(createdPath, "candidate entitlements\n"), + ], + [async () => false], + ); + + expect(result).toEqual({ status: "rolled-back" }); + expect(await readFile(existingPath, "utf8")).toBe("original project\n"); + await expect(lstat(createdPath)).rejects.toMatchObject({ code: "ENOENT" }); + await expectNoTemporaryFiles(root); + }); + + test("preserves newer bytes at a created path when rollback is requested", async () => { + const root = await temporaryRoot(); + const createdPath = join(root, "CoolApp.entitlements"); + const sensitiveCandidate = "pk_test_candidate_must_not_escape"; + + let caught: unknown; + try { + await applyIOSFileTransaction( + [await createMutation(createdPath, sensitiveCandidate)], + [ + async () => { + await writeFile(createdPath, "newer user entitlements\n"); + return false; + }, + ], + ); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(errorText(caught)).not.toContain(sensitiveCandidate); + expect(await readFile(createdPath, "utf8")).toBe("newer user entitlements\n"); + await expectNoTemporaryFiles(root); + }); + + test("preserves a same-byte file that replaced the transaction's created inode", async () => { + const root = await temporaryRoot(); + const createdPath = join(root, "CoolApp.entitlements"); + const candidate = "candidate entitlements\n"; + + let caught: unknown; + try { + await applyIOSFileTransaction( + [await createMutation(createdPath, candidate)], + [ + async () => { + await rm(createdPath); + await writeFile(createdPath, candidate); + return false; + }, + ], + ); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("rollback-failed"); + expect(await readFile(createdPath, "utf8")).toBe(candidate); + await expectNoTemporaryFiles(root); + }); + + test("rejects an invalid create hash without exposing candidate bytes", async () => { + const root = await temporaryRoot(); + const createdPath = join(root, "CoolApp.entitlements"); + const sensitiveCandidate = "pk_test_candidate_must_not_escape"; + const prepared = await createMutation(createdPath, sensitiveCandidate); + prepared.candidateHash = hashIOSFileBytes("different bytes"); + + let caught: unknown; + try { + await applyIOSFileTransaction([prepared], []); + } catch (error) { + caught = error; + } + + expect(caught).toBeInstanceOf(IOSFileTransactionError); + expect((caught as IOSFileTransactionError).code).toBe("invalid-mutation"); + expect(errorText(caught)).not.toContain(sensitiveCandidate); + await expect(lstat(createdPath)).rejects.toMatchObject({ code: "ENOENT" }); + await expectNoTemporaryFiles(root); + }); +}); diff --git a/packages/cli-core/src/commands/init/ios/file-transaction.ts b/packages/cli-core/src/commands/init/ios/file-transaction.ts new file mode 100644 index 00000000..3aab961c --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/file-transaction.ts @@ -0,0 +1,1163 @@ +import { link, lstat, open, readFile, rename, rm } from "node:fs/promises"; +import { randomUUID } from "node:crypto"; +import { basename, dirname, isAbsolute, resolve } from "node:path"; + +/** + * An already-inspected existing file and its validated replacement bytes. + * + * @internal This contains candidate bytes and must never be included in CLI + * output, telemetry, serialized plans, or public errors/results. + */ +export interface IOSExistingFileMutation { + path: string; + originalBytes: Uint8Array; + originalHash: string; + candidateBytes: Uint8Array; + candidateHash: string; + mode: number; +} + +/** + * An already-inspected absent path and the validated bytes to create there. + * + * @internal This contains candidate bytes and must never be included in CLI + * output, telemetry, serialized plans, or public errors/results. + */ +export interface IOSCreateFileMutation { + kind: "create"; + path: string; + /** Exact parent directory inspected while preparing this create. */ + expectedParentIdentity: { device: number; inode: number }; + candidateBytes: Uint8Array; + candidateHash: string; + mode: number; +} + +export type IOSFileMutation = IOSExistingFileMutation | IOSCreateFileMutation; + +export type IOSFilePostcondition = () => boolean | Promise; + +export type IOSFileTransactionResult = + | { status: "applied" } + | { status: "stale" } + | { status: "rolled-back" }; + +export type IOSFileTransactionErrorCode = + | "invalid-mutation" + | "stage-failed" + | "cleanup-failed" + | "commit-failed" + | "rollback-failed"; + +/** A fixed-message failure that never carries mutation contents. */ +export class IOSFileTransactionError extends Error { + constructor( + readonly code: IOSFileTransactionErrorCode, + message: string, + options?: ErrorOptions, + ) { + super(message, options); + this.name = "IOSFileTransactionError"; + } +} + +interface StagedMutation { + mutation: IOSFileMutation; + temporaryPath: string; + temporaryPresent: boolean; + stagedIdentity: FileIdentity; + committedIdentity?: FileIdentity; + claimedOriginal?: ClaimedDestination; +} + +interface ClaimedDestination { + path: string; + present: boolean; + identity: FileIdentity; +} + +interface FileIdentity { + dev: number; + ino: number; + mode: number; +} + +interface DirectoryIdentity { + device: number; + inode: number; +} + +class IOSFileTransactionStaleError extends Error {} + +class IOSFileTransactionOwnershipError extends Error {} + +/** + * Deterministic race hooks used only by the file-transaction regression tests. + * + * @internal + */ +export interface IOSFileTransactionTestHooks { + beforeExistingDestinationBackup?: (path: string) => void | Promise; + afterExistingDestinationBackup?: (path: string, backupPath: string) => void | Promise; + beforeExistingDestinationReplace?: (path: string, backupPath: string) => void | Promise; + afterExistingDestinationReplace?: (path: string, backupPath: string) => void | Promise; + beforeRollbackDestinationReplace?: (path: string, backupPath: string) => void | Promise; + afterRollbackDestinationReplace?: (path: string) => void | Promise; +} + +export function hashIOSFileBytes(value: string | Uint8Array): string { + return new Bun.CryptoHasher("sha256").update(value).digest("hex"); +} + +function transactionError( + code: IOSFileTransactionErrorCode, + message: string, + cause?: unknown, +): IOSFileTransactionError { + return new IOSFileTransactionError(code, message, cause === undefined ? undefined : { cause }); +} + +function aggregateCause(errors: unknown[]): unknown { + return errors.length === 1 ? errors[0] : new AggregateError(errors); +} + +async function syncDirectory(path: string): Promise { + try { + const directory = await open(path, "r"); + try { + await directory.sync(); + } finally { + await directory.close(); + } + } catch { + // Same-directory rename remains atomic even when directory fsync is not + // available on the current filesystem. + } +} + +async function fileMatchesHash(path: string, expectedHash: string): Promise { + try { + const info = await lstat(path); + if (!info.isFile() || info.isSymbolicLink()) return false; + return hashIOSFileBytes(await readFile(path)) === expectedHash; + } catch { + return false; + } +} + +async function readRegularFileIdentity(path: string): Promise { + try { + const info = await lstat(path); + if (!info.isFile() || info.isSymbolicLink()) return undefined; + return { dev: info.dev, ino: info.ino, mode: info.mode & 0o7777 }; + } catch { + return undefined; + } +} + +async function readPathIdentity(path: string): Promise { + try { + const info = await lstat(path); + return { dev: info.dev, ino: info.ino, mode: info.mode & 0o7777 }; + } catch { + return undefined; + } +} + +async function readDirectoryIdentity(path: string): Promise { + try { + const info = await lstat(path); + if (!info.isDirectory() || info.isSymbolicLink()) return undefined; + return { device: info.dev, inode: info.ino }; + } catch { + return undefined; + } +} + +function identitiesMatch(left: FileIdentity, right: FileIdentity): boolean { + return left.dev === right.dev && left.ino === right.ino && left.mode === right.mode; +} + +function sameFile(left: FileIdentity, right: FileIdentity): boolean { + return left.dev === right.dev && left.ino === right.ino; +} + +async function createParentStillMatches(mutation: IOSCreateFileMutation): Promise { + const current = await readDirectoryIdentity(dirname(mutation.path)); + return ( + current !== undefined && + current.device === mutation.expectedParentIdentity.device && + current.inode === mutation.expectedParentIdentity.inode + ); +} + +async function createParentsStillMatch(mutations: readonly IOSFileMutation[]): Promise { + const matches = await Promise.all( + mutations.filter(isCreateMutation).map(async (mutation) => createParentStillMatches(mutation)), + ); + return matches.every(Boolean); +} + +async function fileMatchesIdentityAndHash( + path: string, + expectedIdentity: FileIdentity, + expectedHash: string, +): Promise { + try { + const beforeRead = await readRegularFileIdentity(path); + if (!beforeRead || !identitiesMatch(beforeRead, expectedIdentity)) return false; + const matchesHash = hashIOSFileBytes(await readFile(path)) === expectedHash; + const afterRead = await readRegularFileIdentity(path); + return matchesHash && afterRead !== undefined && identitiesMatch(afterRead, expectedIdentity); + } catch { + return false; + } +} + +async function pathIsAbsent(path: string): Promise { + try { + await lstat(path); + return false; + } catch (error) { + return isFileSystemError(error, "ENOENT"); + } +} + +function isFileSystemError(error: unknown, code: string): boolean { + return ( + typeof error === "object" && + error !== null && + "code" in error && + (error as { code?: unknown }).code === code + ); +} + +function transactionSiblingPath(path: string, purpose: string): string { + return resolve( + dirname(path), + `.${basename(path)}.clerk-${process.pid}-${randomUUID()}.${purpose}`, + ); +} + +async function removeClaimedPath( + claim: ClaimedDestination, + options: { expectedHash?: string; expectedMode?: number } = {}, +): Promise { + const currentIdentity = await readPathIdentity(claim.path); + if ( + !claim.present || + !currentIdentity || + !sameFile(currentIdentity, claim.identity) || + (options.expectedMode !== undefined && currentIdentity.mode !== options.expectedMode) || + (options.expectedHash !== undefined && + !(await fileMatchesIdentityAndHash(claim.path, currentIdentity, options.expectedHash))) + ) { + throw new IOSFileTransactionOwnershipError( + "a claimed path no longer identified the transaction's file", + ); + } + await rm(claim.path); + claim.present = false; +} + +async function restoreClaimWithoutClobber( + claim: ClaimedDestination, + destinationPath: string, +): Promise { + try { + await link(claim.path, destinationPath); + } catch (error) { + if (isFileSystemError(error, "EEXIST")) { + const destinationIdentity = await readPathIdentity(destinationPath); + if (destinationIdentity && sameFile(destinationIdentity, claim.identity)) { + await removeClaimedPath(claim); + await syncDirectory(dirname(destinationPath)); + return; + } + } + throw new IOSFileTransactionOwnershipError( + "a claimed destination could not be restored without overwriting newer filesystem state", + { cause: error }, + ); + } + + const destinationIdentity = await readPathIdentity(destinationPath); + const claimIdentity = await readPathIdentity(claim.path); + if ( + !destinationIdentity || + !claimIdentity || + !sameFile(destinationIdentity, claim.identity) || + !sameFile(claimIdentity, claim.identity) + ) { + throw new IOSFileTransactionOwnershipError( + "a restored destination no longer identified the transaction's claimed file", + ); + } + await removeClaimedPath(claim); + await syncDirectory(dirname(destinationPath)); +} + +type ClaimDestinationResult = + | { status: "claimed"; claim: ClaimedDestination } + | { status: "stale" }; + +/** + * Hard-links the authorized destination to a unique same-directory recovery + * path without ever removing the public destination. The backup remains until + * aggregate postvalidation succeeds or rollback atomically restores it. + */ +async function backupDestination( + destinationPath: string, + expectedIdentity: FileIdentity, + expectedHash: string, +): Promise { + const backupPath = transactionSiblingPath(destinationPath, "claimed"); + try { + await link(destinationPath, backupPath); + } catch (error) { + if (isFileSystemError(error, "ENOENT")) return { status: "stale" }; + throw error; + } + + const linkedIdentity = await readPathIdentity(backupPath); + if (!linkedIdentity) return { status: "stale" }; + const backup: ClaimedDestination = { + path: backupPath, + present: true, + identity: linkedIdentity, + }; + const backupIdentity = await readRegularFileIdentity(backupPath); + if (!backupIdentity) { + await removeClaimedPath(backup); + return { status: "stale" }; + } + const backupMatches = + identitiesMatch(backupIdentity, expectedIdentity) && + (await fileMatchesIdentityAndHash(backupPath, expectedIdentity, expectedHash)); + const destinationMatches = await fileMatchesIdentityAndHash( + destinationPath, + expectedIdentity, + expectedHash, + ); + if (backupMatches && destinationMatches) return { status: "claimed", claim: backup }; + + await removeClaimedPath(backup); + return { status: "stale" }; +} + +/** + * Moves an existing destination to a unique same-directory name, then proves + * which inode was moved. Unlike an overwriting rename, this never destroys a + * replacement that arrives after the caller's last stale-input check. + */ +async function claimDestination( + destinationPath: string, + expectedIdentity: FileIdentity, + expectedHash: string, +): Promise { + const claimedPath = transactionSiblingPath(destinationPath, "claimed"); + try { + await rename(destinationPath, claimedPath); + } catch (error) { + if (isFileSystemError(error, "ENOENT")) return { status: "stale" }; + throw error; + } + + const movedIdentity = await readPathIdentity(claimedPath); + if (!movedIdentity) { + throw new IOSFileTransactionOwnershipError( + "a claimed destination could not be identified after it was moved", + ); + } + const claim: ClaimedDestination = { + path: claimedPath, + present: true, + identity: movedIdentity, + }; + const movedExpectedFile = + identitiesMatch(movedIdentity, expectedIdentity) && + (await fileMatchesIdentityAndHash(claimedPath, expectedIdentity, expectedHash)); + if (movedExpectedFile) return { status: "claimed", claim }; + + await restoreClaimWithoutClobber(claim, destinationPath); + return { status: "stale" }; +} + +function isCreateMutation(mutation: IOSFileMutation): mutation is IOSCreateFileMutation { + return "kind" in mutation && mutation.kind === "create"; +} + +function validateMutations(mutations: readonly IOSFileMutation[]): void { + if (mutations.length === 0) { + throw transactionError( + "invalid-mutation", + "The iOS file transaction did not contain a file mutation.", + ); + } + + const paths = new Set(); + for (const mutation of mutations) { + if ( + !mutation.path || + paths.has(mutation.path) || + !Number.isInteger(mutation.mode) || + mutation.mode < 0 || + mutation.mode > 0o7777 || + hashIOSFileBytes(mutation.candidateBytes) !== mutation.candidateHash || + (isCreateMutation(mutation) && + (!Number.isSafeInteger(mutation.expectedParentIdentity?.device) || + mutation.expectedParentIdentity.device < 0 || + !Number.isSafeInteger(mutation.expectedParentIdentity.inode) || + mutation.expectedParentIdentity.inode < 0)) || + (!isCreateMutation(mutation) && + hashIOSFileBytes(mutation.originalBytes) !== mutation.originalHash) + ) { + throw transactionError( + "invalid-mutation", + "The iOS file transaction contained an invalid or duplicate mutation.", + ); + } + paths.add(mutation.path); + } +} + +function snapshotMutations(mutations: readonly IOSFileMutation[]): IOSFileMutation[] { + try { + return mutations.map((mutation) => { + if (!mutation.path || !isAbsolute(mutation.path)) { + throw new Error("mutation path must be absolute"); + } + if (isCreateMutation(mutation)) { + return { + kind: "create", + path: resolve(mutation.path), + expectedParentIdentity: { ...mutation.expectedParentIdentity }, + candidateBytes: new Uint8Array(mutation.candidateBytes), + candidateHash: mutation.candidateHash, + mode: mutation.mode, + }; + } + return { + path: resolve(mutation.path), + originalBytes: new Uint8Array(mutation.originalBytes), + originalHash: mutation.originalHash, + candidateBytes: new Uint8Array(mutation.candidateBytes), + candidateHash: mutation.candidateHash, + mode: mutation.mode, + }; + }); + } catch (error) { + throw transactionError( + "invalid-mutation", + "The iOS file transaction contained an invalid mutation.", + error, + ); + } +} + +async function stageBytes( + mutation: IOSFileMutation, + bytes: Uint8Array, + expectedHash: string, +): Promise { + const temporaryPath = resolve( + dirname(mutation.path), + `.${basename(mutation.path)}.clerk-${process.pid}-${randomUUID()}.tmp`, + ); + let created = false; + let openedIdentity: FileIdentity | undefined; + try { + if (isCreateMutation(mutation) && !(await createParentStillMatches(mutation))) { + throw new IOSFileTransactionStaleError(); + } + const temporary = await open(temporaryPath, "wx", mutation.mode); + created = true; + try { + const info = await temporary.stat(); + if (!info.isFile()) throw new Error("staged path was not a regular file"); + openedIdentity = { + dev: info.dev, + ino: info.ino, + mode: info.mode & 0o7777, + }; + await temporary.writeFile(bytes); + await temporary.chmod(mutation.mode); + await temporary.sync(); + } finally { + await temporary.close(); + } + if (!(await fileMatchesHash(temporaryPath, expectedHash))) { + throw new Error("staged bytes did not match their prepared hash"); + } + const stagedIdentity = await readRegularFileIdentity(temporaryPath); + if (!stagedIdentity || stagedIdentity.mode !== mutation.mode) { + throw new Error("staged file identity did not match its prepared mode"); + } + if (isCreateMutation(mutation) && !(await createParentStillMatches(mutation))) { + throw new IOSFileTransactionStaleError(); + } + return { mutation, temporaryPath, temporaryPresent: true, stagedIdentity }; + } catch (error) { + if (created) { + try { + const currentIdentity = await readRegularFileIdentity(temporaryPath); + if (!openedIdentity || !currentIdentity || !sameFile(currentIdentity, openedIdentity)) { + throw new Error("the staged path no longer identified the transaction's file"); + } + await rm(temporaryPath); + } catch (cleanupError) { + throw transactionError( + "cleanup-failed", + "A staged iOS file could not be removed after staging failed.", + aggregateCause([error, cleanupError]), + ); + } + } + if (error instanceof IOSFileTransactionStaleError) throw error; + throw transactionError( + "stage-failed", + "The iOS file transaction could not be staged safely.", + error, + ); + } +} + +async function cleanupStaged(staged: readonly StagedMutation[]): Promise { + const results = await Promise.allSettled( + staged + .filter((item) => item.temporaryPresent) + .map(async (item) => { + const currentIdentity = await readRegularFileIdentity(item.temporaryPath); + if (!currentIdentity || !sameFile(currentIdentity, item.stagedIdentity)) { + throw new Error("the staged path no longer identified the transaction's file"); + } + await rm(item.temporaryPath); + item.temporaryPresent = false; + }), + ); + const failures = results + .filter((result): result is PromiseRejectedResult => result.status === "rejected") + .map((result) => result.reason); + if (failures.length > 0) { + throw transactionError( + "cleanup-failed", + "One or more staged iOS files could not be removed.", + aggregateCause(failures), + ); + } +} + +async function stageAll( + mutations: readonly IOSFileMutation[], + content: (mutation: IOSFileMutation) => { bytes: Uint8Array; hash: string }, +): Promise { + const staged: StagedMutation[] = []; + try { + for (const mutation of mutations) { + const value = content(mutation); + staged.push(await stageBytes(mutation, value.bytes, value.hash)); + } + return staged; + } catch (error) { + try { + await cleanupStaged(staged); + } catch (cleanupError) { + throw transactionError( + "cleanup-failed", + "The iOS file transaction failed to clean up after staging.", + aggregateCause([error, cleanupError]), + ); + } + throw error; + } +} + +async function captureInitialExistingFileIdentities( + mutations: readonly IOSFileMutation[], +): Promise | undefined> { + const identities = new Map(); + const states = await Promise.all( + mutations.map(async (mutation) => { + if (isCreateMutation(mutation)) { + return (await createParentStillMatches(mutation)) && (await pathIsAbsent(mutation.path)); + } + const identity = await readRegularFileIdentity(mutation.path); + if ( + !identity || + identity.mode !== mutation.mode || + !(await fileMatchesIdentityAndHash(mutation.path, identity, mutation.originalHash)) + ) { + return false; + } + identities.set(mutation.path, identity); + return true; + }), + ); + return states.every(Boolean) ? identities : undefined; +} + +async function originalStateStillMatches( + mutation: IOSFileMutation, + initialIdentities: ReadonlyMap, +): Promise { + if (isCreateMutation(mutation)) { + return (await createParentStillMatches(mutation)) && (await pathIsAbsent(mutation.path)); + } + const identity = initialIdentities.get(mutation.path); + return ( + identity !== undefined && + fileMatchesIdentityAndHash(mutation.path, identity, mutation.originalHash) + ); +} + +async function originalStatesStillMatch( + mutations: readonly IOSFileMutation[], + initialIdentities: ReadonlyMap, +): Promise { + const matches = await Promise.all( + mutations.map(async (mutation) => originalStateStillMatches(mutation, initialIdentities)), + ); + return matches.every(Boolean); +} + +async function createdCandidateIsUntouched(item: StagedMutation): Promise { + if (!isCreateMutation(item.mutation) || !(await createParentStillMatches(item.mutation))) { + return false; + } + try { + const destinationIdentity = await readRegularFileIdentity(item.mutation.path); + if ( + !destinationIdentity || + !identitiesMatch(destinationIdentity, item.stagedIdentity) || + destinationIdentity.mode !== item.mutation.mode + ) { + return false; + } + if (item.temporaryPresent) { + const temporaryIdentity = await readRegularFileIdentity(item.temporaryPath); + if (!temporaryIdentity || !identitiesMatch(temporaryIdentity, item.stagedIdentity)) { + return false; + } + } + return ( + (await fileMatchesIdentityAndHash( + item.mutation.path, + item.committedIdentity ?? item.stagedIdentity, + item.mutation.candidateHash, + )) && (await createParentStillMatches(item.mutation)) + ); + } catch { + return false; + } +} + +async function committedCandidateIsUntouched(item: StagedMutation): Promise { + if (isCreateMutation(item.mutation)) return createdCandidateIsUntouched(item); + if (!item.committedIdentity) return false; + return fileMatchesIdentityAndHash( + item.mutation.path, + item.committedIdentity, + item.mutation.candidateHash, + ); +} + +async function committedCandidatesAreUntouched( + committed: readonly StagedMutation[], +): Promise { + const states = await Promise.all(committed.map(committedCandidateIsUntouched)); + return states.every(Boolean); +} + +async function claimedOriginalIsUntouched(item: StagedMutation): Promise { + if (isCreateMutation(item.mutation)) return true; + const claim = item.claimedOriginal; + return ( + claim !== undefined && + claim.present && + (await fileMatchesIdentityAndHash(claim.path, claim.identity, item.mutation.originalHash)) + ); +} + +async function claimedOriginalsAreUntouched( + committed: readonly StagedMutation[], +): Promise { + const states = await Promise.all(committed.map(claimedOriginalIsUntouched)); + return states.every(Boolean); +} + +async function cleanupClaimedOriginals(committed: readonly StagedMutation[]): Promise { + if ( + !(await committedCandidatesAreUntouched(committed)) || + !(await claimedOriginalsAreUntouched(committed)) + ) { + throw new IOSFileTransactionOwnershipError( + "one or more committed candidates or claimed originals changed before the originals could be released", + ); + } + const results = await Promise.allSettled( + committed.map(async (item) => { + if (isCreateMutation(item.mutation) || !item.claimedOriginal?.present) return; + if ( + !(await committedCandidateIsUntouched(item)) || + !(await claimedOriginalIsUntouched(item)) + ) { + throw new IOSFileTransactionOwnershipError( + "a committed candidate or claimed original changed before the original could be released", + ); + } + await removeClaimedPath(item.claimedOriginal, { + expectedHash: item.mutation.originalHash, + expectedMode: item.mutation.mode, + }); + }), + ); + const failures = results + .filter((result): result is PromiseRejectedResult => result.status === "rejected") + .map((result) => result.reason); + if (failures.length > 0) { + const cause = aggregateCause(failures); + if (failures.every((failure) => failure instanceof IOSFileTransactionOwnershipError)) { + throw new IOSFileTransactionOwnershipError( + "one or more committed candidates or claimed originals changed before the originals could be released", + { cause }, + ); + } + throw cause; + } +} + +async function rollbackCommitted( + committed: readonly StagedMutation[], + hooks: IOSFileTransactionTestHooks, +): Promise { + if (committed.length === 0) return; + + const reversed = [...committed].reverse(); + const rollbackClaims: Array<{ + claim: ClaimedDestination; + mutation: IOSFileMutation; + }> = []; + const rollbackFiles = await stageAll( + reversed + .map((item) => item.mutation) + .filter((mutation): mutation is IOSExistingFileMutation => !isCreateMutation(mutation)), + (mutation) => { + if (isCreateMutation(mutation)) { + throw new Error("create mutations do not have original bytes"); + } + return { bytes: mutation.originalBytes, hash: mutation.originalHash }; + }, + ); + + try { + // Restore every still-owned existing file before attempting to remove a + // created dependency. A replaced create parent must not leave a project + // file pointing at a destination the transaction can no longer prove. + const candidatesAreUntouched = await Promise.all( + reversed + .filter((item) => !isCreateMutation(item.mutation)) + .map(committedCandidateIsUntouched), + ); + if (!candidatesAreUntouched.every(Boolean)) { + throw transactionError( + "rollback-failed", + "The iOS file transaction changed again before rollback; newer bytes were preserved.", + ); + } + + let rollbackIndex = 0; + for (const item of reversed) { + if (!(await committedCandidateIsUntouched(item))) { + throw transactionError( + "rollback-failed", + "The iOS file transaction changed again during rollback; newer bytes were preserved.", + ); + } + if (isCreateMutation(item.mutation)) { + const candidateIdentity = item.committedIdentity ?? item.stagedIdentity; + const claimResult = await claimDestination( + item.mutation.path, + candidateIdentity, + item.mutation.candidateHash, + ); + if (claimResult.status === "stale") { + throw transactionError( + "rollback-failed", + "The iOS file transaction changed again during rollback; newer bytes were preserved.", + ); + } + const candidateClaim = claimResult.claim; + rollbackClaims.push({ claim: candidateClaim, mutation: item.mutation }); + await removeClaimedPath(candidateClaim, { + expectedHash: item.mutation.candidateHash, + expectedMode: item.mutation.mode, + }); + await syncDirectory(dirname(item.mutation.path)); + if ( + !(await createParentStillMatches(item.mutation)) || + !(await pathIsAbsent(item.mutation.path)) + ) { + throw transactionError( + "rollback-failed", + "An iOS create destination changed while rollback removed its candidate; newer filesystem state was preserved.", + ); + } + continue; + } + const rollback = rollbackFiles[rollbackIndex++]; + if (!rollback) { + throw new Error("a prepared rollback file was missing"); + } + const originalBackup = item.claimedOriginal?.present ? item.claimedOriginal : undefined; + const originalSourcePath = originalBackup?.path ?? rollback.temporaryPath; + const originalSourceIdentity = await readRegularFileIdentity(originalSourcePath); + if ( + !originalSourceIdentity || + (originalBackup && !sameFile(originalSourceIdentity, originalBackup.identity)) || + (!originalBackup && + !(await fileMatchesIdentityAndHash( + originalSourcePath, + rollback.stagedIdentity, + item.mutation.originalHash, + ))) + ) { + throw new IOSFileTransactionOwnershipError( + "the original iOS file could not be identified during rollback", + ); + } + await hooks.beforeRollbackDestinationReplace?.(rollback.mutation.path, originalSourcePath); + if (!(await committedCandidateIsUntouched(item))) { + throw transactionError( + "rollback-failed", + "The iOS file transaction changed again during rollback; newer bytes were preserved.", + ); + } + const sourceIdentityBeforeRename = await readRegularFileIdentity(originalSourcePath); + if ( + !sourceIdentityBeforeRename || + !sameFile(sourceIdentityBeforeRename, originalSourceIdentity) + ) { + throw new IOSFileTransactionOwnershipError( + "the original iOS file changed before atomic rollback", + ); + } + // This final ownership check and the atomic rename are the standard + // replacement linearization boundary. A writer that wins afterward is + // ordered before this rollback; portable Node APIs do not provide an + // inode-conditional rename primitive. + await rename(originalSourcePath, rollback.mutation.path); + if (originalBackup) originalBackup.present = false; + else rollback.temporaryPresent = false; + await hooks.afterRollbackDestinationReplace?.(rollback.mutation.path); + const restoredIdentity = await readRegularFileIdentity(rollback.mutation.path); + if ( + !restoredIdentity || + !sameFile(restoredIdentity, originalSourceIdentity) || + (!originalBackup && + !(await fileMatchesIdentityAndHash( + rollback.mutation.path, + originalSourceIdentity, + item.mutation.originalHash, + ))) + ) { + throw new IOSFileTransactionOwnershipError( + "the restored iOS file did not match its rollback source", + ); + } + await syncDirectory(dirname(rollback.mutation.path)); + } + await cleanupStaged(rollbackFiles); + } catch (error) { + let candidateClaimCleanupError: unknown; + const candidateClaimCleanupResults = await Promise.allSettled( + rollbackClaims.map(async ({ claim, mutation }) => { + if (!claim.present) return; + await removeClaimedPath(claim, { + expectedHash: mutation.candidateHash, + expectedMode: mutation.mode, + }); + }), + ); + const candidateClaimCleanupFailures = candidateClaimCleanupResults + .filter((result): result is PromiseRejectedResult => result.status === "rejected") + .map((result) => result.reason); + if (candidateClaimCleanupFailures.length > 0) { + candidateClaimCleanupError = aggregateCause(candidateClaimCleanupFailures); + } + try { + await cleanupStaged(rollbackFiles); + } catch (cleanupError) { + throw transactionError( + "rollback-failed", + "The iOS file transaction could not be rolled back or cleaned up completely.", + aggregateCause( + [error, candidateClaimCleanupError, cleanupError].filter((cause) => cause !== undefined), + ), + ); + } + if (candidateClaimCleanupError) { + throw transactionError( + "rollback-failed", + "The iOS file transaction could not be rolled back or cleaned up completely.", + aggregateCause([error, candidateClaimCleanupError].filter((cause) => cause !== undefined)), + ); + } + if (error instanceof IOSFileTransactionError && error.code === "rollback-failed") throw error; + throw transactionError( + "rollback-failed", + "The iOS file transaction could not be rolled back completely.", + error, + ); + } +} + +async function rollbackAfterFailure( + committed: readonly StagedMutation[], + staged: readonly StagedMutation[], + hooks: IOSFileTransactionTestHooks, +): Promise { + let rollbackError: unknown; + let cleanupError: unknown; + try { + await rollbackCommitted(committed, hooks); + } catch (error) { + rollbackError = error; + } + try { + await cleanupStaged(staged); + } catch (error) { + cleanupError = error; + } + if (!(await createParentsStillMatch(committed.map((item) => item.mutation)))) { + cleanupError ??= transactionError( + "rollback-failed", + "An iOS create destination changed while rollback was being finalized; newer filesystem state was preserved.", + ); + } + if (rollbackError || cleanupError) { + throw transactionError( + "rollback-failed", + "The iOS file transaction could not be rolled back or cleaned up completely.", + aggregateCause([rollbackError, cleanupError].filter((error) => error !== undefined)), + ); + } +} + +async function postconditionsAreValid( + postconditions: readonly IOSFilePostcondition[], +): Promise { + const results = await Promise.allSettled( + postconditions.map(async (postcondition) => Promise.resolve().then(postcondition)), + ); + return results.every((result) => result.status === "fulfilled" && result.value === true); +} + +/** + * Atomically creates or replaces a set of files as far as the filesystem + * allows. Candidates are all staged first; any partial commit is restored in + * reverse order if a later commit or aggregate postcondition fails. + * + * @internal Prepared mutations contain sensitive-to-output candidate bytes. + */ +export async function applyIOSFileTransaction( + mutations: readonly IOSFileMutation[], + postconditions: readonly IOSFilePostcondition[], + hooks: IOSFileTransactionTestHooks = {}, +): Promise { + const prepared = snapshotMutations(mutations); + validateMutations(prepared); + const initialIdentities = await captureInitialExistingFileIdentities(prepared); + if (!initialIdentities) return { status: "stale" }; + let staged: StagedMutation[]; + try { + staged = await stageAll(prepared, (mutation) => ({ + bytes: mutation.candidateBytes, + hash: mutation.candidateHash, + })); + } catch (error) { + if (error instanceof IOSFileTransactionStaleError) return { status: "stale" }; + throw error; + } + const committed: StagedMutation[] = []; + + if (!(await originalStatesStillMatch(prepared, initialIdentities))) { + await cleanupStaged(staged); + return { status: "stale" }; + } + + let stale = false; + let commitError: unknown; + for (const item of staged) { + if (!(await createParentsStillMatch(prepared))) { + stale = true; + break; + } + const originalStillMatches = await originalStateStillMatches(item.mutation, initialIdentities); + if (!originalStillMatches) { + stale = true; + break; + } + let committedThisItem = false; + try { + if (isCreateMutation(item.mutation)) { + await link(item.temporaryPath, item.mutation.path); + } else { + const expectedIdentity = initialIdentities.get(item.mutation.path); + if (!expectedIdentity) { + throw new Error("an existing iOS file identity was missing during commit"); + } + await hooks.beforeExistingDestinationBackup?.(item.mutation.path); + const backupResult = await backupDestination( + item.mutation.path, + expectedIdentity, + item.mutation.originalHash, + ); + if (backupResult.status === "stale") { + stale = true; + break; + } + item.claimedOriginal = backupResult.claim; + await hooks.afterExistingDestinationBackup?.(item.mutation.path, item.claimedOriginal.path); + await hooks.beforeExistingDestinationReplace?.( + item.mutation.path, + item.claimedOriginal.path, + ); + if ( + !(await createParentsStillMatch(prepared)) || + !(await originalStateStillMatches(item.mutation, initialIdentities)) || + !(await fileMatchesIdentityAndHash( + item.temporaryPath, + item.stagedIdentity, + item.mutation.candidateHash, + )) + ) { + throw new IOSFileTransactionStaleError(); + } + // The original remains available through the verified hard-link + // backup while this same-directory rename atomically replaces the + // public destination. There is no path-absence window. The final + // ownership check and rename form the standard replacement + // linearization boundary; portable Node APIs do not provide an + // inode-conditional rename primitive. + await rename(item.temporaryPath, item.mutation.path); + item.temporaryPresent = false; + } + // A successful create link or existing-file rename proves that the + // destination referred to the staged inode at the commit linearization + // point. Record ownership synchronously before exposing it to rollback. + item.committedIdentity = item.stagedIdentity; + committed.push(item); + committedThisItem = true; + if (!isCreateMutation(item.mutation) && item.claimedOriginal) { + await hooks.afterExistingDestinationReplace?.( + item.mutation.path, + item.claimedOriginal.path, + ); + } + if (!(await createParentsStillMatch(prepared))) { + throw new IOSFileTransactionStaleError(); + } + const committedIdentity = await readRegularFileIdentity(item.mutation.path); + if (!committedIdentity || !identitiesMatch(committedIdentity, item.stagedIdentity)) { + throw new Error("committed file identity did not match its staged candidate"); + } + item.committedIdentity = committedIdentity; + await syncDirectory(dirname(item.mutation.path)); + if (!(await createParentsStillMatch(prepared))) { + throw new IOSFileTransactionStaleError(); + } + } catch (error) { + let effectiveError = error; + if (!committedThisItem && item.claimedOriginal?.present) { + try { + await removeClaimedPath(item.claimedOriginal); + } catch (cleanupError) { + effectiveError = new IOSFileTransactionOwnershipError( + "an original-file backup could not be released after commit stopped", + { cause: aggregateCause([error, cleanupError]) }, + ); + } + } + if ( + effectiveError instanceof IOSFileTransactionStaleError || + (isCreateMutation(item.mutation) && isFileSystemError(effectiveError, "EEXIST")) + ) { + stale = true; + } else { + commitError = effectiveError; + } + break; + } + } + + if (stale || commitError) { + await rollbackAfterFailure(committed, staged, hooks); + if (stale) return { status: "stale" }; + throw transactionError( + "commit-failed", + "The iOS file transaction could not be committed and was restored.", + commitError, + ); + } + + const parentsMatchedBeforePostvalidation = await createParentsStillMatch(prepared); + const candidatesMatchedBeforePostvalidation = await committedCandidatesAreUntouched(committed); + const originalsMatchedBeforePostvalidation = await claimedOriginalsAreUntouched(committed); + const postconditionsValid = await postconditionsAreValid(postconditions); + const parentsMatchedAfterPostvalidation = await createParentsStillMatch(prepared); + const candidatesMatchedAfterPostvalidation = await committedCandidatesAreUntouched(committed); + const originalsMatchedAfterPostvalidation = await claimedOriginalsAreUntouched(committed); + if ( + parentsMatchedBeforePostvalidation && + candidatesMatchedBeforePostvalidation && + originalsMatchedBeforePostvalidation && + postconditionsValid && + parentsMatchedAfterPostvalidation && + candidatesMatchedAfterPostvalidation && + originalsMatchedAfterPostvalidation + ) { + try { + await cleanupClaimedOriginals(committed); + } catch (error) { + await rollbackAfterFailure(committed, staged, hooks); + if (error instanceof IOSFileTransactionOwnershipError) return { status: "stale" }; + throw transactionError( + "cleanup-failed", + "The iOS file transaction could not release its claimed original files and was restored.", + error, + ); + } + await cleanupStaged(staged); + if ( + (await createParentsStillMatch(prepared)) && + (await committedCandidatesAreUntouched(committed)) + ) { + return { status: "applied" }; + } + await rollbackAfterFailure(committed, staged, hooks); + return { status: "stale" }; + } + + await rollbackAfterFailure(committed, staged, hooks); + return parentsMatchedBeforePostvalidation && + candidatesMatchedBeforePostvalidation && + parentsMatchedAfterPostvalidation && + candidatesMatchedAfterPostvalidation && + originalsMatchedBeforePostvalidation && + originalsMatchedAfterPostvalidation + ? { status: "rolled-back" } + : { status: "stale" }; +} + +/** + * Atomically replaces a set of existing files as far as the filesystem allows. + * + * @internal Prepared mutations contain sensitive-to-output candidate bytes. + */ +export async function applyIOSExistingFileTransaction( + mutations: readonly IOSExistingFileMutation[], + postconditions: readonly IOSFilePostcondition[], + hooks: IOSFileTransactionTestHooks = {}, +): Promise { + return applyIOSFileTransaction(mutations, postconditions, hooks); +} diff --git a/packages/cli-core/src/commands/init/ios/inspect.test.ts b/packages/cli-core/src/commands/init/ios/inspect.test.ts new file mode 100644 index 00000000..2f1d01c8 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/inspect.test.ts @@ -0,0 +1,589 @@ +import { afterEach, describe, expect, test } from "bun:test"; +import { mkdtemp, mkdir, rm, symlink } from "node:fs/promises"; +import { join } from "node:path"; +import { tmpdir } from "node:os"; +import { inspectWorkspace } from "./discovery.ts"; +import { inspectIOSProject } from "./inspect.ts"; +import { createIOSFixture, IOS_FIXTURE_IDS, treeDigest } from "./test-helpers.ts"; + +const temporaryDirectories: string[] = []; + +async function fixture(options: Parameters[1] = {}): Promise { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-inspect-")); + temporaryDirectories.push(root); + await createIOSFixture(root, options); + return root; +} + +afterEach(async () => { + await Promise.all(temporaryDirectories.splice(0).map((path) => rm(path, { recursive: true }))); +}); + +describe("inspectIOSProject", () => { + test("inspects target settings, Clerk linkage, entitlements, and Swift setup", async () => { + const root = await fixture({ complete: true, workspace: true }); + const inspection = await inspectIOSProject(root); + + expect(inspection.selection).toEqual({ + state: "selected", + targetId: IOS_FIXTURE_IDS.appTarget, + targetName: "MyApp", + projectPath: "MyApp.xcodeproj", + }); + expect(inspection.workspaces).toEqual([ + { path: "MyApp.xcworkspace", projectPaths: ["MyApp.xcodeproj"] }, + ]); + expect(inspection.projects[0]?.packages[0]).toMatchObject({ + kind: "remote", + repository: "https://github.com/clerk/clerk-ios", + isClerk: true, + }); + + const target = inspection.appTargets[0]; + expect(target?.packages).toEqual({ + package: "remote", + clerkKit: "linked", + clerkKitUI: "linked", + }); + expect(target?.configurations.map((configuration) => configuration.name)).toEqual([ + "Debug", + "Release", + ]); + expect(target?.configurations[0]?.bundleIdentifier).toMatchObject({ + state: "resolved", + value: "com.example.MyApp", + }); + expect(target?.configurations[0]?.entitlements).toMatchObject({ + associatedDomains: ["webcredentials:clerk.example.test"], + literalAppIdentifierPrefix: "LEGACY1234", + teamIdentifier: "ABCDE12345", + }); + expect(target?.swift).toMatchObject({ + status: "complete", + sourceFilesScanned: 1, + }); + expect(target?.runtimeKeySinks).toEqual([]); + expect(inspection.localPublishableKey).toEqual({ + found: true, + source: ".env", + frontendApiHost: "clerk.example.test", + instanceType: "development", + conflict: false, + candidateSources: [".env"], + invalidSources: [], + }); + const fixtureKey = `pk_test_${Buffer.from("clerk.example.test$").toString("base64")}`; + expect(JSON.stringify(inspection)).not.toContain(fixtureKey); + + const fromWorkspaceBundle = await inspectIOSProject(join(root, "MyApp.xcworkspace")); + expect(fromWorkspaceBundle.selection).toMatchObject({ + state: "selected", + targetName: "MyApp", + }); + + const embeddedWorkspace = join(root, "MyApp.xcodeproj", "project.xcworkspace"); + await mkdir(embeddedWorkspace, { recursive: true }); + await Bun.write( + join(embeddedWorkspace, "contents.xcworkspacedata"), + '', + ); + const fromEmbeddedWorkspace = await inspectIOSProject(embeddedWorkspace); + expect(fromEmbeddedWorkspace.selection).toMatchObject({ + state: "selected", + targetName: "MyApp", + projectPath: "MyApp.xcodeproj", + }); + }); + + test("does not synthesize workspace markup across XML comments", async () => { + const root = await fixture({ workspace: true }); + const workspace = join(root, "MyApp.xcworkspace"); + await Bun.write( + join(workspace, "contents.xcworkspacedata"), + ` + leRef location="group:Injected.xcodeproj"> + + + `, + ); + + const result = await inspectWorkspace(root, workspace); + + expect(result.inspection.projectPaths).toEqual(["MyApp.xcodeproj"]); + expect(result.localProjectPaths).toEqual([join(root, "MyApp.xcodeproj")]); + }); + + test("does not parse a workspace location token from inside another quoted attribute", async () => { + const root = await fixture({ workspace: true }); + const workspace = join(root, "MyApp.xcworkspace"); + await Bun.write( + join(workspace, "contents.xcworkspacedata"), + ` + + `, + ); + + const result = await inspectWorkspace(root, workspace); + + expect(result.inspection.projectPaths).toEqual(["MyApp.xcodeproj"]); + expect(result.localProjectPaths).toEqual([join(root, "MyApp.xcodeproj")]); + }); + + test("does not guess when multiple application targets exist", async () => { + const root = await fixture({ secondTarget: true }); + const inspection = await inspectIOSProject(root); + + expect(inspection.selection.state).toBe("ambiguous"); + expect( + inspection.diagnostics.some((diagnostic) => diagnostic.code === "xcode.ambiguous-app-target"), + ).toBe(true); + }); + + test("selects an explicit target by name or object ID", async () => { + const root = await fixture({ secondTarget: true }); + + const byName = await inspectIOSProject(root, { target: "AdminApp" }); + const byId = await inspectIOSProject(root, { target: IOS_FIXTURE_IDS.appTarget }); + + expect(byName.selection).toMatchObject({ state: "selected", targetName: "AdminApp" }); + expect(byId.selection).toMatchObject({ state: "selected", targetName: "MyApp" }); + }); + + test("reports usable target choices when an explicit target is not found", async () => { + const root = await fixture({ secondTarget: true }); + + const inspection = await inspectIOSProject(root, { target: "MissingApp" }); + + expect(inspection.selection).toEqual({ + state: "not-found", + requested: "MissingApp", + candidates: [ + `AdminApp (${IOS_FIXTURE_IDS.secondTarget})`, + `MyApp (${IOS_FIXTURE_IDS.appTarget})`, + ], + }); + expect(inspection.projects[0]?.appTargetIds).toEqual([ + IOS_FIXTURE_IDS.secondTarget, + IOS_FIXTURE_IDS.appTarget, + ]); + }); + + test("does not treat watchOS application products as iOS app candidates", async () => { + const root = await fixture({ secondTarget: "watchos" }); + const inspection = await inspectIOSProject(root); + + expect(inspection.appTargets.map((target) => target.name)).toEqual(["MyApp"]); + expect(inspection.selection).toMatchObject({ state: "selected", targetName: "MyApp" }); + }); + + test("preserves conflicting configuration values instead of guessing", async () => { + const root = await fixture({ conflictingBundle: true }); + const inspection = await inspectIOSProject(root); + + expect( + inspection.appTargets[0]?.configurations.map((configuration) => + configuration.bundleIdentifier.state === "resolved" + ? configuration.bundleIdentifier.value + : configuration.bundleIdentifier.state, + ), + ).toEqual(["com.example.MyApp", "com.example.MyApp.release"]); + expect( + inspection.diagnostics.some( + (diagnostic) => diagnostic.code === "xcode.conflicting-build-setting", + ), + ).toBe(true); + }); + + test("reports a setting present in only one build configuration", async () => { + const root = await fixture({ releaseEntitlements: false }); + const inspection = await inspectIOSProject(root); + + expect( + inspection.diagnostics.some( + (diagnostic) => + diagnostic.code === "xcode.conflicting-build-setting" && + diagnostic.message.includes("Release="), + ), + ).toBe(true); + }); + + test("resolves checked-in xcconfig includes and variables without Xcode", async () => { + const root = await fixture({ xcconfig: true }); + const inspection = await inspectIOSProject(root); + const configurations = inspection.appTargets[0]?.configurations; + + expect(configurations?.map((configuration) => configuration.bundleIdentifier)).toEqual([ + expect.objectContaining({ state: "resolved", value: "com.example.MyApp" }), + expect.objectContaining({ state: "resolved", value: "com.example.MyApp" }), + ]); + expect(configurations?.map((configuration) => configuration.developmentTeam)).toEqual([ + expect.objectContaining({ state: "resolved", value: "ABCDE12345" }), + expect.objectContaining({ state: "resolved", value: "ABCDE12345" }), + ]); + }); + + test("reads a target-owned LocalSecrets.plist without exposing its key", async () => { + const root = await fixture({ includeKey: false, localSecrets: true }); + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: true, + source: "MyApp/LocalSecrets.plist", + frontendApiHost: "native.clerk.example", + instanceType: "production", + conflict: false, + candidateSources: ["MyApp/LocalSecrets.plist"], + invalidSources: [], + }); + expect(inspection.appTargets[0]?.runtimeKeySinks).toEqual([ + { kind: "local-secrets-plist", path: "MyApp/LocalSecrets.plist" }, + ]); + expect(JSON.stringify(inspection)).not.toContain("pk_live_"); + }); + + test("treats a direct @main literal as the selected target's runtime key without exposing it", async () => { + const root = await fixture({ includeKey: false }); + const publishableKey = `pk_test_${Buffer.from("inline.clerk.example$").toString("base64")}`; + await Bun.write( + join(root, "MyApp", "MyAppApp.swift"), + `import ClerkKit +import SwiftUI + +@main +struct MyApp: App { + init() { + Clerk.configure(publishableKey: "${publishableKey}") + } + + var body: some Scene { + WindowGroup { + Text("Hello") + .environment(Clerk.shared) + } + } +} +`, + ); + + const inspection = await inspectIOSProject(root, { target: "MyApp" }); + + expect(inspection.localPublishableKey).toEqual({ + found: true, + conflict: false, + source: "MyApp/MyAppApp.swift", + frontendApiHost: "inline.clerk.example", + instanceType: "development", + candidateSources: ["MyApp/MyAppApp.swift"], + invalidSources: [], + }); + expect(JSON.stringify(inspection)).not.toContain(publishableKey); + }); + + test("reads an enabled publishable key from the selected target's Run scheme", async () => { + const root = await fixture({ includeKey: false }); + const schemeDirectory = join(root, "MyApp.xcodeproj", "xcshareddata", "xcschemes"); + await mkdir(schemeDirectory, { recursive: true }); + const schemeKey = `pk_test_${Buffer.from("scheme.clerk.example$").toString("base64")}`; + await Bun.write( + join(schemeDirectory, "MyApp.xcscheme"), + ``, + ); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toMatchObject({ + found: true, + source: "MyApp.xcodeproj/xcshareddata/xcschemes/MyApp.xcscheme", + frontendApiHost: "scheme.clerk.example", + conflict: false, + }); + expect(JSON.stringify(inspection)).not.toContain(schemeKey); + }); + + test("ignores a workspace scheme that references a different same-named project container", async () => { + const root = await fixture({ includeKey: false, workspace: true }); + const schemeDirectory = join(root, "MyApp.xcworkspace", "xcshareddata", "xcschemes"); + await mkdir(schemeDirectory, { recursive: true }); + const schemeKey = `pk_test_${Buffer.from("wrong-container.clerk.example$").toString("base64")}`; + await Bun.write( + join(schemeDirectory, "WrongContainer.xcscheme"), + ``, + ); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: false, + conflict: false, + candidateSources: [], + invalidSources: [], + }); + expect(JSON.stringify(inspection)).not.toContain(schemeKey); + }); + + test("blocks derived advice when equally effective keys point to different instances", async () => { + const root = await fixture({ includeKey: false }); + const schemeDirectory = join(root, "MyApp.xcodeproj", "xcshareddata", "xcschemes"); + await mkdir(schemeDirectory, { recursive: true }); + const firstKey = `pk_test_${Buffer.from("first.clerk.example$").toString("base64")}`; + const secondKey = `pk_live_${Buffer.from("second.clerk.example$").toString("base64")}`; + const scheme = (key: string) => + ``; + await Bun.write(join(schemeDirectory, "First.xcscheme"), scheme(firstKey)); + await Bun.write(join(schemeDirectory, "Second.xcscheme"), scheme(secondKey)); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: true, + source: "MyApp.xcodeproj/xcshareddata/xcschemes/First.xcscheme", + conflict: true, + candidateSources: [ + "MyApp.xcodeproj/xcshareddata/xcschemes/First.xcscheme", + "MyApp.xcodeproj/xcshareddata/xcschemes/Second.xcscheme", + ], + invalidSources: [], + }); + expect( + inspection.diagnostics.some( + (diagnostic) => diagnostic.code === "clerk.conflicting-publishable-keys", + ), + ).toBe(true); + expect(JSON.stringify(inspection)).not.toContain(firstKey); + expect(JSON.stringify(inspection)).not.toContain(secondKey); + }); + + test("does not conflict a selected-target runtime key with the CLI process environment", async () => { + const root = await fixture({ includeKey: false, localSecrets: true }); + const ambientKey = `pk_test_${Buffer.from("ambient.clerk.example$").toString("base64")}`; + const previousAmbientKey = process.env.CLERK_PUBLISHABLE_KEY; + process.env.CLERK_PUBLISHABLE_KEY = ambientKey; + + try { + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toMatchObject({ + found: true, + conflict: false, + source: "MyApp/LocalSecrets.plist", + frontendApiHost: "native.clerk.example", + }); + expect(inspection.localPublishableKey.candidateSources).toEqual([ + "CLERK_PUBLISHABLE_KEY environment variable", + "MyApp/LocalSecrets.plist", + ]); + expect( + inspection.diagnostics.some( + (diagnostic) => diagnostic.code === "clerk.conflicting-publishable-keys", + ), + ).toBe(false); + expect(JSON.stringify(inspection)).not.toContain(ambientKey); + } finally { + if (previousAmbientKey == null) delete process.env.CLERK_PUBLISHABLE_KEY; + else process.env.CLERK_PUBLISHABLE_KEY = previousAmbientKey; + } + }); + + test("does not fall through when the highest-precedence key is malformed", async () => { + const root = await fixture({ includeKey: false, localSecrets: true }); + const schemeDirectory = join(root, "MyApp.xcodeproj", "xcshareddata", "xcschemes"); + await mkdir(schemeDirectory, { recursive: true }); + const schemePath = join(schemeDirectory, "MyApp.xcscheme"); + await Bun.write( + schemePath, + ``, + ); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: false, + source: "MyApp.xcodeproj/xcshareddata/xcschemes/MyApp.xcscheme", + conflict: false, + candidateSources: [ + "MyApp.xcodeproj/xcshareddata/xcschemes/MyApp.xcscheme", + "MyApp/LocalSecrets.plist", + ], + invalidSources: ["MyApp.xcodeproj/xcshareddata/xcschemes/MyApp.xcscheme"], + }); + }); + + test("does not treat web-framework key names as native iOS configuration", async () => { + const root = await fixture({ includeKey: false }); + const webKey = `pk_test_${Buffer.from("web.clerk.example$").toString("base64")}`; + await Bun.write(join(root, ".env"), `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=${webKey}\n`); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: false, + conflict: false, + candidateSources: [], + invalidSources: [], + }); + }); + + test("does not follow an entitlements symlink outside the inspected root", async () => { + if (process.platform === "win32") return; + const root = await fixture(); + const externalRoot = await mkdtemp(join(tmpdir(), "clerk-ios-external-")); + temporaryDirectories.push(externalRoot); + const externalEntitlements = join(externalRoot, "External.entitlements"); + await Bun.write(externalEntitlements, ""); + await rm(join(root, "MyApp", "MyApp.entitlements")); + await symlink(externalEntitlements, join(root, "MyApp", "MyApp.entitlements")); + + const inspection = await inspectIOSProject(root); + + expect(inspection.appTargets[0]?.configurations[0]?.entitlements).toBeUndefined(); + expect( + inspection.diagnostics.some((diagnostic) => diagnostic.code === "xcode.external-path"), + ).toBe(true); + }); + + test("honors synchronized-group membership exceptions and iOS platform filters", async () => { + const root = await fixture({ complete: false }); + const projectFile = join(root, "MyApp.xcodeproj", "project.pbxproj"); + const original = await Bun.file(projectFile).text(); + const synchronizedObjects = ` + 404040404040404040404040 = { isa = PBXFileSystemSynchronizedRootGroup; exceptions = ( 414141414141414141414141, 424242424242424242424242, ); path = Synced; sourceTree = ""; }; + 414141414141414141414141 = { isa = PBXFileSystemSynchronizedBuildFileExceptionSet; membershipExceptions = ( "Excluded/Auth.swift", ); platformFiltersByRelativePath = { MacOnly.swift = ( macos, ); }; target = ${IOS_FIXTURE_IDS.appTarget}; }; + 424242424242424242424242 = { isa = PBXFileSystemSynchronizedGroupBuildPhaseMembershipExceptionSet; buildPhase = ${IOS_FIXTURE_IDS.sourcesPhase}; membershipExceptions = ( PhaseExcluded.swift, ); }; + `; + await Bun.write( + projectFile, + original + .replace( + `productType = "com.apple.product-type.application";\n packageProductDependencies`, + `productType = "com.apple.product-type.application";\n fileSystemSynchronizedGroups = ( 404040404040404040404040, );\n packageProductDependencies`, + ) + .replace( + `${IOS_FIXTURE_IDS.projectConfigList} = { isa = XCConfigurationList;`, + `${synchronizedObjects}\n ${IOS_FIXTURE_IDS.projectConfigList} = { isa = XCConfigurationList;`, + ), + ); + await mkdir(join(root, "Synced", "Included"), { recursive: true }); + await mkdir(join(root, "Synced", "Excluded"), { recursive: true }); + await Bun.write( + join(root, "Synced", "Included", "Auth.swift"), + "import ClerkKitUI\nstruct Included { let view = AuthView() }\n", + ); + await Bun.write( + join(root, "Synced", "Excluded", "Auth.swift"), + "import ClerkKitUI\nstruct Excluded { let view = AuthView() }\n", + ); + await Bun.write( + join(root, "Synced", "PhaseExcluded.swift"), + "import ClerkKit\nfunc excluded() { Clerk.configure(publishableKey: key) }\n", + ); + await Bun.write( + join(root, "Synced", "MacOnly.swift"), + "import ClerkKit\nfunc macOnly() { Clerk.configure(publishableKey: key) }\n", + ); + + const inspection = await inspectIOSProject(root); + const swift = inspection.appTargets[0]?.swift; + + expect(swift?.sourceFilesScanned).toBe(2); + expect(swift?.authFlowReferences).toEqual([{ path: "Synced/Included/Auth.swift" }]); + expect(swift?.configureCalls).toEqual([]); + }); + + test("does not use Catalyst-only classic build-file membership as native iOS evidence", async () => { + const root = await fixture({ complete: true }); + const projectFile = join(root, "MyApp.xcodeproj", "project.pbxproj"); + const original = await Bun.file(projectFile).text(); + await Bun.write( + projectFile, + original + .replace( + `${IOS_FIXTURE_IDS.sourceBuildFile} = { isa = PBXBuildFile; fileRef`, + `${IOS_FIXTURE_IDS.sourceBuildFile} = { isa = PBXBuildFile; platformFilters = ( maccatalyst, ); fileRef`, + ) + .replace( + `${IOS_FIXTURE_IDS.clerkKitBuildFile} = { isa = PBXBuildFile; productRef`, + `${IOS_FIXTURE_IDS.clerkKitBuildFile} = { isa = PBXBuildFile; platformFilters = ( maccatalyst, ); productRef`, + ), + ); + + const inspection = await inspectIOSProject(root); + const target = inspection.appTargets[0]; + + expect(target?.swift.sourceFilesScanned).toBe(0); + expect(target?.swift.configureCalls).toEqual([]); + expect(target?.packages.clerkKit).toBe("declared"); + }); + + test("does not use unknown classic build-file filters as authoritative iOS evidence", async () => { + const root = await fixture({ complete: true }); + const projectFile = join(root, "MyApp.xcodeproj", "project.pbxproj"); + const original = await Bun.file(projectFile).text(); + await Bun.write( + projectFile, + original + .replace( + `${IOS_FIXTURE_IDS.sourceBuildFile} = { isa = PBXBuildFile; fileRef`, + `${IOS_FIXTURE_IDS.sourceBuildFile} = { isa = PBXBuildFile; platformFilter = futureos; fileRef`, + ) + .replace( + `${IOS_FIXTURE_IDS.clerkKitBuildFile} = { isa = PBXBuildFile; productRef`, + `${IOS_FIXTURE_IDS.clerkKitBuildFile} = { isa = PBXBuildFile; platformFilter = futureos; productRef`, + ), + ); + + const inspection = await inspectIOSProject(root); + const target = inspection.appTargets[0]; + + expect(target?.swift.sourceFilesScanned).toBe(0); + expect(target?.swift.evidenceComplete).toBe(false); + expect(target?.packages.clerkKit).toBe("declared"); + }); + + test("does not use non-iOS or unknown LocalSecrets resource membership as a native key", async () => { + for (const platformFilter of ["maccatalyst", "futureos"]) { + const root = await fixture({ includeKey: false, localSecrets: true }); + const projectFile = join(root, "MyApp.xcodeproj", "project.pbxproj"); + const original = await Bun.file(projectFile).text(); + await Bun.write( + projectFile, + original.replace( + `${IOS_FIXTURE_IDS.localSecretsBuildFile} = { isa = PBXBuildFile; fileRef`, + `${IOS_FIXTURE_IDS.localSecretsBuildFile} = { isa = PBXBuildFile; platformFilter = ${platformFilter}; fileRef`, + ), + ); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: false, + conflict: false, + candidateSources: [], + invalidSources: [], + }); + } + }); + + test("reports malformed projects as blocked evidence", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-inspect-")); + temporaryDirectories.push(root); + await mkdir(join(root, "Broken.xcodeproj")); + await Bun.write(join(root, "Broken.xcodeproj", "project.pbxproj"), "{ objects = ("); + + const inspection = await inspectIOSProject(root); + + expect(inspection.selection.state).toBe("none"); + expect( + inspection.diagnostics.some((diagnostic) => diagnostic.code === "xcode.malformed-project"), + ).toBe(true); + }); + + test("detects generated projects and never mutates the inspected tree", async () => { + const root = await fixture({ complete: true, generated: "xcodegen" }); + const before = await treeDigest(root); + + const inspection = await inspectIOSProject(root); + + expect(inspection.generatedProject).toBe("xcodegen"); + expect(await treeDigest(root)).toEqual(before); + }); +}); diff --git a/packages/cli-core/src/commands/init/ios/inspect.ts b/packages/cli-core/src/commands/init/ios/inspect.ts new file mode 100644 index 00000000..8a0f773a --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/inspect.ts @@ -0,0 +1,1662 @@ +import { readdir, readFile } from "node:fs/promises"; +import { dirname, extname, relative, resolve, sep } from "node:path"; +import plist from "@expo/plist"; +import { parse as parsePbxProject } from "@bacons/xcode/json"; +import { parseEnvFile } from "../../../lib/dotenv.ts"; +import { decodePublishableKey } from "../../../lib/fapi.ts"; +import { + addBuildSettingConflictDiagnostics, + inspectTargetBuildConfigurations, + resolveEntitlementsAbsolutePath, +} from "./build-settings.ts"; +import { + discoverIOSContainers, + inspectWorkspace, + pathIsSafelyWithinIOSRoot, + relativeIOSPath, + xmlAttribute, +} from "./discovery.ts"; +import { + asString, + asStringArray, + asStringRecord, + buildPbxParentIndex, + isClerkIOSRepository, + isRecord, + resolvePbxFilePath, + sanitizeRepositoryURL, + type PbxObject, + type PbxObjects, +} from "./pbx.ts"; +import { inspectSwiftSources } from "./swift.ts"; +import type { + IOSAppTarget, + IOSBuildConfiguration, + IOSClerkPackageState, + IOSDiagnostic, + IOSEntitlementsInspection, + IOSPackageReference, + IOSProductLinkState, + IOSProjectInspection, + IOSProjectInspectionResult, + IOSSourceEvidence, + IOSTargetSelection, +} from "./types.ts"; + +const APP_PRODUCT_TYPE = "com.apple.product-type.application"; +const MAX_PBXPROJ_BYTES = 15_000_000; +const MAX_SOURCE_FILES = 2_500; +const MAX_SOURCE_DEPTH = 24; +const MAX_SECRET_DISCOVERY_DEPTH = 5; +const MAX_SECRET_FILES = 20; +const SOURCE_IGNORES = new Set([ + ".build", + ".git", + ".swiftpm", + "build", + "Carthage", + "DerivedData", + "Pods", + "SourcePackages", +]); + +interface ParsedProject { + inspection: IOSProjectInspection; + appTargets: IOSAppTarget[]; + appTargetCandidates: Array<{ targetId: string; targetName: string; projectPath: string }>; + diagnostics: IOSDiagnostic[]; + sourceMemberships?: IOSTargetSourceMembership[]; +} + +export interface IOSTargetSourceMembership { + targetId: string; + targetName: string; + projectPath: string; + files: Array<{ absolutePath: string; relativePath: string }>; + complete: boolean; +} + +const sourceMembershipByInspection = new WeakMap< + IOSProjectInspectionResult, + IOSTargetSourceMembership[] +>(); + +function emptySwiftInspection() { + return { + sourceFilesScanned: 0, + evidenceComplete: false, + entryPoints: [], + importsClerkKit: [], + importsClerkKitUI: [], + configureCalls: [], + localSecretsRuntimeBindings: [], + environmentInjections: [], + environmentConsumers: [], + authFlowReferences: [], + openURLHandlers: [], + status: "absent" as const, + }; +} + +function normalizeObjects(value: unknown): PbxObjects | undefined { + if (!isRecord(value)) return undefined; + const objects: PbxObjects = {}; + for (const [id, object] of Object.entries(value)) { + if (isRecord(object)) objects[id] = object; + } + return objects; +} + +function canonicalRequirement(value: unknown): Record | undefined { + const requirement = asStringRecord(value); + return Object.keys(requirement).length > 0 ? requirement : undefined; +} + +function buildFileIOSApplicability(object: PbxObject): { + applies: boolean; + recognized: boolean; +} { + const platformFilter = asString(object.platformFilter); + const filters = [ + ...asStringArray(object.platformFilters), + ...(platformFilter ? [platformFilter] : []), + ]; + if (filters.length === 0) return { applies: true, recognized: true }; + if (filters.some((filter) => /(?:^|[^a-z])(?:ios|iphone)/i.test(filter))) { + return { applies: true, recognized: true }; + } + const recognized = filters.every((filter) => + /(?:maccatalyst|macos|tvos|watchos|xros|visionos|driverkit)/i.test(filter), + ); + return { applies: false, recognized }; +} + +interface PublishableKeyCandidate { + value?: string; + decoded?: { frontendApiHost: string; instanceType: "development" | "production" }; + invalid?: true; + source: string; + evidence: IOSSourceEvidence[]; + priority: number; + ambient?: true; +} + +async function collectSchemeFiles( + root: string, + directory: string, + output: string[], + depth = 0, +): Promise { + if (depth > 6 || output.length >= 100) return; + let entries; + try { + entries = await readdir(directory, { withFileTypes: true }); + } catch { + return; + } + entries.sort((a, b) => a.name.localeCompare(b.name)); + for (const entry of entries) { + const path = resolve(directory, entry.name); + if (entry.isDirectory()) { + await collectSchemeFiles(root, path, output, depth + 1); + } else if ( + entry.isFile() && + entry.name.endsWith(".xcscheme") && + (await pathIsSafelyWithinIOSRoot(root, path)) + ) { + output.push(path); + } + } +} + +function enclosingXcodeContainer(path: string): string | undefined { + let current = dirname(path); + while (true) { + if (current.endsWith(".xcodeproj") || current.endsWith(".xcworkspace")) return current; + const parent = dirname(current); + if (parent === current) return undefined; + current = parent; + } +} + +function schemeReferencesSelectedProject( + root: string, + schemePath: string, + selectedProjectPath: string, + referencedContainer: string | undefined, +): boolean { + const selectedProject = resolve(root, selectedProjectPath); + const enclosingContainer = enclosingXcodeContainer(schemePath); + if (!referencedContainer) { + return ( + enclosingContainer?.endsWith(".xcodeproj") === true && enclosingContainer === selectedProject + ); + } + const base = enclosingContainer ? dirname(enclosingContainer) : root; + const normalized = referencedContainer.replaceAll("\\", "/"); + return resolve(base, ...normalized.split("/")) === selectedProject; +} + +async function schemePublishableKeyCandidates( + root: string, + selection: IOSTargetSelection, + schemeRoots: string[], +): Promise { + if (selection.state !== "selected") return []; + const schemePaths: string[] = []; + for (const schemeRoot of [...new Set(schemeRoots)].sort()) { + if (await pathIsSafelyWithinIOSRoot(root, schemeRoot)) { + await collectSchemeFiles(root, schemeRoot, schemePaths); + } + } + const candidates: PublishableKeyCandidate[] = []; + + for (const path of schemePaths.sort()) { + const file = Bun.file(path); + if (!(await file.exists()) || file.size > 2_000_000) continue; + let xml: string; + try { + xml = (await file.text()).replace(//g, ""); + } catch { + continue; + } + + for (const launchAction of xml.matchAll(/]*>([\s\S]*?)<\/LaunchAction>/g)) { + const body = launchAction[1] ?? ""; + const referencesTarget = [...body.matchAll(/]*)>/g)].some( + (reference) => { + const attributes = reference[1] ?? ""; + if (xmlAttribute(attributes, "BlueprintIdentifier") !== selection.targetId) { + return false; + } + const container = xmlAttribute(attributes, "ReferencedContainer")?.replace( + /^container:/, + "", + ); + return schemeReferencesSelectedProject(root, path, selection.projectPath, container); + }, + ); + if (!referencesTarget) continue; + + for (const variable of body.matchAll(/]*)\/?\s*>/g)) { + const attributes = variable[1] ?? ""; + if (xmlAttribute(attributes, "key") !== "CLERK_PUBLISHABLE_KEY") continue; + if ((xmlAttribute(attributes, "isEnabled") ?? "YES").toUpperCase() === "NO") continue; + const value = xmlAttribute(attributes, "value")?.trim(); + if (!value) continue; + const source = relativeIOSPath(root, path); + candidates.push({ + value, + source, + evidence: [{ path: source, keyPath: "LaunchAction.EnvironmentVariables" }], + priority: 5, + }); + } + } + } + return candidates; +} + +async function collectLocalSecretsPlists( + root: string, + directory: string, + output: string[], + depth = 0, +): Promise { + if (depth > MAX_SECRET_DISCOVERY_DEPTH || output.length >= MAX_SECRET_FILES) return; + let entries; + try { + entries = await readdir(directory, { withFileTypes: true }); + } catch { + return; + } + + entries.sort((a, b) => a.name.localeCompare(b.name)); + for (const entry of entries) { + if (output.length >= MAX_SECRET_FILES) return; + const absolutePath = resolve(directory, entry.name); + if (entry.isDirectory()) { + if (!SOURCE_IGNORES.has(entry.name) && !entry.name.startsWith(".")) { + await collectLocalSecretsPlists(root, absolutePath, output, depth + 1); + } + } else if ( + entry.isFile() && + entry.name === "LocalSecrets.plist" && + (await pathIsSafelyWithinIOSRoot(root, absolutePath)) + ) { + output.push(absolutePath); + } + } +} + +async function readPublishableKeyCandidates( + root: string, + selection: IOSTargetSelection, + targetLocalSecretsPaths: string[], + schemeRoots: string[], + inlineCandidates: PublishableKeyCandidate[], +): Promise { + const selectedProjectDirectory = + selection.state === "selected" ? dirname(resolve(root, selection.projectPath)) : root; + const projectDirectories = [...new Set([selectedProjectDirectory, root])]; + const candidates: PublishableKeyCandidate[] = [ + ...inlineCandidates, + ...(await schemePublishableKeyCandidates(root, selection, schemeRoots)), + ]; + + for (const directory of projectDirectories) { + for (const [fileName, priority] of [ + [".env.local", 20], + [".env", 30], + ] as const) { + const path = resolve(directory, fileName); + if (!(await pathIsSafelyWithinIOSRoot(root, path))) continue; + const file = Bun.file(path); + if (!(await file.exists()) || file.size > 1_000_000) continue; + try { + for (const line of parseEnvFile(await file.text())) { + if (line.type === "entry" && line.key === "CLERK_PUBLISHABLE_KEY" && line.value) { + candidates.push({ + value: line.value, + source: relativeIOSPath(root, path), + evidence: [{ path: relativeIOSPath(root, path), keyPath: line.key }], + priority, + }); + } + } + } catch { + // A partially-written env file is not evidence of a usable key. + } + } + } + + for (const path of targetLocalSecretsPaths) { + const file = Bun.file(path); + if (!(await file.exists()) || file.size > 1_000_000) continue; + try { + const parsed: unknown = plist.parse(await file.text()); + const value = isRecord(parsed) ? asString(parsed.CLERK_PUBLISHABLE_KEY) : undefined; + if (value) { + candidates.push({ + value, + source: relativeIOSPath(root, path), + evidence: [{ path: relativeIOSPath(root, path), keyPath: "CLERK_PUBLISHABLE_KEY" }], + priority: 10, + }); + } + } catch { + // Binary/malformed secret files are ignored rather than printing parser data. + } + } + + for (const directory of projectDirectories) { + const path = resolve(directory, ".clerk", ".tmp", "keyless.json"); + if (!(await pathIsSafelyWithinIOSRoot(root, path))) continue; + const file = Bun.file(path); + if (!(await file.exists()) || file.size > 1_000_000) continue; + try { + const parsed: unknown = await file.json(); + const value = isRecord(parsed) ? asString(parsed.publishableKey) : undefined; + if (value) { + candidates.push({ + value, + source: relativeIOSPath(root, path), + evidence: [{ path: relativeIOSPath(root, path), keyPath: "publishableKey" }], + priority: 40, + }); + } + } catch { + // A partially-written SDK keyless file is not evidence of a usable key. + } + } + + const ambient = process.env.CLERK_PUBLISHABLE_KEY; + if (ambient) { + candidates.push({ + value: ambient, + source: "CLERK_PUBLISHABLE_KEY environment variable", + evidence: [], + priority: 50, + ambient: true, + }); + } + + return candidates.sort((a, b) => a.priority - b.priority || a.source.localeCompare(b.source)); +} + +async function inspectLocalPublishableKeys( + root: string, + selection: IOSTargetSelection, + targetLocalSecretsPaths: string[], + schemeRoots: string[], + inlineCandidates: PublishableKeyCandidate[], + diagnostics: IOSDiagnostic[], +): Promise { + const candidates = await readPublishableKeyCandidates( + root, + selection, + targetLocalSecretsPaths, + schemeRoots, + inlineCandidates, + ); + const candidateSources = [...new Set(candidates.map((candidate) => candidate.source))].sort(); + const decodedCandidates: Array<{ + candidate: PublishableKeyCandidate; + decoded?: { frontendApiHost: string; instanceType: "development" | "production" }; + }> = []; + const invalidSources = new Set(); + for (const candidate of candidates) { + if (candidate.decoded) { + decodedCandidates.push({ candidate, decoded: candidate.decoded }); + continue; + } + try { + if (candidate.invalid || candidate.value == null) throw new Error("invalid candidate"); + const value = decodePublishableKey(candidate.value); + decodedCandidates.push({ + candidate, + decoded: { frontendApiHost: value.fapiHost, instanceType: value.instanceType }, + }); + } catch { + invalidSources.add(candidate.source); + decodedCandidates.push({ candidate }); + diagnostics.push({ + code: "clerk.invalid-publishable-key", + severity: "warning", + message: `A publishable key candidate from ${candidate.source} has an invalid format.`, + remedy: "Replace it with a valid pk_test_ or pk_live_ publishable key.", + evidence: candidate.evidence, + }); + } + } + + const localCandidates = decodedCandidates.filter((item) => !item.candidate.ambient); + const ambientCandidates = decodedCandidates.filter((item) => item.candidate.ambient); + const effectivePriority = localCandidates[0]?.candidate.priority; + const effectiveCandidates = + effectivePriority == null + ? ambientCandidates + : localCandidates.filter((item) => item.candidate.priority === effectivePriority); + + // A non-empty higher-precedence source is what the app/CLI will consume. + // Never fall through to a lower-precedence valid key when that source is malformed. + if (effectiveCandidates.some((item) => !item.decoded)) { + return { + found: false, + source: effectiveCandidates[0]!.candidate.source, + conflict: false, + candidateSources, + invalidSources: [...invalidSources].sort(), + }; + } + + const effectiveValid = effectiveCandidates.filter( + ( + item, + ): item is typeof item & { + decoded: { frontendApiHost: string; instanceType: "development" | "production" }; + } => item.decoded != null, + ); + const identities = new Set( + effectiveValid.map((item) => `${item.decoded.instanceType}:${item.decoded.frontendApiHost}`), + ); + const effective = effectiveValid[0]; + + if (identities.size > 1) { + diagnostics.push({ + code: "clerk.conflicting-publishable-keys", + severity: "error", + message: "Equally effective publishable-key sources point to different Clerk instances.", + remedy: "Remove the stale source or make the equally preferred values agree.", + evidence: effectiveValid.flatMap((item) => item.candidate.evidence), + }); + return { + found: true, + source: effective!.candidate.source, + conflict: true, + candidateSources, + invalidSources: [...invalidSources].sort(), + }; + } + + if (!effective) { + return { + found: false, + conflict: false, + candidateSources, + invalidSources: [...invalidSources].sort(), + }; + } + return { + found: true, + conflict: false, + source: effective.candidate.source, + frontendApiHost: effective.decoded.frontendApiHost, + instanceType: effective.decoded.instanceType, + candidateSources, + invalidSources: [...invalidSources].sort(), + }; +} + +async function localPackageIsClerk(root: string, packagePath: string): Promise { + const manifestPath = resolve(packagePath, "Package.swift"); + if (!(await pathIsSafelyWithinIOSRoot(root, manifestPath))) return false; + const manifest = Bun.file(manifestPath); + if (!(await manifest.exists()) || manifest.size > 1_000_000) return false; + try { + const source = await manifest.text(); + return /\b(?:ClerkKit|ClerkKitUI)\b/.test(source); + } catch { + return false; + } +} + +async function inspectPackageReferences( + root: string, + projectPath: string, + projectObject: PbxObject, + objects: PbxObjects, +): Promise { + const packageIds = new Set(asStringArray(projectObject.packageReferences)); + // Some modern/local project layouts leave the project-level list partial. + // Preserve any package object the target graph can still reference. + for (const [id, object] of Object.entries(objects)) { + if ( + object.isa === "XCRemoteSwiftPackageReference" || + object.isa === "XCLocalSwiftPackageReference" + ) { + packageIds.add(id); + } + } + + const packages: IOSPackageReference[] = []; + for (const objectId of [...packageIds].sort()) { + const object = objects[objectId]; + if (object?.isa === "XCRemoteSwiftPackageReference") { + const rawRepository = asString(object.repositoryURL); + if (!rawRepository) continue; + const repository = sanitizeRepositoryURL(rawRepository); + packages.push({ + kind: "remote", + objectId, + repository, + requirement: canonicalRequirement(object.requirement), + isClerk: isClerkIOSRepository(repository), + }); + } else if (object?.isa === "XCLocalSwiftPackageReference") { + const relativePath = asString(object.relativePath); + if (!relativePath) continue; + const absolutePath = resolve(dirname(projectPath), relativePath); + const safelyLocal = await pathIsSafelyWithinIOSRoot(root, absolutePath); + packages.push({ + kind: "local", + objectId, + path: safelyLocal ? relativeIOSPath(root, absolutePath) : absolutePath, + isClerk: safelyLocal && (await localPackageIsClerk(root, absolutePath)), + }); + } + } + return packages; +} + +function targetProductState( + targetObject: PbxObject, + objects: PbxObjects, + productName: "ClerkKit" | "ClerkKitUI", +): { state: IOSProductLinkState; productIds: string[]; packageIds: string[] } { + const targetProductIds = asStringArray(targetObject.packageProductDependencies); + const matchingProductIds = targetProductIds.filter((id) => { + const product = objects[id]; + return ( + product?.isa === "XCSwiftPackageProductDependency" && product.productName === productName + ); + }); + if (matchingProductIds.length === 0) { + return { state: "absent", productIds: [], packageIds: [] }; + } + + const linkedProductIds = new Set(); + for (const phaseId of asStringArray(targetObject.buildPhases)) { + const phase = objects[phaseId]; + if (phase?.isa !== "PBXFrameworksBuildPhase") continue; + for (const buildFileId of asStringArray(phase.files)) { + const buildFile = objects[buildFileId]; + if (!buildFile || !buildFileIOSApplicability(buildFile).applies) continue; + const productRef = asString(buildFile.productRef); + if (productRef) linkedProductIds.add(productRef); + } + } + + const packageIds = matchingProductIds + .map((id) => asString(objects[id]?.package)) + .filter((id): id is string => id != null); + return { + state: matchingProductIds.some((id) => linkedProductIds.has(id)) ? "linked" : "declared", + productIds: matchingProductIds, + packageIds, + }; +} + +function inspectTargetPackages( + root: string, + projectPath: string, + targetName: string, + targetObject: PbxObject, + objects: PbxObjects, + packages: IOSPackageReference[], + diagnostics: IOSDiagnostic[], +): IOSClerkPackageState { + const clerkKit = targetProductState(targetObject, objects, "ClerkKit"); + const clerkKitUI = targetProductState(targetObject, objects, "ClerkKitUI"); + const packageById = new Map(packages.map((item) => [item.objectId, item])); + const productPackageIds = [...clerkKit.packageIds, ...clerkKitUI.packageIds]; + const attributed = productPackageIds + .map((id) => packageById.get(id)) + .filter((item): item is IOSPackageReference => item?.isClerk === true); + const declaredClerkPackage = packages.find((item) => item.isClerk); + const hasClerkProduct = clerkKit.state !== "absent" || clerkKitUI.state !== "absent"; + + let packageKind: IOSClerkPackageState["package"] = "absent"; + if (attributed[0]) packageKind = attributed[0].kind; + else if (declaredClerkPackage) packageKind = declaredClerkPackage.kind; + else if (hasClerkProduct) { + packageKind = "unattributed"; + diagnostics.push({ + code: "clerk.package-unattributed", + severity: "warning", + message: `${targetName} declares a Clerk product without an attributable clerk-ios package reference. This can be valid for a workspace-local package, but should be reviewed.`, + evidence: [...clerkKit.productIds, ...clerkKitUI.productIds].map((objectId) => ({ + path: relativeIOSPath(root, resolve(projectPath, "project.pbxproj")), + objectId, + })), + }); + } + + return { package: packageKind, clerkKit: clerkKit.state, clerkKitUI: clerkKitUI.state }; +} + +function stringArray(value: unknown): string[] { + return Array.isArray(value) + ? value.filter((item): item is string => typeof item === "string") + : []; +} + +async function inspectEntitlements( + root: string, + absolutePath: string, + evidence: IOSSourceEvidence[], + diagnostics: IOSDiagnostic[], +): Promise { + const relativePath = relativeIOSPath(root, absolutePath); + const file = Bun.file(absolutePath); + if (!(await file.exists())) { + diagnostics.push({ + code: "xcode.missing-entitlements", + severity: "warning", + message: `The configured entitlements file does not exist: ${relativePath}`, + remedy: "Create the file in Xcode or update CODE_SIGN_ENTITLEMENTS.", + evidence, + }); + return undefined; + } + + try { + const bytes = new Uint8Array(await file.arrayBuffer()); + if (new TextDecoder().decode(bytes.slice(0, 8)).startsWith("bplist")) { + throw new Error("binary plist"); + } + const parsed: unknown = plist.parse(new TextDecoder().decode(bytes)); + if (!isRecord(parsed)) throw new Error("plist root is not a dictionary"); + + const applicationIdentifier = asString(parsed["application-identifier"]); + return { + path: relativePath, + associatedDomains: stringArray(parsed["com.apple.developer.associated-domains"]).sort(), + unresolvedAssociatedDomains: [], + applicationIdentifier, + teamIdentifier: asString(parsed["com.apple.developer.team-identifier"]), + signInWithApple: stringArray(parsed["com.apple.developer.applesignin"]).length > 0, + }; + } catch { + diagnostics.push({ + code: "xcode.unreadable-entitlements", + severity: "warning", + message: `Could not inspect entitlements at ${relativePath}. Only XML plist entitlements are read in portable mode.`, + remedy: "Open the file in Xcode and save it as XML, then rerun the inspector.", + evidence, + }); + return undefined; + } +} + +async function attachEntitlements( + root: string, + projectPath: string, + configurations: IOSBuildConfiguration[], + settingsByConfiguration: Map>, + diagnostics: IOSDiagnostic[], +): Promise { + const cache = new Map(); + for (const configuration of configurations) { + if (configuration.entitlementsPath.state !== "resolved") continue; + const absolutePath = resolveEntitlementsAbsolutePath( + root, + projectPath, + configuration.entitlementsPath, + ); + if (!absolutePath) { + diagnostics.push({ + code: "xcode.external-path", + severity: "warning", + message: `${configuration.name} resolves CODE_SIGN_ENTITLEMENTS outside the inspected root.`, + evidence: configuration.entitlementsPath.evidence, + }); + continue; + } + if (!(await pathIsSafelyWithinIOSRoot(root, absolutePath))) { + diagnostics.push({ + code: "xcode.external-path", + severity: "warning", + message: `${configuration.name} resolves CODE_SIGN_ENTITLEMENTS through a path outside the inspected root.`, + evidence: configuration.entitlementsPath.evidence, + }); + continue; + } + if (!cache.has(absolutePath)) { + cache.set( + absolutePath, + await inspectEntitlements( + root, + absolutePath, + configuration.entitlementsPath.evidence, + diagnostics, + ), + ); + } + const entitlements = cache.get(absolutePath); + if (!entitlements) continue; + + const settings = settingsByConfiguration.get(configuration.name) ?? {}; + const resolvedAssociatedDomains: string[] = []; + const unresolvedAssociatedDomains: string[] = []; + for (const domain of entitlements.associatedDomains) { + const expanded = expandEntitlementDomain( + domain, + settings, + configuration.bundleIdentifier.state === "resolved" + ? configuration.bundleIdentifier.value + : undefined, + ); + if (expanded) resolvedAssociatedDomains.push(expanded); + else unresolvedAssociatedDomains.push(domain); + } + if (unresolvedAssociatedDomains.length > 0) { + diagnostics.push({ + code: "xcode.unresolved-build-setting", + severity: "warning", + message: `${configuration.name} has associated-domain values with unresolved build settings.`, + remedy: + "Resolve the variables in the entitlements configuration before relying on domain checks.", + evidence: configuration.entitlementsPath.evidence, + }); + } + + const applicationIdentifier = entitlements.applicationIdentifier; + const prefixMatch = /^([A-Z0-9]{10})\.(.+)$/.exec(applicationIdentifier ?? ""); + const literalAppIdentifierPrefix = + prefixMatch && + configuration.bundleIdentifier.state === "resolved" && + prefixMatch[2] === configuration.bundleIdentifier.value + ? prefixMatch[1] + : undefined; + configuration.entitlements = { + ...entitlements, + associatedDomains: resolvedAssociatedDomains.sort(), + unresolvedAssociatedDomains: unresolvedAssociatedDomains.sort(), + ...(literalAppIdentifierPrefix ? { literalAppIdentifierPrefix } : {}), + }; + } +} + +function expandEntitlementDomain( + raw: string, + settings: Record, + bundleIdentifier: string | undefined, +): string | undefined { + const variable = /\$\(([^)]+)\)|\$\{([^}]+)\}/g; + const builtins: Record = { + CFBundleIdentifier: bundleIdentifier, + PRODUCT_BUNDLE_IDENTIFIER: bundleIdentifier, + }; + const resolving = new Set(); + const expand = (value: string, depth: number): string | undefined => { + if (depth > 20) return undefined; + let unresolved = false; + variable.lastIndex = 0; + const expanded = value.replace(variable, (_match, parenthesized, braced) => { + const name = String(parenthesized ?? braced); + if (name.includes(":") || resolving.has(name)) { + unresolved = true; + return ""; + } + const replacement = settings[name] ?? builtins[name]; + if (replacement == null) { + unresolved = true; + return ""; + } + resolving.add(name); + const nested = expand(replacement, depth + 1); + resolving.delete(name); + if (nested == null) unresolved = true; + return nested ?? ""; + }); + variable.lastIndex = 0; + return unresolved || variable.test(expanded) ? undefined : expanded; + }; + + const expanded = expand(raw, 0)?.trim(); + if (!expanded || /pk_(?:test|live)_/i.test(expanded)) return undefined; + return expanded; +} + +function normalizeSynchronizedPath(path: string): string { + return path.replaceAll("\\", "/").replace(/^\.\//, "").replace(/\/$/, ""); +} + +function synchronizedExclusions( + group: PbxObject, + targetId: string, + relevantPhaseIds: Set, + objects: PbxObjects, +): Set { + const excluded = new Set(); + for (const exceptionId of asStringArray(group.exceptions)) { + const exception = objects[exceptionId]; + const appliesToTarget = + exception?.isa === "PBXFileSystemSynchronizedBuildFileExceptionSet" && + asString(exception.target) === targetId; + const appliesToPhase = + exception?.isa === "PBXFileSystemSynchronizedGroupBuildPhaseMembershipExceptionSet" && + relevantPhaseIds.has(asString(exception.buildPhase) ?? ""); + if (!appliesToTarget && !appliesToPhase) continue; + + for (const path of asStringArray(exception.membershipExceptions)) { + excluded.add(normalizeSynchronizedPath(path)); + } + if (isRecord(exception.platformFiltersByRelativePath)) { + for (const [path, filters] of Object.entries(exception.platformFiltersByRelativePath)) { + const platformFilters = stringArray(filters); + if ( + platformFilters.length > 0 && + !platformFilters.some((filter) => /(?:^|[^a-z])(?:ios|iphone)/i.test(filter)) + ) { + excluded.add(normalizeSynchronizedPath(path)); + } + } + } + } + return excluded; +} + +function synchronizedPathIsExcluded(path: string, excluded: Set): boolean { + return [...excluded].some( + (excludedPath) => path === excludedPath || path.startsWith(`${excludedPath}/`), + ); +} + +async function localSecretsForTarget(options: { + root: string; + projectPath: string; + groupRootDirectory: string; + targetId: string; + targetObject: PbxObject; + objects: PbxObjects; + parents: Map; +}): Promise { + const { root, projectPath, groupRootDirectory, targetId, targetObject, objects, parents } = + options; + const projectDirectory = dirname(projectPath); + const paths = new Set(); + const resourcePhaseIds = new Set( + asStringArray(targetObject.buildPhases).filter( + (phaseId) => objects[phaseId]?.isa === "PBXResourcesBuildPhase", + ), + ); + + for (const phaseId of resourcePhaseIds) { + const phase = objects[phaseId]; + if (phase?.isa !== "PBXResourcesBuildPhase") continue; + for (const buildFileId of asStringArray(phase.files)) { + const buildFile = objects[buildFileId]; + if (!buildFile || !buildFileIOSApplicability(buildFile).applies) continue; + const fileReference = asString(buildFile.fileRef); + if (!fileReference) continue; + const absolutePath = resolvePbxFilePath( + fileReference, + objects, + parents, + projectDirectory, + groupRootDirectory, + ); + if ( + absolutePath?.endsWith(`${sep}LocalSecrets.plist`) && + (await pathIsSafelyWithinIOSRoot(root, absolutePath)) + ) { + paths.add(absolutePath); + } + } + } + + for (const groupId of asStringArray(targetObject.fileSystemSynchronizedGroups)) { + const group = objects[groupId]; + if (group?.isa !== "PBXFileSystemSynchronizedRootGroup") continue; + const groupPath = resolvePbxFilePath( + groupId, + objects, + parents, + projectDirectory, + groupRootDirectory, + ); + if (!groupPath || !(await pathIsSafelyWithinIOSRoot(root, groupPath))) continue; + + const discovered: string[] = []; + await collectLocalSecretsPlists(root, groupPath, discovered); + const excluded = synchronizedExclusions(group, targetId, resourcePhaseIds, objects); + for (const absolutePath of discovered) { + const relativePath = relative(groupPath, absolutePath).split(sep).join("/"); + if (!synchronizedPathIsExcluded(relativePath, excluded)) paths.add(absolutePath); + } + } + + return [...paths].sort(); +} + +async function collectSwiftFiles( + root: string, + directory: string, + groupRoot: string, + excluded: Set, + files: Map, + state: { complete: boolean }, + depth = 0, +): Promise { + if (depth > MAX_SOURCE_DEPTH || files.size >= MAX_SOURCE_FILES) { + state.complete = false; + return; + } + if (!(await pathIsSafelyWithinIOSRoot(root, directory))) { + state.complete = false; + return; + } + let entries; + try { + entries = await readdir(directory, { withFileTypes: true }); + } catch { + state.complete = false; + return; + } + + entries.sort((a, b) => a.name.localeCompare(b.name)); + for (const entry of entries) { + if (files.size >= MAX_SOURCE_FILES) { + state.complete = false; + return; + } + const absolutePath = resolve(directory, entry.name); + const pathFromGroup = relative(groupRoot, absolutePath).split(sep).join("/"); + if (synchronizedPathIsExcluded(pathFromGroup, excluded)) { + continue; + } + if (entry.isDirectory()) { + if (!SOURCE_IGNORES.has(entry.name) && !entry.name.startsWith(".")) { + await collectSwiftFiles(root, absolutePath, groupRoot, excluded, files, state, depth + 1); + } + } else if (entry.isFile() && extname(entry.name) === ".swift") { + files.set(absolutePath, { absolutePath, relativePath: relativeIOSPath(root, absolutePath) }); + } else if (entry.isSymbolicLink() && extname(entry.name) === ".swift") { + state.complete = false; + } + } +} + +async function sourceFilesForTarget(options: { + root: string; + projectPath: string; + groupRootDirectory: string; + targetId: string; + targetObject: PbxObject; + objects: PbxObjects; + parents: Map; + diagnostics: IOSDiagnostic[]; +}): Promise<{ + files: Array<{ absolutePath: string; relativePath: string }>; + complete: boolean; +}> { + const { + root, + projectPath, + groupRootDirectory, + targetId, + targetObject, + objects, + parents, + diagnostics, + } = options; + const projectDirectory = dirname(projectPath); + const files = new Map(); + const state = { complete: true }; + const projectEvidencePath = relativeIOSPath(root, resolve(projectPath, "project.pbxproj")); + const reportDangling = (objectId: string, message: string): void => { + state.complete = false; + diagnostics.push({ + code: "xcode.dangling-reference", + severity: "warning", + message, + evidence: [{ path: projectEvidencePath, objectId }], + }); + }; + for (const phaseId of asStringArray(targetObject.buildPhases)) { + if (!objects[phaseId]) { + reportDangling(phaseId, `Target ${targetId} contains a dangling build phase reference.`); + } + } + const sourcePhaseIds = new Set( + asStringArray(targetObject.buildPhases).filter( + (phaseId) => objects[phaseId]?.isa === "PBXSourcesBuildPhase", + ), + ); + + for (const phaseId of sourcePhaseIds) { + const phase = objects[phaseId]; + if (phase?.isa !== "PBXSourcesBuildPhase") continue; + for (const buildFileId of asStringArray(phase.files)) { + const buildFile = objects[buildFileId]; + if (!buildFile) { + reportDangling( + buildFileId, + `Sources phase ${phaseId} contains a dangling build-file reference.`, + ); + continue; + } + const applicability = buildFileIOSApplicability(buildFile); + if (!applicability.applies) { + if (!applicability.recognized) state.complete = false; + continue; + } + const fileReference = asString(buildFile.fileRef); + if (!fileReference) { + reportDangling( + buildFileId, + `Sources phase ${phaseId} contains a build file with no file reference.`, + ); + continue; + } + if (!objects[fileReference]) { + reportDangling( + fileReference, + `Sources phase ${phaseId} contains a dangling file reference.`, + ); + continue; + } + const absolutePath = resolvePbxFilePath( + fileReference, + objects, + parents, + projectDirectory, + groupRootDirectory, + ); + if (!absolutePath) { + if (extname(asString(objects[fileReference]?.path) ?? "") === ".swift") { + state.complete = false; + } + continue; + } + if (extname(absolutePath) !== ".swift") continue; + if (!(await pathIsSafelyWithinIOSRoot(root, absolutePath))) { + state.complete = false; + diagnostics.push({ + code: "xcode.external-path", + severity: "warning", + message: `Skipped Swift source outside the inspected root: ${absolutePath}`, + evidence: [{ path: absolutePath, objectId: fileReference }], + }); + continue; + } + files.set(absolutePath, { absolutePath, relativePath: relativeIOSPath(root, absolutePath) }); + } + } + + for (const groupId of asStringArray(targetObject.fileSystemSynchronizedGroups)) { + const group = objects[groupId]; + if (group?.isa !== "PBXFileSystemSynchronizedRootGroup") { + reportDangling( + groupId, + `Target ${targetId} contains an invalid synchronized-group reference.`, + ); + continue; + } + const groupPath = resolvePbxFilePath( + groupId, + objects, + parents, + projectDirectory, + groupRootDirectory, + ); + if (!groupPath) { + state.complete = false; + continue; + } + if (!(await pathIsSafelyWithinIOSRoot(root, groupPath))) { + state.complete = false; + diagnostics.push({ + code: "xcode.external-path", + severity: "warning", + message: `Skipped synchronized source group outside the inspected root: ${groupPath}`, + evidence: [{ path: groupPath, objectId: groupId }], + }); + continue; + } + + const excluded = synchronizedExclusions(group, targetId, sourcePhaseIds, objects); + await collectSwiftFiles(root, groupPath, groupPath, excluded, files, state); + } + + if (files.size === 0 || !state.complete) { + diagnostics.push({ + code: "xcode.incomplete-source-membership", + severity: "info", + message: + files.size === 0 + ? `No Swift source membership could be resolved for ${asString(targetObject.name) ?? targetId}; source-level Clerk checks may be incomplete.` + : `Swift source membership for ${asString(targetObject.name) ?? targetId} was only partially inspected; absence checks are advisory.`, + evidence: [ + { + path: relativeIOSPath(root, resolve(projectPath, "project.pbxproj")), + objectId: targetId, + }, + ], + }); + } + + return { + files: [...files.values()].sort((a, b) => a.relativePath.localeCompare(b.relativePath)), + complete: state.complete, + }; +} + +async function parseProject( + root: string, + projectPath: string, + requestedTarget?: string, +): Promise { + const projectRelativePath = relativeIOSPath(root, projectPath); + const pbxprojPath = resolve(projectPath, "project.pbxproj"); + const pbxprojRelativePath = relativeIOSPath(root, pbxprojPath); + const diagnostics: IOSDiagnostic[] = []; + const emptyInspection = (objectVersion?: string): IOSProjectInspection => ({ + path: projectRelativePath, + pbxprojPath: pbxprojRelativePath, + objectVersion, + packages: [], + appTargetIds: [], + diagnostics, + }); + if (!(await pathIsSafelyWithinIOSRoot(root, pbxprojPath))) { + diagnostics.push({ + code: "xcode.external-path", + severity: "error", + message: `${projectRelativePath} resolves project.pbxproj outside the inspected root.`, + evidence: [{ path: pbxprojRelativePath }], + }); + return { inspection: emptyInspection(), appTargets: [], appTargetCandidates: [], diagnostics }; + } + const file = Bun.file(pbxprojPath); + if (!(await file.exists())) { + diagnostics.push({ + code: "xcode.missing-project-file", + severity: "error", + message: `${projectRelativePath} does not contain project.pbxproj.`, + evidence: [{ path: pbxprojRelativePath }], + }); + return { inspection: emptyInspection(), appTargets: [], appTargetCandidates: [], diagnostics }; + } + if (file.size > MAX_PBXPROJ_BYTES) { + diagnostics.push({ + code: "xcode.malformed-project", + severity: "error", + message: `${pbxprojRelativePath} is too large to inspect safely.`, + evidence: [{ path: pbxprojRelativePath }], + }); + return { inspection: emptyInspection(), appTargets: [], appTargetCandidates: [], diagnostics }; + } + + let archive: Record; + try { + const parsed: unknown = parsePbxProject(await readFile(pbxprojPath, "utf8")); + if (!isRecord(parsed)) throw new Error("invalid project root"); + archive = parsed; + } catch (error) { + const parserLocation = + error instanceof Error + ? error.message.match(/\b(?:line|column|position)\s+\d+(?::\d+)?/i)?.[0] + : undefined; + diagnostics.push({ + code: "xcode.malformed-project", + severity: "error", + // Parser messages can quote the surrounding pbxproj token. Do not echo + // arbitrary project content because shell phases sometimes hold secrets. + message: `Could not parse ${pbxprojRelativePath}${parserLocation ? ` (${parserLocation})` : ""}.`, + evidence: [{ path: pbxprojRelativePath }], + }); + return { inspection: emptyInspection(), appTargets: [], appTargetCandidates: [], diagnostics }; + } + + const objectVersion = asString(archive.objectVersion); + const objects = normalizeObjects(archive.objects); + if (!objects) { + diagnostics.push({ + code: "xcode.malformed-project", + severity: "error", + message: `${pbxprojRelativePath} has no readable Xcode object graph.`, + evidence: [{ path: pbxprojRelativePath }], + }); + return { + inspection: emptyInspection(objectVersion), + appTargets: [], + appTargetCandidates: [], + diagnostics, + }; + } + + const rootObjectId = asString(archive.rootObject); + const projectObject = + (rootObjectId ? objects[rootObjectId] : undefined) ?? + Object.values(objects).find((object) => object.isa === "PBXProject"); + if (projectObject?.isa !== "PBXProject") { + diagnostics.push({ + code: "xcode.malformed-project", + severity: "error", + message: `${pbxprojRelativePath} has no PBXProject root object.`, + evidence: [{ path: pbxprojRelativePath }], + }); + return { + inspection: emptyInspection(objectVersion), + appTargets: [], + appTargetCandidates: [], + diagnostics, + }; + } + + const parents = buildPbxParentIndex(objects); + const groupRootDirectory = resolve( + dirname(projectPath), + asString(projectObject.projectDirPath) ?? "", + ); + const packages = await inspectPackageReferences(root, projectPath, projectObject, objects); + const appTargets: IOSAppTarget[] = []; + const appTargetCandidates: ParsedProject["appTargetCandidates"] = []; + const targetIds = asStringArray(projectObject.targets).sort(); + const sourceMemberships: IOSTargetSourceMembership[] = []; + const sourceMembershipById = new Map< + string, + { + files: Array<{ absolutePath: string; relativePath: string }>; + complete: boolean; + diagnostics: IOSDiagnostic[]; + } + >(); + + // Resolve every native target, not only application products. Source + // mutators use this hidden result to refuse files shared with extensions, + // tests, or another app target while the public inspection JSON stays + // semantic and compact. + for (const targetId of targetIds) { + const targetObject = objects[targetId]; + if (targetObject?.isa !== "PBXNativeTarget") continue; + const membershipDiagnostics: IOSDiagnostic[] = []; + const membership = await sourceFilesForTarget({ + root, + projectPath, + groupRootDirectory, + targetId, + targetObject, + objects, + parents, + diagnostics: membershipDiagnostics, + }); + sourceMembershipById.set(targetId, { ...membership, diagnostics: membershipDiagnostics }); + sourceMemberships.push({ + targetId, + targetName: asString(targetObject.name) ?? targetId, + projectPath: projectRelativePath, + files: membership.files, + complete: membership.complete, + }); + } + + for (const targetId of targetIds) { + const targetObject = objects[targetId]; + if (targetObject?.isa !== "PBXNativeTarget" || targetObject.productType !== APP_PRODUCT_TYPE) { + continue; + } + const targetName = asString(targetObject.name) ?? targetId; + const configurationDiagnostics: IOSDiagnostic[] = []; + const targetConfigurations = await inspectTargetBuildConfigurations({ + root, + projectPath, + groupRootDirectory, + projectObject, + targetId, + targetObject, + objects, + parents, + diagnostics: configurationDiagnostics, + }); + if ( + targetConfigurations.length > 0 && + !targetConfigurations.some((configuration) => configuration.isIOS) + ) { + continue; + } + appTargetCandidates.push({ + targetId, + targetName, + projectPath: projectRelativePath, + }); + if (requestedTarget && requestedTarget !== targetId && requestedTarget !== targetName) { + continue; + } + diagnostics.push(...configurationDiagnostics); + + const configurations = targetConfigurations.map((configuration) => configuration.model); + await attachEntitlements( + root, + projectPath, + configurations, + new Map( + targetConfigurations.map((configuration) => [ + configuration.model.name, + configuration.settings, + ]), + ), + diagnostics, + ); + addBuildSettingConflictDiagnostics(targetName, configurations, diagnostics); + const targetSources = sourceMembershipById.get(targetId) ?? { + files: [], + complete: false, + diagnostics: [], + }; + diagnostics.push(...targetSources.diagnostics); + + const swiftInspection = + targetSources.files.length > 0 + ? await inspectSwiftSources(targetSources.files, { + membershipComplete: targetSources.complete, + }) + : emptySwiftInspection(); + if (targetSources.complete && !swiftInspection.evidenceComplete) { + diagnostics.push({ + code: "xcode.incomplete-source-membership", + severity: "warning", + message: `One or more Swift members of ${targetName} could not be read safely; absence checks are advisory.`, + evidence: [ + { + path: relativeIOSPath(root, resolve(projectPath, "project.pbxproj")), + objectId: targetId, + }, + ], + }); + } + + const targetLocalSecrets = await localSecretsForTarget({ + root, + projectPath, + groupRootDirectory, + targetId, + targetObject, + objects, + parents, + }); + const appTarget: IOSAppTarget = { + id: targetId, + name: targetName, + productName: asString(targetObject.productName), + projectPath: projectRelativePath, + configurations, + packages: inspectTargetPackages( + root, + projectPath, + targetName, + targetObject, + objects, + packages, + diagnostics, + ), + swift: swiftInspection, + runtimeKeySinks: targetLocalSecrets.map((path) => ({ + kind: "local-secrets-plist" as const, + path: relativeIOSPath(root, path), + })), + }; + appTargets.push(appTarget); + } + + appTargets.sort((a, b) => a.name.localeCompare(b.name) || a.id.localeCompare(b.id)); + appTargetCandidates.sort( + (a, b) => a.targetName.localeCompare(b.targetName) || a.targetId.localeCompare(b.targetId), + ); + return { + inspection: { + path: projectRelativePath, + pbxprojPath: pbxprojRelativePath, + objectVersion, + packages, + appTargetIds: appTargetCandidates.map((target) => target.targetId), + diagnostics, + }, + appTargets, + appTargetCandidates, + diagnostics, + sourceMemberships, + }; +} + +function selectTarget( + candidates: ParsedProject["appTargetCandidates"], + requestedTarget: string | undefined, + diagnostics: IOSDiagnostic[], +): IOSTargetSelection { + if (requestedTarget) { + const matches = candidates.filter( + (candidate) => + candidate.targetId === requestedTarget || candidate.targetName === requestedTarget, + ); + const match = matches[0]; + if (matches.length === 1 && match) return { state: "selected", ...match }; + if (matches.length > 1) { + const matchedByObjectId = matches.every( + (candidate) => candidate.targetId === requestedTarget, + ); + diagnostics.push({ + code: "xcode.ambiguous-app-target", + severity: "error", + message: matchedByObjectId + ? `Target object ID "${requestedTarget}" exists in more than one project.` + : `Target name "${requestedTarget}" exists in more than one project.`, + remedy: matchedByObjectId + ? "Run the inspector from the directory containing only the intended project." + : "Rerun with --target .", + evidence: matches.map((candidate) => ({ + path: candidate.projectPath, + objectId: candidate.targetId, + })), + }); + return { state: "ambiguous", candidates: matches }; + } + + diagnostics.push({ + code: "xcode.target-not-found", + severity: "error", + message: `No iOS application target matches "${requestedTarget}".`, + remedy: "Choose one of the reported target names or IDs.", + evidence: candidates.map((candidate) => ({ + path: candidate.projectPath, + objectId: candidate.targetId, + })), + }); + return { + state: "not-found", + requested: requestedTarget, + candidates: candidates.map((candidate) => `${candidate.targetName} (${candidate.targetId})`), + }; + } + + const onlyCandidate = candidates[0]; + if (candidates.length === 1 && onlyCandidate) { + return { state: "selected", ...onlyCandidate }; + } + if (candidates.length === 0) { + diagnostics.push({ + code: "xcode.no-ios-app-target", + severity: "error", + message: "No iOS application target was found.", + remedy: "Run from an iOS app project, or pass --framework ios from its project root.", + evidence: [], + }); + return { state: "none" }; + } + + diagnostics.push({ + code: "xcode.ambiguous-app-target", + severity: "error", + message: `Found ${candidates.length} iOS application targets; none was selected automatically.`, + remedy: "Rerun with --target .", + evidence: candidates.map((candidate) => ({ + path: candidate.projectPath, + objectId: candidate.targetId, + })), + }); + return { state: "ambiguous", candidates }; +} + +async function detectGeneratedProject( + root: string, +): Promise<{ kind: "xcodegen" | "tuist"; path: string } | null> { + const xcodeGenPath = resolve(root, "project.yml"); + if ( + (await pathIsSafelyWithinIOSRoot(root, xcodeGenPath)) && + (await Bun.file(xcodeGenPath).exists()) + ) { + return { kind: "xcodegen", path: "project.yml" }; + } + for (const path of ["Project.swift", "Workspace.swift", "Tuist/ProjectDescriptionHelpers"]) { + const absolutePath = resolve(root, path); + if ( + (await pathIsSafelyWithinIOSRoot(root, absolutePath)) && + (await Bun.file(absolutePath).exists()) + ) { + return { kind: "tuist", path }; + } + } + return null; +} + +export async function inspectIOSProject( + rootInput: string, + options: { target?: string; exhaustiveContainerDiscovery?: boolean } = {}, +): Promise { + const invocationPath = resolve(rootInput); + const root = invocationPath.endsWith(".xcodeproj") + ? dirname(invocationPath) + : invocationPath.endsWith(".xcworkspace") + ? dirname(invocationPath).endsWith(".xcodeproj") + ? dirname(dirname(invocationPath)) + : dirname(invocationPath) + : invocationPath; + const diagnostics: IOSDiagnostic[] = []; + const discovered = await discoverIOSContainers(invocationPath, { + exhaustive: options.exhaustiveContainerDiscovery === true, + }); + const projectPaths = new Set(discovered.projectPaths); + const workspaces = []; + + for (const workspacePath of discovered.workspacePaths) { + const workspace = await inspectWorkspace(root, workspacePath); + workspaces.push(workspace.inspection); + for (const projectPath of workspace.localProjectPaths) projectPaths.add(projectPath); + } + + if (projectPaths.size === 0) { + diagnostics.push({ + code: "xcode.no-project", + severity: "error", + message: "No .xcodeproj was found in the inspected root.", + remedy: "Run this command from the directory containing your iOS project.", + evidence: [], + }); + } + + const projects: IOSProjectInspection[] = []; + const appTargets: IOSAppTarget[] = []; + const appTargetCandidates: ParsedProject["appTargetCandidates"] = []; + const sourceMemberships: IOSTargetSourceMembership[] = []; + for (const projectPath of [...projectPaths].sort()) { + const parsed = await parseProject(root, projectPath, options.target); + projects.push(parsed.inspection); + appTargets.push(...parsed.appTargets); + appTargetCandidates.push(...parsed.appTargetCandidates); + sourceMemberships.push(...(parsed.sourceMemberships ?? [])); + diagnostics.push(...parsed.diagnostics); + } + if (options.exhaustiveContainerDiscovery === true && !discovered.complete) { + for (const membership of sourceMemberships) membership.complete = false; + } + appTargets.sort( + (a, b) => + a.projectPath.localeCompare(b.projectPath) || + a.name.localeCompare(b.name) || + a.id.localeCompare(b.id), + ); + appTargetCandidates.sort( + (a, b) => + a.projectPath.localeCompare(b.projectPath) || + a.targetName.localeCompare(b.targetName) || + a.targetId.localeCompare(b.targetId), + ); + + const generatedProjectMarker = await detectGeneratedProject(root); + if (generatedProjectMarker) { + diagnostics.push({ + code: "xcode.generated-project", + severity: "warning", + message: `This appears to be a ${generatedProjectMarker.kind === "xcodegen" ? "XcodeGen" : "Tuist"} project. Future automated setup must update the source manifest, not generated project.pbxproj output.`, + evidence: [{ path: generatedProjectMarker.path }], + }); + } + + const selection = selectTarget(appTargetCandidates, options.target, diagnostics); + const selectedAppTarget = + selection.state === "selected" + ? appTargets.find( + (target) => + target.id === selection.targetId && target.projectPath === selection.projectPath, + ) + : undefined; + const inlinePublishableKeyCandidates: PublishableKeyCandidate[] = + selectedAppTarget?.swift.configureCalls + .filter((call) => call.publishableKeyWiring === "inline-literal") + .map((call) => ({ + source: call.path, + evidence: [{ path: call.path, keyPath: "Clerk.configure(publishableKey:)" }], + priority: 0, + ...(call.inlinePublishableKey?.state === "valid" + ? { + decoded: { + frontendApiHost: call.inlinePublishableKey.frontendApiHost, + instanceType: call.inlinePublishableKey.instanceType, + }, + } + : { invalid: true as const }), + })) ?? []; + const localPublishableKeyInspection = await inspectLocalPublishableKeys( + root, + selection, + selectedAppTarget?.runtimeKeySinks.map((sink) => resolve(root, sink.path)) ?? [], + [ + ...(selection.state === "selected" ? [resolve(root, selection.projectPath)] : []), + ...discovered.workspacePaths, + ], + inlinePublishableKeyCandidates, + diagnostics, + ); + const result: IOSProjectInspectionResult = { + schemaVersion: 1, + platform: "ios", + root, + workspaces: workspaces.sort((a, b) => a.path.localeCompare(b.path)), + projects: projects.sort((a, b) => a.path.localeCompare(b.path)), + appTargets, + selection, + localPublishableKey: localPublishableKeyInspection, + generatedProject: generatedProjectMarker?.kind ?? null, + diagnostics, + }; + sourceMembershipByInspection.set(result, sourceMemberships); + return result; +} + +/** + * Returns the exact source-membership result used by the iOS semantic + * inspector without adding source paths to the serializable inspection JSON. + * This is intended for strict source mutators that must prove a non-Clerk + * Swift file belongs to one selected application target. + */ +export async function inspectIOSSourceMembership( + rootInput: string, +): Promise { + const inspection = await inspectIOSProject(rootInput, { + exhaustiveContainerDiscovery: true, + }); + return sourceMembershipByInspection.get(inspection) ?? []; +} diff --git a/packages/cli-core/src/commands/init/ios/pbx.test.ts b/packages/cli-core/src/commands/init/ios/pbx.test.ts new file mode 100644 index 00000000..02723826 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/pbx.test.ts @@ -0,0 +1,116 @@ +import { describe, expect, test } from "bun:test"; +import { join } from "node:path"; +import { + buildPbxParentIndex, + isClerkIOSRepository, + resolvePbxFilePath, + sanitizeRepositoryURL, + type PbxObjects, +} from "./pbx.ts"; + +describe("resolvePbxFilePath", () => { + test("does not treat a pathless group's display name as a directory", () => { + const objects: PbxObjects = { + root: { + isa: "PBXGroup", + children: ["logical"], + sourceTree: "", + }, + logical: { + isa: "PBXGroup", + children: ["file"], + name: "Navigator Label", + sourceTree: "", + }, + file: { + isa: "PBXFileReference", + name: "Display Name.swift", + path: "Sources/App.swift", + sourceTree: "", + }, + }; + const projectDirectory = join("/", "tmp", "Example"); + + expect( + resolvePbxFilePath("file", objects, buildPbxParentIndex(objects), projectDirectory), + ).toBe(join(projectDirectory, "Sources", "App.swift")); + }); + + test("does not guess a path from a pathless file reference's display name", () => { + const objects: PbxObjects = { + root: { + isa: "PBXGroup", + children: ["file"], + sourceTree: "", + }, + file: { + isa: "PBXFileReference", + name: "Display Name.swift", + sourceTree: "", + }, + }; + + expect( + resolvePbxFilePath("file", objects, buildPbxParentIndex(objects), "/tmp/Example"), + ).toBeUndefined(); + }); + + test("uses projectDirPath only for group-relative paths, not SOURCE_ROOT", () => { + const objects: PbxObjects = { + main: { isa: "PBXGroup", children: ["group", "sourceRootFile"], sourceTree: "" }, + group: { + isa: "PBXGroup", + children: ["groupFile"], + path: "Sources", + sourceTree: "", + }, + groupFile: { isa: "PBXFileReference", path: "App.swift", sourceTree: "" }, + sourceRootFile: { + isa: "PBXFileReference", + path: "Root.swift", + sourceTree: "SOURCE_ROOT", + }, + }; + const parents = buildPbxParentIndex(objects); + + expect( + resolvePbxFilePath( + "groupFile", + objects, + parents, + "/tmp/Example", + "/tmp/Example/ActualProjectRoot", + ), + ).toBe("/tmp/Example/ActualProjectRoot/Sources/App.swift"); + expect( + resolvePbxFilePath( + "sourceRootFile", + objects, + parents, + "/tmp/Example", + "/tmp/Example/ActualProjectRoot", + ), + ).toBe("/tmp/Example/Root.swift"); + }); +}); + +describe("sanitizeRepositoryURL", () => { + test("canonicalizes Clerk HTTPS and SCP-style repository URLs", () => { + expect(sanitizeRepositoryURL("https://token@example.com/clerk/clerk-ios.git?key=secret")).toBe( + "https://example.com/clerk/clerk-ios", + ); + expect(sanitizeRepositoryURL("git@github.com:clerk/clerk-ios.git")).toBe( + "ssh://github.com/clerk/clerk-ios", + ); + expect(isClerkIOSRepository("git@github.com:clerk/clerk-ios.git")).toBe(true); + }); + + test("does not expose unsupported local or malformed repository values", () => { + expect(sanitizeRepositoryURL("file:///Users/alice/private/clerk-ios")).toBe( + "file://", + ); + expect(sanitizeRepositoryURL("not valid token@example.com/path")).toBe( + "", + ); + }); +}); diff --git a/packages/cli-core/src/commands/init/ios/pbx.ts b/packages/cli-core/src/commands/init/ios/pbx.ts new file mode 100644 index 00000000..a9b73c75 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/pbx.ts @@ -0,0 +1,129 @@ +import { isAbsolute, resolve } from "node:path"; + +export type PbxObject = Record & { isa?: string }; +export type PbxObjects = Record; + +export function isRecord(value: unknown): value is Record { + return typeof value === "object" && value !== null && !Array.isArray(value); +} + +export function asString(value: unknown): string | undefined { + if (typeof value === "string") return value; + if (typeof value === "number") return String(value); + return undefined; +} + +export function asStringArray(value: unknown): string[] { + if (!Array.isArray(value)) return []; + return value.filter((item): item is string => typeof item === "string"); +} + +export function asStringRecord(value: unknown): Record { + if (!isRecord(value)) return {}; + const result: Record = {}; + for (const [key, item] of Object.entries(value)) { + if (typeof item === "string" || typeof item === "number") { + result[key] = String(item); + } else if (Array.isArray(item)) { + result[key] = item.map(String).join(" "); + } + } + return result; +} + +export function buildPbxParentIndex(objects: PbxObjects): Map { + const parents = new Map(); + for (const [id, object] of Object.entries(objects)) { + for (const child of asStringArray(object.children)) { + if (!parents.has(child)) parents.set(child, id); + } + } + return parents; +} + +/** Resolve a group/file reference without invoking Xcode. */ +export function resolvePbxFilePath( + objectId: string, + objects: PbxObjects, + parents: Map, + projectDirectory: string, + groupRootDirectory: string = projectDirectory, + seen: Set = new Set(), +): string | undefined { + if (seen.has(objectId)) return undefined; + seen.add(objectId); + + const object = objects[objectId]; + if (!object) return undefined; + + const objectPath = asString(object.path); + // `name` is only an Xcode navigator display label. A pathless group is a + // logical group and contributes no filesystem component; a pathless file + // reference cannot be resolved without guessing. + if (objectPath == null && object.isa === "PBXFileReference") return undefined; + const rawPath = objectPath ?? ""; + const sourceTree = asString(object.sourceTree) ?? ""; + + if (sourceTree === "") { + return rawPath ? resolve(rawPath) : undefined; + } + if (isAbsolute(rawPath)) { + return resolve(rawPath); + } + if (sourceTree === "SOURCE_ROOT" || sourceTree === "") { + return resolve(projectDirectory, rawPath); + } + if (sourceTree !== "") return undefined; + + const parentId = parents.get(objectId); + if (!parentId) return resolve(groupRootDirectory, rawPath); + const parentPath = resolvePbxFilePath( + parentId, + objects, + parents, + projectDirectory, + groupRootDirectory, + seen, + ); + return parentPath ? resolve(parentPath, rawPath) : undefined; +} + +export function sanitizeRepositoryURL(repository: string): string { + const trimmed = repository.trim(); + const scpMatch = trimmed.match(/^(?:[^@]+@)?([^:]+):(.+)$/); + const scpHost = scpMatch?.[1]; + const scpPath = scpMatch?.[2]; + if (scpHost && scpPath && !trimmed.includes("://")) { + return `ssh://${scpHost.toLowerCase()}/${scpPath.replace(/^\/+/, "")}` + .replace(/\.git\/?$/i, "") + .replace(/\/$/, ""); + } + + try { + const url = new URL(trimmed); + if (!["https:", "http:", "ssh:", "git:"].includes(url.protocol)) { + return `${url.protocol}//`; + } + url.username = ""; + url.password = ""; + url.search = ""; + url.hash = ""; + return `${url.protocol}//${url.host.toLowerCase()}${url.pathname}` + .replace(/\.git\/?$/i, "") + .replace(/\/$/, ""); + } catch { + const sanitized = trimmed + .replace(/[?#].*$/, "") + .replace(/\.git\/?$/i, "") + .replace(/\/$/, ""); + return /^[a-zA-Z0-9._/-]+$/.test(sanitized) ? sanitized : ""; + } +} + +export function isClerkIOSRepository(repository: string): boolean { + const canonical = sanitizeRepositoryURL(repository).toLowerCase(); + return ( + canonical === "https://github.com/clerk/clerk-ios" || + canonical === "ssh://github.com/clerk/clerk-ios" + ); +} diff --git a/packages/cli-core/src/commands/init/ios/products.test.ts b/packages/cli-core/src/commands/init/ios/products.test.ts new file mode 100644 index 00000000..e2ede877 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/products.test.ts @@ -0,0 +1,151 @@ +import { describe, expect, test } from "bun:test"; +import { + clerkKitUIInstallDecision, + hasIOSDirectConfigCompatibility, + shouldInstallClerkKitUI, + shouldPlanIOSDirectConfig, +} from "./products.ts"; +import type { IOSAppTarget, IOSProjectInspectionResult } from "./types.ts"; + +function target(): IOSAppTarget { + return { + id: "TARGET", + name: "MyApp", + projectPath: "MyApp.xcodeproj", + configurations: [], + packages: { package: "absent", clerkKit: "absent", clerkKitUI: "absent" }, + runtimeKeySinks: [], + swift: { + sourceFilesScanned: 1, + evidenceComplete: true, + entryPoints: [{ path: "MyApp/MyAppApp.swift" }], + importsClerkKit: [], + importsClerkKitUI: [], + configureCalls: [], + localSecretsRuntimeBindings: [], + environmentInjections: [], + environmentConsumers: [], + authFlowReferences: [], + openURLHandlers: [], + status: "absent", + }, + }; +} + +function inspection(selected: IOSAppTarget): IOSProjectInspectionResult { + return { + schemaVersion: 1, + platform: "ios", + root: "/tmp/test", + workspaces: [], + projects: [], + appTargets: [selected], + selection: { + state: "selected", + targetId: selected.id, + targetName: selected.name, + projectPath: selected.projectPath, + }, + localPublishableKey: { + found: false, + conflict: false, + candidateSources: [], + invalidSources: [], + }, + generatedProject: null, + diagnostics: [], + }; +} + +describe("shouldInstallClerkKitUI", () => { + test("defaults an untouched, fully inspected target to the prebuilt UI path", () => { + expect(shouldInstallClerkKitUI(target())).toBe(true); + }); + + test("upgrades a source-blank ClerkKit-only graph created by an earlier setup", () => { + const coreOnly = target(); + coreOnly.packages = { package: "remote", clerkKit: "linked", clerkKitUI: "absent" }; + expect(shouldInstallClerkKitUI(coreOnly)).toBe(true); + }); + + test("preserves a source-proven custom-flow target", () => { + const customSource = target(); + customSource.swift.importsClerkKit = [{ path: "MyApp/Auth.swift" }]; + customSource.swift.status = "partial"; + expect(shouldInstallClerkKitUI(customSource)).toBe(false); + }); + + test("honors existing ClerkKitUI source or product evidence", () => { + const imported = target(); + imported.swift.importsClerkKitUI = [{ path: "MyApp/Auth.swift" }]; + imported.swift.status = "partial"; + expect(shouldInstallClerkKitUI(imported)).toBe(true); + + const declared = target(); + declared.packages.clerkKitUI = "declared"; + expect(shouldInstallClerkKitUI(declared)).toBe(true); + }); + + test("does not infer a prebuilt default from incomplete source evidence", () => { + const incomplete = target(); + incomplete.swift.evidenceComplete = false; + incomplete.packages = { package: "remote", clerkKit: "linked", clerkKitUI: "absent" }; + expect(clerkKitUIInstallDecision(incomplete)).toBe("unknown"); + expect(shouldInstallClerkKitUI(incomplete)).toBe(false); + + incomplete.swift.importsClerkKit = [{ path: "MyApp/Visible.swift" }]; + expect(clerkKitUIInstallDecision(incomplete)).toBe("unknown"); + expect(shouldInstallClerkKitUI(incomplete)).toBe(false); + }); +}); + +describe("direct configuration compatibility", () => { + test.each(["local-secrets-loader", "process-info-environment"] as const)( + "preserves an existing %s configure route", + (publishableKeyWiring) => { + const selected = target(); + selected.swift.configureCalls = [ + { + path: "MyApp/MyAppApp.swift", + publishableKeyWiring, + startupBinding: "app-init", + ...(publishableKeyWiring === "local-secrets-loader" + ? { localSecretsRuntimeBinding: "proven" as const } + : {}), + }, + ]; + const result = inspection(selected); + + expect(hasIOSDirectConfigCompatibility(result, selected)).toBe(true); + expect(shouldPlanIOSDirectConfig(result, selected)).toBe(false); + }, + ); + + test("preserves an enabled selected-target scheme key route", () => { + const selected = target(); + const result = inspection(selected); + result.localPublishableKey.candidateSources = [ + "MyApp.xcodeproj/xcshareddata/xcschemes/MyApp.xcscheme", + ]; + + expect(hasIOSDirectConfigCompatibility(result, selected)).toBe(true); + expect(shouldPlanIOSDirectConfig(result, selected)).toBe(false); + }); + + test("preserves a target-owned runtime key sink", () => { + const selected = target(); + selected.runtimeKeySinks = [{ kind: "local-secrets-plist", path: "MyApp/LocalSecrets.plist" }]; + const result = inspection(selected); + + expect(hasIOSDirectConfigCompatibility(result, selected)).toBe(true); + expect(shouldPlanIOSDirectConfig(result, selected)).toBe(false); + }); + + test("plans direct configuration for a fresh compatible target", () => { + const selected = target(); + const result = inspection(selected); + + expect(hasIOSDirectConfigCompatibility(result, selected)).toBe(false); + expect(shouldPlanIOSDirectConfig(result, selected)).toBe(true); + }); +}); diff --git a/packages/cli-core/src/commands/init/ios/products.ts b/packages/cli-core/src/commands/init/ios/products.ts new file mode 100644 index 00000000..86b9e3dd --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/products.ts @@ -0,0 +1,59 @@ +import type { IOSAppTarget, IOSProjectInspectionResult } from "./types.ts"; + +export type ClerkKitUIInstallDecision = "prebuilt" | "core-only" | "unknown"; + +/** + * Chooses the prebuilt UI product for an explicitly UI-backed target or for a + * fully inspected target that has not begun a custom Clerk integration. A + * source-blank ClerkKit-only graph is upgraded because an earlier CLI release + * may have created it; source-proven custom targets remain core-only. + */ +export function clerkKitUIInstallDecision(target: IOSAppTarget): ClerkKitUIInstallDecision { + const hasUIIntent = + target.swift.importsClerkKitUI.length > 0 || target.packages.clerkKitUI !== "absent"; + if (hasUIIntent) return "prebuilt"; + + const hasCustomSourceIntent = target.swift.importsClerkKit.length > 0; + if (!target.swift.evidenceComplete) return "unknown"; + return hasCustomSourceIntent ? "core-only" : "prebuilt"; +} + +export function shouldInstallClerkKitUI(target: IOSAppTarget): boolean { + return clerkKitUIInstallDecision(target) === "prebuilt"; +} + +/** Existing runtime-key routes that direct source configuration must preserve. */ +export function hasIOSDirectConfigCompatibility( + inspection: IOSProjectInspectionResult, + target: IOSAppTarget, +): boolean { + const hasCompatibleConfigure = target.swift.configureCalls.some( + (call) => + call.publishableKeyWiring === "local-secrets-loader" || + call.publishableKeyWiring === "process-info-environment", + ); + const hasEnabledSchemeKey = inspection.localPublishableKey.candidateSources.some((source) => + source.endsWith(".xcscheme"), + ); + return hasCompatibleConfigure || hasEnabledSchemeKey || target.runtimeKeySinks.length > 0; +} + +/** + * Routes only the fresh/direct-literal Swift path to the source mutator. + * Existing LocalSecrets and ProcessInfo integrations remain compatibility + * paths and are never rewritten into a literal automatically. + */ +export function shouldPlanIOSDirectConfig( + inspection: IOSProjectInspectionResult, + target: IOSAppTarget, + productDecision: ClerkKitUIInstallDecision = clerkKitUIInstallDecision(target), +): boolean { + if (hasIOSDirectConfigCompatibility(inspection, target)) return false; + + const hasInlineConfigure = target.swift.configureCalls.some( + (call) => call.publishableKeyWiring === "inline-literal", + ); + return ( + hasInlineConfigure || target.swift.configureCalls.length > 0 || productDecision === "prebuilt" + ); +} diff --git a/packages/cli-core/src/commands/init/ios/swift.test.ts b/packages/cli-core/src/commands/init/ios/swift.test.ts new file mode 100644 index 00000000..6c774125 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/swift.test.ts @@ -0,0 +1,879 @@ +import { afterEach, describe, expect, test } from "bun:test"; +import { mkdtemp, rm } from "node:fs/promises"; +import { join } from "node:path"; +import { tmpdir } from "node:os"; +import { inspectSwiftSources, sanitizeSwiftSource } from "./swift.ts"; + +const temporaryDirectories: string[] = []; + +afterEach(async () => { + await Promise.all(temporaryDirectories.splice(0).map((path) => rm(path, { recursive: true }))); +}); + +describe("sanitizeSwiftSource", () => { + test("removes nested comments and standard, multiline, and raw strings", () => { + const source = ` + // Clerk.configure(publishableKey: "fake") + /* outer /* @main */ AuthView() */ + let standard = "Clerk.configure()" + let multiline = """.environment(Clerk.shared)""" + let raw = ##"AuthView()"## + @main struct RealApp: App {} + `; + + const sanitized = sanitizeSwiftSource(source); + expect(sanitized).not.toContain("Clerk.configure"); + expect(sanitized).not.toContain("AuthView"); + expect(sanitized).not.toContain(".environment"); + expect(sanitized).toContain("@main struct RealApp"); + }); +}); + +describe("inspectSwiftSources", () => { + test("records real Clerk evidence without retaining key expressions", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "App.swift"); + await Bun.write( + path, + `import ClerkKit + import ClerkKitUI + @main struct AppMain: App { + init() { Clerk.configure(publishableKey: "pk_test_must-not-leak") } + var body: some Scene { + WindowGroup { + AuthView() + .environment(Clerk.shared) + .onOpenURL { url in + Task { try await Clerk.shared.handle(url) } + } + } + } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "App.swift" }, + ]); + + expect(inspection.status).toBe("complete"); + expect(inspection.configureCalls).toEqual([ + { + path: "App.swift", + publishableKeyWiring: "inline-literal", + inlinePublishableKey: { state: "invalid" }, + startupBinding: "app-init", + }, + ]); + expect(inspection.environmentInjections).toEqual([{ path: "App.swift" }]); + expect(inspection.authFlowReferences).toEqual([{ path: "App.swift" }]); + expect(inspection.openURLHandlers).toEqual([{ path: "App.swift" }]); + expect(JSON.stringify(inspection)).not.toContain("must-not-leak"); + }); + + test("retains only decoded metadata for a valid inline publishable key", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "App.swift"); + const publishableKey = `pk_test_${Buffer.from("inline.clerk.example$").toString("base64")}`; + await Bun.write( + path, + `import ClerkKit + @main struct AppMain: App { + init() { Clerk.configure(publishableKey: "${publishableKey}") } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "App.swift" }, + ]); + + expect(inspection.configureCalls).toEqual([ + { + path: "App.swift", + publishableKeyWiring: "inline-literal", + inlinePublishableKey: { + state: "valid", + frontendApiHost: "inline.clerk.example", + instanceType: "development", + }, + startupBinding: "app-init", + }, + ]); + expect(JSON.stringify(inspection)).not.toContain(publishableKey); + }); + + test("recognizes selective ClerkKit and ClerkKitUI imports", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const corePath = join(root, "Core.swift"); + const uiPath = join(root, "UI.swift"); + await Bun.write(corePath, "import class ClerkKit.Clerk\n"); + await Bun.write(uiPath, "import struct ClerkKitUI.AuthView\n"); + + const inspection = await inspectSwiftSources([ + { absolutePath: corePath, relativePath: "Core.swift" }, + { absolutePath: uiPath, relativePath: "UI.swift" }, + ]); + + expect(inspection.importsClerkKit).toEqual([{ path: "Core.swift" }]); + expect(inspection.importsClerkKitUI).toEqual([{ path: "UI.swift" }]); + expect(inspection.status).toBe("partial"); + }); + + test("classifies runtime key wiring without retaining expressions or values", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "Configuration.swift"); + await Bun.write( + path, + `import ClerkKit + func configureFromLoad() { + Clerk.configure(publishableKey: QuickstartLocalSecrets.load().publishableKey ?? "pk_test_loader-secret") + } + func configureFromProperty() { + Clerk.configure(publishableKey: LocalSecrets.key) + } + func configureFromEnvironment() { + Clerk.configure(publishableKey: ProcessInfo.processInfo.environment["CLERK_PUBLISHABLE_KEY"] ?? "pk_test_environment-secret") + } + func configureFromUnrelatedEnvironment() { + Clerk.configure(publishableKey: ProcessInfo.processInfo.environment["ANALYTICS_KEY"] ?? "not-a-clerk-key") + } + func configureFromUnknownSource() { + Clerk.configure(publishableKey: ApplicationSecrets.clerkKey) + } + func configureAfterUnicode() { + let note = "🔐" + Clerk.configure(publishableKey: ProcessInfo.processInfo.environment["CLERK_PUBLISHABLE_KEY"]) + } + func configureWithUnrelatedLaterArgument() { + Clerk.configure(publishableKey: ApplicationSecrets.clerkKey, cache: LocalSecrets.key) + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "Configuration.swift" }, + ]); + + expect(inspection.configureCalls).toEqual([ + { + path: "Configuration.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "Configuration.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "Configuration.swift", + publishableKeyWiring: "process-info-environment", + startupBinding: "unproven", + }, + { + path: "Configuration.swift", + publishableKeyWiring: "unknown", + startupBinding: "unproven", + }, + { + path: "Configuration.swift", + publishableKeyWiring: "unknown", + startupBinding: "unproven", + }, + { + path: "Configuration.swift", + publishableKeyWiring: "process-info-environment", + startupBinding: "unproven", + }, + { + path: "Configuration.swift", + publishableKeyWiring: "unknown", + startupBinding: "unproven", + }, + ]); + const serialized = JSON.stringify(inspection); + expect(serialized).not.toContain("QuickstartLocalSecrets"); + expect(serialized).not.toContain("ProcessInfo"); + expect(serialized).not.toContain("loader-secret"); + expect(serialized).not.toContain("environment-secret"); + expect(serialized).not.toContain("ANALYTICS_KEY"); + }); + + test("proves only an exact LocalSecrets plist runtime binding", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const provenPath = join(root, "LocalSecrets.swift"); + const nameOnlyPath = join(root, "NameOnly.swift"); + const configPath = join(root, "App.swift"); + await Bun.write( + provenPath, + `import Foundation + struct QuickstartLocalSecrets { + let publishableKey: String? + let analyticsKey: String? + + static func load(bundle: Bundle = .main) -> QuickstartLocalSecrets { + guard let url = bundle.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let values = plist as? [String: Any] + else { return .init(publishableKey: nil, analyticsKey: nil) } + return .init( + publishableKey: values["CLERK_PUBLISHABLE_KEY"] as? String, + analyticsKey: values["ANALYTICS_KEY"] as? String + ) + } + } + + struct SameFileFakeLocalSecrets { + let publishableKey: String? + static func load(bundle: Bundle) -> SameFileFakeLocalSecrets { + guard let url = bundle.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let values = plist as? [String: Any] + else { return .init(publishableKey: nil) } + return .init(publishableKey: values["CLERK_PUBLISHABLE_KEY"] as? String) + } + static func unrelatedDefault(bundle: Bundle = .main) { + _ = bundle + } + } + + struct SideEffectOnlyLocalSecrets { + let publishableKey: String? + static func load() -> SideEffectOnlyLocalSecrets { + let values = ApplicationSecrets.values + _ = unusedCanonicalHelper() + return .init(publishableKey: values["CLERK_PUBLISHABLE_KEY"] as? String) + } + static func unusedCanonicalHelper() -> String? { + guard let url = Bundle.main.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let values = plist as? [String: Any] + else { return nil } + return values["CLERK_PUBLISHABLE_KEY"] as? String + } + } + + enum ApplicationSecrets { + static let values: [String: Any] = [:] + } + + struct ShadowedLocalSecrets { + let publishableKey: String? + static func load(bundle: Bundle = .main) -> ShadowedLocalSecrets { + let values = ApplicationSecrets.values + if let url = bundle.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let values = plist as? [String: Any] { + _ = values + } + return .init(publishableKey: values["CLERK_PUBLISHABLE_KEY"] as? String) + } + }`, + ); + await Bun.write( + nameOnlyPath, + `// Bundle.main.url(forResource: "LocalSecrets", withExtension: "plist") + struct FakeLocalSecrets { + static let key = ApplicationSecrets.clerkKey + static let decoy = "CLERK_PUBLISHABLE_KEY" + }`, + ); + await Bun.write( + configPath, + `import ClerkKit + func configureProven() { + Clerk.configure(publishableKey: QuickstartLocalSecrets.load().publishableKey ?? "") + } + func configureExplicitBundle() { + Clerk.configure(publishableKey: QuickstartLocalSecrets.load(bundle: Bundle.module).publishableKey ?? "") + } + func configureWrongReturnedMember() { + Clerk.configure(publishableKey: QuickstartLocalSecrets.load().analyticsKey ?? "") + } + func configureLargerUnrelatedExpression() { + Clerk.configure(publishableKey: ApplicationSecrets.choose(QuickstartLocalSecrets.load().publishableKey)) + } + func configureAlternateFallback() { + Clerk.configure(publishableKey: QuickstartLocalSecrets.load().publishableKey ?? ApplicationSecrets.key) + } + func configureSameFileDecoy() { + Clerk.configure(publishableKey: SameFileFakeLocalSecrets.load().publishableKey ?? "") + } + func configureSideEffectOnlyDecoy() { + Clerk.configure(publishableKey: SideEffectOnlyLocalSecrets.load().publishableKey ?? "") + } + func configureShadowedDecoy() { + Clerk.configure(publishableKey: ShadowedLocalSecrets.load().publishableKey ?? "") + } + func configureDecoy() { + Clerk.configure(publishableKey: FakeLocalSecrets.key) + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: configPath, relativePath: "App.swift" }, + { absolutePath: nameOnlyPath, relativePath: "NameOnly.swift" }, + { absolutePath: provenPath, relativePath: "LocalSecrets.swift" }, + ]); + + expect(inspection.localSecretsRuntimeBindings).toEqual([{ path: "LocalSecrets.swift" }]); + expect(inspection.configureCalls).toEqual([ + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "proven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "unproven", + localSecretsRuntimeBinding: "unproven", + }, + ]); + expect(JSON.stringify(inspection)).not.toContain("CLERK_PUBLISHABLE_KEY"); + }); + + test("rejects unreachable, conditional, alternate, and mutable delegated resolver returns", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const loaderPath = join(root, "LocalSecrets.swift"); + const configPath = join(root, "App.swift"); + const delegatedLoader = ( + symbol: string, + resolverBody: string, + overrides: { loadBody?: string; normalizerBody?: string; extraMethods?: string } = {}, + ) => ` + struct ${symbol} { + let publishableKey: String? + + static func load( + bundle: Bundle = .main, + processInfo: ProcessInfo = .processInfo + ) -> ${symbol} { + ${ + overrides.loadBody ?? + `let plistValues = localSecretsPlistValues(bundle: bundle) + return .init( + publishableKey: resolveValue( + for: "CLERK_PUBLISHABLE_KEY", + processInfo: processInfo, + plistValues: plistValues + ) + ) + ` + } + } + + static func resolveValue( + for key: String, + processInfo: ProcessInfo, + plistValues: [String: Any] + ) -> String? { + ${resolverBody} + } + + static func normalized(_ value: String?) -> String? { + ${ + overrides.normalizerBody ?? + `guard let value = value?.trimmingCharacters(in: .whitespacesAndNewlines), !value.isEmpty else { + return nil + } + return value` + } + } + + static func localSecretsPlistValues(bundle: Bundle) -> [String: Any] { + guard let url = bundle.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let values = plist as? [String: Any] + else { return [:] } + return values + } + + ${overrides.extraMethods ?? ""} + } + `; + + await Bun.write( + loaderPath, + `import Foundation + ${delegatedLoader( + "CanonicalDelegatedLocalSecrets", + `guard !key.isEmpty else { + return nil + } + if let environmentValue = normalized(processInfo.environment[key]) { + return environmentValue + } + return normalized(plistValues[key] as? String)`, + )} + ${delegatedLoader( + "UnreachableDecoyLocalSecrets", + `if false { + return normalized(plistValues[key] as? String) + } + return ApplicationSecrets.key`, + )} + ${delegatedLoader( + "ConditionalLookupLocalSecrets", + `if ApplicationSecrets.usePlist { + return normalized(plistValues[key] as? String) + } + return ApplicationSecrets.key`, + )} + ${delegatedLoader( + "AlternatePathLocalSecrets", + `if ApplicationSecrets.useAlternate { + return ApplicationSecrets.key + } + return normalized(plistValues[key] as? String)`, + )} + ${delegatedLoader( + "MultipleDirectReturnsLocalSecrets", + `return normalized(plistValues[key] as? String) + return ApplicationSecrets.key`, + )} + ${delegatedLoader( + "ShadowedDictionaryLocalSecrets", + `let plistValues = ApplicationSecrets.values + return normalized(plistValues[key] as? String)`, + )} + ${delegatedLoader( + "ReassignedDictionaryLocalSecrets", + `plistValues[key] = ApplicationSecrets.key + return normalized(plistValues[key] as? String)`, + )} + ${delegatedLoader( + "ClosureLookupLocalSecrets", + `let lookup = { + return normalized(plistValues[key] as? String) + } + return lookup()`, + )} + ${delegatedLoader( + "ArbitraryWrapperLocalSecrets", + `return alternate(plistValues[key] as? String)`, + { + extraMethods: `static func alternate(_ value: String?) -> String? { + ApplicationSecrets.key + }`, + }, + )} + ${delegatedLoader( + "ReassignedHelperValueLocalSecrets", + `return normalized(plistValues[key] as? String)`, + { + loadBody: `var plistValues = localSecretsPlistValues(bundle: bundle) + plistValues = ApplicationSecrets.values + return .init( + publishableKey: resolveValue( + for: "CLERK_PUBLISHABLE_KEY", + processInfo: processInfo, + plistValues: plistValues + ) + )`, + }, + )} + ${delegatedLoader( + "TrustedSideEffectModuleLocalSecrets", + `return normalized(plistValues[key] as? String)`, + { + loadBody: `_ = localSecretsPlistValues(bundle: bundle) + let plistValues = localSecretsPlistValues(bundle: .module) + return .init( + publishableKey: resolveValue( + for: "CLERK_PUBLISHABLE_KEY", + processInfo: processInfo, + plistValues: plistValues + ) + )`, + }, + )} + ${delegatedLoader( + "AlternateNormalizerLocalSecrets", + `return normalized(plistValues[key] as? String)`, + { + normalizerBody: `guard let value else { return nil } + return ApplicationSecrets.key`, + }, + )}`, + ); + await Bun.write( + configPath, + `import ClerkKit + func configureCanonical() { + Clerk.configure(publishableKey: CanonicalDelegatedLocalSecrets.load().publishableKey ?? "") + } + func configureUnreachableDecoy() { + Clerk.configure(publishableKey: UnreachableDecoyLocalSecrets.load().publishableKey ?? "") + } + func configureConditionalLookup() { + Clerk.configure(publishableKey: ConditionalLookupLocalSecrets.load().publishableKey ?? "") + } + func configureAlternatePath() { + Clerk.configure(publishableKey: AlternatePathLocalSecrets.load().publishableKey ?? "") + } + func configureMultipleReturns() { + Clerk.configure(publishableKey: MultipleDirectReturnsLocalSecrets.load().publishableKey ?? "") + } + func configureShadowedDictionary() { + Clerk.configure(publishableKey: ShadowedDictionaryLocalSecrets.load().publishableKey ?? "") + } + func configureReassignedDictionary() { + Clerk.configure(publishableKey: ReassignedDictionaryLocalSecrets.load().publishableKey ?? "") + } + func configureClosureLookup() { + Clerk.configure(publishableKey: ClosureLookupLocalSecrets.load().publishableKey ?? "") + } + func configureArbitraryWrapper() { + Clerk.configure(publishableKey: ArbitraryWrapperLocalSecrets.load().publishableKey ?? "") + } + func configureReassignedHelperValue() { + Clerk.configure(publishableKey: ReassignedHelperValueLocalSecrets.load().publishableKey ?? "") + } + func configureTrustedSideEffectModule() { + Clerk.configure(publishableKey: TrustedSideEffectModuleLocalSecrets.load().publishableKey ?? "") + } + func configureAlternateNormalizer() { + Clerk.configure(publishableKey: AlternateNormalizerLocalSecrets.load().publishableKey ?? "") + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: configPath, relativePath: "App.swift" }, + { absolutePath: loaderPath, relativePath: "LocalSecrets.swift" }, + ]); + + expect(inspection.configureCalls.map((call) => call.localSecretsRuntimeBinding)).toEqual([ + "proven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + "unproven", + ]); + expect(inspection.localSecretsRuntimeBindings).toEqual([{ path: "LocalSecrets.swift" }]); + }); + + test("does not prove a LocalSecrets loader under conditional compilation", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "App.swift"); + await Bun.write( + path, + `import ClerkKit + import Foundation + + #if DEBUG + struct ConditionalLocalSecrets { + let publishableKey: String? + static func load() -> ConditionalLocalSecrets { + guard let url = Bundle.main.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let values = plist as? [String: Any] + else { return .init(publishableKey: nil) } + return .init(publishableKey: values["CLERK_PUBLISHABLE_KEY"] as? String) + } + } + #endif + + @main struct AppMain: App { + init() { + Clerk.configure(publishableKey: ConditionalLocalSecrets.load().publishableKey ?? "") + } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "App.swift" }, + ]); + + expect(inspection.localSecretsRuntimeBindings).toEqual([]); + expect(inspection.configureCalls).toEqual([ + { + path: "App.swift", + publishableKeyWiring: "local-secrets-loader", + startupBinding: "app-init", + localSecretsRuntimeBinding: "unproven", + }, + ]); + }); + + test("proves only a direct call in the @main type's init as startup-bound", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "App.swift"); + await Bun.write( + path, + `import ClerkKit + @main struct AppMain: App { + init() { + Clerk.configure(publishableKey: ApplicationSecrets.direct) + let deferredConfiguration = { + Clerk.configure(publishableKey: ApplicationSecrets.nestedClosure) + } + #if DEBUG + Clerk.configure(publishableKey: ApplicationSecrets.conditional) + #endif + _ = deferredConfiguration + } + + func unusedHelper() { + Clerk.configure(publishableKey: ApplicationSecrets.helper) + } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "App.swift" }, + ]); + + expect(inspection.configureCalls.map((call) => call.startupBinding)).toEqual([ + "app-init", + "unproven", + "unproven", + "unproven", + ]); + }); + + test("only records an open URL handler when its closure forwards to Clerk", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const unrelatedPath = join(root, "Unrelated.swift"); + const clerkPath = join(root, "ClerkCallback.swift"); + await Bun.write( + unrelatedPath, + `import ClerkKit + struct Unrelated: View { + var body: some View { + Text("Hello") + .onOpenURL { url in Analytics.shared.track(url) } + } + func handleElsewhere(_ url: URL) async throws { + try await Clerk.shared.handle(url) + } + }`, + ); + await Bun.write( + clerkPath, + `import ClerkKit + struct Callback: View { + @Environment(Clerk.self) private var clerk + var body: some View { + Text("Hello") + .onOpenURL { url in + Task { try await clerk.handle(url) } + } + } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: unrelatedPath, relativePath: "Unrelated.swift" }, + { absolutePath: clerkPath, relativePath: "ClerkCallback.swift" }, + ]); + + expect(inspection.openURLHandlers).toEqual([{ path: "ClerkCallback.swift" }]); + }); + + test("recognizes native Clerk auth calls without matching unrelated sign-in APIs", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const emailCodePath = join(root, "EmailCode.swift"); + const passwordPath = join(root, "Password.swift"); + const signUpPath = join(root, "SignUp.swift"); + const hostedAuthPath = join(root, "HostedAuth.swift"); + const unrelatedPath = join(root, "UnrelatedFlow.swift"); + await Bun.write( + emailCodePath, + `import ClerkKit + struct EmailCodeFlow { + @Environment(Clerk.self) private var clerk + func run() async throws { + try await clerk.auth.signInWithEmailCode(emailAddress: "person@example.com") + } + }`, + ); + await Bun.write( + passwordPath, + `import ClerkKit + struct PasswordFlow { + func run() async throws { + try await Clerk.shared.auth.signInWithPassword(identifier: "person@example.com", password: "secret") + } + }`, + ); + await Bun.write( + signUpPath, + `import ClerkKit + struct SignUpFlow { + @Environment(Clerk.self) private var clerk + func run() async throws { + _ = try await clerk.auth.signUp(emailAddress: "person@example.com") + } + }`, + ); + await Bun.write( + hostedAuthPath, + `import ClerkKit + struct HostedAuthFlow { + @Environment(Clerk.self) private var clerk + func run() async throws { + _ = try await clerk.auth.startHostedAuth() + } + }`, + ); + await Bun.write( + unrelatedPath, + `struct UnrelatedFlow { + func run() { + _ = AuthView() + clerk.auth.signUp() + analytics.auth.signInWithPassword() + signIn.create() + signUp.prepare() + } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: emailCodePath, relativePath: "EmailCode.swift" }, + { absolutePath: passwordPath, relativePath: "Password.swift" }, + { absolutePath: signUpPath, relativePath: "SignUp.swift" }, + { absolutePath: hostedAuthPath, relativePath: "HostedAuth.swift" }, + { absolutePath: unrelatedPath, relativePath: "UnrelatedFlow.swift" }, + ]); + + expect(inspection.authFlowReferences).toEqual([ + { path: "EmailCode.swift" }, + { path: "HostedAuth.swift" }, + { path: "Password.swift" }, + { path: "SignUp.swift" }, + ]); + }); + + test("marks multiple entry points as ambiguous", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const paths = [join(root, "One.swift"), join(root, "Two.swift")]; + await Promise.all(paths.map((path) => Bun.write(path, "@main struct Entry: App {}"))); + + const inspection = await inspectSwiftSources( + paths.map((absolutePath) => ({ + absolutePath, + relativePath: absolutePath.endsWith("One.swift") ? "One.swift" : "Two.swift", + })), + ); + + expect(inspection.status).toBe("ambiguous"); + expect(inspection.entryPoints).toHaveLength(2); + }); + + test("marks source evidence incomplete when a target member is missing", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + + const inspection = await inspectSwiftSources([ + { absolutePath: join(root, "Missing.swift"), relativePath: "Missing.swift" }, + ]); + + expect(inspection.evidenceComplete).toBe(false); + expect(inspection.sourceFilesScanned).toBe(0); + }); + + test("marks source evidence incomplete when a target member exceeds the scan limit", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "Oversized.swift"); + await Bun.write(path, "x".repeat(1_000_001)); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "Oversized.swift" }, + ]); + + expect(inspection.evidenceComplete).toBe(false); + expect(inspection.sourceFilesScanned).toBe(0); + }); + + test("does not treat preview-only Clerk UI as a shipping authentication flow", async () => { + const root = await mkdtemp(join(tmpdir(), "clerk-ios-swift-")); + temporaryDirectories.push(root); + const path = join(root, "ContentView.swift"); + await Bun.write( + path, + `import ClerkKitUI + import SwiftUI + struct ContentView: View { var body: some View { Text("Hello") } } + #Preview { AuthView() } + struct LegacyPreview: PreviewProvider { + static var previews: some View { SignInView() } + }`, + ); + + const inspection = await inspectSwiftSources([ + { absolutePath: path, relativePath: "ContentView.swift" }, + ]); + + expect(inspection.authFlowReferences).toEqual([]); + }); +}); diff --git a/packages/cli-core/src/commands/init/ios/swift.ts b/packages/cli-core/src/commands/init/ios/swift.ts new file mode 100644 index 00000000..ce727d10 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/swift.ts @@ -0,0 +1,1771 @@ +import { readFile } from "node:fs/promises"; +import { decodePublishableKey } from "../../../lib/fapi.ts"; +import type { + IOSConfigureCallEvidence, + IOSInlinePublishableKeyInspection, + IOSPublishableKeyWiring, + IOSSourceEvidence, + IOSSwiftInspection, +} from "./types.ts"; + +const MAX_SWIFT_FILE_BYTES = 1_000_000; + +function blankRange(chars: string[], start: number, end: number): void { + for (let i = start; i < end; i++) { + if (chars[i] !== "\n" && chars[i] !== "\r") chars[i] = " "; + } +} + +/** + * Removes comments and string contents while preserving offsets and newlines. + * This is intentionally a small lexer rather than a regex: Swift supports + * nested block comments, multiline strings, and arbitrary raw-string hashes. + */ +function sanitizeSwift(source: string, blankStrings: boolean): string { + // Swift source offsets below are JavaScript UTF-16 indexes. Split into code + // units so blanking an emoji or other astral character never shifts later + // slices into the original source. + const chars = source.split(""); + let i = 0; + + while (i < chars.length) { + if (chars[i] === "/" && chars[i + 1] === "/") { + const start = i; + i += 2; + while (i < chars.length && chars[i] !== "\n") i++; + blankRange(chars, start, i); + continue; + } + + if (chars[i] === "/" && chars[i + 1] === "*") { + const start = i; + let depth = 1; + i += 2; + while (i < chars.length && depth > 0) { + if (chars[i] === "/" && chars[i + 1] === "*") { + depth++; + i += 2; + } else if (chars[i] === "*" && chars[i + 1] === "/") { + depth--; + i += 2; + } else { + i++; + } + } + blankRange(chars, start, i); + continue; + } + + let hashCount = 0; + while (chars[i + hashCount] === "#") hashCount++; + const quoteIndex = i + hashCount; + if (chars[quoteIndex] !== '"') { + i++; + continue; + } + + const start = i; + const multiline = + chars[quoteIndex] === '"' && chars[quoteIndex + 1] === '"' && chars[quoteIndex + 2] === '"'; + i = quoteIndex + (multiline ? 3 : 1); + + while (i < chars.length) { + const closesQuote = multiline + ? chars[i] === '"' && chars[i + 1] === '"' && chars[i + 2] === '"' + : chars[i] === '"'; + + if (closesQuote) { + const quoteLength = multiline ? 3 : 1; + let closesHashes = true; + for (let h = 0; h < hashCount; h++) { + if (chars[i + quoteLength + h] !== "#") closesHashes = false; + } + if (closesHashes) { + i += quoteLength + hashCount; + break; + } + } + + // Backslash escapes apply directly in normal strings and only when + // followed by the matching number of hashes in raw strings. + if (chars[i] === "\\") { + let escapeHashes = 0; + while (chars[i + 1 + escapeHashes] === "#") escapeHashes++; + if (escapeHashes === hashCount) { + i += 2 + escapeHashes; + continue; + } + } + i++; + } + + if (blankStrings) blankRange(chars, start, i); + } + + return chars.join(""); +} + +export function sanitizeSwiftSource(source: string): string { + return sanitizeSwift(source, true); +} + +function sourceWithoutComments(source: string): string { + return sanitizeSwift(source, false); +} + +function has(source: string, pattern: RegExp): boolean { + pattern.lastIndex = 0; + return pattern.test(source); +} + +const CLERK_URL_HANDLER = /\b(?:Clerk\s*\.\s*shared|clerk)\s*\.\s*handle\s*\(/; +const CLERK_NATIVE_AUTH_FLOW = + /\b(?:Clerk\s*\.\s*shared|clerk)\s*\.\s*auth\s*\.\s*(?:signIn(?:With(?:Password|EmailCode|EmailLink|PhoneCode|OAuth|IdToken|Apple|Passkey|EnterpriseSSO|Ticket))?|signUp(?:With(?:OAuth|Apple|IdToken|EnterpriseSSO|Ticket))?|startHostedAuth)\s*\(/; + +function topLevelCommaSeparated(source: string): string[] { + const segments: string[] = []; + let start = 0; + let parenthesisDepth = 0; + let bracketDepth = 0; + let braceDepth = 0; + for (let index = 0; index < source.length; index++) { + const character = source[index]; + if (character === "(") parenthesisDepth++; + if (character === ")") parenthesisDepth--; + if (character === "[") bracketDepth++; + if (character === "]") bracketDepth--; + if (character === "{") braceDepth++; + if (character === "}") braceDepth--; + if (character === "," && parenthesisDepth === 0 && bracketDepth === 0 && braceDepth === 0) { + segments.push(source.slice(start, index)); + start = index + 1; + } + } + segments.push(source.slice(start)); + return segments.map((segment) => segment.trim()).filter(Boolean); +} + +interface DirectStaticMethodEvidence { + name: string; + parameters: string; + header: string; + openingBrace: number; + closingBrace: number; +} + +interface BundleParameterEvidence { + externalName: string; + localName: string; + defaultsToMain: boolean; +} + +function directStaticMethods( + source: string, + typeOpeningBrace: number, + typeClosingBrace: number, +): DirectStaticMethodEvidence[] { + const methods: DirectStaticMethodEvidence[] = []; + const methodPattern = /\bstatic\s+func\s+([A-Za-z_][A-Za-z0-9_]*)\s*\(/g; + methodPattern.lastIndex = typeOpeningBrace + 1; + let method: RegExpExecArray | null; + + while ((method = methodPattern.exec(source)) !== null && method.index < typeClosingBrace) { + const name = method[1]; + if (!name || braceDepthAt(source, typeOpeningBrace, method.index) !== 1) continue; + const openingParenthesis = source.indexOf("(", method.index); + const closingParenthesis = matchingParenthesis(source, openingParenthesis); + if (closingParenthesis == null || closingParenthesis >= typeClosingBrace) continue; + const parameters = source.slice(openingParenthesis + 1, closingParenthesis); + + const methodOpeningBrace = source.indexOf("{", closingParenthesis + 1); + if (methodOpeningBrace === -1 || methodOpeningBrace >= typeClosingBrace) continue; + const methodHeader = source.slice(closingParenthesis + 1, methodOpeningBrace); + if ( + /[;}]/.test(methodHeader) || + /\bfunc\b/.test(methodHeader) || + braceDepthAt(source, typeOpeningBrace, methodOpeningBrace) !== 1 + ) { + continue; + } + const methodClosingBrace = matchingBrace(source, methodOpeningBrace); + if (methodClosingBrace == null || methodClosingBrace > typeClosingBrace) continue; + + methods.push({ + name, + parameters, + header: methodHeader, + openingBrace: methodOpeningBrace, + closingBrace: methodClosingBrace, + }); + methodPattern.lastIndex = methodClosingBrace + 1; + } + + return methods; +} + +function bundleParameters(parameters: string): BundleParameterEvidence[] { + return topLevelCommaSeparated(parameters).flatMap((parameter) => { + const match = + /^(?:(_|[A-Za-z_][A-Za-z0-9_]*)\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*:\s*Bundle\b([\s\S]*)$/.exec( + parameter, + ); + const localName = match?.[2]; + if (!localName) return []; + return [ + { + externalName: match[1] ?? localName, + localName, + defaultsToMain: /=\s*(?:Bundle\s*)?\.\s*main\b/.test(match[3] ?? ""), + }, + ]; + }); +} + +function directZeroArgumentLoadEvidence( + methods: DirectStaticMethodEvidence[], +): DirectStaticMethodEvidence | undefined { + const candidates = methods.filter((method) => { + if (method.name !== "load" || /\b(?:async|throws|rethrows)\b/.test(method.header)) { + return false; + } + return topLevelCommaSeparated(method.parameters).every((parameter) => parameter.includes("=")); + }); + return candidates.length === 1 ? candidates[0] : undefined; +} + +function escapeRegularExpression(value: string): string { + return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); +} + +function directCallArguments( + source: string, + caller: DirectStaticMethodEvidence, + typeSymbol: string, + calleeName: string, +): string[] { + const bodyStart = caller.openingBrace + 1; + const body = source.slice(bodyStart, caller.closingBrace); + const escapedType = escapeRegularExpression(typeSymbol); + const escapedCallee = escapeRegularExpression(calleeName); + const pattern = new RegExp( + `(?:^|[^A-Za-z0-9_.])(?:(?:Self|${escapedType})\\s*\\.\\s*)?${escapedCallee}\\s*\\(`, + "g", + ); + const argumentsList: string[] = []; + let call: RegExpExecArray | null; + + while ((call = pattern.exec(body)) !== null) { + const localOpeningParenthesis = call.index + call[0].lastIndexOf("("); + const openingParenthesis = bodyStart + localOpeningParenthesis; + if (braceDepthAt(source, caller.openingBrace, openingParenthesis) !== 1) continue; + const closingParenthesis = matchingParenthesis(source, openingParenthesis); + if (closingParenthesis == null || closingParenthesis >= caller.closingBrace) continue; + argumentsList.push(source.slice(openingParenthesis + 1, closingParenthesis)); + pattern.lastIndex = closingParenthesis - bodyStart + 1; + } + + return argumentsList; +} + +function reachableStaticMethods( + source: string, + typeSymbol: string, + methods: DirectStaticMethodEvidence[], + root: DirectStaticMethodEvidence, +): DirectStaticMethodEvidence[] | undefined { + const methodsByName = new Map(); + for (const method of methods) { + const existing = methodsByName.get(method.name) ?? []; + existing.push(method); + methodsByName.set(method.name, existing); + } + + const reachable = new Map([[root.openingBrace, root]]); + const pending = [root]; + while (pending.length > 0) { + const caller = pending.shift(); + if (!caller) break; + const callerBody = source.slice(caller.openingBrace + 1, caller.closingBrace); + for (const [name, candidates] of methodsByName) { + const calls = directCallArguments(source, caller, typeSymbol, name); + if (calls.length === 0) continue; + if ( + new RegExp(`\\b(?:let|var|func)\\s+${escapeRegularExpression(name)}\\b`).test(callerBody) + ) { + return undefined; + } + if (candidates.length !== 1) return undefined; + const callee = candidates[0]; + if (callee && !reachable.has(callee.openingBrace)) { + reachable.set(callee.openingBrace, callee); + pending.push(callee); + } + } + } + return [...reachable.values()]; +} + +function localDeclarationPositions( + source: string, + method: DirectStaticMethodEvidence, + name: string, +): number[] { + const bodyStart = method.openingBrace + 1; + const body = source.slice(bodyStart, method.closingBrace); + const pattern = new RegExp(`\\b(?:let|var)\\s+${escapeRegularExpression(name)}\\b`, "g"); + return [...body.matchAll(pattern)].map((match) => bodyStart + match.index); +} + +function hasUniqueDirectImmutableLocalDeclaration( + source: string, + method: DirectStaticMethodEvidence, + name: string, +): boolean { + const bodyStart = method.openingBrace + 1; + const body = source.slice(bodyStart, method.closingBrace); + const declarationPattern = new RegExp(`\\b(let|var)\\s+${escapeRegularExpression(name)}\\b`, "g"); + const declarations = [...body.matchAll(declarationPattern)]; + return ( + declarations.length === 1 && + declarations[0]?.[1] === "let" && + declarations[0].index != null && + braceDepthAt(source, method.openingBrace, bodyStart + declarations[0].index) === 1 + ); +} + +function hasUniqueImmutableInitializedLocal( + source: string, + method: DirectStaticMethodEvidence, + name: string, +): boolean { + if (!hasUniqueDirectImmutableLocalDeclaration(source, method, name)) return false; + const body = source.slice(method.openingBrace + 1, method.closingBrace); + const escapedName = escapeRegularExpression(name); + const declarationsWithInitializers = [ + ...body.matchAll(new RegExp(`\\blet\\s+${escapedName}(?:\\s*:[^=,;{}\\n\\r]+)?\\s*=`, "g")), + ]; + if (declarationsWithInitializers.length !== 1) return false; + + // An immutable declaration may only receive its declaration initializer. + // Property/subscript writes and mutating collection operations make the + // value reaching the key lookup impossible to prove with this scanner. + const writes = [ + ...body.matchAll( + new RegExp( + `\\b${escapedName}\\s*(?:\\[[^\\]\\n\\r]*\\]|\\.[A-Za-z_][A-Za-z0-9_]*)?\\s*=(?!=)`, + "g", + ), + ), + ]; + if (writes.length !== 1) return false; + return !new RegExp( + `\\b${escapedName}\\s*\\.\\s*(?:append|appendContentsOf|insert|remove|removeAll|removeValue|replaceSubrange|reserveCapacity|sort|swapAt|updateValue)\\s*\\(`, + ).test(body); +} + +function hasParameterMutationOrShadowing( + source: string, + method: DirectStaticMethodEvidence, + parameter: string, +): boolean { + if (localDeclarationPositions(source, method, parameter).length > 0) return true; + const body = source.slice(method.openingBrace + 1, method.closingBrace); + const escapedParameter = escapeRegularExpression(parameter); + return ( + new RegExp( + `\\b${escapedParameter}\\s*(?:\\[[^\\]\\n\\r]*\\]|\\.[A-Za-z_][A-Za-z0-9_]*)?\\s*=(?!=)`, + ).test(body) || + new RegExp( + `\\b${escapedParameter}\\s*\\.\\s*(?:append|appendContentsOf|insert|remove|removeAll|removeValue|replaceSubrange|reserveCapacity|sort|swapAt|updateValue)\\s*\\(`, + ).test(body) + ); +} + +interface ExactMainBundleResourceEvidence { + urlVariablesByMethod: Map>; +} + +function exactMainBundleResourceEvidence( + structuralSource: string, + valueSource: string, + typeSymbol: string, + reachableMethods: DirectStaticMethodEvidence[], + loadMethod: DirectStaticMethodEvidence, +): ExactMainBundleResourceEvidence { + const trustedBundleParameters = new Map>([ + [ + loadMethod.openingBrace, + new Set( + bundleParameters(loadMethod.parameters) + .filter((parameter) => parameter.defaultsToMain) + .map((parameter) => parameter.localName), + ), + ], + ]); + const methodsByName = new Map(reachableMethods.map((method) => [method.name, method])); + + let changed = true; + while (changed) { + changed = false; + for (const caller of reachableMethods) { + const trustedCallerNames = new Set( + [...(trustedBundleParameters.get(caller.openingBrace) ?? [])].filter( + (name) => localDeclarationPositions(structuralSource, caller, name).length === 0, + ), + ); + for (const [calleeName, callee] of methodsByName) { + const calleeBundleParameters = bundleParameters(callee.parameters); + if (calleeBundleParameters.length === 0) continue; + for (const callArguments of directCallArguments( + structuralSource, + caller, + typeSymbol, + calleeName, + )) { + const argumentSegments = topLevelCommaSeparated(callArguments); + for (const parameter of calleeBundleParameters) { + if (parameter.externalName === "_") continue; + const escapedLabel = escapeRegularExpression(parameter.externalName); + const trustedArgument = argumentSegments.some((argument) => { + const label = new RegExp(`^${escapedLabel}\\s*:\\s*([A-Za-z_][A-Za-z0-9_]*)$`).exec( + argument, + ); + return label?.[1] != null && trustedCallerNames.has(label[1]); + }); + const literalMainArgument = argumentSegments.some((argument) => + new RegExp(`^${escapedLabel}\\s*:\\s*(?:Bundle\\s*)?\\.\\s*main$`).test(argument), + ); + if (!trustedArgument && !literalMainArgument) continue; + const trustedCalleeNames = + trustedBundleParameters.get(callee.openingBrace) ?? new Set(); + if (!trustedCalleeNames.has(parameter.localName)) { + trustedCalleeNames.add(parameter.localName); + trustedBundleParameters.set(callee.openingBrace, trustedCalleeNames); + changed = true; + } + } + } + } + } + } + + const urlVariablesByMethod = new Map>(); + for (const method of reachableMethods) { + const body = valueSource.slice(method.openingBrace + 1, method.closingBrace); + const urlVariables = new Set(); + for (const match of body.matchAll( + /\blet\s+([A-Za-z_][A-Za-z0-9_]*)\s*=\s*Bundle\s*\.\s*main\s*\.\s*url\s*\(\s*forResource\s*:\s*"LocalSecrets"\s*,\s*withExtension\s*:\s*"plist"/g, + )) { + if (match[1] && hasUniqueImmutableInitializedLocal(structuralSource, method, match[1])) { + urlVariables.add(match[1]); + } + } + for (const variable of trustedBundleParameters.get(method.openingBrace) ?? []) { + if (localDeclarationPositions(structuralSource, method, variable).length > 0) continue; + const pattern = new RegExp( + `\\blet\\s+([A-Za-z_][A-Za-z0-9_]*)\\s*=\\s*${escapeRegularExpression(variable)}\\s*\\.\\s*url\\s*\\(\\s*forResource\\s*:\\s*"LocalSecrets"\\s*,\\s*withExtension\\s*:\\s*"plist"`, + "g", + ); + for (const match of body.matchAll(pattern)) { + if (match[1] && hasUniqueImmutableInitializedLocal(structuralSource, method, match[1])) { + urlVariables.add(match[1]); + } + } + } + if (urlVariables.size > 0) urlVariablesByMethod.set(method.openingBrace, urlVariables); + } + return { urlVariablesByMethod }; +} + +interface RedactedExpressionEvidence { + structural: string; + value: string; +} + +interface NamedParameterEvidence { + externalName: string; + localName: string; +} + +function namedParameters(parameters: string): NamedParameterEvidence[] { + return topLevelCommaSeparated(parameters).flatMap((parameter) => { + const match = /^(?:(_|[A-Za-z_][A-Za-z0-9_]*)\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*:/.exec(parameter); + const localName = match?.[2]; + if (!localName) return []; + return [{ externalName: match[1] ?? localName, localName }]; + }); +} + +function isTopLevelPosition(source: string, position: number): boolean { + let parenthesisDepth = 0; + let bracketDepth = 0; + let braceDepth = 0; + for (let index = 0; index < position; index++) { + const character = source[index]; + if (character === "(") parenthesisDepth++; + if (character === ")") parenthesisDepth--; + if (character === "[") bracketDepth++; + if (character === "]") bracketDepth--; + if (character === "{") braceDepth++; + if (character === "}") braceDepth--; + } + return parenthesisDepth === 0 && bracketDepth === 0 && braceDepth === 0; +} + +function topLevelLabeledExpression( + structuralArguments: string, + valueArguments: string, + label: string, +): RedactedExpressionEvidence | undefined { + const labelPattern = new RegExp(`\\b${escapeRegularExpression(label)}\\s*:`, "g"); + const expressions: RedactedExpressionEvidence[] = []; + let match: RegExpExecArray | null; + + while ((match = labelPattern.exec(structuralArguments)) !== null) { + if (!isTopLevelPosition(structuralArguments, match.index)) continue; + const start = match.index + match[0].length; + let end = structuralArguments.length; + let parenthesisDepth = 0; + let bracketDepth = 0; + let braceDepth = 0; + for (let index = start; index < structuralArguments.length; index++) { + const character = structuralArguments[index]; + if (character === "(") parenthesisDepth++; + if (character === ")") parenthesisDepth--; + if (character === "[") bracketDepth++; + if (character === "]") bracketDepth--; + if (character === "{") braceDepth++; + if (character === "}") braceDepth--; + if (character === "," && parenthesisDepth === 0 && bracketDepth === 0 && braceDepth === 0) { + end = index; + break; + } + } + expressions.push({ + structural: structuralArguments.slice(start, end), + value: valueArguments.slice(start, end), + }); + } + + return expressions.length === 1 ? expressions[0] : undefined; +} + +function returnedPublishableKeyExpression( + structuralSource: string, + valueSource: string, + typeSymbol: string, + loadMethod: DirectStaticMethodEvidence, +): RedactedExpressionEvidence | undefined { + const bodyStart = loadMethod.openingBrace + 1; + const structuralBody = structuralSource.slice(bodyStart, loadMethod.closingBrace); + const escapedType = escapeRegularExpression(typeSymbol); + const returnPattern = new RegExp(`\\breturn\\s+(?:\\.\\s*init|${escapedType})\\s*\\(`, "g"); + const expressions: RedactedExpressionEvidence[] = []; + let returnedInitializer: RegExpExecArray | null; + + while ((returnedInitializer = returnPattern.exec(structuralBody)) !== null) { + const returnIndex = bodyStart + returnedInitializer.index; + if (braceDepthAt(structuralSource, loadMethod.openingBrace, returnIndex) !== 1) continue; + const openingParenthesis = + bodyStart + returnedInitializer.index + returnedInitializer[0].lastIndexOf("("); + const closingParenthesis = matchingParenthesis(structuralSource, openingParenthesis); + if (closingParenthesis == null || closingParenthesis >= loadMethod.closingBrace) continue; + const structuralArguments = structuralSource.slice(openingParenthesis + 1, closingParenthesis); + const valueArguments = valueSource.slice(openingParenthesis + 1, closingParenthesis); + const expression = topLevelLabeledExpression( + structuralArguments, + valueArguments, + "publishableKey", + ); + if (expression) expressions.push(expression); + returnPattern.lastIndex = closingParenthesis - bodyStart + 1; + } + + return expressions.length === 1 ? expressions[0] : undefined; +} + +function correlatedDecodedDictionaryNames( + structuralSource: string, + valueSource: string, + method: DirectStaticMethodEvidence, + exactURLVariables: Set, +): Set { + const body = valueSource.slice(method.openingBrace + 1, method.closingBrace); + const dataVariables = new Set(); + for (const urlVariable of exactURLVariables) { + const pattern = new RegExp( + `\\blet\\s+([A-Za-z_][A-Za-z0-9_]*)\\s*=\\s*(?:try\\s*[?!]?\\s*)?Data\\s*\\(\\s*contentsOf\\s*:\\s*${escapeRegularExpression(urlVariable)}\\b`, + "g", + ); + for (const match of body.matchAll(pattern)) { + if (match[1] && hasUniqueImmutableInitializedLocal(structuralSource, method, match[1])) { + dataVariables.add(match[1]); + } + } + } + + const propertyListVariables = new Set(); + for (const dataVariable of dataVariables) { + const pattern = new RegExp( + `\\blet\\s+([A-Za-z_][A-Za-z0-9_]*)\\s*=\\s*(?:try\\s*[?!]?\\s*)?PropertyListSerialization\\s*\\.\\s*propertyList\\s*\\(\\s*from\\s*:\\s*${escapeRegularExpression(dataVariable)}\\b`, + "g", + ); + for (const match of body.matchAll(pattern)) { + if (match[1] && hasUniqueImmutableInitializedLocal(structuralSource, method, match[1])) { + propertyListVariables.add(match[1]); + } + } + } + + const dictionaryVariables = new Set(); + for (const propertyListVariable of propertyListVariables) { + const pattern = new RegExp( + `\\blet\\s+([A-Za-z_][A-Za-z0-9_]*)\\s*=\\s*${escapeRegularExpression(propertyListVariable)}\\s+as\\s*\\?\\s*\\[\\s*String\\s*:\\s*Any\\s*\\]`, + "g", + ); + for (const match of body.matchAll(pattern)) { + if (match[1] && hasUniqueImmutableInitializedLocal(structuralSource, method, match[1])) { + dictionaryVariables.add(match[1]); + } + } + } + + let changed = true; + while (changed) { + changed = false; + for (const sourceVariable of dictionaryVariables) { + const aliasPattern = new RegExp( + `(?:^|[;{}\\n\\r])\\s*let\\s+([A-Za-z_][A-Za-z0-9_]*)(?:\\s*:\\s*[^=;{}\\n\\r]+)?\\s*=\\s*${escapeRegularExpression(sourceVariable)}\\b`, + "g", + ); + for (const match of body.matchAll(aliasPattern)) { + const alias = match[1]; + if ( + alias && + !dictionaryVariables.has(alias) && + hasUniqueImmutableInitializedLocal(structuralSource, method, alias) + ) { + dictionaryVariables.add(alias); + changed = true; + } + } + + // Support the direct fixture's definite-initialization form: + // `let values: [String: Any]`, assigned either the decoded immutable + // dictionary or `[:]` in an exact if/else. These are initializations of + // a `let`, not later mutations. + const conditionalAliasPattern = + /\blet\s+([A-Za-z_][A-Za-z0-9_]*)\s*:\s*\[\s*String\s*:\s*Any\s*\](?!\s*=)/g; + for (const aliasDeclaration of body.matchAll(conditionalAliasPattern)) { + const alias = aliasDeclaration[1]; + if ( + !alias || + alias === sourceVariable || + dictionaryVariables.has(alias) || + !hasUniqueDirectImmutableLocalDeclaration(structuralSource, method, alias) + ) { + continue; + } + const escapedAlias = escapeRegularExpression(alias); + const escapedSource = escapeRegularExpression(sourceVariable); + const assignments = [ + ...body.matchAll(new RegExp(`\\b${escapedAlias}\\s*=\\s*([^;{}\\n\\r]+)`, "g")), + ].map((match) => match[1]?.replace(/\s+/g, "")); + if ( + assignments.length !== 2 || + assignments.filter((assignment) => assignment === sourceVariable).length !== 1 || + assignments.filter((assignment) => assignment === "[:]").length !== 1 || + new RegExp( + `\\b${escapedAlias}\\s*(?:\\[[^\\]\\n\\r]*\\]|\\.[A-Za-z_][A-Za-z0-9_]*)\\s*=(?!=)`, + ).test(body) || + new RegExp( + `\\b${escapedAlias}\\s*\\.\\s*(?:append|appendContentsOf|insert|remove|removeAll|removeValue|replaceSubrange|reserveCapacity|sort|swapAt|updateValue)\\s*\\(`, + ).test(body) + ) { + continue; + } + const exactBranches = new RegExp( + `\\{\\s*${escapedAlias}\\s*=\\s*${escapedSource}\\s*\\}\\s*else\\s*\\{\\s*${escapedAlias}\\s*=\\s*\\[\\s*:\\s*\\]\\s*\\}`, + ).test(body); + if (!exactBranches) continue; + dictionaryVariables.add(alias); + changed = true; + } + } + } + return dictionaryVariables; +} + +function directlyReturnedDictionaryName( + structuralSource: string, + method: DirectStaticMethodEvidence, + dictionaryNames: Set, +): string | undefined { + const bodyStart = method.openingBrace + 1; + const body = structuralSource.slice(bodyStart, method.closingBrace); + const returnedNames: string[] = []; + const returnPattern = /\breturn\s+([A-Za-z_][A-Za-z0-9_]*)\b/g; + let returned: RegExpExecArray | null; + while ((returned = returnPattern.exec(body)) !== null) { + const name = returned[1]; + const returnIndex = bodyStart + returned.index; + if ( + name && + dictionaryNames.has(name) && + braceDepthAt(structuralSource, method.openingBrace, returnIndex) === 1 + ) { + returnedNames.push(name); + } + } + return returnedNames.length === 1 ? returnedNames[0] : undefined; +} + +function directExactKeyLookupBase(valueExpression: string): string | undefined { + const subscript = + /^\s*([A-Za-z_][A-Za-z0-9_]*)\s*\[\s*"CLERK_PUBLISHABLE_KEY"\s*\]\s*(?:as\s*\?\s*String)?\s*$/.exec( + valueExpression, + ); + if (subscript?.[1]) return subscript[1]; + return /^\s*([A-Za-z_][A-Za-z0-9_]*)\s*\.\s*(?:value|object)\s*\(\s*forKey\s*:\s*"CLERK_PUBLISHABLE_KEY"\s*\)\s*(?:as\s*\?\s*String)?\s*$/.exec( + valueExpression, + )?.[1]; +} + +interface ReturnStatementEvidence { + index: number; + depth: number; + structuralExpression: string; + valueExpression: string; +} + +function returnStatements( + structuralSource: string, + valueSource: string, + method: DirectStaticMethodEvidence, +): ReturnStatementEvidence[] { + const bodyStart = method.openingBrace + 1; + const body = structuralSource.slice(bodyStart, method.closingBrace); + const statements: ReturnStatementEvidence[] = []; + const returnPattern = /\breturn\b/g; + let returned: RegExpExecArray | null; + + while ((returned = returnPattern.exec(body)) !== null) { + const returnIndex = bodyStart + returned.index; + let expressionStart = returnIndex + returned[0].length; + while ( + structuralSource[expressionStart] === " " || + structuralSource[expressionStart] === "\t" + ) { + expressionStart++; + } + + let expressionEnd = expressionStart; + let parenthesisDepth = 0; + let bracketDepth = 0; + let braceDepth = 0; + for (; expressionEnd < method.closingBrace; expressionEnd++) { + const character = structuralSource[expressionEnd]; + if ( + (character === "\n" || character === "\r" || character === ";") && + parenthesisDepth === 0 && + bracketDepth === 0 && + braceDepth === 0 + ) { + break; + } + if (character === "}" && parenthesisDepth === 0 && bracketDepth === 0 && braceDepth === 0) { + break; + } + if (character === "(") parenthesisDepth++; + if (character === ")") parenthesisDepth--; + if (character === "[") bracketDepth++; + if (character === "]") bracketDepth--; + if (character === "{") braceDepth++; + if (character === "}") braceDepth--; + } + + statements.push({ + index: returnIndex, + depth: braceDepthAt(structuralSource, method.openingBrace, returnIndex), + structuralExpression: structuralSource.slice(expressionStart, expressionEnd).trim(), + valueExpression: valueSource.slice(expressionStart, expressionEnd).trim(), + }); + returnPattern.lastIndex = Math.max(returnPattern.lastIndex, expressionEnd - bodyStart); + } + + return statements; +} + +type ExactLookupTransform = "direct" | "normalized"; + +function exactResolverLookupTransform( + expression: string, + plistParameter: string, + keyParameter: string, +): ExactLookupTransform | undefined { + const lookup = `${escapeRegularExpression(plistParameter)}\\s*\\[\\s*${escapeRegularExpression(keyParameter)}\\s*\\]\\s*(?:as\\s*\\?\\s*String)?`; + if (new RegExp(`^${lookup}$`).test(expression)) return "direct"; + if (new RegExp(`^normalized\\s*\\(\\s*${lookup}\\s*\\)$`).test(expression)) { + return "normalized"; + } + return undefined; +} + +function isCanonicalNormalizer( + structuralSource: string, + methods: DirectStaticMethodEvidence[], +): boolean { + const candidates = methods.filter((method) => method.name === "normalized"); + if (candidates.length !== 1) return false; + const normalizer = candidates[0]; + if (!normalizer) return false; + const parameters = topLevelCommaSeparated(normalizer.parameters); + if (parameters.length !== 1) return false; + const parameter = /^_\s+([A-Za-z_][A-Za-z0-9_]*)\s*:\s*String\s*\?$/.exec(parameters[0] ?? ""); + const parameterName = parameter?.[1]; + if (!parameterName || !/^\s*->\s*String\s*\?\s*$/.test(normalizer.header)) return false; + + const body = structuralSource.slice(normalizer.openingBrace + 1, normalizer.closingBrace); + const escapedParameter = escapeRegularExpression(parameterName); + const canonicalBody = new RegExp( + `^\\s*guard\\s+let\\s+([A-Za-z_][A-Za-z0-9_]*)\\s*=\\s*${escapedParameter}\\s*\\?\\s*\\.\\s*trimmingCharacters\\s*\\(\\s*in\\s*:\\s*\\.\\s*whitespacesAndNewlines\\s*\\)\\s*,\\s*!\\s*\\1\\s*\\.\\s*isEmpty\\s+else\\s*\\{\\s*return\\s+nil\\s*;?\\s*\\}\\s*return\\s+\\1\\s*;?\\s*$`, + ); + return canonicalBody.test(body); +} + +function hasResolverParameterMutation( + structuralSource: string, + method: DirectStaticMethodEvidence, + parameter: string, +): boolean { + return hasParameterMutationOrShadowing(structuralSource, method, parameter); +} + +function isExactEnvironmentOverrideReturn( + structuralSource: string, + method: DirectStaticMethodEvidence, + returned: ReturnStatementEvidence, + processInfoParameter: string, + keyParameter: string, + allowNormalized: boolean, +): boolean { + const returnedName = /^([A-Za-z_][A-Za-z0-9_]*)$/.exec(returned.structuralExpression)?.[1]; + if (!returnedName || returned.depth !== 2) return false; + + const bodyStart = method.openingBrace + 1; + const body = structuralSource.slice(bodyStart, method.closingBrace); + const environmentLookup = `${escapeRegularExpression(processInfoParameter)}\\s*\\.\\s*environment\\s*\\[\\s*${escapeRegularExpression(keyParameter)}\\s*\\]`; + const trustedLookup = allowNormalized + ? `(?:${environmentLookup}|normalized\\s*\\(\\s*${environmentLookup}\\s*\\))` + : environmentLookup; + const pattern = new RegExp( + `\\bif\\s+let\\s+${escapeRegularExpression(returnedName)}\\s*=\\s*${trustedLookup}\\s*\\{`, + "g", + ); + let conditional: RegExpExecArray | null; + + while ((conditional = pattern.exec(body)) !== null) { + const openingBrace = bodyStart + conditional.index + conditional[0].lastIndexOf("{"); + if (braceDepthAt(structuralSource, method.openingBrace, openingBrace) !== 1) continue; + const closingBrace = matchingBrace(structuralSource, openingBrace); + if ( + closingBrace == null || + returned.index <= openingBrace || + returned.index >= closingBrace || + braceDepthAt(structuralSource, openingBrace, returned.index) !== 1 + ) { + continue; + } + const afterConditional = structuralSource.slice(closingBrace + 1, method.closingBrace); + if (/^\s*else\b/.test(afterConditional)) return false; + return true; + } + + return false; +} + +function isExactGuardNilReturn( + structuralSource: string, + method: DirectStaticMethodEvidence, + returned: ReturnStatementEvidence, +): boolean { + if (returned.structuralExpression !== "nil" || returned.depth !== 2) return false; + + const bodyStart = method.openingBrace + 1; + const body = structuralSource.slice(bodyStart, method.closingBrace); + const guardPattern = /\bguard\b[^{};]*\belse\s*\{/g; + let guarded: RegExpExecArray | null; + while ((guarded = guardPattern.exec(body)) !== null) { + if (braceDepthAt(structuralSource, method.openingBrace, bodyStart + guarded.index) !== 1) { + continue; + } + const openingBrace = bodyStart + guarded.index + guarded[0].lastIndexOf("{"); + const closingBrace = matchingBrace(structuralSource, openingBrace); + if ( + closingBrace == null || + returned.index <= openingBrace || + returned.index >= closingBrace || + braceDepthAt(structuralSource, openingBrace, returned.index) !== 1 + ) { + continue; + } + return /^\s*return\s+nil\s*;?\s*$/.test(structuralSource.slice(openingBrace + 1, closingBrace)); + } + + return false; +} + +function hasExactDelegatedResolverReturnFlow( + structuralSource: string, + valueSource: string, + resolver: DirectStaticMethodEvidence, + reachableMethods: DirectStaticMethodEvidence[], + resolverParameters: NamedParameterEvidence[], + plistParameter: NamedParameterEvidence, + keyParameter: NamedParameterEvidence, +): boolean { + if ( + hasResolverParameterMutation(structuralSource, resolver, plistParameter.localName) || + hasResolverParameterMutation(structuralSource, resolver, keyParameter.localName) + ) { + return false; + } + + const statements = returnStatements(structuralSource, valueSource, resolver); + const directReturns = statements.filter((returned) => returned.depth === 1); + const directTransform = directReturns[0] + ? exactResolverLookupTransform( + directReturns[0].structuralExpression, + plistParameter.localName, + keyParameter.localName, + ) + : undefined; + if ( + directReturns.length !== 1 || + !directTransform || + (directTransform === "normalized" && !isCanonicalNormalizer(structuralSource, reachableMethods)) + ) { + return false; + } + + const nestedReturns = statements.filter((returned) => returned.depth !== 1); + if (nestedReturns.length === 0) return true; + const processInfoParameter = resolverParameters.find( + (parameter) => parameter.externalName === "processInfo", + ); + if ( + processInfoParameter && + hasResolverParameterMutation(structuralSource, resolver, processInfoParameter.localName) + ) { + return false; + } + let environmentOverrideCount = 0; + for (const returned of nestedReturns) { + if (isExactGuardNilReturn(structuralSource, resolver, returned)) continue; + if ( + processInfoParameter && + isExactEnvironmentOverrideReturn( + structuralSource, + resolver, + returned, + processInfoParameter.localName, + keyParameter.localName, + directTransform === "normalized", + ) + ) { + environmentOverrideCount++; + continue; + } + return false; + } + return environmentOverrideCount <= 1; +} + +function exactDelegatedResolverFlow( + structuralSource: string, + valueSource: string, + typeSymbol: string, + loadMethod: DirectStaticMethodEvidence, + reachableMethods: DirectStaticMethodEvidence[], + resourceEvidence: ExactMainBundleResourceEvidence, + expression: RedactedExpressionEvidence, +): boolean { + const loadParameters = topLevelCommaSeparated(loadMethod.parameters); + if ( + loadParameters.length !== 2 || + !loadParameters.some((parameter) => + /^bundle\s*:\s*Bundle\s*=\s*(?:Bundle\s*)?\.\s*main$/.test(parameter), + ) || + !loadParameters.some((parameter) => + /^processInfo\s*:\s*ProcessInfo\s*=\s*(?:ProcessInfo\s*)?\.\s*processInfo$/.test(parameter), + ) || + hasParameterMutationOrShadowing(structuralSource, loadMethod, "bundle") || + hasParameterMutationOrShadowing(structuralSource, loadMethod, "processInfo") + ) { + return false; + } + + const escapedType = escapeRegularExpression(typeSymbol); + const resolverCall = new RegExp( + `^\\s*(?:(?:Self|${escapedType})\\s*\\.\\s*)?([A-Za-z_][A-Za-z0-9_]*)\\s*\\(`, + ).exec(expression.structural); + const resolverName = resolverCall?.[1]; + if (!resolverCall || !resolverName) return false; + const openingParenthesis = expression.structural.indexOf("(", resolverCall.index); + const closingParenthesis = matchingParenthesis(expression.structural, openingParenthesis); + if ( + closingParenthesis == null || + expression.structural.slice(closingParenthesis + 1).trim() !== "" + ) { + return false; + } + const valueArguments = expression.value.slice(openingParenthesis + 1, closingParenthesis); + const argumentSegments = topLevelCommaSeparated(valueArguments); + if ( + argumentSegments.length !== 3 || + !argumentSegments.some((argument) => /^for\s*:\s*"CLERK_PUBLISHABLE_KEY"\s*$/.test(argument)) + ) { + return false; + } + const plistArgument = argumentSegments + .map((argument) => /^plistValues\s*:\s*([A-Za-z_][A-Za-z0-9_]*)\s*$/.exec(argument)?.[1]) + .find((value): value is string => value != null); + const processInfoArgument = argumentSegments + .map((argument) => /^processInfo\s*:\s*([A-Za-z_][A-Za-z0-9_]*)\s*$/.exec(argument)?.[1]) + .find((value): value is string => value != null); + if (!plistArgument || processInfoArgument !== "processInfo") return false; + + const resolverCalls = directCallArguments(structuralSource, loadMethod, typeSymbol, resolverName); + if (resolverCalls.length !== 1) return false; + + const resolverCandidates = reachableMethods.filter((method) => method.name === resolverName); + if (resolverCandidates.length !== 1) return false; + const resolver = resolverCandidates[0]; + if (!resolver) return false; + const resolverParameters = namedParameters(resolver.parameters); + const keyParameter = resolverParameters.find((parameter) => parameter.externalName === "for"); + const processInfoParameter = resolverParameters.find( + (parameter) => parameter.externalName === "processInfo", + ); + const plistParameter = resolverParameters.find( + (parameter) => parameter.externalName === "plistValues", + ); + const resolverParameterSegments = topLevelCommaSeparated(resolver.parameters); + if ( + resolverParameterSegments.length !== 3 || + !resolverParameterSegments.some((parameter) => + /^for\s+[A-Za-z_][A-Za-z0-9_]*\s*:\s*String$/.test(parameter), + ) || + !resolverParameterSegments.some((parameter) => + /^processInfo\s*:\s*ProcessInfo$/.test(parameter), + ) || + !resolverParameterSegments.some((parameter) => + /^plistValues\s*:\s*\[\s*String\s*:\s*Any\s*\]$/.test(parameter), + ) || + !keyParameter || + !processInfoParameter || + !plistParameter + ) { + return false; + } + if ( + !hasExactDelegatedResolverReturnFlow( + structuralSource, + valueSource, + resolver, + reachableMethods, + resolverParameters, + plistParameter, + keyParameter, + ) + ) { + return false; + } + + const loadBodyStart = loadMethod.openingBrace + 1; + const structuralLoadBody = structuralSource.slice(loadBodyStart, loadMethod.closingBrace); + const assignmentPattern = new RegExp( + `\\blet\\s+${escapeRegularExpression(plistArgument)}\\s*=\\s*(?:(?:Self|${escapedType})\\s*\\.\\s*)?([A-Za-z_][A-Za-z0-9_]*)\\s*\\(`, + "g", + ); + const resourceAssignments: Array<{ + method: DirectStaticMethodEvidence; + arguments: string; + }> = []; + let assignment: RegExpExecArray | null; + while ((assignment = assignmentPattern.exec(structuralLoadBody)) !== null) { + const assignmentIndex = loadBodyStart + assignment.index; + if (braceDepthAt(structuralSource, loadMethod.openingBrace, assignmentIndex) !== 1) continue; + const resourceName = assignment[1]; + if (!resourceName) continue; + const localOpeningParenthesis = assignment.index + assignment[0].lastIndexOf("("); + const resourceOpeningParenthesis = loadBodyStart + localOpeningParenthesis; + const resourceClosingParenthesis = matchingParenthesis( + structuralSource, + resourceOpeningParenthesis, + ); + if ( + resourceClosingParenthesis == null || + resourceClosingParenthesis >= loadMethod.closingBrace + ) { + continue; + } + const candidates = reachableMethods.filter((method) => method.name === resourceName); + if (candidates.length === 1 && candidates[0]) { + resourceAssignments.push({ + method: candidates[0], + arguments: structuralSource.slice( + resourceOpeningParenthesis + 1, + resourceClosingParenthesis, + ), + }); + } + } + if ( + resourceAssignments.length !== 1 || + !hasUniqueImmutableInitializedLocal(structuralSource, loadMethod, plistArgument) + ) { + return false; + } + const resourceAssignment = resourceAssignments[0]; + if (!resourceAssignment || !/^\s*bundle\s*:\s*bundle\s*$/.test(resourceAssignment.arguments)) { + return false; + } + const resourceMethod = resourceAssignment.method; + const resourceParameters = topLevelCommaSeparated(resourceMethod.parameters); + if ( + resourceParameters.length !== 1 || + !/^bundle\s*:\s*Bundle$/.test(resourceParameters[0] ?? "") || + !/^\s*->\s*\[\s*String\s*:\s*Any\s*\]\s*$/.test(resourceMethod.header) || + hasParameterMutationOrShadowing(structuralSource, resourceMethod, "bundle") + ) { + return false; + } + const resourceCalls = directCallArguments( + structuralSource, + loadMethod, + typeSymbol, + resourceMethod.name, + ); + if (resourceCalls.length !== 1) return false; + + const decodedDictionaries = correlatedDecodedDictionaryNames( + structuralSource, + valueSource, + resourceMethod, + resourceEvidence.urlVariablesByMethod.get(resourceMethod.openingBrace) ?? new Set(), + ); + return ( + directlyReturnedDictionaryName(structuralSource, resourceMethod, decodedDictionaries) != null + ); +} + +function loadReturnsExactPublishableKey( + structuralSource: string, + valueSource: string, + typeSymbol: string, + loadMethod: DirectStaticMethodEvidence, + reachableMethods: DirectStaticMethodEvidence[], + resourceEvidence: ExactMainBundleResourceEvidence, +): boolean { + const expression = returnedPublishableKeyExpression( + structuralSource, + valueSource, + typeSymbol, + loadMethod, + ); + if (!expression) return false; + const directLookupBase = directExactKeyLookupBase(expression.value); + if (directLookupBase) { + const decodedDictionaries = correlatedDecodedDictionaryNames( + structuralSource, + valueSource, + loadMethod, + resourceEvidence.urlVariablesByMethod.get(loadMethod.openingBrace) ?? new Set(), + ); + return decodedDictionaries.has(directLookupBase); + } + return exactDelegatedResolverFlow( + structuralSource, + valueSource, + typeSymbol, + loadMethod, + reachableMethods, + resourceEvidence, + expression, + ); +} + +function provenLocalSecretsRuntimeSymbols(structuralSource: string, valueSource: string): string[] { + const symbols = new Set(); + const declarationPattern = + /\b(?:struct|class|enum|actor)\s+((?:[A-Za-z_][A-Za-z0-9_]*)?LocalSecrets)\b/g; + let declaration: RegExpExecArray | null; + + while ((declaration = declarationPattern.exec(structuralSource)) !== null) { + const symbol = declaration[1]; + if ( + !symbol || + braceDepthAt(structuralSource, 0, declaration.index) !== 0 || + isInsideConditionalCompilation(structuralSource, declaration.index) + ) { + continue; + } + const openingBrace = structuralSource.indexOf("{", declaration.index + declaration[0].length); + if (openingBrace === -1) continue; + const headerRemainder = structuralSource.slice( + declaration.index + declaration[0].length, + openingBrace, + ); + if (/[;}]/.test(headerRemainder) || /\b(?:struct|class|enum|actor)\b/.test(headerRemainder)) { + continue; + } + const closingBrace = matchingBrace(structuralSource, openingBrace); + if (closingBrace == null) continue; + + const structuralBody = structuralSource.slice(openingBrace + 1, closingBrace); + // Any conditional member makes it ambiguous whether the loader and its + // resource/key path ship in the selected configuration. + if (/^[\t ]*#(?:if|elseif|else|endif)\b/m.test(structuralBody)) continue; + + const methods = directStaticMethods(structuralSource, openingBrace, closingBrace); + const loadEvidence = directZeroArgumentLoadEvidence(methods); + if (!loadEvidence) continue; + const reachableMethods = reachableStaticMethods( + structuralSource, + symbol, + methods, + loadEvidence, + ); + if (!reachableMethods) continue; + + const resourceEvidence = exactMainBundleResourceEvidence( + structuralSource, + valueSource, + symbol, + reachableMethods, + loadEvidence, + ); + if ( + resourceEvidence.urlVariablesByMethod.size > 0 && + loadReturnsExactPublishableKey( + structuralSource, + valueSource, + symbol, + loadEvidence, + reachableMethods, + resourceEvidence, + ) + ) { + symbols.add(symbol); + } + } + + return [...symbols].sort(); +} + +function matchingBrace(source: string, openingBrace: number): number | undefined { + let depth = 0; + for (let index = openingBrace; index < source.length; index++) { + if (source[index] === "{") depth++; + if (source[index] !== "}") continue; + depth--; + if (depth === 0) return index; + } + return undefined; +} + +function matchingParenthesis(source: string, openingParenthesis: number): number | undefined { + let depth = 0; + for (let index = openingParenthesis; index < source.length; index++) { + if (source[index] === "(") depth++; + if (source[index] !== ")") continue; + depth--; + if (depth === 0) return index; + } + return undefined; +} + +interface SourceBodyRange { + openingBrace: number; + closingBrace: number; +} + +const TYPE_DECLARATION_MODIFIERS = new Set([ + "final", + "fileprivate", + "indirect", + "internal", + "nonisolated", + "open", + "package", + "private", + "public", +]); + +function skipWhitespace(source: string, start: number): number { + let cursor = start; + while (/\s/.test(source[cursor] ?? "")) cursor++; + return cursor; +} + +function mainTypeBodies(source: string): SourceBodyRange[] { + const bodies: SourceBodyRange[] = []; + const mainPattern = /@main\b/g; + let mainMatch: RegExpExecArray | null; + + while ((mainMatch = mainPattern.exec(source)) !== null) { + let cursor = mainMatch.index + mainMatch[0].length; + + // Other declaration attributes and access modifiers may appear between + // @main and the type declaration. Anything else makes the proof fail + // closed rather than guessing which declaration owns the attribute. + while (true) { + cursor = skipWhitespace(source, cursor); + const attribute = /^@[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*/.exec( + source.slice(cursor), + ); + if (attribute) { + cursor += attribute[0].length; + const attributeArguments = skipWhitespace(source, cursor); + if (source[attributeArguments] === "(") { + const closingParenthesis = matchingParenthesis(source, attributeArguments); + if (closingParenthesis == null) break; + cursor = closingParenthesis + 1; + } + continue; + } + + const modifier = /^[A-Za-z_][A-Za-z0-9_]*/.exec(source.slice(cursor))?.[0]; + if (modifier && TYPE_DECLARATION_MODIFIERS.has(modifier)) { + cursor += modifier.length; + if (modifier === "nonisolated") { + const modifierArguments = skipWhitespace(source, cursor); + if (source[modifierArguments] === "(") { + const closingParenthesis = matchingParenthesis(source, modifierArguments); + if (closingParenthesis == null) break; + cursor = closingParenthesis + 1; + } + } + continue; + } + break; + } + + cursor = skipWhitespace(source, cursor); + const declaration = /^(?:struct|class|enum|actor)\s+[A-Za-z_][A-Za-z0-9_]*/.exec( + source.slice(cursor), + ); + if (!declaration) continue; + + const headerEnd = cursor + declaration[0].length; + const openingBrace = source.indexOf("{", headerEnd); + if (openingBrace === -1) continue; + const headerRemainder = source.slice(headerEnd, openingBrace); + if (/[;}]/.test(headerRemainder) || /@main\b/.test(headerRemainder)) continue; + const closingBrace = matchingBrace(source, openingBrace); + if (closingBrace == null) continue; + bodies.push({ openingBrace, closingBrace }); + mainPattern.lastIndex = closingBrace + 1; + } + + return bodies; +} + +function braceDepthAt(source: string, openingBrace: number, position: number): number { + let depth = 0; + for (let index = openingBrace; index < position; index++) { + if (source[index] === "{") depth++; + if (source[index] === "}") depth--; + } + return depth; +} + +function isInsideConditionalCompilation(source: string, position: number): boolean { + const directive = /^[\t ]*#(if|elseif|else|endif)\b/gm; + let depth = 0; + let match: RegExpExecArray | null; + while ((match = directive.exec(source)) !== null && match.index < position) { + if (match[1] === "if") depth++; + if (match[1] === "endif") depth = Math.max(0, depth - 1); + } + return depth > 0; +} + +function mainInitializerBodies(source: string): SourceBodyRange[] { + const mainTypes = mainTypeBodies(source); + // Multiple @main declarations in one file are ambiguous even though the + // file-level entry-point evidence has only one path. + if (mainTypes.length !== 1) return []; + + const typeBody = mainTypes[0]; + if (!typeBody) return []; + const initializers: SourceBodyRange[] = []; + const initializerPattern = /\binit\s*([?!])?\s*\(/g; + initializerPattern.lastIndex = typeBody.openingBrace + 1; + let match: RegExpExecArray | null; + + while ( + (match = initializerPattern.exec(source)) !== null && + match.index < typeBody.closingBrace + ) { + if ( + match[1] != null || + braceDepthAt(source, typeBody.openingBrace, match.index) !== 1 || + isInsideConditionalCompilation(source, match.index) + ) { + continue; + } + + const openingParenthesis = source.indexOf("(", match.index); + const closingParenthesis = matchingParenthesis(source, openingParenthesis); + if (closingParenthesis == null || closingParenthesis >= typeBody.closingBrace) continue; + if (source.slice(openingParenthesis + 1, closingParenthesis).trim() !== "") continue; + + const openingBrace = skipWhitespace(source, closingParenthesis + 1); + if (source[openingBrace] !== "{") continue; + const closingBrace = matchingBrace(source, openingBrace); + if (closingBrace == null || closingBrace > typeBody.closingBrace) continue; + initializers.push({ openingBrace, closingBrace }); + initializerPattern.lastIndex = closingBrace + 1; + } + + return initializers; +} + +function isDirectStatementInMainInitializer( + source: string, + callIndex: number, + initializerBodies: SourceBodyRange[], +): boolean { + const initializer = initializerBodies.find( + (body) => callIndex > body.openingBrace && callIndex < body.closingBrace, + ); + if (!initializer) return false; + if (braceDepthAt(source, initializer.openingBrace, callIndex) !== 1) return false; + if (isInsideConditionalCompilation(source, callIndex)) return false; + + let cursor = callIndex - 1; + while (source[cursor] === " " || source[cursor] === "\t") cursor--; + return ( + cursor === initializer.openingBrace || + source[cursor] === "\n" || + source[cursor] === "\r" || + source[cursor] === ";" || + source[cursor] === "}" + ); +} + +function publishableKeyWiring( + sanitizedCallBody: string, + originalCallBody: string, +): { + wiring: IOSPublishableKeyWiring; + inlinePublishableKey?: IOSInlinePublishableKeyInspection; + localSecretsSymbol?: string; + localSecretsUsesCanonicalLoad?: boolean; +} { + const label = /\bpublishableKey\s*:/.exec(sanitizedCallBody); + if (!label) return { wiring: "unknown" }; + const expressionStart = label.index + label[0].length; + let expressionEnd = sanitizedCallBody.length; + let parenthesisDepth = 0; + let bracketDepth = 0; + let braceDepth = 0; + for (let index = expressionStart; index < sanitizedCallBody.length; index++) { + const character = sanitizedCallBody[index]; + if (character === "(") parenthesisDepth++; + if (character === ")") parenthesisDepth--; + if (character === "[") bracketDepth++; + if (character === "]") bracketDepth--; + if (character === "{") braceDepth++; + if (character === "}") braceDepth--; + if (character === "," && parenthesisDepth === 0 && bracketDepth === 0 && braceDepth === 0) { + expressionEnd = index; + break; + } + } + const expression = sanitizedCallBody.slice(expressionStart, expressionEnd); + const originalExpression = originalCallBody.slice(expressionStart, expressionEnd); + + // A direct ordinary string literal is the documented native iOS setup. Only + // retain decoded, non-secret metadata; the literal itself must never enter + // inspection, JSON, diagnostics, or telemetry. + const inlineLiteral = /^\s*"([^"\\]*)"\s*$/.exec(originalExpression); + if (inlineLiteral?.[1] != null && expression.trim() === "") { + try { + const decoded = decodePublishableKey(inlineLiteral[1]); + return { + wiring: "inline-literal", + inlinePublishableKey: { + state: "valid", + frontendApiHost: decoded.fapiHost, + instanceType: decoded.instanceType, + }, + }; + } catch { + return { + wiring: "inline-literal", + inlinePublishableKey: { state: "invalid" }, + }; + } + } + + const localSecrets = + /\b((?:[A-Za-z_][A-Za-z0-9_]*)?LocalSecrets)\b\s*\.\s*(load\s*\(|(?:key|publishableKey)\b)/.exec( + expression, + ); + if (localSecrets?.[1]) { + const canonicalLoad = + /^\s*((?:[A-Za-z_][A-Za-z0-9_]*)?LocalSecrets)\s*\.\s*load\s*\(\s*\)\s*\.\s*publishableKey\b([\s\S]*)$/.exec( + expression, + ); + const remainder = canonicalLoad?.[2] ?? ""; + const originalRemainder = originalExpression.slice(expression.length - remainder.length); + const canonicalRemainder = + remainder.trim() === "" || /^\s*\?\?\s*""\s*$/.test(originalRemainder); + return { + wiring: "local-secrets-loader", + localSecretsSymbol: localSecrets[1], + localSecretsUsesCanonicalLoad: canonicalLoad?.[1] === localSecrets[1] && canonicalRemainder, + }; + } + if ( + has(expression, /\bProcessInfo\s*\.\s*processInfo\s*\.\s*environment\b/) && + has( + originalExpression, + /\bProcessInfo\s*\.\s*processInfo\s*\.\s*environment\s*\[\s*"CLERK_PUBLISHABLE_KEY"\s*\]/, + ) + ) { + return { wiring: "process-info-environment" }; + } + return { wiring: "unknown" }; +} + +interface PendingConfigureCall extends IOSConfigureCallEvidence { + localSecretsSymbol?: string; + localSecretsUsesCanonicalLoad?: boolean; +} + +function configureCallEvidence( + sanitizedSource: string, + originalSource: string, + evidence: IOSSourceEvidence, +): PendingConfigureCall[] { + const calls: PendingConfigureCall[] = []; + const initializerBodies = mainInitializerBodies(sanitizedSource); + const pattern = /\bClerk\s*\.\s*configure\s*\(/g; + let match: RegExpExecArray | null; + + while ((match = pattern.exec(sanitizedSource)) !== null) { + const openingParenthesis = sanitizedSource.indexOf("(", match.index); + const closingParenthesis = matchingParenthesis(sanitizedSource, openingParenthesis); + if (closingParenthesis == null) { + calls.push({ + ...evidence, + publishableKeyWiring: "unknown", + startupBinding: isDirectStatementInMainInitializer( + sanitizedSource, + match.index, + initializerBodies, + ) + ? "app-init" + : "unproven", + }); + break; + } + const classification = publishableKeyWiring( + sanitizedSource.slice(openingParenthesis + 1, closingParenthesis), + originalSource.slice(openingParenthesis + 1, closingParenthesis), + ); + calls.push({ + ...evidence, + publishableKeyWiring: classification.wiring, + inlinePublishableKey: classification.inlinePublishableKey, + startupBinding: isDirectStatementInMainInitializer( + sanitizedSource, + match.index, + initializerBodies, + ) + ? "app-init" + : "unproven", + localSecretsSymbol: classification.localSecretsSymbol, + localSecretsUsesCanonicalLoad: classification.localSecretsUsesCanonicalLoad, + }); + pattern.lastIndex = closingParenthesis + 1; + } + + return calls; +} + +function withoutPreviewOnlyRegions(source: string): string { + const chars = source.split(""); + const patterns = [/#Preview\b/g, /\bstruct\s+\w+[^{}]*:\s*[^{}]*\bPreviewProvider\b/g]; + for (const pattern of patterns) { + for (const match of source.matchAll(pattern)) { + const openingBrace = source.indexOf("{", match.index + match[0].length); + if (openingBrace === -1) continue; + const closingBrace = matchingBrace(source, openingBrace); + if (closingBrace == null) continue; + blankRange(chars, match.index, closingBrace + 1); + } + } + return chars.join(""); +} + +function hasClerkOpenURLHandler(source: string): boolean { + const pattern = /\.\s*onOpenURL\b/g; + let match: RegExpExecArray | null; + + while ((match = pattern.exec(source)) !== null) { + let cursor = match.index + match[0].length; + while (/\s/.test(source[cursor] ?? "")) cursor++; + + let openingBrace: number | undefined; + if (source[cursor] === "{") { + openingBrace = cursor; + } else if (source[cursor] === "(") { + const closingParenthesis = source.indexOf(")", cursor + 1); + const candidateBrace = source.indexOf("{", cursor + 1); + if ( + candidateBrace !== -1 && + (closingParenthesis === -1 || candidateBrace < closingParenthesis) + ) { + openingBrace = candidateBrace; + } + } + + if (openingBrace == null) continue; + const closingBrace = matchingBrace(source, openingBrace); + if (closingBrace == null) continue; + if (has(source.slice(openingBrace + 1, closingBrace), CLERK_URL_HANDLER)) return true; + pattern.lastIndex = closingBrace + 1; + } + + return false; +} + +export async function inspectSwiftSources( + sourceFiles: Array<{ absolutePath: string; relativePath: string }>, + options: { membershipComplete?: boolean } = {}, +): Promise { + const entryPoints: IOSSourceEvidence[] = []; + const importsClerkKit: IOSSourceEvidence[] = []; + const importsClerkKitUI: IOSSourceEvidence[] = []; + const pendingConfigureCalls: PendingConfigureCall[] = []; + const localSecretsRuntimeBindings: IOSSourceEvidence[] = []; + const localSecretsRuntimeSymbols = new Set(); + const environmentInjections: IOSSourceEvidence[] = []; + const environmentConsumers: IOSSourceEvidence[] = []; + const authFlowReferences: IOSSourceEvidence[] = []; + const openURLHandlers: IOSSourceEvidence[] = []; + let sourceFilesScanned = 0; + let evidenceComplete = options.membershipComplete ?? true; + + for (const file of sourceFiles.sort((a, b) => a.relativePath.localeCompare(b.relativePath))) { + const diskFile = Bun.file(file.absolutePath); + if (!(await diskFile.exists()) || diskFile.size > MAX_SWIFT_FILE_BYTES) { + evidenceComplete = false; + continue; + } + + let source: string; + try { + source = await readFile(file.absolutePath, "utf8"); + } catch { + evidenceComplete = false; + continue; + } + + sourceFilesScanned++; + const sanitized = withoutPreviewOnlyRegions(sanitizeSwiftSource(source)); + const uncommented = withoutPreviewOnlyRegions(sourceWithoutComments(source)); + const evidence = { path: file.relativePath }; + const importsKit = has( + sanitized, + /\bimport\s+(?:(?:typealias|struct|class|enum|protocol|actor|let|var|func|macro)\s+)?ClerkKit\b/, + ); + const importsUI = has( + sanitized, + /\bimport\s+(?:(?:typealias|struct|class|enum|protocol|actor|let|var|func|macro)\s+)?ClerkKitUI\b/, + ); + const importsClerkModule = importsKit || importsUI; + + if (has(sanitized, /@main\b/)) entryPoints.push(evidence); + if (importsKit) importsClerkKit.push(evidence); + if (importsUI) importsClerkKitUI.push(evidence); + const runtimeSymbols = provenLocalSecretsRuntimeSymbols(sanitized, uncommented); + for (const symbol of runtimeSymbols) { + localSecretsRuntimeSymbols.add(symbol); + localSecretsRuntimeBindings.push(evidence); + } + if (importsClerkModule) { + pendingConfigureCalls.push(...configureCallEvidence(sanitized, source, evidence)); + } + if ( + importsClerkModule && + has(sanitized, /\.\s*environment\s*\(\s*(?:\\?\.\s*self\s*,\s*)?Clerk\s*\.\s*shared\s*\)/) + ) { + environmentInjections.push(evidence); + } + if (importsClerkModule && has(sanitized, /@Environment\s*\(\s*Clerk\s*\.\s*self\s*\)/)) { + environmentConsumers.push(evidence); + } + if ( + (importsUI && has(sanitized, /\bAuthView\s*\(/)) || + (importsClerkModule && has(sanitized, CLERK_NATIVE_AUTH_FLOW)) + ) { + authFlowReferences.push(evidence); + } + if (importsClerkModule && hasClerkOpenURLHandler(sanitized)) { + openURLHandlers.push(evidence); + } + } + + const anyClerkEvidence = + importsClerkKit.length + + importsClerkKitUI.length + + pendingConfigureCalls.length + + localSecretsRuntimeBindings.length + + environmentInjections.length + + environmentConsumers.length + + authFlowReferences.length > + 0; + const status = + entryPoints.length > 1 + ? "ambiguous" + : pendingConfigureCalls.length > 0 && environmentInjections.length > 0 + ? "complete" + : anyClerkEvidence + ? "partial" + : "absent"; + + const configureCalls: IOSConfigureCallEvidence[] = pendingConfigureCalls.map( + ({ localSecretsSymbol, localSecretsUsesCanonicalLoad, ...call }) => ({ + ...call, + ...(call.publishableKeyWiring === "local-secrets-loader" && { + localSecretsRuntimeBinding: + localSecretsUsesCanonicalLoad && + localSecretsSymbol && + localSecretsRuntimeSymbols.has(localSecretsSymbol) + ? ("proven" as const) + : ("unproven" as const), + }), + }), + ); + + return { + sourceFilesScanned, + evidenceComplete, + entryPoints, + importsClerkKit, + importsClerkKitUI, + configureCalls, + localSecretsRuntimeBindings, + environmentInjections, + environmentConsumers, + authFlowReferences, + openURLHandlers, + status, + }; +} diff --git a/packages/cli-core/src/commands/init/ios/test-helpers.ts b/packages/cli-core/src/commands/init/ios/test-helpers.ts new file mode 100644 index 00000000..322c03ea --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/test-helpers.ts @@ -0,0 +1,342 @@ +import { lstat, mkdir, readdir, readFile, readlink, rm, writeFile } from "node:fs/promises"; +import { join, relative } from "node:path"; +import { build as buildPbxProject, parse as parsePbxProject } from "@bacons/xcode/json"; +import type { PbxObjects } from "./pbx.ts"; + +const IDS = { + project: "AAAAAAAAAAAAAAAAAAAAAAAA", + mainGroup: "BBBBBBBBBBBBBBBBBBBBBBBB", + appGroup: "CCCCCCCCCCCCCCCCCCCCCCCC", + appFile: "DDDDDDDDDDDDDDDDDDDDDDDD", + entitlementsFile: "EEEEEEEEEEEEEEEEEEEEEEEE", + appTarget: "111111111111111111111111", + appProduct: "121212121212121212121212", + projectConfigList: "131313131313131313131313", + projectDebug: "141414141414141414141414", + projectRelease: "151515151515151515151515", + targetConfigList: "161616161616161616161616", + targetDebug: "171717171717171717171717", + targetRelease: "181818181818181818181818", + sourcesPhase: "191919191919191919191919", + sourceBuildFile: "202020202020202020202020", + frameworksPhase: "212121212121212121212121", + clerkPackage: "222222222222222222222222", + clerkKit: "232323232323232323232323", + clerkKitUI: "242424242424242424242424", + clerkKitBuildFile: "252525252525252525252525", + clerkKitUIBuildFile: "262626262626262626262626", + secondTarget: "313131313131313131313131", + secondProduct: "323232323232323232323232", + secondConfigList: "333333333333333333333333", + secondDebug: "343434343434343434343434", + secondRelease: "353535353535353535353535", + targetXCConfig: "363636363636363636363636", + localSecretsFile: "373737373737373737373737", + resourcesPhase: "383838383838383838383838", + localSecretsBuildFile: "393939393939393939393939", + secondGroup: "404040404040404040404040", + secondAppFile: "414141414141414141414141", + secondSourcesPhase: "424242424242424242424242", + secondSourceBuildFile: "434343434343434343434343", + secondFrameworksPhase: "444444444444444444444444", +} as const; + +export interface IOSFixtureOptions { + complete?: boolean; + secondTarget?: boolean | "watchos"; + conflictingBundle?: boolean; + includeKey?: boolean; + releaseEntitlements?: boolean; + workspace?: boolean; + generated?: "xcodegen" | "tuist"; + xcconfig?: boolean; + localSecrets?: boolean; + /** Include a fully linked clerk-ios package graph. Defaults to both products. */ + clerkSDK?: boolean | "core-only"; +} + +function secondTargetObjects(platform: "ios" | "watchos"): string { + const isWatchOS = platform === "watchos"; + const directoryName = isWatchOS ? "WatchApp" : "AdminApp"; + const sourceName = isWatchOS ? "WatchAppApp.swift" : "AdminAppApp.swift"; + const targetName = isWatchOS ? "MyApp Watch App" : "AdminApp"; + const platformSettings = isWatchOS + ? 'PRODUCT_BUNDLE_IDENTIFIER = com.example.WatchApp; DEVELOPMENT_TEAM = ABCDE12345; SDKROOT = watchos; SUPPORTED_PLATFORMS = "watchos watchsimulator"; WATCHOS_DEPLOYMENT_TARGET = 10.0;' + : 'PRODUCT_BUNDLE_IDENTIFIER = com.example.AdminApp; DEVELOPMENT_TEAM = ABCDE12345; IPHONEOS_DEPLOYMENT_TARGET = 17.0; SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";'; + return ` + ${IDS.secondGroup} = { isa = PBXGroup; children = ( ${IDS.secondAppFile}, ); path = ${directoryName}; sourceTree = ""; }; + ${IDS.secondAppFile} = { isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ${sourceName}; sourceTree = ""; }; + ${IDS.secondTarget} = { + isa = PBXNativeTarget; + buildConfigurationList = ${IDS.secondConfigList}; + buildPhases = ( ${IDS.secondSourcesPhase}, ${IDS.secondFrameworksPhase}, ); + buildRules = ( ); + dependencies = ( ); + name = "${targetName}"; + productName = "${targetName}"; + productReference = ${IDS.secondProduct}; + productType = "com.apple.product-type.application"; + packageProductDependencies = ( ); + }; + ${IDS.secondProduct} = { isa = PBXFileReference; explicitFileType = wrapper.application; path = ${directoryName}.app; sourceTree = BUILT_PRODUCTS_DIR; }; + ${IDS.secondSourcesPhase} = { isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( ${IDS.secondSourceBuildFile}, ); runOnlyForDeploymentPostprocessing = 0; }; + ${IDS.secondSourceBuildFile} = { isa = PBXBuildFile; fileRef = ${IDS.secondAppFile}; }; + ${IDS.secondFrameworksPhase} = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( ); runOnlyForDeploymentPostprocessing = 0; }; + ${IDS.secondConfigList} = { isa = XCConfigurationList; buildConfigurations = ( ${IDS.secondDebug}, ${IDS.secondRelease}, ); defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; + ${IDS.secondDebug} = { isa = XCBuildConfiguration; buildSettings = { ${platformSettings} }; name = Debug; }; + ${IDS.secondRelease} = { isa = XCBuildConfiguration; buildSettings = { ${platformSettings} }; name = Release; }; + `; +} + +function pbxproj(options: IOSFixtureOptions): string { + const includeClerkSDK = options.clerkSDK !== false; + const includeClerkKitUI = includeClerkSDK && options.clerkSDK !== "core-only"; + const releaseBundle = options.conflictingBundle + ? "com.example.MyApp.release" + : "com.example.MyApp"; + const releaseEntitlements = + options.releaseEntitlements === false + ? "" + : "CODE_SIGN_ENTITLEMENTS = MyApp/MyApp.entitlements;"; + const debugIdentitySettings = options.xcconfig + ? "" + : "DEVELOPMENT_TEAM = ABCDE12345; PRODUCT_BUNDLE_IDENTIFIER = com.example.MyApp;"; + const releaseIdentitySettings = options.xcconfig + ? "" + : `DEVELOPMENT_TEAM = ABCDE12345; PRODUCT_BUNDLE_IDENTIFIER = ${releaseBundle};`; + const baseConfigurationReference = options.xcconfig + ? `baseConfigurationReference = ${IDS.targetXCConfig};` + : ""; + const targetIds = options.secondTarget + ? `${IDS.appTarget}, ${IDS.secondTarget},` + : `${IDS.appTarget},`; + return `// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { }; + objectVersion = 56; + objects = { + ${IDS.project} = { + isa = PBXProject; + attributes = { LastUpgradeCheck = 1600; }; + buildConfigurationList = ${IDS.projectConfigList}; + compatibilityVersion = "Xcode 14.0"; + developmentRegion = en; + knownRegions = ( en, Base, ); + mainGroup = ${IDS.mainGroup}; + packageReferences = ( ${includeClerkSDK ? `${IDS.clerkPackage},` : ""} ); + projectDirPath = ""; + projectRoot = ""; + targets = ( ${targetIds} ); + }; + ${IDS.mainGroup} = { isa = PBXGroup; children = ( ${IDS.appGroup}, ${options.secondTarget ? `${IDS.secondGroup},` : ""} ${IDS.entitlementsFile}, ${options.xcconfig ? `${IDS.targetXCConfig},` : ""} ); sourceTree = ""; }; + ${IDS.appGroup} = { isa = PBXGroup; children = ( ${IDS.appFile}, ${options.localSecrets ? `${IDS.localSecretsFile},` : ""} ); path = MyApp; sourceTree = ""; }; + ${IDS.appFile} = { isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MyAppApp.swift; sourceTree = ""; }; + ${options.localSecrets ? `${IDS.localSecretsFile} = { isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = LocalSecrets.plist; sourceTree = ""; };` : ""} + ${IDS.entitlementsFile} = { isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = MyApp/MyApp.entitlements; sourceTree = ""; }; + ${options.xcconfig ? `${IDS.targetXCConfig} = { isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Config/Target.xcconfig; sourceTree = ""; };` : ""} + ${IDS.appTarget} = { + isa = PBXNativeTarget; + buildConfigurationList = ${IDS.targetConfigList}; + buildPhases = ( ${IDS.sourcesPhase}, ${IDS.frameworksPhase}, ${options.localSecrets ? `${IDS.resourcesPhase},` : ""} ); + buildRules = ( ); + dependencies = ( ); + name = MyApp; + productName = MyApp; + productReference = ${IDS.appProduct}; + productType = "com.apple.product-type.application"; + packageProductDependencies = ( ${includeClerkSDK ? `${IDS.clerkKit},` : ""} ${includeClerkKitUI ? `${IDS.clerkKitUI},` : ""} ); + }; + ${IDS.appProduct} = { isa = PBXFileReference; explicitFileType = wrapper.application; path = MyApp.app; sourceTree = BUILT_PRODUCTS_DIR; }; + ${IDS.sourcesPhase} = { isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( ${IDS.sourceBuildFile}, ); runOnlyForDeploymentPostprocessing = 0; }; + ${IDS.sourceBuildFile} = { isa = PBXBuildFile; fileRef = ${IDS.appFile}; }; + ${options.localSecrets ? `${IDS.resourcesPhase} = { isa = PBXResourcesBuildPhase; buildActionMask = 2147483647; files = ( ${IDS.localSecretsBuildFile}, ); runOnlyForDeploymentPostprocessing = 0; }; ${IDS.localSecretsBuildFile} = { isa = PBXBuildFile; fileRef = ${IDS.localSecretsFile}; };` : ""} + ${IDS.frameworksPhase} = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( ${includeClerkSDK ? `${IDS.clerkKitBuildFile},` : ""} ${includeClerkKitUI ? `${IDS.clerkKitUIBuildFile},` : ""} ); runOnlyForDeploymentPostprocessing = 0; }; + ${includeClerkSDK ? `${IDS.clerkKitBuildFile} = { isa = PBXBuildFile; productRef = ${IDS.clerkKit}; };` : ""} + ${includeClerkKitUI ? `${IDS.clerkKitUIBuildFile} = { isa = PBXBuildFile; productRef = ${IDS.clerkKitUI}; };` : ""} + ${includeClerkSDK ? `${IDS.clerkPackage} = { isa = XCRemoteSwiftPackageReference; repositoryURL = "https://github.com/clerk/clerk-ios.git"; requirement = { kind = upToNextMajorVersion; minimumVersion = 1.0.0; }; };` : ""} + ${includeClerkSDK ? `${IDS.clerkKit} = { isa = XCSwiftPackageProductDependency; package = ${IDS.clerkPackage}; productName = ClerkKit; };` : ""} + ${includeClerkKitUI ? `${IDS.clerkKitUI} = { isa = XCSwiftPackageProductDependency; package = ${IDS.clerkPackage}; productName = ClerkKitUI; };` : ""} + ${IDS.projectConfigList} = { isa = XCConfigurationList; buildConfigurations = ( ${IDS.projectDebug}, ${IDS.projectRelease}, ); defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; + ${IDS.projectDebug} = { isa = XCBuildConfiguration; buildSettings = { SDKROOT = iphoneos; }; name = Debug; }; + ${IDS.projectRelease} = { isa = XCBuildConfiguration; buildSettings = { SDKROOT = iphoneos; }; name = Release; }; + ${IDS.targetConfigList} = { isa = XCConfigurationList; buildConfigurations = ( ${IDS.targetDebug}, ${IDS.targetRelease}, ); defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; + ${IDS.targetDebug} = { isa = XCBuildConfiguration; ${baseConfigurationReference} buildSettings = { CODE_SIGN_ENTITLEMENTS = MyApp/MyApp.entitlements; ${debugIdentitySettings} IPHONEOS_DEPLOYMENT_TARGET = 17.0; SUPPORTED_PLATFORMS = "iphoneos iphonesimulator"; }; name = Debug; }; + ${IDS.targetRelease} = { isa = XCBuildConfiguration; ${baseConfigurationReference} buildSettings = { ${releaseEntitlements} ${releaseIdentitySettings} IPHONEOS_DEPLOYMENT_TARGET = 17.0; SUPPORTED_PLATFORMS = "iphoneos iphonesimulator"; }; name = Release; }; + ${options.secondTarget ? secondTargetObjects(options.secondTarget === "watchos" ? "watchos" : "ios") : ""} + }; + rootObject = ${IDS.project}; +} +`; +} + +function swiftSource(complete: boolean): string { + if (!complete) { + return `import SwiftUI + +@main +struct MyApp: App { + var body: some Scene { WindowGroup { Text("Hello") } } +} +`; + } + return `import ClerkKit +import ClerkKitUI +import SwiftUI + +@main +struct MyApp: App { + init() { Clerk.configure(publishableKey: QuickstartLocalSecrets.load().publishableKey ?? "") } + var body: some Scene { + WindowGroup { + AuthView() + .environment(Clerk.shared) + .onOpenURL { url in Task { try await Clerk.shared.handle(url) } } + } + } +} + +struct QuickstartLocalSecrets { + let publishableKey: String? + + static func load(bundle: Bundle = .main) -> QuickstartLocalSecrets { + let values: [String: Any] + if let url = bundle.url(forResource: "LocalSecrets", withExtension: "plist"), + let data = try? Data(contentsOf: url), + let plist = try? PropertyListSerialization.propertyList(from: data, format: nil), + let dictionary = plist as? [String: Any] { + values = dictionary + } else { + values = [:] + } + return .init(publishableKey: values["CLERK_PUBLISHABLE_KEY"] as? String) + } +} +`; +} + +function secondSwiftSource(platform: "ios" | "watchos"): string { + const appName = platform === "watchos" ? "WatchAppApp" : "AdminAppApp"; + return `import SwiftUI + +@main +struct ${appName}: App { + var body: some Scene { WindowGroup { Text("Hello") } } +} +`; +} + +const ENTITLEMENTS = ` + + +application-identifierLEGACY1234.com.example.MyApp +com.apple.developer.team-identifierABCDE12345 +com.apple.developer.associated-domainswebcredentials:clerk.example.test + +`; + +export async function createIOSFixture( + root: string, + options: IOSFixtureOptions = {}, +): Promise { + const project = join(root, "MyApp.xcodeproj"); + await mkdir(join(project), { recursive: true }); + await mkdir(join(root, "MyApp"), { recursive: true }); + await Bun.write(join(project, "project.pbxproj"), pbxproj(options)); + await Bun.write(join(root, "MyApp", "MyAppApp.swift"), swiftSource(options.complete === true)); + await Bun.write(join(root, "MyApp", "MyApp.entitlements"), ENTITLEMENTS); + if (options.secondTarget) { + const platform = options.secondTarget === "watchos" ? "watchos" : "ios"; + const directoryName = platform === "watchos" ? "WatchApp" : "AdminApp"; + const sourceName = platform === "watchos" ? "WatchAppApp.swift" : "AdminAppApp.swift"; + await mkdir(join(root, directoryName), { recursive: true }); + await Bun.write(join(root, directoryName, sourceName), secondSwiftSource(platform)); + } + if (options.localSecrets) { + const encodedHost = Buffer.from("native.clerk.example$").toString("base64"); + await Bun.write( + join(root, "MyApp", "LocalSecrets.plist"), + `CLERK_PUBLISHABLE_KEYpk_live_${encodedHost}`, + ); + } + + if (options.xcconfig) { + await mkdir(join(root, "Config"), { recursive: true }); + await Bun.write( + join(root, "Config", "Base.xcconfig"), + "BUNDLE_BASE = com.example\nDEVELOPMENT_TEAM = ABCDE12345\n", + ); + await Bun.write( + join(root, "Config", "Target.xcconfig"), + '#include "Base.xcconfig"\nPRODUCT_BUNDLE_IDENTIFIER = $(BUNDLE_BASE).MyApp\n', + ); + } + + if (options.includeKey !== false) { + const encodedHost = Buffer.from("clerk.example.test$").toString("base64"); + await Bun.write(join(root, ".env"), `CLERK_PUBLISHABLE_KEY=pk_test_${encodedHost}\n`); + } + if (options.workspace) { + const workspace = join(root, "MyApp.xcworkspace"); + await mkdir(workspace, { recursive: true }); + await Bun.write( + join(workspace, "contents.xcworkspacedata"), + '', + ); + } + if (options.generated === "xcodegen") await Bun.write(join(root, "project.yml"), "name: MyApp\n"); + if (options.generated === "tuist") + await Bun.write(join(root, "Project.swift"), "import ProjectDescription\n"); +} + +/** Converts the classic fixture into the modern synchronized-root shape used by new Xcode apps. */ +export async function convertIOSFixtureToSynchronizedMissingEntitlements( + root: string, +): Promise { + const synchronizedRootId = "515151515151515151515151"; + const projectPath = join(root, "MyApp.xcodeproj", "project.pbxproj"); + const project = parsePbxProject(await readFile(projectPath, "utf8")); + const objects = (project as unknown as { objects: PbxObjects }).objects; + const mainGroup = objects[IDS.mainGroup]!; + mainGroup.children = [ + ...(mainGroup.children as string[]).filter((id) => id !== IDS.entitlementsFile), + synchronizedRootId, + ]; + objects[synchronizedRootId] = { + isa: "PBXFileSystemSynchronizedRootGroup", + path: "MyApp", + sourceTree: "", + }; + objects[IDS.appTarget]!.fileSystemSynchronizedGroups = [synchronizedRootId]; + delete objects[IDS.entitlementsFile]; + for (const id of [IDS.targetDebug, IDS.targetRelease]) { + const settings = objects[id]!.buildSettings as Record; + delete settings.CODE_SIGN_ENTITLEMENTS; + settings["CODE_SIGN_ENTITLEMENTS[sdk=macosx*]"] = "MyApp/MyApp.mac.entitlements"; + } + await writeFile(projectPath, buildPbxProject(project)); + await rm(join(root, "MyApp", "MyApp.entitlements"), { force: true }); +} + +async function digestEntry(root: string, path: string): Promise { + const info = await lstat(path); + const relativePath = relative(root, path).split("\\").join("/") || "."; + if (info.isSymbolicLink()) { + return [`l:${relativePath}:${info.mode}:${await readlink(path)}`]; + } + if (info.isDirectory()) { + const entries = (await readdir(path)).sort(); + const nested = await Promise.all( + entries.map(async (entry) => digestEntry(root, join(path, entry))), + ); + return [`d:${relativePath}:${info.mode}`, ...nested.flat()]; + } + const hash = new Bun.CryptoHasher("sha256").update(await readFile(path)).digest("hex"); + return [`f:${relativePath}:${info.mode}:${hash}`]; +} + +export async function treeDigest(root: string): Promise { + return digestEntry(root, root); +} + +export { IDS as IOS_FIXTURE_IDS }; diff --git a/packages/cli-core/src/commands/init/ios/types.ts b/packages/cli-core/src/commands/init/ios/types.ts new file mode 100644 index 00000000..98017d76 --- /dev/null +++ b/packages/cli-core/src/commands/init/ios/types.ts @@ -0,0 +1,228 @@ +export type IOSDiagnosticSeverity = "info" | "warning" | "error"; + +export interface IOSSourceEvidence { + /** Project-root-relative path. */ + path: string; + objectId?: string; + keyPath?: string; +} + +export interface IOSDiagnostic { + code: + | "xcode.no-project" + | "xcode.malformed-project" + | "xcode.missing-project-file" + | "xcode.dangling-reference" + | "xcode.no-ios-app-target" + | "xcode.ambiguous-app-target" + | "xcode.target-not-found" + | "xcode.unresolved-build-setting" + | "xcode.conflicting-build-setting" + | "xcode.missing-entitlements" + | "xcode.unreadable-entitlements" + | "xcode.external-path" + | "xcode.generated-project" + | "xcode.incomplete-source-membership" + | "clerk.package-unattributed" + | "clerk.invalid-publishable-key" + | "clerk.conflicting-publishable-keys"; + severity: IOSDiagnosticSeverity; + message: string; + remedy?: string; + evidence: IOSSourceEvidence[]; +} + +export type IOSValueResolution = + | { state: "resolved"; value: string; evidence: IOSSourceEvidence[] } + | { + state: "unresolved"; + raw: string; + missingVariables: string[]; + evidence: IOSSourceEvidence[]; + } + | { state: "missing"; evidence: IOSSourceEvidence[] }; + +export interface IOSEntitlementsInspection { + path: string; + associatedDomains: string[]; + unresolvedAssociatedDomains: string[]; + applicationIdentifier?: string; + /** Literal prefix candidate from the source plist, validated against the Bundle ID. */ + literalAppIdentifierPrefix?: string; + teamIdentifier?: string; + signInWithApple: boolean; +} + +export interface IOSBuildConfiguration { + name: string; + bundleIdentifier: IOSValueResolution; + developmentTeam: IOSValueResolution; + entitlementsPath: IOSValueResolution; + deploymentTarget: IOSValueResolution; + entitlements?: IOSEntitlementsInspection; +} + +export type IOSPackageReference = + | { + kind: "remote"; + objectId: string; + repository: string; + requirement?: Record; + isClerk: boolean; + } + | { + kind: "local"; + objectId: string; + path: string; + isClerk: boolean; + }; + +export type IOSProductLinkState = "linked" | "declared" | "absent"; + +export interface IOSClerkPackageState { + package: "remote" | "local" | "unattributed" | "absent"; + clerkKit: IOSProductLinkState; + clerkKitUI: IOSProductLinkState; +} + +export type IOSPublishableKeyWiring = + | "inline-literal" + | "local-secrets-loader" + | "process-info-environment" + | "unknown"; + +export type IOSInlinePublishableKeyInspection = + | { + state: "valid"; + frontendApiHost: string; + instanceType: "development" | "production"; + } + | { state: "invalid" }; + +export interface IOSConfigureCallEvidence extends IOSSourceEvidence { + /** Redacted classification only; the key expression and value are never retained. */ + publishableKeyWiring: IOSPublishableKeyWiring; + /** Decoded metadata for a plain inline literal. The literal itself is never retained. */ + inlinePublishableKey?: IOSInlinePublishableKeyInspection; + /** Whether this call is a direct statement in the selected @main type's init(). */ + startupBinding: "app-init" | "unproven"; + /** Whether the referenced LocalSecrets symbol is the exact inspected runtime loader. */ + localSecretsRuntimeBinding?: "proven" | "unproven"; +} + +export interface IOSSwiftInspection { + sourceFilesScanned: number; + /** False when target membership was truncated or a member could not be read. */ + evidenceComplete: boolean; + entryPoints: IOSSourceEvidence[]; + importsClerkKit: IOSSourceEvidence[]; + importsClerkKitUI: IOSSourceEvidence[]; + configureCalls: IOSConfigureCallEvidence[]; + /** Exact target source that loads LocalSecrets.plist and CLERK_PUBLISHABLE_KEY. */ + localSecretsRuntimeBindings: IOSSourceEvidence[]; + environmentInjections: IOSSourceEvidence[]; + environmentConsumers: IOSSourceEvidence[]; + authFlowReferences: IOSSourceEvidence[]; + openURLHandlers: IOSSourceEvidence[]; + status: "complete" | "partial" | "absent" | "ambiguous"; +} + +export interface IOSRuntimeKeySink { + kind: "local-secrets-plist"; + /** Project-root-relative path. The publishable-key value is never exposed. */ + path: string; +} + +export interface IOSAppTarget { + id: string; + name: string; + productName?: string; + projectPath: string; + configurations: IOSBuildConfiguration[]; + packages: IOSClerkPackageState; + swift: IOSSwiftInspection; + /** Target-owned runtime destinations proven from the Xcode project graph. */ + runtimeKeySinks: IOSRuntimeKeySink[]; +} + +export interface IOSProjectInspection { + path: string; + pbxprojPath: string; + objectVersion?: string; + packages: IOSPackageReference[]; + appTargetIds: string[]; + diagnostics: IOSDiagnostic[]; +} + +export interface IOSWorkspaceInspection { + path: string; + projectPaths: string[]; +} + +export type IOSTargetSelection = + | { state: "selected"; targetId: string; targetName: string; projectPath: string } + | { + state: "ambiguous"; + candidates: Array<{ targetId: string; targetName: string; projectPath: string }>; + } + | { state: "not-found"; requested: string; candidates: string[] } + | { state: "none" }; + +export interface IOSLocalPublishableKeyInspection { + found: boolean; + source?: string; + frontendApiHost?: string; + instanceType?: "development" | "production"; + conflict: boolean; + candidateSources: string[]; + invalidSources: string[]; +} + +export interface IOSProjectInspectionResult { + schemaVersion: 1; + platform: "ios"; + /** Absolute invocation root. Paths nested below it are emitted relatively. */ + root: string; + workspaces: IOSWorkspaceInspection[]; + projects: IOSProjectInspection[]; + appTargets: IOSAppTarget[]; + selection: IOSTargetSelection; + localPublishableKey: IOSLocalPublishableKeyInspection; + generatedProject: "xcodegen" | "tuist" | null; + diagnostics: IOSDiagnostic[]; +} + +export type IOSSetupStepId = + | "select-target" + | "install-clerk-sdk" + | "configure-publishable-key" + | "inject-clerk-environment" + | "wire-auth-callbacks" + | "register-native-application" + | "enable-native-apple" + | "add-associated-domain" + | "add-authentication-flow" + | "verify-integration"; + +export type IOSSetupStepStatus = "satisfied" | "required" | "review" | "blocked"; + +export interface IOSSetupStep { + id: IOSSetupStepId; + title: string; + status: IOSSetupStepStatus; + automatable: boolean; + description: string; + links?: Array<{ kind: "dashboard" | "documentation"; url: string }>; + evidence: IOSSourceEvidence[]; +} + +export interface IOSSetupPlan { + schemaVersion: 1; + kind: "clerk-ios-setup"; + root: string; + status: "ready" | "action-required" | "blocked"; + selection: IOSTargetSelection; + summary: Record; + steps: IOSSetupStep[]; + diagnostics: IOSDiagnostic[]; +} From 376585ea28eb45647609fdec91d1a4d744f11116 Mon Sep 17 00:00:00 2001 From: seanperez Date: Fri, 21 Aug 2026 16:59:49 -0400 Subject: [PATCH 2/2] fix(init): mask XML comments without joining markup --- .../src/commands/init/ios/discovery.ts | 2 +- .../src/commands/init/ios/inspect.test.ts | 21 +++++++++++++++++++ .../cli-core/src/commands/init/ios/inspect.ts | 3 ++- 3 files changed, 24 insertions(+), 2 deletions(-) diff --git a/packages/cli-core/src/commands/init/ios/discovery.ts b/packages/cli-core/src/commands/init/ios/discovery.ts index 0b83ceb3..11cc3cc0 100644 --- a/packages/cli-core/src/commands/init/ios/discovery.ts +++ b/packages/cli-core/src/commands/init/ios/discovery.ts @@ -235,7 +235,7 @@ function resolveWorkspaceLocation( * comment outright could synthesize markup from two otherwise inert fragments * (for example, `leRef>`). */ -function maskXMLComments(source: string): string { +export function maskXMLComments(source: string): string { const chunks: string[] = []; let cursor = 0; while (cursor < source.length) { diff --git a/packages/cli-core/src/commands/init/ios/inspect.test.ts b/packages/cli-core/src/commands/init/ios/inspect.test.ts index 2f1d01c8..44b3ad83 100644 --- a/packages/cli-core/src/commands/init/ios/inspect.test.ts +++ b/packages/cli-core/src/commands/init/ios/inspect.test.ts @@ -300,6 +300,27 @@ struct MyApp: App { expect(JSON.stringify(inspection)).not.toContain(schemeKey); }); + test("does not synthesize Run scheme markup across XML comments", async () => { + const root = await fixture({ includeKey: false }); + const schemeDirectory = join(root, "MyApp.xcodeproj", "xcshareddata", "xcschemes"); + await mkdir(schemeDirectory, { recursive: true }); + const schemeKey = `pk_test_${Buffer.from("comment.clerk.example$").toString("base64")}`; + await Bun.write( + join(schemeDirectory, "MyApp.xcscheme"), + `Action>Action>`, + ); + + const inspection = await inspectIOSProject(root); + + expect(inspection.localPublishableKey).toEqual({ + found: false, + conflict: false, + candidateSources: [], + invalidSources: [], + }); + expect(JSON.stringify(inspection)).not.toContain(schemeKey); + }); + test("ignores a workspace scheme that references a different same-named project container", async () => { const root = await fixture({ includeKey: false, workspace: true }); const schemeDirectory = join(root, "MyApp.xcworkspace", "xcshareddata", "xcschemes"); diff --git a/packages/cli-core/src/commands/init/ios/inspect.ts b/packages/cli-core/src/commands/init/ios/inspect.ts index 8a0f773a..37157d5c 100644 --- a/packages/cli-core/src/commands/init/ios/inspect.ts +++ b/packages/cli-core/src/commands/init/ios/inspect.ts @@ -12,6 +12,7 @@ import { import { discoverIOSContainers, inspectWorkspace, + maskXMLComments, pathIsSafelyWithinIOSRoot, relativeIOSPath, xmlAttribute, @@ -216,7 +217,7 @@ async function schemePublishableKeyCandidates( if (!(await file.exists()) || file.size > 2_000_000) continue; let xml: string; try { - xml = (await file.text()).replace(//g, ""); + xml = maskXMLComments(await file.text()); } catch { continue; }