update to v6

B4nan · B4nan · commit 1d94b01f1bcd · 2024-02-05T21:06:21.000+01:00
diff --git a/.env b/.env
@@ -1,5 +1,4 @@
 MIKRO_ORM_DYNAMIC_IMPORTS=1
-MIKRO_ORM_TYPE=mongo
+MIKRO_ORM_TYPE=better-sqlite
 MIKRO_ORM_ENTITIES=./app/entities/*.js
-MIKRO_ORM_DB_NAME=mikro-orm-express-js
 MIKRO_ORM_DEBUG=true
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [ 14, 16 ]
+        node-version: [ 18, 20 ]
     steps:
       - name: Checkout Source code
         uses: actions/checkout@v4
@@ -25,19 +25,13 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Cache node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: '**/node_modules'
           key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/yarn.lock') }}
 
-      - name: Init docker
-        run: docker-compose up -d
-
       - name: Install
         run: yarn
 
       - name: Test
         run: yarn test
-
-      - name: Teardown docker
-        run: docker-compose down
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
-# Express + MongoDB + JavaScript example integration
+# Express + SQLite + JavaScript example integration
 
 1. Install dependencies via `yarn` or `npm install`
-2. Run `docker-compose up -d` to start mongodb
-3. Run via `yarn start` or `yarn start:dev` (nodemon)
-4. Example API is running on localhost:3000
+2. Run via `yarn start` or `yarn start:dev` (nodemon)
+3. Example API is running on localhost:3000
 
 Available routes:
 
diff --git a/app/controllers/author.controller.js b/app/controllers/author.controller.js
@@ -8,7 +8,7 @@ import { Author } from '../entities/Author.js';
 const router = Router();
 
 router.get('/', async (req, res) => {
-  const authors = await DI.authorRepository.findAll({
+  const authors = await DI.authors.findAll({
     populate: ['books'],
     orderBy: { name: QueryOrder.DESC },
     limit: 20,
@@ -18,7 +18,7 @@ router.get('/', async (req, res) => {
 
 router.get('/:id', async (req, res) => {
   try {
-    const author = await DI.authorRepository.findOne(req.params.id, {
+    const author = await DI.authors.findOne(+req.params.id, {
       populate: ['books'],
     });
 
@@ -40,7 +40,7 @@ router.post('/', async (req, res) => {
 
   try {
     const author = DI.em.create(Author, req.body);
-    await DI.em.persist(author).flush();
+    await DI.em.flush();
 
     res.json(author);
   } catch (e) {
@@ -50,9 +50,9 @@ router.post('/', async (req, res) => {
 
 router.put('/:id', async (req, res) => {
   try {
-    const author = await DI.authorRepository.findOneOrFail(req.params.id);
+    const author = await DI.authors.findOneOrFail(+req.params.id);
     wrap(author).assign(req.body);
-    await DI.authorRepository.flush();
+    await DI.em.flush();
 
     res.json(author);
   } catch (e) {
diff --git a/app/controllers/author.controller.spec.js b/app/controllers/author.controller.spec.js
@@ -1,14 +1,12 @@
 import request from 'supertest';
-import expect from 'expect';
+import { expect } from 'expect';
 import { app, DI, server } from '../server.js';
 
 describe('author controller', () => {
 
   before(async () => {
-    DI.orm.config.set('dbName', 'express-test-db');
-    DI.orm.config.getLogger().setDebugMode(false);
-    await DI.orm.config.getDriver().reconnect();
-    await DI.orm.getSchemaGenerator().clearDatabase();
+      await DI.orm.reconnect({ dbName: ':memory:', debug: false });
+      await DI.orm.schema.createSchema();
   });
 
   after(async () => {
diff --git a/app/controllers/book.controller.js b/app/controllers/book.controller.js
@@ -8,7 +8,7 @@ import { DI } from '../server.js';
 const router = Router();
 
 router.get('/', async (req, res) => {
-  const books = await DI.bookRepository.findAll({
+  const books = await DI.books.findAll({
     populate: ['author'],
     orderBy: { title: QueryOrder.DESC },
     limit: 20,
@@ -18,7 +18,7 @@ router.get('/', async (req, res) => {
 
 router.get('/:id', async (req, res) => {
   try {
-    const book = await DI.bookRepository.findOneOrFail(req.params.id, {
+    const book = await DI.books.findOneOrFail(+req.params.id, {
       populate: ['author'],
     });
     res.json(book);
@@ -35,8 +35,7 @@ router.post('/', async (req, res) => {
 
   try {
     const book = DI.em.create(Book, req.body);
-    wrap(book.author, true).__initialized = true;
-    await DI.em.persist(book).flush();
+    await DI.em.flush();
 
     res.json(book);
   } catch (e) {
@@ -46,9 +45,9 @@ router.post('/', async (req, res) => {
 
 router.put('/:id', async (req, res) => {
   try {
-    const book = await DI.bookRepository.findOneOrFail(req.params.id);
+    const book = await DI.books.findOneOrFail(+req.params.id);
     wrap(book).assign(req.body);
-    await DI.bookRepository.flush();
+    await DI.em.flush();
 
     res.json(book);
   } catch (e) {
diff --git a/app/controllers/book.controller.spec.js b/app/controllers/book.controller.spec.js
@@ -1,14 +1,12 @@
 import request from 'supertest';
-import expect from 'expect';
+import { expect } from 'expect';
 import { app, DI, server } from '../server.js';
 
-describe('author controller', () => {
+describe('book controller', () => {
 
   before(async () => {
-    DI.orm.config.set('dbName', 'express-test-db');
-    DI.orm.config.getLogger().setDebugMode(false);
-    await DI.orm.config.getDriver().reconnect();
-    await DI.orm.getSchemaGenerator().clearDatabase();
+    await DI.orm.reconnect({ dbName: ':memory:', debug: false });
+    await DI.orm.schema.createSchema();
   });
 
   after(async () => {
diff --git a/app/entities/Author.js b/app/entities/Author.js
@@ -45,12 +45,12 @@ export const schema = new EntitySchema({
     identities: { type: 'string[]', nullable: true },
     born: { type: 'Date', nullable: true },
     books: {
-      reference: '1:m',
+      kind: '1:m',
       mappedBy: 'author',
       type: 'Book',
     },
     favouriteBook: {
-      reference: 'm:1',
+      kind: 'm:1',
       type: 'Book',
       nullable: true,
     },
diff --git a/app/entities/BaseEntity.js b/app/entities/BaseEntity.js
@@ -1,9 +1,9 @@
 'use strict';
 
-import { Collection, ReferenceType, EntitySchema, wrap } from '@mikro-orm/core';
+import { Collection, ReferenceKind, EntitySchema, wrap } from '@mikro-orm/core';
 
 /**
- * @property {ObjectID} _id
+ * @property {number} id
  * @property {Date} createdAt
  * @property {Date} updatedAt
  */
@@ -15,7 +15,7 @@ export class BaseEntity {
     const props = wrap(this).__meta.properties;
 
     Object.keys(props).forEach(prop => {
-      if ([ReferenceType.ONE_TO_MANY, ReferenceType.MANY_TO_MANY].includes(props[prop].reference)) {
+      if ([ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(props[prop].reference)) {
         this[prop] = new Collection(this);
       }
     });
@@ -26,7 +26,7 @@ export class BaseEntity {
 export const schema = new EntitySchema({
   name: 'BaseEntity',
   properties: {
-    _id: { primary: true, type: 'ObjectID' },
+    id: { primary: true, type: 'number' },
     createdAt: { type: 'Date' },
     updatedAt: { type: 'Date', onUpdate: () => new Date() },
   },
diff --git a/app/entities/Book.js b/app/entities/Book.js
@@ -32,16 +32,16 @@ export const schema = new EntitySchema({
   properties: {
     title: { type: 'string' },
     author: {
-      reference: 'm:1',
+      kind: 'm:1',
       type: 'Author',
     },
     publisher: {
-      reference: 'm:1',
+      kind: 'm:1',
       type: 'Publisher',
       nullable: true,
     },
     tags: {
-      reference: 'm:n',
+      kind: 'm:n',
       owner: true,
       inversedBy: 'books',
       type: 'BookTag',
diff --git a/app/entities/BookTag.js b/app/entities/BookTag.js
@@ -27,7 +27,7 @@ export const schema = new EntitySchema({
   properties: {
     name: { type: 'string' },
     books: {
-      reference: 'm:n',
+      kind: 'm:n',
       owner: false,
       mappedBy: 'tags',
       type: 'Book',
diff --git a/app/entities/Publisher.js b/app/entities/Publisher.js
@@ -27,7 +27,7 @@ export const schema = new EntitySchema({
       type: 'string',
     },
     books: {
-      reference: '1:m',
+      kind: '1:m',
       mappedBy: 'publisher',
       type: 'Book',
     },
diff --git a/app/mikro-orm.config.js b/app/mikro-orm.config.js
@@ -1,5 +1,7 @@
-import { MongoHighlighter } from '@mikro-orm/mongo-highlighter';
+import { defineConfig } from '@mikro-orm/better-sqlite';
+import { SqlHighlighter } from '@mikro-orm/sql-highlighter';
 
-export default {
-  highlighter: new MongoHighlighter(),
-};
+export default defineConfig({
+  dbName: 'mikro-orm-express-js',
+  highlighter: new SqlHighlighter(),
+});
diff --git a/app/server.js b/app/server.js
@@ -1,28 +1,26 @@
 'use strict';
 
 import express from 'express';
-import { EntityManager, EntityRepository, MikroORM, RequestContext } from '@mikro-orm/core';
-import { MongoHighlighter } from '@mikro-orm/mongo-highlighter';
+import { EntityManager, EntityRepository, MikroORM, RequestContext } from '@mikro-orm/better-sqlite';
+import config from './mikro-orm.config.js';
 import { AuthorController, BookController } from './controllers/index.js';
 import { Author, Book } from './entities/index.js';
 
 /**
  * @property {MikroORM} orm
  * @property {EntityManager} em
- * @property {EntityRepository<Author>} authorRepository
- * @property {EntityRepository<Book>} bookRepository
+ * @property {EntityRepository<Author>} authors
+ * @property {EntityRepository<Book>} books
  */
 export const DI = {};
 
 export const app = express();
 const port = process.env.PORT || 3000;
 
-DI.orm = await MikroORM.init({
-  highlighter: new MongoHighlighter(),
-});
+DI.orm = await MikroORM.init(config);
 DI.em = DI.orm.em;
-DI.authorRepository = DI.orm.em.getRepository(Author);
-DI.bookRepository = DI.orm.em.getRepository(Book);
+DI.authors = DI.orm.em.getRepository(Author);
+DI.books = DI.orm.em.getRepository(Book);
 
 app.use(express.json());
 app.use((req, res, next) => {
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/package.json b/package.json
@@ -11,18 +11,18 @@
     "test": "mocha **/*.spec.js"
   },
   "dependencies": {
-    "express": "^4.17.1",
-    "express-promise-router": "^4.0.0",
-    "@mikro-orm/core": "^5.0.0",
-    "@mikro-orm/mongodb": "^5.0.0",
-    "@mikro-orm/mongo-highlighter": "^1.0.0"
+    "express": "^4.18.2",
+    "express-promise-router": "^4.1.1",
+    "@mikro-orm/core": "^6.1.0",
+    "@mikro-orm/better-sqlite": "^6.1.0",
+    "@mikro-orm/sql-highlighter": "^1.0.0"
   },
   "devDependencies": {
-    "@mikro-orm/cli": "^5.0.0",
-    "expect": "27.5.1",
-    "mocha": "9.2.2",
-    "nodemon": "^2.0.4",
-    "supertest": "^6.2.2"
+    "@mikro-orm/cli": "^6.1.0",
+    "expect": "29.7.0",
+    "mocha": "10.2.0",
+    "nodemon": "^3.0.3",
+    "supertest": "^6.3.4"
   },
   "mikro-orm": {
     "configPaths": [
diff --git a/yarn.lock b/yarn.lock
