@autofleet/sadot 0.8.3 → 0.8.5

package/dist/index.js

@@ -35,7 +35,7 @@ const useCustomFields = async (app, getModel, options) => {
     if (app) {
         app.use('/api', api_1.default);
     }
-    const sequelize = (0, db_1.default)(options.databaseConfig);
+    const sequelize = options.sequelize ?? (0, db_1.default)(options.databaseConfig);
     if (process.env.NODE_ENV === 'test') {
         await (0, models_1.initTestModels)(sequelize);
     }

package/dist/models/index.d.ts

@@ -6,6 +6,9 @@ import ContextAwareTestModel from './tests/contextAwareModels/ContextAwareTestMo
 import ContextTestModel from './tests/contextAwareModels/ContextTestModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
 import type { CustomFieldOptions } from '../types';
-declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions['getUser']) => Promise<void>;
+declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions['getUser'], { schemaPrefix, schemaVersion }?: {
+    schemaPrefix: string;
+    schemaVersion: string;
+}) => Promise<void>;
 declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
 export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel, initTables, initTestModels, };

package/dist/models/index.js

@@ -23,8 +23,8 @@ const productionModels = [CustomFieldDefinition_1.default, CustomFieldValue_1.de
 const testModels = [TestModel_1.default, AssociatedTestModel_1.default, ContextAwareTestModel_1.default, ContextTestModel_1.default];
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
 const SCHEMA_VERSION = 'fb0fa867-1241-4816-b08d-5ed9060c7ae5';
-const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
-const initTables = async (sequelize, getUser) => {
+const initTables = async (sequelize, getUser, { schemaPrefix, schemaVersion } = { schemaPrefix: SADOT_MIGRATION_PREFIX, schemaVersion: SCHEMA_VERSION }) => {
+    const CUSTOM_FIELDS_SCHEMA_VERSION = `${schemaPrefix}_${schemaVersion}`;
     logger_1.default.info('custom-fields: initialize custom-fields tables');
     // Detect models and import them to the orm
     // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -61,14 +61,22 @@ const initTables = async (sequelize, getUser) => {
         timestamps: false,
         schema: 'public',
     });
-    const migrations = await SequelizeMeta.findAll({ raw: true });
-    const currentSadotSchemaVersion = migrations.reverse().find((m) => m.name.includes(SADOT_MIGRATION_PREFIX));
-    if (!currentSadotSchemaVersion
-        || currentSadotSchemaVersion.name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
+    const migrations = await SequelizeMeta.findAll({ where: { name: { [sequelize_1.Op.like]: `${schemaPrefix}%` } }, raw: true });
+    const currentSadotSchemaVersion = migrations.at(-1);
+    const expectedSchemaVersionIndex = migrations.findIndex((m) => m.name === CUSTOM_FIELDS_SCHEMA_VERSION);
+    if (!currentSadotSchemaVersion || currentSadotSchemaVersion.name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
         await CustomFieldDefinition_1.default.sync({ alter: true });
         await CustomFieldValue_1.default.sync({ alter: true });
-        await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
+        if (expectedSchemaVersionIndex === -1) {
+            await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
+        }
         logger_1.default.info('custom-fields: models synced');
+        if (migrations.length && expectedSchemaVersionIndex !== -1 && expectedSchemaVersionIndex < migrations.length - 1) {
+            // We have existing migrations, and we are calling `sync`.
+            // This means we are in a `down` migration, and hence we should delete newer migrations to ensure we can reapply them.
+            const migrationsToDelete = migrations.slice(expectedSchemaVersionIndex + 1);
+            await SequelizeMeta.destroy({ where: { name: { [sequelize_1.Op.in]: migrationsToDelete.map((m) => m.name) } } });
+        }
     }
 };
 exports.initTables = initTables;

package/dist/tests/helpers/commonHooks.d.ts

@@ -0,0 +1,3 @@
+import type { Application } from 'express';
+import type { Models } from '../../types';
+export declare function commonTestHooks(app?: Application | null, models?: Models[]): void;

package/dist/tests/helpers/commonHooks.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commonTestHooks = void 0;
+const __1 = __importDefault(require("../.."));
+const _1 = require(".");
+const database_config_1 = __importDefault(require("./database-config"));
+const db_1 = __importStar(require("../../utils/db"));
+function commonTestHooks(app = null, models = [{ name: 'TestModel', scopeAttributes: ['fleetId'] }]) {
+    let sequelize;
+    beforeAll(async () => {
+        sequelize = (0, db_1.default)(database_config_1.default);
+        await (0, db_1.createSequelizeMeta)(sequelize);
+        await (0, __1.default)(app, _1.getModel, {
+            models,
+            databaseConfig: database_config_1.default,
+            getUser: () => undefined,
+            sequelize,
+        });
+    });
+    afterEach(async () => {
+        jest.clearAllMocks();
+        await (0, _1.cleanup)();
+    });
+    afterAll(async () => {
+        await sequelize.close();
+    });
+}
+exports.commonTestHooks = commonTestHooks;

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import type { IncludeOptions } from 'sequelize';
-import type { ModelCtor } from 'sequelize-typescript';
+import type { ModelCtor, Sequelize } from 'sequelize-typescript';
 import type { getUser as GetUserType } from '@autofleet/zehut';
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
@@ -29,4 +29,5 @@ export type CustomFieldOptions = {
     models: Models[];
     databaseConfig: any;
     getUser: typeof GetUserType;
+    sequelize?: Sequelize;
 };

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
     "start": "ts-node src/index.ts",
     "build": "rm -rf dist && tsc",
     "linter": "eslint .",
-    "test": "jest --forceExit --runInBand",
-    "coverage": "jest --coverage --forceExit --runInBand && rm -rf ./coverage",
+    "test": "jest --runInBand",
+    "coverage": "jest --coverage --runInBand && rm -rf ./coverage",
     "build-to-local-repo": "node --run build && cp -r dist/* ../$REPO/node_modules/$npm_package_name/dist",
     "dev": "nodemon",
     "watch": "npm-watch build-to-local-repo",

package/src/index.ts

@@ -30,7 +30,7 @@ const useCustomFields = async (
   if (app) {
     app.use('/api', api);
   }
-  const sequelize = initDB(options.databaseConfig);
+  const sequelize = options.sequelize ?? initDB(options.databaseConfig);
   if (process.env.NODE_ENV === 'test') {
     await initTestModels(sequelize);
   }

package/src/models/index.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-param-reassign */
-import { DataTypes } from 'sequelize';
+import { DataTypes, Op } from 'sequelize';
 import type { Sequelize } from 'sequelize-typescript';
 import logger from '../utils/logger';
 import CustomFieldDefinition from './CustomFieldDefinition';
@@ -15,9 +15,13 @@ const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, Conte
 
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
 const SCHEMA_VERSION = 'fb0fa867-1241-4816-b08d-5ed9060c7ae5';
-const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
 
-const initTables = async (sequelize: Sequelize, getUser: CustomFieldOptions['getUser']): Promise<void> => {
+const initTables = async (
+  sequelize: Sequelize,
+  getUser: CustomFieldOptions['getUser'],
+  { schemaPrefix, schemaVersion } = { schemaPrefix: SADOT_MIGRATION_PREFIX, schemaVersion: SCHEMA_VERSION },
+): Promise<void> => {
+  const CUSTOM_FIELDS_SCHEMA_VERSION = `${schemaPrefix}_${schemaVersion}`;
   logger.info('custom-fields: initialize custom-fields tables');
   // Detect models and import them to the orm
   // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -61,17 +65,24 @@ const initTables = async (sequelize: Sequelize, getUser: CustomFieldOptions['get
       schema: 'public',
     },
   );
-  const migrations = await SequelizeMeta.findAll({ raw: true });
-  const currentSadotSchemaVersion = migrations.reverse().find((m: any) => m.name.includes(SADOT_MIGRATION_PREFIX));
 
-  if (
-    !currentSadotSchemaVersion
-    || (currentSadotSchemaVersion as any).name !== CUSTOM_FIELDS_SCHEMA_VERSION
-  ) {
+  const migrations = await SequelizeMeta.findAll({ where: { name: { [Op.like]: `${schemaPrefix}%` } }, raw: true });
+  const currentSadotSchemaVersion = migrations.at(-1);
+  const expectedSchemaVersionIndex = migrations.findIndex((m) => (m as any).name === CUSTOM_FIELDS_SCHEMA_VERSION);
+
+  if (!currentSadotSchemaVersion || (currentSadotSchemaVersion as any).name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
     await CustomFieldDefinition.sync({ alter: true });
     await CustomFieldValue.sync({ alter: true });
-    await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
+    if (expectedSchemaVersionIndex === -1) {
+      await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
+    }
     logger.info('custom-fields: models synced');
+    if (migrations.length && expectedSchemaVersionIndex !== -1 && expectedSchemaVersionIndex < migrations.length - 1) {
+      // We have existing migrations, and we are calling `sync`.
+      // This means we are in a `down` migration, and hence we should delete newer migrations to ensure we can reapply them.
+      const migrationsToDelete = migrations.slice(expectedSchemaVersionIndex + 1);
+      await SequelizeMeta.destroy({ where: { name: { [Op.in]: migrationsToDelete.map((m) => (m as any).name) } } });
+    }
   }
 };
 

package/src/tests/helpers/commonHooks.ts

@@ -0,0 +1,31 @@
+import type { Application } from 'express';
+import type { Sequelize } from 'sequelize-typescript';
+import useCustomFields from '../..';
+import { cleanup, getModel } from '.';
+import databaseConfig from './database-config';
+import initDB, { createSequelizeMeta } from '../../utils/db';
+import type { Models } from '../../types';
+
+export function commonTestHooks(app: Application | null = null, models: Models[] = [{ name: 'TestModel', scopeAttributes: ['fleetId'] }]) {
+  let sequelize: Sequelize;
+
+  beforeAll(async () => {
+    sequelize = initDB(databaseConfig);
+    await createSequelizeMeta(sequelize);
+    await useCustomFields(app, getModel, {
+      models,
+      databaseConfig,
+      getUser: () => undefined,
+      sequelize,
+    });
+  });
+
+  afterEach(async () => {
+    jest.clearAllMocks();
+    await cleanup();
+  });
+
+  afterAll(async () => {
+    await sequelize.close();
+  });
+}

package/src/types/index.ts

@@ -1,5 +1,5 @@
 import type { IncludeOptions } from 'sequelize';
-import type { ModelCtor } from 'sequelize-typescript';
+import type { ModelCtor, Sequelize } from 'sequelize-typescript';
 import type { getUser as GetUserType } from '@autofleet/zehut';
 
 export type ModelFetcher = (name: string) => any;
@@ -33,4 +33,5 @@ export type CustomFieldOptions = {
   models: Models[];
   databaseConfig: any;
   getUser: typeof GetUserType;
+  sequelize?: Sequelize;
 };