feat(): Backport metadata management (#11469)

FIXES FRMW-2915

**What**
Backport metadata management. all the metadata get preserved unless a specific empty string is provided for the key which in turn would remove that key from the metadata

packages/core/utils/src/common/__tests__/merge-metadata.spec.ts

@@ -0,0 +1,40 @@
+import { mergeMetadata } from "../merge-metadata"
+
+describe("mergeMetadata", () => {
+  it("should merge simple key-value pairs", () => {
+    const metadata = {
+      key1: "value1",
+      key2: "value2",
+    }
+    const metadataToMerge = {
+      key2: "new-value2",
+      key3: "value3",
+    }
+
+    const result = mergeMetadata(metadata, metadataToMerge)
+
+    expect(result).toEqual({
+      key1: "value1",
+      key2: "new-value2",
+      key3: "value3",
+    })
+  })
+
+  it("should remove keys with empty string values", () => {
+    const metadata = {
+      key1: "value1",
+      key2: "value2",
+      key3: "value3",
+    }
+    const metadataToMerge = {
+      key2: "",
+    }
+
+    const result = mergeMetadata(metadata, metadataToMerge)
+
+    expect(result).toEqual({
+      key1: "value1",
+      key3: "value3",
+    })
+  })
+})

packages/core/utils/src/common/index.ts

@@ -81,3 +81,4 @@ export * from "./upper-case-first"
 export * from "./validate-handle"
 export * from "./wrap-handler"
 export * from "./merge-plugin-modules"
+export * from "./merge-metadata"

packages/core/utils/src/common/merge-metadata.ts

@@ -0,0 +1,37 @@
+/**
+ * Merges two metadata objects. The key from the original metadata object is
+ * preserved if the key is not present in the metadata to merge. If the key
+ * is present in the metadata to merge, the value from the metadata to merge
+ * is used. If the key in the metadata to merge is an empty string, the key
+ * is removed from the merged metadata object.
+ *
+ * @param metadata - The base metadata object.
+ * @param metadataToMerge - The metadata object to merge.
+ * @returns The merged metadata object.
+ */
+export function mergeMetadata(
+  metadata: Record<string, any>,
+  metadataToMerge: Record<string, any>
+) {
+  const merged = { ...metadata }
+
+  for (const [key, value] of Object.entries(metadataToMerge)) {
+    if (value === "") {
+      delete merged[key]
+      continue
+    }
+
+    // NOTE: If we want to handle the same behaviour on nested objects. We should then conside arrays as well.
+    // if (value && typeof value === "object") {
+    //   merged[key] =
+    //     merged[key] && typeof merged[key] === "object"
+    //       ? mergeMetadata(merged[key], value)
+    //       : { ...value }
+    //   continue
+    // }
+
+    merged[key] = value
+  }
+
+  return merged
+}