@invarn/cibuild 2.7.0 → 2.7.1

package/dist/src/commands/ios-scanner.d.ts

@@ -44,18 +44,54 @@ export interface IosScanResult {
  *
  *  1. named after the project or workspace — the commonest case, and
  *     unambiguous;
- *  2. launches the product named after the project, and is not named like a
- *     companion. `thebaselab/codeapp` is why this outranks the next one: its
- *     `Code App` scheme launches `Code.app` and declares no tests at all,
- *     while `Code UI` has two test bundles and launches `CodeUI.app`;
- *  3. launches an `.app`, declares tests (the template runs them), and is not
- *     named like a companion; among several, the iOS or Debug one, then the
- *     shortest;
- *  4. launches an `.app` and is not named like a companion;
+ *  2. launches the product named after the project, and is not a companion.
+ *     `thebaselab/codeapp` is why this outranks the next one: its `Code App`
+ *     scheme launches `Code.app` and declares no tests at all, while `Code UI`
+ *     has two test bundles and launches `CodeUI.app`;
+ *  3. launches an `.app`, declares tests (the template runs them), and is not a
+ *     companion; among several, the iOS or Debug one, then the shortest;
+ *  4. launches an `.app` and is not a companion;
  *  5. whatever order it came in.
  *
  * Every scheme stays in the list — this reorders, it does not filter, so a
  * caller wanting the extension can still find it.
+ *
+ * **What "companion" has to mean, and why a name is not enough.**
+ * `mozilla-mobile/firefox-ios` broke tiers 1-4 without touching the directory
+ * order this function was written for. Its project is `Client.xcodeproj`, so
+ * `projectName` is `Client`. An app extension is launched *through its host
+ * app*, so the `Today` widget scheme's LaunchAction runnable is `Client.app` —
+ * identical to `Fennec`'s. Both landed in tier 1, neither name carries an `iOS`
+ * or `Debug` token, and the tie fell to name length:
+ *
+ *     "Today"  -> 5 characters      <- won
+ *     "Fennec" -> 6 characters
+ *
+ * The build then failed compiling `ActionExtension` rather than the browser
+ * (`bld_b1b38dda58f4111080415283`).
+ *
+ * Launching the app binary is therefore not sufficient, and the answer is not a
+ * longer name blocklist either — `Today` names nothing. Xcode states the fact
+ * outright: it writes `wasCreatedForAppExtension = "YES"` onto the `<Scheme>`
+ * element of a scheme it created for an extension target, so that is what is
+ * read.
+ *
+ * Measured over all 125 shared schemes in the thirty-app study's clones: 29
+ * carry the attribute, and **all 29 are extension schemes** — no false
+ * positive. It is also the only signal that would have worked. Two that were
+ * considered and are wrong on this same evidence:
+ *
+ *  - *require an `.app` among the BuildAction entries.* 27 of the 29 extension
+ *    schemes build the host app too — `Today` builds
+ *    `["Today.appex", "Client.app"]` — so this demotes 2 of 29 and leaves
+ *    firefox-ios picking `Today`.
+ *  - *demote anything building an `.appex`.* `chenqi92/primuse`'s `Primuse`
+ *    scheme is the real app scheme and builds two widget extensions alongside
+ *    `Primuse.app`.
+ *
+ * The attribute is a sufficient signal, not a necessary one: a hand-written or
+ * pre-Xcode-10 scheme may omit it, and its absence changes nothing, so nothing
+ * that ranked before can regress on a scheme that does not carry it.
  */
 export declare function rankSchemes(root: string, projectPath: string, schemes: string[]): string[];
 /** The ranking, plus the sentence explaining its first entry. */

package/dist/src/commands/ios-scanner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ios-scanner.d.ts","sourceRoot":"","sources":["../../../src/commands/ios-scanner.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,SAAS,GAAG,gBAAgB,GAAG,WAAW,CAAC;AAE7F,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB;;;OAGG;IACH,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,YAAY,EAAE,OAAO,CAAC;IACtB,0DAA0D;IAC1D,MAAM,EAAE,OAAO,CAAC;IAChB,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iFAAiF;IACjF,eAAe,EAAE,MAAM,CAAC;CACzB;AA8ED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,GAChB,MAAM,EAAE,CAEV;AAED,iEAAiE;AACjE,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,GAChB;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CA4CxC;AAmLD,wBAAsB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAgGhF;AAaD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAkDjE"}
+{"version":3,"file":"ios-scanner.d.ts","sourceRoot":"","sources":["../../../src/commands/ios-scanner.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,SAAS,GAAG,gBAAgB,GAAG,WAAW,CAAC;AAE7F,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB;;;OAGG;IACH,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,YAAY,EAAE,OAAO,CAAC;IACtB,0DAA0D;IAC1D,MAAM,EAAE,OAAO,CAAC;IAChB,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iFAAiF;IACjF,eAAe,EAAE,MAAM,CAAC;CACzB;AAuFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,GAChB,MAAM,EAAE,CAEV;AAED,iEAAiE;AACjE,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,GAChB;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CA8CxC;AAmLD,wBAAsB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAgGhF;AAaD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAkDjE"}

package/dist/src/commands/ios-scanner.js

@@ -60,9 +60,13 @@ function readSchemeFacts(root, name) {
         if (!xml)
             continue;
         const launch = /<LaunchAction[\s\S]*?<\/LaunchAction>/.exec(xml)?.[0] ?? "";
+        // Attribute values carry no `>`, so the opening tag alone is a safe scope
+        // and no attribute deeper in the document can be mistaken for it.
+        const schemeTag = /<Scheme\b[^>]*>/.exec(xml)?.[0] ?? "";
         return {
             runnable: /BuildableName\s*=\s*"([^"]+)"/.exec(launch)?.[1],
             testable: /<TestableReference/.test(xml),
+            appExtension: /wasCreatedForAppExtension\s*=\s*"YES"/.test(schemeTag),
         };
     }
     return undefined;
@@ -84,18 +88,54 @@ function readSchemeFacts(root, name) {
  *
  *  1. named after the project or workspace — the commonest case, and
  *     unambiguous;
- *  2. launches the product named after the project, and is not named like a
- *     companion. `thebaselab/codeapp` is why this outranks the next one: its
- *     `Code App` scheme launches `Code.app` and declares no tests at all,
- *     while `Code UI` has two test bundles and launches `CodeUI.app`;
- *  3. launches an `.app`, declares tests (the template runs them), and is not
- *     named like a companion; among several, the iOS or Debug one, then the
- *     shortest;
- *  4. launches an `.app` and is not named like a companion;
+ *  2. launches the product named after the project, and is not a companion.
+ *     `thebaselab/codeapp` is why this outranks the next one: its `Code App`
+ *     scheme launches `Code.app` and declares no tests at all, while `Code UI`
+ *     has two test bundles and launches `CodeUI.app`;
+ *  3. launches an `.app`, declares tests (the template runs them), and is not a
+ *     companion; among several, the iOS or Debug one, then the shortest;
+ *  4. launches an `.app` and is not a companion;
  *  5. whatever order it came in.
  *
  * Every scheme stays in the list — this reorders, it does not filter, so a
  * caller wanting the extension can still find it.
+ *
+ * **What "companion" has to mean, and why a name is not enough.**
+ * `mozilla-mobile/firefox-ios` broke tiers 1-4 without touching the directory
+ * order this function was written for. Its project is `Client.xcodeproj`, so
+ * `projectName` is `Client`. An app extension is launched *through its host
+ * app*, so the `Today` widget scheme's LaunchAction runnable is `Client.app` —
+ * identical to `Fennec`'s. Both landed in tier 1, neither name carries an `iOS`
+ * or `Debug` token, and the tie fell to name length:
+ *
+ *     "Today"  -> 5 characters      <- won
+ *     "Fennec" -> 6 characters
+ *
+ * The build then failed compiling `ActionExtension` rather than the browser
+ * (`bld_b1b38dda58f4111080415283`).
+ *
+ * Launching the app binary is therefore not sufficient, and the answer is not a
+ * longer name blocklist either — `Today` names nothing. Xcode states the fact
+ * outright: it writes `wasCreatedForAppExtension = "YES"` onto the `<Scheme>`
+ * element of a scheme it created for an extension target, so that is what is
+ * read.
+ *
+ * Measured over all 125 shared schemes in the thirty-app study's clones: 29
+ * carry the attribute, and **all 29 are extension schemes** — no false
+ * positive. It is also the only signal that would have worked. Two that were
+ * considered and are wrong on this same evidence:
+ *
+ *  - *require an `.app` among the BuildAction entries.* 27 of the 29 extension
+ *    schemes build the host app too — `Today` builds
+ *    `["Today.appex", "Client.app"]` — so this demotes 2 of 29 and leaves
+ *    firefox-ios picking `Today`.
+ *  - *demote anything building an `.appex`.* `chenqi92/primuse`'s `Primuse`
+ *    scheme is the real app scheme and builds two widget extensions alongside
+ *    `Primuse.app`.
+ *
+ * The attribute is a sufficient signal, not a necessary one: a hand-written or
+ * pre-Xcode-10 scheme may omit it, and its absence changes nothing, so nothing
+ * that ranked before can regress on a scheme that does not carry it.
  */
 export function rankSchemes(root, projectPath, schemes) {
     return rankSchemesWithReason(root, projectPath, schemes).schemes;
@@ -107,10 +147,12 @@ export function rankSchemesWithReason(root, projectPath, schemes) {
     const projectName = projectPath.replace(/\.(xcodeproj|xcworkspace)$/, "").split("/").pop();
     const scored = schemes.map((name, index) => {
         const facts = readSchemeFacts(root, name);
-        const companion = COMPANION_SCHEME.test(name);
+        // Two ways to be a companion: the name says so, or Xcode does. Xcode's
+        // word outranks a name match, so it disqualifies tier 0 as well.
+        const companion = COMPANION_SCHEME.test(name) || (facts?.appExtension ?? false);
         const app = facts?.runnable?.endsWith(".app") ?? false;
         let tier = 4;
-        if (name === projectName)
+        if (name === projectName && !facts?.appExtension)
             tier = 0;
         else if (facts?.runnable === `${projectName}.app` && !companion)
             tier = 1;

package/dist/src/commands/ios-scheme-ranking.test.js

@@ -27,11 +27,11 @@ afterEach(() => {
     rmSync(root, { recursive: true, force: true });
 });
 /** An `.xcscheme` with the parts the ranking reads, in Xcode's own shape. */
-function scheme(project, name, { runnable, testable }) {
+function scheme(project, name, { runnable, testable, appExtension }) {
     const dir = join(root, `${project}.xcodeproj`, "xcshareddata", "xcschemes");
     mkdirSync(dir, { recursive: true });
     writeFileSync(join(dir, `${name}.xcscheme`), `<?xml version="1.0" encoding="UTF-8"?>
-<Scheme LastUpgradeVersion = "1600" version = "1.7">
+<Scheme LastUpgradeVersion = "1600"${appExtension ? `\n   wasCreatedForAppExtension = "YES"` : ""} version = "1.7">
    <TestAction buildConfiguration = "Debug">
       <Testables>${testable
         ? `
@@ -149,4 +149,111 @@ describe("rankSchemes", () => {
         expect(pick("Solo.xcodeproj", ["Solo", "Other"])).toBe("Solo");
     });
 });
+/**
+ * An app extension is launched *through its host app*, so an extension scheme's
+ * LaunchAction runnable is the host `.app` — the same value the app's own
+ * scheme carries. Launching the app binary is therefore not sufficient to be
+ * the app scheme, and no name blocklist reaches the case: `Today` names nothing.
+ *
+ * Xcode states the fact itself, on the `<Scheme>` element of any scheme it
+ * created for an extension target. Measured across all 125 shared schemes in
+ * the thirty-app study's clones: 29 carry `wasCreatedForAppExtension`, all 29
+ * are extension schemes, and 27 of them build the host `.app` too — which is
+ * why "require an `.app` among the BuildAction entries" does not separate them.
+ */
+describe("rankSchemes and app-extension schemes", () => {
+    /**
+     * `mozilla-mobile/firefox-ios`, all thirteen schemes of
+     * `firefox-ios/Client.xcodeproj`, read off the clone. The project is
+     * `Client.xcodeproj`, so five schemes launch `Client.app` and land in the
+     * same tier; none carries an `iOS` or `Debug` token, so the tie fell to name
+     * length and `Today` (5) beat `Fennec` (6). The build then failed compiling
+     * `ActionExtension` — `bld_b1b38dda58f4111080415283`.
+     */
+    const FIREFOX_IOS = [
+        ["Account", { runnable: "libAccount.a", testable: true }],
+        ["Fennec", { runnable: "Client.app", testable: true }],
+        ["Fennec_Enterprise", { runnable: "Client.app", testable: true }],
+        ["Firefox", { runnable: "Client.app", testable: true }],
+        ["FirefoxBeta", { runnable: "Client.app", testable: true }],
+        ["FirefoxStaging", { runnable: "Client.app", testable: true }],
+        ["L10nSnapshotTests", { runnable: "L10nSnapshotTests.xctest", testable: true }],
+        ["Periphery", {}],
+        ["ShareTo", { runnable: "ShareTo.appex", appExtension: true }],
+        ["Storage", { runnable: "libStorage.a", testable: true }],
+        ["Sync", { runnable: "Sync.framework", testable: true }],
+        ["Telemetry", { runnable: "libSyncTelemetry.a", testable: true }],
+        ["Today", { runnable: "Client.app", testable: true, appExtension: true }],
+    ];
+    function firefoxIos() {
+        for (const [name, shape] of FIREFOX_IOS)
+            scheme("Client", name, shape);
+        return FIREFOX_IOS.map(([name]) => name);
+    }
+    test("picks the browser, not its widget", () => {
+        const names = firefoxIos();
+        expect(pick("Client.xcodeproj", names)).toBe("Fennec");
+    });
+    // The defect only became visible because a five-character extension name won
+    // a length tiebreak. The answer must not depend on the order either.
+    test("picks the browser whatever order the filesystem lists", () => {
+        const names = firefoxIos();
+        const orders = [
+            names,
+            [...names].reverse(),
+            ["Today", ...names.filter((n) => n !== "Today")],
+            ["ShareTo", "Today", ...names.filter((n) => n !== "Today" && n !== "ShareTo")],
+        ];
+        for (const order of orders) {
+            expect([order[0], pick("Client.xcodeproj", order)]).toEqual([order[0], "Fennec"]);
+        }
+    });
+    test("still keeps every scheme in the list", () => {
+        const names = firefoxIos();
+        expect([...rankSchemes(root, "Client.xcodeproj", names)].sort()).toEqual([...names].sort());
+    });
+    // The narrow statement, without the other twelve schemes around it.
+    test("an extension scheme launching the host app is not the app scheme", () => {
+        scheme("Client", "Fennec", { runnable: "Client.app", testable: true });
+        scheme("Client", "Today", { runnable: "Client.app", testable: true, appExtension: true });
+        expect(pick("Client.xcodeproj", ["Today", "Fennec"])).toBe("Fennec");
+    });
+    // Xcode's own word about the target outranks a name coincidence, so it
+    // disqualifies the name-match tier too.
+    test("outranks a scheme named exactly after the project", () => {
+        scheme("Widget", "Widget", { runnable: "Host.app", appExtension: true });
+        scheme("Widget", "HostApp", { runnable: "Host.app", testable: true });
+        expect(pick("Widget.xcodeproj", ["Widget", "HostApp"])).toBe("HostApp");
+    });
+    /**
+     * The attribute is a sufficient signal, not a necessary one — a hand-written
+     * or pre-Xcode-10 scheme may omit it. Its absence must change nothing, or
+     * every scheme that ranked correctly before this could regress.
+     *
+     * `chenqi92/primuse` is the row that makes the point concrete: its `Primuse`
+     * scheme is the real app scheme and builds two widget `.appex` bundles
+     * alongside `Primuse.app`, so "demote anything that builds an extension"
+     * would have taken the wrong one.
+     */
+    test("an untagged app scheme ranks exactly as it did before", () => {
+        scheme("Primuse", "Primuse", { runnable: "Primuse.app", testable: true });
+        scheme("Primuse", "PrimuseWidgets", { runnable: "Primuse.app" });
+        expect(pick("Primuse.xcodeproj", ["PrimuseWidgets", "Primuse"])).toBe("Primuse");
+    });
+    // When every candidate is an extension scheme there is no app scheme to
+    // find. Both land in the bottom tier, nothing is filtered out, and the
+    // pre-existing within-tier rule decides — so the caller still gets a
+    // deterministic answer rather than one that depends on the directory order.
+    test("still answers deterministically when every scheme is an extension", () => {
+        scheme("Client", "ShareTo", { runnable: "ShareTo.appex", appExtension: true });
+        scheme("Client", "Today", { runnable: "Client.app", appExtension: true });
+        for (const order of [
+            ["Today", "ShareTo"],
+            ["ShareTo", "Today"],
+        ]) {
+            expect([order[0], pick("Client.xcodeproj", order)]).toEqual([order[0], "Today"]);
+        }
+        expect(rankSchemes(root, "Client.xcodeproj", ["ShareTo", "Today"])).toHaveLength(2);
+    });
+});
 //# sourceMappingURL=ios-scheme-ranking.test.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@invarn/cibuild",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "CI Build CLI — local pipeline orchestration and validation",
   "type": "module",
   "main": "dist/cli.cjs",