@autofleet/sadot 0.5.4-beta.20 → 0.5.4-beta.22

package/dist/api/v1/definition/index.js

@@ -83,7 +83,7 @@ router.get('/', async (req, res) => {
         if (entityIds?.length > 0) {
             where.entityId = entityIds;
         }
-        const customFieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true });
+        const customFieldDefinitions = await DefinitionRepo.findAll({ ...where }, { withDisabled: true });
         return res.json(customFieldDefinitions);
     }
     catch (err) {

package/dist/hooks/create.d.ts

@@ -7,4 +7,4 @@ export declare const beforeBulkCreate: (options: any) => void;
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export declare const beforeCreate: (scopeAttributes: string[], modelOptions: ModelOptions) => (instance: any, options: any) => Promise<void>;
+export declare const beforeCreate: (scopeAttributes: string[], modelOptions?: ModelOptions) => (instance: any, options: any) => Promise<void>;

package/dist/hooks/create.js

@@ -44,7 +44,7 @@ exports.beforeBulkCreate = beforeBulkCreate;
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-const beforeCreate = (scopeAttributes, modelOptions) => async (instance, options) => {
+const beforeCreate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
     const { fields } = options;
     const modelType = instance.constructor.name;
     const { scopeAttributeReplacer } = modelOptions;

package/dist/hooks/enrich.d.ts

@@ -3,5 +3,5 @@ type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-declare const enrichResults: (modelType: string, scopeAttributes: string[], getScope: any, hookType?: SupportedHookTypes, modelOptions?: ModelOptions) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
+declare const enrichResults: (modelType: string, scopeAttributes: string[], hookType?: SupportedHookTypes, modelOptions?: ModelOptions) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
 export default enrichResults;

package/dist/hooks/enrich.js

@@ -45,7 +45,7 @@ const serializeCustomFields = (customFieldValues, customFieldDefinitionsHash) =>
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-const enrichResults = (modelType, scopeAttributes, getScope, hookType, modelOptions) => async (instancesOrInstance, options) => {
+const enrichResults = (modelType, scopeAttributes, hookType, modelOptions = {}) => async (instancesOrInstance, options) => {
     const { scopeAttributeReplacer } = modelOptions;
     if (options.originalAttributes?.length > 0
         && !options.originalAttributes?.includes?.('customFields')) {
@@ -63,7 +63,7 @@ const enrichResults = (modelType, scopeAttributes, getScope, hookType, modelOpti
         ...map,
         [identifier]: [],
     }), {});
-    const customFieldDefinitions = await DefinitionRepo.findByEntityIds(modelType, uniqueIdentifiers, { transaction: options.transaction, getScope });
+    const customFieldDefinitions = await DefinitionRepo.findByEntityIds(modelType, uniqueIdentifiers, { transaction: options.transaction });
     const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({
         ...map,
         [definition.id]: definition,

package/dist/hooks/update.d.ts

@@ -7,4 +7,4 @@ export declare const beforeBulkUpdate: (options: any) => void;
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export declare const beforeUpdate: (scopeAttributes: string[], modelOptions: ModelOptions) => (instance: any, options: any) => Promise<void>;
+export declare const beforeUpdate: (scopeAttributes: string[], modelOptions?: ModelOptions) => (instance: any, options: any) => Promise<void>;

package/dist/hooks/update.js

@@ -43,7 +43,7 @@ exports.beforeBulkUpdate = beforeBulkUpdate;
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-const beforeUpdate = (scopeAttributes, modelOptions) => async (instance, options) => {
+const beforeUpdate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
     logger_1.default.debug('sadot - before update hook');
     const { fields } = options;
     const { scopeAttributeReplacer } = modelOptions;

package/dist/repository/definition.js

@@ -1,23 +1,18 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRequiredFields = exports.destroy = exports.disable = exports.update = exports.findDefinitionsByModels = exports.findByWhere = exports.findByEntityIds = exports.findById = exports.findByIds = exports.findAll = exports.create = void 0;
 const sequelize_1 = require("sequelize");
 const models_1 = require("../models");
-const logger_1 = __importDefault(require("../utils/logger"));
 const create = (data) => models_1.CustomFieldDefinition.create(data);
 exports.create = create;
 const findAll = (where, options = { withDisabled: false }) => {
     const queryModel = options.withDisabled
         ? models_1.CustomFieldDefinition.unscoped()
         : models_1.CustomFieldDefinition;
-    logger_1.default.info('sadot - whereQuery', { options });
     return queryModel.scope('userScope').findAll({
         where,
+        transaction: options.transaction,
         raw: true,
-        logging: true,
     });
 };
 exports.findAll = findAll;
@@ -37,7 +32,6 @@ const findByEntityIds = async (modelType, entityIds, options = {}) => models_1.C
         entityId: entityIds,
     },
     transaction: options.transaction,
-    include: options.include,
     raw: true,
 });
 exports.findByEntityIds = findByEntityIds;

package/dist/repository/value.js

@@ -77,11 +77,11 @@ const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, opt
     logger_1.default.info(`custom-fields: updating values for ${modelType} ${modelId}`, {
         names, options, valuesToUpdate, entityId: identifiers,
     });
-    const fieldDefinitions = (await DefinitionRepo.findAll({
+    const fieldDefinitions = await DefinitionRepo.findAll({
         modelType,
         name: names,
         entityId: identifiers,
-    }, { withDisabled: true, transaction: options.transaction })) || [];
+    }, { withDisabled: true, transaction: options.transaction }) || [];
     const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
     if (fieldDefinitions.length !== names.length) {
         logger_1.default.info(`custom-fields: missing definitions for ${modelType} ${modelId}`, { names, fieldDefinitions });

package/dist/tests/mocks/testModel.d.ts

@@ -1,5 +1,5 @@
 import { TestModel } from '../../models';
-export declare const createTestModel: (payload?: {}, model?: any) => any;
+export declare const createTestModel: (payload?: {}) => Promise<TestModel>;
 export declare const createTestModels: (fleetId: any, total: number) => Promise<TestModel[]>;
 export declare const upsertTestModel: (payload: any) => Promise<[TestModel, boolean]>;
 export declare const destroyTestModels: () => Promise<number>;

package/dist/tests/mocks/testModel.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTestModelWithAssociation = exports.createTestModelWithAssociation = exports.updateTestModel = exports.getSomeTestModels = exports.getTestModel = exports.destroyTestModels = exports.upsertTestModel = exports.createTestModels = exports.createTestModel = void 0;
 const models_1 = require("../../models");
-const createTestModel = (payload = {}, model = models_1.TestModel) => model.create(payload);
+const createTestModel = (payload = {}) => models_1.TestModel.create(payload);
 exports.createTestModel = createTestModel;
 const createTestModels = (fleetId, total) => {
     const models = [];

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
-    scopeAttributeReplacer?: (attributes?: string[]) => Promise<any>;
+    scopeAttributeReplacer?: (attributes?: string[]) => Promise<(string | undefined)[]>;
 };
 export type Models = {
     name: string;

package/dist/utils/init.js

@@ -33,9 +33,9 @@ const addHooks = (models, getModel) => {
             model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', hooks_1.beforeBulkUpdate);
             model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes, modelOptions));
             model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes, modelOptions));
-            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind', null, modelOptions));
-            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, modelOptions));
-            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, modelOptions));
+            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind', modelOptions));
+            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, modelOptions));
+            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, modelOptions));
         }
         catch (e) {
             logger_1.default.error(`Could not add custom fields hook to model ${name}. `, e);

package/dist/utils/scopeAttributes.d.ts

@@ -1,3 +1,3 @@
 import { ModelOptions } from '../types';
-declare const getScopeAttributes: (instance: any, scopeAttributes: string[], scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']) => Promise<any[]>;
+declare const getScopeAttributes: (instance: any, scopeAttributes: string[], scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']) => Promise<string[]>;
 export default getScopeAttributes;

package/dist/utils/scopeAttributes.js

@@ -1,16 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const getIdentifiers = (instance, scopeAttributes) => {
+const attributeCache = new Map();
+const mapAttributeToInstance = (scopeAttributes, instance) => scopeAttributes.map((attr) => instance[attr]);
+const buildAttributesByInstance = (instance, scopeAttributes) => {
     if (Array.isArray(instance)) {
-        return instance.map((ins) => scopeAttributes.map((attr) => ins[attr])).flat();
+        return instance.flatMap((ins) => mapAttributeToInstance(scopeAttributes, ins));
     }
-    return scopeAttributes.map((attribute) => instance[attribute]);
+    return mapAttributeToInstance(scopeAttributes, instance);
 };
 const getScopeAttributes = async (instance, scopeAttributes, scopeAttributeReplacer) => {
-    let identifiers = getIdentifiers(instance, scopeAttributes);
-    if (scopeAttributeReplacer) {
-        identifiers = await scopeAttributeReplacer(identifiers);
+    const attributes = buildAttributesByInstance(instance, scopeAttributes);
+    const attributeCacheKey = attributes.join();
+    const cachedAttributes = attributeCache.get(attributeCacheKey);
+    if (cachedAttributes) {
+        return cachedAttributes;
     }
-    return identifiers;
+    const attributeResult = (scopeAttributeReplacer
+        ? await scopeAttributeReplacer(attributes) : attributes);
+    attributeCache.set(attributeCacheKey, attributeResult);
+    return attributeResult;
 };
 exports.default = getScopeAttributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.5.4-beta.20",
+  "version": "0.5.4-beta.22",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -35,7 +35,6 @@
     "@autofleet/logger": "^2.0.5",
     "express": "^4.18.2",
     "joi": "^17.7.0",
-    "npm-watch": "^0.11.0",
     "pg": "^8.10.0",
     "reflect-metadata": "^0.1.13",
     "sequelize": "^6.31.1",
@@ -52,6 +51,7 @@
     "eslint-config-airbnb-typescript": "^12.0.0",
     "eslint-plugin-import": "^2.22.1",
     "jest": "^27.0.5",
+    "npm-watch": "^0.11.0",
     "ts-jest": "^27.0.3",
     "ts-node": "^8.6.2",
     "typescript": "^4.9.5",
@@ -59,4 +59,4 @@
   },
   "author": "Autofleet",
   "license": "ISC"
-}
+}

package/src/api/v1/definition/index.ts

@@ -65,7 +65,7 @@ router.get('/', async (req, res) => {
     if (entityIds?.length > 0) {
       where.entityId = entityIds;
     }
-    const customFieldDefinitions = await DefinitionRepo.findAll(where,
+    const customFieldDefinitions = await DefinitionRepo.findAll({ ...where },
       { withDisabled: true });
     return res.json(customFieldDefinitions);
   } catch (err) {

package/src/hooks/create.ts

@@ -16,7 +16,7 @@ export const beforeBulkCreate = (options): void => {
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptions) => async (
+export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptions = {}) => async (
   instance,
   options,
 ): Promise<void> => {

package/src/hooks/enrich.ts

@@ -32,9 +32,8 @@ const serializeCustomFields = (
 const enrichResults = (
   modelType: string,
   scopeAttributes: string[],
-  getScope,
   hookType?: SupportedHookTypes,
-  modelOptions?: ModelOptions,
+  modelOptions: ModelOptions = {},
 ) => async (
   instancesOrInstance: any | any[],
   options,
@@ -68,7 +67,7 @@ const enrichResults = (
   const customFieldDefinitions = await DefinitionRepo.findByEntityIds(
     modelType,
     uniqueIdentifiers,
-    { transaction: options.transaction, getScope },
+    { transaction: options.transaction },
   );
 
   const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({

package/src/hooks/update.ts

@@ -16,7 +16,7 @@ export const beforeBulkUpdate = (options): void => {
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export const beforeUpdate = (scopeAttributes: string[], modelOptions: ModelOptions) => async (
+export const beforeUpdate = (scopeAttributes: string[], modelOptions: ModelOptions = {}) => async (
   instance,
   options,
 ): Promise<void> => {

package/src/repository/definition.ts

@@ -3,7 +3,6 @@ import {
 } from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
-import logger from '../utils/logger';
 
 export const create = (data: CreateCustomFieldDefinition): Promise<CustomFieldDefinition> =>
   CustomFieldDefinition.create(data);
@@ -16,11 +15,10 @@ export const findAll = (
     ? CustomFieldDefinition.unscoped()
     : CustomFieldDefinition;
 
-  logger.info('sadot - whereQuery', { options });
   return queryModel.scope('userScope').findAll({
     where,
+    transaction: options.transaction,
     raw: true,
-    logging: true,
   });
 };
 
@@ -50,7 +48,6 @@ export const findByEntityIds = async (
     entityId: entityIds,
   },
   transaction: options.transaction,
-  include: options.include,
   raw: true,
 });
 
@@ -108,6 +105,6 @@ export const getRequiredFields = async (
     },
     logging: true,
   });
-  const requiredFieldsNames = requiredFields.map((definition:any) => definition.name);
+  const requiredFieldsNames = requiredFields.map((definition) => definition.name);
   return [...new Set(requiredFieldsNames)];
 };

package/src/repository/value.ts

@@ -57,14 +57,14 @@ export const updateValues = async (
     names, options, valuesToUpdate, entityId: identifiers,
   });
 
-  const fieldDefinitions = (await DefinitionRepo.findAll(
+  const fieldDefinitions = await DefinitionRepo.findAll(
     {
       modelType,
       name: names,
       entityId: identifiers,
     },
     { withDisabled: true, transaction: options.transaction },
-  )) || [];
+  ) || [];
 
   const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
   if (fieldDefinitions.length !== names.length) {

package/src/tests/mocks/testModel.ts

@@ -1,6 +1,6 @@
 import { TestModel, AssociatedTestModel } from '../../models';
 
-export const createTestModel = (payload = {}, model:any = TestModel) => model.create(payload);
+export const createTestModel = (payload = {}) => TestModel.create(payload);
 
 export const createTestModels = (fleetId, total: number) => {
   const models: Promise<TestModel>[] = [];

package/src/types/index.ts

@@ -1,12 +1,12 @@
 export type ModelFetcher = (name: string) => any;
 
 export type ModelOptions = {
-  scopeAttributeReplacer?: (attributes?: string[]) => Promise<any>;
+  scopeAttributeReplacer?: (attributes?: string[]) => Promise<(string | undefined)[]>;
 }
 export type Models = {
   name: string;
   scopeAttributes: string[];
-  modelOptions?: ModelOptions
+  modelOptions?: ModelOptions;
   creationWebhookHandler?: (instance: any) => any;
   updateWebhookHandler?: (instance: any) => any;
   deletionWebhookHandler?: (instance: any) => any;

package/src/utils/init.ts

@@ -42,9 +42,9 @@ export const addHooks = (models: Models[], getModel: ModelFetcher): void => {
       model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', beforeBulkUpdate);
       model.addHook('beforeCreate', 'sadot-beforeCreate', beforeCreate(scopeAttributes, modelOptions));
       model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(scopeAttributes, modelOptions));
-      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind', null, modelOptions));
-      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes, null, null, modelOptions));
-      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes, null, null, modelOptions));
+      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind', modelOptions));
+      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes, null, modelOptions));
+      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes, null, modelOptions));
     } catch (e) {
       logger.error(`Could not add custom fields hook to model ${name}. `, e);
     }

package/src/utils/scopeAttributes.ts

@@ -1,18 +1,29 @@
 import { ModelOptions } from '../types';
 
-const getIdentifiers = (instance: any, scopeAttributes: string[]) => {
+const attributeCache = new Map<string, string[]>();
+
+const mapAttributeToInstance = (scopeAttributes: string[], instance: any) =>
+  scopeAttributes.map((attr) => instance[attr]);
+
+const buildAttributesByInstance = (instance: any, scopeAttributes: string[]) => {
   if (Array.isArray(instance)) {
-    return instance.map((ins) =>
-      scopeAttributes.map((attr) => ins[attr])).flat();
+    return instance.flatMap((ins) => mapAttributeToInstance(scopeAttributes, ins));
   }
-  return scopeAttributes.map((attribute) => instance[attribute]);
+  return mapAttributeToInstance(scopeAttributes, instance);
 };
-const getScopeAttributes = async (instance: any, scopeAttributes: string[], scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']) => {
-  let identifiers = getIdentifiers(instance, scopeAttributes);
-  if (scopeAttributeReplacer) {
-    identifiers = await scopeAttributeReplacer(identifiers);
+
+const getScopeAttributes = async (instance: any, scopeAttributes: string[],
+  scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']): Promise<string[]> => {
+  const attributes = buildAttributesByInstance(instance, scopeAttributes);
+  const attributeCacheKey = attributes.join();
+  const cachedAttributes = attributeCache.get(attributeCacheKey);
+  if (cachedAttributes) {
+    return cachedAttributes;
   }
-  return identifiers;
+  const attributeResult = (scopeAttributeReplacer
+    ? await scopeAttributeReplacer(attributes) : attributes);
+  attributeCache.set(attributeCacheKey, attributeResult);
+  return attributeResult;
 };
 
 export default getScopeAttributes;