followup: centralize widget common properties and add widget bulk update integration tests (#18225)

followup
https://github.com/twentyhq/twenty/pull/18015#pullrequestreview-3818929035

packages/twenty-server/src/engine/metadata-modules/flat-page-layout-widget/utils/build-flat-page-layout-widget-common-properties.util.ts

@@ -0,0 +1,56 @@
+import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
+import { resolveEntityRelationUniversalIdentifiers } from 'src/engine/metadata-modules/flat-entity/utils/resolve-entity-relation-universal-identifiers.util';
+import { type FlatPageLayoutWidget } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget.type';
+import { type CreatePageLayoutWidgetInput } from 'src/engine/metadata-modules/page-layout-widget/dtos/inputs/create-page-layout-widget.input';
+
+export const buildFlatPageLayoutWidgetCommonProperties = ({
+  widgetInput,
+  flatPageLayoutTabMaps,
+  flatObjectMetadataMaps,
+}: {
+  widgetInput: Pick<
+    CreatePageLayoutWidgetInput,
+    | 'pageLayoutTabId'
+    | 'title'
+    | 'type'
+    | 'objectMetadataId'
+    | 'gridPosition'
+    | 'position'
+  >;
+} & Pick<
+  AllFlatEntityMaps,
+  'flatPageLayoutTabMaps' | 'flatObjectMetadataMaps'
+>): Pick<
+  FlatPageLayoutWidget,
+  | 'pageLayoutTabId'
+  | 'pageLayoutTabUniversalIdentifier'
+  | 'title'
+  | 'type'
+  | 'objectMetadataId'
+  | 'objectMetadataUniversalIdentifier'
+  | 'gridPosition'
+  | 'position'
+> => {
+  const {
+    pageLayoutTabUniversalIdentifier,
+    objectMetadataUniversalIdentifier,
+  } = resolveEntityRelationUniversalIdentifiers({
+    metadataName: 'pageLayoutWidget',
+    foreignKeyValues: {
+      pageLayoutTabId: widgetInput.pageLayoutTabId,
+      objectMetadataId: widgetInput.objectMetadataId,
+    },
+    flatEntityMaps: { flatPageLayoutTabMaps, flatObjectMetadataMaps },
+  });
+
+  return {
+    pageLayoutTabId: widgetInput.pageLayoutTabId,
+    pageLayoutTabUniversalIdentifier,
+    title: widgetInput.title,
+    type: widgetInput.type,
+    objectMetadataId: widgetInput.objectMetadataId ?? null,
+    objectMetadataUniversalIdentifier,
+    gridPosition: widgetInput.gridPosition,
+    position: widgetInput.position ?? null,
+  };
+};

packages/twenty-server/src/engine/metadata-modules/flat-page-layout-widget/utils/from-create-page-layout-widget-input-to-flat-page-layout-widget-to-create.util.ts

@@ -3,8 +3,8 @@ import { v4 } from 'uuid';
 
 import { type FlatApplication } from 'src/engine/core-modules/application/types/flat-application.type';
 import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
-import { resolveEntityRelationUniversalIdentifiers } from 'src/engine/metadata-modules/flat-entity/utils/resolve-entity-relation-universal-identifiers.util';
 import { type FlatPageLayoutWidget } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget.type';
+import { buildFlatPageLayoutWidgetCommonProperties } from 'src/engine/metadata-modules/flat-page-layout-widget/utils/build-flat-page-layout-widget-common-properties.util';
 import { fromPageLayoutWidgetConfigurationToUniversalConfiguration } from 'src/engine/metadata-modules/flat-page-layout-widget/utils/from-page-layout-widget-configuration-to-universal-configuration.util';
 import { type CreatePageLayoutWidgetInput } from 'src/engine/metadata-modules/page-layout-widget/dtos/inputs/create-page-layout-widget.input';
 import { validateWidgetConfigurationInput } from 'src/engine/metadata-modules/page-layout-widget/utils/validate-widget-configuration-input.util';
@@ -48,33 +48,27 @@ export const fromCreatePageLayoutWidgetInputToFlatPageLayoutWidgetToCreate = ({
   const createdAt = new Date().toISOString();
   const pageLayoutWidgetId = v4();
 
-  const {
-    pageLayoutTabUniversalIdentifier,
-    objectMetadataUniversalIdentifier,
-  } = resolveEntityRelationUniversalIdentifiers({
-    metadataName: 'pageLayoutWidget',
-    foreignKeyValues: {
+  const commonProperties = buildFlatPageLayoutWidgetCommonProperties({
+    widgetInput: {
       pageLayoutTabId,
+      title: createPageLayoutWidgetInput.title,
+      type: createPageLayoutWidgetInput.type,
       objectMetadataId: createPageLayoutWidgetInput.objectMetadataId,
+      gridPosition: createPageLayoutWidgetInput.gridPosition,
+      position: createPageLayoutWidgetInput.position,
     },
-    flatEntityMaps: { flatPageLayoutTabMaps, flatObjectMetadataMaps },
+    flatPageLayoutTabMaps,
+    flatObjectMetadataMaps,
   });
 
   return {
     id: pageLayoutWidgetId,
-    pageLayoutTabId,
-    pageLayoutTabUniversalIdentifier,
+    ...commonProperties,
     workspaceId,
     createdAt,
     updatedAt: createdAt,
     deletedAt: null,
     universalIdentifier: pageLayoutWidgetId,
-    title: createPageLayoutWidgetInput.title,
-    type: createPageLayoutWidgetInput.type,
-    objectMetadataId: createPageLayoutWidgetInput.objectMetadataId ?? null,
-    objectMetadataUniversalIdentifier,
-    gridPosition: createPageLayoutWidgetInput.gridPosition,
-    position: createPageLayoutWidgetInput.position ?? null,
     configuration: createPageLayoutWidgetInput.configuration,
     applicationId: flatApplication.id,
     applicationUniversalIdentifier: flatApplication.universalIdentifier,

packages/twenty-server/src/engine/metadata-modules/page-layout/services/page-layout-update.service.ts

@@ -10,12 +10,12 @@ import { AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types
 import { addFlatEntityToFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/add-flat-entity-to-flat-entity-maps-or-throw.util';
 import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
 import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';
-import { resolveEntityRelationUniversalIdentifiers } from 'src/engine/metadata-modules/flat-entity/utils/resolve-entity-relation-universal-identifiers.util';
 import { FLAT_PAGE_LAYOUT_TAB_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-page-layout-tab/constants/flat-page-layout-tab-editable-properties.constant';
 import { type FlatPageLayoutTabMaps } from 'src/engine/metadata-modules/flat-page-layout-tab/types/flat-page-layout-tab-maps.type';
 import { type FlatPageLayoutTab } from 'src/engine/metadata-modules/flat-page-layout-tab/types/flat-page-layout-tab.type';
 import { FLAT_PAGE_LAYOUT_WIDGET_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-page-layout-widget/constants/flat-page-layout-widget-editable-properties.constant';
 import { type FlatPageLayoutWidget } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget.type';
+import { buildFlatPageLayoutWidgetCommonProperties } from 'src/engine/metadata-modules/flat-page-layout-widget/utils/build-flat-page-layout-widget-common-properties.util';
 import { fromPageLayoutWidgetConfigurationToUniversalConfiguration } from 'src/engine/metadata-modules/flat-page-layout-widget/utils/from-page-layout-widget-configuration-to-universal-configuration.util';
 import { type FlatPageLayout } from 'src/engine/metadata-modules/flat-page-layout/types/flat-page-layout.type';
 import { reconstructFlatPageLayoutWithTabsAndWidgets } from 'src/engine/metadata-modules/flat-page-layout/utils/reconstruct-flat-page-layout-with-tabs-and-widgets.util';
@@ -476,32 +476,18 @@ export class PageLayoutUpdateService {
     });
 
     const now = new Date();
+
     const widgetsToCreate: FlatPageLayoutWidget[] = entitiesToCreate.map(
       (widgetInput) => {
         const widgetId = widgetInput.id ?? v4();
 
-        const {
-          pageLayoutTabUniversalIdentifier,
-          objectMetadataUniversalIdentifier,
-        } = resolveEntityRelationUniversalIdentifiers({
-          metadataName: 'pageLayoutWidget',
-          foreignKeyValues: {
-            pageLayoutTabId: widgetInput.pageLayoutTabId,
-            objectMetadataId: widgetInput.objectMetadataId,
-          },
-          flatEntityMaps: { flatPageLayoutTabMaps, flatObjectMetadataMaps },
-        });
-
         return {
           id: widgetId,
-          pageLayoutTabId: widgetInput.pageLayoutTabId,
-          pageLayoutTabUniversalIdentifier,
-          title: widgetInput.title,
-          type: widgetInput.type,
-          objectMetadataId: widgetInput.objectMetadataId ?? null,
-          objectMetadataUniversalIdentifier,
-          gridPosition: widgetInput.gridPosition,
-          position: widgetInput.position ?? null,
+          ...buildFlatPageLayoutWidgetCommonProperties({
+            widgetInput,
+            flatPageLayoutTabMaps,
+            flatObjectMetadataMaps,
+          }),
           configuration: widgetInput.configuration,
           workspaceId,
           createdAt: now.toISOString(),
@@ -536,28 +522,13 @@ export class PageLayoutUpdateService {
 
         const updatedConfiguration = widgetInput.configuration ?? null;
 
-        const {
-          pageLayoutTabUniversalIdentifier,
-          objectMetadataUniversalIdentifier,
-        } = resolveEntityRelationUniversalIdentifiers({
-          metadataName: 'pageLayoutWidget',
-          foreignKeyValues: {
-            pageLayoutTabId: widgetInput.pageLayoutTabId,
-            objectMetadataId: widgetInput.objectMetadataId,
-          },
-          flatEntityMaps: { flatPageLayoutTabMaps, flatObjectMetadataMaps },
-        });
-
         return {
           ...existingWidget,
-          pageLayoutTabId: widgetInput.pageLayoutTabId,
-          pageLayoutTabUniversalIdentifier,
-          title: widgetInput.title,
-          type: widgetInput.type,
-          objectMetadataId: widgetInput.objectMetadataId ?? null,
-          objectMetadataUniversalIdentifier,
-          gridPosition: widgetInput.gridPosition,
-          position: widgetInput.position ?? null,
+          ...buildFlatPageLayoutWidgetCommonProperties({
+            widgetInput,
+            flatPageLayoutTabMaps,
+            flatObjectMetadataMaps,
+          }),
           configuration: updatedConfiguration,
           updatedAt: now.toISOString(),
           ...(isDefined(updatedConfiguration) && {
@@ -587,28 +558,13 @@ export class PageLayoutUpdateService {
 
         const restoredConfiguration = widgetInput.configuration ?? null;
 
-        const {
-          pageLayoutTabUniversalIdentifier,
-          objectMetadataUniversalIdentifier,
-        } = resolveEntityRelationUniversalIdentifiers({
-          metadataName: 'pageLayoutWidget',
-          foreignKeyValues: {
-            pageLayoutTabId: widgetInput.pageLayoutTabId,
-            objectMetadataId: widgetInput.objectMetadataId,
-          },
-          flatEntityMaps: { flatPageLayoutTabMaps, flatObjectMetadataMaps },
-        });
-
         return {
           ...existingWidget,
-          pageLayoutTabId: widgetInput.pageLayoutTabId,
-          pageLayoutTabUniversalIdentifier,
-          title: widgetInput.title,
-          type: widgetInput.type,
-          objectMetadataId: widgetInput.objectMetadataId ?? null,
-          objectMetadataUniversalIdentifier,
-          gridPosition: widgetInput.gridPosition,
-          position: widgetInput.position ?? null,
+          ...buildFlatPageLayoutWidgetCommonProperties({
+            widgetInput,
+            flatPageLayoutTabMaps,
+            flatObjectMetadataMaps,
+          }),
           configuration: restoredConfiguration,
           deletedAt: null,
           updatedAt: now.toISOString(),