Socket.io & Sequelize Migrations (#7)

* socket.io server setup for express and nest

* socket-io express server setup

* socket to do in react & next app

* socket-io wip

* socket io server wip

* socket.io in next-client

* socket api test wip

* socket-io done

* wip

* migrations wip

* seeders wip

* seeders wip

* seed cars

* update comment

* mysql migrations wip

* mysql migrations wip

* update comands.md files

* migrations wip

* mysql migrations wip

* migration changes wip

* seed mysql db, handle case for optional values

* add scripts to seeder pkgs

* fix car list api

* minor lint fix

* generate migation file cmd

* def buyer model

* def buyerRoute

* add buyers migration & seeder

* isUUIDv6 validation fn

* more exmaple with sequelize include

* add seeder and migration storage notes

* indent docs

Author: nishkohli96

.eslintignore

@@ -0,0 +1,3 @@
+mongo-seeders
+mysql-migrations
+postgres-migrations

.gitignore

@@ -44,4 +44,8 @@ coverage
 
 # misc
 apps/express-server/public
-apps/express-server/uploads
+apps/express-server/uploads
+
+# config files for migrations
+apps/mysql-migrations/config/config.json
+apps/postgres-migrations/config/config.json

apps/express-server/package.json

@@ -24,7 +24,9 @@
     "pg": "^8.13.1",
     "pg-hstore": "^2.3.4",
     "sequelize": "^6.37.5",
+    "socket.io": "^4.8.1",
     "stytch": "^12.4.0",
+    "uuid": "^11.0.5",
     "winston": "3.11.0"
   },
   "devDependencies": {
@@ -35,6 +37,7 @@
     "@types/fluent-ffmpeg": "^2.1.24",
     "@types/multer": "1.4.12",
     "@types/node": "^20.11.17",
+    "@types/uuid": "^10.0.0",
     "env-cmd": "^10.1.0",
     "eslint": "^8.57.0",
     "nodemon": "^3.0.3",

apps/express-server/src/app.ts

@@ -5,6 +5,7 @@ import { ExpressServerEndpoints } from '@csl/react-express';
 import { ENV_VARS, ServerConfig } from '@/app-constants';
 import { requestLogger } from '@/middleware';
 import { routesArray } from '@/routes';
+import { io } from '.';
 
 const app: Express = express();
 
@@ -41,6 +42,7 @@ app.use(requestLogger);
 app.use(express.static(path.join(__dirname, '../public')));
 
 app.get('/', (_: Request, response: Response) => {
+  io.emit('noArg');
   response.status(200).json({
     env: ENV_VARS.env,
     message: 'Api is up & running!!!'

apps/express-server/src/db/mysql/index.ts

@@ -31,18 +31,10 @@ export async function connectMySQLDB() {
       `[ ⚡️ ${hostName} ⚡️ ] - Connected to MySQL DB`
     );
 
-    if (ENV_VARS.env === 'production') {
-      await mySQLSequelize.sync();
-      console.log('Production: Run migrations for schema updates.');
-    } else {
-      await mySQLSequelize.sync({ alter: true });
-      console.log(`${ENV_VARS.env}: MySQL Database schema synchronized with alter mode.`);
-    }
-
     /**
      * sequelize.close() -> will close the connection to the DB.
-	 * You will need to create a new Sequelize instance to
-	 * access your database again.
+	   * You will need to create a new Sequelize instance to
+	   * access your database again.
      */
   } catch (error) {
     winstonLogger.error('⚠ Error connecting to MySQL Database ⚠', error);

apps/express-server/src/db/mysql/models/index.ts

@@ -1 +1 @@
-export * from './person';
+export * from './user';

apps/express-server/src/db/mysql/models/person.ts apps/express-server/src/db/mysql/models/user.ts

@@ -1,21 +1,21 @@
 /* eslint-disable no-use-before-define */
 
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
-import { mySQLSequelize, shouldAlterTable } from '@/db/mysql';
+import { mySQLSequelize } from '@/db/mysql';
 
 export type UserModelAttributes = InferAttributes<UserModel>;
 export type UserModelCreationAttributes = InferCreationAttributes<UserModel>;
 
 class UserModel extends Model<UserModelAttributes, UserModelCreationAttributes> {
 	declare id: CreationOptional<number>;
-	name!: string;
-	email!: string;
-	isActive!: CreationOptional<boolean>;
-	preferences!: object;
-	tags!: string[];
-	age!: number;
-	createdAt!: CreationOptional<Date>;
-	updatedAt!: CreationOptional<Date>;
+	declare name: string;
+	declare email: string;
+	declare isActive: CreationOptional<boolean>;
+	declare preferences: object | null;
+	declare tags: string[] | null;
+	declare age: number;
+	declare createdAt: CreationOptional<Date>;
+	declare updatedAt: CreationOptional<Date>;
 }
 
 UserModel.init(
@@ -43,12 +43,14 @@ UserModel.init(
     },
     preferences: {
       type: DataTypes.JSON,
-      allowNull: true
+      allowNull: true,
+      defaultValue: null
     },
     /* Arrays are not supported in MySQL */
     tags: {
       type: DataTypes.JSON,
-      allowNull: true
+      allowNull: true,
+      defaultValue: null
     },
     age: {
       type: DataTypes.INTEGER,
@@ -93,12 +95,6 @@ UserModel.init(
   }
 );
 
-async function createTable() {
-  await UserModel.sync({ alter: shouldAlterTable });
-}
-
-createTable();
-
 const InactiveUserModel = UserModel.scope('inactiveUsers');
 
 export { UserModel, InactiveUserModel };

apps/express-server/src/db/postgres/index.ts

@@ -26,23 +26,20 @@ export const postgreSequelize = new Sequelize(ENV_VARS.postgresUrl, {
 
 export async function connectPostgresDB() {
   try {
+    /**
+     * SELECT 1+1 AS result is the default test query in Sequelize
+     * to verify database connection, when calling sequelize.authenticate().
+     * It can't be disabled though.
+     */
     await postgreSequelize.authenticate();
     winstonLogger.info(
       `[ ⚡️ ${hostName} ⚡️ ] - Connected to Postgres`
     );
 
-    if (ENV_VARS.env === 'production') {
-      await postgreSequelize.sync();
-      console.log('Production: Run migrations for schema updates.');
-    } else {
-      await postgreSequelize.sync({ alter: true });
-      console.log(`${ENV_VARS.env}: Postgres Database schema synchronized with alter mode.`);
-    }
-
     /**
      * sequelize.close() -> will close the connection to the DB.
-	 * You will need to create a new Sequelize instance to
-	 * access your database again.
+	   * You will need to create a new Sequelize instance to
+	   * access your database again.
      */
   } catch (error) {
     winstonLogger.error('⚠ Error connecting to Postgres Database ⚠');

apps/express-server/src/db/postgres/models/buyer.ts

@@ -0,0 +1,84 @@
+/* eslint-disable no-use-before-define */
+
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import { v6 as UUIDv6 } from 'uuid';
+import { postgreSequelize } from '@/db/postgres';
+import { isUUIDv6 } from '@/utils';
+import { CarModel, CarColors } from './car';
+
+export type BuyerModelAttributes = InferAttributes<BuyerModel>;
+export type BuyerModelCreationAttributes = InferCreationAttributes<BuyerModel>;
+
+class BuyerModel extends Model<BuyerModelAttributes, BuyerModelCreationAttributes> {
+  declare id: CreationOptional<string>;
+  declare name: string;
+  declare car_id: string;
+  declare color: CarColors;
+  declare purchased_on: CreationOptional<Date>;
+}
+
+BuyerModel.init(
+  {
+    id: {
+      type: DataTypes.UUID,
+      defaultValue: () => UUIDv6(),
+      primaryKey: true,
+      validate: {
+        isuuidV6(value: string) {
+          if (!isUUIDv6(value)) {
+            throw new Error('Invalid UUID v6 format.');
+          }
+        }
+      }
+    },
+    name: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    car_id: {
+      type: DataTypes.UUID,
+      allowNull: false,
+      references: {
+        model: CarModel,
+        key: 'id',
+      },
+      validate: {
+        isuuidV6(value: string) {
+          if (!isUUIDv6(value)) {
+            throw new Error('Invalid UUID v6 format.');
+          }
+        }
+      },
+    },
+    color: {
+      type: DataTypes.ENUM(...Object.values(CarColors)),
+      allowNull: false,
+    },
+    purchased_on: {
+      type: DataTypes.DATE,
+      allowNull: false,
+      defaultValue: DataTypes.NOW,
+    }
+  },
+  {
+    sequelize: postgreSequelize,
+    timestamps: true,
+    createdAt: 'purchased_on',
+    updatedAt: false,
+    modelName: 'buyer',
+  }
+);
+
+BuyerModel.belongsTo(CarModel, {
+  foreignKey: 'car_id',
+  as: 'carDetails',
+  onDelete: 'CASCADE',
+  onUpdate: 'CASCADE'
+});
+
+CarModel.hasMany(BuyerModel, {
+  foreignKey: 'car_id',
+  as: 'owners',
+});
+
+export { BuyerModel };

apps/express-server/src/db/postgres/models/car.ts

@@ -1,7 +1,9 @@
 /* eslint-disable no-use-before-define */
 
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
-import { postgreSequelize, shouldAlterTable } from '@/db/postgres';
+import { v6 as UUIDv6 } from 'uuid';
+import { postgreSequelize } from '@/db/postgres';
+import { isUUIDv6 } from '@/utils';
 import { CarBrandModel } from './car-brand';
 
 export enum CarColors {
@@ -26,6 +28,16 @@ export enum CarColors {
 export type CarModelAttributes = InferAttributes<CarModel>;
 export type CarModelCreationAttributes = InferCreationAttributes<CarModel>;
 
+/**
+ * Always create and modify tables using migration scripts instead of
+ * calling the createTable method, because everytime you restart the
+ * server, the same index will be called multiple times, which will
+ * eventually give you "Too many keys specified; max 64 keys allowed"
+ * error.
+ *
+ * Migrations can be easily replicated on different environments and should
+ * be the preferred way of creating and managing tables.
+ */
 class CarModel extends Model<CarModelAttributes, CarModelCreationAttributes> {
   declare id: CreationOptional<string>;
   name!: string;
@@ -44,9 +56,25 @@ class CarModel extends Model<CarModelAttributes, CarModelCreationAttributes> {
 CarModel.init(
   {
     id: {
+      /**
+       * FYI UUIDv6 must be used instead of v4, as v6 is
+       * Timestamp-based + random whereas v4 is fully random,
+       * thus its better used for indexing. Previously it was
+       * DataTypes.UUIDV4.
+       *
+       * Also use DataTypes.UUID only instead of DataTypes.STRING as
+       * the former is lighter and faster in indexing.
+       */
       type: DataTypes.UUID,
-      defaultValue: DataTypes.UUIDV4,
-      primaryKey: true
+      defaultValue: () => UUIDv6(),
+      primaryKey: true,
+      validate: {
+        isuuidV6(value: string) {
+          if (!isUUIDv6(value)) {
+            throw new Error('Invalid UUID v6 format.');
+          }
+        }
+      }
     },
     name: {
       type: DataTypes.STRING,
@@ -108,21 +136,30 @@ CarModel.init(
         );
       },
     },
-    created_at: DataTypes.DATE,
-    updated_at: DataTypes.DATE,
+    created_at: {
+      type: DataTypes.DATE,
+      allowNull: false,
+      defaultValue: DataTypes.NOW,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      allowNull: false,
+      defaultValue: DataTypes.NOW,
+    }
   },
   {
     sequelize: postgreSequelize,
     /**
      * This will prevent the auto-pluralization performed by Sequelize,
      * ie. the table name will be equal to the model name, without
      * any modifications
+     *
+     * freezeTableName: true,
      */
-    freezeTableName: true,
+    timestamps: true,
     createdAt: 'created_at',
     updatedAt: 'updated_at',
     modelName: 'car',
-    timestamps: true,
     /**
      * Sequelize provides paranoid tables which soft deletes a record
      * by inserting deletedAt timestamp. Timestamps must be enabled to
@@ -157,7 +194,10 @@ CarModel.init(
   }
 );
 
-/* Define the relationship between CarModel and CarBrandModel using optional aliases */
+/**
+ * Define the relationship between CarModel and CarBrandModel
+ * using optional aliases
+ */
 CarModel.belongsTo(CarBrandModel, {
   foreignKey: 'brand_id',
   as: 'brand',
@@ -167,7 +207,7 @@ CarModel.belongsTo(CarBrandModel, {
 
 CarBrandModel.hasMany(CarModel, {
   foreignKey: 'brand_id',
-  as: 'cars',
+  as: 'carModels',
 });
 
 
@@ -176,12 +216,9 @@ CarBrandModel.hasMany(CarModel, {
  * if it exists. The former option will drop the table while the
  * latter performs the necessary changes in the table to make it
  * match the model.
+ *
+ * await CarModel.sync({ alter: shouldAlterTable });
  */
-async function createTable() {
-  await CarModel.sync({ alter: shouldAlterTable });
-}
-
-createTable();
 
 export { CarModel };
 

apps/express-server/src/db/postgres/models/index.ts

@@ -1,2 +1,3 @@
+export * from './buyer';
 export * from './car-brand';
 export * from './car';