orchid-orm 1.5.29 → 1.5.31

package/src/bin/init.test.ts

@@ -1,810 +0,0 @@
-import { initOrchidORM } from './init';
-import fs from 'fs/promises';
-import { asMock } from '../codegen/testUtils';
-import path from 'path';
-
-jest.mock('https', () => ({
-  get(
-    this: { result: string },
-    _: string,
-    cb: (res: {
-      on(event: string, cb: (chunk?: string) => void): void;
-    }) => void,
-  ) {
-    cb({
-      on: (event: string, cb: (chunk?: string) => void) => {
-        if (event === 'data') {
-          cb(`{"version":"1.2.3"}`);
-        } else if (event === 'end') {
-          cb();
-        }
-      },
-    });
-  },
-}));
-
-jest.mock('fs/promises', () => ({
-  readFile: jest.fn(),
-  writeFile: jest.fn(),
-  mkdir: jest.fn(),
-}));
-
-class EnoentError extends Error {
-  code = 'ENOENT';
-}
-
-const packageJSONPath = path.resolve(process.cwd(), 'package.json');
-const tsConfigPath = path.resolve(process.cwd(), 'tsconfig.json');
-const envPath = path.resolve(process.cwd(), '.env');
-const gitignorePath = path.resolve(process.cwd(), '.gitignore');
-const dbDirPath = path.resolve(process.cwd(), 'src', 'db');
-const baseTablePath = path.resolve(dbDirPath, 'baseTable.ts');
-const tablesDir = path.resolve(dbDirPath, 'tables');
-const postTablePath = path.resolve(tablesDir, 'post.table.ts');
-const commentTablePath = path.resolve(tablesDir, 'comment.table.ts');
-const configPath = path.join(dbDirPath, 'config.ts');
-const dbPath = path.join(dbDirPath, 'db.ts');
-const migrationScriptPath = path.join(dbDirPath, 'dbScripts.ts');
-const migrationsPath = path.join(dbDirPath, 'migrations');
-const seedPath = path.join(dbDirPath, 'seed.ts');
-
-console.log = jest.fn();
-
-describe('initOrchidORM', () => {
-  beforeEach(jest.clearAllMocks);
-
-  it('should create db directory', async () => {
-    await initOrchidORM({});
-
-    expect(fs.mkdir).toBeCalledWith(dbDirPath, { recursive: true });
-  });
-
-  describe('package.json', () => {
-    const packageJSONWithoutAdditional = `{
-  "scripts": {
-    "db": "ts-node src/db/dbScripts.ts"
-  },
-  "dependencies": {
-    "dotenv": "^1.2.3",
-    "orchid-orm": "^1.2.3",
-    "pqb": "^1.2.3",
-    "pg": "^1.2.3"
-  },
-  "devDependencies": {
-    "rake-db": "^1.2.3",
-    "@swc/core": "^1.2.3",
-    "@types/node": "^1.2.3",
-    "ts-node": "^1.2.3",
-    "typescript": "^1.2.3"
-  }
-}
-`;
-
-    const fullPackageJSON = `{
-  "scripts": {
-    "db": "ts-node src/db/dbScripts.ts"
-  },
-  "dependencies": {
-    "dotenv": "^1.2.3",
-    "orchid-orm": "^1.2.3",
-    "pqb": "^1.2.3",
-    "pg": "^1.2.3",
-    "orchid-orm-schema-to-zod": "^1.2.3"
-  },
-  "devDependencies": {
-    "rake-db": "^1.2.3",
-    "orchid-orm-test-factory": "^1.2.3",
-    "@swc/core": "^1.2.3",
-    "@types/node": "^1.2.3",
-    "ts-node": "^1.2.3",
-    "typescript": "^1.2.3"
-  }
-}
-`;
-
-    it('should create package.json if not exist', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('package.json')) {
-          throw new EnoentError();
-        }
-      });
-
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === packageJSONPath,
-      );
-      expect(content).toBe(packageJSONWithoutAdditional);
-    });
-
-    it('should create package.json with additional deps if not exist', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('package.json')) {
-          throw new EnoentError();
-        }
-      });
-
-      await initOrchidORM({
-        addSchemaToZod: true,
-        addTestFactory: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === packageJSONPath,
-      );
-      expect(content).toBe(fullPackageJSON);
-    });
-
-    it('should add scripts, dependencies and devDependencies if they are not present in package.json', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('package.json')) {
-          return '{}';
-        }
-        return;
-      });
-
-      await initOrchidORM({
-        addSchemaToZod: true,
-        addTestFactory: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === packageJSONPath,
-      );
-      expect(content).toBe(fullPackageJSON);
-    });
-
-    it('should insert scripts and dependencies', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('package.json')) {
-          return `{
-  "scripts": {
-    "ko": "ko"
-  },
-  "dependencies": {
-    "ko": "ko"
-  },
-  "devDependencies": {
-    "ko": "ko"
-  }
-}`;
-        }
-        return;
-      });
-
-      await initOrchidORM({
-        addSchemaToZod: true,
-        addTestFactory: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === packageJSONPath,
-      );
-      expect(content).toBe(
-        `{
-  "scripts": {
-    "ko": "ko",
-    "db": "ts-node src/db/dbScripts.ts"
-  },
-  "dependencies": {
-    "ko": "ko",
-    "dotenv": "^1.2.3",
-    "orchid-orm": "^1.2.3",
-    "pqb": "^1.2.3",
-    "pg": "^1.2.3",
-    "orchid-orm-schema-to-zod": "^1.2.3"
-  },
-  "devDependencies": {
-    "ko": "ko",
-    "rake-db": "^1.2.3",
-    "orchid-orm-test-factory": "^1.2.3",
-    "@swc/core": "^1.2.3",
-    "@types/node": "^1.2.3",
-    "ts-node": "^1.2.3",
-    "typescript": "^1.2.3"
-  }
-}
-`,
-      );
-    });
-  });
-
-  describe('tsconfig.json', () => {
-    it('should create tsconfig.json if not not exist', async () => {
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === tsConfigPath,
-      );
-      expect(content).toBe(`{
-  "ts-node": {
-    "swc": true
-  },
-  "compilerOptions": {
-    "strict": true
-  }
-}
-`);
-    });
-
-    it('should update tsconfig.json if it exists', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('tsconfig.json')) {
-          return `{"compilerOptions":{"ko":"ko"}}`;
-        }
-        return;
-      });
-
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === tsConfigPath,
-      );
-      expect(content).toBe(`{
-  "compilerOptions": {
-    "ko": "ko",
-    "strict": true
-  },
-  "ts-node": {
-    "swc": true
-  }
-}
-`);
-    });
-  });
-
-  describe('.env', () => {
-    it('should create .env if not exist', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('.env')) {
-          throw new EnoentError();
-        }
-      });
-
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === envPath,
-      );
-      expect(content)
-        .toBe(`DATABASE_URL=postgres://user:password@localhost:5432/dbname?ssl=false
-`);
-    });
-
-    it('should append DATABASE_URL to existing .env', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('.env')) {
-          return 'KO=KO';
-        }
-        return '';
-      });
-
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === envPath,
-      );
-      expect(content).toBe(`KO=KO
-DATABASE_URL=postgres://user:password@localhost:5432/dbname?ssl=false
-`);
-    });
-
-    it('should append DATABASE_TEST_URL if testDatabase specified', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('.env')) {
-          return 'KO=KO';
-        }
-        return '';
-      });
-
-      await initOrchidORM({
-        testDatabase: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === envPath,
-      );
-      expect(content).toBe(`KO=KO
-DATABASE_URL=postgres://user:password@localhost:5432/dbname?ssl=false
-DATABASE_TEST_URL=postgres://user:password@localhost:5432/dbname-test?ssl=false
-`);
-    });
-  });
-
-  describe('.gitignore', () => {
-    it('should create .gitignore if not exists', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('.gitignore')) {
-          throw new EnoentError();
-        }
-      });
-
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === gitignorePath,
-      );
-      expect(content).toBe(`node_modules
-.env
-`);
-    });
-
-    it('should append missing entries if .gitignore exists', async () => {
-      asMock(fs.readFile).mockImplementation((path: string) => {
-        if (path.endsWith('.gitignore')) {
-          return 'node_modules/\nko';
-        }
-        return;
-      });
-
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === gitignorePath,
-      );
-      expect(content).toBe(`node_modules/
-ko
-.env
-`);
-    });
-  });
-
-  describe('baseTable', () => {
-    it('should create base table', async () => {
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === baseTablePath,
-      );
-      expect(content).toBe(`import { createBaseTable } from 'orchid-orm';
-
-export const BaseTable = createBaseTable({
-  columnTypes: (t) => ({
-    ...t,
-    text: (min = 0, max = Infinity) => t.text(min, max),
-  }),
-});
-`);
-    });
-
-    it('should create base table with timestamp as date', async () => {
-      await initOrchidORM({
-        timestamp: 'date',
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === baseTablePath,
-      );
-      expect(content).toBe(`import { createBaseTable } from 'orchid-orm';
-
-export const BaseTable = createBaseTable({
-  columnTypes: (t) => ({
-    ...t,
-    text: (min = 0, max = Infinity) => t.text(min, max),
-    timestamp: <P extends number>(precision?: P) =>
-      t.timestamp<P>(precision).asDate(),
-  }),
-});
-`);
-    });
-
-    it('should create base table with timestamp as number', async () => {
-      await initOrchidORM({
-        timestamp: 'number',
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === baseTablePath,
-      );
-      expect(content).toBe(`import { createBaseTable } from 'orchid-orm';
-
-export const BaseTable = createBaseTable({
-  columnTypes: (t) => ({
-    ...t,
-    text: (min = 0, max = Infinity) => t.text(min, max),
-    timestamp: <P extends number>(precision?: P) =>
-      t.timestamp<P>(precision).asNumber(),
-  }),
-});
-`);
-    });
-  });
-
-  describe('tables', () => {
-    it('should do nothing if demoTables is not specified', async () => {
-      await initOrchidORM({});
-
-      expect(fs.mkdir).not.toBeCalledWith(tablesDir, { recursive: true });
-    });
-
-    it('should create tables dir', async () => {
-      await initOrchidORM({
-        demoTables: true,
-      });
-
-      expect(fs.mkdir).toBeCalledWith(tablesDir, { recursive: true });
-    });
-
-    it('should create post table', async () => {
-      await initOrchidORM({
-        demoTables: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === postTablePath,
-      );
-      expect(content).toBe(`import { BaseTable } from '../baseTable';
-import { CommentTable } from './comment.table';
-
-export type Post = PostTable['columns']['type'];
-export class PostTable extends BaseTable {
-  table = 'post';
-  columns = this.setColumns((t) => ({
-    id: t.serial().primaryKey(),
-    title: t.text(3, 100).unique(),
-    text: t.text(20, 10000),
-    ...t.timestamps(),
-  }));
-
-  relations = {
-    comments: this.hasMany(() => CommentTable, {
-      primaryKey: 'id',
-      foreignKey: 'postId',
-    }),
-  };
-}
-`);
-    });
-
-    it('should create post table with zod schema', async () => {
-      await initOrchidORM({
-        demoTables: true,
-        addSchemaToZod: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === postTablePath,
-      );
-      expect(content).toBe(`import { BaseTable } from '../baseTable';
-import { CommentTable } from './comment.table';
-import { tableToZod } from 'orchid-orm-schema-to-zod';
-
-export type Post = PostTable['columns']['type'];
-export class PostTable extends BaseTable {
-  table = 'post';
-  columns = this.setColumns((t) => ({
-    id: t.serial().primaryKey(),
-    title: t.text(3, 100).unique(),
-    text: t.text(20, 10000),
-    ...t.timestamps(),
-  }));
-
-  relations = {
-    comments: this.hasMany(() => CommentTable, {
-      primaryKey: 'id',
-      foreignKey: 'postId',
-    }),
-  };
-}
-
-export const postSchema = tableToZod(PostTable);
-`);
-    });
-
-    it('should create comment table', async () => {
-      await initOrchidORM({
-        demoTables: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === commentTablePath,
-      );
-      expect(content).toBe(`import { BaseTable } from '../baseTable';
-import { PostTable } from './post.table';
-
-export type Comment = CommentTable['columns']['type'];
-export class CommentTable extends BaseTable {
-  table = 'comment';
-  columns = this.setColumns((t) => ({
-    id: t.serial().primaryKey(),
-    postId: t
-      .integer()
-      .foreignKey(() => PostTable, 'id')
-      .index(),
-    text: t.text(5, 1000),
-    ...t.timestamps(),
-  }));
-
-  relations = {
-    post: this.belongsTo(() => PostTable, {
-      primaryKey: 'id',
-      foreignKey: 'postId',
-    }),
-  };
-}
-`);
-    });
-
-    it('should create post table with zod schema', async () => {
-      await initOrchidORM({
-        demoTables: true,
-        addSchemaToZod: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === commentTablePath,
-      );
-      expect(content).toBe(`import { BaseTable } from '../baseTable';
-import { PostTable } from './post.table';
-import { tableToZod } from 'orchid-orm-schema-to-zod';
-
-export type Comment = CommentTable['columns']['type'];
-export class CommentTable extends BaseTable {
-  table = 'comment';
-  columns = this.setColumns((t) => ({
-    id: t.serial().primaryKey(),
-    postId: t
-      .integer()
-      .foreignKey(() => PostTable, 'id')
-      .index(),
-    text: t.text(5, 1000),
-    ...t.timestamps(),
-  }));
-
-  relations = {
-    post: this.belongsTo(() => PostTable, {
-      primaryKey: 'id',
-      foreignKey: 'postId',
-    }),
-  };
-}
-
-export const commentSchema = tableToZod(CommentTable);
-`);
-    });
-  });
-
-  describe('config', () => {
-    it('should create config file', async () => {
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === configPath,
-      );
-      expect(content).toBe(`import 'dotenv/config';
-
-const database = {
-  databaseURL: process.env.DATABASE_URL,
-};
-if (!database.databaseURL) throw new Error('DATABASE_URL is missing in .env');
-
-export const config = {
-  database,
-};
-`);
-    });
-
-    it('should add test database config if specified', async () => {
-      await initOrchidORM({
-        testDatabase: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === configPath,
-      );
-      expect(content).toBe(`import 'dotenv/config';
-
-const database = {
-  databaseURL: process.env.DATABASE_URL,
-};
-if (!database.databaseURL) throw new Error('DATABASE_URL is missing in .env');
-
-const testDatabase = {
-  databaseURL: process.env.DATABASE_TEST_URL,
-};
-
-const allDatabases = [database];
-
-if (testDatabase.databaseURL) {
-  allDatabases.push(testDatabase);
-}
-
-export const config = {
-  allDatabases,
-  database: process.env.NODE_ENV === 'test' ? testDatabase : database,
-};
-`);
-    });
-  });
-
-  describe('db.ts', () => {
-    it('should create db.ts', async () => {
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === dbPath,
-      );
-      expect(content).toBe(`import { orchidORM } from 'orchid-orm';
-import { config } from './config';
-
-export const db = orchidORM(config.database, {
-});
-`);
-    });
-
-    it('should create db.ts with demo tables', async () => {
-      await initOrchidORM({
-        demoTables: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === dbPath,
-      );
-      expect(content).toBe(`import { orchidORM } from 'orchid-orm';
-import { config } from './config';
-import { PostTable } from './tables/post.table';
-import { CommentTable } from './tables/comment.table';
-
-export const db = orchidORM(config.database, {
-  post: PostTable,
-  comment: CommentTable,
-});
-`);
-    });
-  });
-
-  describe('migrationScript', () => {
-    it('should create script', async () => {
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === migrationScriptPath,
-      );
-      expect(content).toBe(`import { rakeDb } from 'rake-db';
-import { config } from './config';
-import { appCodeUpdater } from 'orchid-orm';
-
-rakeDb(config.database, {
-  migrationsPath: './migrations',
-  appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`./tables/\${tableName}.table.ts\`,
-    baseTablePath: './baseTable.ts',
-    baseTableName: 'BaseTable',
-    mainFilePath: './db.ts',
-  }),
-  useCodeUpdater: true, // set to false to disable code updater
-  commands: {
-    async seed() {
-      const { seed } = await import('./seed');
-      await seed();
-    },
-  },
-});
-`);
-    });
-
-    it('should create script with multiple databases', async () => {
-      await initOrchidORM({
-        testDatabase: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === migrationScriptPath,
-      );
-      expect(content).toBe(`import { rakeDb } from 'rake-db';
-import { config } from './config';
-import { appCodeUpdater } from 'orchid-orm';
-
-rakeDb(config.allDatabases, {
-  migrationsPath: './migrations',
-  appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`./tables/\${tableName}.table.ts\`,
-    baseTablePath: './baseTable.ts',
-    baseTableName: 'BaseTable',
-    mainFilePath: './db.ts',
-  }),
-  useCodeUpdater: true, // set to false to disable code updater
-  commands: {
-    async seed() {
-      const { seed } = await import('./seed');
-      await seed();
-    },
-  },
-});
-`);
-    });
-  });
-
-  describe('migrations', () => {
-    it('should create migrations directory', async () => {
-      await initOrchidORM({});
-
-      expect(fs.mkdir).toBeCalledWith(migrationsPath);
-    });
-
-    it('should create migrations if demoTables specified', async () => {
-      await initOrchidORM({
-        demoTables: true,
-      });
-
-      const [, post] = asMock(fs.writeFile).mock.calls.find(([to]) =>
-        to.endsWith('createPost.ts'),
-      );
-      expect(post).toBe(`import { change } from 'rake-db';
-
-change(async (db) => {
-  await db.createTable('post', (t) => ({
-    id: t.serial().primaryKey(),
-    title: t.text().unique(),
-    text: t.text(),
-    ...t.timestamps(),
-  }));
-});
-`);
-
-      const [, comment] = asMock(fs.writeFile).mock.calls.find(([to]) =>
-        to.endsWith('createComment.ts'),
-      );
-      expect(comment).toBe(`import { change } from 'rake-db';
-
-change(async (db) => {
-  await db.createTable('comment', (t) => ({
-    id: t.serial().primaryKey(),
-    postId: t.integer().foreignKey('post', 'id').index(),
-    text: t.text(),
-    ...t.timestamps(),
-  }));
-});
-`);
-    });
-  });
-
-  describe('seed', () => {
-    it('should create seed file', async () => {
-      await initOrchidORM({});
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === seedPath,
-      );
-      expect(content).toBe(`import { db } from './db';
-
-export const seed = async () => {
-  // create records here
-
-  await db.$close();
-};
-`);
-    });
-
-    it('should create seed file with sample records when demoTables is set to true', async () => {
-      await initOrchidORM({
-        demoTables: true,
-      });
-
-      const [, content] = asMock(fs.writeFile).mock.calls.find(
-        ([to]) => to === seedPath,
-      );
-      expect(content).toBe(`import { db } from './db';
-
-export const seed = async () => {
-  await db.post.findBy({ title: 'Sample post' }).orCreate({
-    title: 'Post',
-    text: 'This is a text for a sample post. It contains words, spaces, and punctuation.',
-    comments: {
-      create: [
-        {
-          text: 'Nice post!',
-        },
-        {
-          text: \`Too long, didn't read\`,
-        },
-      ],
-    },
-  });
-
-  await db.$close();
-};
-`);
-    });
-  });
-});