@astryxdesign/cli 0.6.3 → 0.6.4-canary.06c8fa3

package/api/upgrade/project-context.test.mjs

@@ -0,0 +1,272 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file `loadProjectContext` agrees with Project on provider identity, so
+ * `astryx upgrade` never runs codemods from a package Project set aside.
+ *
+ * Fixtures live under a repo-local temp dir, not /tmp, because Vite refuses to
+ * dynamically import a module from outside the project root.
+ */
+
+import {afterEach, beforeEach, describe, expect, it} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import {loadProjectContext, selectIntegrationCodemodsFor} from './_adapter.mjs';
+
+let tmpDir;
+let originalCwd;
+
+beforeEach(() => {
+  originalCwd = process.cwd();
+  tmpDir = fs.mkdtempSync(path.join(process.cwd(), '.astryx-upgrade-context-'));
+});
+
+afterEach(() => {
+  process.chdir(originalCwd);
+  fs.rmSync(tmpDir, {recursive: true, force: true});
+});
+
+/**
+ * Install an integration package that ships one 0.2.0 codemod.
+ * @param {string} name
+ * @param {string} version
+ * @param {Record<string, unknown>} [manifest]
+ */
+function installWithCodemod(name, version, manifest = {}) {
+  const pkgDir = path.join(tmpDir, 'node_modules', ...name.split('/'));
+  const codemodDir = path.join(pkgDir, 'codemods', '0.2.0');
+  fs.mkdirSync(codemodDir, {recursive: true});
+  fs.writeFileSync(path.join(pkgDir, 'package.json'), JSON.stringify({name, version}));
+  fs.writeFileSync(
+    path.join(pkgDir, 'astryx.integration.mjs'),
+    `export default ${JSON.stringify({codemods: './codemods', ...manifest})};\n`,
+  );
+  fs.writeFileSync(
+    path.join(codemodDir, 'rename.mjs'),
+    "export default {type: 'code', title: 'Rename', transform: file => file.source};\n",
+  );
+}
+
+/** @param {string[]} integrations */
+function configure(integrations) {
+  fs.writeFileSync(
+    path.join(tmpDir, 'astryx.config.mjs'),
+    `export default ${JSON.stringify({integrations})};\n`,
+  );
+}
+
+describe('loadProjectContext provider identity', () => {
+  it('keeps codemods from a configured package the authored package sets aside', async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    configure(['@acme/widgets']);
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: '@acme/renamed', version: '2.0.0-dev'}),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {providerId: '@acme/widgets'};\n",
+    );
+
+    const {integrations} = await loadProjectContext(tmpDir);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        Boolean(integration.__providerConflict),
+      ]),
+    ).toEqual([['@acme/widgets', true]]);
+    expect(
+      await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0'),
+    ).toEqual([]);
+  });
+
+  it('still selects codemods from a configured package nothing else claims', async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    configure(['@acme/widgets']);
+    fs.writeFileSync(path.join(tmpDir, 'package.json'), JSON.stringify({name: 'consumer'}));
+
+    const {integrations} = await loadProjectContext(tmpDir);
+    const selected = await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0');
+    expect(selected.map(entry => entry.version)).toEqual(['0.2.0']);
+  });
+
+  it('sets aside an --integration extra that claims a configured provider ID', async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    installWithCodemod('@acme/other', '1.0.0', {providerId: '@acme/widgets'});
+    configure(['@acme/widgets']);
+    fs.writeFileSync(path.join(tmpDir, 'package.json'), JSON.stringify({name: 'consumer'}));
+    // `--integration` specs resolve from the process cwd, as they always have.
+    process.chdir(tmpDir);
+
+    const {integrations} = await loadProjectContext(tmpDir, ['@acme/other']);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.__providerConflict?.claimedBy ?? null,
+      ]),
+    ).toEqual([
+      ['@acme/widgets', null],
+      ['@acme/other', '@acme/widgets'],
+    ]);
+  });
+
+  it('runs the installed copy of a package that lists itself, not its work in progress', async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    configure(['@acme/widgets']);
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: '@acme/widgets', version: '3.0.0-dev'}),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {codemods: './codemods'};\n",
+    );
+    fs.mkdirSync(path.join(tmpDir, 'codemods', '0.2.0'), {recursive: true});
+    fs.writeFileSync(
+      path.join(tmpDir, 'codemods', '0.2.0', 'local-wip.mjs'),
+      "export default {type: 'code', title: 'Local WIP', transform: file => file.source};\n",
+    );
+
+    const {integrations} = await loadProjectContext(tmpDir);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.version,
+        Boolean(integration.__local),
+        Boolean(integration.__providerConflict),
+      ]),
+    ).toEqual([['@acme/widgets', '1.0.0', false, false]]);
+    const selected = JSON.stringify(
+      await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0'),
+    );
+    expect(selected).toContain('rename');
+    expect(selected).not.toContain('local-wip');
+  });
+
+  it('runs the installed copy when the authored package is named with --integration', async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    configure([]);
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: '@acme/widgets', version: '3.0.0-dev'}),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {codemods: './codemods'};\n",
+    );
+    fs.mkdirSync(path.join(tmpDir, 'codemods', '0.2.0'), {recursive: true});
+    fs.writeFileSync(
+      path.join(tmpDir, 'codemods', '0.2.0', 'local-wip.mjs'),
+      "export default {type: 'code', title: 'Local WIP', transform: file => file.source};\n",
+    );
+    process.chdir(tmpDir);
+
+    const {integrations} = await loadProjectContext(tmpDir, ['@acme/widgets']);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.version,
+        Boolean(integration.__local),
+        integration.__providerConflict?.claimedBy ?? null,
+      ]),
+    ).toEqual([['@acme/widgets', '1.0.0', false, null]]);
+    const selected = JSON.stringify(
+      await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0'),
+    );
+    expect(selected).toContain('rename');
+    expect(selected).not.toContain('local-wip');
+  });
+
+  it("sets aside an --integration extra that claims an autolinked package's ID", async () => {
+    installWithCodemod('@acme/a', '1.0.0');
+    installWithCodemod('@acme/b', '1.0.0', {providerId: '@acme/a'});
+    configure([]);
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: 'consumer', dependencies: {'@acme/a': '1.0.0'}}),
+    );
+    process.chdir(tmpDir);
+
+    const {integrations} = await loadProjectContext(tmpDir, ['@acme/b']);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.__providerConflict?.claimedBy ?? null,
+      ]),
+    ).toEqual([['@acme/b', '@acme/a']]);
+    expect(
+      await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0'),
+    ).toEqual([]);
+  });
+
+  it('runs an autolinked package the user names with --integration', async () => {
+    installWithCodemod('@acme/a', '1.0.0');
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: 'consumer', dependencies: {'@acme/a': '1.0.0'}}),
+    );
+    process.chdir(tmpDir);
+
+    const {integrations} = await loadProjectContext(tmpDir, ['@acme/a']);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.__providerConflict?.claimedBy ?? null,
+      ]),
+    ).toEqual([['@acme/a', null]]);
+    const selected = await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0');
+    expect(selected.map(entry => entry.version)).toEqual(['0.2.0']);
+  });
+
+  it('never reports a claimant that every other command uses as set aside', async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    installWithCodemod('@acme/renamed', '2.0.0', {providerId: '@acme/widgets'});
+    configure(['@acme/widgets']);
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({
+        name: '@acme/widgets',
+        version: '3.0.0-dev',
+        dependencies: {'@acme/renamed': '2.0.0'},
+      }),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {providerId: '@acme/widgets-next'};\n",
+    );
+
+    const {integrations} = await loadProjectContext(tmpDir);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.version,
+        integration.__providerConflict?.claimedBy ?? null,
+      ]),
+    ).toEqual([['@acme/widgets', '1.0.0', null]]);
+  });
+
+  it("sets aside an --integration extra that claims the authored package's ID", async () => {
+    installWithCodemod('@acme/widgets', '1.0.0');
+    configure([]);
+    fs.writeFileSync(
+      path.join(tmpDir, 'package.json'),
+      JSON.stringify({name: '@acme/renamed', version: '2.0.0-dev'}),
+    );
+    fs.writeFileSync(
+      path.join(tmpDir, 'astryx.integration.mjs'),
+      "export default {providerId: '@acme/widgets'};\n",
+    );
+    process.chdir(tmpDir);
+
+    const {integrations} = await loadProjectContext(tmpDir, ['@acme/widgets']);
+    expect(
+      integrations.map(integration => [
+        integration.name,
+        integration.__providerConflict?.claimedBy ?? null,
+      ]),
+    ).toEqual([['@acme/widgets', '@acme/renamed']]);
+    expect(
+      await selectIntegrationCodemodsFor(integrations, '0.1.0', '0.3.0'),
+    ).toEqual([]);
+  });
+});

package/api/upgrade/provider-agreement.test.mjs

@@ -0,0 +1,152 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file Where `upgrade` and Project still disagree on a provider ID's winner.
+ *
+ * Both repros are `it.fails`: each asserts the agreeing result, and fails
+ * today. `upgrade` lets an `--integration` extra of the same name@version stand
+ * in for an autolinked package, from any directory, and orders that extra with
+ * the extras. So another extra can take the provider ID in `upgrade` while
+ * every other command gives it to the autolinked package. The provider ledger
+ * property test carves out exactly this shape.
+ *
+ * Fixtures live under a repo-local temp dir, not /tmp, because Vite refuses to
+ * dynamically import a module from outside the project root.
+ */
+
+import {afterEach, beforeEach, describe, expect, it} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import {loadProjectContext} from './_adapter.mjs';
+import {Project, providerLedgerOf} from '../../foundation/config/project.mjs';
+
+let tmpDir;
+let originalCwd;
+
+beforeEach(() => {
+  originalCwd = process.cwd();
+  tmpDir = fs.mkdtempSync(
+    path.join(process.cwd(), '.astryx-upgrade-agreement-'),
+  );
+  process.chdir(tmpDir);
+});
+
+afterEach(() => {
+  process.chdir(originalCwd);
+  fs.rmSync(tmpDir, {recursive: true, force: true});
+});
+
+/**
+ * Install a package under node_modules/<dir>.
+ * @param {string} dir
+ * @param {{name: string, version: string}} pkg
+ * @param {string} manifest manifest module source
+ */
+function install(dir, pkg, manifest) {
+  const pkgDir = path.join(tmpDir, 'node_modules', ...dir.split('/'));
+  fs.mkdirSync(pkgDir, {recursive: true});
+  fs.writeFileSync(path.join(pkgDir, 'package.json'), JSON.stringify(pkg));
+  fs.writeFileSync(path.join(pkgDir, 'astryx.integration.mjs'), manifest);
+}
+
+/** An autolinked `@acme/a` and an `@acme/other` that claims its provider ID. */
+function autolinkedWithRival() {
+  fs.writeFileSync(
+    path.join(tmpDir, 'package.json'),
+    JSON.stringify({name: 'consumer', dependencies: {'@acme/a': '1.0.0'}}),
+  );
+  install(
+    '@acme/a',
+    {name: '@acme/a', version: '1.0.0'},
+    'export default {};\n',
+  );
+  install(
+    '@acme/other',
+    {name: '@acme/other', version: '1.0.0'},
+    "export default {providerId: '@acme/a'};\n",
+  );
+}
+
+/**
+ * The package each resolution lets contribute under a provider ID.
+ * @param {Map<string, any>} ledger
+ * @param {string} providerId
+ */
+function winnerOf(ledger, providerId) {
+  return [...ledger.values()].find(
+    entry => entry.outcome === 'contributes' && entry.providerId === providerId,
+  )?.key;
+}
+
+/** @param {Array<import('../../foundation/integrations/integrations.mjs').LoadedIntegration>} integrations */
+function claims(integrations) {
+  return integrations.map(integration => [
+    integration.name,
+    integration.__providerConflict?.claimedBy ?? null,
+  ]);
+}
+
+describe('upgrade and Project on an autolinked package named with --integration', () => {
+  it('agree when the autolinked package is named first', async () => {
+    autolinkedWithRival();
+    const project = await Project.load(tmpDir, {fresh: true});
+    const upgrade = await loadProjectContext(tmpDir, [
+      '@acme/a',
+      '@acme/other',
+    ]);
+
+    expect(claims(upgrade.integrations)).toEqual([
+      ['@acme/a', null],
+      ['@acme/other', '@acme/a'],
+    ]);
+    expect(winnerOf(upgrade.ledger, '@acme/a')).toBe(
+      winnerOf(providerLedgerOf(project), '@acme/a'),
+    );
+  });
+
+  it.fails(
+    'agree when an extra that claims its ID is named first',
+    async () => {
+      autolinkedWithRival();
+      const project = await Project.load(tmpDir, {fresh: true});
+      // Today upgrade runs @acme/other and reports @acme/a, which every other
+      // command uses, as contributing nothing.
+      const upgrade = await loadProjectContext(tmpDir, [
+        '@acme/other',
+        '@acme/a',
+      ]);
+
+      expect(winnerOf(upgrade.ledger, '@acme/a')).toBe(
+        winnerOf(providerLedgerOf(project), '@acme/a'),
+      );
+      expect(claims(upgrade.integrations)).toEqual([
+        ['@acme/other', '@acme/a'],
+        ['@acme/a', null],
+      ]);
+    },
+  );
+
+  it.fails(
+    'agree when a copy of it in another directory is named',
+    async () => {
+      autolinkedWithRival();
+      // The same name@version in another directory, with a manifest that fails.
+      install(
+        '@acme/a-copy',
+        {name: '@acme/a', version: '1.0.0'},
+        "throw new Error('broken copy');\n",
+      );
+      const project = await Project.load(tmpDir, {fresh: true});
+      // Today the broken copy stands in for @acme/a by name@version, so upgrade
+      // has no claimant left for the ID and @acme/other takes it.
+      const upgrade = await loadProjectContext(tmpDir, [
+        '@acme/a-copy',
+        '@acme/other',
+      ]);
+
+      expect(winnerOf(upgrade.ledger, '@acme/a')).toBe(
+        winnerOf(providerLedgerOf(project), '@acme/a'),
+      );
+    },
+  );
+});

package/api/upgrade/run/files-changed.test.mjs

@@ -0,0 +1,111 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file The upgrade receipt counts a file once when a core codemod AND an
+ * integration codemod both change it: `filesChanged` is the union of the two
+ * runners' files, while `transformsApplied` adds their changes.
+ *
+ * Uses a real consumer under a repo-local temp dir (Vite blocks dynamic import
+ * of config and integration modules from /tmp), the real core registry, and an
+ * installed integration whose code codemod stamps the same file.
+ */
+
+import {describe, it, expect, afterEach} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import {upgrade} from '../upgrade.mjs';
+import {
+  latestVersion,
+  versions,
+  getTransformsBetween,
+} from '../../../assets/codemods/registry.mjs';
+
+const SLOW = 60_000;
+
+/** The registry version whose manifest ships the authoring migration. */
+async function authoringTier() {
+  const all = await getTransformsBetween('0.0.0', latestVersion);
+  const tier = all.find(({transforms}) =>
+    transforms.some(t => t.name === 'migrate-authoring-imports'),
+  );
+  if (!tier) throw new Error('no registry version ships the authoring migration');
+  return tier.version;
+}
+
+/**
+ * A consumer with installed core at the registry's latest version and one
+ * old-surface file that the core authoring codemods rewrite.
+ * @param {string} dir
+ * @param {{integrationCodemod: boolean}} options
+ */
+function seed(dir, {integrationCodemod}) {
+  fs.writeFileSync(
+    path.join(dir, 'package.json'),
+    JSON.stringify({name: 'consumer', version: '1.0.0'}),
+  );
+  const core = path.join(dir, 'node_modules', '@astryxdesign', 'core');
+  fs.mkdirSync(core, {recursive: true});
+  fs.writeFileSync(
+    path.join(core, 'package.json'),
+    JSON.stringify({name: '@astryxdesign/core', version: latestVersion}),
+  );
+  fs.mkdirSync(path.join(dir, 'src'), {recursive: true});
+  fs.writeFileSync(
+    path.join(dir, 'src', 'Button.doc.mjs'),
+    [
+      "import {createComponentDoc} from '@astryxdesign/core/authoring';",
+      "export default createComponentDoc({name: 'Button', props: []});",
+      '',
+    ].join('\n'),
+  );
+  if (!integrationCodemod) return;
+  fs.writeFileSync(
+    path.join(dir, 'astryx.config.mjs'),
+    "export default {integrations: ['@acme/widgets']};\n",
+  );
+  const pkg = path.join(dir, 'node_modules', '@acme', 'widgets');
+  fs.mkdirSync(path.join(pkg, 'codemods', latestVersion), {recursive: true});
+  fs.writeFileSync(
+    path.join(pkg, 'package.json'),
+    JSON.stringify({name: '@acme/widgets', version: '1.0.0'}),
+  );
+  fs.writeFileSync(
+    path.join(pkg, 'astryx.integration.mjs'),
+    "export default {codemods: './codemods'};\n",
+  );
+  fs.writeFileSync(
+    path.join(pkg, 'codemods', latestVersion, 'acme-stamp.mjs'),
+    "export default {type: 'code', title: 'Stamp', transform: file => (file.source.includes('// acme') ? null : `${file.source}// acme\\n`)};\n",
+  );
+}
+
+describe('upgrade receipt — filesChanged across core and integration codemods', () => {
+  /** @type {string[]} */
+  const dirs = [];
+  afterEach(() => {
+    for (const dir of dirs.splice(0)) fs.rmSync(dir, {recursive: true, force: true});
+  });
+
+  /** @param {{integrationCodemod: boolean}} options */
+  async function run(options) {
+    const dir = fs.mkdtempSync(path.join(process.cwd(), '.astryx-files-changed-'));
+    dirs.push(dir);
+    seed(dir, options);
+    const tier = await authoringTier();
+    const from = versions[versions.indexOf(tier) - 1];
+    const res = await upgrade({from, path: 'src'}, {cwd: dir});
+    expect(res.type).toBe('upgrade.run');
+    return res.data;
+  }
+
+  it('counts a file changed by both a core and an integration codemod once', async () => {
+    const coreOnly = await run({integrationCodemod: false});
+    expect(coreOnly.filesChanged).toBe(1);
+    expect(coreOnly.transformsApplied).toBeGreaterThan(0);
+
+    const both = await run({integrationCodemod: true});
+    expect(both.integrations).toEqual(['@acme/widgets']);
+    expect(both.filesChanged).toBe(1);
+    expect(both.transformsApplied).toBe(coreOnly.transformsApplied + 1);
+  }, SLOW);
+});