fix(mysql): boolean values return numbers

also refactored transformers by extracting them from entity loader service

Author: brunobuddy

package-lock.json

@@ -0,0 +1,16 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.ts$": "ts-jest"
+  },
+  "maxWorkers": 1,
+  "setupFilesAfterEnv": ["./jest.mysql-setup.ts"],
+  "moduleNameMapper": {
+    "^@repo/types$": "<rootDir>/../../types/src",
+    "^@repo/common$": "<rootDir>/../../common/src",
+    "^@repo/json-schema$": "<rootDir>/../../json-schema/src"
+  }
+}

packages/core/manifest/e2e/jest-e2e.mysql-config.json

@@ -0,0 +1,85 @@
+import { Test, TestingModule } from '@nestjs/testing'
+import { AppModule } from '../src/app.module'
+import { YamlService } from '../src/manifest/services/yaml.service'
+import { INestApplication } from '@nestjs/common'
+import supertest from 'supertest'
+import { load } from 'js-yaml'
+import fs from 'fs'
+import { SwaggerModule } from '@nestjs/swagger'
+import { OpenApiService } from '../src/open-api/services/open-api.service'
+import { SeederService } from '../src/seed/services/seeder.service'
+import { MySqlContainer, StartedMySqlContainer } from '@testcontainers/mysql'
+
+import path from 'path'
+
+let app: INestApplication
+
+jest.setTimeout(30000) // Increase the timeout because the MySQL container takes a while to start.
+
+beforeAll(async () => {
+  // Set environment variables for testing.
+  process.env.NODE_ENV = 'test'
+  process.env.TOKEN_SECRET_KEY = 'test'
+  process.env.MANIFEST_HANDLERS_FOLDER = path.join(
+    __dirname,
+    'assets',
+    'handlers'
+  )
+
+  process.env.DB_CONNECTION = 'mysql'
+  process.env.DB_DROP_SCHEMA = 'true'
+
+  // Start a PostgreSQL test container
+  const mysqlContainer: StartedMySqlContainer = await new MySqlContainer()
+    .withDatabase('test')
+    .withUsername('test')
+    .withRootPassword('test')
+    .start()
+
+  process.env.DB_HOST = mysqlContainer.getHost()
+  process.env.DB_PORT = mysqlContainer.getPort().toString()
+  process.env.DB_USERNAME = 'test'
+  process.env.DB_PASSWORD = 'test'
+  process.env.DB_DATABASE = 'test'
+
+  // Start the NestJS application mocking some services.
+  const moduleFixture: TestingModule = await Test.createTestingModule({
+    imports: [AppModule]
+  })
+    .overrideProvider(YamlService)
+    .useValue({
+      load: () =>
+        load(
+          fs.readFileSync(
+            `${process.cwd()}/e2e/assets/mock-backend.yml`,
+            'utf8'
+          )
+        )
+    })
+    .compile()
+
+  app = moduleFixture.createNestApplication()
+
+  // Seed the database with the mock data.
+  const seedService = app.get(SeederService)
+  await seedService.seed('admin')
+  await seedService.seed('cat')
+  await seedService.seed('university')
+  await seedService.seed('author')
+  await seedService.seed('tag')
+  await seedService.seed('note')
+
+  // Store request object in global scope to use in tests.
+  global.request = supertest(app.getHttpServer())
+
+  // Set the SwaggerModule to serve the OpenAPI doc.
+  const openApiService = app.get(OpenApiService)
+  SwaggerModule.setup('api', app, openApiService.generateOpenApiObject())
+
+  await app.init()
+})
+
+afterAll(async () => {
+  delete global.request
+  await app.close()
+})

packages/core/manifest/e2e/jest.mysql-setup.ts

@@ -44,7 +44,6 @@ beforeAll(async () => {
   process.env.DB_USERNAME = 'test'
   process.env.DB_PASSWORD = 'test'
   process.env.DB_DATABASE = 'test'
-  process.env.DB_TYPE = 'postgres'
 
   // Start the NestJS application mocking some services.
   const moduleFixture: TestingModule = await Test.createTestingModule({

packages/core/manifest/e2e/jest.pg-setup.ts

@@ -9,7 +9,7 @@ describe('Collection CRUD (e2e)', () => {
     birthdate: '2024-01-01',
     price: 100,
     isGoodBoy: true,
-    acquiredAt: new Date().toISOString(),
+    acquiredAt: '2025-01-05T08:19:02.000Z',
     email: '[email protected]',
     favoriteToy: 'ball',
     location: { lat: 12, lng: 13 }

packages/core/manifest/e2e/tests/collection-crud.e2e-spec.ts

@@ -45,6 +45,7 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e:sqlite": "jest --config ./e2e/jest-e2e.sqlite-config.json",
     "test:e2e:postgres": "jest --config ./e2e/jest-e2e.pg-config.json",
+    "test:e2e:mysql": "jest --config ./e2e/jest-e2e.mysql-config.json",
     "test:e2e": "npm run test:e2e:sqlite && npm run test:e2e:postgres",
     "test:e2e:ci": "npm run test:e2e:sqlite -- --ci && npm run test:e2e:postgres -- --ci",
     "test:unit": "jest --config ./jest.config.json",
@@ -98,6 +99,7 @@
     "@nestjs/cli": "^10.4.7",
     "@nestjs/schematics": "^10.2.3",
     "@nestjs/testing": "^10.4.8",
+    "@testcontainers/mysql": "^10.18.0",
     "@testcontainers/postgresql": "^10.18.0",
     "@types/bcrypt": "^5.0.2",
     "@types/dasherize": "^2.0.3",

packages/core/manifest/package.json

@@ -19,6 +19,9 @@ import { EntityManifestService } from '../../manifest/services/entity-manifest.s
 import { mysqlPropTypeColumnTypes } from '../columns/mysql-prop-type-column-types'
 import { postgresPropTypeColumnTypes } from '../columns/postgres-prop-type-column-types copy'
 import { ColumnService } from './column.service'
+import { BooleanTransformer } from '../transformers/boolean-transformer'
+import { NumberTransformer } from '../transformers/number-transformer'
+import { TimestampTransformer } from '../transformers/timestamp-transformer'
 
 @Injectable()
 export class EntityLoaderService {
@@ -72,19 +75,16 @@ export class EntityLoaderService {
                 propManifest.type === PropType.Number ||
                 propManifest.type === PropType.Money
               ) {
-                transformer = {
-                  from: (value: string | number) => Number(value),
-                  to: (value: string | number) => value
-                }
+                transformer = new NumberTransformer()
               }
 
               // Ensure it returns strings for timestamps (SQLite returns Date objects by default).
               if (propManifest.type === PropType.Timestamp) {
-                transformer = {
-                  from: (value: Date | string) =>
-                    value instanceof Date ? value.toISOString() : value,
-                  to: (value: string) => value // Store as string
-                }
+                transformer = new TimestampTransformer()
+              }
+
+              if (propManifest.type === PropType.Boolean) {
+                transformer = new BooleanTransformer(dbConnection)
               }
 
               acc[propManifest.name] = {

packages/core/manifest/src/entity/services/entity-loader.service.ts

@@ -140,7 +140,7 @@ describe('EntityLoaderService', () => {
       expect(mysqlResult[0].options.columns['timestamp-prop'].type).toBe(
         'datetime'
       )
-      expect(mysqlResult[0].options.columns['choice-prop'].type).toBe('enum')
+      expect(mysqlResult[0].options.columns['choice-prop'].type).toBe('varchar')
       expect(mysqlResult[0].options.columns['location-prop'].type).toBe('json')
       expect(mysqlResult[0].options.columns['image-prop'].type).toBe('json')
     })

packages/core/manifest/src/entity/tests/entity-loader.service.spec.ts

@@ -0,0 +1,41 @@
+import { BooleanTransformer } from '../transformers/boolean-transformer'
+import { NumberTransformer } from '../transformers/number-transformer'
+import { TimestampTransformer } from '../transformers/timestamp-transformer'
+
+describe('Transformers', () => {
+  describe('BooleanTransformer', () => {
+    it('should convert boolean to number for MySQL', () => {
+      const connection = 'mysql'
+      const transformer = new BooleanTransformer(connection)
+      const value = true
+      const result = transformer.to(value)
+      expect(result).toBe(1)
+    })
+
+    it('should convert number to boolean for MySQL', () => {
+      const connection = 'mysql'
+      const transformer = new BooleanTransformer(connection)
+      const value = 1
+      const result = transformer.from(value)
+      expect(result).toBe(true)
+    })
+  })
+
+  describe('NumberTransformer', () => {
+    it('should always return a number', () => {
+      const transformer = new NumberTransformer()
+      const value = '1'
+      const result = transformer.from(value)
+      expect(result).toBe(1)
+    })
+  })
+
+  describe('TimestampTransformer', () => {
+    it('should always return a string', () => {
+      const transformer = new TimestampTransformer()
+      const value = new Date()
+      const result = transformer.from(value)
+      expect(typeof result).toBe('string')
+    })
+  })
+})

packages/core/manifest/src/entity/tests/transformers.spec.ts

@@ -0,0 +1,27 @@
+import { ValueTransformer } from 'typeorm'
+import { DatabaseConnection } from '../../../../types/src'
+
+/**
+ * Boolean transformer for TypeORM.
+ *
+ * This transformer is used to convert boolean values to numbers for MySQL as it returns 1 for true and 0 for false.
+ */
+export class BooleanTransformer implements ValueTransformer {
+  private connection: DatabaseConnection
+
+  constructor(connection: DatabaseConnection) {
+    this.connection = connection
+  }
+
+  to(value: boolean): number {
+    if (this.connection === 'mysql') {
+      return value ? 1 : 0
+    }
+  }
+
+  from(value: number): boolean {
+    if (this.connection === 'mysql') {
+      return value === 1
+    }
+  }
+}