undeexcepturi/tests/features/schema-generator/GH1904.test.ts

TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.

import { Entity, MikroORM, PrimaryKey, Property } from '@mikro-orm/core';
import { MySqlDriver } from '@mikro-orm/mysql';

@Entity({ tableName: 'book' })
export class Book1 {

  @PrimaryKey()
  id!: number;

  @Property({ columnType: 'int' })
  changingField!: number;

}

@Entity({ tableName: 'book' })
export class Book2 {

  @PrimaryKey()
  id!: number;

  @Property({ columnType: 'timestamp', ignoreSchemaChanges: ['type'] })
  changingField!: Date;

}

@Entity({ tableName: 'book' })
export class Book3 {

  @PrimaryKey()
  id!: number;

  @Property({
    columnType: 'int',
    extra: 'VIRTUAL GENERATED',
    ignoreSchemaChanges: ['extra'],
  })
  changingField!: number;

}

@Entity({ tableName: 'book' })
export class Book4 {

  @PrimaryKey()
  id!: number;

  @Property({
    columnType: 'timestamp',
    extra: 'VIRTUAL GENERATED',
    ignoreSchemaChanges: ['extra', 'type'],
  })
  changingField!: Date;

}

@Entity({ tableName: 'book' })
export class Book5 {

  @PrimaryKey()
  id!: number;

  @Property({ columnType: 'timestamp' })
  changingField!: Date;

}

describe('ignore specific schema changes (GH 1904)', () => {
  let orm: MikroORM<MySqlDriver>;

  beforeEach(async () => {
    orm = await MikroORM.init({
      entities: [Book1],
      dbName: `mikro_orm_test_gh_1904`,
      driver: MySqlDriver,
      port: 3308,
    });
    await orm.schema.refreshDatabase();
  });

  afterEach(() => orm.close(true));

  test('schema generator respects ignoreSchemaChanges for `type`', async () => {
    const diff0 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff0).toBe('');
    orm.getMetadata().reset('Book1');
    await orm.discoverEntity(Book2);
    const diff1 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff1).toBe('');

    // Once we remove ignoreSchemaChanges, we should see a diff again.
    orm.getMetadata().reset('Book2');
    await orm.discoverEntity(Book5);
    const diff2 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff2).toBe('alter table `book` modify `changing_field` timestamp not null;\n\n');
  });

  test('schema generator respects ignoreSchemaChanges for `extra`', async () => {
    const diff0 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff0).toBe('');
    orm.getMetadata().reset('Book1');
    await orm.discoverEntity(Book3);
    const diff1 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff1).toBe('');
  });

  test('schema generator respects ignoreSchemaChanges for `extra` and `type`', async () => {
    const diff0 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff0).toBe('');
    orm.getMetadata().reset('Book1');
    await orm.discoverEntity(Book4);
    const diff1 = await orm.schema.getUpdateSchemaSQL({ wrap: false });
    expect(diff1).toBe('');
  });
});