@rsdk/yarn.constraints 6.0.0-next.39 → 6.0.0-next.40

package/__tests__/compatibility.test.ts

@@ -0,0 +1,321 @@
+import { spawnSync } from 'node:child_process';
+import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { resolve } from 'node:path';
+
+// Paths relative to this test file:
+//   __tests__/ -> constraints/ -> packages/ -> monorepo root
+const MONOREPO_ROOT = resolve(__dirname, '../../..');
+const YARN_BIN = resolve(MONOREPO_ROOT, '.yarn/releases/yarn-4.5.3.cjs');
+const YARN_CACHE = resolve(MONOREPO_ROOT, '.yarn/cache');
+// Reuse the main project's tsc instead of installing typescript in each temp monorepo.
+const MAIN_TSC = resolve(MONOREPO_ROOT, 'node_modules/typescript/bin/tsc');
+
+jest.setTimeout(120_000);
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+function yarn(args: string[], cwd: string): string {
+  const r = spawnSync(process.execPath, [YARN_BIN, ...args], {
+    cwd,
+    encoding: 'utf8',
+    stdio: 'pipe',
+    timeout: 90_000,
+  });
+  const output = (r.stdout ?? '') + (r.stderr ?? '');
+
+  if (r.status !== 0 || r.error) {
+    throw new Error(
+      [
+        `yarn ${args.join(' ')} failed in ${cwd}`,
+        `status: ${r.status ?? '<none>'}`,
+        r.signal ? `signal: ${r.signal}` : null,
+        r.error ? `error: ${r.error.message}` : null,
+        'output:',
+        output || '<empty>',
+      ]
+        .filter(Boolean)
+        .join('\n'),
+    );
+  }
+
+  return output;
+}
+
+function tscNoEmit(tsConfigPath: string, cwd: string): { ok: boolean; output: string } {
+  // Use the main project's tsc binary — avoids installing typescript (~48 MiB)
+  // inside each temp monorepo. rxjs types are still resolved from the temp
+  // monorepo's node_modules, so the type-checking result is accurate.
+  const r = spawnSync(process.execPath, [MAIN_TSC, '-p', tsConfigPath], {
+    cwd,
+    encoding: 'utf8',
+    stdio: 'pipe',
+    timeout: 30_000,
+  });
+
+  return { ok: r.status === 0, output: (r.stdout ?? '') + (r.stderr ?? '') };
+}
+
+interface WorkspaceSpec {
+  location: string;
+  manifest: Record<string, unknown>;
+  files?: Record<string, string>;
+}
+
+function createMonorepo(
+  rootManifest: Record<string, unknown>,
+  workspaces: WorkspaceSpec[],
+): { dir: string; cleanup: () => void } {
+  const dir = mkdtempSync(resolve(tmpdir(), 'rsdk-compat-'));
+
+  writeFileSync(
+    resolve(dir, 'package.json'),
+    JSON.stringify(
+      { ...rootManifest, workspaces: workspaces.map((w) => w.location) },
+      null,
+      2,
+    ) + '\n',
+  );
+
+  writeFileSync(
+    resolve(dir, '.yarnrc.yml'),
+    [
+      `yarnPath: "${YARN_BIN}"`,
+      `cacheFolder: "${YARN_CACHE}"`,
+      'enableGlobalCache: false',
+      'nodeLinker: node-modules',
+    ].join('\n') + '\n',
+  );
+
+  for (const { location, manifest, files } of workspaces) {
+    const wsDir = resolve(dir, location);
+    mkdirSync(wsDir, { recursive: true });
+    writeFileSync(resolve(wsDir, 'package.json'), JSON.stringify(manifest, null, 2) + '\n');
+
+    for (const [relPath, content] of Object.entries(files ?? {})) {
+      const abs = resolve(wsDir, relPath);
+      mkdirSync(resolve(abs, '..'), { recursive: true });
+      writeFileSync(abs, content);
+    }
+  }
+
+  return {
+    dir,
+    cleanup: () => {
+      try {
+        rmSync(dir, { recursive: true, force: true });
+      } catch {}
+    },
+  };
+}
+
+function hasMissingPeer(output: string): boolean {
+  // YN0002 = MISSING_PEER_DEPENDENCY warning code in yarn 4.x
+  return output.includes('YN0002');
+}
+
+function hasFailedRequirement(output: string): boolean {
+  // yarn explain peer-requirements marks unmet requirements with ✘ (U+2718)
+  return output.includes('✘');
+}
+
+// ---------------------------------------------------------------------------
+// yarn-install-clean: library peer+dev mirror accepted by yarn
+// ---------------------------------------------------------------------------
+
+describe('compatibility: yarn-install-clean', () => {
+  let installOut: string;
+  let explainOut: string;
+  let cleanup: () => void;
+
+  beforeAll(() => {
+    // Library declares lodash as a peer dependency with a matching dev mirror
+    // (model invariants L1+L2). Service provides lodash in dependencies (P1).
+    const { dir, cleanup: c } = createMonorepo(
+      { private: true, name: '@compat/root' },
+      [
+        {
+          location: 'packages/lib',
+          manifest: {
+            name: '@compat/lib',
+            version: '1.0.0',
+            peerDependencies: { lodash: '^4.17.21' },
+            devDependencies: { lodash: '^4.17.21' },
+          },
+        },
+        {
+          location: 'packages/svc',
+          manifest: {
+            name: '@compat/svc',
+            version: '1.0.0',
+            dependencies: {
+              '@compat/lib': 'workspace:*',
+              lodash: '^4.17.21',
+            },
+          },
+        },
+      ],
+    );
+    cleanup = c;
+    installOut = yarn(['install'], dir);
+    explainOut = yarn(['explain', 'peer-requirements'], dir);
+  });
+
+  afterAll(() => cleanup());
+
+  it('no YN0002 missing-peer warnings on install', () => {
+    expect(hasMissingPeer(installOut)).toBe(false);
+  });
+
+  it('no failed peer requirements after install', () => {
+    expect(hasFailedRequirement(explainOut)).toBe(false);
+  });
+});
+
+// ---------------------------------------------------------------------------
+// yarn-peer-requirements-clean: required external peers propagated to service
+// ---------------------------------------------------------------------------
+
+describe('compatibility: yarn-peer-requirements-clean', () => {
+  let installOut: string;
+  let explainOut: string;
+  let cleanup: () => void;
+
+  beforeAll(() => {
+    // @nestjs/common requires rxjs (required) and reflect-metadata (required).
+    // The model propagates both into service dependencies (invariant P2 + S1).
+    const { dir, cleanup: c } = createMonorepo(
+      { private: true, name: '@compat/root' },
+      [
+        {
+          location: 'packages/svc',
+          manifest: {
+            name: '@compat/svc',
+            version: '1.0.0',
+            dependencies: {
+              '@nestjs/common': '10.4.8',
+              rxjs: '^7.8.1',
+              'reflect-metadata': '^0.1.12 || ^0.2.0',
+            },
+          },
+        },
+      ],
+    );
+    cleanup = c;
+    installOut = yarn(['install'], dir);
+    explainOut = yarn(['explain', 'peer-requirements'], dir);
+  });
+
+  afterAll(() => cleanup());
+
+  it('service with all required peers: no YN0002 on install', () => {
+    expect(hasMissingPeer(installOut)).toBe(false);
+  });
+
+  it('service with all required peers: no failed peer requirements', () => {
+    expect(hasFailedRequirement(explainOut)).toBe(false);
+  });
+});
+
+// ---------------------------------------------------------------------------
+// missing-peer-detected: negative test — proves the assertions are meaningful
+// ---------------------------------------------------------------------------
+
+describe('compatibility: missing-peer-detected (negative)', () => {
+  let installOut: string;
+  let explainOut: string;
+  let cleanup: () => void;
+
+  beforeAll(() => {
+    // Required peers rxjs and reflect-metadata intentionally omitted.
+    const { dir, cleanup: c } = createMonorepo(
+      { private: true, name: '@compat/root' },
+      [
+        {
+          location: 'packages/svc',
+          manifest: {
+            name: '@compat/svc',
+            version: '1.0.0',
+            dependencies: { '@nestjs/common': '10.4.8' },
+          },
+        },
+      ],
+    );
+    cleanup = c;
+    installOut = yarn(['install'], dir);
+    explainOut = yarn(['explain', 'peer-requirements'], dir);
+  });
+
+  afterAll(() => cleanup());
+
+  it('missing required peers: yarn install reports YN0002', () => {
+    expect(hasMissingPeer(installOut)).toBe(true);
+  });
+
+  it('missing required peers: yarn explain peer-requirements reports failure', () => {
+    expect(hasFailedRequirement(explainOut)).toBe(true);
+  });
+});
+
+// ---------------------------------------------------------------------------
+// tsc-library-build: library with peer+dev mirror compiles without errors
+// ---------------------------------------------------------------------------
+
+describe('compatibility: tsc-library-build', () => {
+  let result: { ok: boolean; output: string };
+  let cleanup: () => void;
+
+  beforeAll(() => {
+    // Library imports rxjs (which ships with bundled types). After install the
+    // dev mirror (devDependencies = peerDependencies) makes rxjs available for
+    // tsc without any additional @types packages.
+    const { dir, cleanup: c } = createMonorepo(
+      { private: true, name: '@compat/root' },
+      [
+        {
+          location: 'packages/lib',
+          manifest: {
+            name: '@compat/lib',
+            version: '1.0.0',
+            peerDependencies: { rxjs: '^7.8.1' },
+            devDependencies: { rxjs: '^7.8.1' },
+          },
+          files: {
+            'src/index.ts': [
+              "import { Observable } from 'rxjs';",
+              'export type Obs<T> = Observable<T>;',
+              '',
+            ].join('\n'),
+            'tsconfig.json': JSON.stringify(
+              {
+                compilerOptions: {
+                  strict: true,
+                  noEmit: true,
+                  module: 'commonjs',
+                  target: 'es2020',
+                },
+                include: ['src/**/*.ts'],
+              },
+              null,
+              2,
+            ) + '\n',
+          },
+        },
+      ],
+    );
+    cleanup = c;
+    yarn(['install'], dir);
+    result = tscNoEmit('packages/lib/tsconfig.json', dir);
+  });
+
+  afterAll(() => cleanup());
+
+  it('library with peer+dev mirror (rxjs): tsc type-checks without errors', () => {
+    if (result.output.includes('error TS')) {
+      throw new Error(`tsc failed:\n${result.output}`);
+    }
+    expect(result.ok).toBe(true);
+  });
+});