GitNexus/gitnexus/test/unit/scope-resolution/swift/package-config.test.ts
Gergő Magyar 51fb64c976
fix(swift): model Swift modules like the compiler (nested packages, Xcode targets, linear visibility) (#3387)
* fix(swift): discover nested Package.swift manifests for module grouping

A Swift monorepo laid out as Core/<pkg>/Package.swift has no root manifest
and no root Sources/, so every Swift file fell into one __default__ module.
The Swift resolver now walks the repo (bounded, skipping dot, ignored, and
Xcode bundle directories) and adds each nested package's targets, keyed by
repo-relative directory and ordered deepest-first so first-match grouping
picks the most specific target. Import resolution keeps the root view.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(swift): bound implicit IMPORTS edges by a total budget

Implicit same-module IMPORTS are n*(n-1) edges per module, and the graph
keeps every relationship in one Map capped by V8 at 2^24 entries. Emission
now fills a 4M-edge budget smallest module first and skips, with a warning,
any module that does not fit, so no module layout can crash analyze.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(swift): skip pairwise sibling passes for oversized modules

The target-siblings and sibling-type-bindings passes copy every file's
declarations into every other file of a module, so heap grows as n^2:
about 3.8 GB at 1,000 files with 15 defs each, about 15 GB at 2,000.
Modules over 1,000 files now skip both passes with a warning and resolve
through the global name fallback. GITNEXUS_SWIFT_MAX_MODULE_FILES changes
the ceiling.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* test(swift): cover nested SwiftPM packages end to end

A fixture with three nested Package.swift manifests (two declaring a target
named Net) and no root manifest. Each target gets its own implicit IMPORTS,
none cross packages, and Config() resolves to the caller's own package.
The Swift capture golden and scope-capture fingerprint grow with the new
fixture corpus only.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(review): apply review findings

- Rebase nested target paths with the existing Zig path helpers, which also
  reject Windows drive paths and paths that resolve to the repo root (whose
  empty prefix would group every file into one target).
- Document GITNEXUS_SWIFT_MAX_MODULE_FILES in the README env table.
- State that skipped modules resolve through lower-confidence fallback edges,
  why nested-type fragments still run for oversized modules, and fix a stale
  loader name in the target-grouping header.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* test(swift): cover every skipped Xcode bundle suffix in the package walk

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(swift): model modules the way the compiler does

Replace the caps from the first round with representations that stay
linear, and derive module identity from the same sources the compiler uses.

- Same-module visibility is one File -> Module IMPORTS edge per file
  (reason `module-membership`) instead of an edge per ordered file pair.
  Incremental importer expansion treats files sharing a Module hub as
  importers of each other. The 4M edge budget is gone.
- Sibling declarations and type bindings live in one shared table per
  module in the namespace channel C# uses since #1871, instead of being
  copied into every file. The 1,000-file ceiling and
  GITNEXUS_SWIFT_MAX_MODULE_FILES are gone.
- Modules come from root and nested SwiftPM manifests (Sources, Source,
  src, srcs; plugins under Plugins; the newest Package@swift-X.Y.swift)
  and from Xcode native targets in project.pbxproj, including Xcode 16
  synchronized folders. Target paths are matched from the repo root, so
  a vendored copy of the same layout is no longer grouped into a root
  target (this reverses #2931's floating match).
- `import X` resolves to the modules named X instead of any folder named
  X. A name no module carries is external when every manifest and
  project was read completely.
- The global-name-fallback veto uses the same membership, so test
  targets, custom-path targets and Xcode targets have module identity.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(bench): move the Swift package bench to module grouping

The bench still imported the removed groupSwiftFilesBySpmTarget. Its
first-wins probe keeps its meaning under root-anchored grouping: the
clash file sits under Sources/Mod0, and the Sources/Mod1 further down its
path is a vendored copy.

Plugins are now non-importable modules under Plugins/, so parse_targets
counts importable source targets (still 3) and parse_binary_skipped also
checks that the plugin is recorded that way. Baseline values unchanged;
the notes say why the definitions moved.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(swift): match compiler module names, manifests, and target filters

- Module names follow the compiler's c99 mangling (`my-lib` imports as
  `my_lib`); Xcode targets use a literal PRODUCT_MODULE_NAME or
  PRODUCT_NAME when the project sets one.
- Package manifests are one-file modules, as SwiftPM compiles them. Files
  outside every target are one-file modules once every manifest and
  project was read; otherwise they keep the shared __default__ module.
- Xcode 16 synchronized-folder exceptions add a file to a target that
  does not list the folder, and remove it from one that does.
- SwiftPM `sources:` / `exclude:` narrow a target; a computed list marks
  the manifest unreadable.
- The default target folder is chosen once per package, as SwiftPM does,
  instead of per target.

Refs #3355

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* Address PR review feedback (#3387)

- Inferred Swift folders keep SwiftPM's first predefined parent when a
  target name repeats (Sources before srcs).
- The pbxproj parser rejects a \U escape without four hex digits instead
  of decoding garbage, so the project reads as incomplete.
- Extension owners are stamped in every Xcode membership of a shared file.
- A plugin name never reaches a plugin: neither the fallback veto nor the
  folder-index fallback treats a known non-importable module as imported.
- A file an Xcode target compiles keeps that membership even when it also
  lies under a SwiftPM target directory.
- The workspace scan bounds the queue, not only the directories read.
- Integration tests require each module hub to exist before comparing.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Gergo Magyar <gergomagyar0@gmail.com>
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-27 06:24:35 +01:00

804 lines
29 KiB
TypeScript

/**
* Package.swift target loading (PR 3105 / #2964).
*
* `loadSwiftPackageConfig` must distinguish a declaration map
* (`origin: 'package.swift'`) from an inferred `Sources/*` folder map
* (`origin: 'directories'`). Grouping uses either; explicit import
* resolve uses only the declared origin.
*/
import { afterAll, describe, expect, it } from 'vitest';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import {
loadSwiftPackageConfig,
parseSwiftPackageManifest,
type SwiftPackageConfig,
swiftDeclaredTargetPrefix,
} from '../../../../src/core/ingestion/language-config.js';
import {
coerceDeclaredSwiftTargets,
groupSwiftFilesByModule,
} from '../../../../src/core/ingestion/languages/swift/target-grouping.js';
import { loadSwiftWorkspaceConfig } from '../../../../src/core/ingestion/languages/swift/workspace-config.js';
import { parseXcodeProject } from '../../../../src/core/ingestion/languages/swift/xcode-project.js';
import { _captureLogger } from '../../../../src/core/logger.js';
const roots: string[] = [];
function repo(files: Readonly<Record<string, string | null>>): string {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-swift-pkg-'));
roots.push(root);
for (const [rel, contents] of Object.entries(files)) {
const full = path.join(root, rel);
if (contents === null) {
fs.mkdirSync(full, { recursive: true });
continue;
}
fs.mkdirSync(path.dirname(full), { recursive: true });
fs.writeFileSync(full, contents);
}
return root;
}
afterAll(() => {
for (const root of roots) fs.rmSync(root, { recursive: true, force: true });
});
const MODELS_APP = `
let package = Package(
name: "Demo",
targets: [
.target(name: "Models"),
.target(name: "App"),
]
)
`;
describe('parseSwiftPackageManifest', () => {
it('maps .target(name:) with no path to Sources/<name>', () => {
const parsed = parseSwiftPackageManifest(MODELS_APP);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
expect(parsed.targets.get('App')).toBe('Sources/App');
});
it('honors an explicit path:', () => {
const src = `
.target(name: "Core", path: "Modules/Core")
`;
const parsed = parseSwiftPackageManifest(src);
expect({ complete: parsed.complete, entries: [...parsed.targets] }).toEqual({
complete: true,
entries: [['Core', 'Modules/Core']],
});
});
it('maps .testTarget to Tests/<name>', () => {
const parsed = parseSwiftPackageManifest(`.testTarget(name: "AppTests")`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('AppTests')).toBe('Tests/AppTests');
});
it('skips binary / systemLibrary targets, which have no Swift sources', () => {
const parsed = parseSwiftPackageManifest(`
.binaryTarget(name: "Lib", path: "Lib.xcframework")
.systemLibrary(name: "CFoo")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.size).toBe(0);
});
it('keeps plugin targets as modules under Plugins/, marked non-importable', () => {
const parsed = parseSwiftPackageManifest(`.plugin(name: "Gen", capability: .buildTool())`);
expect(parsed.targets.get('Gen')).toBe('Plugins/Gen');
expect([...parsed.plugins]).toEqual(['Gen']);
expect(parsed.implicitDirs.get('Gen')).toBe('plugin');
});
it('treats #if as a completeness hazard', () => {
const parsed = parseSwiftPackageManifest(`
#if os(macOS)
.target(name: "MacOnly")
#endif
.target(name: "Models")
`);
expect(parsed.complete).toBe(false);
});
it('treats a helper-built targets: list as incomplete', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(name: "Demo", targets: makeTargets())
`);
expect(parsed.complete).toBe(false);
});
it('treats a computed name: as incomplete', () => {
const parsed = parseSwiftPackageManifest(`.target(name: targetName)`);
expect(parsed.complete).toBe(false);
});
it('treats a computed path: as incomplete', () => {
const parsed = parseSwiftPackageManifest(`.target(name: "Core", path: corePath)`);
expect(parsed.complete).toBe(false);
});
it('ignores a block-commented factory', () => {
const parsed = parseSwiftPackageManifest(`
/* .target(name: "Ghost") */
.target(name: "Models")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('records path: "." as the package root', () => {
const parsed = parseSwiftPackageManifest(`.target(name: "Lib", path: ".")`);
expect({ complete: parsed.complete, entries: [...parsed.targets] }).toEqual({
complete: true,
entries: [['Lib', '.']],
});
});
it('ignores a // commented factory', () => {
const parsed = parseSwiftPackageManifest(`
// .target(name: "Ghost")
.target(name: "Models")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('does not treat a dependency .target(name:) as a declared target', () => {
const parsed = parseSwiftPackageManifest(`
.target(name: "App", dependencies: [.target(name: "Core")])
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('App')).toBe('Sources/App');
expect(parsed.targets.has('Core')).toBe(false);
});
it('prefers an explicit path over an earlier same-name factory', () => {
const parsed = parseSwiftPackageManifest(`
.target(name: "Core")
.target(name: "Core", path: "Modules/Core")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Core')).toBe('Modules/Core');
});
it('treats a string-interpolated path as incomplete', () => {
const parsed = parseSwiftPackageManifest(`.target(name: "Core", path: "Modules/\\(name)")`);
expect(parsed.complete).toBe(false);
});
it('treats a parenthesized name string as a complete factory', () => {
const parsed = parseSwiftPackageManifest(`.target(name: "Foo (experimental)")`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Foo (experimental)')).toBe('Sources/Foo (experimental)');
});
it('ignores a commented parenthesis while balancing a factory', () => {
const parsed = parseSwiftPackageManifest(`
.target(name: "Core", // )
path: "Modules/Core")
`);
expect({ complete: parsed.complete, entries: [...parsed.targets] }).toEqual({
complete: true,
entries: [['Core', 'Modules/Core']],
});
});
it('ignores a block-comment parenthesis while balancing a factory', () => {
const parsed = parseSwiftPackageManifest(`.target(name: "Core", /* ) */ path: "Modules/Core")`);
expect({ complete: parsed.complete, entries: [...parsed.targets] }).toEqual({
complete: true,
entries: [['Core', 'Modules/Core']],
});
});
it('treats a mixed literal + helper-built targets: list as incomplete', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(name: "Demo", targets: [.target(name: "Core")] + makeTargets())
`);
expect(parsed.complete).toBe(false);
});
it('treats a helper-built list concatenated before literals as incomplete', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(name: "Demo", targets: makeTargets() + [.target(name: "Core")])
`);
expect(parsed.complete).toBe(false);
});
it('does not treat .library(..., targets: names) as a helper-built list', () => {
const parsed = parseSwiftPackageManifest(`
.library(name: "Demo", targets: libTargets)
.target(name: "Models")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('ignores a factory-like spelling inside a string literal', () => {
const parsed = parseSwiftPackageManifest(`
let example = ".target(name: 'Ghost')"
.target(name: "Models")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('treats a variable-prefix targets: concatenation as incomplete', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(name: "Demo", targets: extraTargets + [.target(name: "Core")])
`);
expect(parsed.complete).toBe(false);
});
it('skips a commented name: field and uses the real one', () => {
const parsed = parseSwiftPackageManifest(`.target(/* name: "Ghost" */ name: "Models")`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('does not treat a commented #if as a completeness hazard', () => {
const parsed = parseSwiftPackageManifest(`
// #if os(macOS)
.target(name: "Models")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('does not treat a block-commented #if as a completeness hazard', () => {
const parsed = parseSwiftPackageManifest(`
/*
#if os(macOS)
.target(name: "MacOnly")
#endif
*/
.target(name: "Models")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('MacOnly')).toBe(false);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('rejects a name string with a Swift escape', () => {
const parsed = parseSwiftPackageManifest(`.target(name: "\\u{43}ore")`);
expect(parsed.complete).toBe(false);
expect(parsed.targets.size).toBe(0);
});
it('does not treat https:// on the same line as a commented factory', () => {
const parsed = parseSwiftPackageManifest(
'let package = Package(name: "Demo", dependencies: [.package(url: "https://example.com/foo.git", from: "1.0.0")], targets: [.target(name: "T")])',
);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('T')).toBe('Sources/T');
});
it('ignores a commented helper-built targets: list', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(
name: "Demo",
targets: [
.target(name: "Models"),
]
)
// targets: makeTargets()
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('ignores a helper-built targets: spelling inside a string', () => {
const parsed = parseSwiftPackageManifest(`
let note = "targets: makeTargets()"
let package = Package(name: "Demo", targets: [.target(name: "Models")])
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
it('treats Package(targets: variable) as incomplete even when a factory was collected', () => {
const parsed = parseSwiftPackageManifest(`
func unused() { _ = Target.target(name: "Ghost") }
let package = Package(name: "Demo", targets: actualTargets)
.target(name: "Incidental")
`);
expect(parsed.complete).toBe(false);
expect(parsed.targets.size).toBe(0);
});
it('does not collect a factory outside Package(targets: [...])', () => {
const parsed = parseSwiftPackageManifest(`
func unused() { _ = Target.target(name: "Ghost") }
let package = Package(name: "Demo", targets: [.target(name: "Incidental")])
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.get('Incidental')).toBe('Sources/Incidental');
});
it('treats a computed element inside the targets: array as incomplete', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(name: "Demo", targets: [makeTargets()])
`);
expect(parsed.complete).toBe(false);
expect(parsed.targets.size).toBe(0);
});
it('does not collect factories when Package omits targets:', () => {
const parsed = parseSwiftPackageManifest(`
let unused = Target.target(name: "Ghost")
let package = Package(name: "Empty")
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.size).toBe(0);
});
it('does not treat a line comment after a label colon as live source', () => {
const parsed = parseSwiftPackageManifest(`
let package = Package(
name: "Demo",
targets: [
.target(name: // .target(name: "Ghost")
"Models"),
]
)
`);
expect(parsed.complete).toBe(true);
expect(parsed.targets.has('Ghost')).toBe(false);
expect(parsed.targets.get('Models')).toBe('Sources/Models');
});
});
describe('swiftDeclaredTargetPrefix', () => {
it('treats . and ./ as the package root', () => {
expect(swiftDeclaredTargetPrefix('.')).toBe('');
expect(swiftDeclaredTargetPrefix('./')).toBe('');
expect(swiftDeclaredTargetPrefix('./.')).toBe('');
});
it('strips a leading ./ from a relative target path', () => {
expect(swiftDeclaredTargetPrefix('./Sources/Core')).toBe('Sources/Core/');
expect(swiftDeclaredTargetPrefix('Sources/Core')).toBe('Sources/Core/');
});
});
describe('loadSwiftPackageConfig', () => {
it('returns a declared map from Package.swift and ignores undeclared Sources/* folders', async () => {
const root = repo({
'Package.swift': MODELS_APP,
'Sources/Models/User.swift': '',
'Sources/App/main.swift': '',
'Sources/Foundation/Thing.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.origin).toBe('package.swift');
expect([...cfg!.targets.keys()].sort()).toEqual(['App', 'Models']);
expect(cfg!.targets.has('Foundation')).toBe(false);
});
it('returns an empty declared map when the manifest only has skipped target kinds', async () => {
const root = repo({
'Package.swift': `
let package = Package(
name: "OnlyBinary",
targets: [.binaryTarget(name: "Lib", path: "Lib.xcframework")]
)
`,
'Sources/Foundation/Thing.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.origin).toBe('package.swift');
expect(cfg!.declaredTargets?.size).toBe(0);
// Grouping still uses inferred folders so App/Foundation stay isolated.
expect(cfg!.targets.get('Foundation')).toBe('Sources/Foundation');
expect(coerceDeclaredSwiftTargets(cfg)?.size).toBe(0);
});
it('infers Sources/* folders when Package.swift is missing', async () => {
const root = repo({
'Sources/App/main.swift': '',
'Sources/Models/User.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.origin).toBe('directories');
expect(cfg!.targets.get('App')).toBe('Sources/App');
expect(cfg!.targets.get('Models')).toBe('Sources/Models');
});
it('infers directories when Package.swift is unreadable (is a directory)', async () => {
const root = repo({
'Package.swift': null,
'Sources/App/main.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.origin).toBe('directories');
expect(cfg!.targets.get('App')).toBe('Sources/App');
});
it('infers directories when the manifest has completeness hazards', async () => {
const root = repo({
'Package.swift': `
#if os(Linux)
.target(name: "LinuxOnly")
#endif
`,
'Sources/App/main.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.origin).toBe('directories');
expect(cfg!.targets.get('App')).toBe('Sources/App');
expect(cfg!.targets.has('LinuxOnly')).toBe(false);
});
it('returns null when there is no manifest and no source folders', async () => {
const root = repo({ 'README.md': '' });
expect(await loadSwiftPackageConfig(root)).toBeNull();
});
it('declares a one-line manifest that includes an https:// dependency URL', async () => {
const root = repo({
'Package.swift':
'let package = Package(name: "Demo", dependencies: [.package(url: "https://example.com/foo.git", from: "1.0.0")], targets: [.target(name: "T")])',
'Sources/T/T.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.origin).toBe('package.swift');
expect(cfg!.declaredTargets?.get('T')).toBe('Sources/T');
expect(cfg!.targets.get('T')).toBe('Sources/T');
});
});
const pkg = (...targets: string[]): string =>
`let package = Package(name: "P", targets: [${targets.join(', ')}])`;
const moduleKeys = (cfg: SwiftPackageConfig | null): string[] =>
(cfg?.modules ?? []).map((m) => m.key).sort();
describe('loadSwiftPackageConfig — SwiftPM directory rules', () => {
it('prefers the first predefined parent when inferring folders with no manifest', async () => {
const root = repo({ 'Sources/Foo/a.swift': '', 'srcs/Foo/b.swift': '' });
expect((await loadSwiftPackageConfig(root))?.targets.get('Foo')).toBe('Sources/Foo');
});
it('picks one predefined parent per package: the first of Sources, Source, src, srcs', async () => {
const root = repo({
'Package.swift': pkg(
'.target(name: "A")',
'.target(name: "B")',
'.testTarget(name: "BTests")',
),
'Source/A/a.swift': '',
'srcs/B/b.swift': '',
'Tests/BTests/t.swift': '',
});
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.targets.get('A')).toBe('Source/A');
// SwiftPM does not fall through per target: B belongs under Source/ too.
expect(cfg?.targets.get('B')).toBe('Source/B');
expect(cfg?.targets.get('BTests')).toBe('Tests/BTests');
});
it('looks for test targets under the source parent when there is no Tests/', async () => {
const root = repo({
'Package.swift': pkg('.testTarget(name: "LibTests")'),
'Sources/LibTests/t.swift': '',
});
expect((await loadSwiftPackageConfig(root))?.targets.get('LibTests')).toBe('Sources/LibTests');
});
it('reads sources: and exclude: lists, and treats a computed list as unreadable', () => {
const parsed = parseSwiftPackageManifest(
pkg(
'.target(name: "Lib", exclude: ["Legacy", "README.md"], sources: ["Core", "Main.swift"])',
),
);
expect(parsed.filters.get('Lib')).toEqual({
sources: ['Core', 'Main.swift'],
exclude: ['Legacy', 'README.md'],
});
expect(parseSwiftPackageManifest(pkg('.target(name: "Lib", exclude: excluded)')).complete).toBe(
false,
);
});
it('reads the highest Package@swift-X.Y.swift over Package.swift', async () => {
const root = repo({
'Package.swift': pkg('.target(name: "Old")'),
'Package@swift-5.9.swift': pkg('.target(name: "New59")'),
'Package@swift-5.10.swift': pkg('.target(name: "New510")'),
});
const cfg = await loadSwiftPackageConfig(root);
expect([...cfg!.targets.keys()]).toEqual(['New510']);
});
it('groups plugins but keeps them out of the import declaration map', async () => {
const root = repo({ 'Package.swift': pkg('.target(name: "Lib")', '.plugin(name: "Gen")') });
const cfg = await loadSwiftPackageConfig(root);
expect(cfg?.targets.get('Gen')).toBe('Plugins/Gen');
expect([...cfg!.declaredTargets!.keys()]).toEqual(['Lib']);
});
});
describe('loadSwiftWorkspaceConfig — nested packages and Xcode projects (#3355)', () => {
it('adds each nested package target keyed by its repo-relative directory', async () => {
const root = repo({
'Core/Net/Package.swift': pkg('.target(name: "Net")'),
'Core/Net/Sources/Net/Client.swift': '',
'Features/Login/Package.swift': pkg(
'.target(name: "Login")',
'.testTarget(name: "LoginTests")',
),
'Features/Login/Sources/Login/View.swift': '',
'Features/Login/Tests/LoginTests/ViewTests.swift': '',
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(cfg?.origin).toBe('directories');
expect(moduleKeys(cfg)).toEqual([
'Core/Net/Sources/Net',
'Features/Login/Sources/Login',
'Features/Login/Tests/LoginTests',
]);
expect(cfg?.modules?.find((m) => m.key === 'Core/Net/Sources/Net')).toMatchObject({
name: 'Net',
importable: true,
});
expect(cfg?.moduleNamesComplete).toBe(true);
expect(coerceDeclaredSwiftTargets(cfg)).toBeNull();
});
it('keeps two packages declaring the same target name as two modules', async () => {
const root = repo({
'Core/A/Package.swift': pkg('.target(name: "Core")'),
'Core/B/Package.swift': pkg('.target(name: "Core")'),
});
const cfg = await loadSwiftWorkspaceConfig(root);
const groups = groupSwiftFilesByModule(
['Core/A/Sources/Core/X.swift', 'Core/B/Sources/Core/Y.swift'],
(p) => p,
cfg,
);
expect(groups.get('Core/A/Sources/Core')).toEqual(['Core/A/Sources/Core/X.swift']);
expect(groups.get('Core/B/Sources/Core')).toEqual(['Core/B/Sources/Core/Y.swift']);
});
it('groups a nested file under its own package even when a root target shares the tail', async () => {
const root = repo({
'Package.swift': pkg('.target(name: "Core")'),
'Features/A/Package.swift': pkg('.target(name: "Core")'),
});
const cfg = await loadSwiftWorkspaceConfig(root);
const groups = groupSwiftFilesByModule(
['Sources/Core/Root.swift', 'Features/A/Sources/Core/Nested.swift'],
(p) => p,
cfg,
);
expect(groups.get('Sources/Core')).toEqual(['Sources/Core/Root.swift']);
expect(groups.get('Features/A/Sources/Core')).toEqual(['Features/A/Sources/Core/Nested.swift']);
});
it('keeps the root declaration for legacy callers and lists every module', async () => {
const root = repo({
'Package.swift': MODELS_APP,
'Features/Login/Package.swift': pkg('.target(name: "Login")'),
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(cfg?.origin).toBe('package.swift');
expect([...coerceDeclaredSwiftTargets(cfg)!.keys()].sort()).toEqual(['App', 'Models']);
expect(moduleKeys(cfg)).toEqual([
'Features/Login/Sources/Login',
'Sources/App',
'Sources/Models',
]);
});
it('joins a custom path with the package directory and drops one escaping the repo', async () => {
const root = repo({
'Pkgs/Lib/Package.swift': pkg(
'.target(name: "Lib", path: "Code")',
'.target(name: "Shared", path: "../Shared")',
'.target(name: "Outside", path: "../../../Outside")',
'.target(name: "Root", path: "../..")',
'.target(name: "Drive", path: "C:/Elsewhere")',
),
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(moduleKeys(cfg)).toEqual(['Pkgs/Lib/Code', 'Pkgs/Shared']);
});
it('infers Sources/* folders for a hazardous nested manifest and marks names incomplete', async () => {
const root = repo({
'Core/Hazard/Package.swift': '#if os(Linux)\n.target(name: "L")\n#endif\n',
'Core/Hazard/Sources/App/main.swift': '',
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(moduleKeys(cfg)).toEqual(['Core/Hazard/Sources/App']);
expect(cfg?.moduleNamesComplete).toBe(false);
});
it('skips manifests under build output, dependencies, and bundle directories', async () => {
const root = repo({
'.build/checkouts/Dep/Package.swift': pkg('.target(name: "Dep")'),
'node_modules/x/Package.swift': pkg('.target(name: "X")'),
'App.xcodeproj/Package.swift': pkg('.target(name: "Proj")'),
'Assets.xcassets/Package.swift': pkg('.target(name: "Assets")'),
'App.xcworkspace/Package.swift': pkg('.target(name: "Ws")'),
'en.lproj/Package.swift': pkg('.target(name: "Loc")'),
'Res.bundle/Package.swift': pkg('.target(name: "Res")'),
'Core/Real/Package.swift': pkg('.target(name: "Real")'),
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(moduleKeys(cfg)).toEqual(['Core/Real/Sources/Real']);
});
it('reads Xcode target membership and marks names incomplete when a project is unreadable', async () => {
const root = repo({
'App/App.xcodeproj/project.pbxproj': PBXPROJ,
'App/Broken.xcodeproj/project.pbxproj': '{ objects = {',
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(cfg?.modules?.find((m) => m.name === 'App')).toMatchObject({
key: 'xcode:App/App.xcodeproj:App',
files: ['App/App/AppMain.swift', 'App/Shared/Util.swift', 'App/Widget/Shared.swift'],
});
expect(cfg?.moduleNamesComplete).toBe(false);
});
it('warns and keeps shallower packages when the walk passes the depth cap', async () => {
const deep = Array.from({ length: 26 }, (_, i) => `d${i}`).join('/');
const root = repo({
'Core/Shallow/Package.swift': pkg('.target(name: "Shallow")'),
[`${deep}/Package.swift`]: pkg('.target(name: "Deep")'),
});
const cap = _captureLogger();
try {
const cfg = await loadSwiftWorkspaceConfig(root);
expect(moduleKeys(cfg)).toEqual(['Core/Shallow/Sources/Shallow']);
expect(cfg?.moduleNamesComplete).toBe(false);
expect(cap.text()).toContain('workspace scan');
} finally {
cap.restore();
}
});
it('returns null with no manifest, project, or source folders anywhere', async () => {
const root = repo({ 'README.md': '' });
expect(await loadSwiftWorkspaceConfig(root)).toBeNull();
});
});
describe('parseXcodeProject', () => {
it('resolves group paths, SOURCE_ROOT references, and synchronized folders with exceptions', () => {
const parsed = parseXcodeProject(PBXPROJ, 'App');
expect(parsed.complete).toBe(true);
expect(parsed.targets).toEqual([
{
name: 'App',
moduleName: 'App',
files: ['App/App/AppMain.swift', 'App/Shared/Util.swift', 'App/Widget/Shared.swift'],
folders: [],
excluded: [],
},
{
name: 'Widget',
moduleName: 'WidgetKitExt',
files: ['App/Shared/Util.swift'],
folders: ['App/Widget'],
excluded: ['App/Widget/Preview.swift'],
},
]);
});
it('reports an unparseable project as incomplete', () => {
expect(parseXcodeProject('{ objects = ', '')).toEqual({ targets: [], complete: false });
});
it.each(['\\U12xz', '\\Uzzzz', '\\U12'])(
'reports a malformed %s escape as incomplete',
(escape) => {
const project = `{ objects = { R = { isa = PBXProject; mainGroup = G; targets = ( ); }; G = { isa = PBXGroup; name = "${escape}"; }; }; rootObject = R; }`;
expect(parseXcodeProject(project, '').complete).toBe(false);
},
);
});
/**
* Two targets: `App` via a classic sources phase (one `<group>` file, one
* `SOURCE_ROOT` file, one SDK framework that must be ignored), and `Widget`
* via an Xcode 16 synchronized folder, plus the shared SOURCE_ROOT file.
* The folder's exceptions remove `Preview.swift` from `Widget` (which lists
* the folder) and add `Shared.swift` to `App` (which does not). `Widget`
* sets a literal `PRODUCT_MODULE_NAME`.
*/
const PBXPROJ = `// !$*UTF8*$!
{
archiveVersion = 1;
objectVersion = 77;
objects = {
ROOT /* Project object */ = { isa = PBXProject; mainGroup = MAIN; projectDirPath = ""; targets = ( TAPP, TWID, ); };
MAIN = { isa = PBXGroup; children = ( GAPP, FUTIL, FSDK, SYNC, ); sourceTree = "<group>"; };
GAPP /* App */ = { isa = PBXGroup; children = ( FMAIN, ); path = App; sourceTree = "<group>"; };
FMAIN = { isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppMain.swift; sourceTree = "<group>"; };
FUTIL = { isa = PBXFileReference; path = "Shared/Util.swift"; sourceTree = SOURCE_ROOT; };
FSDK = { isa = PBXFileReference; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; };
SYNC = { isa = PBXFileSystemSynchronizedRootGroup; exceptions = ( EXC, EXCAPP, ); path = Widget; sourceTree = "<group>"; };
EXC = { isa = PBXFileSystemSynchronizedBuildFileExceptionSet; membershipExceptions = ( Preview.swift, ); target = TWID; };
EXCAPP = { isa = PBXFileSystemSynchronizedBuildFileExceptionSet; membershipExceptions = ( Shared.swift, ); target = TAPP; };
TAPP = { isa = PBXNativeTarget; buildPhases = ( PAPP, ); name = App; };
PAPP = { isa = PBXSourcesBuildPhase; files = ( BMAIN, BUTIL, BSDK, ); };
BMAIN = { isa = PBXBuildFile; fileRef = FMAIN; };
BUTIL = { isa = PBXBuildFile; fileRef = FUTIL; };
BSDK = { isa = PBXBuildFile; fileRef = FSDK; };
TWID = { isa = PBXNativeTarget; buildConfigurationList = CLWID; buildPhases = ( PWID, ); fileSystemSynchronizedGroups = ( SYNC, ); name = Widget; };
CLWID = { isa = XCConfigurationList; buildConfigurations = ( CDEBUG, ); };
CDEBUG = { isa = XCBuildConfiguration; buildSettings = { PRODUCT_MODULE_NAME = WidgetKitExt; PRODUCT_NAME = "$(TARGET_NAME)"; }; name = Debug; };
PWID = { isa = PBXSourcesBuildPhase; files = ( BUTIL2, ); };
BUTIL2 = { isa = PBXBuildFile; fileRef = FUTIL; };
};
rootObject = ROOT;
}
`;
describe('loadSwiftWorkspaceConfig — compiler module names and filters (#3355)', () => {
it('names a SwiftPM module the way the compiler does and rebases sources:/exclude:', async () => {
const root = repo({
'Pkgs/Kit/Package.swift': pkg(
'.target(name: "my-kit", sources: ["Core"], exclude: ["Core/Legacy"])',
),
'Pkgs/Kit/Sources/my-kit/Core/A.swift': '',
});
const cfg = await loadSwiftWorkspaceConfig(root);
expect(cfg?.modules).toEqual([
{
key: 'Pkgs/Kit/Sources/my-kit',
name: 'my_kit',
dir: 'Pkgs/Kit/Sources/my-kit',
importable: true,
sources: ['Pkgs/Kit/Sources/my-kit/Core'],
excluded: ['Pkgs/Kit/Sources/my-kit/Core/Legacy'],
},
]);
});
});