Feat/menu versioning

config/typeorm.config.ts

@@ -13,6 +13,7 @@ export const typeOrmConfig: TypeOrmConfig = (configService: ConfigService) => {
     username: configService.get('JAMIE_API_DATABASE_USER'),
     password: configService.get('JAMIE_API_DATABASE_PASSWORD'),
     database: configService.get('JAMIE_API_DATABASE_NAME'),
+    timezone: 'Z',
     entities: [join(__dirname, '..', 'src', '**', '*.entity{.js,.ts}')],
     subscribers: [join(__dirname, '..', 'src', '**', '*.subscriber{.js,.ts}')],
     migrationsRun: true,

docker-compose.yml

@@ -17,6 +17,8 @@ services:
       MYSQL_DATABASE: 'api'
       MYSQL_USER: 'api'
       MYSQL_PASSWORD: 'api'
+      TZ: '+00:00'
+    command: --default-time-zone=+00:00
 
   prometheus:
     image: bitnami/prometheus

migrations.config.ts

@@ -15,6 +15,7 @@ export default new DataSource({
   username: configService.get('JAMIE_API_DATABASE_USER'),
   password: configService.get('JAMIE_API_DATABASE_PASSWORD'),
   database: configService.get('JAMIE_API_DATABASE_NAME'),
+  timezone: 'Z',
   entities: [join(__dirname, 'dist', 'src', '**', '*.entity.js')],
   migrations: [join(__dirname, 'dist', 'migrations', '*.js')],
   namingStrategy: new SnakeNamingStrategy(),

migrations/1677257893669-CreateMenuRevisions.ts

@@ -0,0 +1,21 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class CreateMenuRevisions1677257893669 implements MigrationInterface {
+  name = 'CreateMenuRevisions1677257893669';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE \`menu_revisions\` (\`id\` int NOT NULL, \`menu_id\` int NOT NULL, \`description\` text NOT NULL, \`snapshot\` text NOT NULL, \`created_at\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6), PRIMARY KEY (\`id\`, \`menu_id\`)) ENGINE=InnoDB`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_revisions\` ADD CONSTRAINT \`FK_ae57a5041c46e5dba5810a73030\` FOREIGN KEY (\`menu_id\`) REFERENCES \`menus\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menu_revisions\` DROP FOREIGN KEY \`FK_ae57a5041c46e5dba5810a73030\``,
+    );
+    await queryRunner.query(`DROP TABLE \`menu_revisions\``);
+  }
+}

migrations/1677272600645-AddCurrentRevisionToMenu.ts

@@ -0,0 +1,31 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddCurrentRevisionToMenu1677272600645
+  implements MigrationInterface
+{
+  name = 'AddCurrentRevisionToMenu1677272600645';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`current_revision_id\` int NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`current_revision_menu_id\` int NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD CONSTRAINT \`FK_27681781e1b6b13225c733fb648\` FOREIGN KEY (\`current_revision_id\`, \`current_revision_menu_id\`) REFERENCES \`menu_revisions\`(\`id\`,\`menu_id\`) ON DELETE CASCADE ON UPDATE CASCADE`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` DROP FOREIGN KEY \`FK_27681781e1b6b13225c733fb648\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` DROP COLUMN \`current_revision_menu_id\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` DROP COLUMN \`current_revision_id\``,
+    );
+  }
+}

migrations/1677279793975-MenuItemCompositePrimaryKey.ts

@@ -0,0 +1,43 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class MenuItemCompositePrimaryKey1677279793975
+  implements MigrationInterface
+{
+  name = 'MenuItemCompositePrimaryKey1677279793975';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP FOREIGN KEY \`FK_8e20ca40202c116fdafe92cdc4e\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD \`parent_menu_id\` int NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` CHANGE \`id\` \`id\` int NOT NULL`,
+    );
+    await queryRunner.query(`ALTER TABLE \`menu_items\` DROP PRIMARY KEY`);
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD PRIMARY KEY (\`id\`, \`menu_id\`)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD CONSTRAINT \`FK_410d05637be571e7fc8973ae364\` FOREIGN KEY (\`parent_id\`, \`parent_menu_id\`) REFERENCES \`menu_items\`(\`id\`,\`menu_id\`) ON DELETE CASCADE ON UPDATE CASCADE`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP FOREIGN KEY \`FK_410d05637be571e7fc8973ae364\``,
+    );
+    await queryRunner.query(`ALTER TABLE \`menu_items\` DROP PRIMARY KEY`);
+    await queryRunner.query(`ALTER TABLE \`menu_items\` DROP COLUMN \`id\``);
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD \`id\` int NOT NULL AUTO_INCREMENT, ADD PRIMARY KEY (\`id\`)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP COLUMN \`parent_menu_id\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD CONSTRAINT \`FK_8e20ca40202c116fdafe92cdc4e\` FOREIGN KEY (\`parent_id\`) REFERENCES \`menu_items\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE`,
+    );
+  }
+}

migrations/1677304809626-AddVersionAndTimestampsToMenu.ts

@@ -0,0 +1,29 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddVersionAndTimestampsToMenu1677304809626
+  implements MigrationInterface
+{
+  name = 'AddVersionAndTimestampsToMenu1677304809626';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`created_at\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`updated_at\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`deleted_at\` datetime(6) NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`version\` int NOT NULL`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE \`menus\` DROP COLUMN \`version\``);
+    await queryRunner.query(`ALTER TABLE \`menus\` DROP COLUMN \`deleted_at\``);
+    await queryRunner.query(`ALTER TABLE \`menus\` DROP COLUMN \`updated_at\``);
+    await queryRunner.query(`ALTER TABLE \`menus\` DROP COLUMN \`created_at\``);
+  }
+}

migrations/1677305371145-AddVersionAndTimestampsToMenuItem.ts

@@ -0,0 +1,37 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddVersionAndTimestampsToMenuItem1677305371145
+  implements MigrationInterface
+{
+  name = 'AddVersionAndTimestampsToMenuItem1677305371145';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD \`created_at\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD \`updated_at\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD \`deleted_at\` datetime(6) NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` ADD \`version\` int NOT NULL`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP COLUMN \`version\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP COLUMN \`deleted_at\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP COLUMN \`updated_at\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menu_items\` DROP COLUMN \`created_at\``,
+    );
+  }
+}

migrations/1677320214393-AddPublishedRevisionToMenu.ts

@@ -0,0 +1,31 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddPublishedRevisionToMenu1677320214393
+  implements MigrationInterface
+{
+  name = 'AddPublishedRevisionToMenu1677320214393';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`published_revision_id\` int NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD \`published_revision_menu_id\` int NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` ADD CONSTRAINT \`FK_e4bf608a85adf722bc3015bbb8a\` FOREIGN KEY (\`published_revision_id\`, \`published_revision_menu_id\`) REFERENCES \`menu_revisions\`(\`id\`,\`menu_id\`) ON DELETE CASCADE ON UPDATE CASCADE`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` DROP FOREIGN KEY \`FK_e4bf608a85adf722bc3015bbb8a\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` DROP COLUMN \`published_revision_menu_id\``,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`menus\` DROP COLUMN \`published_revision_id\``,
+    );
+  }
+}

src/common/errors/entity-not-found.error.ts

@@ -0,0 +1,22 @@
+import { GraphQLError } from 'graphql';
+
+export class EntityNotFoundError<
+  T extends string | { name: string },
+> extends GraphQLError {
+  constructor(entity: T, id: number) {
+    const e =
+      typeof entity === 'string'
+        ? entity
+        : entity.constructor?.name !== 'Function'
+        ? entity.constructor.name
+        : entity.name;
+    super(`${e} with id ${id} not found`, {
+      extensions: {
+        code: 'ENTITY_NOT_FOUND',
+        entity: e,
+        id,
+      },
+    });
+    this.name = 'EntityNotFoundError';
+  }
+}

src/common/errors/field-validation.error.ts

@@ -57,6 +57,7 @@ class FieldValidationError extends GraphQLError {
     IS_UNIQUE: 'isUnique',
     // Menu Meta
     META_TYPE_CANNOT_BE_CHANGED: 'metaTypeCannotBeChanged',
+    META_DEFAULT_VALUE_REQUIRED: 'metaDefaultValueRequired',
     // Menu Item Meta
     META_REQUIRED: 'metaRequired',
   };

src/common/helpers/paginate.helper.ts

@@ -3,17 +3,18 @@ import { PageInfo } from '../schema/objects/page-info.object';
 import { PaginationArgs } from '../schema/args/pagination.arg';
 import { SelectQueryBuilder, MoreThan, LessThan } from 'typeorm';
 import { Direction } from '../schema/enums/direction.enum';
+import { Connection } from '../types';
 
 /**
- * Based on https://gist.github.com/VojtaSim/6b03466f1964a6c81a3dbf1f8cec8d5c
+ * Based on https://gist.github.com/tumainimosha/6652deb0aea172f7f2c4b2077c72d16c
  */
 export async function paginate<T>(
   query: SelectQueryBuilder<T>,
   paginationArgs: PaginationArgs,
   cursorColumn = 'id',
   direction = Direction.ASC,
   defaultLimit = 25,
-): Promise<any> {
+): Promise<Connection<T>> {
   const logger = new Logger('Pagination');
 
   // pagination ordering
@@ -27,7 +28,7 @@ export async function paginate<T>(
       const offsetId = Number(
         Buffer.from(paginationArgs.after, 'base64').toString('ascii'),
       );
-      logger.verbose(`Paginate AfterID: ${offsetId}`);
+      logger.verbose(`Paginate After ID: ${offsetId}`);
       query.where({ [cursorColumn]: MoreThan(offsetId) });
     }
 
@@ -41,7 +42,7 @@ export async function paginate<T>(
     const offsetId = Number(
       Buffer.from(paginationArgs.before, 'base64').toString('ascii'),
     );
-    logger.verbose(`Paginate BeforeID: ${offsetId}`);
+    logger.verbose(`Paginate Before ID: ${offsetId}`);
 
     const limit = paginationArgs.last ?? defaultLimit;
 
@@ -81,8 +82,8 @@ export async function paginate<T>(
       .getCount();
   }
 
-  logger.debug(`CountBefore:${countBefore}`);
-  logger.debug(`CountAfter:${countAfter}`);
+  logger.verbose(`CountBefore: ${countBefore}`);
+  logger.verbose(`CountAfter: ${countAfter}`);
 
   const edges = result.map((value) => {
     return {

src/common/schema/objects/versioned-timestamped.object.ts

@@ -0,0 +1,28 @@
+import { Field, Int, ObjectType } from '@nestjs/graphql';
+import {
+  CreateDateColumn,
+  DeleteDateColumn,
+  UpdateDateColumn,
+  VersionColumn,
+} from 'typeorm';
+
+@ObjectType({ isAbstract: true })
+export abstract class Timestamped {
+  @Field(() => Date)
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @Field(() => Date)
+  @UpdateDateColumn()
+  updatedAt: Date;
+
+  @DeleteDateColumn()
+  deletedAt?: Date;
+}
+
+@ObjectType({ isAbstract: true })
+export abstract class VersionedTimestamped extends Timestamped {
+  @Field(() => Int)
+  @VersionColumn()
+  version: number;
+}

src/common/types/model.type.ts

@@ -1,4 +1,7 @@
+import { MenuItem } from 'src/menu-items/entities/menu-item.entity';
+import { MenuMeta } from 'src/menus/objects/menu-meta.object';
 import { InputAction } from '../schema/enums/input-action.enum';
+import { PageInfo } from '../schema/objects/page-info.object';
 
 export enum MenuMetaType {
   TEXT = 'text',
@@ -26,4 +29,23 @@ export interface IMenuItemMeta {
   [index: number]: unknown;
 }
 
+export interface MenuRevisionSnapshot {
+  name: string;
+  meta?: MenuMeta[];
+  items?: MenuItem[];
+  template?: string;
+  templateFormat?: string;
+}
+
 export type WithAction<T> = T & { action?: InputAction };
+
+export interface Edge<T> {
+  cursor: string;
+  node: T;
+}
+
+export interface Connection<T> {
+  edges: Edge<T>[];
+  pageInfo: PageInfo;
+  totalCount: number;
+}

src/menu-items/entities/menu-item.entity.ts

@@ -1,5 +1,6 @@
 import { Field, Int, ObjectType } from '@nestjs/graphql';
 import { TemplateFormat } from 'src/common/enums/template-format.enum';
+import { VersionedTimestamped } from 'src/common/schema/objects/versioned-timestamped.object';
 import { GraphQLJSONObject } from 'src/common/schema/scalars/json.scalar';
 import { IMenuItemMeta } from 'src/common/types';
 import { Menu } from 'src/menus/entities/menu.entity';
@@ -9,14 +10,14 @@ import {
   JoinColumn,
   ManyToOne,
   OneToMany,
-  PrimaryGeneratedColumn,
+  PrimaryColumn,
 } from 'typeorm';
 
 @ObjectType()
 @Entity('menu_items')
-export class MenuItem {
+export class MenuItem extends VersionedTimestamped {
   @Field(() => Int)
-  @PrimaryGeneratedColumn()
+  @PrimaryColumn()
   id: number;
 
   @Field()
@@ -63,7 +64,7 @@ export class MenuItem {
   menu: Menu;
 
   @Field(() => Int)
-  @Column()
+  @PrimaryColumn()
   menuId?: number;
 
   @Field(() => Boolean, { nullable: false })