@restforgejs/platform 4.1.1 → 4.3.1

package/generators/tests/unit/cli/create-dashboard.test.js

@@ -1,505 +0,0 @@
-'use strict';
-
-const test = require('node:test');
-const assert = require('node:assert');
-const fs = require('node:fs');
-const path = require('node:path');
-const os = require('node:os');
-const { spawnSync } = require('node:child_process');
-
-const REPO_ROOT = path.resolve(__dirname, '..', '..', '..');
-const CLI_SCRIPT = path.join(REPO_ROOT, 'cli', 'create-dashboard.js');
-
-const SAMPLE_PAYLOAD_PATH = path.resolve(
-  REPO_ROOT,
-  '..',
-  'restforge',
-  'docs',
-  'architecture',
-  'dashboard-architecture',
-  'payload',
-  'dashboard-sales.json'
-);
-const SAMPLE_PAYLOAD_DIR = path.dirname(SAMPLE_PAYLOAD_PATH);
-const SAMPLE_QUERY_DIR = path.join(SAMPLE_PAYLOAD_DIR, 'query');
-
-/**
- * Buat tmp working dir lengkap dengan payload dashboard sample plus
- * 4 file SQL referensi. Mengembalikan absolute path ke direktori tmp.
- */
-function setupTmpProject() {
-  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'rf-dash-cli-'));
-  const tmpPayloadDir = path.join(tmpDir, 'payload');
-  const tmpQueryDir = path.join(tmpPayloadDir, 'query');
-  fs.mkdirSync(tmpQueryDir, { recursive: true });
-
-  fs.copyFileSync(
-    SAMPLE_PAYLOAD_PATH,
-    path.join(tmpPayloadDir, 'dashboard-sales.json')
-  );
-  for (const sqlFile of fs.readdirSync(SAMPLE_QUERY_DIR)) {
-    fs.copyFileSync(
-      path.join(SAMPLE_QUERY_DIR, sqlFile),
-      path.join(tmpQueryDir, sqlFile)
-    );
-  }
-
-  return tmpDir;
-}
-
-function cleanupTmpProject(tmpDir) {
-  try {
-    fs.rmSync(tmpDir, { recursive: true, force: true });
-  } catch (err) {
-    // Best-effort cleanup.
-  }
-}
-
-function runCli(args, cwd) {
-  return spawnSync(process.execPath, [CLI_SCRIPT, ...args], {
-    cwd,
-    encoding: 'utf-8',
-    env: { ...process.env, NODE_ENV: 'test' }
-  });
-}
-
-// ===== Happy path =====
-
-test('happy path: argv valid menghasilkan file main module + dash module + registry update', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.strictEqual(result.status, 0, `CLI exit non-zero: ${result.stderr}`);
-
-    const mainModulePath = path.join(tmpDir, 'src', 'modules', 'mini-inventory.js');
-    assert.strictEqual(
-      fs.existsSync(mainModulePath),
-      true,
-      'main module mini-inventory.js harus terbentuk'
-    );
-
-    const dashModulePath = path.join(
-      tmpDir, 'src', 'modules', 'mini-inventory', 'dash-sales.js'
-    );
-    assert.strictEqual(
-      fs.existsSync(dashModulePath),
-      true,
-      'dashboard module dash-sales.js harus terbentuk'
-    );
-
-    const registryPath = path.join(tmpDir, '.restforge', 'projects.json');
-    assert.strictEqual(
-      fs.existsSync(registryPath),
-      true,
-      'registry projects.json harus terbentuk'
-    );
-
-    const registry = JSON.parse(fs.readFileSync(registryPath, 'utf8'));
-    assert.ok(
-      registry.projects && registry.projects['mini-inventory'],
-      'registry harus mengandung project mini-inventory'
-    );
-    assert.ok(
-      Array.isArray(registry.projects['mini-inventory'].endpoints),
-      'project entry harus punya endpoints array'
-    );
-    assert.ok(
-      registry.projects['mini-inventory'].endpoints.includes('dash-sales'),
-      "registry endpoints harus mengandung 'dash-sales'"
-    );
-
-    const metadataPath = path.join(tmpDir, 'metadata', 'mini-inventory.json');
-    assert.ok(fs.existsSync(metadataPath), 'metadata file harus dibuat');
-    const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf8'));
-    assert.ok('dash-sales' in metadata.endpoints, 'metadata harus berisi entry dash-sales');
-    assert.strictEqual(metadata.endpoints['dash-sales'].type, 'dashboard');
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Missing arguments =====
-
-test('missing --project: exit non-zero dan pesan error menyebut --project', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(result.stdout + result.stderr, /--project/);
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('missing --name: exit non-zero dan pesan error menyebut --name', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(result.stdout + result.stderr, /--name/);
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('missing --payload: exit non-zero dan pesan error menyebut --payload', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(result.stdout + result.stderr, /--payload/);
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Name prefix validation =====
-
-test('--name tanpa prefix dash- ditolak: exit non-zero dan pesan error menyebut prefix', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(result.stdout + result.stderr, /dash-/);
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('--name hanya dash- (suffix kosong) ditolak: exit non-zero', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(result.stdout + result.stderr, /suffix/);
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Payload file missing =====
-
-test('payload file tidak ada: exit non-zero dan pesan error menyebut nama file', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=does-not-exist'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(result.stdout + result.stderr, /does-not-exist/);
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Payload tidak valid =====
-
-test('payload tidak valid (mengandung tableName): exit non-zero dan pesan error dari validator', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const badPayload = {
-      tableName: 'should_not_be_here',
-      widgets: [{ id: 'w1', query: 'file:query/author-sales.sql' }]
-    };
-    fs.writeFileSync(
-      path.join(tmpDir, 'payload', 'invalid-dashboard.json'),
-      JSON.stringify(badPayload)
-    );
-
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=invalid-dashboard'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0);
-    assert.match(
-      result.stdout + result.stderr,
-      /tableName/,
-      'pesan error harus menyebut tableName (validator membatalkan payload dashboard berisi tableName)'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Force overwrite =====
-
-test('force overwrite: file dashboard module sudah ada, --force=true → success dan file lama di-archive', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const firstRun = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-    assert.strictEqual(firstRun.status, 0, `first run gagal: ${firstRun.stderr}`);
-
-    const moduleDir = path.join(tmpDir, 'src', 'modules', 'mini-inventory');
-    const liveFile = path.join(moduleDir, 'dash-sales.js');
-    assert.strictEqual(fs.existsSync(liveFile), true);
-
-    const secondRun = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales',
-      '--force=true'
-    ], tmpDir);
-    assert.strictEqual(secondRun.status, 0, `force run gagal: ${secondRun.stderr}`);
-
-    const files = fs.readdirSync(moduleDir);
-    const archived = files.filter((f) => f.startsWith('dash-sales.js.archive.'));
-    assert.ok(
-      archived.length >= 1,
-      'minimal satu file archive harus terbuat saat force overwrite'
-    );
-    assert.strictEqual(
-      fs.existsSync(liveFile),
-      true,
-      'live file dash-sales.js harus tetap ada setelah overwrite'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Output content sanity =====
-
-// ===== Database propagation =====
-
-test('database propagation: --database=mysql → dashboard module emit const dialect = mysql dan require db-mysql', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory-mysql',
-      '--name=dash-sales',
-      '--payload=dashboard-sales',
-      '--database=mysql'
-    ], tmpDir);
-
-    assert.strictEqual(result.status, 0, `CLI exit non-zero: ${result.stderr}`);
-
-    const dashModulePath = path.join(
-      tmpDir, 'src', 'modules', 'mini-inventory-mysql', 'dash-sales.js'
-    );
-    const content = fs.readFileSync(dashModulePath, 'utf8');
-    assert.ok(
-      content.includes("const dialect = 'mysql';"),
-      "output dashboard module harus emit const dialect = 'mysql'"
-    );
-    assert.ok(
-      content.includes("require('restforgejs/src/utils/db-mysql')"),
-      'output dashboard module harus require db-mysql'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('database propagation: --database=sqlite (tidak didukung dashboard) → exit non-zero dengan pesan error sqlite', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory-sqlite',
-      '--name=dash-sales',
-      '--payload=dashboard-sales',
-      '--database=sqlite'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0, 'CLI harus exit non-zero saat database=sqlite');
-    assert.match(
-      result.stdout + result.stderr,
-      /sqlite/i,
-      'pesan error harus menyebut sqlite'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('output content sanity: dash-sales.js mengandung SQL fragment dari fixture', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-    assert.strictEqual(result.status, 0, `CLI exit non-zero: ${result.stderr}`);
-
-    const dashModulePath = path.join(
-      tmpDir, 'src', 'modules', 'mini-inventory', 'dash-sales.js'
-    );
-    const content = fs.readFileSync(dashModulePath, 'utf8');
-
-    assert.ok(
-      content.includes('country AS label'),
-      'fragment SQL author-sales harus muncul di output'
-    );
-    assert.ok(
-      content.includes('product_name AS label'),
-      'fragment SQL sales-statistics harus muncul di output'
-    );
-    assert.ok(
-      content.includes("router.post('/dashboard'"),
-      'output harus emit router.post handler /dashboard'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-// ===== Cache cross-reference (orchestrator → validator options) =====
-
-/**
- * Tulis ulang payload dashboard-sales.json dengan blok cache tambahan.
- * Membuktikan orchestrator meneruskan options.projectName + options.metadataDir
- * ke validator, karena cross-reference path hanya aktif saat
- * cache.enabled=true && invalidates non-empty.
- */
-function writeCachePayload(tmpDir, cacheBlock) {
-  const payloadPath = path.join(tmpDir, 'payload', 'dashboard-sales.json');
-  const base = JSON.parse(fs.readFileSync(payloadPath, 'utf8'));
-  base.cache = cacheBlock;
-  fs.writeFileSync(payloadPath, JSON.stringify(base, null, 2));
-}
-
-/**
- * Tulis metadata fixture sederhana dengan endpoint module CRUD untuk
- * tabel-tabel yang dirujuk SQL widget. Membuktikan cross-reference berhasil
- * ketika invalidates declarative match dengan tabel yang ada di metadata.
- */
-function writeMetadataFixture(tmpDir, projectName, tables) {
-  const metaDir = path.join(tmpDir, 'metadata');
-  fs.mkdirSync(metaDir, { recursive: true });
-  const endpoints = {};
-  for (const t of tables) {
-    endpoints[t] = {
-      version: '2.0.0',
-      type: 'module',
-      tableName: t,
-      path: `src/modules/${projectName}/${t}.js`
-    };
-  }
-  fs.writeFileSync(
-    path.join(metaDir, `${projectName}.json`),
-    JSON.stringify({ project: projectName, endpoints }, null, 2)
-  );
-}
-
-test('cache cross-reference: validator dipanggil dengan options.projectName — metadata absent + invalidates non-empty → error menyebut metadata path', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    writeCachePayload(tmpDir, {
-      enabled: true,
-      ttl: 300,
-      invalidates: ['sales', 'order_items']
-    });
-
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.notStrictEqual(result.status, 0, 'CLI harus exit non-zero saat metadata tidak ada');
-    const combined = result.stdout + result.stderr;
-    assert.match(
-      combined,
-      /metadata\/mini-inventory\.json/,
-      'pesan error harus menyebut metadata/{projectName}.json — bukti orchestrator pass options.projectName=args.project'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('cache cross-reference: validator dipanggil dengan options.metadataDir=cwd/metadata — happy path success', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    writeCachePayload(tmpDir, {
-      enabled: true,
-      ttl: 300,
-      invalidates: ['sales', 'order_items']
-    });
-    writeMetadataFixture(tmpDir, 'mini-inventory', ['sales', 'order_items']);
-
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.strictEqual(
-      result.status,
-      0,
-      `CLI gagal padahal cross-reference seharusnya pass: ${result.stderr}`
-    );
-
-    const dashModulePath = path.join(
-      tmpDir, 'src', 'modules', 'mini-inventory', 'dash-sales.js'
-    );
-    assert.ok(fs.existsSync(dashModulePath), 'dashboard module harus tetap ter-generate');
-    const content = fs.readFileSync(dashModulePath, 'utf8');
-    assert.ok(
-      content.includes("require('restforgejs/src/utils/cache-manager')"),
-      'output handler harus emit cache-manager require (cache.enabled=true)'
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});
-
-test('cache cross-reference: cache.enabled=false → cross-reference di-skip walau metadata absent', () => {
-  const tmpDir = setupTmpProject();
-  try {
-    writeCachePayload(tmpDir, {
-      enabled: false,
-      invalidates: ['sales']
-    });
-
-    const result = runCli([
-      '--project=mini-inventory',
-      '--name=dash-sales',
-      '--payload=dashboard-sales'
-    ], tmpDir);
-
-    assert.strictEqual(
-      result.status,
-      0,
-      `CLI gagal padahal cache disabled seharusnya skip cross-reference: ${result.stderr}`
-    );
-  } finally {
-    cleanupTmpProject(tmpDir);
-  }
-});