From c3aebb999d156da3043649b437de29b54bf0aacc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Wed, 5 Mar 2025 18:48:50 +0100
Subject: [PATCH 01/55] feat: backbone first implementation
---
messages/install.md | 13 ++
messages/uninstall.md | 13 ++
package.json | 2 +-
src/commands/git/merge/driver/install.ts | 21 ++++
src/commands/git/merge/driver/uninstall.ts | 19 +++
src/constant/driverConstant.ts | 1 +
src/index.ts | 17 +++
src/service/JsonMergeService.ts | 132 +++++++++++++++++++++
src/service/MergeDriver.ts | 24 ++++
src/service/XmlMergeService.ts | 45 +++++++
src/service/installService.ts | 23 ++++
src/service/uninstallService.ts | 20 ++++
test/index.test.js | 117 ++++++++++++++++++
test/unit/service/InstallService.test.ts | 35 ++++++
test/unit/service/MergeDriver.test.ts | 52 ++++++++
test/unit/service/UninstallService.test.ts | 34 ++++++
test/unit/service/XmlMergeService.test.ts | 61 ++++++++++
17 files changed, 628 insertions(+), 1 deletion(-)
create mode 100644 messages/install.md
create mode 100644 messages/uninstall.md
create mode 100644 src/commands/git/merge/driver/install.ts
create mode 100644 src/commands/git/merge/driver/uninstall.ts
create mode 100644 src/constant/driverConstant.ts
create mode 100644 src/index.ts
create mode 100644 src/service/JsonMergeService.ts
create mode 100644 src/service/MergeDriver.ts
create mode 100644 src/service/XmlMergeService.ts
create mode 100644 src/service/installService.ts
create mode 100644 src/service/uninstallService.ts
create mode 100644 test/index.test.js
create mode 100644 test/unit/service/InstallService.test.ts
create mode 100644 test/unit/service/MergeDriver.test.ts
create mode 100644 test/unit/service/UninstallService.test.ts
create mode 100644 test/unit/service/XmlMergeService.test.ts
diff --git a/messages/install.md b/messages/install.md
new file mode 100644
index 0000000..d8be80a
--- /dev/null
+++ b/messages/install.md
@@ -0,0 +1,13 @@
+# summary
+
+Installs a local git merge driver for the given org and branch.
+
+# description
+
+Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project and creating a new merge driver configuration file in the `.git/config` of the project.
+
+# examples
+
+- Install the driver for a given project:
+
+ <%= config.bin %> <%= command.id %>
diff --git a/messages/uninstall.md b/messages/uninstall.md
new file mode 100644
index 0000000..84ba234
--- /dev/null
+++ b/messages/uninstall.md
@@ -0,0 +1,13 @@
+# summary
+
+Uninstalls the local git merge driver for the given org and branch.
+
+# description
+
+Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` files in the project and deleting the merge driver configuration file in the `.git/config` of the project.
+
+# examples
+
+- Uninstall the driver for a given project:
+
+ <%= config.bin %> <%= command.id %>
diff --git a/package.json b/package.json
index d83aa1f..c46cd9c 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
"name": "sf-git-merge-driver",
"description": "git remote add origin git@github.com:scolladon/sf-git-merge-driver.git",
"version": "1.0.0",
- "exports": "./lib/index.js",
+ "exports": "./lib/service/MergeDriver.js",
"type": "module",
"author": "Sébastien Colladon (colladonsebastien@gmail.com)",
"repository": {
diff --git a/src/commands/git/merge/driver/install.ts b/src/commands/git/merge/driver/install.ts
new file mode 100644
index 0000000..f9146c0
--- /dev/null
+++ b/src/commands/git/merge/driver/install.ts
@@ -0,0 +1,21 @@
+import { Messages } from '@salesforce/core'
+import { SfCommand } from '@salesforce/sf-plugins-core'
+import { InstallService } from '../../../../service/installService.js'
+import { UninstallService } from '../../../../service/uninstallService.js'
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+const messages = Messages.loadMessages('sf-git-merge-driver', 'install')
+
+export default class Install extends SfCommand<void> {
+ public static override readonly summary = messages.getMessage('summary')
+ public static override readonly description =
+ messages.getMessage('description')
+ public static override readonly examples = messages.getMessages('examples')
+
+ public static override readonly flags = {}
+
+ public async run(): Promise<void> {
+ await new UninstallService().uninstallMergeDriver()
+ await new InstallService().installMergeDriver()
+ }
+}
diff --git a/src/commands/git/merge/driver/uninstall.ts b/src/commands/git/merge/driver/uninstall.ts
new file mode 100644
index 0000000..416835c
--- /dev/null
+++ b/src/commands/git/merge/driver/uninstall.ts
@@ -0,0 +1,19 @@
+import { Messages } from '@salesforce/core'
+import { SfCommand } from '@salesforce/sf-plugins-core'
+import { UninstallService } from '../../../../service/uninstallService.js'
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+const messages = Messages.loadMessages('sf-git-merge-driver', 'uninstall')
+
+export default class Uninstall extends SfCommand<void> {
+ public static override readonly summary = messages.getMessage('summary')
+ public static override readonly description =
+ messages.getMessage('description')
+ public static override readonly examples = messages.getMessages('examples')
+
+ public static override readonly flags = {}
+
+ public async run(): Promise<void> {
+ await new UninstallService().uninstallMergeDriver()
+ }
+}
diff --git a/src/constant/driverConstant.ts b/src/constant/driverConstant.ts
new file mode 100644
index 0000000..af8d29f
--- /dev/null
+++ b/src/constant/driverConstant.ts
@@ -0,0 +1 @@
+export const DRIVER_NAME = 'salesforce-source'
diff --git a/src/index.ts b/src/index.ts
new file mode 100644
index 0000000..c1ddeca
--- /dev/null
+++ b/src/index.ts
@@ -0,0 +1,17 @@
+#!/usr/bin/env -S NODE_OPTIONS="--no-warnings=ExperimentalWarning" npx ts-node --project tsconfig.json --esm
+import { MergeDriver } from './service/MergeDriver.js'
+
+if (process.argv.length >= 6) {
+ const [, , ancestorFile, ourFile, theirFile, outputFile] = process.argv
+ const mergeDriver = new MergeDriver()
+ mergeDriver
+ .mergeFiles(ancestorFile, ourFile, theirFile, outputFile)
+ .then(() => process.exit(0))
+} else {
+ console.error('Usage: sf-git-merge-driver %O %A %B %P')
+ console.error(' %O: ancestor file')
+ console.error(' %A: our file')
+ console.error(' %B: their file')
+ console.error(' %P: output file path')
+ process.exit(1)
+}
diff --git a/src/service/JsonMergeService.ts b/src/service/JsonMergeService.ts
new file mode 100644
index 0000000..22da51d
--- /dev/null
+++ b/src/service/JsonMergeService.ts
@@ -0,0 +1,132 @@
+export class JsonMergeService {
+ // Deep merge function for objects
+ mergeObjects(ancestor, ours, theirs) {
+ // If types don't match, prefer our version
+ if (
+ typeof ours !== typeof theirs ||
+ Array.isArray(ours) !== Array.isArray(theirs)
+ ) {
+ return ours
+ }
+
+ // Handle arrays - special case for Salesforce metadata
+ if (Array.isArray(ours)) {
+ return this.mergeArrays(ancestor, ours, theirs)
+ }
+
+ // Handle objects
+ if (typeof ours === 'object' && ours !== null) {
+ const result = { ...ours }
+
+ // Process all keys from both objects
+ const allKeys = new Set([
+ ...Object.keys(ours || {}),
+ ...Object.keys(theirs || {}),
+ ])
+
+ for (const key of allKeys) {
+ // If key exists only in theirs, add it
+ if (!(key in ours)) {
+ result[key] = theirs[key]
+ continue
+ }
+
+ // If key exists only in ours, keep it
+ if (!(key in theirs)) {
+ continue
+ }
+
+ // If key exists in both, recursively merge
+ const ancestorValue = ancestor && ancestor[key]
+ result[key] = this.mergeObjects(ancestorValue, ours[key], theirs[key])
+ }
+
+ return result
+ }
+
+ // For primitive values, check if they changed from ancestor
+ if (theirs !== ancestor && ours === ancestor) {
+ // They changed it, we didn't - use their change
+ return theirs
+ }
+
+ // In all other cases, prefer our version
+ return ours
+ }
+
+ // Special handling for Salesforce metadata arrays
+ mergeArrays(ancestor, ours, theirs) {
+ // For Salesforce metadata, arrays often contain objects with unique identifiers
+ // Try to match items by common identifier fields
+ const idFields = ['fullName', 'name', 'field', 'label', 'id', '@_name']
+
+ // Find a common identifier field that exists in the arrays
+ const idField = idFields.find(
+ field =>
+ ours.some(item => item && typeof item === 'object' && field in item) &&
+ theirs.some(item => item && typeof item === 'object' && field in item)
+ )
+
+ if (idField) {
+ // If we found a common identifier, merge by that field
+ const result = [...ours]
+
+ // Create maps for faster lookups
+ const ourMap = new Map(
+ ours
+ .filter(item => item && typeof item === 'object' && idField in item)
+ .map(item => [item[idField], item])
+ )
+
+ const ancestorMap =
+ ancestor && Array.isArray(ancestor)
+ ? new Map(
+ ancestor
+ .filter(
+ item => item && typeof item === 'object' && idField in item
+ )
+ .map(item => [item[idField], item])
+ )
+ : new Map()
+
+ // Process items from their version
+ for (const theirItem of theirs) {
+ if (
+ theirItem &&
+ typeof theirItem === 'object' &&
+ idField in theirItem
+ ) {
+ const id = theirItem[idField]
+
+ if (ourMap.has(id)) {
+ // Item exists in both versions, merge them
+ const ourItem = ourMap.get(id)
+ const ancestorItem = ancestorMap.get(id)
+
+ // Find the index in our array
+ const index = result.findIndex(
+ item => item && typeof item === 'object' && item[idField] === id
+ )
+
+ if (index !== -1) {
+ // Replace with merged item
+ result[index] = this.mergeObjects(
+ ancestorItem,
+ ourItem,
+ theirItem
+ )
+ }
+ } else {
+ // Item only exists in their version, add it
+ result.push(theirItem)
+ }
+ }
+ }
+
+ return result
+ }
+
+ // If no common identifier found, default to our version
+ return ours
+ }
+}
diff --git a/src/service/MergeDriver.ts b/src/service/MergeDriver.ts
new file mode 100644
index 0000000..cfc00f3
--- /dev/null
+++ b/src/service/MergeDriver.ts
@@ -0,0 +1,24 @@
+import { readFile, writeFile } from 'node:fs/promises'
+import { XmlMergeService } from './XmlMergeService.js'
+
+export class MergeDriver {
+ async mergeFiles(ancestorFile, ourFile, theirFile, outputFile) {
+ // Read all three versions
+ const [ancestorContent, ourContent, theirContent] = await Promise.all([
+ readFile(ancestorFile, 'utf8'),
+ readFile(ourFile, 'utf8'),
+ readFile(theirFile, 'utf8'),
+ ])
+
+ const mergeService = new XmlMergeService()
+
+ const mergedContent = await mergeService.tripartXmlMerge(
+ ancestorContent,
+ ourContent,
+ theirContent
+ )
+
+ // Write the merged content to the output file
+ await writeFile(outputFile, mergedContent)
+ }
+}
diff --git a/src/service/XmlMergeService.ts b/src/service/XmlMergeService.ts
new file mode 100644
index 0000000..50b3b56
--- /dev/null
+++ b/src/service/XmlMergeService.ts
@@ -0,0 +1,45 @@
+import { XMLBuilder, XMLParser } from 'fast-xml-parser'
+import { JsonMergeService } from './JsonMergeService.js'
+
+const options = {
+ attributeNamePrefix: '@_',
+ commentPropName: '#comment',
+ format: true,
+ ignoreAttributes: false,
+ ignoreNameSpace: false,
+ indentBy: ' ',
+ parseAttributeValue: false,
+ parseNodeValue: false,
+ parseTagValue: false,
+ processEntities: false,
+ suppressEmptyNode: false,
+ trimValues: true,
+}
+
+export class XmlMergeService {
+ async tripartXmlMerge(
+ ancestorContent: string,
+ ourContent: string,
+ theirContent: string
+ ) {
+ const parser = new XMLParser(options)
+
+ const ancestorObj = parser.parse(ancestorContent)
+ const ourObj = parser.parse(ourContent)
+ const theirObj = parser.parse(theirContent)
+
+ // Perform deep merge of XML objects
+
+ const jsonMergeService = new JsonMergeService()
+ const mergedObj = jsonMergeService.mergeObjects(
+ ancestorObj,
+ ourObj,
+ theirObj
+ )
+
+ // Convert back to XML and format
+ const builder = new XMLBuilder(options)
+ const mergedXml = builder.build(mergedObj)
+ return mergedXml
+ }
+}
diff --git a/src/service/installService.ts b/src/service/installService.ts
new file mode 100644
index 0000000..235fc73
--- /dev/null
+++ b/src/service/installService.ts
@@ -0,0 +1,23 @@
+import { appendFile } from 'node:fs/promises'
+import { simpleGit } from 'simple-git'
+import { DRIVER_NAME } from '../constant/driverConstant.js'
+
+export class InstallService {
+ public async installMergeDriver() {
+ const git = simpleGit()
+
+ await git
+ .addConfig(`merge.${DRIVER_NAME}.name`, 'Salesforce source merge driver')
+ .addConfig(
+ `merge.${DRIVER_NAME}.driver`,
+ 'node ${__dirname}/index.js %O %A %B %P' // TODO define how to do that
+ )
+ .addConfig(`merge.${DRIVER_NAME}.recursive`, 'true') // TO CHALLENGE
+
+ const content =
+ ['*.xml'].map(pattern => `${pattern} merge=${DRIVER_NAME}`).join('\n') +
+ '\n'
+
+ await appendFile('.gitattributes', content, { flag: 'a' })
+ }
+}
diff --git a/src/service/uninstallService.ts b/src/service/uninstallService.ts
new file mode 100644
index 0000000..e74fd49
--- /dev/null
+++ b/src/service/uninstallService.ts
@@ -0,0 +1,20 @@
+import { readFile, writeFile } from 'node:fs/promises'
+import { simpleGit } from 'simple-git'
+import { DRIVER_NAME } from '../constant/driverConstant.js'
+
+const MERGE_DRIVER_CONFIG = new RegExp(`.* merge\\s*=\\s*${DRIVER_NAME}$`)
+
+export class UninstallService {
+ public async uninstallMergeDriver() {
+ const git = simpleGit()
+ await git.raw(['config', '--remove-section', `merge.${DRIVER_NAME}`])
+
+ const gitAttributes = await readFile('.gitattributes', {
+ encoding: 'utf8',
+ })
+ const filteredAttributes = gitAttributes
+ .split('\n')
+ .filter(line => !MERGE_DRIVER_CONFIG.test(line))
+ await writeFile('.gitattributes', filteredAttributes.join('\n'))
+ }
+}
diff --git a/test/index.test.js b/test/index.test.js
new file mode 100644
index 0000000..74c60e3
--- /dev/null
+++ b/test/index.test.js
@@ -0,0 +1,117 @@
+import fs from 'fs'
+import assert from 'node:assert'
+import { describe, it } from 'node:test'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { mergeFiles } from '../src/index.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+describe('Salesforce Metadata Merge Driver', () => {
+ const testDir = path.join(__dirname, 'fixtures')
+
+ // Create test directory if it doesn't exist
+ if (!fs.existsSync(testDir)) {
+ fs.mkdirSync(testDir, { recursive: true })
+ }
+
+ describe('XML Merging', () => {
+ it('should correctly merge XML files with non-conflicting changes', async () => {
+ // Create test files
+ const ancestorContent = `<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+ <label>Test Object</label>
+ <pluralLabel>Test Objects</pluralLabel>
+</CustomObject>`
+
+ const ourContent = `<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+ <label>Test Object</label>
+ <pluralLabel>Test Objects</pluralLabel>
+ <description>Our description</description>
+</CustomObject>`
+
+ const theirContent = `<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+ <label>Modified Test Object</label>
+ <pluralLabel>Test Objects</pluralLabel>
+</CustomObject>`
+
+ const ancestorFile = path.join(testDir, 'ancestor.xml')
+ const ourFile = path.join(testDir, 'ours.xml')
+ const theirFile = path.join(testDir, 'theirs.xml')
+ const outputFile = path.join(testDir, 'merged.xml')
+
+ fs.writeFileSync(ancestorFile, ancestorContent)
+ fs.writeFileSync(ourFile, ourContent)
+ fs.writeFileSync(theirFile, theirContent)
+
+ // Run the merge
+ const success = await mergeFiles(
+ ancestorFile,
+ ourFile,
+ theirFile,
+ outputFile
+ )
+
+ // Verify the result
+ assert.strictEqual(success, true)
+ const mergedContent = fs.readFileSync(outputFile, 'utf8')
+
+ // The merged content should contain both changes
+ assert(mergedContent.includes('Modified Test Object'))
+ assert(mergedContent.includes('Our description'))
+ })
+ })
+
+ describe('JSON Merging', () => {
+ it('should correctly merge JSON files with non-conflicting changes', async () => {
+ // Create test files
+ const ancestorContent = `{
+ "fullName": "TestObject",
+ "label": "Test Object",
+ "pluralLabel": "Test Objects"
+}`
+
+ const ourContent = `{
+ "fullName": "TestObject",
+ "label": "Test Object",
+ "pluralLabel": "Test Objects",
+ "description": "Our description"
+}`
+
+ const theirContent = `{
+ "fullName": "TestObject",
+ "label": "Modified Test Object",
+ "pluralLabel": "Test Objects"
+}`
+
+ const ancestorFile = path.join(testDir, 'ancestor.json')
+ const ourFile = path.join(testDir, 'ours.json')
+ const theirFile = path.join(testDir, 'theirs.json')
+ const outputFile = path.join(testDir, 'merged.json')
+
+ fs.writeFileSync(ancestorFile, ancestorContent)
+ fs.writeFileSync(ourFile, ourContent)
+ fs.writeFileSync(theirFile, theirContent)
+
+ // Run the merge
+ const success = await mergeFiles(
+ ancestorFile,
+ ourFile,
+ theirFile,
+ outputFile
+ )
+
+ // Verify the result
+ assert.strictEqual(success, true)
+ const mergedContent = fs.readFileSync(outputFile, 'utf8')
+ const mergedObj = JSON.parse(mergedContent)
+
+ // The merged content should contain both changes
+ assert.strictEqual(mergedObj.label, 'Modified Test Object')
+ assert.strictEqual(mergedObj.description, 'Our description')
+ })
+ })
+})
diff --git a/test/unit/service/InstallService.test.ts b/test/unit/service/InstallService.test.ts
new file mode 100644
index 0000000..bc13034
--- /dev/null
+++ b/test/unit/service/InstallService.test.ts
@@ -0,0 +1,35 @@
+import { appendFile } from 'node:fs/promises'
+import { InstallService } from '../../../src/service/installService.js'
+
+const mockedAddConfig = jest.fn()
+jest.mock('simple-git', () => {
+ return {
+ simpleGit: () => ({
+ addConfig: mockedAddConfig,
+ }),
+ }
+})
+jest.mock('node:fs/promises')
+
+describe('InstallService', () => {
+ let sut: InstallService // System Under Test
+
+ beforeEach(() => {
+ // Arrange
+ sut = new InstallService()
+ })
+
+ it('should install successfully when given valid parameters', async () => {
+ // Act
+ await sut.installMergeDriver()
+
+ // Assert
+ expect(mockedAddConfig).toHaveBeenCalledTimes(3)
+ expect(appendFile).toHaveBeenCalledTimes(1)
+ expect(appendFile).toHaveBeenCalledWith(
+ '.gitattributes',
+ expect.stringContaining('*.xml merge=salesforce-source\n'),
+ { flag: 'a' }
+ )
+ })
+})
diff --git a/test/unit/service/MergeDriver.test.ts b/test/unit/service/MergeDriver.test.ts
new file mode 100644
index 0000000..75d202d
--- /dev/null
+++ b/test/unit/service/MergeDriver.test.ts
@@ -0,0 +1,52 @@
+import { MergeDriver } from '../../../src/service/MergeDriver.js'
+
+const mockReadFile = jest.fn()
+const mockWriteFile = jest.fn()
+jest.mock('node:fs/promises', () => ({
+ readFile: (...args) => mockReadFile(...args),
+ writeFile: (...args) => mockWriteFile(...args),
+}))
+
+const mockedTripartXmlMerge = jest.fn()
+jest.mock('../../../src/service/XmlMergeService.js', () => ({
+ XmlMergeService: jest.fn(() => ({
+ tripartXmlMerge: mockedTripartXmlMerge,
+ })),
+}))
+
+describe('MergeDriver', () => {
+ let sut: MergeDriver
+
+ beforeEach(() => {
+ sut = new MergeDriver()
+ })
+
+ describe('mergeFiles', () => {
+ it('should merge files successfully when given valid parameters', async () => {
+ // Arrange
+ mockReadFile.mockResolvedValue('<label>Test Object</label>')
+ mockedTripartXmlMerge.mockResolvedValue('<label>Test Object</label>')
+
+ // Act
+ await sut.mergeFiles('AncestorFile', 'OurFile', 'TheirFile', 'OutputFile')
+
+ // Assert
+ expect(mockReadFile).toHaveBeenCalledTimes(3)
+ expect(mockedTripartXmlMerge).toHaveBeenCalledTimes(1)
+ expect(mockWriteFile).toHaveBeenCalledTimes(1)
+ })
+
+ it('should throw an error when tripartXmlMerge fails', async () => {
+ // Arrange
+ mockReadFile.mockResolvedValue('<label>Test Object</label>')
+ mockedTripartXmlMerge.mockRejectedValue(
+ new Error('Tripart XML merge failed')
+ )
+
+ // Act and Assert
+ await expect(
+ sut.mergeFiles('AncestorFile', 'OurFile', 'TheirFile', 'OutputFile')
+ ).rejects.toThrowError('Tripart XML merge failed')
+ })
+ })
+})
diff --git a/test/unit/service/UninstallService.test.ts b/test/unit/service/UninstallService.test.ts
new file mode 100644
index 0000000..0a1ce3f
--- /dev/null
+++ b/test/unit/service/UninstallService.test.ts
@@ -0,0 +1,34 @@
+import { readFile, writeFile } from 'node:fs/promises'
+import { DRIVER_NAME } from '../../../src/constant/driverConstant.js'
+import { UninstallService } from '../../../src/service/uninstallService.js'
+
+const mockedRaw = jest.fn()
+jest.mock('simple-git', () => ({
+ raw: mockedRaw,
+}))
+jest.mock('node:fs/promises')
+
+describe('UninstallService', () => {
+ let sut: UninstallService // System Under Test
+
+ beforeEach(() => {
+ // Arrange
+ sut = new UninstallService()
+ })
+
+ it('should uninstall successfully when given valid parameters', async () => {
+ // Act
+ await sut.uninstallMergeDriver()
+
+ // Assert
+ expect(mockedRaw).toHaveBeenCalledWith(
+ 'config',
+ '--remove-section',
+ `merge.${DRIVER_NAME}`
+ )
+ expect(readFile).toHaveBeenCalledTimes(1)
+ expect(readFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
+ expect(writeFile).toHaveBeenCalledTimes(1)
+ expect(writeFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
+ })
+})
diff --git a/test/unit/service/XmlMergeService.test.ts b/test/unit/service/XmlMergeService.test.ts
new file mode 100644
index 0000000..c56c20d
--- /dev/null
+++ b/test/unit/service/XmlMergeService.test.ts
@@ -0,0 +1,61 @@
+import { XMLBuilder, XMLParser } from "fast-xml-parser";
+import { JsonMergeService } from "../../../src/service/JsonMergeService.js";
+import { XmlMergeService } from "../../../src/service/XmlMergeService.js";
+
+jest.mock("fast-xml-parser", () => {
+ return {
+ XMLParser: jest.fn().mockImplementation(() => {
+ return {
+ parse: (xml) => xml,
+ };
+ }),
+ XMLBuilder: jest.fn().mockImplementation(() => {
+ return {
+ build: (obj) => obj,
+ };
+ }),
+ };
+});
+
+const mockedMergeObjects = jest.fn();
+jest.mock("../../../src/service/JsonMergeService.js", () => {
+ return {
+ JsonMergeService: jest.fn().mockImplementation(() => {
+ return {
+ mergeObjects: mockedMergeObjects,
+ };
+ }),
+ };
+});
+
+describe("MergeDriver", () => {
+ let sut: XmlMergeService;
+
+ beforeEach(() => {
+ sut = new XmlMergeService();
+ });
+
+ describe("tripartXmlMerge", () => {
+ it("should merge files successfully when given valid parameters", async () => {
+ // Act
+ await sut.tripartXmlMerge("AncestorFile", "OurFile", "TheirFile");
+
+ // Assert
+ expect(XMLParser).toHaveBeenCalledTimes(1);
+ expect(XMLBuilder).toHaveBeenCalledTimes(1);
+ expect(JsonMergeService).toHaveBeenCalledTimes(1);
+ });
+
+ it("should throw an error when tripartXmlMerge fails", async () => {
+ // Arrange
+ mockedMergeObjects.mockRejectedValue(
+ new Error("Tripart XML merge failed")
+ );
+
+ // Act and Assert
+ await expect(
+ sut.tripartXmlMerge("AncestorFile", "OurFile", "TheirFile")
+ ).rejects.toThrowError("Tripart XML merge failed");
+ });
+ });
+});
From 126845e2f4852b7cec4fa0a8f9868d2b050adb02 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 12:06:54 +0100
Subject: [PATCH 02/55] test: add spec for services
---
src/service/installService.ts | 16 ++---
test/unit/service/InstallService.test.ts | 19 +++---
test/unit/service/JsonMergeService.test.ts | 29 +++++++++
test/unit/service/UninstallService.test.ts | 20 +++++--
test/unit/service/XmlMergeService.test.ts | 68 +++++++++++-----------
5 files changed, 96 insertions(+), 56 deletions(-)
create mode 100644 test/unit/service/JsonMergeService.test.ts
diff --git a/src/service/installService.ts b/src/service/installService.ts
index 235fc73..24abec5 100644
--- a/src/service/installService.ts
+++ b/src/service/installService.ts
@@ -6,13 +6,15 @@ export class InstallService {
public async installMergeDriver() {
const git = simpleGit()
- await git
- .addConfig(`merge.${DRIVER_NAME}.name`, 'Salesforce source merge driver')
- .addConfig(
- `merge.${DRIVER_NAME}.driver`,
- 'node ${__dirname}/index.js %O %A %B %P' // TODO define how to do that
- )
- .addConfig(`merge.${DRIVER_NAME}.recursive`, 'true') // TO CHALLENGE
+ await git.addConfig(
+ `merge.${DRIVER_NAME}.name`,
+ 'Salesforce source merge driver'
+ )
+ await git.addConfig(
+ `merge.${DRIVER_NAME}.driver`,
+ 'node ${__dirname}/index.js %O %A %B %P' // TODO define how to do that
+ )
+ await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true') // TO CHALLENGE
const content =
['*.xml'].map(pattern => `${pattern} merge=${DRIVER_NAME}`).join('\n') +
diff --git a/test/unit/service/InstallService.test.ts b/test/unit/service/InstallService.test.ts
index bc13034..aa20ba8 100644
--- a/test/unit/service/InstallService.test.ts
+++ b/test/unit/service/InstallService.test.ts
@@ -1,15 +1,16 @@
import { appendFile } from 'node:fs/promises'
+import simpleGit from 'simple-git'
import { InstallService } from '../../../src/service/installService.js'
+jest.mock('node:fs/promises')
+jest.mock('simple-git')
const mockedAddConfig = jest.fn()
-jest.mock('simple-git', () => {
- return {
- simpleGit: () => ({
- addConfig: mockedAddConfig,
- }),
- }
+const simpleGitMock = simpleGit as jest.Mock
+simpleGitMock.mockReturnValue({
+ addConfig: mockedAddConfig,
})
-jest.mock('node:fs/promises')
+
+const appendFileMocked = jest.mocked(appendFile)
describe('InstallService', () => {
let sut: InstallService // System Under Test
@@ -25,8 +26,8 @@ describe('InstallService', () => {
// Assert
expect(mockedAddConfig).toHaveBeenCalledTimes(3)
- expect(appendFile).toHaveBeenCalledTimes(1)
- expect(appendFile).toHaveBeenCalledWith(
+ expect(appendFileMocked).toHaveBeenCalledTimes(1)
+ expect(appendFileMocked).toHaveBeenCalledWith(
'.gitattributes',
expect.stringContaining('*.xml merge=salesforce-source\n'),
{ flag: 'a' }
diff --git a/test/unit/service/JsonMergeService.test.ts b/test/unit/service/JsonMergeService.test.ts
new file mode 100644
index 0000000..0b39f4e
--- /dev/null
+++ b/test/unit/service/JsonMergeService.test.ts
@@ -0,0 +1,29 @@
+import { JsonMergeService } from '../../../src/service/JsonMergeService.js'
+
+describe('JsonMergeService', () => {
+ let sut: JsonMergeService
+
+ beforeEach(() => {
+ sut = new JsonMergeService()
+ })
+
+ it('should merge two JSON objects with no conflicts', async () => {
+ const obj1 = { a: 1, b: 2 }
+ const obj2 = { b: 3, c: 4 }
+ const obj3 = { d: 2, e: 2 }
+
+ const result = await sut.mergeObjects(obj1, obj2, obj3)
+
+ expect(result).toEqual({ b: 3, c: 4, d: 2, e: 2 })
+ })
+
+ it('should merge two JSON objects with conflicts', async () => {
+ const obj1 = { a: 1, b: 2 }
+ const obj2 = { a: 3, b: 2 }
+ const obj3 = { b: 2, c: 3 }
+
+ const result = await sut.mergeObjects(obj1, obj2, obj3)
+
+ expect(result).toEqual({ a: 3, b: 2, c: 3 })
+ })
+})
diff --git a/test/unit/service/UninstallService.test.ts b/test/unit/service/UninstallService.test.ts
index 0a1ce3f..afbed35 100644
--- a/test/unit/service/UninstallService.test.ts
+++ b/test/unit/service/UninstallService.test.ts
@@ -1,12 +1,20 @@
import { readFile, writeFile } from 'node:fs/promises'
+import simpleGit from 'simple-git'
import { DRIVER_NAME } from '../../../src/constant/driverConstant.js'
import { UninstallService } from '../../../src/service/uninstallService.js'
+jest.mock('node:fs/promises')
+jest.mock('simple-git')
const mockedRaw = jest.fn()
-jest.mock('simple-git', () => ({
+const simpleGitMock = simpleGit as jest.Mock
+simpleGitMock.mockReturnValue({
raw: mockedRaw,
-}))
-jest.mock('node:fs/promises')
+})
+
+const readFileMocked = jest.mocked(readFile)
+readFileMocked.mockResolvedValue(
+ '*.xml merge=salesforce-source\nsome other content'
+)
describe('UninstallService', () => {
let sut: UninstallService // System Under Test
@@ -21,11 +29,11 @@ describe('UninstallService', () => {
await sut.uninstallMergeDriver()
// Assert
- expect(mockedRaw).toHaveBeenCalledWith(
+ expect(mockedRaw).toHaveBeenCalledWith([
'config',
'--remove-section',
- `merge.${DRIVER_NAME}`
- )
+ `merge.${DRIVER_NAME}`,
+ ])
expect(readFile).toHaveBeenCalledTimes(1)
expect(readFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
expect(writeFile).toHaveBeenCalledTimes(1)
diff --git a/test/unit/service/XmlMergeService.test.ts b/test/unit/service/XmlMergeService.test.ts
index c56c20d..db28192 100644
--- a/test/unit/service/XmlMergeService.test.ts
+++ b/test/unit/service/XmlMergeService.test.ts
@@ -1,61 +1,61 @@
-import { XMLBuilder, XMLParser } from "fast-xml-parser";
-import { JsonMergeService } from "../../../src/service/JsonMergeService.js";
-import { XmlMergeService } from "../../../src/service/XmlMergeService.js";
+import { XMLBuilder, XMLParser } from 'fast-xml-parser'
+import { JsonMergeService } from '../../../src/service/JsonMergeService.js'
+import { XmlMergeService } from '../../../src/service/XmlMergeService.js'
-jest.mock("fast-xml-parser", () => {
+jest.mock('fast-xml-parser', () => {
return {
XMLParser: jest.fn().mockImplementation(() => {
return {
- parse: (xml) => xml,
- };
+ parse: xml => xml,
+ }
}),
XMLBuilder: jest.fn().mockImplementation(() => {
return {
- build: (obj) => obj,
- };
+ build: obj => obj,
+ }
}),
- };
-});
+ }
+})
-const mockedMergeObjects = jest.fn();
-jest.mock("../../../src/service/JsonMergeService.js", () => {
+const mockedMergeObjects = jest.fn()
+jest.mock('../../../src/service/JsonMergeService.js', () => {
return {
JsonMergeService: jest.fn().mockImplementation(() => {
return {
mergeObjects: mockedMergeObjects,
- };
+ }
}),
- };
-});
+ }
+})
-describe("MergeDriver", () => {
- let sut: XmlMergeService;
+describe('MergeDriver', () => {
+ let sut: XmlMergeService
beforeEach(() => {
- sut = new XmlMergeService();
- });
+ sut = new XmlMergeService()
+ })
- describe("tripartXmlMerge", () => {
- it("should merge files successfully when given valid parameters", async () => {
+ describe('tripartXmlMerge', () => {
+ it('should merge files successfully when given valid parameters', async () => {
// Act
- await sut.tripartXmlMerge("AncestorFile", "OurFile", "TheirFile");
+ await sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
// Assert
- expect(XMLParser).toHaveBeenCalledTimes(1);
- expect(XMLBuilder).toHaveBeenCalledTimes(1);
- expect(JsonMergeService).toHaveBeenCalledTimes(1);
- });
+ expect(XMLParser).toHaveBeenCalledTimes(1)
+ expect(XMLBuilder).toHaveBeenCalledTimes(1)
+ expect(JsonMergeService).toHaveBeenCalledTimes(1)
+ })
- it("should throw an error when tripartXmlMerge fails", async () => {
+ it('should throw an error when tripartXmlMerge fails', async () => {
// Arrange
mockedMergeObjects.mockRejectedValue(
- new Error("Tripart XML merge failed")
- );
+ new Error('Tripart XML merge failed')
+ )
// Act and Assert
await expect(
- sut.tripartXmlMerge("AncestorFile", "OurFile", "TheirFile")
- ).rejects.toThrowError("Tripart XML merge failed");
- });
- });
-});
+ sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
+ ).rejects.toThrowError('Tripart XML merge failed')
+ })
+ })
+})
From a8645a528f3e38a206d103f413b23b80b20ae0a2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 16:14:27 +0100
Subject: [PATCH 03/55] test: add integration test
---
src/commands/git/merge/driver/install.ts | 5 +-
src/service/installService.ts | 2 +-
src/service/uninstallService.ts | 5 +-
test/data/.keep | 0
test/integration/install.nut.ts | 83 +++++++++++++++++++++++
test/integration/uninstall.nut.ts | 86 ++++++++++++++++++++++++
6 files changed, 178 insertions(+), 3 deletions(-)
create mode 100644 test/data/.keep
create mode 100644 test/integration/install.nut.ts
create mode 100644 test/integration/uninstall.nut.ts
diff --git a/src/commands/git/merge/driver/install.ts b/src/commands/git/merge/driver/install.ts
index f9146c0..68cf7a3 100644
--- a/src/commands/git/merge/driver/install.ts
+++ b/src/commands/git/merge/driver/install.ts
@@ -15,7 +15,10 @@ export default class Install extends SfCommand<void> {
public static override readonly flags = {}
public async run(): Promise<void> {
- await new UninstallService().uninstallMergeDriver()
+ try {
+ await new UninstallService().uninstallMergeDriver()
+ // biome-ignore lint/suspicious/noEmptyBlockStatements: <explanation>
+ } catch {}
await new InstallService().installMergeDriver()
}
}
diff --git a/src/service/installService.ts b/src/service/installService.ts
index 24abec5..9bc0742 100644
--- a/src/service/installService.ts
+++ b/src/service/installService.ts
@@ -14,7 +14,7 @@ export class InstallService {
`merge.${DRIVER_NAME}.driver`,
'node ${__dirname}/index.js %O %A %B %P' // TODO define how to do that
)
- await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true') // TO CHALLENGE
+ await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true') // TO CHALLENGE if needed
const content =
['*.xml'].map(pattern => `${pattern} merge=${DRIVER_NAME}`).join('\n') +
diff --git a/src/service/uninstallService.ts b/src/service/uninstallService.ts
index e74fd49..768d35a 100644
--- a/src/service/uninstallService.ts
+++ b/src/service/uninstallService.ts
@@ -7,7 +7,10 @@ const MERGE_DRIVER_CONFIG = new RegExp(`.* merge\\s*=\\s*${DRIVER_NAME}$`)
export class UninstallService {
public async uninstallMergeDriver() {
const git = simpleGit()
- await git.raw(['config', '--remove-section', `merge.${DRIVER_NAME}`])
+ try {
+ await git.raw(['config', '--remove-section', `merge.${DRIVER_NAME}`])
+ // biome-ignore lint/suspicious/noEmptyBlockStatements: <explanation>
+ } catch {}
const gitAttributes = await readFile('.gitattributes', {
encoding: 'utf8',
diff --git a/test/data/.keep b/test/data/.keep
new file mode 100644
index 0000000..e69de29
diff --git a/test/integration/install.nut.ts b/test/integration/install.nut.ts
new file mode 100644
index 0000000..e1af585
--- /dev/null
+++ b/test/integration/install.nut.ts
@@ -0,0 +1,83 @@
+import { execSync } from 'node:child_process'
+import { existsSync, readFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { execCmd } from '@salesforce/cli-plugins-testkit'
+import { expect } from 'chai'
+import { after, before, describe, it } from 'mocha'
+import { DRIVER_NAME } from '../../src/constant/driverConstant.js'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const ROOT_FOLDER = join(__dirname, '../data')
+
+describe('git merge driver install', () => {
+ before(() => {
+ execSync('git init', {
+ cwd: ROOT_FOLDER,
+ })
+ })
+
+ after(() => {
+ // Clean up by removing .git folder and .gitattributes file
+ execSync('rm -rf .git', {
+ cwd: ROOT_FOLDER,
+ })
+
+ const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
+ if (existsSync(gitattributesPath)) {
+ execSync(`rm ${gitattributesPath}`, {
+ cwd: ROOT_FOLDER,
+ })
+ }
+ })
+
+ it('installs merge driver correctly', () => {
+ // Arrange
+ // No specific arrangement needed as we're testing a fresh install
+
+ // Act
+ execCmd('git merge driver install', {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ })
+
+ // Assert
+ const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
+ expect(existsSync(gitattributesPath)).to.be.true
+
+ const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
+ expect(gitattributesContent).to.include('*.xml merge=salesforce-source')
+
+ const gitConfigOutput = execSync('git config --list', {
+ cwd: ROOT_FOLDER,
+ }).toString()
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.name`)
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.driver`)
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive`)
+ })
+
+ it('reinstalls merge driver correctly', () => {
+ // Arrange
+ // Driver is already installed from previous test
+
+ // Act
+ execCmd('git merge driver install', {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ })
+
+ // Assert
+ const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
+ expect(existsSync(gitattributesPath)).to.be.true
+
+ const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
+ expect(gitattributesContent).to.include('*.xml merge=salesforce-source')
+
+ const gitConfigOutput = execSync('git config --list', {
+ cwd: ROOT_FOLDER,
+ }).toString()
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.name`)
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.driver`)
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive`)
+ })
+})
diff --git a/test/integration/uninstall.nut.ts b/test/integration/uninstall.nut.ts
new file mode 100644
index 0000000..ea37896
--- /dev/null
+++ b/test/integration/uninstall.nut.ts
@@ -0,0 +1,86 @@
+import { execSync } from 'node:child_process'
+import { existsSync, readFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { execCmd } from '@salesforce/cli-plugins-testkit'
+import { expect } from 'chai'
+import { after, before, describe, it } from 'mocha'
+import { DRIVER_NAME } from '../../src/constant/driverConstant.js'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const ROOT_FOLDER = join(__dirname, '../data')
+
+describe('git merge driver uninstall', () => {
+ before(() => {
+ execSync('git init', {
+ cwd: ROOT_FOLDER,
+ })
+ })
+
+ after(() => {
+ // Clean up by removing .git folder and .gitattributes file
+ execSync('rm -rf .git', {
+ cwd: ROOT_FOLDER,
+ })
+
+ const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
+ if (existsSync(gitattributesPath)) {
+ execSync(`rm ${gitattributesPath}`, {
+ cwd: ROOT_FOLDER,
+ })
+ }
+ })
+
+ it('uninstalls merge driver correctly', () => {
+ // Arrange
+ execCmd('git:merge:driver:install', {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ })
+
+ // Act
+ execCmd('git merge driver uninstall', {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ })
+
+ // Assert
+ const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
+ expect(existsSync(gitattributesPath)).to.be.true
+
+ const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
+ expect(gitattributesContent).not.to.include('*.xml merge=salesforce-source')
+
+ const gitConfigOutput = execSync('git config --list', {
+ cwd: ROOT_FOLDER,
+ }).toString()
+ expect(gitConfigOutput).not.to.include(`merge.${DRIVER_NAME}.name`)
+ expect(gitConfigOutput).not.to.include(`merge.${DRIVER_NAME}.driver`)
+ expect(gitConfigOutput).not.to.include(`merge.${DRIVER_NAME}.recursive`)
+ })
+
+ it('uninstalls does nothing when not installed', () => {
+ // Arrange
+ // No setup needed as we're testing the case where nothing is installed
+
+ // Act
+ execCmd('git merge driver uninstall', {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ })
+
+ // Assert
+ const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
+ expect(existsSync(gitattributesPath)).to.be.true
+
+ const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
+ expect(gitattributesContent).not.to.include('*.xml merge=salesforce-source')
+
+ const gitConfigOutput = execSync('git config --list', {
+ cwd: ROOT_FOLDER,
+ }).toString()
+ expect(gitConfigOutput).not.to.include(`merge.${DRIVER_NAME}.name`)
+ expect(gitConfigOutput).not.to.include(`merge.${DRIVER_NAME}.driver`)
+ expect(gitConfigOutput).not.to.include(`merge.${DRIVER_NAME}.recursive`)
+ })
+})
From 64c7217ba2ba97e03c2965c8fb8fdd6d043de007 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 16:20:10 +0100
Subject: [PATCH 04/55] docs: add README.md
---
README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 73 insertions(+)
diff --git a/README.md b/README.md
index 20709b6..abfd646 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,74 @@
# Salesforce Metadata Git Merge Driver
+
+A custom Git merge driver designed specifically for Salesforce metadata files. This tool helps resolve merge conflicts in Salesforce XML metadata files by understanding their structure and intelligently merging changes.
+
+## Features
+
+- Intelligent merging of Salesforce XML metadata files
+- Handles complex metadata structures like arrays with unique identifiers
+- Supports both local and global installation
+- Easy to use with SFDX CLI plugin commands
+
+## Installation
+
+### As SFDX Plugin
+
+```bash
+sf plugins install sf-git-merge-driver
+```
+
+### Local Repository Installation
+
+```bash
+sf git merge driver install
+```
+
+This will:
+- Configure your Git settings to use the merge driver
+- Add appropriate entries to your `.gitattributes` file
+- Set up the driver to handle XML files
+
+## Uninstallation
+
+```bash
+sf git merge driver uninstall
+```
+
+## How It Works
+
+The merge driver works by:
+1. Converting XML to JSON for easier processing
+2. Using a specialized three-way merge algorithm that understands Salesforce metadata structures
+3. Intelligently resolving conflicts based on metadata type
+4. Converting the merged result back to properly formatted XML
+
+## Configuration
+
+The driver is configured to work with `.xml` files by default. The installation adds the following to your `.gitattributes` file:
+
+```
+*.xml merge=salesforce-source
+```
+
+## Changelog
+
+[changelog.md](CHANGELOG.md) is available for consultation.
+
+## Versioning
+
+Versioning follows [SemVer](http://semver.org/) specification.
+
+## Authors
+
+- **Kevin Gossent** - [yohanim](https://github.com/yohanim)
+- **Sebastien Colladon** - [scolladon](https://github.com/scolladon)
+
+## Contributing
+
+Contributions are what make the trailblazer community such an amazing place. I regard this component as a way to inspire and learn from others. Any contributions you make are **appreciated**.
+
+See [contributing.md](CONTRIBUTING.md) for sgd contribution principles.
+
+## License
+
+This project license is MIT - see the [LICENSE.md](LICENSE.md) file for details
From cf5225f765b74a57e2295b38a3975ba7f2e19217 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 16:30:43 +0100
Subject: [PATCH 05/55] refactor: spread classes into folders
---
src/{service => driver}/MergeDriver.ts | 6 +++---
src/index.ts | 2 +-
.../JsonMergeService.ts => merger/JsonMerger.ts} | 2 +-
.../XmlMergeService.ts => merger/XmlMerger.ts} | 12 ++++--------
test/unit/{service => driver}/MergeDriver.test.ts | 6 +++---
.../JsonMerger.test.ts} | 8 ++++----
.../XmlMerger.test.ts} | 14 +++++++-------
7 files changed, 23 insertions(+), 27 deletions(-)
rename src/{service => driver}/MergeDriver.ts (76%)
rename src/{service/JsonMergeService.ts => merger/JsonMerger.ts} (99%)
rename src/{service/XmlMergeService.ts => merger/XmlMerger.ts} (78%)
rename test/unit/{service => driver}/MergeDriver.test.ts (89%)
rename test/unit/{service/JsonMergeService.test.ts => merger/JsonMerger.test.ts} (77%)
rename test/unit/{service/XmlMergeService.test.ts => merger/XmlMerger.test.ts} (76%)
diff --git a/src/service/MergeDriver.ts b/src/driver/MergeDriver.ts
similarity index 76%
rename from src/service/MergeDriver.ts
rename to src/driver/MergeDriver.ts
index cfc00f3..208c1fd 100644
--- a/src/service/MergeDriver.ts
+++ b/src/driver/MergeDriver.ts
@@ -1,5 +1,5 @@
import { readFile, writeFile } from 'node:fs/promises'
-import { XmlMergeService } from './XmlMergeService.js'
+import { XmlMerger } from '../merger/XmlMerger.js'
export class MergeDriver {
async mergeFiles(ancestorFile, ourFile, theirFile, outputFile) {
@@ -10,9 +10,9 @@ export class MergeDriver {
readFile(theirFile, 'utf8'),
])
- const mergeService = new XmlMergeService()
+ const xmlMerger = new XmlMerger()
- const mergedContent = await mergeService.tripartXmlMerge(
+ const mergedContent = await xmlMerger.tripartXmlMerge(
ancestorContent,
ourContent,
theirContent
diff --git a/src/index.ts b/src/index.ts
index c1ddeca..30fc77e 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,5 +1,5 @@
#!/usr/bin/env -S NODE_OPTIONS="--no-warnings=ExperimentalWarning" npx ts-node --project tsconfig.json --esm
-import { MergeDriver } from './service/MergeDriver.js'
+import { MergeDriver } from './driver/MergeDriver.js'
if (process.argv.length >= 6) {
const [, , ancestorFile, ourFile, theirFile, outputFile] = process.argv
diff --git a/src/service/JsonMergeService.ts b/src/merger/JsonMerger.ts
similarity index 99%
rename from src/service/JsonMergeService.ts
rename to src/merger/JsonMerger.ts
index 22da51d..58bae0d 100644
--- a/src/service/JsonMergeService.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,4 +1,4 @@
-export class JsonMergeService {
+export class JsonMerger {
// Deep merge function for objects
mergeObjects(ancestor, ours, theirs) {
// If types don't match, prefer our version
diff --git a/src/service/XmlMergeService.ts b/src/merger/XmlMerger.ts
similarity index 78%
rename from src/service/XmlMergeService.ts
rename to src/merger/XmlMerger.ts
index 50b3b56..58155b9 100644
--- a/src/service/XmlMergeService.ts
+++ b/src/merger/XmlMerger.ts
@@ -1,5 +1,5 @@
import { XMLBuilder, XMLParser } from 'fast-xml-parser'
-import { JsonMergeService } from './JsonMergeService.js'
+import { JsonMerger } from './JsonMerger.js'
const options = {
attributeNamePrefix: '@_',
@@ -16,7 +16,7 @@ const options = {
trimValues: true,
}
-export class XmlMergeService {
+export class XmlMerger {
async tripartXmlMerge(
ancestorContent: string,
ourContent: string,
@@ -30,12 +30,8 @@ export class XmlMergeService {
// Perform deep merge of XML objects
- const jsonMergeService = new JsonMergeService()
- const mergedObj = jsonMergeService.mergeObjects(
- ancestorObj,
- ourObj,
- theirObj
- )
+ const jsonMerger = new JsonMerger()
+ const mergedObj = jsonMerger.mergeObjects(ancestorObj, ourObj, theirObj)
// Convert back to XML and format
const builder = new XMLBuilder(options)
diff --git a/test/unit/service/MergeDriver.test.ts b/test/unit/driver/MergeDriver.test.ts
similarity index 89%
rename from test/unit/service/MergeDriver.test.ts
rename to test/unit/driver/MergeDriver.test.ts
index 75d202d..f10066a 100644
--- a/test/unit/service/MergeDriver.test.ts
+++ b/test/unit/driver/MergeDriver.test.ts
@@ -1,4 +1,4 @@
-import { MergeDriver } from '../../../src/service/MergeDriver.js'
+import { MergeDriver } from '../../../src/driver/MergeDriver.js'
const mockReadFile = jest.fn()
const mockWriteFile = jest.fn()
@@ -8,8 +8,8 @@ jest.mock('node:fs/promises', () => ({
}))
const mockedTripartXmlMerge = jest.fn()
-jest.mock('../../../src/service/XmlMergeService.js', () => ({
- XmlMergeService: jest.fn(() => ({
+jest.mock('../../../src/merger/XmlMerger.js', () => ({
+ XmlMerger: jest.fn(() => ({
tripartXmlMerge: mockedTripartXmlMerge,
})),
}))
diff --git a/test/unit/service/JsonMergeService.test.ts b/test/unit/merger/JsonMerger.test.ts
similarity index 77%
rename from test/unit/service/JsonMergeService.test.ts
rename to test/unit/merger/JsonMerger.test.ts
index 0b39f4e..ca0ec91 100644
--- a/test/unit/service/JsonMergeService.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -1,10 +1,10 @@
-import { JsonMergeService } from '../../../src/service/JsonMergeService.js'
+import { JsonMerger } from '../../../src/merger/JsonMerger.js'
-describe('JsonMergeService', () => {
- let sut: JsonMergeService
+describe('JsonMerger', () => {
+ let sut: JsonMerger
beforeEach(() => {
- sut = new JsonMergeService()
+ sut = new JsonMerger()
})
it('should merge two JSON objects with no conflicts', async () => {
diff --git a/test/unit/service/XmlMergeService.test.ts b/test/unit/merger/XmlMerger.test.ts
similarity index 76%
rename from test/unit/service/XmlMergeService.test.ts
rename to test/unit/merger/XmlMerger.test.ts
index db28192..2f42c30 100644
--- a/test/unit/service/XmlMergeService.test.ts
+++ b/test/unit/merger/XmlMerger.test.ts
@@ -1,6 +1,6 @@
import { XMLBuilder, XMLParser } from 'fast-xml-parser'
-import { JsonMergeService } from '../../../src/service/JsonMergeService.js'
-import { XmlMergeService } from '../../../src/service/XmlMergeService.js'
+import { JsonMerger } from '../../../src/merger/JsonMerger.js'
+import { XmlMerger } from '../../../src/merger/XmlMerger.js'
jest.mock('fast-xml-parser', () => {
return {
@@ -18,9 +18,9 @@ jest.mock('fast-xml-parser', () => {
})
const mockedMergeObjects = jest.fn()
-jest.mock('../../../src/service/JsonMergeService.js', () => {
+jest.mock('../../../src/merger/JsonMerger.js', () => {
return {
- JsonMergeService: jest.fn().mockImplementation(() => {
+ JsonMerger: jest.fn().mockImplementation(() => {
return {
mergeObjects: mockedMergeObjects,
}
@@ -29,10 +29,10 @@ jest.mock('../../../src/service/JsonMergeService.js', () => {
})
describe('MergeDriver', () => {
- let sut: XmlMergeService
+ let sut: XmlMerger
beforeEach(() => {
- sut = new XmlMergeService()
+ sut = new XmlMerger()
})
describe('tripartXmlMerge', () => {
@@ -43,7 +43,7 @@ describe('MergeDriver', () => {
// Assert
expect(XMLParser).toHaveBeenCalledTimes(1)
expect(XMLBuilder).toHaveBeenCalledTimes(1)
- expect(JsonMergeService).toHaveBeenCalledTimes(1)
+ expect(JsonMerger).toHaveBeenCalledTimes(1)
})
it('should throw an error when tripartXmlMerge fails', async () => {
From e8ad4601b31889116c600767975803f130bafff5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 18:00:49 +0100
Subject: [PATCH 06/55] feat: copy the executable in the node_modules binary
---
jest.config.js | 18 +++++++++-
package-lock.json | 14 ++++++++
package.json | 9 +++--
src/service/installService.ts | 18 +++++++---
src/service/uninstallService.ts | 12 ++++++-
test/integration/install.nut.ts | 36 ++++++++++++--------
test/unit/service/InstallService.test.ts | 38 ++++++++++++++++++++--
test/unit/service/UninstallService.test.ts | 8 ++++-
8 files changed, 128 insertions(+), 25 deletions(-)
diff --git a/jest.config.js b/jest.config.js
index 32de949..3fe4768 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -72,7 +72,23 @@ export default {
// A map from regular expressions to paths to transformers
transform: {
- '\\.ts$': ['ts-jest', { tsconfig: './tsconfig.json' }],
+ '\\.ts$': ['ts-jest', {
+ diagnostics: {
+ ignoreCodes: [1343]
+ },
+ astTransformers: {
+ before: [
+ {
+ path: 'ts-jest-mock-import-meta',
+ options: {
+ metaObjectReplacement: {
+ url: 'file:///mock/test'
+ }
+ }
+ }
+ ]
+ },
+ tsconfig: './tsconfig.json' }],
},
extensionsToTreatAsEsm: ['.ts'],
// A map from regular expressions to module names that allow to stub out resources with a single module
diff --git a/package-lock.json b/package-lock.json
index 2522eed..466dbf1 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -16,6 +16,9 @@
"fast-xml-parser": "^5.0.8",
"simple-git": "^3.27.0"
},
+ "bin": {
+ "sf-git-merge-driver": "lib/index.js"
+ },
"devDependencies": {
"@biomejs/biome": "1.9.4",
"@commitlint/config-conventional": "^19.7.1",
@@ -33,6 +36,7 @@
"oclif": "^4.17.34",
"shx": "^0.3.4",
"ts-jest": "^29.2.6",
+ "ts-jest-mock-import-meta": "^1.2.1",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typescript": "^5.8.2",
@@ -13361,6 +13365,16 @@
}
}
},
+ "node_modules/ts-jest-mock-import-meta": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/ts-jest-mock-import-meta/-/ts-jest-mock-import-meta-1.2.1.tgz",
+ "integrity": "sha512-+qh8ZijpFnh7nMNdw1yYrvmnhe3Rctau5a3AFtgBAtps46RSiC8SHr3Z0S9sNqCU3cNOGumCAVO7Ac65fstxRA==",
+ "dev": true,
+ "license": "MIT",
+ "peerDependencies": {
+ "ts-jest": ">=20.0.0"
+ }
+ },
"node_modules/ts-node": {
"version": "10.9.2",
"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
diff --git a/package.json b/package.json
index c46cd9c..4e84ff1 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,10 @@
"name": "sf-git-merge-driver",
"description": "git remote add origin git@github.com:scolladon/sf-git-merge-driver.git",
"version": "1.0.0",
- "exports": "./lib/service/MergeDriver.js",
+ "exports": "./lib/driver/MergeDriver.js",
+ "bin": {
+ "sf-git-merge-driver": "./lib/index.js"
+ },
"type": "module",
"author": "Sébastien Colladon (colladonsebastien@gmail.com)",
"repository": {
@@ -33,6 +36,7 @@
"oclif": "^4.17.34",
"shx": "^0.3.4",
"ts-jest": "^29.2.6",
+ "ts-jest-mock-import-meta": "^1.2.1",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typescript": "^5.8.2",
@@ -46,7 +50,8 @@
"/messages",
"/npm-shrinkwrap.json",
"/oclif.manifest.json",
- "/oclif.lock"
+ "/oclif.lock",
+ "/bin"
],
"keywords": [
"sf",
diff --git a/src/service/installService.ts b/src/service/installService.ts
index 9bc0742..18faf51 100644
--- a/src/service/installService.ts
+++ b/src/service/installService.ts
@@ -1,20 +1,30 @@
-import { appendFile } from 'node:fs/promises'
+import { appendFile, chmod, copyFile, mkdir } from 'node:fs/promises'
+import { join } from 'node:path'
+import { fileURLToPath } from 'node:url'
import { simpleGit } from 'simple-git'
import { DRIVER_NAME } from '../constant/driverConstant.js'
+const currentDir = fileURLToPath(new URL('.', import.meta.url))
+const libIndexPath = join(currentDir, '../../lib/index.js')
+const binaryPath = 'node_modules/.bin'
+const localBinPath = `${binaryPath}/sf-git-merge-driver`
+
export class InstallService {
public async installMergeDriver() {
- const git = simpleGit()
+ await mkdir(binaryPath, { recursive: true })
+ await copyFile(libIndexPath, localBinPath)
+ await chmod(localBinPath, 0o755)
+ const git = simpleGit()
await git.addConfig(
`merge.${DRIVER_NAME}.name`,
'Salesforce source merge driver'
)
await git.addConfig(
`merge.${DRIVER_NAME}.driver`,
- 'node ${__dirname}/index.js %O %A %B %P' // TODO define how to do that
+ `${localBinPath} %O %A %B %P`
)
- await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true') // TO CHALLENGE if needed
+ await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true')
const content =
['*.xml'].map(pattern => `${pattern} merge=${DRIVER_NAME}`).join('\n') +
diff --git a/src/service/uninstallService.ts b/src/service/uninstallService.ts
index 768d35a..065edc1 100644
--- a/src/service/uninstallService.ts
+++ b/src/service/uninstallService.ts
@@ -1,11 +1,21 @@
-import { readFile, writeFile } from 'node:fs/promises'
+import { readFile, unlink, writeFile } from 'node:fs/promises'
+import { join } from 'node:path'
import { simpleGit } from 'simple-git'
import { DRIVER_NAME } from '../constant/driverConstant.js'
const MERGE_DRIVER_CONFIG = new RegExp(`.* merge\\s*=\\s*${DRIVER_NAME}$`)
+const localBinPath = join(
+ process.cwd(),
+ 'node_modules/.bin/sf-git-merge-driver'
+)
export class UninstallService {
public async uninstallMergeDriver() {
+ try {
+ await unlink(localBinPath)
+ // biome-ignore lint/suspicious/noEmptyBlockStatements: <explanation>
+ } catch {}
+
const git = simpleGit()
try {
await git.raw(['config', '--remove-section', `merge.${DRIVER_NAME}`])
diff --git a/test/integration/install.nut.ts b/test/integration/install.nut.ts
index e1af585..dc45b2e 100644
--- a/test/integration/install.nut.ts
+++ b/test/integration/install.nut.ts
@@ -1,14 +1,13 @@
import { execSync } from 'node:child_process'
import { existsSync, readFileSync } from 'node:fs'
-import { dirname, join } from 'node:path'
-import { fileURLToPath } from 'node:url'
+import { join } from 'node:path'
import { execCmd } from '@salesforce/cli-plugins-testkit'
import { expect } from 'chai'
import { after, before, describe, it } from 'mocha'
import { DRIVER_NAME } from '../../src/constant/driverConstant.js'
-const __dirname = dirname(fileURLToPath(import.meta.url))
-const ROOT_FOLDER = join(__dirname, '../data')
+const ROOT_FOLDER = './test/data'
+const binaryPath = 'node_modules/.bin/sf-git-merge-driver'
describe('git merge driver install', () => {
before(() => {
@@ -22,10 +21,11 @@ describe('git merge driver install', () => {
execSync('rm -rf .git', {
cwd: ROOT_FOLDER,
})
-
- const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
- if (existsSync(gitattributesPath)) {
- execSync(`rm ${gitattributesPath}`, {
+ execSync('rm -rf node_modules', {
+ cwd: ROOT_FOLDER,
+ })
+ if (existsSync(join(ROOT_FOLDER, '.gitattributes'))) {
+ execSync(`rm .gitattributes`, {
cwd: ROOT_FOLDER,
})
}
@@ -51,9 +51,13 @@ describe('git merge driver install', () => {
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
}).toString()
- expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.name`)
- expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.driver`)
- expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive`)
+ expect(gitConfigOutput).to.include(
+ `merge.${DRIVER_NAME}.name=Salesforce source merge driver`
+ )
+ expect(gitConfigOutput).to.include(
+ `merge.${DRIVER_NAME}.driver=${binaryPath} %O %A %B %P`
+ )
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive=true`)
})
it('reinstalls merge driver correctly', () => {
@@ -76,8 +80,12 @@ describe('git merge driver install', () => {
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
}).toString()
- expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.name`)
- expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.driver`)
- expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive`)
+ expect(gitConfigOutput).to.include(
+ `merge.${DRIVER_NAME}.name=Salesforce source merge driver`
+ )
+ expect(gitConfigOutput).to.include(
+ `merge.${DRIVER_NAME}.driver=${binaryPath} %O %A %B %P`
+ )
+ expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive=true`)
})
})
diff --git a/test/unit/service/InstallService.test.ts b/test/unit/service/InstallService.test.ts
index aa20ba8..bf30fbd 100644
--- a/test/unit/service/InstallService.test.ts
+++ b/test/unit/service/InstallService.test.ts
@@ -1,9 +1,11 @@
-import { appendFile } from 'node:fs/promises'
+import { appendFile, chmod, copyFile, mkdir } from 'node:fs/promises'
import simpleGit from 'simple-git'
+import { DRIVER_NAME } from '../../../src/constant/driverConstant.js'
import { InstallService } from '../../../src/service/installService.js'
jest.mock('node:fs/promises')
jest.mock('simple-git')
+
const mockedAddConfig = jest.fn()
const simpleGitMock = simpleGit as jest.Mock
simpleGitMock.mockReturnValue({
@@ -11,6 +13,9 @@ simpleGitMock.mockReturnValue({
})
const appendFileMocked = jest.mocked(appendFile)
+const chmodMocked = jest.mocked(chmod)
+const copyFileMocked = jest.mocked(copyFile)
+const mkdirMocked = jest.mocked(mkdir)
describe('InstallService', () => {
let sut: InstallService // System Under Test
@@ -18,6 +23,8 @@ describe('InstallService', () => {
beforeEach(() => {
// Arrange
sut = new InstallService()
+ mockedAddConfig.mockClear()
+ appendFileMocked.mockClear()
})
it('should install successfully when given valid parameters', async () => {
@@ -26,11 +33,38 @@ describe('InstallService', () => {
// Assert
expect(mockedAddConfig).toHaveBeenCalledTimes(3)
+ expect(mockedAddConfig).toHaveBeenCalledWith(
+ `merge.${DRIVER_NAME}.name`,
+ 'Salesforce source merge driver'
+ )
+ expect(mockedAddConfig).toHaveBeenCalledWith(
+ `merge.${DRIVER_NAME}.driver`,
+ 'node_modules/.bin/sf-git-merge-driver %O %A %B %P'
+ )
+ expect(mockedAddConfig).toHaveBeenCalledWith(
+ `merge.${DRIVER_NAME}.recursive`,
+ 'true'
+ )
expect(appendFileMocked).toHaveBeenCalledTimes(1)
expect(appendFileMocked).toHaveBeenCalledWith(
'.gitattributes',
- expect.stringContaining('*.xml merge=salesforce-source\n'),
+ '*.xml merge=salesforce-source\n',
{ flag: 'a' }
)
+ expect(chmodMocked).toHaveBeenCalledTimes(1)
+ expect(chmodMocked).toHaveBeenCalledWith(
+ 'node_modules/.bin/sf-git-merge-driver',
+ 0o755
+ )
+ expect(copyFileMocked).toHaveBeenCalledTimes(1)
+ expect(copyFileMocked).toHaveBeenCalledWith(
+ expect.stringContaining('lib/index.js'),
+ expect.stringContaining('node_modules/.bin/sf-git-merge-driver')
+ )
+ expect(mkdirMocked).toHaveBeenCalledTimes(1)
+ expect(mkdirMocked).toHaveBeenCalledWith(
+ expect.stringContaining('node_modules/.bin'),
+ { recursive: true }
+ )
})
})
diff --git a/test/unit/service/UninstallService.test.ts b/test/unit/service/UninstallService.test.ts
index afbed35..841f86f 100644
--- a/test/unit/service/UninstallService.test.ts
+++ b/test/unit/service/UninstallService.test.ts
@@ -1,4 +1,4 @@
-import { readFile, writeFile } from 'node:fs/promises'
+import { readFile, unlink, writeFile } from 'node:fs/promises'
import simpleGit from 'simple-git'
import { DRIVER_NAME } from '../../../src/constant/driverConstant.js'
import { UninstallService } from '../../../src/service/uninstallService.js'
@@ -16,6 +16,8 @@ readFileMocked.mockResolvedValue(
'*.xml merge=salesforce-source\nsome other content'
)
+const unlinkMocked = jest.mocked(unlink)
+
describe('UninstallService', () => {
let sut: UninstallService // System Under Test
@@ -38,5 +40,9 @@ describe('UninstallService', () => {
expect(readFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
expect(writeFile).toHaveBeenCalledTimes(1)
expect(writeFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
+ expect(unlinkMocked).toHaveBeenCalledTimes(1)
+ expect(unlinkMocked).toHaveBeenCalledWith(
+ expect.stringContaining('node_modules/.bin/sf-git-merge-driver')
+ )
})
})
From fe950644abfc20ab3c9096db33c380c424db516a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 18:08:01 +0100
Subject: [PATCH 07/55] build: upgrade dependencies
---
package-lock.json | 17 ++++++++---------
package.json | 4 ++--
2 files changed, 10 insertions(+), 11 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index 466dbf1..aa8a320 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -10,9 +10,8 @@
"license": "MIT",
"dependencies": {
"@oclif/core": "^4.2.8",
- "@salesforce/core": "^8.8.4",
+ "@salesforce/core": "^8.8.5",
"@salesforce/sf-plugins-core": "^12.2.0",
- "@salesforce/ts-types": "^2.0.12",
"fast-xml-parser": "^5.0.8",
"simple-git": "^3.27.0"
},
@@ -25,7 +24,7 @@
"@oclif/plugin-help": "^6.2.26",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
- "@types/chai": "^5.0.1",
+ "@types/chai": "^5.2.0",
"@types/jest": "^29.5.14",
"chai": "^5.2.0",
"husky": "^9.1.7",
@@ -4200,9 +4199,9 @@
}
},
"node_modules/@salesforce/core": {
- "version": "8.8.4",
- "resolved": "https://registry.npmjs.org/@salesforce/core/-/core-8.8.4.tgz",
- "integrity": "sha512-TKioMWh/QWmXjnD0bMNvFHEqaH175TCYWNXUCO1CixdhhI0p1MQj4AnQsk8wuRJiH5kVhiYw6Z7NukcIxLtbUw==",
+ "version": "8.8.5",
+ "resolved": "https://registry.npmjs.org/@salesforce/core/-/core-8.8.5.tgz",
+ "integrity": "sha512-eCiiO4NptvKkz04A4ivBVLzEBy/6IIFmaXoZ4tnF1FcD5MESvC+Xuc+0RFSRiYmPi5oloKNl6njrfVCKAho2zQ==",
"license": "BSD-3-Clause",
"dependencies": {
"@jsforce/jsforce-node": "^3.6.5",
@@ -5249,9 +5248,9 @@
}
},
"node_modules/@types/chai": {
- "version": "5.0.1",
- "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.0.1.tgz",
- "integrity": "sha512-5T8ajsg3M/FOncpLYW7sdOcD6yf4+722sze/tc4KQV0P8Z2rAr3SAuHCIkYmYpt8VbcQlnz8SxlOlPQYefe4cA==",
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.0.tgz",
+ "integrity": "sha512-FWnQYdrG9FAC8KgPVhDFfrPL1FBsL3NtIt2WsxKvwu/61K6HiuDF3xAb7c7w/k9ML2QOUHcwTgU7dKLFPK6sBg==",
"dev": true,
"license": "MIT",
"dependencies": {
diff --git a/package.json b/package.json
index 4e84ff1..9a0e3de 100644
--- a/package.json
+++ b/package.json
@@ -14,7 +14,7 @@
},
"dependencies": {
"@oclif/core": "^4.2.8",
- "@salesforce/core": "^8.8.4",
+ "@salesforce/core": "^8.8.5",
"@salesforce/sf-plugins-core": "^12.2.0",
"fast-xml-parser": "^5.0.8",
"simple-git": "^3.27.0"
@@ -25,7 +25,7 @@
"@oclif/plugin-help": "^6.2.26",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
- "@types/chai": "^5.0.1",
+ "@types/chai": "^5.2.0",
"@types/jest": "^29.5.14",
"chai": "^5.2.0",
"husky": "^9.1.7",
From b56b28531feb7b889432091f051a6c859026b1d3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 18:18:34 +0100
Subject: [PATCH 08/55] build: fix linting issues
---
.github/linters/.cspell.json | 28 ++++++++-
test/index.test.js | 117 -----------------------------------
2 files changed, 27 insertions(+), 118 deletions(-)
delete mode 100644 test/index.test.js
diff --git a/.github/linters/.cspell.json b/.github/linters/.cspell.json
index d402626..6c2e3b2 100644
--- a/.github/linters/.cspell.json
+++ b/.github/linters/.cspell.json
@@ -9,5 +9,31 @@
"language": "en",
"noConfigSearch": true,
"version": "0.2",
- "words": []
+ "words": [
+ "amannn",
+ "apexskier",
+ "autoupdate",
+ "behaviour",
+ "brqh",
+ "codeowners",
+ "colladon",
+ "commitlint",
+ "gossent",
+ "instantiator",
+ "jwalton",
+ "mjyhjbm",
+ "mocharc",
+ "nonoctal",
+ "nycrc",
+ "scolladon",
+ "sebastien",
+ "sébastien",
+ "sfdx",
+ "sfdx",
+ "testkit",
+ "thollander",
+ "wagoid",
+ "wireit",
+ "yohanim"
+ ]
}
diff --git a/test/index.test.js b/test/index.test.js
deleted file mode 100644
index 74c60e3..0000000
--- a/test/index.test.js
+++ /dev/null
@@ -1,117 +0,0 @@
-import fs from 'fs'
-import assert from 'node:assert'
-import { describe, it } from 'node:test'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { mergeFiles } from '../src/index.js'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-describe('Salesforce Metadata Merge Driver', () => {
- const testDir = path.join(__dirname, 'fixtures')
-
- // Create test directory if it doesn't exist
- if (!fs.existsSync(testDir)) {
- fs.mkdirSync(testDir, { recursive: true })
- }
-
- describe('XML Merging', () => {
- it('should correctly merge XML files with non-conflicting changes', async () => {
- // Create test files
- const ancestorContent = `<?xml version="1.0" encoding="UTF-8"?>
-<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
- <label>Test Object</label>
- <pluralLabel>Test Objects</pluralLabel>
-</CustomObject>`
-
- const ourContent = `<?xml version="1.0" encoding="UTF-8"?>
-<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
- <label>Test Object</label>
- <pluralLabel>Test Objects</pluralLabel>
- <description>Our description</description>
-</CustomObject>`
-
- const theirContent = `<?xml version="1.0" encoding="UTF-8"?>
-<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
- <label>Modified Test Object</label>
- <pluralLabel>Test Objects</pluralLabel>
-</CustomObject>`
-
- const ancestorFile = path.join(testDir, 'ancestor.xml')
- const ourFile = path.join(testDir, 'ours.xml')
- const theirFile = path.join(testDir, 'theirs.xml')
- const outputFile = path.join(testDir, 'merged.xml')
-
- fs.writeFileSync(ancestorFile, ancestorContent)
- fs.writeFileSync(ourFile, ourContent)
- fs.writeFileSync(theirFile, theirContent)
-
- // Run the merge
- const success = await mergeFiles(
- ancestorFile,
- ourFile,
- theirFile,
- outputFile
- )
-
- // Verify the result
- assert.strictEqual(success, true)
- const mergedContent = fs.readFileSync(outputFile, 'utf8')
-
- // The merged content should contain both changes
- assert(mergedContent.includes('Modified Test Object'))
- assert(mergedContent.includes('Our description'))
- })
- })
-
- describe('JSON Merging', () => {
- it('should correctly merge JSON files with non-conflicting changes', async () => {
- // Create test files
- const ancestorContent = `{
- "fullName": "TestObject",
- "label": "Test Object",
- "pluralLabel": "Test Objects"
-}`
-
- const ourContent = `{
- "fullName": "TestObject",
- "label": "Test Object",
- "pluralLabel": "Test Objects",
- "description": "Our description"
-}`
-
- const theirContent = `{
- "fullName": "TestObject",
- "label": "Modified Test Object",
- "pluralLabel": "Test Objects"
-}`
-
- const ancestorFile = path.join(testDir, 'ancestor.json')
- const ourFile = path.join(testDir, 'ours.json')
- const theirFile = path.join(testDir, 'theirs.json')
- const outputFile = path.join(testDir, 'merged.json')
-
- fs.writeFileSync(ancestorFile, ancestorContent)
- fs.writeFileSync(ourFile, ourContent)
- fs.writeFileSync(theirFile, theirContent)
-
- // Run the merge
- const success = await mergeFiles(
- ancestorFile,
- ourFile,
- theirFile,
- outputFile
- )
-
- // Verify the result
- assert.strictEqual(success, true)
- const mergedContent = fs.readFileSync(outputFile, 'utf8')
- const mergedObj = JSON.parse(mergedContent)
-
- // The merged content should contain both changes
- assert.strictEqual(mergedObj.label, 'Modified Test Object')
- assert.strictEqual(mergedObj.description, 'Our description')
- })
- })
-})
From b4c01a321907d84fb8a98f5638b3289d7474bf6c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 6 Mar 2025 18:31:15 +0100
Subject: [PATCH 09/55] feat: implement a first tripart simple json algorithm
with spec
---
knip.config.ts | 2 +-
src/merger/JsonMerger.ts | 216 ++++++++++++++--------------
test/unit/merger/JsonMerger.test.ts | 210 +++++++++++++++++++++++++--
3 files changed, 310 insertions(+), 118 deletions(-)
diff --git a/knip.config.ts b/knip.config.ts
index 75f1319..af5e24b 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -8,7 +8,7 @@ export default {
'**/*.{nut,test}.ts',
'.github/**/*.yml',
],
- project: ['**/*.{ts,js,json,yml}'],
+ project: ['**/*.{ts,js,json,yml}', '!src/index.ts'],
ignoreDependencies: [
'@commitlint/config-conventional',
'ts-jest-mock-import-meta',
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 58bae0d..8a41c62 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,132 +1,138 @@
-export class JsonMerger {
- // Deep merge function for objects
- mergeObjects(ancestor, ours, theirs) {
- // If types don't match, prefer our version
- if (
- typeof ours !== typeof theirs ||
- Array.isArray(ours) !== Array.isArray(theirs)
- ) {
- return ours
- }
+type JsonValue = string | number | boolean | null | JsonObject | JsonArray
+interface JsonObject {
+ [key: string]: JsonValue
+}
+interface JsonArray extends Array<JsonValue> {}
- // Handle arrays - special case for Salesforce metadata
- if (Array.isArray(ours)) {
- return this.mergeArrays(ancestor, ours, theirs)
+export class JsonMerger {
+ private readonly idFields = [
+ 'fullName',
+ 'name',
+ 'field',
+ 'label',
+ 'id',
+ '@_name',
+ ]
+
+ mergeObjects(
+ ancestor: JsonValue | undefined,
+ ours: JsonValue,
+ theirs: JsonValue
+ ): JsonValue {
+ // Handle null/undefined cases
+ if (ours === null || theirs === null) return ours ?? theirs
+ if (typeof ours !== typeof theirs) return ours
+
+ // Handle arrays (special case for Salesforce metadata)
+ if (Array.isArray(ours) && Array.isArray(theirs)) {
+ return this.mergeArrays(
+ Array.isArray(ancestor) ? ancestor : undefined,
+ ours,
+ theirs
+ )
}
// Handle objects
- if (typeof ours === 'object' && ours !== null) {
- const result = { ...ours }
+ if (typeof ours === 'object' && typeof theirs === 'object') {
+ const result = { ...ours } as JsonObject
+ const ancestorObj = (ancestor ?? {}) as JsonObject
+ const theirsObj = theirs as JsonObject
// Process all keys from both objects
- const allKeys = new Set([
- ...Object.keys(ours || {}),
- ...Object.keys(theirs || {}),
- ])
+ const allKeys = new Set([...Object.keys(ours), ...Object.keys(theirs)])
for (const key of allKeys) {
- // If key exists only in theirs, add it
- if (!(key in ours)) {
- result[key] = theirs[key]
- continue
- }
-
- // If key exists only in ours, keep it
- if (!(key in theirs)) {
+ if (!(key in theirsObj)) continue // Keep our version
+ if (!(key in result)) {
+ result[key] = theirsObj[key] // Take their version
continue
}
- // If key exists in both, recursively merge
- const ancestorValue = ancestor && ancestor[key]
- result[key] = this.mergeObjects(ancestorValue, ours[key], theirs[key])
+ // Recursively merge when both have the key
+ result[key] = this.mergeObjects(
+ ancestorObj[key],
+ result[key],
+ theirsObj[key]
+ )
}
-
return result
}
- // For primitive values, check if they changed from ancestor
- if (theirs !== ancestor && ours === ancestor) {
- // They changed it, we didn't - use their change
- return theirs
- }
-
- // In all other cases, prefer our version
- return ours
+ // For primitive values, use their changes if we didn't modify from ancestor
+ if (theirs !== ancestor && ours === ancestor) return theirs
+ return ours // Default to our version
}
- // Special handling for Salesforce metadata arrays
- mergeArrays(ancestor, ours, theirs) {
- // For Salesforce metadata, arrays often contain objects with unique identifiers
- // Try to match items by common identifier fields
- const idFields = ['fullName', 'name', 'field', 'label', 'id', '@_name']
-
- // Find a common identifier field that exists in the arrays
- const idField = idFields.find(
+ private mergeArrays(
+ ancestor: JsonArray | undefined,
+ ours: JsonArray,
+ theirs: JsonArray
+ ): JsonArray {
+ // Find the first matching ID field that exists in both arrays
+ const idField = this.idFields.find(
field =>
- ours.some(item => item && typeof item === 'object' && field in item) &&
- theirs.some(item => item && typeof item === 'object' && field in item)
+ ours.some(item => this.hasIdField(item, field)) &&
+ theirs.some(item => this.hasIdField(item, field))
)
- if (idField) {
- // If we found a common identifier, merge by that field
- const result = [...ours]
-
- // Create maps for faster lookups
- const ourMap = new Map(
- ours
- .filter(item => item && typeof item === 'object' && idField in item)
- .map(item => [item[idField], item])
- )
-
- const ancestorMap =
- ancestor && Array.isArray(ancestor)
- ? new Map(
- ancestor
- .filter(
- item => item && typeof item === 'object' && idField in item
- )
- .map(item => [item[idField], item])
- )
- : new Map()
-
- // Process items from their version
- for (const theirItem of theirs) {
- if (
- theirItem &&
- typeof theirItem === 'object' &&
- idField in theirItem
- ) {
- const id = theirItem[idField]
-
- if (ourMap.has(id)) {
- // Item exists in both versions, merge them
- const ourItem = ourMap.get(id)
- const ancestorItem = ancestorMap.get(id)
-
- // Find the index in our array
- const index = result.findIndex(
- item => item && typeof item === 'object' && item[idField] === id
- )
-
- if (index !== -1) {
- // Replace with merged item
- result[index] = this.mergeObjects(
- ancestorItem,
- ourItem,
- theirItem
- )
- }
- } else {
- // Item only exists in their version, add it
- result.push(theirItem)
- }
+ if (!idField) return ours // No common identifier, keep our version
+
+ // Create lookup maps
+ const ourMap = this.createIdMap(ours, idField)
+ const theirMap = this.createIdMap(theirs, idField)
+ const ancestorMap = ancestor
+ ? this.createIdMap(ancestor, idField)
+ : new Map()
+
+ const result = [...ours]
+ const processed = new Set<string>()
+
+ // Process all items from both arrays
+ for (const [id, ourItem] of ourMap) {
+ const theirItem = theirMap.get(id)
+ if (theirItem) {
+ // Item exists in both versions, merge them
+ const index = result.findIndex(
+ item => this.hasIdField(item, idField) && item[idField] === id
+ )
+ if (index !== -1) {
+ result[index] = this.mergeObjects(
+ ancestorMap.get(id),
+ ourItem,
+ theirItem
+ )
}
}
+ processed.add(id)
+ }
- return result
+ // Add items that only exist in their version
+ for (const [id, theirItem] of theirMap) {
+ if (!processed.has(id)) {
+ result.push(theirItem)
+ }
}
- // If no common identifier found, default to our version
- return ours
+ return result
+ }
+
+ private hasIdField(item: JsonValue, field: string): item is JsonObject {
+ return (
+ item !== null &&
+ typeof item === 'object' &&
+ !Array.isArray(item) &&
+ field in item
+ )
+ }
+
+ private createIdMap(
+ arr: JsonArray,
+ idField: string
+ ): Map<string, JsonObject> {
+ return new Map(
+ arr
+ .filter(item => this.hasIdField(item, idField))
+ .map(item => [String(item[idField]), item])
+ )
}
}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index ca0ec91..e4a0efa 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -4,26 +4,212 @@ describe('JsonMerger', () => {
let sut: JsonMerger
beforeEach(() => {
+ // Arrange
sut = new JsonMerger()
})
- it('should merge two JSON objects with no conflicts', async () => {
- const obj1 = { a: 1, b: 2 }
- const obj2 = { b: 3, c: 4 }
- const obj3 = { d: 2, e: 2 }
+ describe('given primitive values', () => {
+ describe('when our changes differ from ancestor', () => {
+ it('then should prefer our changes', () => {
+ // Act & Assert
+ expect(sut.mergeObjects(1, 2, 1)).toBe(2)
+ expect(sut.mergeObjects('old', 'new', 'old')).toBe('new')
+ expect(sut.mergeObjects(true, false, true)).toBe(false)
+ })
+ })
- const result = await sut.mergeObjects(obj1, obj2, obj3)
+ describe('when we match ancestor', () => {
+ it('then should accept their changes', () => {
+ // Act & Assert
+ expect(sut.mergeObjects(1, 1, 2)).toBe(2)
+ expect(sut.mergeObjects('old', 'old', 'new')).toBe('new')
+ expect(sut.mergeObjects(true, true, false)).toBe(false)
+ })
+ })
- expect(result).toEqual({ b: 3, c: 4, d: 2, e: 2 })
+ describe('when null values are present', () => {
+ it('then should handle them correctly', () => {
+ // Act & Assert
+ expect(sut.mergeObjects(1, null, null)).toBeNull()
+ expect(sut.mergeObjects(null, 1, null)).toBe(1)
+ expect(sut.mergeObjects(undefined, null, 1)).toBe(1)
+ })
+ })
})
- it('should merge two JSON objects with conflicts', async () => {
- const obj1 = { a: 1, b: 2 }
- const obj2 = { a: 3, b: 2 }
- const obj3 = { b: 2, c: 3 }
+ describe('given objects to merge', () => {
+ describe('when changes are non-conflicting', () => {
+ it('then should merge them correctly', () => {
+ // Arrange
+ const ancestor = { a: 1, b: 2 }
+ const ours = { a: 1, b: 3, c: 4 }
+ const theirs = { a: 1, b: 2, d: 5 }
- const result = await sut.mergeObjects(obj1, obj2, obj3)
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
+ a: 1,
+ b: 3,
+ c: 4,
+ d: 5,
+ })
+ })
+ })
- expect(result).toEqual({ a: 3, b: 2, c: 3 })
+ describe('when objects are nested', () => {
+ it('then should handle nested structures', () => {
+ // Arrange
+ const ancestor = { nested: { a: 1, b: 2 } }
+ const ours = { nested: { a: 2, b: 2 } }
+ const theirs = { nested: { a: 1, b: 3 } }
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
+ nested: { a: 2, b: 3 },
+ })
+ })
+ })
+
+ describe('when type mismatches occur', () => {
+ it('then should prefer our version', () => {
+ // Arrange
+ const ancestor = { a: 1 }
+ const ours = { a: { nested: true } }
+ const theirs = { a: 2 }
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
+ a: { nested: true },
+ })
+ })
+ })
+ })
+
+ describe('given arrays to merge', () => {
+ describe('when arrays have common identifiers', () => {
+ it('then should merge them correctly', () => {
+ // Arrange
+ const ancestor = [
+ { fullName: 'test1', value: 1 },
+ { fullName: 'test2', value: 2 },
+ ]
+ const ours = [
+ { fullName: 'test1', value: 3 },
+ { fullName: 'test2', value: 2 },
+ ]
+ const theirs = [
+ { fullName: 'test1', value: 1 },
+ { fullName: 'test2', value: 4 },
+ { fullName: 'test3', value: 5 },
+ ]
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual([
+ { fullName: 'test1', value: 3 },
+ { fullName: 'test2', value: 4 },
+ { fullName: 'test3', value: 5 },
+ ])
+ })
+ })
+
+ describe('when arrays use different identifier fields', () => {
+ it('then should handle different identifiers', () => {
+ // Arrange
+ const ancestor = [{ name: 'test1', value: 1 }]
+ const ours = [{ name: 'test1', value: 2 }]
+ const theirs = [{ name: 'test1', value: 3 }]
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual([
+ { name: 'test1', value: 2 },
+ ])
+ })
+ })
+
+ describe('when arrays have no identifiers', () => {
+ it('then should use our version', () => {
+ // Arrange
+ const ancestor = [1, 2, 3]
+ const ours = [2, 3, 4]
+ const theirs = [3, 4, 5]
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual([2, 3, 4])
+ })
+ })
+ })
+
+ describe('given Salesforce metadata', () => {
+ describe('when merging custom field definitions', () => {
+ it('then should merge correctly', () => {
+ // Arrange
+ const ancestor = {
+ fields: [
+ { fullName: 'Field1__c', type: 'Text', length: 100 },
+ { fullName: 'Field2__c', type: 'Number', precision: 10 },
+ ],
+ }
+ const ours = {
+ fields: [
+ { fullName: 'Field1__c', type: 'Text', length: 255 },
+ { fullName: 'Field2__c', type: 'Number', precision: 10 },
+ ],
+ }
+ const theirs = {
+ fields: [
+ { fullName: 'Field1__c', type: 'Text', length: 100 },
+ { fullName: 'Field2__c', type: 'Number', precision: 18 },
+ { fullName: 'Field3__c', type: 'Checkbox' },
+ ],
+ }
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
+ fields: [
+ { fullName: 'Field1__c', type: 'Text', length: 255 },
+ { fullName: 'Field2__c', type: 'Number', precision: 18 },
+ { fullName: 'Field3__c', type: 'Checkbox' },
+ ],
+ })
+ })
+ })
+
+ describe('when merging layout metadata', () => {
+ it('then should merge layouts correctly', () => {
+ // Arrange
+ const ancestor = {
+ layoutSections: [
+ { label: 'Information', layoutColumns: [{ fields: ['Name'] }] },
+ ],
+ }
+ const ours = {
+ layoutSections: [
+ {
+ label: 'Information',
+ layoutColumns: [{ fields: ['Name', 'Email'] }],
+ },
+ ],
+ }
+ const theirs = {
+ layoutSections: [
+ {
+ label: 'Information',
+ layoutColumns: [{ fields: ['Name', 'Phone'] }],
+ },
+ { label: 'System', layoutColumns: [{ fields: ['CreatedDate'] }] },
+ ],
+ }
+
+ // Act & Assert
+ expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
+ layoutSections: [
+ {
+ label: 'Information',
+ layoutColumns: [{ fields: ['Name', 'Email'] }],
+ },
+ { label: 'System', layoutColumns: [{ fields: ['CreatedDate'] }] },
+ ],
+ })
+ })
+ })
})
})
From 8be7bb845c3ae9973a93e6efb803334e0f0656da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 7 Mar 2025 08:37:04 +0100
Subject: [PATCH 10/55] docs: improve description and add usage
---
README.md | 67 +++++++++++++++++++++++++++++++++++--------
messages/install.md | 2 +-
messages/uninstall.md | 2 +-
3 files changed, 57 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index abfd646..1dcc9a7 100644
--- a/README.md
+++ b/README.md
@@ -11,29 +11,72 @@ A custom Git merge driver designed specifically for Salesforce metadata files. T
## Installation
-### As SFDX Plugin
-
```bash
sf plugins install sf-git-merge-driver
```
-### Local Repository Installation
+## Usage
+
+<!-- commands -->
+* [`sf git merge driver install`](#sf-git-merge-driver-install)
+* [`sf git merge driver uninstall`](#sf-git-merge-driver-uninstall)
+
+## `sf git merge driver install`
+
+Installs a local git merge driver for the given org and branch.
-```bash
-sf git merge driver install
```
+USAGE
+ $ sf git merge driver install [--json] [--flags-dir <value>]
-This will:
-- Configure your Git settings to use the merge driver
-- Add appropriate entries to your `.gitattributes` file
-- Set up the driver to handle XML files
+GLOBAL FLAGS
+ --flags-dir=<value> Import flag values from a directory.
+ --json Format output as json.
-## Uninstallation
+DESCRIPTION
+ Installs a local git merge driver for the given org and branch.
-```bash
-sf git merge driver uninstall
+ Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project,
+ creating a new merge driver configuration in the `.git/config` of the project, and installing the binary in the
+ node_modules/.bin directory.
+
+EXAMPLES
+ Install the driver for a given project:
+
+ $ sf git merge driver install
```
+_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/install.ts)_
+
+## `sf git merge driver uninstall`
+
+Uninstalls the local git merge driver for the given org and branch.
+
+```
+USAGE
+ $ sf git merge driver uninstall [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+ --flags-dir=<value> Import flag values from a directory.
+ --json Format output as json.
+
+DESCRIPTION
+ Uninstalls the local git merge driver for the given org and branch.
+
+ Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the
+ `.gitattributes` files in the project, deleting the merge driver configuration from the `.git/config` of the project,
+ and removing the installed binary from the node_modules/.bin directory.
+
+EXAMPLES
+ Uninstall the driver for a given project:
+
+ $ sf git merge driver uninstall
+```
+
+_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/uninstall.ts)_
+<!-- commandsstop -->
+
+
## How It Works
The merge driver works by:
diff --git a/messages/install.md b/messages/install.md
index d8be80a..e100f89 100644
--- a/messages/install.md
+++ b/messages/install.md
@@ -4,7 +4,7 @@ Installs a local git merge driver for the given org and branch.
# description
-Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project and creating a new merge driver configuration file in the `.git/config` of the project.
+Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project, creating a new merge driver configuration in the `.git/config` of the project, and installing the binary in the node_modules/.bin directory.
# examples
diff --git a/messages/uninstall.md b/messages/uninstall.md
index 84ba234..54feb9f 100644
--- a/messages/uninstall.md
+++ b/messages/uninstall.md
@@ -4,7 +4,7 @@ Uninstalls the local git merge driver for the given org and branch.
# description
-Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` files in the project and deleting the merge driver configuration file in the `.git/config` of the project.
+Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` files in the project, deleting the merge driver configuration from the `.git/config` of the project, and removing the installed binary from the node_modules/.bin directory.
# examples
From a0caae90441f8e27c75ae64a0e2bcadff6f44ff5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 7 Mar 2025 22:46:04 +0100
Subject: [PATCH 11/55] feat: add driver run command
---
README.md | 39 +++++++++++++
jest.config.js | 21 ++-----
knip.config.ts | 15 ++---
messages/run.md | 36 ++++++++++++
package-lock.json | 30 +++-------
package.json | 6 +-
src/commands/git/merge/driver/run.ts | 51 +++++++++++++++++
src/constant/driverConstant.ts | 1 +
src/index.ts | 17 ------
src/service/installService.ts | 17 +-----
src/service/uninstallService.ts | 12 +---
test/integration/install.nut.ts | 14 +++--
test/integration/run.nut.ts | 64 ++++++++++++++++++++++
test/integration/uninstall.nut.ts | 22 +++-----
test/unit/service/InstallService.test.ts | 27 ++-------
test/unit/service/UninstallService.test.ts | 8 +--
16 files changed, 237 insertions(+), 143 deletions(-)
create mode 100644 messages/run.md
create mode 100644 src/commands/git/merge/driver/run.ts
delete mode 100644 src/index.ts
create mode 100644 test/integration/run.nut.ts
diff --git a/README.md b/README.md
index 1dcc9a7..9481b46 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ sf plugins install sf-git-merge-driver
<!-- commands -->
* [`sf git merge driver install`](#sf-git-merge-driver-install)
+* [`sf git merge driver run`](#sf-git-merge-driver-run)
* [`sf git merge driver uninstall`](#sf-git-merge-driver-uninstall)
## `sf git merge driver install`
@@ -48,6 +49,44 @@ EXAMPLES
_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/install.ts)_
+## `sf git merge driver run`
+
+Runs the merge driver for the specified files.
+
+```
+USAGE
+ $ sf git merge driver run -a <value> -o <value> -t <value> -p <value> [--json] [--flags-dir <value>]
+
+FLAGS
+ -a, --ancestor-file=<value> (required) path to the common ancestor version of the file
+ -o, --our-file=<value> (required) path to our version of the file
+ -p, --output-file=<value> (required) path to the file where the merged content will be written
+ -t, --theirs-file=<value> (required) path to their version of the file
+
+GLOBAL FLAGS
+ --flags-dir=<value> Import flag values from a directory.
+ --json Format output as json.
+
+DESCRIPTION
+ Runs the merge driver for the specified files.
+
+ Runs the merge driver for the specified files, handling the merge conflict resolution using Salesforce-specific merge
+ strategies. This command is typically called automatically by Git when a merge conflict is detected.
+
+EXAMPLES
+ Run the merge driver for conflicting files:
+
+ $ sf git merge driver run --ancestor-file=<value> --our-file=<value> --theirs-file=<value> --output-file=<value>
+
+ Where:
+ - ancestor-file is the path to the common ancestor version of the file
+ - our-file is the path to our version of the file
+ - their-file is the path to their version of the file
+ - output-file is the path to the file where the merged content will be written
+```
+
+_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/run.ts)_
+
## `sf git merge driver uninstall`
Uninstalls the local git merge driver for the given org and branch.
diff --git a/jest.config.js b/jest.config.js
index 3fe4768..5c662e1 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -72,23 +72,12 @@ export default {
// A map from regular expressions to paths to transformers
transform: {
- '\\.ts$': ['ts-jest', {
- diagnostics: {
- ignoreCodes: [1343]
+ '\\.ts$': [
+ 'ts-jest',
+ {
+ tsconfig: './tsconfig.json',
},
- astTransformers: {
- before: [
- {
- path: 'ts-jest-mock-import-meta',
- options: {
- metaObjectReplacement: {
- url: 'file:///mock/test'
- }
- }
- }
- ]
- },
- tsconfig: './tsconfig.json' }],
+ ],
},
extensionsToTreatAsEsm: ['.ts'],
// A map from regular expressions to module names that allow to stub out resources with a single module
diff --git a/knip.config.ts b/knip.config.ts
index af5e24b..ab0b192 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -1,18 +1,15 @@
export default {
packageManager: 'npm',
entry: [
- 'src/commands/git/merge/driver/install.ts',
- 'src/commands/git/merge/driver/uninstall.ts',
+ '.github/**/*.yml',
+ '**/*.{nut,test}.ts',
'bin/dev.js',
'bin/run.js',
- '**/*.{nut,test}.ts',
- '.github/**/*.yml',
+ 'src/commands/git/merge/driver/install.ts',
+ 'src/commands/git/merge/driver/run.ts',
+ 'src/commands/git/merge/driver/uninstall.ts',
],
project: ['**/*.{ts,js,json,yml}', '!src/index.ts'],
- ignoreDependencies: [
- '@commitlint/config-conventional',
- 'ts-jest-mock-import-meta',
- 'ts-node',
- ],
+ ignoreDependencies: ['@commitlint/config-conventional', 'ts-node'],
ignoreBinaries: ['commitlint', 'npm-check-updates'],
}
diff --git a/messages/run.md b/messages/run.md
new file mode 100644
index 0000000..06ce724
--- /dev/null
+++ b/messages/run.md
@@ -0,0 +1,36 @@
+# summary
+
+Runs the merge driver for the specified files.
+
+# description
+
+Runs the merge driver for the specified files, handling the merge conflict resolution using Salesforce-specific merge strategies. This command is typically called automatically by Git when a merge conflict is detected.
+
+# examples
+
+- Run the merge driver for conflicting files:
+
+ <%= config.bin %> <%= command.id %> --ancestor-file=<value> --our-file=<value> --theirs-file=<value> --output-file=<value>
+
+- Where:
+ - ancestor-file is the path to the common ancestor version of the file
+ - our-file is the path to our version of the file
+ - their-file is the path to their version of the file
+ - output-file is the path to the file where the merged content will be written
+
+# flags.ancestor-file.summary
+
+path to the common ancestor version of the file
+
+# flags.our-file.summary
+
+path to our version of the file
+
+# flags.theirs-file.summary
+
+path to their version of the file
+
+# flags.output-file.summary
+
+path to the file where the merged content will be written
+
diff --git a/package-lock.json b/package-lock.json
index aa8a320..3821a31 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -15,12 +15,9 @@
"fast-xml-parser": "^5.0.8",
"simple-git": "^3.27.0"
},
- "bin": {
- "sf-git-merge-driver": "lib/index.js"
- },
"devDependencies": {
"@biomejs/biome": "1.9.4",
- "@commitlint/config-conventional": "^19.7.1",
+ "@commitlint/config-conventional": "^19.8.0",
"@oclif/plugin-help": "^6.2.26",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
@@ -35,7 +32,6 @@
"oclif": "^4.17.34",
"shx": "^0.3.4",
"ts-jest": "^29.2.6",
- "ts-jest-mock-import-meta": "^1.2.1",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typescript": "^5.8.2",
@@ -1741,13 +1737,13 @@
}
},
"node_modules/@commitlint/config-conventional": {
- "version": "19.7.1",
- "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.7.1.tgz",
- "integrity": "sha512-fsEIF8zgiI/FIWSnykdQNj/0JE4av08MudLTyYHm4FlLWemKoQvPNUYU2M/3tktWcCEyq7aOkDDgtjrmgWFbvg==",
+ "version": "19.8.0",
+ "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.8.0.tgz",
+ "integrity": "sha512-9I2kKJwcAPwMoAj38hwqFXG0CzS2Kj+SAByPUQ0SlHTfb7VUhYVmo7G2w2tBrqmOf7PFd6MpZ/a1GQJo8na8kw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@commitlint/types": "^19.5.0",
+ "@commitlint/types": "^19.8.0",
"conventional-changelog-conventionalcommits": "^7.0.2"
},
"engines": {
@@ -1755,9 +1751,9 @@
}
},
"node_modules/@commitlint/types": {
- "version": "19.5.0",
- "resolved": "https://registry.npmjs.org/@commitlint/types/-/types-19.5.0.tgz",
- "integrity": "sha512-DSHae2obMSMkAtTBSOulg5X7/z+rGLxcXQIkg3OmWvY6wifojge5uVMydfhUvs7yQj+V7jNmRZ2Xzl8GJyqRgg==",
+ "version": "19.8.0",
+ "resolved": "https://registry.npmjs.org/@commitlint/types/-/types-19.8.0.tgz",
+ "integrity": "sha512-LRjP623jPyf3Poyfb0ohMj8I3ORyBDOwXAgxxVPbSD0unJuW2mJWeiRfaQinjtccMqC5Wy1HOMfa4btKjbNxbg==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -13364,16 +13360,6 @@
}
}
},
- "node_modules/ts-jest-mock-import-meta": {
- "version": "1.2.1",
- "resolved": "https://registry.npmjs.org/ts-jest-mock-import-meta/-/ts-jest-mock-import-meta-1.2.1.tgz",
- "integrity": "sha512-+qh8ZijpFnh7nMNdw1yYrvmnhe3Rctau5a3AFtgBAtps46RSiC8SHr3Z0S9sNqCU3cNOGumCAVO7Ac65fstxRA==",
- "dev": true,
- "license": "MIT",
- "peerDependencies": {
- "ts-jest": ">=20.0.0"
- }
- },
"node_modules/ts-node": {
"version": "10.9.2",
"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
diff --git a/package.json b/package.json
index 9a0e3de..ad135c0 100644
--- a/package.json
+++ b/package.json
@@ -3,9 +3,6 @@
"description": "git remote add origin git@github.com:scolladon/sf-git-merge-driver.git",
"version": "1.0.0",
"exports": "./lib/driver/MergeDriver.js",
- "bin": {
- "sf-git-merge-driver": "./lib/index.js"
- },
"type": "module",
"author": "Sébastien Colladon (colladonsebastien@gmail.com)",
"repository": {
@@ -21,7 +18,7 @@
},
"devDependencies": {
"@biomejs/biome": "1.9.4",
- "@commitlint/config-conventional": "^19.7.1",
+ "@commitlint/config-conventional": "^19.8.0",
"@oclif/plugin-help": "^6.2.26",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
@@ -36,7 +33,6 @@
"oclif": "^4.17.34",
"shx": "^0.3.4",
"ts-jest": "^29.2.6",
- "ts-jest-mock-import-meta": "^1.2.1",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typescript": "^5.8.2",
diff --git a/src/commands/git/merge/driver/run.ts b/src/commands/git/merge/driver/run.ts
new file mode 100644
index 0000000..2701c9d
--- /dev/null
+++ b/src/commands/git/merge/driver/run.ts
@@ -0,0 +1,51 @@
+import { Messages } from '@salesforce/core'
+import { Flags, SfCommand } from '@salesforce/sf-plugins-core'
+import { MergeDriver } from '../../../../driver/MergeDriver.js'
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+const messages = Messages.loadMessages('sf-git-merge-driver', 'run')
+
+export default class Run extends SfCommand<void> {
+ public static override readonly summary = messages.getMessage('summary')
+ public static override readonly description =
+ messages.getMessage('description')
+ public static override readonly examples = messages.getMessages('examples')
+
+ public static override readonly flags = {
+ 'ancestor-file': Flags.string({
+ char: 'a',
+ summary: messages.getMessage('flags.ancestor-file.summary'),
+ required: true,
+ exists: true,
+ }),
+ 'our-file': Flags.string({
+ char: 'o',
+ summary: messages.getMessage('flags.our-file.summary'),
+ required: true,
+ exists: true,
+ }),
+ 'theirs-file': Flags.string({
+ char: 't',
+ summary: messages.getMessage('flags.theirs-file.summary'),
+ required: true,
+ exists: true,
+ }),
+ 'output-file': Flags.string({
+ char: 'p',
+ summary: messages.getMessage('flags.output-file.summary'),
+ required: true,
+ exists: true,
+ }),
+ }
+
+ public async run(): Promise<void> {
+ const { flags } = await this.parse(Run)
+ const mergeDriver = new MergeDriver()
+ await mergeDriver.mergeFiles(
+ flags['ancestor-file'],
+ flags['our-file'],
+ flags['theirs-file'],
+ flags['output-file']
+ )
+ }
+}
diff --git a/src/constant/driverConstant.ts b/src/constant/driverConstant.ts
index af8d29f..0b51a5e 100644
--- a/src/constant/driverConstant.ts
+++ b/src/constant/driverConstant.ts
@@ -1 +1,2 @@
export const DRIVER_NAME = 'salesforce-source'
+export const RUN_PLUGIN_COMMAND = 'sf git merge driver run'
diff --git a/src/index.ts b/src/index.ts
deleted file mode 100644
index 30fc77e..0000000
--- a/src/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-#!/usr/bin/env -S NODE_OPTIONS="--no-warnings=ExperimentalWarning" npx ts-node --project tsconfig.json --esm
-import { MergeDriver } from './driver/MergeDriver.js'
-
-if (process.argv.length >= 6) {
- const [, , ancestorFile, ourFile, theirFile, outputFile] = process.argv
- const mergeDriver = new MergeDriver()
- mergeDriver
- .mergeFiles(ancestorFile, ourFile, theirFile, outputFile)
- .then(() => process.exit(0))
-} else {
- console.error('Usage: sf-git-merge-driver %O %A %B %P')
- console.error(' %O: ancestor file')
- console.error(' %A: our file')
- console.error(' %B: their file')
- console.error(' %P: output file path')
- process.exit(1)
-}
diff --git a/src/service/installService.ts b/src/service/installService.ts
index 18faf51..26ada23 100644
--- a/src/service/installService.ts
+++ b/src/service/installService.ts
@@ -1,20 +1,9 @@
-import { appendFile, chmod, copyFile, mkdir } from 'node:fs/promises'
-import { join } from 'node:path'
-import { fileURLToPath } from 'node:url'
+import { appendFile } from 'node:fs/promises'
import { simpleGit } from 'simple-git'
-import { DRIVER_NAME } from '../constant/driverConstant.js'
-
-const currentDir = fileURLToPath(new URL('.', import.meta.url))
-const libIndexPath = join(currentDir, '../../lib/index.js')
-const binaryPath = 'node_modules/.bin'
-const localBinPath = `${binaryPath}/sf-git-merge-driver`
+import { DRIVER_NAME, RUN_PLUGIN_COMMAND } from '../constant/driverConstant.js'
export class InstallService {
public async installMergeDriver() {
- await mkdir(binaryPath, { recursive: true })
- await copyFile(libIndexPath, localBinPath)
- await chmod(localBinPath, 0o755)
-
const git = simpleGit()
await git.addConfig(
`merge.${DRIVER_NAME}.name`,
@@ -22,7 +11,7 @@ export class InstallService {
)
await git.addConfig(
`merge.${DRIVER_NAME}.driver`,
- `${localBinPath} %O %A %B %P`
+ `${RUN_PLUGIN_COMMAND} --ancestor-file %O --our-file %A --theirs-file %B --output-file %P`
)
await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true')
diff --git a/src/service/uninstallService.ts b/src/service/uninstallService.ts
index 065edc1..768d35a 100644
--- a/src/service/uninstallService.ts
+++ b/src/service/uninstallService.ts
@@ -1,21 +1,11 @@
-import { readFile, unlink, writeFile } from 'node:fs/promises'
-import { join } from 'node:path'
+import { readFile, writeFile } from 'node:fs/promises'
import { simpleGit } from 'simple-git'
import { DRIVER_NAME } from '../constant/driverConstant.js'
const MERGE_DRIVER_CONFIG = new RegExp(`.* merge\\s*=\\s*${DRIVER_NAME}$`)
-const localBinPath = join(
- process.cwd(),
- 'node_modules/.bin/sf-git-merge-driver'
-)
export class UninstallService {
public async uninstallMergeDriver() {
- try {
- await unlink(localBinPath)
- // biome-ignore lint/suspicious/noEmptyBlockStatements: <explanation>
- } catch {}
-
const git = simpleGit()
try {
await git.raw(['config', '--remove-section', `merge.${DRIVER_NAME}`])
diff --git a/test/integration/install.nut.ts b/test/integration/install.nut.ts
index dc45b2e..f52a91a 100644
--- a/test/integration/install.nut.ts
+++ b/test/integration/install.nut.ts
@@ -4,10 +4,12 @@ import { join } from 'node:path'
import { execCmd } from '@salesforce/cli-plugins-testkit'
import { expect } from 'chai'
import { after, before, describe, it } from 'mocha'
-import { DRIVER_NAME } from '../../src/constant/driverConstant.js'
+import {
+ DRIVER_NAME,
+ RUN_PLUGIN_COMMAND,
+} from '../../src/constant/driverConstant.js'
const ROOT_FOLDER = './test/data'
-const binaryPath = 'node_modules/.bin/sf-git-merge-driver'
describe('git merge driver install', () => {
before(() => {
@@ -46,7 +48,7 @@ describe('git merge driver install', () => {
expect(existsSync(gitattributesPath)).to.be.true
const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
- expect(gitattributesContent).to.include('*.xml merge=salesforce-source')
+ expect(gitattributesContent).to.include(`*.xml merge=${DRIVER_NAME}`)
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
@@ -55,7 +57,7 @@ describe('git merge driver install', () => {
`merge.${DRIVER_NAME}.name=Salesforce source merge driver`
)
expect(gitConfigOutput).to.include(
- `merge.${DRIVER_NAME}.driver=${binaryPath} %O %A %B %P`
+ `merge.${DRIVER_NAME}.driver=${RUN_PLUGIN_COMMAND} --ancestor-file %O --our-file %A --theirs-file %B --output-file %P`
)
expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive=true`)
})
@@ -75,7 +77,7 @@ describe('git merge driver install', () => {
expect(existsSync(gitattributesPath)).to.be.true
const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
- expect(gitattributesContent).to.include('*.xml merge=salesforce-source')
+ expect(gitattributesContent).to.include(`*.xml merge=${DRIVER_NAME}`)
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
@@ -84,7 +86,7 @@ describe('git merge driver install', () => {
`merge.${DRIVER_NAME}.name=Salesforce source merge driver`
)
expect(gitConfigOutput).to.include(
- `merge.${DRIVER_NAME}.driver=${binaryPath} %O %A %B %P`
+ `merge.${DRIVER_NAME}.driver=${RUN_PLUGIN_COMMAND} --ancestor-file %O --our-file %A --theirs-file %B --output-file %P`
)
expect(gitConfigOutput).to.include(`merge.${DRIVER_NAME}.recursive=true`)
})
diff --git a/test/integration/run.nut.ts b/test/integration/run.nut.ts
new file mode 100644
index 0000000..2a1c097
--- /dev/null
+++ b/test/integration/run.nut.ts
@@ -0,0 +1,64 @@
+import {
+ existsSync,
+ mkdirSync,
+ readFileSync,
+ rmSync,
+ writeFileSync,
+} from 'node:fs'
+import { join } from 'node:path'
+import { execCmd } from '@salesforce/cli-plugins-testkit'
+import { expect } from 'chai'
+import { after, before, describe, it } from 'mocha'
+
+const ROOT_FOLDER = './test/data'
+const TEST_FILES_FOLDER = 'testFiles'
+
+describe('git merge driver run', () => {
+ before(() => {
+ // Arrange
+ mkdirSync(join(ROOT_FOLDER, TEST_FILES_FOLDER), { recursive: true })
+ const ancestorContent = '<root>\n <item>common</item>\n</root>'
+ const ourContent = '<root>\n <item>our change</item>\n</root>'
+ const theirContent = '<root>\n <item>their change</item>\n</root>'
+
+ writeFileSync(
+ join(ROOT_FOLDER, TEST_FILES_FOLDER, 'ancestor.xml'),
+ ancestorContent
+ )
+ writeFileSync(join(ROOT_FOLDER, TEST_FILES_FOLDER, 'ours.xml'), ourContent)
+ writeFileSync(
+ join(ROOT_FOLDER, TEST_FILES_FOLDER, 'theirs.xml'),
+ theirContent
+ )
+ writeFileSync(join(ROOT_FOLDER, TEST_FILES_FOLDER, 'output.xml'), '')
+ })
+
+ after(() => {
+ // Clean up test files
+ rmSync(join(ROOT_FOLDER, TEST_FILES_FOLDER), { recursive: true })
+ })
+
+ it('merges XML files correctly', () => {
+ // Act
+ execCmd(
+ `git merge driver run --ancestor-file ${join(TEST_FILES_FOLDER, 'ancestor.xml')} --our-file ${join(TEST_FILES_FOLDER, 'ours.xml')} --theirs-file ${join(TEST_FILES_FOLDER, 'theirs.xml')} --output-file ${join(TEST_FILES_FOLDER, 'output.xml')}`,
+ {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ }
+ )
+
+ // Assert
+ const outputPath = join(ROOT_FOLDER, TEST_FILES_FOLDER, 'output.xml')
+ expect(existsSync(outputPath)).to.be.true
+
+ const outputContent = readFileSync(outputPath, 'utf-8')
+ expect(outputContent).to.include('<root>')
+ expect(outputContent).to.include('</root>')
+ /*
+ expect(outputContent).to.include('our change')
+ expect(outputContent).to.include('their change')
+ expect(outputContent).to.include('common')
+ */
+ })
+})
diff --git a/test/integration/uninstall.nut.ts b/test/integration/uninstall.nut.ts
index ea37896..acda829 100644
--- a/test/integration/uninstall.nut.ts
+++ b/test/integration/uninstall.nut.ts
@@ -1,14 +1,12 @@
import { execSync } from 'node:child_process'
import { existsSync, readFileSync } from 'node:fs'
-import { dirname, join } from 'node:path'
-import { fileURLToPath } from 'node:url'
+import { join } from 'node:path'
import { execCmd } from '@salesforce/cli-plugins-testkit'
import { expect } from 'chai'
import { after, before, describe, it } from 'mocha'
import { DRIVER_NAME } from '../../src/constant/driverConstant.js'
-const __dirname = dirname(fileURLToPath(import.meta.url))
-const ROOT_FOLDER = join(__dirname, '../data')
+const ROOT_FOLDER = './test/data'
describe('git merge driver uninstall', () => {
before(() => {
@@ -23,12 +21,9 @@ describe('git merge driver uninstall', () => {
cwd: ROOT_FOLDER,
})
- const gitattributesPath = join(ROOT_FOLDER, '.gitattributes')
- if (existsSync(gitattributesPath)) {
- execSync(`rm ${gitattributesPath}`, {
- cwd: ROOT_FOLDER,
- })
- }
+ execSync('rm .gitattributes', {
+ cwd: ROOT_FOLDER,
+ })
})
it('uninstalls merge driver correctly', () => {
@@ -49,7 +44,7 @@ describe('git merge driver uninstall', () => {
expect(existsSync(gitattributesPath)).to.be.true
const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
- expect(gitattributesContent).not.to.include('*.xml merge=salesforce-source')
+ expect(gitattributesContent).not.to.include(`*.xml merge=${DRIVER_NAME}`)
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
@@ -60,9 +55,6 @@ describe('git merge driver uninstall', () => {
})
it('uninstalls does nothing when not installed', () => {
- // Arrange
- // No setup needed as we're testing the case where nothing is installed
-
// Act
execCmd('git merge driver uninstall', {
ensureExitCode: 0,
@@ -74,7 +66,7 @@ describe('git merge driver uninstall', () => {
expect(existsSync(gitattributesPath)).to.be.true
const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
- expect(gitattributesContent).not.to.include('*.xml merge=salesforce-source')
+ expect(gitattributesContent).not.to.include(`*.xml merge=${DRIVER_NAME}`)
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
diff --git a/test/unit/service/InstallService.test.ts b/test/unit/service/InstallService.test.ts
index bf30fbd..48583d0 100644
--- a/test/unit/service/InstallService.test.ts
+++ b/test/unit/service/InstallService.test.ts
@@ -1,6 +1,9 @@
-import { appendFile, chmod, copyFile, mkdir } from 'node:fs/promises'
+import { appendFile } from 'node:fs/promises'
import simpleGit from 'simple-git'
-import { DRIVER_NAME } from '../../../src/constant/driverConstant.js'
+import {
+ DRIVER_NAME,
+ RUN_PLUGIN_COMMAND,
+} from '../../../src/constant/driverConstant.js'
import { InstallService } from '../../../src/service/installService.js'
jest.mock('node:fs/promises')
@@ -13,9 +16,6 @@ simpleGitMock.mockReturnValue({
})
const appendFileMocked = jest.mocked(appendFile)
-const chmodMocked = jest.mocked(chmod)
-const copyFileMocked = jest.mocked(copyFile)
-const mkdirMocked = jest.mocked(mkdir)
describe('InstallService', () => {
let sut: InstallService // System Under Test
@@ -39,7 +39,7 @@ describe('InstallService', () => {
)
expect(mockedAddConfig).toHaveBeenCalledWith(
`merge.${DRIVER_NAME}.driver`,
- 'node_modules/.bin/sf-git-merge-driver %O %A %B %P'
+ `${RUN_PLUGIN_COMMAND} --ancestor-file %O --our-file %A --theirs-file %B --output-file %P`
)
expect(mockedAddConfig).toHaveBeenCalledWith(
`merge.${DRIVER_NAME}.recursive`,
@@ -51,20 +51,5 @@ describe('InstallService', () => {
'*.xml merge=salesforce-source\n',
{ flag: 'a' }
)
- expect(chmodMocked).toHaveBeenCalledTimes(1)
- expect(chmodMocked).toHaveBeenCalledWith(
- 'node_modules/.bin/sf-git-merge-driver',
- 0o755
- )
- expect(copyFileMocked).toHaveBeenCalledTimes(1)
- expect(copyFileMocked).toHaveBeenCalledWith(
- expect.stringContaining('lib/index.js'),
- expect.stringContaining('node_modules/.bin/sf-git-merge-driver')
- )
- expect(mkdirMocked).toHaveBeenCalledTimes(1)
- expect(mkdirMocked).toHaveBeenCalledWith(
- expect.stringContaining('node_modules/.bin'),
- { recursive: true }
- )
})
})
diff --git a/test/unit/service/UninstallService.test.ts b/test/unit/service/UninstallService.test.ts
index 841f86f..afbed35 100644
--- a/test/unit/service/UninstallService.test.ts
+++ b/test/unit/service/UninstallService.test.ts
@@ -1,4 +1,4 @@
-import { readFile, unlink, writeFile } from 'node:fs/promises'
+import { readFile, writeFile } from 'node:fs/promises'
import simpleGit from 'simple-git'
import { DRIVER_NAME } from '../../../src/constant/driverConstant.js'
import { UninstallService } from '../../../src/service/uninstallService.js'
@@ -16,8 +16,6 @@ readFileMocked.mockResolvedValue(
'*.xml merge=salesforce-source\nsome other content'
)
-const unlinkMocked = jest.mocked(unlink)
-
describe('UninstallService', () => {
let sut: UninstallService // System Under Test
@@ -40,9 +38,5 @@ describe('UninstallService', () => {
expect(readFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
expect(writeFile).toHaveBeenCalledTimes(1)
expect(writeFile).toHaveBeenCalledWith('.gitattributes', expect.anything())
- expect(unlinkMocked).toHaveBeenCalledTimes(1)
- expect(unlinkMocked).toHaveBeenCalledWith(
- expect.stringContaining('node_modules/.bin/sf-git-merge-driver')
- )
})
})
From c0ffdd30ce5729f3a156e833568074295d8cb5a1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 7 Mar 2025 23:04:29 +0100
Subject: [PATCH 12/55] fix: linting issues
---
.github/linters/.cspell.json | 1 +
.jscpd.json | 15 +++++++--------
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/.github/linters/.cspell.json b/.github/linters/.cspell.json
index 6c2e3b2..f6abe03 100644
--- a/.github/linters/.cspell.json
+++ b/.github/linters/.cspell.json
@@ -17,6 +17,7 @@
"brqh",
"codeowners",
"colladon",
+ "commandsstop",
"commitlint",
"gossent",
"instantiator",
diff --git a/.jscpd.json b/.jscpd.json
index 363d9f1..217b629 100644
--- a/.jscpd.json
+++ b/.jscpd.json
@@ -2,13 +2,12 @@
"threshold": 0,
"reporters": ["html", "markdown"],
"ignore": [
- "**/node_modules/**",
- "**/.git/**",
- "**/*cache*/**",
- "**/.github/**",
- "**/report/**",
- "**/img/**",
- "**/__tests__/**",
- "**/*.md"
+ ".git/**",
+ ".github/**",
+ "**/*.md",
+ "node_modules/**",
+ "reports/**",
+ "src/commands/**",
+ "test/**"
]
}
From 3648edea3707d99901f8eebe85fb4ae2a6955256 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Mon, 10 Mar 2025 18:20:31 +0100
Subject: [PATCH 13/55] fix: parser and builder configuration
---
src/driver/MergeDriver.ts | 2 +-
src/merger/XmlMerger.ts | 42 +++++++++++++-------
test/unit/driver/MergeDriver.test.ts | 8 ++--
test/unit/merger/XmlMerger.test.ts | 59 ++++++++++++++++++++++++----
4 files changed, 83 insertions(+), 28 deletions(-)
diff --git a/src/driver/MergeDriver.ts b/src/driver/MergeDriver.ts
index 208c1fd..872fda3 100644
--- a/src/driver/MergeDriver.ts
+++ b/src/driver/MergeDriver.ts
@@ -12,7 +12,7 @@ export class MergeDriver {
const xmlMerger = new XmlMerger()
- const mergedContent = await xmlMerger.tripartXmlMerge(
+ const mergedContent = xmlMerger.tripartXmlMerge(
ancestorContent,
ourContent,
theirContent
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 58155b9..15bad14 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -1,28 +1,40 @@
import { XMLBuilder, XMLParser } from 'fast-xml-parser'
import { JsonMerger } from './JsonMerger.js'
-const options = {
- attributeNamePrefix: '@_',
- commentPropName: '#comment',
- format: true,
+const XML_DECL = '<?xml version="1.0" encoding="UTF-8"?>\n'
+const XML_COMMENT_PROP_NAME = '#xml__comment'
+
+const parserOptions = {
ignoreAttributes: false,
- ignoreNameSpace: false,
- indentBy: ' ',
- parseAttributeValue: false,
- parseNodeValue: false,
parseTagValue: false,
- processEntities: false,
- suppressEmptyNode: false,
- trimValues: true,
+ parseAttributeValue: false,
+ cdataPropName: '__cdata',
+ ignoreDeclaration: true,
+ numberParseOptions: { leadingZeros: false, hex: false },
+ commentPropName: XML_COMMENT_PROP_NAME,
+}
+
+const builderOptions = {
+ format: true,
+ indentBy: ' ',
+ ignoreAttributes: false,
+ cdataPropName: '__cdata',
+ commentPropName: XML_COMMENT_PROP_NAME,
}
+const correctComments = (xml: string): string =>
+ xml.includes('<!--') ? xml.replace(/\s+<!--(.*?)-->\s+/g, '<!--$1-->') : xml
+
+const handleSpecialEntities = (xml: string): string =>
+ xml.replaceAll('&#160;', ' ')
+
export class XmlMerger {
- async tripartXmlMerge(
+ tripartXmlMerge(
ancestorContent: string,
ourContent: string,
theirContent: string
) {
- const parser = new XMLParser(options)
+ const parser = new XMLParser(parserOptions)
const ancestorObj = parser.parse(ancestorContent)
const ourObj = parser.parse(ourContent)
@@ -34,8 +46,8 @@ export class XmlMerger {
const mergedObj = jsonMerger.mergeObjects(ancestorObj, ourObj, theirObj)
// Convert back to XML and format
- const builder = new XMLBuilder(options)
+ const builder = new XMLBuilder(builderOptions)
const mergedXml = builder.build(mergedObj)
- return mergedXml
+ return correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
}
}
diff --git a/test/unit/driver/MergeDriver.test.ts b/test/unit/driver/MergeDriver.test.ts
index f10066a..10c5f84 100644
--- a/test/unit/driver/MergeDriver.test.ts
+++ b/test/unit/driver/MergeDriver.test.ts
@@ -25,7 +25,7 @@ describe('MergeDriver', () => {
it('should merge files successfully when given valid parameters', async () => {
// Arrange
mockReadFile.mockResolvedValue('<label>Test Object</label>')
- mockedTripartXmlMerge.mockResolvedValue('<label>Test Object</label>')
+ mockedTripartXmlMerge.mockReturnValue('<label>Test Object</label>')
// Act
await sut.mergeFiles('AncestorFile', 'OurFile', 'TheirFile', 'OutputFile')
@@ -39,9 +39,9 @@ describe('MergeDriver', () => {
it('should throw an error when tripartXmlMerge fails', async () => {
// Arrange
mockReadFile.mockResolvedValue('<label>Test Object</label>')
- mockedTripartXmlMerge.mockRejectedValue(
- new Error('Tripart XML merge failed')
- )
+ mockedTripartXmlMerge.mockImplementation(() => {
+ throw new Error('Tripart XML merge failed')
+ })
// Act and Assert
await expect(
diff --git a/test/unit/merger/XmlMerger.test.ts b/test/unit/merger/XmlMerger.test.ts
index 2f42c30..6afe24e 100644
--- a/test/unit/merger/XmlMerger.test.ts
+++ b/test/unit/merger/XmlMerger.test.ts
@@ -36,9 +36,12 @@ describe('MergeDriver', () => {
})
describe('tripartXmlMerge', () => {
- it('should merge files successfully when given valid parameters', async () => {
+ it('should merge files successfully when given valid parameters', () => {
+ // Arrange
+ mockedMergeObjects.mockReturnValue('MergedContent')
+
// Act
- await sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
+ sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
// Assert
expect(XMLParser).toHaveBeenCalledTimes(1)
@@ -46,16 +49,56 @@ describe('MergeDriver', () => {
expect(JsonMerger).toHaveBeenCalledTimes(1)
})
- it('should throw an error when tripartXmlMerge fails', async () => {
+ it('should throw an error when tripartXmlMerge fails', () => {
// Arrange
- mockedMergeObjects.mockRejectedValue(
- new Error('Tripart XML merge failed')
- )
+ mockedMergeObjects.mockImplementation(() => {
+ throw new Error('Tripart XML merge failed')
+ })
// Act and Assert
- await expect(
+ expect(() =>
sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
- ).rejects.toThrowError('Tripart XML merge failed')
+ ).toThrow('Tripart XML merge failed')
+ })
+ })
+
+ describe('handling special XML features', () => {
+ it('should correctly handle XML special entities', () => {
+ // Arrange
+ const ancestorWithSpecial = '<root><special></root>'
+ const ourWithSpecial = '<root><modified></root>'
+ const theirWithSpecial = '<root><special></root>'
+ mockedMergeObjects.mockReturnValue('<root><modified></root>')
+
+ // Act
+ const result = sut.tripartXmlMerge(
+ ancestorWithSpecial,
+ ourWithSpecial,
+ theirWithSpecial
+ )
+
+ // Assert
+ expect(result).toContain('<?xml version="1.0" encoding="UTF-8"?>')
+ expect(result).toContain('<modified>')
+ })
+
+ it('should correctly handle XML comments', () => {
+ // Arrange
+ const ancestorWithComment = '<root><!-- original comment --></root>'
+ const ourWithComment = '<root><!-- our comment --></root>'
+ const theirWithComment = '<root><!-- their comment --></root>'
+ mockedMergeObjects.mockReturnValue('<root><!-- merged comment --></root>')
+
+ // Act
+ const result = sut.tripartXmlMerge(
+ ancestorWithComment,
+ ourWithComment,
+ theirWithComment
+ )
+
+ // Assert
+ expect(result).toContain('<?xml version="1.0" encoding="UTF-8"?>')
+ expect(result).toContain('<!-- merged comment -->')
})
})
})
From 0195e6b36306496878a5a92d216c74f75e14c85a Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Tue, 11 Mar 2025 11:21:48 +0100
Subject: [PATCH 14/55] docs: adding TODO in jsonmerger test, export jsonvalue
type and use it in jsonmerger test
---
src/merger/JsonMerger.ts | 8 ++++++-
test/unit/merger/JsonMerger.test.ts | 36 +++++++++++++++++++++++++----
2 files changed, 38 insertions(+), 6 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 8a41c62..341d61a 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,4 +1,10 @@
-type JsonValue = string | number | boolean | null | JsonObject | JsonArray
+export type JsonValue =
+ | string
+ | number
+ | boolean
+ | null
+ | JsonObject
+ | JsonArray
interface JsonObject {
[key: string]: JsonValue
}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index e4a0efa..a78975c 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -1,4 +1,4 @@
-import { JsonMerger } from '../../../src/merger/JsonMerger.js'
+import { JsonMerger, JsonValue } from '../../../src/merger/JsonMerger.js'
describe('JsonMerger', () => {
let sut: JsonMerger
@@ -35,6 +35,12 @@ describe('JsonMerger', () => {
expect(sut.mergeObjects(undefined, null, 1)).toBe(1)
})
})
+
+ // TODO : Testing Conflict outputs
+ // still not sure if we should test conflict for primitives as it lacks a unique identifier
+ // maybe only throwing an error to treat the conflict at the parent node level
+ // (1,null,2) should output conflict with tags and each value with git conflict convention
+ // same for (1,2,null)
})
describe('given objects to merge', () => {
@@ -55,6 +61,12 @@ describe('JsonMerger', () => {
})
})
+ // TODO: Testing Conflict outputs
+ // { a: 1, b: 2 }{ a: 1, b: 3, c: 4 }{ a: 1, b: 6, d: 5 } should merge all but output conflict on b
+ // standard is <<<<<<< ours\n {ours version here} \n ||||||| base\n {base version here} \n =======\n {theirs version here} \n >>>>>>> theirs
+ // if base null or empty (node does not exist in base) we can put it as empty or remove the entire base part
+ // (I prefer always putting the 3 parts to make it clearer)
+
describe('when objects are nested', () => {
it('then should handle nested structures', () => {
// Arrange
@@ -69,6 +81,7 @@ describe('JsonMerger', () => {
})
})
+ // TODO: this one should output a conflict as the types are not compatible
describe('when type mismatches occur', () => {
it('then should prefer our version', () => {
// Arrange
@@ -111,6 +124,7 @@ describe('JsonMerger', () => {
})
})
+ // TODO: this one should output a conflict as there are 2 different diversions
describe('when arrays use different identifier fields', () => {
it('then should handle different identifiers', () => {
// Arrange
@@ -125,6 +139,9 @@ describe('JsonMerger', () => {
})
})
+ // TODO: I don't know if we should have such case ever
+ // if we actually do, I'd think the output should be [3,4,5]
+ // because ours removes 1 and adds 4 and theirs removes 1 & 2 and adds 4 & 5 which are compatible
describe('when arrays have no identifiers', () => {
it('then should use our version', () => {
// Arrange
@@ -142,19 +159,19 @@ describe('JsonMerger', () => {
describe('when merging custom field definitions', () => {
it('then should merge correctly', () => {
// Arrange
- const ancestor = {
+ const ancestor: JsonValue = {
fields: [
{ fullName: 'Field1__c', type: 'Text', length: 100 },
{ fullName: 'Field2__c', type: 'Number', precision: 10 },
],
}
- const ours = {
+ const ours: JsonValue = {
fields: [
{ fullName: 'Field1__c', type: 'Text', length: 255 },
{ fullName: 'Field2__c', type: 'Number', precision: 10 },
],
}
- const theirs = {
+ const theirs: JsonValue = {
fields: [
{ fullName: 'Field1__c', type: 'Text', length: 100 },
{ fullName: 'Field2__c', type: 'Number', precision: 18 },
@@ -173,6 +190,7 @@ describe('JsonMerger', () => {
})
})
+ // TODO: check but we shoud apply each change here as they are compatible (I added the Phone field in the expect)
describe('when merging layout metadata', () => {
it('then should merge layouts correctly', () => {
// Arrange
@@ -204,12 +222,20 @@ describe('JsonMerger', () => {
layoutSections: [
{
label: 'Information',
- layoutColumns: [{ fields: ['Name', 'Email'] }],
+ layoutColumns: [{ fields: ['Name', 'Email', 'Phone'] }],
},
{ label: 'System', layoutColumns: [{ fields: ['CreatedDate'] }] },
],
})
})
})
+
+ // TODO: Adding the different cases where the unique key is not the usual ones (those few types which have composite keys)
+
+ // TODO: Adding cases for the few for which the order of items in a list is important, like picklist values in a CustomField
+
+ // TODO: Adding conflict cases for Object element conflict
+
+ // TODO: Adding conflict cases for List element conflict
})
})
From 081f31d02cd9b7f01e8b4aff26e150fca0d6f880 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Tue, 11 Mar 2025 11:29:03 +0100
Subject: [PATCH 15/55] fix: removing the layout merge fix while it's not fixed
in code
---
test/unit/merger/JsonMerger.test.ts | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index a78975c..96f4946 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -190,7 +190,7 @@ describe('JsonMerger', () => {
})
})
- // TODO: check but we shoud apply each change here as they are compatible (I added the Phone field in the expect)
+ // TODO: check but we shoud apply each change here as they are compatible
describe('when merging layout metadata', () => {
it('then should merge layouts correctly', () => {
// Arrange
@@ -222,7 +222,7 @@ describe('JsonMerger', () => {
layoutSections: [
{
label: 'Information',
- layoutColumns: [{ fields: ['Name', 'Email', 'Phone'] }],
+ layoutColumns: [{ fields: ['Name', 'Email'] }],
},
{ label: 'System', layoutColumns: [{ fields: ['CreatedDate'] }] },
],
From a3dad92e799b1c900b9d5b865c0d80d2fb8f149d Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Tue, 11 Mar 2025 14:27:49 +0100
Subject: [PATCH 16/55] fix: upgrade dependency @oclif\core and megalinter
error
---
CHANGELOG.md | 0
lychee.toml | 2 +-
package-lock.json | 8 ++++----
3 files changed, 5 insertions(+), 5 deletions(-)
create mode 100644 CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..e69de29
diff --git a/lychee.toml b/lychee.toml
index 2c98335..f090da5 100644
--- a/lychee.toml
+++ b/lychee.toml
@@ -1,2 +1,2 @@
-exclude_mail = true
+# exclude_mail = true
exclude_path = ["CHANGELOG.md", "package-lock.json"]
diff --git a/package-lock.json b/package-lock.json
index 3821a31..42ad97a 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -3936,13 +3936,13 @@
}
},
"node_modules/@oclif/core": {
- "version": "4.2.8",
- "resolved": "https://registry.npmjs.org/@oclif/core/-/core-4.2.8.tgz",
- "integrity": "sha512-OWv4Va6bERxIhrYcnUGzyhGRqktc64lJO6cZ3UwkzJDpfR8ZrbCxRfKRBBah1i8kzUlOAeAXnpbMBMah3skKwA==",
+ "version": "4.2.9",
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-4.2.9.tgz",
+ "integrity": "sha512-cIlvpefLtorcyvnvJiOmYBqn6J6qdp/06tk54p2MddGEr0gnA7EIaQXM2UtRjf4ryDVCbIo+8IFRsW8Flt0uGA==",
"license": "MIT",
"dependencies": {
"ansi-escapes": "^4.3.2",
- "ansis": "^3.16.0",
+ "ansis": "^3.17.0",
"clean-stack": "^3.0.1",
"cli-spinners": "^2.9.2",
"debug": "^4.4.0",
From 346e1fe11bf1b7feeca97c6ffc73b003ceeeb048 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Tue, 11 Mar 2025 14:33:02 +0100
Subject: [PATCH 17/55] fix: readme urls
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 9481b46..abae422 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ EXAMPLES
$ sf git merge driver install
```
-_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/install.ts)_
+_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/install.ts)_
## `sf git merge driver run`
@@ -85,7 +85,7 @@ EXAMPLES
- output-file is the path to the file where the merged content will be written
```
-_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/run.ts)_
+_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/run.ts)_
## `sf git merge driver uninstall`
@@ -112,7 +112,7 @@ EXAMPLES
$ sf git merge driver uninstall
```
-_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/uninstall.ts)_
+_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/uninstall.ts)_
<!-- commandsstop -->
From 7c8e67adac70c2c4e836e3197a0b442bb4addf04 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Thu, 13 Mar 2025 15:19:48 +0100
Subject: [PATCH 18/55] revert: e66831bb75fe6b5798f13b4f365784b9e22d204d
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index abae422..9481b46 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ EXAMPLES
$ sf git merge driver install
```
-_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/install.ts)_
+_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/install.ts)_
## `sf git merge driver run`
@@ -85,7 +85,7 @@ EXAMPLES
- output-file is the path to the file where the merged content will be written
```
-_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/run.ts)_
+_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/run.ts)_
## `sf git merge driver uninstall`
@@ -112,7 +112,7 @@ EXAMPLES
$ sf git merge driver uninstall
```
-_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/uninstall.ts)_
+_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/uninstall.ts)_
<!-- commandsstop -->
From a69a768771a59f58f94ad5e5a40b5254d851441e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 14 Mar 2025 19:36:20 +0100
Subject: [PATCH 19/55] feat: improve merge algorithm
---
jest.config.js | 1 +
package-lock.json | 7 +
package.json | 1 +
src/constant/metadataConstant.ts | 68 +++++
src/merger/JsonMerger.ts | 294 ++++++++++++------
test/unit/merger/JsonMerger.test.ts | 443 +++++++++++++++-------------
6 files changed, 519 insertions(+), 295 deletions(-)
create mode 100644 src/constant/metadataConstant.ts
diff --git a/jest.config.js b/jest.config.js
index 5c662e1..4f97a47 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -83,6 +83,7 @@ export default {
// A map from regular expressions to module names that allow to stub out resources with a single module
moduleNameMapper: {
'(.+)\\.js': '$1',
+ '^lodash-es$': 'lodash', // FIXME: Huge workaround to allow compile lodash-es module when testing https://stackoverflow.com/a/54117206/1809659
},
// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
diff --git a/package-lock.json b/package-lock.json
index 42ad97a..98cfe40 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -13,6 +13,7 @@
"@salesforce/core": "^8.8.5",
"@salesforce/sf-plugins-core": "^12.2.0",
"fast-xml-parser": "^5.0.8",
+ "lodash-es": "^4.17.21",
"simple-git": "^3.27.0"
},
"devDependencies": {
@@ -10507,6 +10508,12 @@
"integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
"license": "MIT"
},
+ "node_modules/lodash-es": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz",
+ "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==",
+ "license": "MIT"
+ },
"node_modules/lodash.flattendeep": {
"version": "4.4.0",
"resolved": "https://registry.npmjs.org/lodash.flattendeep/-/lodash.flattendeep-4.4.0.tgz",
diff --git a/package.json b/package.json
index ad135c0..ab6a671 100644
--- a/package.json
+++ b/package.json
@@ -14,6 +14,7 @@
"@salesforce/core": "^8.8.5",
"@salesforce/sf-plugins-core": "^12.2.0",
"fast-xml-parser": "^5.0.8",
+ "lodash-es": "^4.17.21",
"simple-git": "^3.27.0"
},
"devDependencies": {
diff --git a/src/constant/metadataConstant.ts b/src/constant/metadataConstant.ts
new file mode 100644
index 0000000..a37e261
--- /dev/null
+++ b/src/constant/metadataConstant.ts
@@ -0,0 +1,68 @@
+export const KEY_FIELD_METADATA = {
+ marketingAppExtActivities: 'fullName',
+ alerts: 'fullName',
+ fieldUpdates: 'fullName',
+ flowActions: 'fullName',
+ outboundMessages: 'fullName',
+ rules: 'fullName',
+ knowledgePublishes: 'fullName',
+ tasks: 'fullName',
+ send: 'fullName',
+ sharingCriteriaRules: 'fullName',
+ sharingGuestRules: 'fullName',
+ sharingOwnerRules: 'fullName',
+ sharingTerritoryRules: 'fullName',
+ assignmentRule: 'fullName',
+ autoResponseRule: 'fullName',
+ escalationRule: 'fullName',
+ matchingRules: 'fullName',
+ valueTranslation: 'masterLabel',
+ categoryGroupVisibilities: 'dataCategoryGroup',
+ applicationVisibilities: 'application',
+ classAccesses: 'apexClass',
+ customMetadataTypeAccesses: 'name',
+ customPermissions: 'name',
+ customSettingAccesses: 'name',
+ externalDataSourceAccesses: 'externalDataSource',
+ fieldPermissions: 'field',
+ flowAccesses: 'flow',
+ loginFlows: 'friendlyname',
+ layoutAssignments: '<object>',
+ loginHours: '<array>',
+ loginIpRanges: '<array>',
+ objectPermissions: 'object',
+ pageAccesses: 'apexPage',
+ profileActionOverrides: 'actionName',
+ recordTypeVisibilities: 'recordType',
+ tabVisibilities: 'tab',
+ userPermissions: 'name',
+ bots: 'fullName',
+ customApplications: 'name',
+ customLabels: 'name',
+ customPageWebLinks: 'name',
+ customTabs: 'name',
+ flowDefinitions: 'fullName',
+ pipelineInspMetricConfigs: 'name',
+ prompts: 'name',
+ quickActions: 'name',
+ reportTypes: 'name',
+ scontrols: 'name',
+ standardValue: 'fullName',
+ customValue: 'fullName',
+ labels: 'fullName',
+}
+
+export const METADATA_TYPES_PATTERNS = [
+ 'assignmentRules',
+ 'autoResponseRules',
+ 'escalationRules',
+ 'globalValueSet',
+ 'globalValueSetTranslation',
+ 'marketingappextension',
+ 'matchingRule',
+ 'profile',
+ 'sharingRules',
+ 'standardValueSet',
+ 'standardValueSetTranslation',
+ 'workflow',
+]
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 341d61a..e60bb3e 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,3 +1,6 @@
+import { castArray, differenceWith, isEqual, unionWith } from 'lodash-es'
+import { KEY_FIELD_METADATA } from '../constant/metadataConstant.js'
+
export type JsonValue =
| string
| number
@@ -5,140 +8,241 @@ export type JsonValue =
| null
| JsonObject
| JsonArray
+
interface JsonObject {
[key: string]: JsonValue
}
+
interface JsonArray extends Array<JsonValue> {}
export class JsonMerger {
- private readonly idFields = [
- 'fullName',
- 'name',
- 'field',
- 'label',
- 'id',
- '@_name',
- ]
-
+ /**
+ * Main entry point for merging JSON values
+ */
mergeObjects(
ancestor: JsonValue | undefined,
ours: JsonValue,
theirs: JsonValue
): JsonValue {
- // Handle null/undefined cases
- if (ours === null || theirs === null) return ours ?? theirs
- if (typeof ours !== typeof theirs) return ours
-
- // Handle arrays (special case for Salesforce metadata)
- if (Array.isArray(ours) && Array.isArray(theirs)) {
- return this.mergeArrays(
- Array.isArray(ancestor) ? ancestor : undefined,
- ours,
- theirs
- )
+ // Handle root object (e.g., Profile)
+ if (
+ typeof ours === 'object' &&
+ ours !== null &&
+ !Array.isArray(ours) &&
+ typeof theirs === 'object' &&
+ theirs !== null &&
+ !Array.isArray(theirs)
+ ) {
+ // Get the base attribute (e.g., Profile)
+ const baseKey = Object.keys(ours)[0]
+ if (baseKey && Object.keys(theirs)[0] === baseKey) {
+ const result = { ...ours } as JsonObject
+
+ // Get the content of the base attribute
+ const ourContent = ours[baseKey] as JsonObject
+ const theirContent = theirs[baseKey] as JsonObject
+ const ancestorContent =
+ ancestor &&
+ typeof ancestor === 'object' &&
+ !Array.isArray(ancestor) &&
+ baseKey in ancestor
+ ? ((ancestor as JsonObject)[baseKey] as JsonObject)
+ : {}
+
+ // Get all properties from both contents
+ const allProperties = new Set([
+ ...Object.keys(ourContent),
+ ...Object.keys(theirContent),
+ ])
+
+ // Process each property
+ const mergedContent = { ...ourContent } as JsonObject
+ for (const property of allProperties) {
+ // Skip if property doesn't exist in their content
+ if (!(property in theirContent)) continue
+
+ // Use their version if property doesn't exist in our content
+ if (!(property in mergedContent)) {
+ mergedContent[property] = this.ensureArray(theirContent[property])
+ continue
+ }
+
+ // Ensure both values are arrays
+ const ourArray = this.ensureArray(mergedContent[property])
+ const theirArray = this.ensureArray(theirContent[property])
+ const ancestorArray =
+ property in ancestorContent
+ ? this.ensureArray(ancestorContent[property])
+ : []
+
+ // Get the key field for this property if available
+ const keyField = this.getKeyField(property)
+
+ // Merge the arrays
+ mergedContent[property] = this.mergeArrays(
+ ancestorArray,
+ ourArray,
+ theirArray,
+ keyField
+ )
+ }
+
+ result[baseKey] = mergedContent
+ return result
+ }
}
- // Handle objects
- if (typeof ours === 'object' && typeof theirs === 'object') {
- const result = { ...ours } as JsonObject
- const ancestorObj = (ancestor ?? {}) as JsonObject
- const theirsObj = theirs as JsonObject
+ // Default to our version for other cases
+ return ours
+ }
- // Process all keys from both objects
- const allKeys = new Set([...Object.keys(ours), ...Object.keys(theirs)])
+ /**
+ * Ensures a value is an array
+ */
+ private ensureArray(value: JsonValue): JsonArray {
+ return value === null ? [] : (castArray(value) as JsonArray)
+ }
- for (const key of allKeys) {
- if (!(key in theirsObj)) continue // Keep our version
- if (!(key in result)) {
- result[key] = theirsObj[key] // Take their version
- continue
- }
+ /**
+ * Gets the key field for a property from KEY_FIELD_METADATA
+ */
+ private getKeyField(property: string): string | undefined {
+ return property in KEY_FIELD_METADATA
+ ? KEY_FIELD_METADATA[property as keyof typeof KEY_FIELD_METADATA]
+ : undefined
+ }
- // Recursively merge when both have the key
- result[key] = this.mergeObjects(
- ancestorObj[key],
- result[key],
- theirsObj[key]
- )
- }
- return result
+ /**
+ * Merges arrays using the specified key field if available
+ */
+ private mergeArrays(
+ ancestor: JsonArray,
+ ours: JsonArray,
+ theirs: JsonArray,
+ keyField?: string
+ ): JsonArray {
+ // If no key field, use unionWith to merge arrays without duplicates
+ if (!keyField) {
+ return unionWith([...ours], theirs, isEqual)
+ }
+
+ // Special case for array position
+ if (keyField === '<array>') {
+ return this.mergeByPosition(ancestor, ours, theirs)
}
- // For primitive values, use their changes if we didn't modify from ancestor
- if (theirs !== ancestor && ours === ancestor) return theirs
- return ours // Default to our version
+ // Merge using key field
+ return this.mergeByKeyField(ancestor, ours, theirs, keyField)
}
- private mergeArrays(
- ancestor: JsonArray | undefined,
+ /**
+ * Merges arrays by position
+ */
+ private mergeByPosition(
+ ancestor: JsonArray,
ours: JsonArray,
theirs: JsonArray
): JsonArray {
- // Find the first matching ID field that exists in both arrays
- const idField = this.idFields.find(
- field =>
- ours.some(item => this.hasIdField(item, field)) &&
- theirs.some(item => this.hasIdField(item, field))
- )
+ const result = [...ours]
- if (!idField) return ours // No common identifier, keep our version
+ // Merge items at the same positions
+ for (let i = 0; i < Math.min(ours.length, theirs.length); i++) {
+ const ancestorItem = i < ancestor.length ? ancestor[i] : undefined
- // Create lookup maps
- const ourMap = this.createIdMap(ours, idField)
- const theirMap = this.createIdMap(theirs, idField)
- const ancestorMap = ancestor
- ? this.createIdMap(ancestor, idField)
- : new Map()
+ // If they changed it from ancestor but we didn't, use their version
+ if (!isEqual(theirs[i], ancestorItem) && isEqual(ours[i], ancestorItem)) {
+ result[i] = theirs[i]
+ }
+ }
+
+ // Add items that only exist in their version
+ if (theirs.length > ours.length) {
+ for (let i = ours.length; i < theirs.length; i++) {
+ result.push(theirs[i])
+ }
+ }
+ return result
+ }
+
+ /**
+ * Merges arrays using a key field
+ */
+ private mergeByKeyField(
+ ancestor: JsonArray,
+ ours: JsonArray,
+ theirs: JsonArray,
+ keyField: string
+ ): JsonArray {
const result = [...ours]
const processed = new Set<string>()
- // Process all items from both arrays
- for (const [id, ourItem] of ourMap) {
- const theirItem = theirMap.get(id)
- if (theirItem) {
- // Item exists in both versions, merge them
- const index = result.findIndex(
- item => this.hasIdField(item, idField) && item[idField] === id
- )
- if (index !== -1) {
- result[index] = this.mergeObjects(
- ancestorMap.get(id),
- ourItem,
- theirItem
- )
+ // Create maps for efficient lookups
+ const ourMap = new Map<string, JsonValue>()
+ const theirMap = new Map<string, JsonValue>()
+ const ancestorMap = new Map<string, JsonValue>()
+
+ // Populate maps
+ for (const item of ours) {
+ const key = this.getItemKey(item, keyField)
+ if (key) ourMap.set(key, item)
+ }
+
+ for (const item of theirs) {
+ const key = this.getItemKey(item, keyField)
+ if (key) theirMap.set(key, item)
+ }
+
+ for (const item of ancestor) {
+ const key = this.getItemKey(item, keyField)
+ if (key) ancestorMap.set(key, item)
+ }
+
+ // Process items in our version
+ for (let i = 0; i < result.length; i++) {
+ const key = this.getItemKey(result[i], keyField)
+ if (!key) continue
+
+ processed.add(key)
+
+ // If item exists in both versions
+ if (theirMap.has(key)) {
+ const theirItem = theirMap.get(key)!
+ const ancestorItem = ancestorMap.get(key)
+
+ // If they changed it from ancestor but we didn't, use their version
+ if (
+ !isEqual(theirItem, ancestorItem) &&
+ isEqual(result[i], ancestorItem)
+ ) {
+ result[i] = theirItem
}
}
- processed.add(id)
}
// Add items that only exist in their version
- for (const [id, theirItem] of theirMap) {
- if (!processed.has(id)) {
- result.push(theirItem)
- }
- }
+ const uniqueTheirItems = differenceWith(
+ Array.from(theirMap.values()),
+ result,
+ (a, b) => this.getItemKey(a, keyField) === this.getItemKey(b, keyField)
+ )
+ result.push(...uniqueTheirItems)
return result
}
- private hasIdField(item: JsonValue, field: string): item is JsonObject {
- return (
- item !== null &&
+ /**
+ * Gets the key value for an item using the specified key field
+ */
+ private getItemKey(item: JsonValue, keyField: string): string | undefined {
+ if (
typeof item === 'object' &&
+ item !== null &&
!Array.isArray(item) &&
- field in item
- )
- }
-
- private createIdMap(
- arr: JsonArray,
- idField: string
- ): Map<string, JsonObject> {
- return new Map(
- arr
- .filter(item => this.hasIdField(item, idField))
- .map(item => [String(item[idField]), item])
- )
+ keyField in item
+ ) {
+ return String(item[keyField])
+ }
+ return undefined
}
}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 96f4946..7d1ac85 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -8,234 +8,277 @@ describe('JsonMerger', () => {
sut = new JsonMerger()
})
- describe('given primitive values', () => {
- describe('when our changes differ from ancestor', () => {
- it('then should prefer our changes', () => {
- // Act & Assert
- expect(sut.mergeObjects(1, 2, 1)).toBe(2)
- expect(sut.mergeObjects('old', 'new', 'old')).toBe('new')
- expect(sut.mergeObjects(true, false, true)).toBe(false)
- })
- })
+ describe('given arrays with key fields', () => {
+ it('should merge arrays using the key field to identify matching elements', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
- describe('when we match ancestor', () => {
- it('then should accept their changes', () => {
- // Act & Assert
- expect(sut.mergeObjects(1, 1, 2)).toBe(2)
- expect(sut.mergeObjects('old', 'old', 'new')).toBe('new')
- expect(sut.mergeObjects(true, true, false)).toBe(false)
- })
- })
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
- describe('when null values are present', () => {
- it('then should handle them correctly', () => {
- // Act & Assert
- expect(sut.mergeObjects(1, null, null)).toBeNull()
- expect(sut.mergeObjects(null, 1, null)).toBe(1)
- expect(sut.mergeObjects(undefined, null, 1)).toBe(1)
- })
- })
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
- // TODO : Testing Conflict outputs
- // still not sure if we should test conflict for primitives as it lacks a unique identifier
- // maybe only throwing an error to treat the conflict at the parent node level
- // (1,null,2) should output conflict with tags and each value with git conflict convention
- // same for (1,2,null)
- })
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- describe('given objects to merge', () => {
- describe('when changes are non-conflicting', () => {
- it('then should merge them correctly', () => {
- // Arrange
- const ancestor = { a: 1, b: 2 }
- const ours = { a: 1, b: 3, c: 4 }
- const theirs = { a: 1, b: 2, d: 5 }
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
- a: 1,
- b: 3,
- c: 4,
- d: 5,
- })
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ },
})
})
- // TODO: Testing Conflict outputs
- // { a: 1, b: 2 }{ a: 1, b: 3, c: 4 }{ a: 1, b: 6, d: 5 } should merge all but output conflict on b
- // standard is <<<<<<< ours\n {ours version here} \n ||||||| base\n {base version here} \n =======\n {theirs version here} \n >>>>>>> theirs
- // if base null or empty (node does not exist in base) we can put it as empty or remove the entire base part
- // (I prefer always putting the 3 parts to make it clearer)
-
- describe('when objects are nested', () => {
- it('then should handle nested structures', () => {
- // Arrange
- const ancestor = { nested: { a: 1, b: 2 } }
- const ours = { nested: { a: 2, b: 2 } }
- const theirs = { nested: { a: 1, b: 3 } }
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
- nested: { a: 2, b: 3 },
- })
+ it('should handle the scenario when both sides modify the same element', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
})
})
- // TODO: this one should output a conflict as the types are not compatible
- describe('when type mismatches occur', () => {
- it('then should prefer our version', () => {
- // Arrange
- const ancestor = { a: 1 }
- const ours = { a: { nested: true } }
- const theirs = { a: 2 }
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
- a: { nested: true },
- })
+ it('should handle the scenario when we modify an element and they add a new one', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ },
})
})
})
- describe('given arrays to merge', () => {
- describe('when arrays have common identifiers', () => {
- it('then should merge them correctly', () => {
- // Arrange
- const ancestor = [
- { fullName: 'test1', value: 1 },
- { fullName: 'test2', value: 2 },
- ]
- const ours = [
- { fullName: 'test1', value: 3 },
- { fullName: 'test2', value: 2 },
- ]
- const theirs = [
- { fullName: 'test1', value: 1 },
- { fullName: 'test2', value: 4 },
- { fullName: 'test3', value: 5 },
- ]
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual([
- { fullName: 'test1', value: 3 },
- { fullName: 'test2', value: 4 },
- { fullName: 'test3', value: 5 },
- ])
- })
- })
+ describe('given arrays without key fields', () => {
+ it('should merge arrays without duplicates', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ custom: ['Value1', 'Value2'],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ custom: ['Value1', 'Value3'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ custom: ['Value1', 'Value2', 'Value4'],
+ },
+ }
- // TODO: this one should output a conflict as there are 2 different diversions
- describe('when arrays use different identifier fields', () => {
- it('then should handle different identifiers', () => {
- // Arrange
- const ancestor = [{ name: 'test1', value: 1 }]
- const ours = [{ name: 'test1', value: 2 }]
- const theirs = [{ name: 'test1', value: 3 }]
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual([
- { name: 'test1', value: 2 },
- ])
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ },
})
})
- // TODO: I don't know if we should have such case ever
- // if we actually do, I'd think the output should be [3,4,5]
- // because ours removes 1 and adds 4 and theirs removes 1 & 2 and adds 4 & 5 which are compatible
- describe('when arrays have no identifiers', () => {
- it('then should use our version', () => {
- // Arrange
- const ancestor = [1, 2, 3]
- const ours = [2, 3, 4]
- const theirs = [3, 4, 5]
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual([2, 3, 4])
+ it('should handle primitive values in arrays', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ values: [1, 2, 3],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ values: [1, 4, 5],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ values: [1, 2, 6],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ values: [1, 4, 5, 2, 6],
+ },
})
})
})
- describe('given Salesforce metadata', () => {
- describe('when merging custom field definitions', () => {
- it('then should merge correctly', () => {
- // Arrange
- const ancestor: JsonValue = {
- fields: [
- { fullName: 'Field1__c', type: 'Text', length: 100 },
- { fullName: 'Field2__c', type: 'Number', precision: 10 },
- ],
- }
- const ours: JsonValue = {
- fields: [
- { fullName: 'Field1__c', type: 'Text', length: 255 },
- { fullName: 'Field2__c', type: 'Number', precision: 10 },
- ],
- }
- const theirs: JsonValue = {
- fields: [
- { fullName: 'Field1__c', type: 'Text', length: 100 },
- { fullName: 'Field2__c', type: 'Number', precision: 18 },
- { fullName: 'Field3__c', type: 'Checkbox' },
- ],
- }
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
- fields: [
- { fullName: 'Field1__c', type: 'Text', length: 255 },
- { fullName: 'Field2__c', type: 'Number', precision: 18 },
- { fullName: 'Field3__c', type: 'Checkbox' },
- ],
- })
- })
- })
+ describe('given mixed JSON with both key and non-key arrays', () => {
+ it('should correctly merge a complex structure with both types', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value2'],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our updated description',
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value2', 'Value4'],
+ label: 'Their Label',
+ },
+ }
- // TODO: check but we shoud apply each change here as they are compatible
- describe('when merging layout metadata', () => {
- it('then should merge layouts correctly', () => {
- // Arrange
- const ancestor = {
- layoutSections: [
- { label: 'Information', layoutColumns: [{ fields: ['Name'] }] },
- ],
- }
- const ours = {
- layoutSections: [
- {
- label: 'Information',
- layoutColumns: [{ fields: ['Name', 'Email'] }],
- },
- ],
- }
- const theirs = {
- layoutSections: [
- {
- label: 'Information',
- layoutColumns: [{ fields: ['Name', 'Phone'] }],
- },
- { label: 'System', layoutColumns: [{ fields: ['CreatedDate'] }] },
- ],
- }
-
- // Act & Assert
- expect(sut.mergeObjects(ancestor, ours, theirs)).toEqual({
- layoutSections: [
- {
- label: 'Information',
- layoutColumns: [{ fields: ['Name', 'Email'] }],
- },
- { label: 'System', layoutColumns: [{ fields: ['CreatedDate'] }] },
- ],
- })
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ description: ['Our updated description', 'Original description'],
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ label: ['Their Label'],
+ },
})
})
+ })
- // TODO: Adding the different cases where the unique key is not the usual ones (those few types which have composite keys)
+ describe('given type conflicts', () => {
+ it('should prefer our changes when types conflict', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ settings: { enabled: 'false' },
+ }
- // TODO: Adding cases for the few for which the order of items in a list is important, like picklist values in a CustomField
+ const ours: JsonValue = {
+ settings: ['option1', 'option2'],
+ }
- // TODO: Adding conflict cases for Object element conflict
+ const theirs: JsonValue = {
+ settings: { enabled: 'true', newSetting: 'value' },
+ }
- // TODO: Adding conflict cases for List element conflict
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ settings: {
+ '0': 'option1',
+ '1': 'option2',
+ enabled: ['true'],
+ newSetting: ['value'],
+ },
+ })
+ })
})
})
From f4e973a5ad6e9bd4529044a643cd7ba242d9fc35 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 14 Mar 2025 19:37:39 +0100
Subject: [PATCH 20/55] feat: install driver only for handled types
---
src/service/installService.ts | 9 ++++++---
test/integration/install.nut.ts | 4 ++--
test/unit/service/InstallService.test.ts | 10 +++++++++-
3 files changed, 17 insertions(+), 6 deletions(-)
diff --git a/src/service/installService.ts b/src/service/installService.ts
index 26ada23..4e5976c 100644
--- a/src/service/installService.ts
+++ b/src/service/installService.ts
@@ -1,6 +1,7 @@
import { appendFile } from 'node:fs/promises'
import { simpleGit } from 'simple-git'
import { DRIVER_NAME, RUN_PLUGIN_COMMAND } from '../constant/driverConstant.js'
+import { METADATA_TYPES_PATTERNS } from '../constant/metadataConstant.js'
export class InstallService {
public async installMergeDriver() {
@@ -15,9 +16,11 @@ export class InstallService {
)
await git.addConfig(`merge.${DRIVER_NAME}.recursive`, 'true')
- const content =
- ['*.xml'].map(pattern => `${pattern} merge=${DRIVER_NAME}`).join('\n') +
- '\n'
+ // Configure merge driver for each metadata type pattern
+ const patterns = METADATA_TYPES_PATTERNS.map(
+ pattern => `*.${pattern}.xml merge=${DRIVER_NAME}`
+ ).join('\n')
+ const content = `${patterns}\n`
await appendFile('.gitattributes', content, { flag: 'a' })
}
diff --git a/test/integration/install.nut.ts b/test/integration/install.nut.ts
index f52a91a..9a9b2cd 100644
--- a/test/integration/install.nut.ts
+++ b/test/integration/install.nut.ts
@@ -48,7 +48,7 @@ describe('git merge driver install', () => {
expect(existsSync(gitattributesPath)).to.be.true
const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
- expect(gitattributesContent).to.include(`*.xml merge=${DRIVER_NAME}`)
+ expect(gitattributesContent).to.include(`.xml merge=${DRIVER_NAME}`)
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
@@ -77,7 +77,7 @@ describe('git merge driver install', () => {
expect(existsSync(gitattributesPath)).to.be.true
const gitattributesContent = readFileSync(gitattributesPath, 'utf-8')
- expect(gitattributesContent).to.include(`*.xml merge=${DRIVER_NAME}`)
+ expect(gitattributesContent).to.include(`.xml merge=${DRIVER_NAME}`)
const gitConfigOutput = execSync('git config --list', {
cwd: ROOT_FOLDER,
diff --git a/test/unit/service/InstallService.test.ts b/test/unit/service/InstallService.test.ts
index 48583d0..a3fd9ba 100644
--- a/test/unit/service/InstallService.test.ts
+++ b/test/unit/service/InstallService.test.ts
@@ -4,6 +4,7 @@ import {
DRIVER_NAME,
RUN_PLUGIN_COMMAND,
} from '../../../src/constant/driverConstant.js'
+import { METADATA_TYPES_PATTERNS } from '../../../src/constant/metadataConstant.js'
import { InstallService } from '../../../src/service/installService.js'
jest.mock('node:fs/promises')
@@ -46,9 +47,16 @@ describe('InstallService', () => {
'true'
)
expect(appendFileMocked).toHaveBeenCalledTimes(1)
+
+ // Generate the expected content for .gitattributes
+ const expectedPatterns = METADATA_TYPES_PATTERNS.map(
+ pattern => `*.${pattern}.xml merge=${DRIVER_NAME}`
+ ).join('\n')
+ const expectedContent = `${expectedPatterns}\n`
+
expect(appendFileMocked).toHaveBeenCalledWith(
'.gitattributes',
- '*.xml merge=salesforce-source\n',
+ expectedContent,
{ flag: 'a' }
)
})
From aebd99b9bde5d708ff5f02d33a8a553cc7b2cd97 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 14 Mar 2025 19:38:03 +0100
Subject: [PATCH 21/55] feat: improve uninstall regex
---
src/service/uninstallService.ts | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/service/uninstallService.ts b/src/service/uninstallService.ts
index 768d35a..f88b9cf 100644
--- a/src/service/uninstallService.ts
+++ b/src/service/uninstallService.ts
@@ -2,7 +2,8 @@ import { readFile, writeFile } from 'node:fs/promises'
import { simpleGit } from 'simple-git'
import { DRIVER_NAME } from '../constant/driverConstant.js'
-const MERGE_DRIVER_CONFIG = new RegExp(`.* merge\\s*=\\s*${DRIVER_NAME}$`)
+// This match lines like: "*.profile-meta.xml merge=sf-git-merge-driver"
+const MERGE_DRIVER_CONFIG = new RegExp(`.*\s+merge\s*=\s*${DRIVER_NAME}$`)
export class UninstallService {
public async uninstallMergeDriver() {
From 46502b359e87432f782cc72baf257e9120ed636d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Mon, 17 Mar 2025 10:00:41 +0100
Subject: [PATCH 22/55] test: improve spec coverage
---
src/merger/JsonMerger.ts | 4 +-
test/unit/merger/JsonMerger.test.ts | 256 ++++++++++++++++++++++++++++
2 files changed, 258 insertions(+), 2 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index e60bb3e..5a6ceba 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,4 +1,4 @@
-import { castArray, differenceWith, isEqual, unionWith } from 'lodash-es'
+import { castArray, differenceWith, isEqual, isNil, unionWith } from 'lodash-es'
import { KEY_FIELD_METADATA } from '../constant/metadataConstant.js'
export type JsonValue =
@@ -100,7 +100,7 @@ export class JsonMerger {
* Ensures a value is an array
*/
private ensureArray(value: JsonValue): JsonArray {
- return value === null ? [] : (castArray(value) as JsonArray)
+ return isNil(value) ? [] : (castArray(value) as JsonArray)
}
/**
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 7d1ac85..3f77e98 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -281,4 +281,260 @@ describe('JsonMerger', () => {
})
})
})
+
+ describe('given undefined ancestor', () => {
+ it('should correctly merge objects when ancestor is undefined', () => {
+ // Arrange
+ const ancestor = undefined
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value2', 'Value4'],
+ description: 'Their description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ description: ['Their description'],
+ },
+ })
+ })
+
+ it('should correctly merge arrays with key field when ancestor is undefined', () => {
+ // Arrange
+ const ancestor = undefined
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ },
+ })
+ })
+
+ it('should correctly merge arrays without key field when ancestor is undefined', () => {
+ // Arrange
+ const ancestor = undefined
+
+ const ours: JsonValue = {
+ Profile: {
+ custom: ['Value1', 'Value3'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ custom: ['Value1', 'Value2', 'Value4'],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ },
+ })
+ })
+ })
+
+ describe('given arrays with <array> key field', () => {
+ it('should merge arrays by position when both sides modify different elements', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ loginHours: [
+ 'Monday-Modified',
+ 'Tuesday',
+ 'Wednesday',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ loginHours: [
+ 'Monday',
+ 'Tuesday',
+ 'Wednesday-Modified',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ loginHours: [
+ 'Monday-Modified',
+ 'Tuesday',
+ 'Wednesday-Modified',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
+ })
+ })
+
+ it('should use their version when we did not modify an element but they did', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ loginIpRanges: ['192.168.1.1', '10.0.0.1', '172.16.0.1'],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ loginIpRanges: ['192.168.1.1', '10.0.0.1', '172.16.0.1'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ loginIpRanges: ['192.168.1.1', '10.0.0.2', '172.16.0.1'],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ loginIpRanges: ['192.168.1.1', '10.0.0.2', '172.16.0.1'],
+ },
+ })
+ })
+
+ it('should append their additional elements when their array is longer', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ loginHours: ['Monday', 'Tuesday', 'Wednesday'],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ loginHours: ['Monday', 'Tuesday', 'Wednesday'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ },
+ })
+ })
+
+ it('should keep our additional elements when our array is longer', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ loginHours: ['Monday', 'Tuesday'],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ loginHours: ['Monday-Modified', 'Tuesday'],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual({
+ Profile: {
+ loginHours: [
+ 'Monday-Modified',
+ 'Tuesday',
+ 'Wednesday',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
+ })
+ })
+ })
})
From f7a7bc60c7bd35e4d317ca5770a92c7025721380 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Mon, 17 Mar 2025 10:13:51 +0100
Subject: [PATCH 23/55] build: upgrade dependencies
---
knip.config.ts | 4 +-
package-lock.json | 716 ++++++++++++++++++++++++----------------------
package.json | 12 +-
3 files changed, 378 insertions(+), 354 deletions(-)
diff --git a/knip.config.ts b/knip.config.ts
index ab0b192..f226d0d 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -9,7 +9,7 @@ export default {
'src/commands/git/merge/driver/run.ts',
'src/commands/git/merge/driver/uninstall.ts',
],
- project: ['**/*.{ts,js,json,yml}', '!src/index.ts'],
- ignoreDependencies: ['@commitlint/config-conventional', 'ts-node'],
+ project: ['**/*.{ts,js,json,yml}'],
+ ignoreDependencies: ['@commitlint/config-conventional', 'ts-node', 'lodash'],
ignoreBinaries: ['commitlint', 'npm-check-updates'],
}
diff --git a/package-lock.json b/package-lock.json
index 98cfe40..f3aa01d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,17 +9,17 @@
"version": "1.0.0",
"license": "MIT",
"dependencies": {
- "@oclif/core": "^4.2.8",
+ "@oclif/core": "^4.2.10",
"@salesforce/core": "^8.8.5",
"@salesforce/sf-plugins-core": "^12.2.0",
- "fast-xml-parser": "^5.0.8",
+ "fast-xml-parser": "^5.0.9",
"lodash-es": "^4.17.21",
"simple-git": "^3.27.0"
},
"devDependencies": {
"@biomejs/biome": "1.9.4",
"@commitlint/config-conventional": "^19.8.0",
- "@oclif/plugin-help": "^6.2.26",
+ "@oclif/plugin-help": "^6.2.27",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
"@types/chai": "^5.2.0",
@@ -27,11 +27,11 @@
"chai": "^5.2.0",
"husky": "^9.1.7",
"jest": "^29.7.0",
- "knip": "^5.45.0",
+ "knip": "^5.46.0",
"mocha": "^11.1.0",
"nyc": "^17.1.0",
- "oclif": "^4.17.34",
- "shx": "^0.3.4",
+ "oclif": "^4.17.37",
+ "shx": "^0.4.0",
"ts-jest": "^29.2.6",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
@@ -312,9 +312,9 @@
}
},
"node_modules/@aws-sdk/client-cloudfront": {
- "version": "3.758.0",
- "resolved": "https://registry.npmjs.org/@aws-sdk/client-cloudfront/-/client-cloudfront-3.758.0.tgz",
- "integrity": "sha512-kAIMe+cwH+ZuK/rM3L8NdM8rS5cnCoFTgCbjF4GVjDnZJ8JlNm3oRIKAK55mmgtGLuqEz1h6QVLrV01/fNvYaA==",
+ "version": "3.764.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/client-cloudfront/-/client-cloudfront-3.764.0.tgz",
+ "integrity": "sha512-nXKaM9/T9viu5IXcPueTjf10VHOMX4J1FHWITDdk0s/vY2YZidGAZmeHLA0QXM0SxOQw/xga4d4k5HKdup2DSw==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
@@ -1250,14 +1250,14 @@
}
},
"node_modules/@babel/helpers": {
- "version": "7.26.9",
- "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.9.tgz",
- "integrity": "sha512-Mz/4+y8udxBKdmzt/UjPACs4G3j5SshJJEFFKxlCGPydG4JAHXxjWjAwjd09tf6oINvl1VfMJo+nB7H2YKQ0dA==",
+ "version": "7.26.10",
+ "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.10.tgz",
+ "integrity": "sha512-UPYc3SauzZ3JGgj87GgZ89JVdC5dj0AoetR5Bw6wj4niittNyFh6+eOGonYvJ1ao6B8lEa3Q3klS7ADZ53bc5g==",
"dev": true,
"license": "MIT",
"dependencies": {
"@babel/template": "^7.26.9",
- "@babel/types": "^7.26.9"
+ "@babel/types": "^7.26.10"
},
"engines": {
"node": ">=6.9.0"
@@ -1553,9 +1553,9 @@
}
},
"node_modules/@babel/types": {
- "version": "7.26.9",
- "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.9.tgz",
- "integrity": "sha512-Y3IR1cRnOxOCDvMmNiym7XpXQ93iGDDPHx+Zj+NM+rg0fBaShfQLkg+hKPaZCEvg5N/LeCo4+Rj/i3FuJsIQaw==",
+ "version": "7.26.10",
+ "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.10.tgz",
+ "integrity": "sha512-emqcG3vHrpxUKTrxcblR36dcrcoRDvKmnL/dCL6ZsHaShW80qxCAcNhzQZrpeM765VzEos+xOi4s+r4IXzTwdQ==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -1790,15 +1790,15 @@
}
},
"node_modules/@inquirer/checkbox": {
- "version": "4.1.2",
- "resolved": "https://registry.npmjs.org/@inquirer/checkbox/-/checkbox-4.1.2.tgz",
- "integrity": "sha512-PL9ixC5YsPXzXhAZFUPmkXGxfgjkdfZdPEPPmt4kFwQ4LBMDG9n/nHXYRGGZSKZJs+d1sGKWgS2GiPzVRKUdtQ==",
+ "version": "4.1.4",
+ "resolved": "https://registry.npmjs.org/@inquirer/checkbox/-/checkbox-4.1.4.tgz",
+ "integrity": "sha512-d30576EZdApjAMceijXA5jDzRQHT/MygbC+J8I7EqA6f/FRpYxlRtRJbHF8gHeWYeSdOuTEJqonn7QLB1ELezA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"yoctocolors-cjs": "^2.1.2"
},
@@ -1815,14 +1815,14 @@
}
},
"node_modules/@inquirer/checkbox/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -1843,9 +1843,9 @@
}
},
"node_modules/@inquirer/checkbox/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -1876,26 +1876,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/checkbox/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/checkbox/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/checkbox/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -1987,15 +1967,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/core/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
"node_modules/@inquirer/core/node_modules/mute-stream": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-1.0.0.tgz",
@@ -2032,14 +2003,14 @@
}
},
"node_modules/@inquirer/editor": {
- "version": "4.2.7",
- "resolved": "https://registry.npmjs.org/@inquirer/editor/-/editor-4.2.7.tgz",
- "integrity": "sha512-gktCSQtnSZHaBytkJKMKEuswSk2cDBuXX5rxGFv306mwHfBPjg5UAldw9zWGoEyvA9KpRDkeM4jfrx0rXn0GyA==",
+ "version": "4.2.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/editor/-/editor-4.2.9.tgz",
+ "integrity": "sha512-8HjOppAxO7O4wV1ETUlJFg6NDjp/W2NP5FB9ZPAcinAlNT4ZIWOLe2pUVwmmPRSV0NMdI5r/+lflN55AwZOKSw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5",
"external-editor": "^3.1.0"
},
"engines": {
@@ -2055,14 +2026,14 @@
}
},
"node_modules/@inquirer/editor/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2083,9 +2054,9 @@
}
},
"node_modules/@inquirer/editor/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -2116,26 +2087,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/editor/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/editor/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/editor/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -2165,14 +2116,14 @@
}
},
"node_modules/@inquirer/expand": {
- "version": "4.0.9",
- "resolved": "https://registry.npmjs.org/@inquirer/expand/-/expand-4.0.9.tgz",
- "integrity": "sha512-Xxt6nhomWTAmuSX61kVgglLjMEFGa+7+F6UUtdEUeg7fg4r9vaFttUUKrtkViYYrQBA5Ia1tkOJj2koP9BuLig==",
+ "version": "4.0.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/expand/-/expand-4.0.11.tgz",
+ "integrity": "sha512-OZSUW4hFMW2TYvX/Sv+NnOZgO8CHT2TU1roUCUIF2T+wfw60XFRRp9MRUPCT06cRnKL+aemt2YmTWwt7rOrNEA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5",
"yoctocolors-cjs": "^2.1.2"
},
"engines": {
@@ -2188,14 +2139,14 @@
}
},
"node_modules/@inquirer/expand/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2216,9 +2167,9 @@
}
},
"node_modules/@inquirer/expand/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -2249,26 +2200,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/expand/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/expand/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/expand/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -2298,9 +2229,9 @@
}
},
"node_modules/@inquirer/figures": {
- "version": "1.0.10",
- "resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.10.tgz",
- "integrity": "sha512-Ey6176gZmeqZuY/W/nZiUyvmb1/qInjcpiZjXWi6nON+nxJpD1bxtSoBxNliGISae32n6OwbY+TSXPZ1CfS4bw==",
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.11.tgz",
+ "integrity": "sha512-eOg92lvrn/aRUqbxRyvpEWnrvRuTYRifixHkYVpJiygTgVSBIHDqLh0SrMQXkafvULg3ck11V7xvR+zcgvpHFw==",
"license": "MIT",
"engines": {
"node": ">=18"
@@ -2321,14 +2252,14 @@
}
},
"node_modules/@inquirer/number": {
- "version": "3.0.9",
- "resolved": "https://registry.npmjs.org/@inquirer/number/-/number-3.0.9.tgz",
- "integrity": "sha512-iN2xZvH3tyIYXLXBvlVh0npk1q/aVuKXZo5hj+K3W3D4ngAEq/DkLpofRzx6oebTUhBvOgryZ+rMV0yImKnG3w==",
+ "version": "3.0.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/number/-/number-3.0.11.tgz",
+ "integrity": "sha512-pQK68CsKOgwvU2eA53AG/4npRTH2pvs/pZ2bFvzpBhrznh8Mcwt19c+nMO7LHRr3Vreu1KPhNBF3vQAKrjIulw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4"
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5"
},
"engines": {
"node": ">=18"
@@ -2343,14 +2274,14 @@
}
},
"node_modules/@inquirer/number/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2371,9 +2302,9 @@
}
},
"node_modules/@inquirer/number/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -2404,26 +2335,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/number/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/number/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/number/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -2453,14 +2364,14 @@
}
},
"node_modules/@inquirer/password": {
- "version": "4.0.9",
- "resolved": "https://registry.npmjs.org/@inquirer/password/-/password-4.0.9.tgz",
- "integrity": "sha512-xBEoOw1XKb0rIN208YU7wM7oJEHhIYkfG7LpTJAEW913GZeaoQerzf5U/LSHI45EVvjAdgNXmXgH51cUXKZcJQ==",
+ "version": "4.0.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/password/-/password-4.0.11.tgz",
+ "integrity": "sha512-dH6zLdv+HEv1nBs96Case6eppkRggMe8LoOTl30+Gq5Wf27AO/vHFgStTVz4aoevLdNXqwE23++IXGw4eiOXTg==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2"
},
"engines": {
@@ -2476,14 +2387,14 @@
}
},
"node_modules/@inquirer/password/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2504,9 +2415,9 @@
}
},
"node_modules/@inquirer/password/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -2537,26 +2448,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/password/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/password/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/password/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -2586,22 +2477,22 @@
}
},
"node_modules/@inquirer/prompts": {
- "version": "7.3.2",
- "resolved": "https://registry.npmjs.org/@inquirer/prompts/-/prompts-7.3.2.tgz",
- "integrity": "sha512-G1ytyOoHh5BphmEBxSwALin3n1KGNYB6yImbICcRQdzXfOGbuJ9Jske/Of5Sebk339NSGGNfUshnzK8YWkTPsQ==",
+ "version": "7.4.0",
+ "resolved": "https://registry.npmjs.org/@inquirer/prompts/-/prompts-7.4.0.tgz",
+ "integrity": "sha512-EZiJidQOT4O5PYtqnu1JbF0clv36oW2CviR66c7ma4LsupmmQlUwmdReGKRp456OWPWMz3PdrPiYg3aCk3op2w==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/checkbox": "^4.1.2",
- "@inquirer/confirm": "^5.1.6",
- "@inquirer/editor": "^4.2.7",
- "@inquirer/expand": "^4.0.9",
- "@inquirer/input": "^4.1.6",
- "@inquirer/number": "^3.0.9",
- "@inquirer/password": "^4.0.9",
- "@inquirer/rawlist": "^4.0.9",
- "@inquirer/search": "^3.0.9",
- "@inquirer/select": "^4.0.9"
+ "@inquirer/checkbox": "^4.1.4",
+ "@inquirer/confirm": "^5.1.8",
+ "@inquirer/editor": "^4.2.9",
+ "@inquirer/expand": "^4.0.11",
+ "@inquirer/input": "^4.1.8",
+ "@inquirer/number": "^3.0.11",
+ "@inquirer/password": "^4.0.11",
+ "@inquirer/rawlist": "^4.0.11",
+ "@inquirer/search": "^3.0.11",
+ "@inquirer/select": "^4.1.0"
},
"engines": {
"node": ">=18"
@@ -2616,14 +2507,14 @@
}
},
"node_modules/@inquirer/prompts/node_modules/@inquirer/confirm": {
- "version": "5.1.6",
- "resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.6.tgz",
- "integrity": "sha512-6ZXYK3M1XmaVBZX6FCfChgtponnL0R6I7k8Nu+kaoNkT828FVZTcca1MqmWQipaW2oNREQl5AaPCUOOCVNdRMw==",
+ "version": "5.1.8",
+ "resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.8.tgz",
+ "integrity": "sha512-dNLWCYZvXDjO3rnQfk2iuJNL4Ivwz/T2+C3+WnNfJKsNGSuOs3wAo2F6e0p946gtSAk31nZMfW+MRmYaplPKsg==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4"
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5"
},
"engines": {
"node": ">=18"
@@ -2638,14 +2529,14 @@
}
},
"node_modules/@inquirer/prompts/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2666,14 +2557,14 @@
}
},
"node_modules/@inquirer/prompts/node_modules/@inquirer/input": {
- "version": "4.1.6",
- "resolved": "https://registry.npmjs.org/@inquirer/input/-/input-4.1.6.tgz",
- "integrity": "sha512-1f5AIsZuVjPT4ecA8AwaxDFNHny/tSershP/cTvTDxLdiIGTeILNcKozB0LaYt6mojJLUbOYhpIxicaYf7UKIQ==",
+ "version": "4.1.8",
+ "resolved": "https://registry.npmjs.org/@inquirer/input/-/input-4.1.8.tgz",
+ "integrity": "sha512-WXJI16oOZ3/LiENCAxe8joniNp8MQxF6Wi5V+EBbVA0ZIOpFcL4I9e7f7cXse0HJeIPCWO8Lcgnk98juItCi7Q==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4"
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5"
},
"engines": {
"node": ">=18"
@@ -2688,15 +2579,15 @@
}
},
"node_modules/@inquirer/prompts/node_modules/@inquirer/select": {
- "version": "4.0.9",
- "resolved": "https://registry.npmjs.org/@inquirer/select/-/select-4.0.9.tgz",
- "integrity": "sha512-BpJyJe7Dkhv2kz7yG7bPSbJLQuu/rqyNlF1CfiiFeFwouegfH+zh13KDyt6+d9DwucKo7hqM3wKLLyJxZMO+Xg==",
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/@inquirer/select/-/select-4.1.0.tgz",
+ "integrity": "sha512-z0a2fmgTSRN+YBuiK1ROfJ2Nvrpij5lVN3gPDkQGhavdvIVGHGW29LwYZfM/j42Ai2hUghTI/uoBuTbrJk42bA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"yoctocolors-cjs": "^2.1.2"
},
@@ -2713,9 +2604,9 @@
}
},
"node_modules/@inquirer/prompts/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -2746,26 +2637,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/prompts/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/prompts/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/prompts/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -2795,14 +2666,14 @@
}
},
"node_modules/@inquirer/rawlist": {
- "version": "4.0.9",
- "resolved": "https://registry.npmjs.org/@inquirer/rawlist/-/rawlist-4.0.9.tgz",
- "integrity": "sha512-+5t6ebehKqgoxV8fXwE49HkSF2Rc9ijNiVGEQZwvbMI61/Q5RcD+jWD6Gs1tKdz5lkI8GRBL31iO0HjGK1bv+A==",
+ "version": "4.0.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/rawlist/-/rawlist-4.0.11.tgz",
+ "integrity": "sha512-uAYtTx0IF/PqUAvsRrF3xvnxJV516wmR6YVONOmCWJbbt87HcDHLfL9wmBQFbNJRv5kCjdYKrZcavDkH3sVJPg==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/type": "^3.0.5",
"yoctocolors-cjs": "^2.1.2"
},
"engines": {
@@ -2818,14 +2689,14 @@
}
},
"node_modules/@inquirer/rawlist/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2846,9 +2717,9 @@
}
},
"node_modules/@inquirer/rawlist/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -2879,26 +2750,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/rawlist/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/rawlist/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/rawlist/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -2928,15 +2779,15 @@
}
},
"node_modules/@inquirer/search": {
- "version": "3.0.9",
- "resolved": "https://registry.npmjs.org/@inquirer/search/-/search-3.0.9.tgz",
- "integrity": "sha512-DWmKztkYo9CvldGBaRMr0ETUHgR86zE6sPDVOHsqz4ISe9o1LuiWfgJk+2r75acFclA93J/lqzhT0dTjCzHuoA==",
+ "version": "3.0.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/search/-/search-3.0.11.tgz",
+ "integrity": "sha512-9CWQT0ikYcg6Ls3TOa7jljsD7PgjcsYEM0bYE+Gkz+uoW9u8eaJCRHJKkucpRE5+xKtaaDbrND+nPDoxzjYyew==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/core": "^10.1.7",
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/core": "^10.1.9",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"yoctocolors-cjs": "^2.1.2"
},
"engines": {
@@ -2952,14 +2803,14 @@
}
},
"node_modules/@inquirer/search/node_modules/@inquirer/core": {
- "version": "10.1.7",
- "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.7.tgz",
- "integrity": "sha512-AA9CQhlrt6ZgiSy6qoAigiA1izOa751ugX6ioSjqgJ+/Gd+tEN/TORk5sUYNjXuHWfW0r1n/a6ak4u/NqHHrtA==",
+ "version": "10.1.9",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.9.tgz",
+ "integrity": "sha512-sXhVB8n20NYkUBfDYgizGHlpRVaCRjtuzNZA6xpALIUbkgfd2Hjz+DfEN6+h1BRnuxw0/P4jCIMjMsEOAMwAJw==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/figures": "^1.0.10",
- "@inquirer/type": "^3.0.4",
+ "@inquirer/figures": "^1.0.11",
+ "@inquirer/type": "^3.0.5",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "^2.0.0",
@@ -2980,9 +2831,9 @@
}
},
"node_modules/@inquirer/search/node_modules/@inquirer/type": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz",
- "integrity": "sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==",
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.5.tgz",
+ "integrity": "sha512-ZJpeIYYueOz/i/ONzrfof8g89kNdO2hjGuvULROo3O8rlB2CRtSseE5KeirnyE4t/thAn/EwvS/vuQeJCn+NZg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -3013,26 +2864,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/@inquirer/search/node_modules/cli-width": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
- "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": ">= 12"
- }
- },
- "node_modules/@inquirer/search/node_modules/mute-stream": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
- "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
"node_modules/@inquirer/search/node_modules/signal-exit": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
@@ -3937,9 +3768,9 @@
}
},
"node_modules/@oclif/core": {
- "version": "4.2.9",
- "resolved": "https://registry.npmjs.org/@oclif/core/-/core-4.2.9.tgz",
- "integrity": "sha512-cIlvpefLtorcyvnvJiOmYBqn6J6qdp/06tk54p2MddGEr0gnA7EIaQXM2UtRjf4ryDVCbIo+8IFRsW8Flt0uGA==",
+ "version": "4.2.10",
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-4.2.10.tgz",
+ "integrity": "sha512-fAqcXgqkUm4v5FYy7qWP4w1HaOlVSVJveah+yVTo5Nm5kTiXhmD5mQQ7+knGeBaStyrtQy6WardoC2xSic9rlQ==",
"license": "MIT",
"dependencies": {
"ansi-escapes": "^4.3.2",
@@ -3966,9 +3797,9 @@
}
},
"node_modules/@oclif/plugin-help": {
- "version": "6.2.26",
- "resolved": "https://registry.npmjs.org/@oclif/plugin-help/-/plugin-help-6.2.26.tgz",
- "integrity": "sha512-5KdldxEizbV3RsHOddN4oMxrX/HL6z79S94tbxEHVZ/dJKDWzfyCpgC9axNYqwmBF2pFZkozl/l7t3hCGOdalw==",
+ "version": "6.2.27",
+ "resolved": "https://registry.npmjs.org/@oclif/plugin-help/-/plugin-help-6.2.27.tgz",
+ "integrity": "sha512-RWSWtCFVObRmCwgxVOye3lsYbPHTnB7G4He5LEAg2tf600Sil5yXEOL/ULx1TqL/XOQxKqRvmLn/rLQOMT85YA==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -3979,15 +3810,15 @@
}
},
"node_modules/@oclif/plugin-not-found": {
- "version": "3.2.44",
- "resolved": "https://registry.npmjs.org/@oclif/plugin-not-found/-/plugin-not-found-3.2.44.tgz",
- "integrity": "sha512-UF6GD/aDbElP6LJMZSSq72NvK0aQwtQ+fkjn0VLU9o1vNAA3M2K0tGL7lduZGQNw8LejOhr25eR4aXeRCgKb2A==",
+ "version": "3.2.47",
+ "resolved": "https://registry.npmjs.org/@oclif/plugin-not-found/-/plugin-not-found-3.2.47.tgz",
+ "integrity": "sha512-7Zk10TQhPOd5kkS4wiLDBqtR2MRM8FBiSrZDmSsgME1kXt4eYQLAFc9c5WJzkpglNb6g5/iD1LvbhTNd5oLe1g==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@inquirer/prompts": "^7.3.2",
+ "@inquirer/prompts": "^7.3.3",
"@oclif/core": "^4",
- "ansis": "^3.16.0",
+ "ansis": "^3.17.0",
"fast-levenshtein": "^3.0.0"
},
"engines": {
@@ -6451,6 +6282,15 @@
"url": "https://github.com/chalk/strip-ansi?sponsor=1"
}
},
+ "node_modules/cli-width": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
+ "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
+ "license": "ISC",
+ "engines": {
+ "node": ">= 12"
+ }
+ },
"node_modules/cliui": {
"version": "8.0.1",
"resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
@@ -7352,9 +7192,9 @@
"license": "BSD-3-Clause"
},
"node_modules/fast-xml-parser": {
- "version": "5.0.8",
- "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.0.8.tgz",
- "integrity": "sha512-qY8NiI5L8ff00F2giyICiJxSSKHO52tC36LJqx2JtvGyAd5ZfehC/l4iUVVHpmpIa6sM9N5mneSLHQG2INGoHA==",
+ "version": "5.0.9",
+ "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.0.9.tgz",
+ "integrity": "sha512-2mBwCiuW3ycKQQ6SOesSB8WeF+fIGb6I/GG5vU5/XEptwFFhp9PE8b9O7fbs2dpq9fXn4ULR3UsfydNUCntf5A==",
"funding": [
{
"type": "github",
@@ -10338,9 +10178,9 @@
}
},
"node_modules/knip": {
- "version": "5.45.0",
- "resolved": "https://registry.npmjs.org/knip/-/knip-5.45.0.tgz",
- "integrity": "sha512-OUyO9FUEVCM6/j0gl+PP/LDeJEs4hIdE8n4vK4xrtjN1g3Qu4Ws1oexbWTCJ+8xt8Tgse4Yvhx96OqF/UVl3Ug==",
+ "version": "5.46.0",
+ "resolved": "https://registry.npmjs.org/knip/-/knip-5.46.0.tgz",
+ "integrity": "sha512-WedHSK5xNBWYgm64Rt5B9b0CVXL2kRBcyCeet3NHgdv9en3QE4AWSDPEiX48NoPUBW3h//9S0VwLF5MG/MPi3g==",
"dev": true,
"funding": [
{
@@ -11005,6 +10845,16 @@
"node": ">= 6"
}
},
+ "node_modules/mute-stream": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
+ "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": "^18.17.0 || >=20.5.0"
+ }
+ },
"node_modules/natural-compare": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz",
@@ -11021,6 +10871,13 @@
"node": ">=18"
}
},
+ "node_modules/nice-try": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz",
+ "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==",
+ "dev": true,
+ "license": "MIT"
+ },
"node_modules/nise": {
"version": "5.1.9",
"resolved": "https://registry.npmjs.org/nise/-/nise-5.1.9.tgz",
@@ -11338,20 +11195,20 @@
}
},
"node_modules/oclif": {
- "version": "4.17.34",
- "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.17.34.tgz",
- "integrity": "sha512-zog6l7Xndexoq0lQIKyHIspr0OQQBiXQ97xTCZC4hUmgxKoxLVUV4HmHfegAxiTC/5Kmp5+z72b+BysNU2RlVQ==",
+ "version": "4.17.37",
+ "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.17.37.tgz",
+ "integrity": "sha512-sB71e7euBGmoMgIJ9UgM49QdpMVTqp26be31ZLfO1iV6MetCR7XLL2aAL+32NuucaCbTVdH9YkgbcU9xJMfZfA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@aws-sdk/client-cloudfront": "^3.758.0",
+ "@aws-sdk/client-cloudfront": "^3.764.0",
"@aws-sdk/client-s3": "^3.749.0",
"@inquirer/confirm": "^3.1.22",
"@inquirer/input": "^2.2.4",
"@inquirer/select": "^2.5.0",
"@oclif/core": "^4.2.8",
"@oclif/plugin-help": "^6.2.25",
- "@oclif/plugin-not-found": "^3.2.44",
+ "@oclif/plugin-not-found": "^3.2.46",
"@oclif/plugin-warn-if-update-available": "^3.1.31",
"async-retry": "^1.3.3",
"chalk": "^4",
@@ -11365,7 +11222,7 @@
"lodash": "^4.17.21",
"normalize-package-data": "^6",
"semver": "^7.7.1",
- "sort-package-json": "^2.14.0",
+ "sort-package-json": "^2.15.1",
"tiny-jsonc": "^1.0.1",
"validate-npm-package-name": "^5.0.1"
},
@@ -11475,6 +11332,16 @@
"node": ">=12.20"
}
},
+ "node_modules/p-finally": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz",
+ "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
"node_modules/p-limit": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
@@ -12547,22 +12414,169 @@
}
},
"node_modules/shx": {
- "version": "0.3.4",
- "resolved": "https://registry.npmjs.org/shx/-/shx-0.3.4.tgz",
- "integrity": "sha512-N6A9MLVqjxZYcVn8hLmtneQWIJtp8IKzMP4eMnx+nqkvXoqinUPCbUFLp2UcWTEIUONhlk0ewxr/jaVGlc+J+g==",
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/shx/-/shx-0.4.0.tgz",
+ "integrity": "sha512-Z0KixSIlGPpijKgcH6oCMCbltPImvaKy0sGH8AkLRXw1KyzpKtaCTizP2xen+hNDqVF4xxgvA0KXSb9o4Q6hnA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "minimist": "^1.2.3",
- "shelljs": "^0.8.5"
+ "minimist": "^1.2.8",
+ "shelljs": "^0.9.2"
},
"bin": {
"shx": "lib/cli.js"
},
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/shx/node_modules/cross-spawn": {
+ "version": "6.0.6",
+ "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.6.tgz",
+ "integrity": "sha512-VqCUuhcd1iB+dsv8gxPttb5iZh/D0iubSP21g36KXdEuf6I5JiioesUVjpCdHV9MZRUfVFlvwtIUyPfxo5trtw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "nice-try": "^1.0.4",
+ "path-key": "^2.0.1",
+ "semver": "^5.5.0",
+ "shebang-command": "^1.2.0",
+ "which": "^1.2.9"
+ },
+ "engines": {
+ "node": ">=4.8"
+ }
+ },
+ "node_modules/shx/node_modules/execa": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz",
+ "integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cross-spawn": "^6.0.0",
+ "get-stream": "^4.0.0",
+ "is-stream": "^1.1.0",
+ "npm-run-path": "^2.0.0",
+ "p-finally": "^1.0.0",
+ "signal-exit": "^3.0.0",
+ "strip-eof": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/shx/node_modules/get-stream": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz",
+ "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "pump": "^3.0.0"
+ },
"engines": {
"node": ">=6"
}
},
+ "node_modules/shx/node_modules/is-stream": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz",
+ "integrity": "sha512-uQPm8kcs47jx38atAcWTVxyltQYoPT68y9aWYdV6yWXSyW8mzSat0TL6CiWdZeCdF3KrAvpVtnHbTv4RN+rqdQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/shx/node_modules/npm-run-path": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz",
+ "integrity": "sha512-lJxZYlT4DW/bRUtFh1MQIWqmLwQfAxnqWG4HhEdjMlkrJYnJn0Jrr2u3mgxqaWsdiBc76TYkTG/mhrnYTuzfHw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "path-key": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/shx/node_modules/path-key": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz",
+ "integrity": "sha512-fEHGKCSmUSDPv4uoj8AlD+joPlq3peND+HRYyxFz4KPw4z926S/b8rIuFs2FYJg3BwsxJf6A9/3eIdLaYC+9Dw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/shx/node_modules/semver": {
+ "version": "5.7.2",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz",
+ "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==",
+ "dev": true,
+ "license": "ISC",
+ "bin": {
+ "semver": "bin/semver"
+ }
+ },
+ "node_modules/shx/node_modules/shebang-command": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz",
+ "integrity": "sha512-EV3L1+UQWGor21OmnvojK36mhg+TyIKDh3iFBKBohr5xeXIhNBcx8oWdgkTEEQ+BEFFYdLRuqMfd5L84N1V5Vg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "shebang-regex": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/shx/node_modules/shebang-regex": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz",
+ "integrity": "sha512-wpoSFAxys6b2a2wHZ1XpDSgD7N9iVjg29Ph9uV/uaP9Ex/KXlkTZTeddxDPSYQpgvzKLGJke2UU0AzoGCjNIvQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/shx/node_modules/shelljs": {
+ "version": "0.9.2",
+ "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.9.2.tgz",
+ "integrity": "sha512-S3I64fEiKgTZzKCC46zT/Ib9meqofLrQVbpSswtjFfAVDW+AZ54WTnAM/3/yENoxz/V1Cy6u3kiiEbQ4DNphvw==",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "execa": "^1.0.0",
+ "fast-glob": "^3.3.2",
+ "interpret": "^1.0.0",
+ "rechoir": "^0.6.2"
+ },
+ "bin": {
+ "shjs": "bin/shjs"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/shx/node_modules/which": {
+ "version": "1.3.1",
+ "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz",
+ "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "which": "bin/which"
+ }
+ },
"node_modules/signal-exit": {
"version": "3.0.7",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz",
@@ -13002,6 +13016,16 @@
"node": ">=8"
}
},
+ "node_modules/strip-eof": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz",
+ "integrity": "sha512-7FCwGGmx8mD5xQd3RPUvnSpUXHM3BWuzjtpD4TXsfcZ9EL4azvVVUscFYwD9nx8Kh+uCBC00XBtAykoMHwTh8Q==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/strip-final-newline": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz",
diff --git a/package.json b/package.json
index ab6a671..8ac8a05 100644
--- a/package.json
+++ b/package.json
@@ -10,17 +10,17 @@
"url": "git+https://github.com/scolladon/sf-git-merge-driver.git"
},
"dependencies": {
- "@oclif/core": "^4.2.8",
+ "@oclif/core": "^4.2.10",
"@salesforce/core": "^8.8.5",
"@salesforce/sf-plugins-core": "^12.2.0",
- "fast-xml-parser": "^5.0.8",
+ "fast-xml-parser": "^5.0.9",
"lodash-es": "^4.17.21",
"simple-git": "^3.27.0"
},
"devDependencies": {
"@biomejs/biome": "1.9.4",
"@commitlint/config-conventional": "^19.8.0",
- "@oclif/plugin-help": "^6.2.26",
+ "@oclif/plugin-help": "^6.2.27",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
"@types/chai": "^5.2.0",
@@ -28,11 +28,11 @@
"chai": "^5.2.0",
"husky": "^9.1.7",
"jest": "^29.7.0",
- "knip": "^5.45.0",
+ "knip": "^5.46.0",
"mocha": "^11.1.0",
"nyc": "^17.1.0",
- "oclif": "^4.17.34",
- "shx": "^0.3.4",
+ "oclif": "^4.17.37",
+ "shx": "^0.4.0",
"ts-jest": "^29.2.6",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
From 0fa8622568bc68e071d592f430098697dbd77095 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Mon, 17 Mar 2025 14:53:46 +0100
Subject: [PATCH 24/55] fix: fast-xml-parser configuration
---
src/merger/XmlMerger.ts | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 15bad14..2f1326f 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -5,21 +5,23 @@ const XML_DECL = '<?xml version="1.0" encoding="UTF-8"?>\n'
const XML_COMMENT_PROP_NAME = '#xml__comment'
const parserOptions = {
+ commentPropName: XML_COMMENT_PROP_NAME,
ignoreAttributes: false,
- parseTagValue: false,
- parseAttributeValue: false,
- cdataPropName: '__cdata',
- ignoreDeclaration: true,
+ ignoreNameSpace: false,
numberParseOptions: { leadingZeros: false, hex: false },
- commentPropName: XML_COMMENT_PROP_NAME,
+ parseAttributeValue: false,
+ parseNodeValue: false,
+ parseTagValue: false,
+ processEntities: false,
+ trimValues: true,
}
const builderOptions = {
+ ...parserOptions,
format: true,
indentBy: ' ',
- ignoreAttributes: false,
- cdataPropName: '__cdata',
- commentPropName: XML_COMMENT_PROP_NAME,
+ suppressBooleanAttributes: false,
+ suppressEmptyNode: false,
}
const correctComments = (xml: string): string =>
From 631d73694185c368ced304e5a0d5a49e4ac35a06 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Wed, 19 Mar 2025 13:47:18 +0100
Subject: [PATCH 25/55] feat: merge and conflict rewrite with recursivity
---
src/commands/git/merge/driver/beta.ts | 34 ++
src/driver/MergeDriver.ts | 10 +
src/merger/JsonMerger.ts | 571 ++++++++++++++++++++------
src/merger/XmlMerger.ts | 103 ++++-
4 files changed, 575 insertions(+), 143 deletions(-)
create mode 100644 src/commands/git/merge/driver/beta.ts
diff --git a/src/commands/git/merge/driver/beta.ts b/src/commands/git/merge/driver/beta.ts
new file mode 100644
index 0000000..9f6ea20
--- /dev/null
+++ b/src/commands/git/merge/driver/beta.ts
@@ -0,0 +1,34 @@
+import { Messages } from '@salesforce/core'
+import { Flags, SfCommand } from '@salesforce/sf-plugins-core'
+import { MergeDriver } from '../../../../driver/MergeDriver.js'
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+const messages = Messages.loadMessages('sf-git-merge-driver', 'run')
+
+export default class Beta extends SfCommand<void> {
+ public static override readonly summary = messages.getMessage('summary')
+ public static override readonly description =
+ messages.getMessage('description')
+ public static override readonly examples = messages.getMessages('examples')
+
+ public static override readonly flags = {
+ 'ancestor-file': Flags.string({
+ char: 'a',
+ summary: messages.getMessage('flags.ancestor-file.summary'),
+ required: true,
+ exists: true,
+ }),
+ 'output-file': Flags.string({
+ char: 'p',
+ summary: messages.getMessage('flags.output-file.summary'),
+ required: true,
+ exists: true,
+ }),
+ }
+
+ public async run(): Promise<void> {
+ const { flags } = await this.parse(Beta)
+ const mergeDriver = new MergeDriver()
+ await mergeDriver.copyFiles(flags['ancestor-file'], flags['output-file'])
+ }
+}
diff --git a/src/driver/MergeDriver.ts b/src/driver/MergeDriver.ts
index 872fda3..405eaf5 100644
--- a/src/driver/MergeDriver.ts
+++ b/src/driver/MergeDriver.ts
@@ -21,4 +21,14 @@ export class MergeDriver {
// Write the merged content to the output file
await writeFile(outputFile, mergedContent)
}
+
+ async copyFiles(ancestorFile, outputFile) {
+ const ancestorContent = await readFile(ancestorFile, 'utf8')
+ console.dir(ancestorContent, { depth: null })
+
+ const xmlMerger = new XmlMerger()
+ const mergedContent = xmlMerger.parseThenBuild(ancestorContent)
+ console.dir(mergedContent, { depth: null })
+ await writeFile(outputFile, mergedContent)
+ }
}
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 5a6ceba..f973ec9 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,4 +1,4 @@
-import { castArray, differenceWith, isEqual, isNil, unionWith } from 'lodash-es'
+import { castArray, isEqual, isNil, keyBy, unionWith } from 'lodash-es' // , differenceWith
import { KEY_FIELD_METADATA } from '../constant/metadataConstant.js'
export type JsonValue =
@@ -20,80 +20,254 @@ export class JsonMerger {
* Main entry point for merging JSON values
*/
mergeObjects(
- ancestor: JsonValue | undefined,
- ours: JsonValue,
- theirs: JsonValue
- ): JsonValue {
- // Handle root object (e.g., Profile)
- if (
- typeof ours === 'object' &&
- ours !== null &&
- !Array.isArray(ours) &&
- typeof theirs === 'object' &&
- theirs !== null &&
- !Array.isArray(theirs)
- ) {
- // Get the base attribute (e.g., Profile)
- const baseKey = Object.keys(ours)[0]
- if (baseKey && Object.keys(theirs)[0] === baseKey) {
- const result = { ...ours } as JsonObject
-
- // Get the content of the base attribute
- const ourContent = ours[baseKey] as JsonObject
- const theirContent = theirs[baseKey] as JsonObject
- const ancestorContent =
- ancestor &&
- typeof ancestor === 'object' &&
- !Array.isArray(ancestor) &&
- baseKey in ancestor
- ? ((ancestor as JsonObject)[baseKey] as JsonObject)
- : {}
-
- // Get all properties from both contents
- const allProperties = new Set([
- ...Object.keys(ourContent),
- ...Object.keys(theirContent),
- ])
-
- // Process each property
- const mergedContent = { ...ourContent } as JsonObject
- for (const property of allProperties) {
- // Skip if property doesn't exist in their content
- if (!(property in theirContent)) continue
-
- // Use their version if property doesn't exist in our content
- if (!(property in mergedContent)) {
- mergedContent[property] = this.ensureArray(theirContent[property])
- continue
+ ancestor: JsonObject | JsonArray,
+ ours: JsonObject | JsonArray,
+ theirs: JsonObject | JsonArray,
+ parent?: JsonObject | JsonArray //,
+ // attrib?: string
+ ): JsonArray {
+ // Get all properties from three ways
+ const allProperties = new Set([
+ ...Object.keys(ancestor),
+ ...Object.keys(ours),
+ ...Object.keys(theirs),
+ ])
+
+ // Process each property
+ const mergedContent = [] as JsonArray
+ for (const property of allProperties) {
+ switch (
+ this.getAttributePrimarytype(
+ ancestor[property],
+ ours[property],
+ theirs[property]
+ )
+ ) {
+ case 'object': {
+ const propObject = {}
+ propObject[property] = []
+ if (parent) {
+ propObject[property].push(
+ ...this.mergeArrays(
+ this.ensureArray(ancestor[property]),
+ this.ensureArray(ours[property]),
+ this.ensureArray(theirs[property]),
+ this.ensureArray(parent),
+ this.getKeyField(property)
+ )
+ )
+ } else {
+ propObject[property].push(
+ ...this.mergeObjects(
+ ancestor[property],
+ ours[property],
+ theirs[property],
+ propObject
+ )
+ )
}
-
- // Ensure both values are arrays
- const ourArray = this.ensureArray(mergedContent[property])
- const theirArray = this.ensureArray(theirContent[property])
- const ancestorArray =
- property in ancestorContent
- ? this.ensureArray(ancestorContent[property])
- : []
-
- // Get the key field for this property if available
- const keyField = this.getKeyField(property)
-
- // Merge the arrays
- mergedContent[property] = this.mergeArrays(
- ancestorArray,
- ourArray,
- theirArray,
- keyField
- )
+ mergedContent.push(propObject)
+ break
}
-
- result[baseKey] = mergedContent
- return result
+ default:
+ if (property.startsWith('@_') && parent) {
+ if (parent[':@']) {
+ parent[':@'][property] = ancestor[property]
+ } else {
+ parent[':@'] = {}
+ parent[':@'][property] = ancestor[property]
+ }
+ } else {
+ mergedContent.push(
+ ...this.mergeTextAttribute(
+ property,
+ ancestor[property],
+ ours[property],
+ theirs[property]
+ )
+ )
+ }
+ break
}
}
- // Default to our version for other cases
- return ours
+ return mergedContent
+ // Handle root object (e.g., Profile)
+ // if (
+ // typeof ours === 'object' &&
+ // ours !== null &&
+ // !Array.isArray(ours) &&
+ // typeof theirs === 'object' &&
+ // theirs !== null &&
+ // !Array.isArray(theirs)
+ // ) {
+ // // Get the base attribute (e.g., Profile)
+ // const baseKey = Object.keys(ours)[0]
+ // if (baseKey && Object.keys(theirs)[0] === baseKey) {
+ // const result = { ...ours } as JsonObject
+
+ // // Get the content of the base attribute
+ // const ourContent = ours[baseKey] as JsonObject
+ // const theirContent = theirs[baseKey] as JsonObject
+ // const ancestorContent =
+ // ancestor &&
+ // typeof ancestor === 'object' &&
+ // !Array.isArray(ancestor) &&
+ // baseKey in ancestor
+ // ? ((ancestor as JsonObject)[baseKey] as JsonObject)
+ // : {}
+
+ // // Get all properties from both contents
+ // const allProperties = new Set([
+ // ...Object.keys(ourContent),
+ // ...Object.keys(theirContent),
+ // ])
+
+ // // Process each property
+ // const mergedContent = { ...ourContent } as JsonObject
+ // for (const property of allProperties) {
+ // // Skip if property doesn't exist in their content
+ // if (!(property in theirContent)) continue
+
+ // // Use their version if property doesn't exist in our content
+ // if (!(property in mergedContent)) {
+ // mergedContent[property] = this.ensureArray(theirContent[property])
+ // continue
+ // }
+
+ // // Ensure both values are arrays
+ // const ourArray = this.ensureArray(mergedContent[property])
+ // const theirArray = this.ensureArray(theirContent[property])
+ // const ancestorArray =
+ // property in ancestorContent
+ // ? this.ensureArray(ancestorContent[property])
+ // : []
+
+ // // Get the key field for this property if available
+ // const keyField = this.getKeyField(property)
+
+ // // Merge the arrays
+ // mergedContent[property] = this.mergeArrays(
+ // ancestorArray,
+ // ourArray,
+ // theirArray,
+ // keyField
+ // )
+ // }
+
+ // result[baseKey] = mergedContent
+ // return result
+ // }
+ // }
+
+ // // Default to our version for other cases
+ // return ours
+ }
+
+ private mergeTextAttribute(
+ attrib: string,
+ ancestor: JsonValue | null,
+ ours: JsonValue | null,
+ theirs: JsonValue | null
+ ): JsonArray {
+ const objAnc: JsonObject = {}
+ const objOurs: JsonObject = {}
+ const objTheirs: JsonObject = {}
+ let caseCode: number = 0
+ if (!isNil(ancestor)) {
+ objAnc[attrib] = [{ '#text': ancestor }]
+ caseCode += 100
+ }
+ if (!isNil(ours)) {
+ objOurs[attrib] = [{ '#text': ours }]
+ caseCode += 10
+ }
+ if (!isNil(theirs)) {
+ objTheirs[attrib] = [{ '#text': theirs }]
+ caseCode += 1
+ }
+ switch (caseCode) {
+ case 1:
+ return [objTheirs]
+ case 10:
+ return [objOurs]
+ case 11:
+ if (ours === theirs) {
+ return [objOurs]
+ } else {
+ const arr: JsonArray = []
+ arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push(objOurs)
+ arr.push({ '#text': '||||||| BASE' })
+ arr.push({ '#text': '=======' })
+ arr.push(objTheirs)
+ arr.push({ '#text': '>>>>>>> REMOTE' })
+ return arr
+ }
+ case 100:
+ return []
+ case 101:
+ if (ancestor === theirs) {
+ return []
+ } else {
+ const arr: JsonArray = []
+ arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push({ '#text': '||||||| BASE' })
+ arr.push(objAnc)
+ arr.push({ '#text': '=======' })
+ arr.push(objTheirs)
+ arr.push({ '#text': '>>>>>>> REMOTE' })
+ return arr
+ }
+ case 110:
+ if (ancestor === ours) {
+ return []
+ } else {
+ const arr: JsonArray = []
+ arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push(objOurs)
+ arr.push({ '#text': '||||||| BASE' })
+ arr.push(objAnc)
+ arr.push({ '#text': '=======' })
+ arr.push({ '#text': '>>>>>>> REMOTE' })
+ return arr
+ }
+ case 111:
+ if (ours === theirs) {
+ return [objOurs]
+ } else if (ancestor === ours) {
+ return [objTheirs]
+ } else if (ancestor === theirs) {
+ return [objOurs]
+ } else {
+ const arr: JsonArray = []
+ arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push(objOurs)
+ arr.push({ '#text': '||||||| BASE' })
+ arr.push(objAnc)
+ arr.push({ '#text': '=======' })
+ arr.push(objTheirs)
+ arr.push({ '#text': '>>>>>>> REMOTE' })
+ return arr
+ }
+ default:
+ return []
+ }
+ }
+
+ /**
+ * Gets the typeof of the attribute
+ */
+ private getAttributePrimarytype(
+ ancestor: JsonValue | undefined | null,
+ ours: JsonValue | undefined | null,
+ theirs: JsonValue | undefined | null
+ ): string {
+ return isNil(ancestor)
+ ? isNil(ours)
+ ? typeof theirs
+ : typeof ours
+ : typeof ancestor
}
/**
@@ -119,6 +293,7 @@ export class JsonMerger {
ancestor: JsonArray,
ours: JsonArray,
theirs: JsonArray,
+ parent: JsonArray,
keyField?: string
): JsonArray {
// If no key field, use unionWith to merge arrays without duplicates
@@ -132,7 +307,7 @@ export class JsonMerger {
}
// Merge using key field
- return this.mergeByKeyField(ancestor, ours, theirs, keyField)
+ return this.mergeByKeyField(ancestor, ours, theirs, keyField, parent)
}
/**
@@ -172,77 +347,211 @@ export class JsonMerger {
ancestor: JsonArray,
ours: JsonArray,
theirs: JsonArray,
- keyField: string
+ keyField: string,
+ parent: JsonArray
): JsonArray {
- const result = [...ours]
- const processed = new Set<string>()
-
- // Create maps for efficient lookups
- const ourMap = new Map<string, JsonValue>()
- const theirMap = new Map<string, JsonValue>()
- const ancestorMap = new Map<string, JsonValue>()
-
- // Populate maps
- for (const item of ours) {
- const key = this.getItemKey(item, keyField)
- if (key) ourMap.set(key, item)
+ const finalArray: JsonArray = []
+ let caseCode: number = 0
+ if (ancestor.length == 0) {
+ caseCode += 100
}
-
- for (const item of theirs) {
- const key = this.getItemKey(item, keyField)
- if (key) theirMap.set(key, item)
+ if (ours.length == 0) {
+ caseCode += 10
}
-
- for (const item of ancestor) {
- const key = this.getItemKey(item, keyField)
- if (key) ancestorMap.set(key, item)
+ if (theirs.length == 0) {
+ caseCode += 1
}
+ switch (caseCode) {
+ case 1:
+ return this.mergeObjects({}, {}, theirs, parent)
+ case 10:
+ return this.mergeObjects({}, ours, {}, parent)
+ case 100:
+ return []
+ }
+ const keyedAnc = keyBy(ancestor, keyField)
+ const keyedOurs = keyBy(ours, keyField)
+ const keyedTheirs = keyBy(theirs, keyField)
+ const allKeys = new Set([
+ ...Object.keys(keyedAnc),
+ ...Object.keys(keyedOurs),
+ ...Object.keys(keyedTheirs),
+ ])
+ for (const key of allKeys) {
+ caseCode = 0
+ if (keyedAnc[key]) {
+ caseCode += 100
+ }
+ if (keyedOurs[key]) {
+ caseCode += 10
+ }
+ if (keyedTheirs[key]) {
+ caseCode += 1
+ }
+ // console.log('caseCode: ' + caseCode);
- // Process items in our version
- for (let i = 0; i < result.length; i++) {
- const key = this.getItemKey(result[i], keyField)
- if (!key) continue
-
- processed.add(key)
-
- // If item exists in both versions
- if (theirMap.has(key)) {
- const theirItem = theirMap.get(key)!
- const ancestorItem = ancestorMap.get(key)
-
- // If they changed it from ancestor but we didn't, use their version
- if (
- !isEqual(theirItem, ancestorItem) &&
- isEqual(result[i], ancestorItem)
- ) {
- result[i] = theirItem
- }
+ switch (caseCode) {
+ case 1:
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
+ )
+ break
+ case 10:
+ finalArray.push(...this.mergeObjects({}, {}, keyedOurs[key], parent))
+ break
+ case 100:
+ break
+ case 11:
+ if (isEqual(ours, theirs)) {
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent)
+ )
+ } else {
+ finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent)
+ )
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '=======' })
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
+ )
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ }
+ break
+ case 101:
+ if (!isEqual(ancestor, theirs)) {
+ finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push(...this.mergeObjects({}, {}, keyedAnc[key], parent))
+ finalArray.push({ '#text': '=======' })
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
+ )
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ }
+ break
+ case 110:
+ if (!isEqual(ancestor, ours)) {
+ finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent)
+ )
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push(...this.mergeObjects({}, {}, keyedAnc[key], parent))
+ finalArray.push({ '#text': '=======' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ }
+ break
+ case 111:
+ if (isEqual(ours, theirs)) {
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent)
+ )
+ } else if (isEqual(ancestor, ours)) {
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
+ )
+ } else if (isEqual(ancestor, theirs)) {
+ finalArray.push(
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent)
+ )
+ } else {
+ // finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ // finalArray.push(...this.mergeObjects({}, {}, keyedOurs[key], parent))
+ // finalArray.push({ '#text': '||||||| BASE' })
+ // finalArray.push(...this.mergeObjects({}, {}, keyedAnc[key], parent))
+ // finalArray.push({ '#text': '=======' })
+ // finalArray.push(...this.mergeObjects({}, {}, keyedTheirs[key], parent))
+ // finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ finalArray.push(
+ ...this.mergeObjects(
+ keyedAnc[key],
+ keyedOurs[key],
+ keyedTheirs[key],
+ parent
+ )
+ )
+ }
+ break
+ default:
}
}
- // Add items that only exist in their version
- const uniqueTheirItems = differenceWith(
- Array.from(theirMap.values()),
- result,
- (a, b) => this.getItemKey(a, keyField) === this.getItemKey(b, keyField)
- )
- result.push(...uniqueTheirItems)
-
- return result
+ return finalArray
+ // original by scolladon
+ // const result = [...ours]
+ // const processed = new Set<string>()
+
+ // // Create maps for efficient lookups
+ // const ourMap = new Map<string, JsonValue>()
+ // const theirMap = new Map<string, JsonValue>()
+ // const ancestorMap = new Map<string, JsonValue>()
+
+ // // Populate maps
+ // for (const item of ours) {
+ // const key = this.getItemKey(item, keyField)
+ // if (key) ourMap.set(key, item)
+ // }
+
+ // for (const item of theirs) {
+ // const key = this.getItemKey(item, keyField)
+ // if (key) theirMap.set(key, item)
+ // }
+
+ // for (const item of ancestor) {
+ // const key = this.getItemKey(item, keyField)
+ // if (key) ancestorMap.set(key, item)
+ // }
+
+ // // Process items in our version
+ // for (let i = 0; i < result.length; i++) {
+ // const key = this.getItemKey(result[i], keyField)
+ // if (!key) continue
+
+ // processed.add(key)
+
+ // // If item exists in both versions
+ // if (theirMap.has(key)) {
+ // const theirItem = theirMap.get(key)!
+ // const ancestorItem = ancestorMap.get(key)
+
+ // // If they changed it from ancestor but we didn't, use their version
+ // if (
+ // !isEqual(theirItem, ancestorItem) &&
+ // isEqual(result[i], ancestorItem)
+ // ) {
+ // result[i] = theirItem
+ // }
+ // }
+ // }
+
+ // // Add items that only exist in their version
+ // const uniqueTheirItems = differenceWith(
+ // Array.from(theirMap.values()),
+ // result,
+ // (a, b) => this.getItemKey(a, keyField) === this.getItemKey(b, keyField)
+ // )
+ // result.push(...uniqueTheirItems)
+
+ // return result
}
/**
* Gets the key value for an item using the specified key field
*/
- private getItemKey(item: JsonValue, keyField: string): string | undefined {
- if (
- typeof item === 'object' &&
- item !== null &&
- !Array.isArray(item) &&
- keyField in item
- ) {
- return String(item[keyField])
- }
- return undefined
- }
+ // private getItemKey(item: JsonValue, keyField: string): string | undefined {
+ // if (
+ // typeof item === 'object' &&
+ // item !== null &&
+ // !Array.isArray(item) &&
+ // keyField in item
+ // ) {
+ // return String(item[keyField])
+ // }
+ // return undefined
+ // }
}
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 2f1326f..2d4cb1d 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -5,30 +5,38 @@ const XML_DECL = '<?xml version="1.0" encoding="UTF-8"?>\n'
const XML_COMMENT_PROP_NAME = '#xml__comment'
const parserOptions = {
- commentPropName: XML_COMMENT_PROP_NAME,
ignoreAttributes: false,
- ignoreNameSpace: false,
- numberParseOptions: { leadingZeros: false, hex: false },
- parseAttributeValue: false,
- parseNodeValue: false,
parseTagValue: false,
- processEntities: false,
- trimValues: true,
+ parseAttributeValue: false,
+ cdataPropName: '__cdata',
+ ignoreDeclaration: true,
+ numberParseOptions: { leadingZeros: false, hex: false },
+ commentPropName: XML_COMMENT_PROP_NAME,
+ // preserveOrder: true,
}
const builderOptions = {
- ...parserOptions,
format: true,
indentBy: ' ',
- suppressBooleanAttributes: false,
- suppressEmptyNode: false,
+ ignoreAttributes: false,
+ cdataPropName: '__cdata',
+ commentPropName: XML_COMMENT_PROP_NAME,
+ preserveOrder: true,
}
const correctComments = (xml: string): string =>
xml.includes('<!--') ? xml.replace(/\s+<!--(.*?)-->\s+/g, '<!--$1-->') : xml
+const correctConflictIndent = (xml: string): string =>
+ xml
+ .replace(/[ \t]+(<<<<<<<|\|\|\|\|\|\|\||=======|>>>>>>>)/g, '$1')
+ .replace(/^[ \t]*[\n\r]+/gm, '')
+
const handleSpecialEntities = (xml: string): string =>
- xml.replaceAll('&#160;', ' ')
+ xml
+ .replaceAll('&#160;', ' ')
+ .replaceAll('<', '<')
+ .replaceAll('>', '>')
export class XmlMerger {
tripartXmlMerge(
@@ -41,15 +49,86 @@ export class XmlMerger {
const ancestorObj = parser.parse(ancestorContent)
const ourObj = parser.parse(ourContent)
const theirObj = parser.parse(theirContent)
+ // console.log('ancestorObj')
+ // console.dir(ancestorObj, {depth:null})
// Perform deep merge of XML objects
const jsonMerger = new JsonMerger()
const mergedObj = jsonMerger.mergeObjects(ancestorObj, ourObj, theirObj)
+ // console.log('mergedObj')
+ // console.dir(mergedObj, {depth:null})
// Convert back to XML and format
const builder = new XMLBuilder(builderOptions)
const mergedXml = builder.build(mergedObj)
- return correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
+ // console.log('mergedXml')
+ // console.dir(mergedXml, {depth:null})
+ return correctConflictIndent(
+ correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
+ )
+ }
+
+ parseThenBuild(ancestorContent: string) {
+ const parser = new XMLParser(parserOptions)
+
+ const ancestorObj = parser.parse(ancestorContent)
+ console.dir(ancestorObj, { depth: null })
+
+ // const testObj = {
+ // CustomLabels: {
+ // labels: {
+ // fullName: 'tested_label',
+ // value: '\n<<<<<<< LOCAL\nthis is ancestor label\n=======\nthis is theirs label\n>>>>>>> REMOTE\n',
+ // language: 'fr',
+ // protected: 'false',
+ // shortDescription: 'this is ancestor label'
+ // },
+ // '@_xmlns': 'http://soap.sforce.com/2006/04/metadata'
+ // }
+ // }
+
+ const testObj = [
+ {
+ CustomLabels: [
+ {
+ labels: [
+ { fullName: [{ '#text': 'tested_label' }] },
+ { '#text': '<<<<<<< LOCAL' },
+ { value: [{ '#text': 'this is ancestor label' }] },
+ { '#text': '||||||| base' },
+ { value: [{ '#text': 'this is ancestor label' }] },
+ { '#text': '=======' },
+ { value: [{ '#text': 'this is theirs label' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ { language: [{ '#text': 'fr' }] },
+ { protected: [{ '#text': 'false' }] },
+ {
+ shortDescription: [{ '#text': 'this is ancestor label' }],
+ },
+ ],
+ },
+ {
+ labels: [
+ { fullName: [{ '#text': 'without conflict' }] },
+ { value: [{ '#text': 'all good' }] },
+ { language: [{ '#text': 'fr' }] },
+ { protected: [{ '#text': 'false' }] },
+ {
+ shortDescription: [{ '#text': 'all good' }],
+ },
+ ],
+ },
+ ],
+ ':@': { '@_xmlns': 'http://soap.sforce.com/2006/04/metadata' },
+ },
+ ]
+
+ const builder = new XMLBuilder(builderOptions)
+ const mergedXml = builder.build(testObj)
+ console.dir(mergedXml, { depth: null })
+ return correctConflictIndent(
+ correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
+ )
}
}
From 9e8d39f128214f2fbae862fe334e72a144f1c1f7 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Wed, 19 Mar 2025 14:09:48 +0100
Subject: [PATCH 26/55] fix: remove beta poc command
---
README.md | 96 +++++++++++++++++++++++++++
src/commands/git/merge/driver/beta.ts | 34 ----------
src/driver/MergeDriver.ts | 10 ---
src/merger/XmlMerger.ts | 63 ------------------
4 files changed, 96 insertions(+), 107 deletions(-)
delete mode 100644 src/commands/git/merge/driver/beta.ts
diff --git a/README.md b/README.md
index 9481b46..df15c18 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,102 @@ EXAMPLES
$ sf git merge driver install
```
+_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/install.ts)_
+
+## `sf git merge driver run`
+
+Runs the merge driver for the specified files.
+
+```
+USAGE
+ $ sf git merge driver run -a <value> -o <value> -t <value> -p <value> [--json] [--flags-dir <value>]
+
+FLAGS
+ -a, --ancestor-file=<value> (required) path to the common ancestor version of the file
+ -o, --our-file=<value> (required) path to our version of the file
+ -p, --output-file=<value> (required) path to the file where the merged content will be written
+ -t, --theirs-file=<value> (required) path to their version of the file
+
+GLOBAL FLAGS
+ --flags-dir=<value> Import flag values from a directory.
+ --json Format output as json.
+
+DESCRIPTION
+ Runs the merge driver for the specified files.
+
+ Runs the merge driver for the specified files, handling the merge conflict resolution using Salesforce-specific merge
+ strategies. This command is typically called automatically by Git when a merge conflict is detected.
+
+EXAMPLES
+ Run the merge driver for conflicting files:
+
+ $ sf git merge driver run --ancestor-file=<value> --our-file=<value> --theirs-file=<value> --output-file=<value>
+
+ Where:
+ - ancestor-file is the path to the common ancestor version of the file
+ - our-file is the path to our version of the file
+ - their-file is the path to their version of the file
+ - output-file is the path to the file where the merged content will be written
+```
+
+_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/run.ts)_
+
+## `sf git merge driver uninstall`
+
+Uninstalls the local git merge driver for the given org and branch.
+
+```
+USAGE
+ $ sf git merge driver uninstall [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+ --flags-dir=<value> Import flag values from a directory.
+ --json Format output as json.
+
+DESCRIPTION
+ Uninstalls the local git merge driver for the given org and branch.
+
+ Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the
+ `.gitattributes` files in the project, deleting the merge driver configuration from the `.git/config` of the project,
+ and removing the installed binary from the node_modules/.bin directory.
+
+EXAMPLES
+ Uninstall the driver for a given project:
+
+ $ sf git merge driver uninstall
+```
+
+_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/uninstall.ts)_
+<!-- commandsstop -->
+* [`sf git merge driver install`](#sf-git-merge-driver-install)
+* [`sf git merge driver run`](#sf-git-merge-driver-run)
+* [`sf git merge driver uninstall`](#sf-git-merge-driver-uninstall)
+
+## `sf git merge driver install`
+
+Installs a local git merge driver for the given org and branch.
+
+```
+USAGE
+ $ sf git merge driver install [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+ --flags-dir=<value> Import flag values from a directory.
+ --json Format output as json.
+
+DESCRIPTION
+ Installs a local git merge driver for the given org and branch.
+
+ Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project,
+ creating a new merge driver configuration in the `.git/config` of the project, and installing the binary in the
+ node_modules/.bin directory.
+
+EXAMPLES
+ Install the driver for a given project:
+
+ $ sf git merge driver install
+```
+
_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/install.ts)_
## `sf git merge driver run`
diff --git a/src/commands/git/merge/driver/beta.ts b/src/commands/git/merge/driver/beta.ts
deleted file mode 100644
index 9f6ea20..0000000
--- a/src/commands/git/merge/driver/beta.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-import { Messages } from '@salesforce/core'
-import { Flags, SfCommand } from '@salesforce/sf-plugins-core'
-import { MergeDriver } from '../../../../driver/MergeDriver.js'
-
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
-const messages = Messages.loadMessages('sf-git-merge-driver', 'run')
-
-export default class Beta extends SfCommand<void> {
- public static override readonly summary = messages.getMessage('summary')
- public static override readonly description =
- messages.getMessage('description')
- public static override readonly examples = messages.getMessages('examples')
-
- public static override readonly flags = {
- 'ancestor-file': Flags.string({
- char: 'a',
- summary: messages.getMessage('flags.ancestor-file.summary'),
- required: true,
- exists: true,
- }),
- 'output-file': Flags.string({
- char: 'p',
- summary: messages.getMessage('flags.output-file.summary'),
- required: true,
- exists: true,
- }),
- }
-
- public async run(): Promise<void> {
- const { flags } = await this.parse(Beta)
- const mergeDriver = new MergeDriver()
- await mergeDriver.copyFiles(flags['ancestor-file'], flags['output-file'])
- }
-}
diff --git a/src/driver/MergeDriver.ts b/src/driver/MergeDriver.ts
index 405eaf5..872fda3 100644
--- a/src/driver/MergeDriver.ts
+++ b/src/driver/MergeDriver.ts
@@ -21,14 +21,4 @@ export class MergeDriver {
// Write the merged content to the output file
await writeFile(outputFile, mergedContent)
}
-
- async copyFiles(ancestorFile, outputFile) {
- const ancestorContent = await readFile(ancestorFile, 'utf8')
- console.dir(ancestorContent, { depth: null })
-
- const xmlMerger = new XmlMerger()
- const mergedContent = xmlMerger.parseThenBuild(ancestorContent)
- console.dir(mergedContent, { depth: null })
- await writeFile(outputFile, mergedContent)
- }
}
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 2d4cb1d..9ac2378 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -68,67 +68,4 @@ export class XmlMerger {
correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
)
}
-
- parseThenBuild(ancestorContent: string) {
- const parser = new XMLParser(parserOptions)
-
- const ancestorObj = parser.parse(ancestorContent)
- console.dir(ancestorObj, { depth: null })
-
- // const testObj = {
- // CustomLabels: {
- // labels: {
- // fullName: 'tested_label',
- // value: '\n<<<<<<< LOCAL\nthis is ancestor label\n=======\nthis is theirs label\n>>>>>>> REMOTE\n',
- // language: 'fr',
- // protected: 'false',
- // shortDescription: 'this is ancestor label'
- // },
- // '@_xmlns': 'http://soap.sforce.com/2006/04/metadata'
- // }
- // }
-
- const testObj = [
- {
- CustomLabels: [
- {
- labels: [
- { fullName: [{ '#text': 'tested_label' }] },
- { '#text': '<<<<<<< LOCAL' },
- { value: [{ '#text': 'this is ancestor label' }] },
- { '#text': '||||||| base' },
- { value: [{ '#text': 'this is ancestor label' }] },
- { '#text': '=======' },
- { value: [{ '#text': 'this is theirs label' }] },
- { '#text': '>>>>>>> REMOTE' },
- { language: [{ '#text': 'fr' }] },
- { protected: [{ '#text': 'false' }] },
- {
- shortDescription: [{ '#text': 'this is ancestor label' }],
- },
- ],
- },
- {
- labels: [
- { fullName: [{ '#text': 'without conflict' }] },
- { value: [{ '#text': 'all good' }] },
- { language: [{ '#text': 'fr' }] },
- { protected: [{ '#text': 'false' }] },
- {
- shortDescription: [{ '#text': 'all good' }],
- },
- ],
- },
- ],
- ':@': { '@_xmlns': 'http://soap.sforce.com/2006/04/metadata' },
- },
- ]
-
- const builder = new XMLBuilder(builderOptions)
- const mergedXml = builder.build(testObj)
- console.dir(mergedXml, { depth: null })
- return correctConflictIndent(
- correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
- )
- }
}
From 67aae5fb498bc0385b8b999ce94559c19a154b54 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Wed, 19 Mar 2025 14:23:32 +0100
Subject: [PATCH 27/55] fix: install unstall xmlmerge test fix
---
src/merger/XmlMerger.ts | 4 ++--
test/integration/install.nut.ts | 6 +++---
test/integration/uninstall.nut.ts | 4 ++--
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 9ac2378..e1b6069 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -35,8 +35,8 @@ const correctConflictIndent = (xml: string): string =>
const handleSpecialEntities = (xml: string): string =>
xml
.replaceAll('&#160;', ' ')
- .replaceAll('<', '<')
- .replaceAll('>', '>')
+ .replaceAll('<<<<<<<', '<<<<<<<')
+ .replaceAll('>>>>>>>', '>>>>>>>')
export class XmlMerger {
tripartXmlMerge(
diff --git a/test/integration/install.nut.ts b/test/integration/install.nut.ts
index 9a9b2cd..bb38707 100644
--- a/test/integration/install.nut.ts
+++ b/test/integration/install.nut.ts
@@ -20,14 +20,14 @@ describe('git merge driver install', () => {
after(() => {
// Clean up by removing .git folder and .gitattributes file
- execSync('rm -rf .git', {
+ execSync('shx rm -rf .git', {
cwd: ROOT_FOLDER,
})
- execSync('rm -rf node_modules', {
+ execSync('shx rm -rf node_modules', {
cwd: ROOT_FOLDER,
})
if (existsSync(join(ROOT_FOLDER, '.gitattributes'))) {
- execSync(`rm .gitattributes`, {
+ execSync(`shx rm .gitattributes`, {
cwd: ROOT_FOLDER,
})
}
diff --git a/test/integration/uninstall.nut.ts b/test/integration/uninstall.nut.ts
index acda829..fbc7a3e 100644
--- a/test/integration/uninstall.nut.ts
+++ b/test/integration/uninstall.nut.ts
@@ -17,11 +17,11 @@ describe('git merge driver uninstall', () => {
after(() => {
// Clean up by removing .git folder and .gitattributes file
- execSync('rm -rf .git', {
+ execSync('shx rm -rf .git', {
cwd: ROOT_FOLDER,
})
- execSync('rm .gitattributes', {
+ execSync('shx rm .gitattributes', {
cwd: ROOT_FOLDER,
})
})
From ef9f90a9242dc382e889b32ecd8a9e549c5da482 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 20 Mar 2025 12:28:56 +0100
Subject: [PATCH 28/55] fix: proper jsonmerger test and fix mergearray algo
---
src/merger/JsonMerger.ts | 219 +++++++++++------
src/merger/XmlMerger.ts | 2 +-
test/unit/merger/JsonMerger.test.ts | 363 +++++++++++++++++++---------
3 files changed, 400 insertions(+), 184 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index f973ec9..cbce092 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -27,11 +27,23 @@ export class JsonMerger {
// attrib?: string
): JsonArray {
// Get all properties from three ways
- const allProperties = new Set([
- ...Object.keys(ancestor),
- ...Object.keys(ours),
- ...Object.keys(theirs),
- ])
+ const arrProperties: string[] = []
+ if (ancestor && !isEqual(ancestor, {})) {
+ arrProperties.push(...Object.keys(ancestor))
+ } else {
+ ancestor = {}
+ }
+ if (ours && !isEqual(ours, {})) {
+ arrProperties.push(...Object.keys(ours))
+ } else {
+ ours = {}
+ }
+ if (theirs && !isEqual(theirs, {})) {
+ arrProperties.push(...Object.keys(theirs))
+ } else {
+ theirs = {}
+ }
+ const allProperties = new Set(arrProperties.sort())
// Process each property
const mergedContent = [] as JsonArray
@@ -44,19 +56,20 @@ export class JsonMerger {
)
) {
case 'object': {
- const propObject = {}
- propObject[property] = []
if (parent) {
- propObject[property].push(
+ mergedContent.push(
...this.mergeArrays(
this.ensureArray(ancestor[property]),
this.ensureArray(ours[property]),
this.ensureArray(theirs[property]),
this.ensureArray(parent),
+ property,
this.getKeyField(property)
)
)
} else {
+ const propObject = {}
+ propObject[property] = []
propObject[property].push(
...this.mergeObjects(
ancestor[property],
@@ -65,8 +78,8 @@ export class JsonMerger {
propObject
)
)
+ mergedContent.push(propObject)
}
- mergedContent.push(propObject)
break
}
default:
@@ -199,6 +212,7 @@ export class JsonMerger {
arr.push({ '#text': '<<<<<<< LOCAL' })
arr.push(objOurs)
arr.push({ '#text': '||||||| BASE' })
+ arr.push({ '#text': '\n' })
arr.push({ '#text': '=======' })
arr.push(objTheirs)
arr.push({ '#text': '>>>>>>> REMOTE' })
@@ -212,6 +226,7 @@ export class JsonMerger {
} else {
const arr: JsonArray = []
arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push({ '#text': '\n' })
arr.push({ '#text': '||||||| BASE' })
arr.push(objAnc)
arr.push({ '#text': '=======' })
@@ -229,6 +244,7 @@ export class JsonMerger {
arr.push({ '#text': '||||||| BASE' })
arr.push(objAnc)
arr.push({ '#text': '=======' })
+ arr.push({ '#text': '\n' })
arr.push({ '#text': '>>>>>>> REMOTE' })
return arr
}
@@ -294,20 +310,31 @@ export class JsonMerger {
ours: JsonArray,
theirs: JsonArray,
parent: JsonArray,
+ attribute: string,
keyField?: string
): JsonArray {
+ const propObject = {}
// If no key field, use unionWith to merge arrays without duplicates
if (!keyField) {
- return unionWith([...ours], theirs, isEqual)
+ propObject[attribute] = unionWith([...ours], theirs, isEqual)
+ return [propObject]
}
// Special case for array position
if (keyField === '<array>') {
- return this.mergeByPosition(ancestor, ours, theirs)
+ propObject[attribute] = this.mergeByPosition(ancestor, ours, theirs)
+ return [propObject]
}
// Merge using key field
- return this.mergeByKeyField(ancestor, ours, theirs, keyField, parent)
+ return this.mergeByKeyField(
+ ancestor,
+ ours,
+ theirs,
+ keyField,
+ attribute,
+ parent
+ )
}
/**
@@ -348,35 +375,49 @@ export class JsonMerger {
ours: JsonArray,
theirs: JsonArray,
keyField: string,
+ attribute: string,
parent: JsonArray
): JsonArray {
const finalArray: JsonArray = []
let caseCode: number = 0
- if (ancestor.length == 0) {
+ if (ancestor.length !== 0) {
caseCode += 100
}
- if (ours.length == 0) {
+ if (ours.length !== 0) {
caseCode += 10
}
- if (theirs.length == 0) {
+ if (theirs.length !== 0) {
caseCode += 1
}
+ // console.info(
+ // 'attribute: ' +
+ // attribute +
+ // '\nkeyField: ' +
+ // keyField +
+ // '\ncaseCode: ' +
+ // caseCode
+ // )
+ const propObject = {}
switch (caseCode) {
case 1:
- return this.mergeObjects({}, {}, theirs, parent)
+ propObject[attribute] = this.mergeObjects({}, {}, theirs, parent)
+ return [propObject]
case 10:
- return this.mergeObjects({}, ours, {}, parent)
+ propObject[attribute] = this.mergeObjects({}, {}, ours, parent)
+ return [propObject]
case 100:
return []
}
const keyedAnc = keyBy(ancestor, keyField)
const keyedOurs = keyBy(ours, keyField)
const keyedTheirs = keyBy(theirs, keyField)
- const allKeys = new Set([
- ...Object.keys(keyedAnc),
- ...Object.keys(keyedOurs),
- ...Object.keys(keyedTheirs),
- ])
+ const allKeys = new Set(
+ [
+ ...Object.keys(keyedAnc),
+ ...Object.keys(keyedOurs),
+ ...Object.keys(keyedTheirs),
+ ].sort()
+ )
for (const key of allKeys) {
caseCode = 0
if (keyedAnc[key]) {
@@ -389,76 +430,111 @@ export class JsonMerger {
caseCode += 1
}
// console.log('caseCode: ' + caseCode);
-
+ const propObject = {}
switch (caseCode) {
case 1:
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
- )
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
+ ]
+ finalArray.push(propObject)
break
case 10:
- finalArray.push(...this.mergeObjects({}, {}, keyedOurs[key], parent))
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent),
+ ]
+ finalArray.push(propObject)
break
case 100:
break
case 11:
if (isEqual(ours, theirs)) {
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedOurs[key], parent)
- )
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent),
+ ]
+ finalArray.push(propObject)
} else {
- finalArray.push({ '#text': '<<<<<<< LOCAL' })
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedOurs[key], parent)
- )
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '=======' })
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
- )
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ // finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects({}, {}, keyedOurs[key], parent),
+ // ]
+ // finalArray.push(propObject)
+ // finalArray.push({ '#text': '||||||| BASE' })
+ // finalArray.push({ '#text': '\n' })
+ // finalArray.push({ '#text': '=======' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
+ // ]
+ // finalArray.push(propObject)
+ // finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ propObject[attribute] = [
+ ...this.mergeObjects(
+ {},
+ keyedOurs[key],
+ keyedTheirs[key],
+ parent
+ ),
+ ]
+ finalArray.push(propObject)
}
break
case 101:
if (!isEqual(ancestor, theirs)) {
- finalArray.push({ '#text': '<<<<<<< LOCAL' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push(...this.mergeObjects({}, {}, keyedAnc[key], parent))
- finalArray.push({ '#text': '=======' })
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
- )
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ // finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ // finalArray.push({ '#text': '\n' })
+ // finalArray.push({ '#text': '||||||| BASE' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects({}, {}, keyedAnc[key], parent),
+ // ]
+ // finalArray.push(propObject)
+ // finalArray.push({ '#text': '=======' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
+ // ]
+ // finalArray.push(propObject)
+ // finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ propObject[attribute] = [
+ ...this.mergeObjects(keyedAnc[key], {}, keyedTheirs[key], parent),
+ ]
+ finalArray.push(propObject)
}
break
case 110:
if (!isEqual(ancestor, ours)) {
- finalArray.push({ '#text': '<<<<<<< LOCAL' })
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedOurs[key], parent)
- )
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push(...this.mergeObjects({}, {}, keyedAnc[key], parent))
- finalArray.push({ '#text': '=======' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ // finalArray.push({ '#text': '<<<<<<< LOCAL' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects({}, {}, keyedOurs[key], parent),
+ // ]
+ // finalArray.push(propObject)
+ // finalArray.push({ '#text': '||||||| BASE' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects({}, {}, keyedAnc[key], parent),
+ // ]
+ // finalArray.push(propObject)
+ // finalArray.push({ '#text': '=======' })
+ // finalArray.push({ '#text': '\n' })
+ // finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ propObject[attribute] = [
+ ...this.mergeObjects(keyedAnc[key], keyedOurs[key], {}, parent),
+ ]
+ finalArray.push(propObject)
}
break
case 111:
if (isEqual(ours, theirs)) {
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedOurs[key], parent)
- )
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent),
+ ]
+ finalArray.push(propObject)
} else if (isEqual(ancestor, ours)) {
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent)
- )
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
+ ]
+ finalArray.push(propObject)
} else if (isEqual(ancestor, theirs)) {
- finalArray.push(
- ...this.mergeObjects({}, {}, keyedOurs[key], parent)
- )
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent),
+ ]
+ finalArray.push(propObject)
} else {
// finalArray.push({ '#text': '<<<<<<< LOCAL' })
// finalArray.push(...this.mergeObjects({}, {}, keyedOurs[key], parent))
@@ -467,14 +543,15 @@ export class JsonMerger {
// finalArray.push({ '#text': '=======' })
// finalArray.push(...this.mergeObjects({}, {}, keyedTheirs[key], parent))
// finalArray.push({ '#text': '>>>>>>> REMOTE' })
- finalArray.push(
+ propObject[attribute] = [
...this.mergeObjects(
keyedAnc[key],
keyedOurs[key],
keyedTheirs[key],
parent
- )
- )
+ ),
+ ]
+ finalArray.push(propObject)
}
break
default:
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index e1b6069..d3a82c1 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -49,7 +49,7 @@ export class XmlMerger {
const ancestorObj = parser.parse(ancestorContent)
const ourObj = parser.parse(ourContent)
const theirObj = parser.parse(theirContent)
- // console.log('ancestorObj')
+ // console.log('ancestorObj ' + typeof ancestorObj)
// console.dir(ancestorObj, {depth:null})
// Perform deep merge of XML objects
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 3f77e98..8fe6976 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -43,15 +43,33 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'false' },
- { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
+ },
],
},
- })
+ ])
})
it('should handle the scenario when both sides modify the same element', () => {
@@ -84,13 +102,19 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
+ },
],
},
- })
+ ])
})
it('should handle the scenario when we modify an element and they add a new one', () => {
@@ -124,14 +148,26 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'true' },
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
],
},
- })
+ ])
})
})
@@ -160,11 +196,15 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ },
+ ],
},
- })
+ ])
})
it('should handle primitive values in arrays', () => {
@@ -191,11 +231,15 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- values: [1, 4, 5, 2, 6],
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ values: [1, 4, 5, 2, 6],
+ },
+ ],
},
- })
+ ])
})
})
@@ -238,54 +282,69 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- description: ['Our updated description', 'Original description'],
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'true' },
+ expect(result).toEqual([
+ {
+ Profile: [
+ { custom: ['Value1', 'Value3', 'Value2', 'Value4'] },
+ {
+ description: [{ '#text': 'Our updated description' }],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { label: [{ '#text': 'Their Label' }] },
],
- custom: ['Value1', 'Value3', 'Value2', 'Value4'],
- label: ['Their Label'],
},
- })
+ ])
})
})
- describe('given type conflicts', () => {
- it('should prefer our changes when types conflict', () => {
- // Arrange
- const ancestor: JsonValue = {
- settings: { enabled: 'false' },
- }
-
- const ours: JsonValue = {
- settings: ['option1', 'option2'],
- }
-
- const theirs: JsonValue = {
- settings: { enabled: 'true', newSetting: 'value' },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual({
- settings: {
- '0': 'option1',
- '1': 'option2',
- enabled: ['true'],
- newSetting: ['value'],
- },
- })
- })
- })
+ // KGO: removed because should never happen
+ // describe('given type conflicts', () => {
+ // it('should prefer our changes when types conflict', () => {
+ // // Arrange
+ // const ancestor: JsonValue = {
+ // settings: { enabled: 'false' },
+ // }
+
+ // const ours: JsonValue = {
+ // settings: ['option1', 'option2'],
+ // }
+
+ // const theirs: JsonValue = {
+ // settings: { enabled: 'true', newSetting: 'value' },
+ // }
+
+ // // Act
+ // const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // // Assert
+ // expect(result).toEqual({
+ // settings: {
+ // '0': 'option1',
+ // '1': 'option2',
+ // enabled: ['true'],
+ // newSetting: ['value'],
+ // },
+ // })
+ // })
+ // })
describe('given undefined ancestor', () => {
it('should correctly merge objects when ancestor is undefined', () => {
// Arrange
- const ancestor = undefined
+ const ancestor = {}
const ours: JsonValue = {
Profile: {
@@ -312,22 +371,52 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'true' },
- { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ expect(result).toEqual([
+ {
+ Profile: [
+ { custom: ['Value1', 'Value3', 'Value2', 'Value4'] },
+ { description: [{ '#text': 'Their description' }] },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { '#text': '<<<<<<< LOCAL' },
+ { editable: [{ '#text': 'true' }] },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ { editable: [{ '#text': 'false' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ { field: [{ '#text': 'Account.Name' }] },
+ { '#text': '<<<<<<< LOCAL' },
+ { readable: [{ '#text': 'true' }] },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ { readable: [{ '#text': 'false' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
],
- custom: ['Value1', 'Value3', 'Value2', 'Value4'],
- description: ['Their description'],
},
- })
+ ])
})
it('should correctly merge arrays with key field when ancestor is undefined', () => {
// Arrange
- const ancestor = undefined
+ const ancestor = {}
const ours: JsonValue = {
Profile: {
@@ -350,19 +439,43 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'true' },
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { '#text': '<<<<<<< LOCAL' },
+ { editable: [{ '#text': 'true' }] },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ { editable: [{ '#text': 'false' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ { field: [{ '#text': 'Account.Name' }] },
+ { '#text': '<<<<<<< LOCAL' },
+ { readable: [{ '#text': 'true' }] },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ { readable: [{ '#text': 'false' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
],
},
- })
+ ])
})
it('should correctly merge arrays without key field when ancestor is undefined', () => {
// Arrange
- const ancestor = undefined
+ const ancestor = {}
const ours: JsonValue = {
Profile: {
@@ -380,11 +493,15 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ },
+ ],
},
- })
+ ])
})
})
@@ -425,17 +542,21 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- loginHours: [
- 'Monday-Modified',
- 'Tuesday',
- 'Wednesday-Modified',
- 'Thursday',
- 'Friday',
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ loginHours: [
+ 'Monday-Modified',
+ 'Tuesday',
+ 'Wednesday-Modified',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
],
},
- })
+ ])
})
it('should use their version when we did not modify an element but they did', () => {
@@ -462,11 +583,15 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- loginIpRanges: ['192.168.1.1', '10.0.0.2', '172.16.0.1'],
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ loginIpRanges: ['192.168.1.1', '10.0.0.2', '172.16.0.1'],
+ },
+ ],
},
- })
+ ])
})
it('should append their additional elements when their array is longer', () => {
@@ -493,11 +618,21 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ loginHours: [
+ 'Monday',
+ 'Tuesday',
+ 'Wednesday',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
+ ],
},
- })
+ ])
})
it('should keep our additional elements when our array is longer', () => {
@@ -524,17 +659,21 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual({
- Profile: {
- loginHours: [
- 'Monday-Modified',
- 'Tuesday',
- 'Wednesday',
- 'Thursday',
- 'Friday',
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ loginHours: [
+ 'Monday-Modified',
+ 'Tuesday',
+ 'Wednesday',
+ 'Thursday',
+ 'Friday',
+ ],
+ },
],
},
- })
+ ])
})
})
})
From 64a72e44adcfe23a1951728b605359e2de211367 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 20 Mar 2025 14:49:50 +0100
Subject: [PATCH 29/55] fix: change coverage to initiate branch - todo proper
dealing with one empty file
---
jest.config.js | 8 +-
src/merger/XmlMerger.ts | 10 ++-
test/unit/merger/JsonMerger.test.ts | 133 ++++++++++++++++++++++++++++
3 files changed, 143 insertions(+), 8 deletions(-)
diff --git a/jest.config.js b/jest.config.js
index 4f97a47..b6988ed 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -40,10 +40,10 @@ export default {
// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
- branches: 90,
- functions: 90,
- lines: 95,
- statements: 95,
+ branches: 66,
+ functions: 66,
+ lines: 66,
+ statements: 66,
},
},
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index d3a82c1..6c31549 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -61,11 +61,13 @@ export class XmlMerger {
// Convert back to XML and format
const builder = new XMLBuilder(builderOptions)
- const mergedXml = builder.build(mergedObj)
+ const mergedXml: string = builder.build(mergedObj)
// console.log('mergedXml')
// console.dir(mergedXml, {depth:null})
- return correctConflictIndent(
- correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
- )
+ return mergedXml.length
+ ? correctConflictIndent(
+ correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
+ )
+ : ''
}
}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 8fe6976..93a1bf2 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -505,6 +505,139 @@ describe('JsonMerger', () => {
})
})
+ // describe('given undefined ours', () => {
+ // it('should correctly merge objects when ours is undefined', () => {
+ // // Arrange
+ // const ancestor: JsonValue = {
+ // Profile: {
+ // fieldPermissions: [
+ // { field: 'Account.Name', editable: 'true', readable: 'true' },
+ // { field: 'Account.Type', editable: 'false', readable: 'true' },
+ // ],
+ // custom: ['Value1', 'Value3'],
+ // },
+ // }
+
+ // const ours = {}
+
+ // const theirs: JsonValue = {
+ // Profile: {
+ // fieldPermissions: [
+ // { field: 'Account.Name', editable: 'false', readable: 'false' },
+ // { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ // ],
+ // custom: ['Value2', 'Value4'],
+ // description: 'Their description',
+ // },
+ // }
+
+ // // Act
+ // const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // // Assert
+ // expect(result).toEqual([
+ // {
+ // Profile: [
+ // { custom: ['Value2', 'Value4'] },
+ // { description: [{ '#text': 'Their description' }] },
+ // {
+ // fieldPermissions: [
+ // { editable: [{ '#text': 'false' }] },
+ // { field: [{ '#text': 'Account.Industry' }] },
+ // { readable: [{ '#text': 'true' }] },
+ // ],
+ // },
+ // {
+ // fieldPermissions: [
+ // { '#text': '<<<<<<< LOCAL' },
+ // { '#text': '\n' },
+ // { '#text': '||||||| BASE' },
+ // { editable: [{ '#text': 'true' }] },
+ // { '#text': '=======' },
+ // { editable: [{ '#text': 'false' }] },
+ // { '#text': '>>>>>>> REMOTE' },
+ // { field: [{ '#text': 'Account.Name' }] },
+ // { '#text': '<<<<<<< LOCAL' },
+ // { '#text': '\n' },
+ // { '#text': '||||||| BASE' },
+ // { readable: [{ '#text': 'true' }] },
+ // { '#text': '=======' },
+ // { readable: [{ '#text': 'false' }] },
+ // { '#text': '>>>>>>> REMOTE' },
+ // ],
+ // },
+ // ],
+ // },
+ // ])
+ // })
+ // })
+
+ // describe('given undefined theirs', () => {
+ // it('should correctly merge objects when theirs is undefined', () => {
+ // // Arrange
+ // const ancestor: JsonValue = {
+ // Profile: {
+ // fieldPermissions: [
+ // { field: 'Account.Name', editable: 'false', readable: 'false' },
+ // { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ // ],
+ // custom: ['Value2', 'Value4'],
+ // description: 'Their description',
+ // },
+ // }
+
+ // const ours: JsonValue = {
+ // Profile: {
+ // fieldPermissions: [
+ // { field: 'Account.Name', editable: 'true', readable: 'true' },
+ // { field: 'Account.Type', editable: 'false', readable: 'true' },
+ // ],
+ // custom: ['Value1', 'Value3'],
+ // },
+ // }
+
+ // const theirs = {}
+
+ // // Act
+ // const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // // Assert
+ // expect(result).toEqual([
+ // {
+ // Profile: [
+ // { custom: ['Value1', 'Value3'] },
+ // {
+ // fieldPermissions: [
+ // { '#text': '<<<<<<< LOCAL' },
+ // { editable: [{ '#text': 'true' }] },
+ // { '#text': '||||||| BASE' },
+ // { editable: [{ '#text': 'false' }] },
+ // { '#text': '=======' },
+ // { '#text': '\n' },
+ // { '#text': '>>>>>>> REMOTE' },
+ // { field: [{ '#text': 'Account.Name' }] },
+ // { '#text': '<<<<<<< LOCAL' },
+ // { readable: [{ '#text': 'true' }] },
+ // { '#text': '||||||| BASE' },
+ // { readable: [{ '#text': 'false' }] },
+ // { '#text': '=======' },
+ // { '#text': '\n' },
+ // { '#text': '>>>>>>> REMOTE' },
+ // ],
+ // },
+ // {
+ // fieldPermissions: [
+ // { editable: [{ '#text': 'false' }] },
+ // { field: [{ '#text': 'Account.Type' }] },
+ // { readable: [{ '#text': 'true' }] },
+ // ],
+ // },
+ // ],
+ // },
+ // ])
+ // })
+ // })
+
describe('given arrays with <array> key field', () => {
it('should merge arrays by position when both sides modify different elements', () => {
// Arrange
From bb3e699cdc5528f6a403a92c07f85b8a84d7f695 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 20 Mar 2025 16:07:43 +0100
Subject: [PATCH 30/55] fix: empty file input
---
src/merger/JsonMerger.ts | 127 ++++++++--
test/unit/merger/JsonMerger.test.ts | 352 ++++++++++++++++------------
2 files changed, 300 insertions(+), 179 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index cbce092..42b286f 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -28,17 +28,21 @@ export class JsonMerger {
): JsonArray {
// Get all properties from three ways
const arrProperties: string[] = []
+ let caseCode: number = 0
if (ancestor && !isEqual(ancestor, {})) {
+ caseCode += 100
arrProperties.push(...Object.keys(ancestor))
} else {
ancestor = {}
}
if (ours && !isEqual(ours, {})) {
+ caseCode += 10
arrProperties.push(...Object.keys(ours))
} else {
ours = {}
}
if (theirs && !isEqual(theirs, {})) {
+ caseCode += 1
arrProperties.push(...Object.keys(theirs))
} else {
theirs = {}
@@ -48,6 +52,11 @@ export class JsonMerger {
// Process each property
const mergedContent = [] as JsonArray
for (const property of allProperties) {
+ // console.info('property: '+property+'\ntypeof: '+this.getAttributePrimarytype(
+ // ancestor[property],
+ // ours[property],
+ // theirs[property]
+ // ))
switch (
this.getAttributePrimarytype(
ancestor[property],
@@ -68,17 +77,93 @@ export class JsonMerger {
)
)
} else {
- const propObject = {}
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects(
- ancestor[property],
- ours[property],
- theirs[property],
- propObject
- )
- )
- mergedContent.push(propObject)
+ let propObject = {}
+ switch (caseCode) {
+ case 100:
+ return []
+ case 11:
+ if (isEqual(ours, theirs)) {
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, ours[property], {}, propObject)
+ )
+ mergedContent.push(propObject)
+ } else {
+ mergedContent.push({ '#text': '\n<<<<<<< LOCAL' })
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, ours[property], {}, propObject)
+ )
+ mergedContent.push(propObject)
+ mergedContent.push({ '#text': '||||||| BASE' })
+ mergedContent.push({ '#text': '\n' })
+ mergedContent.push({ '#text': '=======' })
+ propObject = {}
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, {}, theirs[property], propObject)
+ )
+ mergedContent.push(propObject)
+ mergedContent.push({ '#text': '>>>>>>> REMOTE' })
+ }
+ break
+ case 101:
+ if (isEqual(ancestor, theirs)) {
+ return []
+ } else {
+ mergedContent.push({ '#text': '\n<<<<<<< LOCAL' })
+ mergedContent.push({ '#text': '\n' })
+ mergedContent.push({ '#text': '||||||| BASE' })
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, ancestor[property], {}, propObject)
+ )
+ mergedContent.push(propObject)
+ mergedContent.push({ '#text': '=======' })
+ propObject = {}
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, {}, theirs[property], propObject)
+ )
+ mergedContent.push(propObject)
+ mergedContent.push({ '#text': '>>>>>>> REMOTE' })
+ }
+ break
+ case 110:
+ if (isEqual(ancestor, ours)) {
+ return []
+ } else {
+ mergedContent.push({ '#text': '\n<<<<<<< LOCAL' })
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, ours[property], {}, propObject)
+ )
+ mergedContent.push(propObject)
+ mergedContent.push({ '#text': '||||||| BASE' })
+ propObject = {}
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects({}, {}, ancestor[property], propObject)
+ )
+ mergedContent.push(propObject)
+ mergedContent.push({ '#text': '=======' })
+ mergedContent.push({ '#text': '\n' })
+ mergedContent.push({ '#text': '>>>>>>> REMOTE' })
+ }
+ break
+ default:
+ propObject[property] = []
+ propObject[property].push(
+ ...this.mergeObjects(
+ ancestor[property],
+ ours[property],
+ theirs[property],
+ propObject
+ )
+ )
+ mergedContent.push(propObject)
+ break
+ }
}
break
}
@@ -209,7 +294,7 @@ export class JsonMerger {
return [objOurs]
} else {
const arr: JsonArray = []
- arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push({ '#text': '\n<<<<<<< LOCAL' })
arr.push(objOurs)
arr.push({ '#text': '||||||| BASE' })
arr.push({ '#text': '\n' })
@@ -225,7 +310,7 @@ export class JsonMerger {
return []
} else {
const arr: JsonArray = []
- arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push({ '#text': '\n<<<<<<< LOCAL' })
arr.push({ '#text': '\n' })
arr.push({ '#text': '||||||| BASE' })
arr.push(objAnc)
@@ -239,7 +324,7 @@ export class JsonMerger {
return []
} else {
const arr: JsonArray = []
- arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push({ '#text': '\n<<<<<<< LOCAL' })
arr.push(objOurs)
arr.push({ '#text': '||||||| BASE' })
arr.push(objAnc)
@@ -257,7 +342,7 @@ export class JsonMerger {
return [objOurs]
} else {
const arr: JsonArray = []
- arr.push({ '#text': '<<<<<<< LOCAL' })
+ arr.push({ '#text': '\n<<<<<<< LOCAL' })
arr.push(objOurs)
arr.push({ '#text': '||||||| BASE' })
arr.push(objAnc)
@@ -397,17 +482,7 @@ export class JsonMerger {
// '\ncaseCode: ' +
// caseCode
// )
- const propObject = {}
- switch (caseCode) {
- case 1:
- propObject[attribute] = this.mergeObjects({}, {}, theirs, parent)
- return [propObject]
- case 10:
- propObject[attribute] = this.mergeObjects({}, {}, ours, parent)
- return [propObject]
- case 100:
- return []
- }
+ // console.dir(ours, {depth: null})
const keyedAnc = keyBy(ancestor, keyField)
const keyedOurs = keyBy(ours, keyField)
const keyedTheirs = keyBy(theirs, keyField)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 93a1bf2..927a377 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -372,45 +372,50 @@ describe('JsonMerger', () => {
// Assert
expect(result).toEqual([
+ { '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
- { custom: ['Value1', 'Value3', 'Value2', 'Value4'] },
- { description: [{ '#text': 'Their description' }] },
+ { custom: ['Value1', 'Value3'] },
{
fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Industry' }] },
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
{ readable: [{ '#text': 'true' }] },
],
},
{
fieldPermissions: [
- { '#text': '<<<<<<< LOCAL' },
- { editable: [{ '#text': 'true' }] },
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
{ editable: [{ '#text': 'false' }] },
- { '#text': '>>>>>>> REMOTE' },
- { field: [{ '#text': 'Account.Name' }] },
- { '#text': '<<<<<<< LOCAL' },
+ { field: [{ '#text': 'Account.Type' }] },
{ readable: [{ '#text': 'true' }] },
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
- { readable: [{ '#text': 'false' }] },
- { '#text': '>>>>>>> REMOTE' },
],
},
+ ],
+ },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ {
+ Profile: [
+ { custom: ['Value2', 'Value4'] },
+ { description: [{ '#text': 'Their description' }] },
{
fieldPermissions: [
{ editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Type' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
{ readable: [{ '#text': 'true' }] },
],
},
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
+ },
],
},
+ { '#text': '>>>>>>> REMOTE' },
])
})
@@ -440,25 +445,28 @@ describe('JsonMerger', () => {
// Assert
expect(result).toEqual([
+ { '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
{
fieldPermissions: [
- { '#text': '<<<<<<< LOCAL' },
{ editable: [{ '#text': 'true' }] },
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
- { editable: [{ '#text': 'false' }] },
- { '#text': '>>>>>>> REMOTE' },
{ field: [{ '#text': 'Account.Name' }] },
- { '#text': '<<<<<<< LOCAL' },
{ readable: [{ '#text': 'true' }] },
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
+ ],
+ },
+ ],
+ },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
{ readable: [{ '#text': 'false' }] },
- { '#text': '>>>>>>> REMOTE' },
],
},
{
@@ -470,6 +478,7 @@ describe('JsonMerger', () => {
},
],
},
+ { '#text': '>>>>>>> REMOTE' },
])
})
@@ -494,149 +503,186 @@ describe('JsonMerger', () => {
// Assert
expect(result).toEqual([
+ { '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
{
- custom: ['Value1', 'Value3', 'Value2', 'Value4'],
+ custom: ['Value1', 'Value3'],
+ },
+ ],
+ },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ {
+ Profile: [
+ {
+ custom: ['Value1', 'Value2', 'Value4'],
},
],
},
+ { '#text': '>>>>>>> REMOTE' },
])
})
})
- // describe('given undefined ours', () => {
- // it('should correctly merge objects when ours is undefined', () => {
- // // Arrange
- // const ancestor: JsonValue = {
- // Profile: {
- // fieldPermissions: [
- // { field: 'Account.Name', editable: 'true', readable: 'true' },
- // { field: 'Account.Type', editable: 'false', readable: 'true' },
- // ],
- // custom: ['Value1', 'Value3'],
- // },
- // }
+ describe('given undefined ours', () => {
+ it('should correctly merge objects when ours is undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value2', 'Value4'],
+ description: 'Their description',
+ },
+ }
- // const ours = {}
+ const ours = {}
- // const theirs: JsonValue = {
- // Profile: {
- // fieldPermissions: [
- // { field: 'Account.Name', editable: 'false', readable: 'false' },
- // { field: 'Account.Industry', editable: 'false', readable: 'true' },
- // ],
- // custom: ['Value2', 'Value4'],
- // description: 'Their description',
- // },
- // }
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3'],
+ },
+ }
- // // Act
- // const result = sut.mergeObjects(ancestor, ours, theirs)
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- // // Assert
- // expect(result).toEqual([
- // {
- // Profile: [
- // { custom: ['Value2', 'Value4'] },
- // { description: [{ '#text': 'Their description' }] },
- // {
- // fieldPermissions: [
- // { editable: [{ '#text': 'false' }] },
- // { field: [{ '#text': 'Account.Industry' }] },
- // { readable: [{ '#text': 'true' }] },
- // ],
- // },
- // {
- // fieldPermissions: [
- // { '#text': '<<<<<<< LOCAL' },
- // { '#text': '\n' },
- // { '#text': '||||||| BASE' },
- // { editable: [{ '#text': 'true' }] },
- // { '#text': '=======' },
- // { editable: [{ '#text': 'false' }] },
- // { '#text': '>>>>>>> REMOTE' },
- // { field: [{ '#text': 'Account.Name' }] },
- // { '#text': '<<<<<<< LOCAL' },
- // { '#text': '\n' },
- // { '#text': '||||||| BASE' },
- // { readable: [{ '#text': 'true' }] },
- // { '#text': '=======' },
- // { readable: [{ '#text': 'false' }] },
- // { '#text': '>>>>>>> REMOTE' },
- // ],
- // },
- // ],
- // },
- // ])
- // })
- // })
+ // Assert
+ expect(result).toEqual([
+ { '#text': '\n<<<<<<< LOCAL' },
+ { '#text': '\n' },
+ { '#text': '||||||| BASE' },
+ {
+ Profile: [
+ { custom: ['Value2', 'Value4'] },
+ { description: [{ '#text': 'Their description' }] },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
+ },
+ ],
+ },
+ { '#text': '=======' },
+ {
+ Profile: [
+ { custom: ['Value1', 'Value3'] },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ])
+ })
+ })
- // describe('given undefined theirs', () => {
- // it('should correctly merge objects when theirs is undefined', () => {
- // // Arrange
- // const ancestor: JsonValue = {
- // Profile: {
- // fieldPermissions: [
- // { field: 'Account.Name', editable: 'false', readable: 'false' },
- // { field: 'Account.Industry', editable: 'false', readable: 'true' },
- // ],
- // custom: ['Value2', 'Value4'],
- // description: 'Their description',
- // },
- // }
+ describe('given undefined theirs', () => {
+ it('should correctly merge objects when theirs is undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value2', 'Value4'],
+ description: 'Their description',
+ },
+ }
- // const ours: JsonValue = {
- // Profile: {
- // fieldPermissions: [
- // { field: 'Account.Name', editable: 'true', readable: 'true' },
- // { field: 'Account.Type', editable: 'false', readable: 'true' },
- // ],
- // custom: ['Value1', 'Value3'],
- // },
- // }
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3'],
+ },
+ }
- // const theirs = {}
+ const theirs = {}
- // // Act
- // const result = sut.mergeObjects(ancestor, ours, theirs)
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- // // Assert
- // expect(result).toEqual([
- // {
- // Profile: [
- // { custom: ['Value1', 'Value3'] },
- // {
- // fieldPermissions: [
- // { '#text': '<<<<<<< LOCAL' },
- // { editable: [{ '#text': 'true' }] },
- // { '#text': '||||||| BASE' },
- // { editable: [{ '#text': 'false' }] },
- // { '#text': '=======' },
- // { '#text': '\n' },
- // { '#text': '>>>>>>> REMOTE' },
- // { field: [{ '#text': 'Account.Name' }] },
- // { '#text': '<<<<<<< LOCAL' },
- // { readable: [{ '#text': 'true' }] },
- // { '#text': '||||||| BASE' },
- // { readable: [{ '#text': 'false' }] },
- // { '#text': '=======' },
- // { '#text': '\n' },
- // { '#text': '>>>>>>> REMOTE' },
- // ],
- // },
- // {
- // fieldPermissions: [
- // { editable: [{ '#text': 'false' }] },
- // { field: [{ '#text': 'Account.Type' }] },
- // { readable: [{ '#text': 'true' }] },
- // ],
- // },
- // ],
- // },
- // ])
- // })
- // })
+ // Assert
+ expect(result).toEqual([
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ Profile: [
+ { custom: ['Value1', 'Value3'] },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ { '#text': '||||||| BASE' },
+ {
+ Profile: [
+ { custom: ['Value2', 'Value4'] },
+ { description: [{ '#text': 'Their description' }] },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
+ },
+ ],
+ },
+ { '#text': '=======' },
+ { '#text': '\n' },
+ { '#text': '>>>>>>> REMOTE' },
+ ])
+ })
+ })
describe('given arrays with <array> key field', () => {
it('should merge arrays by position when both sides modify different elements', () => {
From 0112d358be8109fdcd72358f02f8c88d92dcb64f Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 20 Mar 2025 16:10:11 +0100
Subject: [PATCH 31/55] fix: lower coverage check to push
---
jest.config.js | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/jest.config.js b/jest.config.js
index b6988ed..dea29f8 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -40,10 +40,10 @@ export default {
// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
- branches: 66,
- functions: 66,
- lines: 66,
- statements: 66,
+ branches: 65,
+ functions: 90,
+ lines: 70,
+ statements: 70,
},
},
From 378591dafcd59411491ce9f202211436e8f52e46 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 20 Mar 2025 16:54:14 +0100
Subject: [PATCH 32/55] fix: improve tests and coverage
---
jest.config.js | 6 +-
src/merger/JsonMerger.ts | 95 +++----
test/unit/merger/JsonMerger.test.ts | 398 ++++++++++++++++++++++++++++
3 files changed, 445 insertions(+), 54 deletions(-)
diff --git a/jest.config.js b/jest.config.js
index dea29f8..ef419ac 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -40,10 +40,10 @@ export default {
// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
- branches: 65,
+ branches: 80,
functions: 90,
- lines: 70,
- statements: 70,
+ lines: 90,
+ statements: 90,
},
},
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 42b286f..162c35f 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -284,76 +284,69 @@ export class JsonMerger {
objTheirs[attrib] = [{ '#text': theirs }]
caseCode += 1
}
+ const finalArray: JsonArray = []
switch (caseCode) {
case 1:
- return [objTheirs]
+ finalArray.push(objTheirs)
+ break
case 10:
- return [objOurs]
+ finalArray.push(objOurs)
+ break
case 11:
if (ours === theirs) {
- return [objOurs]
+ finalArray.push(objOurs)
} else {
- const arr: JsonArray = []
- arr.push({ '#text': '\n<<<<<<< LOCAL' })
- arr.push(objOurs)
- arr.push({ '#text': '||||||| BASE' })
- arr.push({ '#text': '\n' })
- arr.push({ '#text': '=======' })
- arr.push(objTheirs)
- arr.push({ '#text': '>>>>>>> REMOTE' })
- return arr
+ finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
+ finalArray.push(objOurs)
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '=======' })
+ finalArray.push(objTheirs)
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
}
- case 100:
- return []
+ break
case 101:
- if (ancestor === theirs) {
- return []
- } else {
- const arr: JsonArray = []
- arr.push({ '#text': '\n<<<<<<< LOCAL' })
- arr.push({ '#text': '\n' })
- arr.push({ '#text': '||||||| BASE' })
- arr.push(objAnc)
- arr.push({ '#text': '=======' })
- arr.push(objTheirs)
- arr.push({ '#text': '>>>>>>> REMOTE' })
- return arr
+ if (ancestor !== theirs) {
+ finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push(objAnc)
+ finalArray.push({ '#text': '=======' })
+ finalArray.push(objTheirs)
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
}
+ break
case 110:
- if (ancestor === ours) {
- return []
- } else {
- const arr: JsonArray = []
- arr.push({ '#text': '\n<<<<<<< LOCAL' })
- arr.push(objOurs)
- arr.push({ '#text': '||||||| BASE' })
- arr.push(objAnc)
- arr.push({ '#text': '=======' })
- arr.push({ '#text': '\n' })
- arr.push({ '#text': '>>>>>>> REMOTE' })
- return arr
+ if (ancestor !== ours) {
+ finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
+ finalArray.push(objOurs)
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push(objAnc)
+ finalArray.push({ '#text': '=======' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
}
+ break
case 111:
if (ours === theirs) {
- return [objOurs]
+ finalArray.push(objOurs)
} else if (ancestor === ours) {
- return [objTheirs]
+ finalArray.push(objTheirs)
} else if (ancestor === theirs) {
- return [objOurs]
+ finalArray.push(objOurs)
} else {
- const arr: JsonArray = []
- arr.push({ '#text': '\n<<<<<<< LOCAL' })
- arr.push(objOurs)
- arr.push({ '#text': '||||||| BASE' })
- arr.push(objAnc)
- arr.push({ '#text': '=======' })
- arr.push(objTheirs)
- arr.push({ '#text': '>>>>>>> REMOTE' })
- return arr
+ finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
+ finalArray.push(objOurs)
+ finalArray.push({ '#text': '||||||| BASE' })
+ finalArray.push(objAnc)
+ finalArray.push({ '#text': '=======' })
+ finalArray.push(objTheirs)
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
}
+ break
default:
- return []
}
+ return finalArray
}
/**
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 927a377..68a92be 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -526,6 +526,358 @@ describe('JsonMerger', () => {
})
})
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {},
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {},
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {}
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Their description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ {
+ description: [{ '#text': 'Their description' }],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {},
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Their description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ { '#text': '\n' },
+ { '#text': '||||||| BASE' },
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ { '#text': '=======' },
+ {
+ description: [{ '#text': 'Their description' }],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ { '#text': '||||||| BASE' },
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ { '#text': '=======' },
+ { '#text': '\n' },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Their description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ { '#text': '||||||| BASE' },
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ { '#text': '=======' },
+ {
+ description: [{ '#text': 'Their description' }],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
describe('given undefined ours', () => {
it('should correctly merge objects when ours is undefined', () => {
// Arrange
@@ -603,6 +955,52 @@ describe('JsonMerger', () => {
{ '#text': '>>>>>>> REMOTE' },
])
})
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const ours: JsonValue = {}
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {}
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([])
+ })
})
describe('given undefined theirs', () => {
From 39d76df02a49c4a885dec173b2985b34fe4cc901 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 20 Mar 2025 16:56:35 +0100
Subject: [PATCH 33/55] fix: original coverage level
---
jest.config.js | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/jest.config.js b/jest.config.js
index ef419ac..4f97a47 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -40,10 +40,10 @@ export default {
// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
- branches: 80,
+ branches: 90,
functions: 90,
- lines: 90,
- statements: 90,
+ lines: 95,
+ statements: 95,
},
},
From 53b9523d878406cfde2f595f57c6963c2d6f70f7 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Fri, 21 Mar 2025 10:58:25 +0100
Subject: [PATCH 34/55] fix: complete initial tests
co-authored-by: sebastien <colladonsebastien@gmail.com>
---
src/merger/JsonMerger.ts | 5 +-
src/merger/XmlMerger.ts | 18 +-
test/unit/merger/JsonMerger.test.ts | 329 ++++++++++++++++++++++++++++
3 files changed, 340 insertions(+), 12 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 162c35f..1ded8cf 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -592,17 +592,14 @@ export class JsonMerger {
propObject[attribute] = [
...this.mergeObjects({}, {}, keyedOurs[key], parent),
]
- finalArray.push(propObject)
} else if (isEqual(ancestor, ours)) {
propObject[attribute] = [
...this.mergeObjects({}, {}, keyedTheirs[key], parent),
]
- finalArray.push(propObject)
} else if (isEqual(ancestor, theirs)) {
propObject[attribute] = [
...this.mergeObjects({}, {}, keyedOurs[key], parent),
]
- finalArray.push(propObject)
} else {
// finalArray.push({ '#text': '<<<<<<< LOCAL' })
// finalArray.push(...this.mergeObjects({}, {}, keyedOurs[key], parent))
@@ -619,8 +616,8 @@ export class JsonMerger {
parent
),
]
- finalArray.push(propObject)
}
+ finalArray.push(propObject)
break
default:
}
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 6c31549..ede3277 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -4,23 +4,25 @@ import { JsonMerger } from './JsonMerger.js'
const XML_DECL = '<?xml version="1.0" encoding="UTF-8"?>\n'
const XML_COMMENT_PROP_NAME = '#xml__comment'
-const parserOptions = {
- ignoreAttributes: false,
- parseTagValue: false,
- parseAttributeValue: false,
+const baseOptions = {
cdataPropName: '__cdata',
+ commentPropName: XML_COMMENT_PROP_NAME,
+ ignoreAttributes: false,
+}
+
+const parserOptions = {
+ ...baseOptions,
ignoreDeclaration: true,
numberParseOptions: { leadingZeros: false, hex: false },
- commentPropName: XML_COMMENT_PROP_NAME,
+ parseAttributeValue: false,
+ parseTagValue: false,
// preserveOrder: true,
}
const builderOptions = {
+ ...baseOptions,
format: true,
indentBy: ' ',
- ignoreAttributes: false,
- cdataPropName: '__cdata',
- commentPropName: XML_COMMENT_PROP_NAME,
preserveOrder: true,
}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 68a92be..7928e90 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -526,6 +526,335 @@ describe('JsonMerger', () => {
})
})
+ it('should correctly merge objects when ancestor key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when ancestor key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ { editable: [{ '#text': 'true' }] },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ { editable: [{ '#text': 'false' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when our key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '||||||| BASE' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '=======' },
+ { '#text': '\n' },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when our key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {},
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ { '#text': '\n' },
+ { '#text': '||||||| BASE' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '=======' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when our key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when our key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when our key undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ ])
+ })
+
it('should handle string values', () => {
// Arrange
const ancestor: JsonValue = {
From b043e191922e587b52fdd57dff3e528022164b43 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Fri, 21 Mar 2025 11:24:26 +0100
Subject: [PATCH 35/55] feat: improve perf of getAttributePrimarytype
---
src/merger/JsonMerger.ts | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 1ded8cf..f0b04c1 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -49,6 +49,8 @@ export class JsonMerger {
}
const allProperties = new Set(arrProperties.sort())
+ // TODO filter the namespace here and reapply it in the end of the loop if necessary
+
// Process each property
const mergedContent = [] as JsonArray
for (const property of allProperties) {
@@ -357,11 +359,7 @@ export class JsonMerger {
ours: JsonValue | undefined | null,
theirs: JsonValue | undefined | null
): string {
- return isNil(ancestor)
- ? isNil(ours)
- ? typeof theirs
- : typeof ours
- : typeof ancestor
+ return typeof [ancestor, theirs, ours].find(ele => !isNil(ele))
}
/**
From 646ba00658f0750bc582fba612ae6d8a24a84941 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Fri, 21 Mar 2025 12:06:16 +0100
Subject: [PATCH 36/55] feat: finish solving cases of one key not present
---
src/merger/JsonMerger.ts | 62 +++++++++++++++--------------
test/unit/merger/JsonMerger.test.ts | 31 ++++++++++++++-
2 files changed, 63 insertions(+), 30 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index f0b04c1..2e8f921 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -496,7 +496,7 @@ export class JsonMerger {
caseCode += 1
}
// console.log('caseCode: ' + caseCode);
- const propObject = {}
+ let propObject = {}
switch (caseCode) {
case 1:
propObject[attribute] = [
@@ -545,44 +545,48 @@ export class JsonMerger {
break
case 101:
if (!isEqual(ancestor, theirs)) {
- // finalArray.push({ '#text': '<<<<<<< LOCAL' })
- // finalArray.push({ '#text': '\n' })
- // finalArray.push({ '#text': '||||||| BASE' })
- // propObject[attribute] = [
- // ...this.mergeObjects({}, {}, keyedAnc[key], parent),
- // ]
- // finalArray.push(propObject)
- // finalArray.push({ '#text': '=======' })
- // propObject[attribute] = [
- // ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
- // ]
- // finalArray.push(propObject)
- // finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '||||||| BASE' })
+ propObject = {}
propObject[attribute] = [
- ...this.mergeObjects(keyedAnc[key], {}, keyedTheirs[key], parent),
+ ...this.mergeObjects({}, {}, keyedAnc[key], parent),
]
finalArray.push(propObject)
+ finalArray.push({ '#text': '=======' })
+ propObject = {}
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
+ ]
+ finalArray.push(propObject)
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects(keyedAnc[key], {}, keyedTheirs[key], parent),
+ // ]
+ // finalArray.push(propObject)
}
break
case 110:
if (!isEqual(ancestor, ours)) {
- // finalArray.push({ '#text': '<<<<<<< LOCAL' })
- // propObject[attribute] = [
- // ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- // ]
- // finalArray.push(propObject)
- // finalArray.push({ '#text': '||||||| BASE' })
- // propObject[attribute] = [
- // ...this.mergeObjects({}, {}, keyedAnc[key], parent),
- // ]
- // finalArray.push(propObject)
- // finalArray.push({ '#text': '=======' })
- // finalArray.push({ '#text': '\n' })
- // finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
+ propObject = {}
propObject[attribute] = [
- ...this.mergeObjects(keyedAnc[key], keyedOurs[key], {}, parent),
+ ...this.mergeObjects({}, {}, keyedOurs[key], parent),
]
finalArray.push(propObject)
+ finalArray.push({ '#text': '||||||| BASE' })
+ propObject = {}
+ propObject[attribute] = [
+ ...this.mergeObjects({}, {}, keyedAnc[key], parent),
+ ]
+ finalArray.push(propObject)
+ finalArray.push({ '#text': '=======' })
+ finalArray.push({ '#text': '\n' })
+ finalArray.push({ '#text': '>>>>>>> REMOTE' })
+ // propObject[attribute] = [
+ // ...this.mergeObjects(keyedAnc[key], keyedOurs[key], {}, parent),
+ // ]
+ // finalArray.push(propObject)
}
break
case 111:
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 7928e90..4bd3812 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -614,7 +614,7 @@ describe('JsonMerger', () => {
])
})
- it('should correctly merge objects when our key undefined', () => {
+ it('should correctly merge objects when their key undefined', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -720,6 +720,35 @@ describe('JsonMerger', () => {
])
})
+ it('only ancestor key present should just be removed', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {},
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
+
it('should correctly merge objects when our key undefined', () => {
// Arrange
const ancestor: JsonValue = {
From 01e7ae47c9ddca4c57dd24f20bb147e082e39b00 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Fri, 21 Mar 2025 12:10:20 +0100
Subject: [PATCH 37/55] chore: update @salesforce dependencies
---
package-lock.json | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index f3aa01d..b4d83b2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -4027,9 +4027,9 @@
}
},
"node_modules/@salesforce/core": {
- "version": "8.8.5",
- "resolved": "https://registry.npmjs.org/@salesforce/core/-/core-8.8.5.tgz",
- "integrity": "sha512-eCiiO4NptvKkz04A4ivBVLzEBy/6IIFmaXoZ4tnF1FcD5MESvC+Xuc+0RFSRiYmPi5oloKNl6njrfVCKAho2zQ==",
+ "version": "8.8.6",
+ "resolved": "https://registry.npmjs.org/@salesforce/core/-/core-8.8.6.tgz",
+ "integrity": "sha512-RQK7iUvOv579qZkz93DtXOTFY6HZrOF1iJB5JntnzzmWgKXwdeRdoyIYlLksrDp0vkNtjtNTZZz+IJY4x6eCig==",
"license": "BSD-3-Clause",
"dependencies": {
"@jsforce/jsforce-node": "^3.6.5",
@@ -4078,16 +4078,16 @@
"license": "ISC"
},
"node_modules/@salesforce/sf-plugins-core": {
- "version": "12.2.0",
- "resolved": "https://registry.npmjs.org/@salesforce/sf-plugins-core/-/sf-plugins-core-12.2.0.tgz",
- "integrity": "sha512-aGNk74rMt8I+HTP7hRsX6kxiGTuun9ONrWkX7JvWDdtIoO9TsEbNVZENH8GFxHFalWPFCj31IMUQD/bGbxMFbg==",
+ "version": "12.2.1",
+ "resolved": "https://registry.npmjs.org/@salesforce/sf-plugins-core/-/sf-plugins-core-12.2.1.tgz",
+ "integrity": "sha512-b3eRSzGO0weBLL1clHaJNgNP1aKkD1Qy2DQEc0ieteEm+fh1FfPA0QpJ9rh/hdmkJRip2x2R2zz9tflJ0wflbg==",
"license": "BSD-3-Clause",
"dependencies": {
"@inquirer/confirm": "^3.1.22",
"@inquirer/password": "^2.2.0",
- "@oclif/core": "^4.2.4",
+ "@oclif/core": "^4.2.10",
"@oclif/table": "^0.4.6",
- "@salesforce/core": "^8.5.1",
+ "@salesforce/core": "^8.8.5",
"@salesforce/kit": "^3.2.3",
"@salesforce/ts-types": "^2.0.12",
"ansis": "^3.3.2",
From 2a870025afa8f1435ee2b106b7535fa1ddcf9d4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 21 Mar 2025 12:18:44 +0100
Subject: [PATCH 38/55] docs: fix README duplicate command section
---
README.md | 97 -------------------------------------------------------
1 file changed, 97 deletions(-)
diff --git a/README.md b/README.md
index df15c18..8cec4d7 100644
--- a/README.md
+++ b/README.md
@@ -47,102 +47,6 @@ EXAMPLES
$ sf git merge driver install
```
-_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/install.ts)_
-
-## `sf git merge driver run`
-
-Runs the merge driver for the specified files.
-
-```
-USAGE
- $ sf git merge driver run -a <value> -o <value> -t <value> -p <value> [--json] [--flags-dir <value>]
-
-FLAGS
- -a, --ancestor-file=<value> (required) path to the common ancestor version of the file
- -o, --our-file=<value> (required) path to our version of the file
- -p, --output-file=<value> (required) path to the file where the merged content will be written
- -t, --theirs-file=<value> (required) path to their version of the file
-
-GLOBAL FLAGS
- --flags-dir=<value> Import flag values from a directory.
- --json Format output as json.
-
-DESCRIPTION
- Runs the merge driver for the specified files.
-
- Runs the merge driver for the specified files, handling the merge conflict resolution using Salesforce-specific merge
- strategies. This command is typically called automatically by Git when a merge conflict is detected.
-
-EXAMPLES
- Run the merge driver for conflicting files:
-
- $ sf git merge driver run --ancestor-file=<value> --our-file=<value> --theirs-file=<value> --output-file=<value>
-
- Where:
- - ancestor-file is the path to the common ancestor version of the file
- - our-file is the path to our version of the file
- - their-file is the path to their version of the file
- - output-file is the path to the file where the merged content will be written
-```
-
-_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/run.ts)_
-
-## `sf git merge driver uninstall`
-
-Uninstalls the local git merge driver for the given org and branch.
-
-```
-USAGE
- $ sf git merge driver uninstall [--json] [--flags-dir <value>]
-
-GLOBAL FLAGS
- --flags-dir=<value> Import flag values from a directory.
- --json Format output as json.
-
-DESCRIPTION
- Uninstalls the local git merge driver for the given org and branch.
-
- Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the
- `.gitattributes` files in the project, deleting the merge driver configuration from the `.git/config` of the project,
- and removing the installed binary from the node_modules/.bin directory.
-
-EXAMPLES
- Uninstall the driver for a given project:
-
- $ sf git merge driver uninstall
-```
-
-_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0/src/commands/git/merge/driver/uninstall.ts)_
-<!-- commandsstop -->
-* [`sf git merge driver install`](#sf-git-merge-driver-install)
-* [`sf git merge driver run`](#sf-git-merge-driver-run)
-* [`sf git merge driver uninstall`](#sf-git-merge-driver-uninstall)
-
-## `sf git merge driver install`
-
-Installs a local git merge driver for the given org and branch.
-
-```
-USAGE
- $ sf git merge driver install [--json] [--flags-dir <value>]
-
-GLOBAL FLAGS
- --flags-dir=<value> Import flag values from a directory.
- --json Format output as json.
-
-DESCRIPTION
- Installs a local git merge driver for the given org and branch.
-
- Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project,
- creating a new merge driver configuration in the `.git/config` of the project, and installing the binary in the
- node_modules/.bin directory.
-
-EXAMPLES
- Install the driver for a given project:
-
- $ sf git merge driver install
-```
-
_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/install.ts)_
## `sf git merge driver run`
@@ -211,7 +115,6 @@ EXAMPLES
_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/main/src/commands/git/merge/driver/uninstall.ts)_
<!-- commandsstop -->
-
## How It Works
The merge driver works by:
From f60f2f35c6f1c82997c4bfad2b7db335225d970e Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Fri, 21 Mar 2025 12:41:50 +0100
Subject: [PATCH 39/55] test: adding test for empty files
---
test/unit/merger/XmlMerger.test.ts | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/test/unit/merger/XmlMerger.test.ts b/test/unit/merger/XmlMerger.test.ts
index 6afe24e..cc521b5 100644
--- a/test/unit/merger/XmlMerger.test.ts
+++ b/test/unit/merger/XmlMerger.test.ts
@@ -100,5 +100,23 @@ describe('MergeDriver', () => {
expect(result).toContain('<?xml version="1.0" encoding="UTF-8"?>')
expect(result).toContain('<!-- merged comment -->')
})
+
+ it('empty files should output empty file', () => {
+ // Arrange
+ const ancestorWithComment = ''
+ const ourWithComment = ''
+ const theirWithComment = ''
+ mockedMergeObjects.mockReturnValue('')
+
+ // Act
+ const result = sut.tripartXmlMerge(
+ ancestorWithComment,
+ ourWithComment,
+ theirWithComment
+ )
+
+ // Assert
+ expect(result).toEqual('')
+ })
})
})
From d761e17814339401bf97040c79eaee4bd38fc095 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Fri, 21 Mar 2025 13:59:35 +0100
Subject: [PATCH 40/55] test: adding a test to check namespace dealing
---
test/unit/merger/JsonMerger.test.ts | 71 +++++++++++++++++++++++++++++
1 file changed, 71 insertions(+)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 4bd3812..21c5440 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -310,6 +310,77 @@ describe('JsonMerger', () => {
})
})
+ describe('test dealing with namespace', () => {
+ it('it should come at the right level', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ CustomLabels: {
+ labels: {
+ fullName: 'tested_label',
+ value: 'this is ancestor label',
+ language: 'fr',
+ protected: 'false',
+ shortDescription: 'this is ancestor label',
+ },
+ '@_xmlns': 'http://soap.sforce.com/2006/04/metadata',
+ },
+ }
+
+ const ours: JsonValue = {
+ CustomLabels: {
+ labels: {
+ fullName: 'tested_label',
+ value: 'this is ancestor label',
+ language: 'fr',
+ protected: 'false',
+ shortDescription: 'this is ancestor label',
+ },
+ '@_xmlns': 'http://soap.sforce.com/2006/04/metadata',
+ },
+ }
+
+ const theirs: JsonValue = {
+ CustomLabels: {
+ labels: {
+ fullName: 'tested_label',
+ value: 'this is ancestor label',
+ language: 'fr',
+ protected: 'false',
+ shortDescription: 'this is ancestor label',
+ },
+ '@_xmlns': 'http://soap.sforce.com/2006/04/metadata',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ CustomLabels: [
+ {
+ labels: [
+ { fullName: [{ '#text': 'tested_label' }] },
+ { language: [{ '#text': 'fr' }] },
+ { protected: [{ '#text': 'false' }] },
+ {
+ shortDescription: [{ '#text': 'this is ancestor label' }],
+ },
+ { value: [{ '#text': 'this is ancestor label' }] },
+ ],
+ },
+ ],
+ ':@': {
+ '@_xmlns': 'http://soap.sforce.com/2006/04/metadata',
+ },
+ },
+ ])
+ })
+
+ // TODO think about if we check for conflicts and what to output in suhc cases
+ })
+
// KGO: removed because should never happen
// describe('given type conflicts', () => {
// it('should prefer our changes when types conflict', () => {
From fbd8f9a018bfde1d38a839f3cb27ffd18578e5fd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 21 Mar 2025 17:21:14 +0100
Subject: [PATCH 41/55] refactor: mutualize test cases
---
src/merger/JsonMerger.ts | 141 ---
test/unit/merger/JsonMerger.test.ts | 1269 ++++++++++-----------------
2 files changed, 455 insertions(+), 955 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 2e8f921..f66b737 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -192,76 +192,6 @@ export class JsonMerger {
}
return mergedContent
- // Handle root object (e.g., Profile)
- // if (
- // typeof ours === 'object' &&
- // ours !== null &&
- // !Array.isArray(ours) &&
- // typeof theirs === 'object' &&
- // theirs !== null &&
- // !Array.isArray(theirs)
- // ) {
- // // Get the base attribute (e.g., Profile)
- // const baseKey = Object.keys(ours)[0]
- // if (baseKey && Object.keys(theirs)[0] === baseKey) {
- // const result = { ...ours } as JsonObject
-
- // // Get the content of the base attribute
- // const ourContent = ours[baseKey] as JsonObject
- // const theirContent = theirs[baseKey] as JsonObject
- // const ancestorContent =
- // ancestor &&
- // typeof ancestor === 'object' &&
- // !Array.isArray(ancestor) &&
- // baseKey in ancestor
- // ? ((ancestor as JsonObject)[baseKey] as JsonObject)
- // : {}
-
- // // Get all properties from both contents
- // const allProperties = new Set([
- // ...Object.keys(ourContent),
- // ...Object.keys(theirContent),
- // ])
-
- // // Process each property
- // const mergedContent = { ...ourContent } as JsonObject
- // for (const property of allProperties) {
- // // Skip if property doesn't exist in their content
- // if (!(property in theirContent)) continue
-
- // // Use their version if property doesn't exist in our content
- // if (!(property in mergedContent)) {
- // mergedContent[property] = this.ensureArray(theirContent[property])
- // continue
- // }
-
- // // Ensure both values are arrays
- // const ourArray = this.ensureArray(mergedContent[property])
- // const theirArray = this.ensureArray(theirContent[property])
- // const ancestorArray =
- // property in ancestorContent
- // ? this.ensureArray(ancestorContent[property])
- // : []
-
- // // Get the key field for this property if available
- // const keyField = this.getKeyField(property)
-
- // // Merge the arrays
- // mergedContent[property] = this.mergeArrays(
- // ancestorArray,
- // ourArray,
- // theirArray,
- // keyField
- // )
- // }
-
- // result[baseKey] = mergedContent
- // return result
- // }
- // }
-
- // // Default to our version for other cases
- // return ours
}
private mergeTextAttribute(
@@ -626,76 +556,5 @@ export class JsonMerger {
}
return finalArray
- // original by scolladon
- // const result = [...ours]
- // const processed = new Set<string>()
-
- // // Create maps for efficient lookups
- // const ourMap = new Map<string, JsonValue>()
- // const theirMap = new Map<string, JsonValue>()
- // const ancestorMap = new Map<string, JsonValue>()
-
- // // Populate maps
- // for (const item of ours) {
- // const key = this.getItemKey(item, keyField)
- // if (key) ourMap.set(key, item)
- // }
-
- // for (const item of theirs) {
- // const key = this.getItemKey(item, keyField)
- // if (key) theirMap.set(key, item)
- // }
-
- // for (const item of ancestor) {
- // const key = this.getItemKey(item, keyField)
- // if (key) ancestorMap.set(key, item)
- // }
-
- // // Process items in our version
- // for (let i = 0; i < result.length; i++) {
- // const key = this.getItemKey(result[i], keyField)
- // if (!key) continue
-
- // processed.add(key)
-
- // // If item exists in both versions
- // if (theirMap.has(key)) {
- // const theirItem = theirMap.get(key)!
- // const ancestorItem = ancestorMap.get(key)
-
- // // If they changed it from ancestor but we didn't, use their version
- // if (
- // !isEqual(theirItem, ancestorItem) &&
- // isEqual(result[i], ancestorItem)
- // ) {
- // result[i] = theirItem
- // }
- // }
- // }
-
- // // Add items that only exist in their version
- // const uniqueTheirItems = differenceWith(
- // Array.from(theirMap.values()),
- // result,
- // (a, b) => this.getItemKey(a, keyField) === this.getItemKey(b, keyField)
- // )
- // result.push(...uniqueTheirItems)
-
- // return result
}
-
- /**
- * Gets the key value for an item using the specified key field
- */
- // private getItemKey(item: JsonValue, keyField: string): string | undefined {
- // if (
- // typeof item === 'object' &&
- // item !== null &&
- // !Array.isArray(item) &&
- // keyField in item
- // ) {
- // return String(item[keyField])
- // }
- // return undefined
- // }
}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 21c5440..e86a3d5 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -377,41 +377,8 @@ describe('JsonMerger', () => {
},
])
})
-
- // TODO think about if we check for conflicts and what to output in suhc cases
})
- // KGO: removed because should never happen
- // describe('given type conflicts', () => {
- // it('should prefer our changes when types conflict', () => {
- // // Arrange
- // const ancestor: JsonValue = {
- // settings: { enabled: 'false' },
- // }
-
- // const ours: JsonValue = {
- // settings: ['option1', 'option2'],
- // }
-
- // const theirs: JsonValue = {
- // settings: { enabled: 'true', newSetting: 'value' },
- // }
-
- // // Act
- // const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // // Assert
- // expect(result).toEqual({
- // settings: {
- // '0': 'option1',
- // '1': 'option2',
- // enabled: ['true'],
- // newSetting: ['value'],
- // },
- // })
- // })
- // })
-
describe('given undefined ancestor', () => {
it('should correctly merge objects when ancestor is undefined', () => {
// Arrange
@@ -490,9 +457,11 @@ describe('JsonMerger', () => {
])
})
- it('should correctly merge arrays with key field when ancestor is undefined', () => {
+ it('should correctly merge objects when ancestor key undefined', () => {
// Arrange
- const ancestor = {}
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
const ours: JsonValue = {
Profile: {
@@ -503,14 +472,118 @@ describe('JsonMerger', () => {
}
const theirs: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ fieldPermissions: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ { editable: [{ '#text': 'true' }] },
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
+ { editable: [{ '#text': 'false' }] },
+ { '#text': '>>>>>>> REMOTE' },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ ],
+ },
+ ])
+ })
+ })
+
+ describe('given undefined their', () => {
+ it('should correctly merge objects', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '||||||| BASE' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '=======' },
+ { '#text': '\n' },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects when theirs is undefined', () => {
+ // Arrange
+ const ancestor: JsonValue = {
Profile: {
fieldPermissions: [
{ field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value2', 'Value4'],
+ description: 'Their description',
+ },
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
{ field: 'Account.Type', editable: 'false', readable: 'true' },
],
+ custom: ['Value1', 'Value3'],
},
}
+ const theirs = {}
+
// Act
const result = sut.mergeObjects(ancestor, ours, theirs)
@@ -519,6 +592,7 @@ describe('JsonMerger', () => {
{ '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
+ { custom: ['Value1', 'Value3'] },
{
fieldPermissions: [
{ editable: [{ '#text': 'true' }] },
@@ -526,46 +600,119 @@ describe('JsonMerger', () => {
{ readable: [{ '#text': 'true' }] },
],
},
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
],
},
{ '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
{
Profile: [
+ { custom: ['Value2', 'Value4'] },
+ { description: [{ '#text': 'Their description' }] },
{
fieldPermissions: [
{ editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
+ { readable: [{ '#text': 'true' }] },
],
},
{
fieldPermissions: [
{ editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Type' }] },
- { readable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
],
},
],
},
+ { '#text': '=======' },
+ { '#text': '\n' },
{ '#text': '>>>>>>> REMOTE' },
])
})
+ })
- it('should correctly merge arrays without key field when ancestor is undefined', () => {
+ describe('given undefined our', () => {
+ it('should correctly merge objects', () => {
// Arrange
- const ancestor = {}
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
const ours: JsonValue = {
+ Profile: {},
+ }
+
+ const theirs: JsonValue = {
Profile: {
- custom: ['Value1', 'Value3'],
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'true' },
+ ],
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ { '#text': '\n' },
+ { '#text': '||||||| BASE' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '=======' },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
+ })
+
+ it('should correctly merge objects', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'false', readable: 'false' },
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value2', 'Value4'],
+ description: 'Their description',
},
}
+ const ours = {}
+
const theirs: JsonValue = {
Profile: {
- custom: ['Value1', 'Value2', 'Value4'],
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ { field: 'Account.Type', editable: 'false', readable: 'true' },
+ ],
+ custom: ['Value1', 'Value3'],
},
}
@@ -575,20 +722,45 @@ describe('JsonMerger', () => {
// Assert
expect(result).toEqual([
{ '#text': '\n<<<<<<< LOCAL' },
+ { '#text': '\n' },
+ { '#text': '||||||| BASE' },
{
Profile: [
+ { custom: ['Value2', 'Value4'] },
+ { description: [{ '#text': 'Their description' }] },
{
- custom: ['Value1', 'Value3'],
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Industry' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'false' }] },
+ ],
},
],
},
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
{ '#text': '=======' },
{
Profile: [
+ { custom: ['Value1', 'Value3'] },
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.Name' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
{
- custom: ['Value1', 'Value2', 'Value4'],
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.Type' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
},
],
},
@@ -597,21 +769,9 @@ describe('JsonMerger', () => {
})
})
- it('should correctly merge objects when ancestor key undefined', () => {
+ it('only ancestor key present should just be removed', () => {
// Arrange
const ancestor: JsonValue = {
- Profile: {},
- }
-
- const ours: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const theirs: JsonValue = {
Profile: {
fieldPermissions: [
{ field: 'Account.Name', editable: 'true', readable: 'true' },
@@ -619,45 +779,12 @@ describe('JsonMerger', () => {
},
}
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- fieldPermissions: [
- { editable: [{ '#text': 'true' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- ],
- },
- ])
- })
-
- it('should correctly merge objects when ancestor key undefined', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {},
- }
-
const ours: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
+ Profile: {},
}
const theirs: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
+ Profile: {},
}
// Act
@@ -666,670 +793,178 @@ describe('JsonMerger', () => {
// Assert
expect(result).toEqual([
{
- Profile: [
- {
- fieldPermissions: [
- { '#text': '\n<<<<<<< LOCAL' },
- { editable: [{ '#text': 'true' }] },
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
- { editable: [{ '#text': 'false' }] },
- { '#text': '>>>>>>> REMOTE' },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- ],
+ Profile: [],
},
])
})
- it('should correctly merge objects when their key undefined', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const ours: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
- }
-
- const theirs: JsonValue = {
- Profile: {},
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- { '#text': '\n<<<<<<< LOCAL' },
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- { '#text': '||||||| BASE' },
- {
- fieldPermissions: [
- { editable: [{ '#text': 'true' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- { '#text': '=======' },
- { '#text': '\n' },
- { '#text': '>>>>>>> REMOTE' },
- ],
- },
- ])
- })
-
- it('should correctly merge objects when our key undefined', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const ours: JsonValue = {
- Profile: {},
- }
-
- const theirs: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- { '#text': '\n<<<<<<< LOCAL' },
- { '#text': '\n' },
- { '#text': '||||||| BASE' },
- {
- fieldPermissions: [
- { editable: [{ '#text': 'true' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- { '#text': '=======' },
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- { '#text': '>>>>>>> REMOTE' },
- ],
- },
- ])
- })
-
- it('only ancestor key present should just be removed', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const ours: JsonValue = {
- Profile: {},
- }
-
- const theirs: JsonValue = {
- Profile: {},
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [],
- },
- ])
- })
-
- it('should correctly merge objects when our key undefined', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const ours: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
- }
-
- const theirs: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- ],
- },
- ])
- })
-
- it('should correctly merge objects when our key undefined', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const ours: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const theirs: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- ],
- },
- ])
- })
-
- it('should correctly merge objects when our key undefined', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- const ours: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'true' },
- ],
- },
- }
-
- const theirs: JsonValue = {
- Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- ],
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- ],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Original description',
- },
- }
-
- const ours: JsonValue = {
- Profile: {
- description: 'Original description',
- },
- }
-
- const theirs: JsonValue = {
- Profile: {
- description: 'Original description',
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- description: [{ '#text': 'Original description' }],
- },
- ],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {},
- }
-
- const ours: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- const theirs: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- description: [{ '#text': 'Our description' }],
- },
- ],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- const ours: JsonValue = {
- Profile: {},
- }
-
- const theirs: JsonValue = {
- Profile: {},
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- const ours: JsonValue = {
- Profile: {},
- }
-
- const theirs: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- const ours: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- const theirs: JsonValue = {
- Profile: {},
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {}
-
- const ours: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- const theirs: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
-
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
-
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- {
- description: [{ '#text': 'Our description' }],
- },
- ],
- },
- ])
- })
-
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {},
- }
+ describe('Nominal case', () => {
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
- const ours: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
- const theirs: JsonValue = {
- Profile: {
- description: 'Their description',
- },
- }
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Original description',
+ },
+ }
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- { '#text': '\n<<<<<<< LOCAL' },
- {
- description: [{ '#text': 'Our description' }],
- },
- { '#text': '||||||| BASE' },
- { '#text': '\n' },
- { '#text': '=======' },
- {
- description: [{ '#text': 'Their description' }],
- },
- { '#text': '>>>>>>> REMOTE' },
- ],
- },
- ])
- })
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ ],
+ },
+ ])
+ })
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Original description',
- },
- }
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
- const ours: JsonValue = {
- Profile: {},
- }
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
- const theirs: JsonValue = {
- Profile: {
- description: 'Their description',
- },
- }
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- { '#text': '\n<<<<<<< LOCAL' },
- { '#text': '\n' },
- { '#text': '||||||| BASE' },
- {
- description: [{ '#text': 'Original description' }],
- },
- { '#text': '=======' },
- {
- description: [{ '#text': 'Their description' }],
- },
- { '#text': '>>>>>>> REMOTE' },
- ],
- },
- ])
- })
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ ],
+ },
+ ])
+ })
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Original description',
- },
- }
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
- const ours: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
+ const ours: JsonValue = {
+ Profile: {},
+ }
- const theirs: JsonValue = {
- Profile: {},
- }
+ const theirs: JsonValue = {
+ Profile: {},
+ }
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- { '#text': '\n<<<<<<< LOCAL' },
- {
- description: [{ '#text': 'Our description' }],
- },
- { '#text': '||||||| BASE' },
- {
- description: [{ '#text': 'Original description' }],
- },
- { '#text': '=======' },
- { '#text': '\n' },
- { '#text': '>>>>>>> REMOTE' },
- ],
- },
- ])
- })
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
- it('should handle string values', () => {
- // Arrange
- const ancestor: JsonValue = {
- Profile: {
- description: 'Original description',
- },
- }
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
- const ours: JsonValue = {
- Profile: {
- description: 'Our description',
- },
- }
+ const ours: JsonValue = {
+ Profile: {},
+ }
- const theirs: JsonValue = {
- Profile: {
- description: 'Their description',
- },
- }
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
- // Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
- // Assert
- expect(result).toEqual([
- {
- Profile: [
- { '#text': '\n<<<<<<< LOCAL' },
- {
- description: [{ '#text': 'Our description' }],
- },
- { '#text': '||||||| BASE' },
- {
- description: [{ '#text': 'Original description' }],
- },
- { '#text': '=======' },
- {
- description: [{ '#text': 'Their description' }],
- },
- { '#text': '>>>>>>> REMOTE' },
- ],
- },
- ])
- })
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
- describe('given undefined ours', () => {
- it('should correctly merge objects when ours is undefined', () => {
+ it('should handle string values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'false' },
- { field: 'Account.Industry', editable: 'false', readable: 'true' },
- ],
- custom: ['Value2', 'Value4'],
- description: 'Their description',
+ description: 'Our description',
},
}
- const ours = {}
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {},
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
+ {
+ Profile: [],
+ },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {}
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
const theirs: JsonValue = {
Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'true' },
- ],
- custom: ['Value1', 'Value3'],
+ description: 'Our description',
},
}
@@ -1338,50 +973,54 @@ describe('JsonMerger', () => {
// Assert
expect(result).toEqual([
- { '#text': '\n<<<<<<< LOCAL' },
- { '#text': '\n' },
- { '#text': '||||||| BASE' },
{
Profile: [
- { custom: ['Value2', 'Value4'] },
- { description: [{ '#text': 'Their description' }] },
{
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Industry' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'false' }] },
- ],
+ description: [{ '#text': 'Our description' }],
},
],
},
- { '#text': '=======' },
+ ])
+ })
+
+ it('should handle string values', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {},
+ }
+
+ const ours: JsonValue = {
+ Profile: {
+ description: 'Our description',
+ },
+ }
+
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Their description',
+ },
+ }
+
+ // Act
+ const result = sut.mergeObjects(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([
{
Profile: [
- { custom: ['Value1', 'Value3'] },
+ { '#text': '\n<<<<<<< LOCAL' },
{
- fieldPermissions: [
- { editable: [{ '#text': 'true' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
+ description: [{ '#text': 'Our description' }],
},
+ { '#text': '||||||| BASE' },
+ { '#text': '\n' },
+ { '#text': '=======' },
{
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Type' }] },
- { readable: [{ '#text': 'true' }] },
- ],
+ description: [{ '#text': 'Their description' }],
},
+ { '#text': '>>>>>>> REMOTE' },
],
},
- { '#text': '>>>>>>> REMOTE' },
])
})
@@ -1389,15 +1028,17 @@ describe('JsonMerger', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- description: 'Our description',
+ description: 'Original description',
},
}
- const ours: JsonValue = {}
+ const ours: JsonValue = {
+ Profile: {},
+ }
const theirs: JsonValue = {
Profile: {
- description: 'Our description',
+ description: 'Their description',
},
}
@@ -1405,14 +1046,30 @@ describe('JsonMerger', () => {
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([])
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ { '#text': '\n' },
+ { '#text': '||||||| BASE' },
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ { '#text': '=======' },
+ {
+ description: [{ '#text': 'Their description' }],
+ },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
})
it('should handle string values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- description: 'Our description',
+ description: 'Original description',
},
}
@@ -1422,91 +1079,75 @@ describe('JsonMerger', () => {
},
}
- const theirs: JsonValue = {}
+ const theirs: JsonValue = {
+ Profile: {},
+ }
// Act
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([])
+ expect(result).toEqual([
+ {
+ Profile: [
+ { '#text': '\n<<<<<<< LOCAL' },
+ {
+ description: [{ '#text': 'Our description' }],
+ },
+ { '#text': '||||||| BASE' },
+ {
+ description: [{ '#text': 'Original description' }],
+ },
+ { '#text': '=======' },
+ { '#text': '\n' },
+ { '#text': '>>>>>>> REMOTE' },
+ ],
+ },
+ ])
})
- })
- describe('given undefined theirs', () => {
- it('should correctly merge objects when theirs is undefined', () => {
+ it('should handle string values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'false', readable: 'false' },
- { field: 'Account.Industry', editable: 'false', readable: 'true' },
- ],
- custom: ['Value2', 'Value4'],
- description: 'Their description',
+ description: 'Original description',
},
}
const ours: JsonValue = {
Profile: {
- fieldPermissions: [
- { field: 'Account.Name', editable: 'true', readable: 'true' },
- { field: 'Account.Type', editable: 'false', readable: 'true' },
- ],
- custom: ['Value1', 'Value3'],
+ description: 'Our description',
},
}
- const theirs = {}
+ const theirs: JsonValue = {
+ Profile: {
+ description: 'Their description',
+ },
+ }
// Act
const result = sut.mergeObjects(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
- { '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
- { custom: ['Value1', 'Value3'] },
+ { '#text': '\n<<<<<<< LOCAL' },
{
- fieldPermissions: [
- { editable: [{ '#text': 'true' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'true' }] },
- ],
- },
- {
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Type' }] },
- { readable: [{ '#text': 'true' }] },
- ],
+ description: [{ '#text': 'Our description' }],
},
- ],
- },
- { '#text': '||||||| BASE' },
- {
- Profile: [
- { custom: ['Value2', 'Value4'] },
- { description: [{ '#text': 'Their description' }] },
+ { '#text': '||||||| BASE' },
{
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Industry' }] },
- { readable: [{ '#text': 'true' }] },
- ],
+ description: [{ '#text': 'Original description' }],
},
+ { '#text': '=======' },
{
- fieldPermissions: [
- { editable: [{ '#text': 'false' }] },
- { field: [{ '#text': 'Account.Name' }] },
- { readable: [{ '#text': 'false' }] },
- ],
+ description: [{ '#text': 'Their description' }],
},
+ { '#text': '>>>>>>> REMOTE' },
],
},
- { '#text': '=======' },
- { '#text': '\n' },
- { '#text': '>>>>>>> REMOTE' },
])
})
})
From 9e7cadaa11887be15e37e8f670fda2d94a90a5db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 21 Mar 2025 18:52:37 +0100
Subject: [PATCH 42/55] refactor: use metadataService
---
src/constant/metadataConstant.ts | 57 +---
src/merger/JsonMerger.ts | 70 +----
src/service/MetadataService.ts | 81 +++++
src/types/jsonTypes.ts | 13 +
test/unit/merger/JsonMerger.test.ts | 194 +++++++++---
test/unit/service/MetadataService.test.ts | 367 ++++++++++++++++++++++
6 files changed, 634 insertions(+), 148 deletions(-)
create mode 100644 src/service/MetadataService.ts
create mode 100644 src/types/jsonTypes.ts
create mode 100644 test/unit/service/MetadataService.test.ts
diff --git a/src/constant/metadataConstant.ts b/src/constant/metadataConstant.ts
index a37e261..4f7014a 100644
--- a/src/constant/metadataConstant.ts
+++ b/src/constant/metadataConstant.ts
@@ -1,56 +1,7 @@
-export const KEY_FIELD_METADATA = {
- marketingAppExtActivities: 'fullName',
- alerts: 'fullName',
- fieldUpdates: 'fullName',
- flowActions: 'fullName',
- outboundMessages: 'fullName',
- rules: 'fullName',
- knowledgePublishes: 'fullName',
- tasks: 'fullName',
- send: 'fullName',
- sharingCriteriaRules: 'fullName',
- sharingGuestRules: 'fullName',
- sharingOwnerRules: 'fullName',
- sharingTerritoryRules: 'fullName',
- assignmentRule: 'fullName',
- autoResponseRule: 'fullName',
- escalationRule: 'fullName',
- matchingRules: 'fullName',
- valueTranslation: 'masterLabel',
- categoryGroupVisibilities: 'dataCategoryGroup',
- applicationVisibilities: 'application',
- classAccesses: 'apexClass',
- customMetadataTypeAccesses: 'name',
- customPermissions: 'name',
- customSettingAccesses: 'name',
- externalDataSourceAccesses: 'externalDataSource',
- fieldPermissions: 'field',
- flowAccesses: 'flow',
- loginFlows: 'friendlyname',
- layoutAssignments: '<object>',
- loginHours: '<array>',
- loginIpRanges: '<array>',
- objectPermissions: 'object',
- pageAccesses: 'apexPage',
- profileActionOverrides: 'actionName',
- recordTypeVisibilities: 'recordType',
- tabVisibilities: 'tab',
- userPermissions: 'name',
- bots: 'fullName',
- customApplications: 'name',
- customLabels: 'name',
- customPageWebLinks: 'name',
- customTabs: 'name',
- flowDefinitions: 'fullName',
- pipelineInspMetricConfigs: 'name',
- prompts: 'name',
- quickActions: 'name',
- reportTypes: 'name',
- scontrols: 'name',
- standardValue: 'fullName',
- customValue: 'fullName',
- labels: 'fullName',
-}
+/**
+ * Note: KEY_FIELD_METADATA has been moved to MetadataService
+ * @see MetadataService for key field extraction logic
+ */
export const METADATA_TYPES_PATTERNS = [
'assignmentRules',
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index f66b737..4438457 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,21 +1,13 @@
import { castArray, isEqual, isNil, keyBy, unionWith } from 'lodash-es' // , differenceWith
-import { KEY_FIELD_METADATA } from '../constant/metadataConstant.js'
-
-export type JsonValue =
- | string
- | number
- | boolean
- | null
- | JsonObject
- | JsonArray
-
-interface JsonObject {
- [key: string]: JsonValue
-}
-
-interface JsonArray extends Array<JsonValue> {}
+import { MetadataService } from '../service/MetadataService.js'
+import { JsonArray, JsonObject, JsonValue } from '../types/jsonTypes.js'
export class JsonMerger {
+ private metadataService: MetadataService
+ constructor() {
+ this.metadataService = new MetadataService()
+ }
+
/**
* Main entry point for merging JSON values
*/
@@ -302,10 +294,10 @@ export class JsonMerger {
/**
* Gets the key field for a property from KEY_FIELD_METADATA
*/
- private getKeyField(property: string): string | undefined {
- return property in KEY_FIELD_METADATA
- ? KEY_FIELD_METADATA[property as keyof typeof KEY_FIELD_METADATA]
- : undefined
+ private getKeyField(
+ property: string
+ ): ((el: JsonValue) => string) | undefined {
+ return this.metadataService.getKeyFieldExtractor(property)
}
/**
@@ -317,7 +309,7 @@ export class JsonMerger {
theirs: JsonArray,
parent: JsonArray,
attribute: string,
- keyField?: string
+ keyField?: (el: JsonValue) => string
): JsonArray {
const propObject = {}
// If no key field, use unionWith to merge arrays without duplicates
@@ -326,12 +318,6 @@ export class JsonMerger {
return [propObject]
}
- // Special case for array position
- if (keyField === '<array>') {
- propObject[attribute] = this.mergeByPosition(ancestor, ours, theirs)
- return [propObject]
- }
-
// Merge using key field
return this.mergeByKeyField(
ancestor,
@@ -343,36 +329,6 @@ export class JsonMerger {
)
}
- /**
- * Merges arrays by position
- */
- private mergeByPosition(
- ancestor: JsonArray,
- ours: JsonArray,
- theirs: JsonArray
- ): JsonArray {
- const result = [...ours]
-
- // Merge items at the same positions
- for (let i = 0; i < Math.min(ours.length, theirs.length); i++) {
- const ancestorItem = i < ancestor.length ? ancestor[i] : undefined
-
- // If they changed it from ancestor but we didn't, use their version
- if (!isEqual(theirs[i], ancestorItem) && isEqual(ours[i], ancestorItem)) {
- result[i] = theirs[i]
- }
- }
-
- // Add items that only exist in their version
- if (theirs.length > ours.length) {
- for (let i = ours.length; i < theirs.length; i++) {
- result.push(theirs[i])
- }
- }
-
- return result
- }
-
/**
* Merges arrays using a key field
*/
@@ -380,7 +336,7 @@ export class JsonMerger {
ancestor: JsonArray,
ours: JsonArray,
theirs: JsonArray,
- keyField: string,
+ keyField: (el: JsonValue) => string,
attribute: string,
parent: JsonArray
): JsonArray {
diff --git a/src/service/MetadataService.ts b/src/service/MetadataService.ts
new file mode 100644
index 0000000..e0d4fad
--- /dev/null
+++ b/src/service/MetadataService.ts
@@ -0,0 +1,81 @@
+import { JsonValue } from '../types/jsonTypes.js'
+
+export class MetadataService {
+ public getKeyFieldExtractor(
+ metadataType: string
+ ): ((el: JsonValue) => string) | undefined {
+ return metadataType in METADATA_KEY_EXTRACTORS
+ ? METADATA_KEY_EXTRACTORS[
+ metadataType as keyof typeof METADATA_KEY_EXTRACTORS
+ ]
+ : undefined
+ }
+}
+
+const getPropertyValue = (el: JsonValue, property: string) =>
+ String((el as Record<string, unknown>)[property])
+const METADATA_KEY_EXTRACTORS = {
+ marketingAppExtActivities: (el: JsonValue) =>
+ getPropertyValue(el, 'fullName'),
+ alerts: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ fieldUpdates: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ flowActions: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ outboundMessages: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ rules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ knowledgePublishes: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ tasks: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ send: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ sharingCriteriaRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ sharingGuestRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ sharingOwnerRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ sharingTerritoryRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ assignmentRule: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ autoResponseRule: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ escalationRule: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ matchingRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ valueTranslation: (el: JsonValue) => getPropertyValue(el, 'masterLabel'),
+ categoryGroupVisibilities: (el: JsonValue) =>
+ getPropertyValue(el, 'dataCategoryGroup'),
+ applicationVisibilities: (el: JsonValue) =>
+ getPropertyValue(el, 'application'),
+ classAccesses: (el: JsonValue) => getPropertyValue(el, 'apexClass'),
+ customMetadataTypeAccesses: (el: JsonValue) => getPropertyValue(el, 'name'),
+ customPermissions: (el: JsonValue) => getPropertyValue(el, 'name'),
+ customSettingAccesses: (el: JsonValue) => getPropertyValue(el, 'name'),
+ externalDataSourceAccesses: (el: JsonValue) =>
+ getPropertyValue(el, 'externalDataSource'),
+ fieldPermissions: (el: JsonValue) => getPropertyValue(el, 'field'),
+ flowAccesses: (el: JsonValue) => getPropertyValue(el, 'flow'),
+ loginFlows: (el: JsonValue) => getPropertyValue(el, 'friendlyname'),
+ layoutAssignments: (el: JsonValue) => {
+ const layout = getPropertyValue(el, 'layout')
+ const recordType = getPropertyValue(el, 'recordType')
+ return [layout, recordType].filter(x => x !== String(undefined)).join('.')
+ },
+ loginHours: (el: JsonValue) => Object.keys(el!).join(','),
+ loginIpRanges: (el: JsonValue) => {
+ const startAddress = getPropertyValue(el, 'startAddress')
+ const endAddress = getPropertyValue(el, 'endAddress')
+ return `${startAddress}-${endAddress}`
+ },
+ objectPermissions: (el: JsonValue) => getPropertyValue(el, 'object'),
+ pageAccesses: (el: JsonValue) => getPropertyValue(el, 'apexPage'),
+ profileActionOverrides: (el: JsonValue) => getPropertyValue(el, 'actionName'),
+ recordTypeVisibilities: (el: JsonValue) => getPropertyValue(el, 'recordType'),
+ tabVisibilities: (el: JsonValue) => getPropertyValue(el, 'tab'),
+ userPermissions: (el: JsonValue) => getPropertyValue(el, 'name'),
+ bots: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ customApplications: (el: JsonValue) => getPropertyValue(el, 'name'),
+ customLabels: (el: JsonValue) => getPropertyValue(el, 'name'),
+ customPageWebLinks: (el: JsonValue) => getPropertyValue(el, 'name'),
+ customTabs: (el: JsonValue) => getPropertyValue(el, 'name'),
+ flowDefinitions: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ pipelineInspMetricConfigs: (el: JsonValue) => getPropertyValue(el, 'name'),
+ prompts: (el: JsonValue) => getPropertyValue(el, 'name'),
+ quickActions: (el: JsonValue) => getPropertyValue(el, 'name'),
+ reportTypes: (el: JsonValue) => getPropertyValue(el, 'name'),
+ scontrols: (el: JsonValue) => getPropertyValue(el, 'name'),
+ standardValue: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ customValue: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ labels: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+}
diff --git a/src/types/jsonTypes.ts b/src/types/jsonTypes.ts
new file mode 100644
index 0000000..cd55176
--- /dev/null
+++ b/src/types/jsonTypes.ts
@@ -0,0 +1,13 @@
+export type JsonValue =
+ | string
+ | number
+ | boolean
+ | null
+ | JsonObject
+ | JsonArray
+
+export interface JsonObject {
+ [key: string]: JsonValue
+}
+
+export interface JsonArray extends Array<JsonValue> {}
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index e86a3d5..bdc2b1a 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -1,4 +1,5 @@
-import { JsonMerger, JsonValue } from '../../../src/merger/JsonMerger.js'
+import { JsonMerger } from '../../../src/merger/JsonMerger.js'
+import { JsonValue } from '../../../src/types/jsonTypes.js'
describe('JsonMerger', () => {
let sut: JsonMerger
@@ -1152,23 +1153,29 @@ describe('JsonMerger', () => {
})
})
- describe('given arrays with <array> key field', () => {
+ describe('given special metadata kind', () => {
it('should merge arrays by position when both sides modify different elements', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 400 },
+ { thursdayStart: 300, thursdayEnd: 400 },
+ { fridayStart: 300, fridayEnd: 400 },
+ ],
},
}
const ours: JsonValue = {
Profile: {
loginHours: [
- 'Monday-Modified',
- 'Tuesday',
- 'Wednesday',
- 'Thursday',
- 'Friday',
+ { mondayStart: 200, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 400 },
+ { thursdayStart: 300, thursdayEnd: 400 },
+ { fridayStart: 300, fridayEnd: 400 },
],
},
}
@@ -1176,11 +1183,11 @@ describe('JsonMerger', () => {
const theirs: JsonValue = {
Profile: {
loginHours: [
- 'Monday',
- 'Tuesday',
- 'Wednesday-Modified',
- 'Thursday',
- 'Friday',
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 500 },
+ { thursdayStart: 300, thursdayEnd: 400 },
+ { fridayStart: 300, fridayEnd: 400 },
],
},
}
@@ -1194,11 +1201,32 @@ describe('JsonMerger', () => {
Profile: [
{
loginHours: [
- 'Monday-Modified',
- 'Tuesday',
- 'Wednesday-Modified',
- 'Thursday',
- 'Friday',
+ { fridayEnd: [{ '#text': 400 }] },
+ { fridayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { mondayEnd: [{ '#text': 400 }] },
+ { mondayStart: [{ '#text': 200 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { thursdayEnd: [{ '#text': 400 }] },
+ { thursdayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { tuesdayEnd: [{ '#text': 400 }] },
+ { tuesdayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { wednesdayEnd: [{ '#text': 500 }] },
+ { wednesdayStart: [{ '#text': 300 }] },
],
},
],
@@ -1210,19 +1238,37 @@ describe('JsonMerger', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- loginIpRanges: ['192.168.1.1', '10.0.0.1', '172.16.0.1'],
+ loginIpRanges: [
+ {
+ startAddress: '192.168.1.1',
+ endAddress: '10.0.0.1',
+ description: 'description',
+ },
+ ],
},
}
const ours: JsonValue = {
Profile: {
- loginIpRanges: ['192.168.1.1', '10.0.0.1', '172.16.0.1'],
+ loginIpRanges: [
+ {
+ startAddress: '192.168.1.1',
+ endAddress: '10.0.0.1',
+ description: 'description',
+ },
+ ],
},
}
const theirs: JsonValue = {
Profile: {
- loginIpRanges: ['192.168.1.1', '10.0.0.2', '172.16.0.1'],
+ loginIpRanges: [
+ {
+ startAddress: '192.168.1.1',
+ endAddress: '10.0.0.2',
+ description: 'description',
+ },
+ ],
},
}
@@ -1234,7 +1280,11 @@ describe('JsonMerger', () => {
{
Profile: [
{
- loginIpRanges: ['192.168.1.1', '10.0.0.2', '172.16.0.1'],
+ loginIpRanges: [
+ { description: [{ '#text': 'description' }] },
+ { endAddress: [{ '#text': '10.0.0.2' }] },
+ { startAddress: [{ '#text': '192.168.1.1' }] },
+ ],
},
],
},
@@ -1245,19 +1295,33 @@ describe('JsonMerger', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- loginHours: ['Monday', 'Tuesday', 'Wednesday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 400 },
+ ],
},
}
const ours: JsonValue = {
Profile: {
- loginHours: ['Monday', 'Tuesday', 'Wednesday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 400 },
+ ],
},
}
const theirs: JsonValue = {
Profile: {
- loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 400 },
+ { thursdayStart: 300, thursdayEnd: 400 },
+ { fridayStart: 300, fridayEnd: 400 },
+ ],
},
}
@@ -1270,11 +1334,32 @@ describe('JsonMerger', () => {
Profile: [
{
loginHours: [
- 'Monday',
- 'Tuesday',
- 'Wednesday',
- 'Thursday',
- 'Friday',
+ { fridayEnd: [{ '#text': 400 }] },
+ { fridayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { mondayEnd: [{ '#text': 400 }] },
+ { mondayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { thursdayEnd: [{ '#text': 400 }] },
+ { thursdayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { tuesdayEnd: [{ '#text': 400 }] },
+ { tuesdayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { wednesdayEnd: [{ '#text': 400 }] },
+ { wednesdayStart: [{ '#text': 300 }] },
],
},
],
@@ -1286,19 +1371,31 @@ describe('JsonMerger', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
- loginHours: ['Monday', 'Tuesday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ ],
},
}
const ours: JsonValue = {
Profile: {
- loginHours: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 400 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ { wednesdayStart: 300, wednesdayEnd: 400 },
+ { thursdayStart: 300, thursdayEnd: 400 },
+ { fridayStart: 300, fridayEnd: 400 },
+ ],
},
}
const theirs: JsonValue = {
Profile: {
- loginHours: ['Monday-Modified', 'Tuesday'],
+ loginHours: [
+ { mondayStart: 300, mondayEnd: 500 },
+ { tuesdayStart: 300, tuesdayEnd: 400 },
+ ],
},
}
@@ -1311,11 +1408,32 @@ describe('JsonMerger', () => {
Profile: [
{
loginHours: [
- 'Monday-Modified',
- 'Tuesday',
- 'Wednesday',
- 'Thursday',
- 'Friday',
+ { fridayEnd: [{ '#text': 400 }] },
+ { fridayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { mondayEnd: [{ '#text': 500 }] },
+ { mondayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { thursdayEnd: [{ '#text': 400 }] },
+ { thursdayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { tuesdayEnd: [{ '#text': 400 }] },
+ { tuesdayStart: [{ '#text': 300 }] },
+ ],
+ },
+ {
+ loginHours: [
+ { wednesdayEnd: [{ '#text': 400 }] },
+ { wednesdayStart: [{ '#text': 300 }] },
],
},
],
diff --git a/test/unit/service/MetadataService.test.ts b/test/unit/service/MetadataService.test.ts
new file mode 100644
index 0000000..cc653c6
--- /dev/null
+++ b/test/unit/service/MetadataService.test.ts
@@ -0,0 +1,367 @@
+import { MetadataService } from '../../../src/service/MetadataService.js'
+import { JsonValue } from '../../../src/types/jsonTypes.js'
+
+describe('MetadataService', () => {
+ let metadataService: MetadataService
+
+ beforeEach(() => {
+ metadataService = new MetadataService()
+ })
+
+ describe('getKeyFieldExtractor', () => {
+ describe('given a valid metadata type', () => {
+ const testCases = [
+ // fullName extractors
+ {
+ name: 'handles marketingAppExtActivities with fullName',
+ metadataType: 'marketingAppExtActivities',
+ testObject: { fullName: 'TestActivity' },
+ expected: 'TestActivity',
+ },
+ {
+ name: 'handles alerts with fullName',
+ metadataType: 'alerts',
+ testObject: { fullName: 'TestAlert' },
+ expected: 'TestAlert',
+ },
+ {
+ name: 'handles fieldUpdates with fullName',
+ metadataType: 'fieldUpdates',
+ testObject: { fullName: 'TestFieldUpdate' },
+ expected: 'TestFieldUpdate',
+ },
+ {
+ name: 'handles flowActions with fullName',
+ metadataType: 'flowActions',
+ testObject: { fullName: 'TestFlowAction' },
+ expected: 'TestFlowAction',
+ },
+ {
+ name: 'handles outboundMessages with fullName',
+ metadataType: 'outboundMessages',
+ testObject: { fullName: 'TestOutboundMessage' },
+ expected: 'TestOutboundMessage',
+ },
+ {
+ name: 'handles rules with fullName',
+ metadataType: 'rules',
+ testObject: { fullName: 'TestRule' },
+ expected: 'TestRule',
+ },
+ {
+ name: 'handles knowledgePublishes with fullName',
+ metadataType: 'knowledgePublishes',
+ testObject: { fullName: 'TestKnowledgePublish' },
+ expected: 'TestKnowledgePublish',
+ },
+ {
+ name: 'handles tasks with fullName',
+ metadataType: 'tasks',
+ testObject: { fullName: 'TestTask' },
+ expected: 'TestTask',
+ },
+ {
+ name: 'handles send with fullName',
+ metadataType: 'send',
+ testObject: { fullName: 'TestSend' },
+ expected: 'TestSend',
+ },
+ {
+ name: 'handles sharingCriteriaRules with fullName',
+ metadataType: 'sharingCriteriaRules',
+ testObject: { fullName: 'TestSharingCriteriaRule' },
+ expected: 'TestSharingCriteriaRule',
+ },
+ {
+ name: 'handles sharingGuestRules with fullName',
+ metadataType: 'sharingGuestRules',
+ testObject: { fullName: 'TestSharingGuestRule' },
+ expected: 'TestSharingGuestRule',
+ },
+ {
+ name: 'handles sharingOwnerRules with fullName',
+ metadataType: 'sharingOwnerRules',
+ testObject: { fullName: 'TestSharingOwnerRule' },
+ expected: 'TestSharingOwnerRule',
+ },
+ {
+ name: 'handles sharingTerritoryRules with fullName',
+ metadataType: 'sharingTerritoryRules',
+ testObject: { fullName: 'TestSharingTerritoryRule' },
+ expected: 'TestSharingTerritoryRule',
+ },
+ {
+ name: 'handles assignmentRule with fullName',
+ metadataType: 'assignmentRule',
+ testObject: { fullName: 'TestAssignmentRule' },
+ expected: 'TestAssignmentRule',
+ },
+ {
+ name: 'handles autoResponseRule with fullName',
+ metadataType: 'autoResponseRule',
+ testObject: { fullName: 'TestAutoResponseRule' },
+ expected: 'TestAutoResponseRule',
+ },
+ {
+ name: 'handles escalationRule with fullName',
+ metadataType: 'escalationRule',
+ testObject: { fullName: 'TestEscalationRule' },
+ expected: 'TestEscalationRule',
+ },
+ {
+ name: 'handles matchingRules with fullName',
+ metadataType: 'matchingRules',
+ testObject: { fullName: 'TestMatchingRule' },
+ expected: 'TestMatchingRule',
+ },
+ {
+ name: 'handles bots with fullName',
+ metadataType: 'bots',
+ testObject: { fullName: 'TestBot' },
+ expected: 'TestBot',
+ },
+ {
+ name: 'handles flowDefinitions with fullName',
+ metadataType: 'flowDefinitions',
+ testObject: { fullName: 'TestFlowDefinition' },
+ expected: 'TestFlowDefinition',
+ },
+ {
+ name: 'handles standardValue with fullName',
+ metadataType: 'standardValue',
+ testObject: { fullName: 'TestStandardValue' },
+ expected: 'TestStandardValue',
+ },
+ {
+ name: 'handles customValue with fullName',
+ metadataType: 'customValue',
+ testObject: { fullName: 'TestCustomValue' },
+ expected: 'TestCustomValue',
+ },
+ {
+ name: 'handles labels with fullName',
+ metadataType: 'labels',
+ testObject: { fullName: 'TestLabel' },
+ expected: 'TestLabel',
+ },
+
+ // Other property extractors
+ {
+ name: 'handles valueTranslation with masterLabel',
+ metadataType: 'valueTranslation',
+ testObject: { masterLabel: 'TestMasterLabel' },
+ expected: 'TestMasterLabel',
+ },
+ {
+ name: 'handles categoryGroupVisibilities with dataCategoryGroup',
+ metadataType: 'categoryGroupVisibilities',
+ testObject: { dataCategoryGroup: 'TestCategoryGroup' },
+ expected: 'TestCategoryGroup',
+ },
+ {
+ name: 'handles applicationVisibilities with application',
+ metadataType: 'applicationVisibilities',
+ testObject: { application: 'TestApplication' },
+ expected: 'TestApplication',
+ },
+ {
+ name: 'handles classAccesses with apexClass',
+ metadataType: 'classAccesses',
+ testObject: { apexClass: 'TestApexClass' },
+ expected: 'TestApexClass',
+ },
+ {
+ name: 'handles customMetadataTypeAccesses with name',
+ metadataType: 'customMetadataTypeAccesses',
+ testObject: { name: 'TestCustomMetadataType' },
+ expected: 'TestCustomMetadataType',
+ },
+ {
+ name: 'handles customPermissions with name',
+ metadataType: 'customPermissions',
+ testObject: { name: 'TestCustomPermission' },
+ expected: 'TestCustomPermission',
+ },
+ {
+ name: 'handles customSettingAccesses with name',
+ metadataType: 'customSettingAccesses',
+ testObject: { name: 'TestCustomSetting' },
+ expected: 'TestCustomSetting',
+ },
+ {
+ name: 'handles externalDataSourceAccesses with externalDataSource',
+ metadataType: 'externalDataSourceAccesses',
+ testObject: { externalDataSource: 'TestExternalDataSource' },
+ expected: 'TestExternalDataSource',
+ },
+ {
+ name: 'handles fieldPermissions with field',
+ metadataType: 'fieldPermissions',
+ testObject: { field: 'Account.Name' },
+ expected: 'Account.Name',
+ },
+ {
+ name: 'handles flowAccesses with flow',
+ metadataType: 'flowAccesses',
+ testObject: { flow: 'TestFlow' },
+ expected: 'TestFlow',
+ },
+ {
+ name: 'handles loginFlows with friendlyname',
+ metadataType: 'loginFlows',
+ testObject: { friendlyname: 'TestLoginFlow' },
+ expected: 'TestLoginFlow',
+ },
+ {
+ name: 'handles objectPermissions with object',
+ metadataType: 'objectPermissions',
+ testObject: { object: 'TestObject' },
+ expected: 'TestObject',
+ },
+ {
+ name: 'handles pageAccesses with apexPage',
+ metadataType: 'pageAccesses',
+ testObject: { apexPage: 'TestApexPage' },
+ expected: 'TestApexPage',
+ },
+ {
+ name: 'handles profileActionOverrides with actionName',
+ metadataType: 'profileActionOverrides',
+ testObject: { actionName: 'TestActionName' },
+ expected: 'TestActionName',
+ },
+ {
+ name: 'handles recordTypeVisibilities with recordType',
+ metadataType: 'recordTypeVisibilities',
+ testObject: { recordType: 'TestRecordType' },
+ expected: 'TestRecordType',
+ },
+ {
+ name: 'handles tabVisibilities with tab',
+ metadataType: 'tabVisibilities',
+ testObject: { tab: 'TestTab' },
+ expected: 'TestTab',
+ },
+ {
+ name: 'handles userPermissions with name',
+ metadataType: 'userPermissions',
+ testObject: { name: 'TestUserPermission' },
+ expected: 'TestUserPermission',
+ },
+ {
+ name: 'handles customApplications with name',
+ metadataType: 'customApplications',
+ testObject: { name: 'TestCustomApplication' },
+ expected: 'TestCustomApplication',
+ },
+ {
+ name: 'handles customLabels with name',
+ metadataType: 'customLabels',
+ testObject: { name: 'TestCustomLabel' },
+ expected: 'TestCustomLabel',
+ },
+ {
+ name: 'handles customPageWebLinks with name',
+ metadataType: 'customPageWebLinks',
+ testObject: { name: 'TestCustomPageWebLink' },
+ expected: 'TestCustomPageWebLink',
+ },
+ {
+ name: 'handles customTabs with name',
+ metadataType: 'customTabs',
+ testObject: { name: 'TestCustomTab' },
+ expected: 'TestCustomTab',
+ },
+ {
+ name: 'handles pipelineInspMetricConfigs with name',
+ metadataType: 'pipelineInspMetricConfigs',
+ testObject: { name: 'TestPipelineInspMetricConfig' },
+ expected: 'TestPipelineInspMetricConfig',
+ },
+ {
+ name: 'handles prompts with name',
+ metadataType: 'prompts',
+ testObject: { name: 'TestPrompt' },
+ expected: 'TestPrompt',
+ },
+ {
+ name: 'handles quickActions with name',
+ metadataType: 'quickActions',
+ testObject: { name: 'TestQuickAction' },
+ expected: 'TestQuickAction',
+ },
+ {
+ name: 'handles reportTypes with name',
+ metadataType: 'reportTypes',
+ testObject: { name: 'TestReportType' },
+ expected: 'TestReportType',
+ },
+ {
+ name: 'handles scontrols with name',
+ metadataType: 'scontrols',
+ testObject: { name: 'TestScontrol' },
+ expected: 'TestScontrol',
+ },
+
+ // Complex extractors
+ {
+ name: 'handles layoutAssignments with layout and recordType',
+ metadataType: 'layoutAssignments',
+ testObject: {
+ layout: 'TestLayout',
+ recordType: 'TestRecordType',
+ },
+ expected: 'TestLayout.TestRecordType',
+ },
+ {
+ name: 'handles layoutAssignments with only layout',
+ metadataType: 'layoutAssignments',
+ testObject: {
+ layout: 'TestLayout',
+ },
+ expected: 'TestLayout',
+ },
+ {
+ name: 'handles loginHours correctly',
+ metadataType: 'loginHours',
+ testObject: { monday: true, wednesday: true },
+ expected: 'monday,wednesday',
+ },
+ {
+ name: 'handles loginIpRanges correctly',
+ metadataType: 'loginIpRanges',
+ testObject: {
+ startAddress: '192.168.1.1',
+ endAddress: '192.168.1.255',
+ },
+ expected: '192.168.1.1-192.168.1.255',
+ },
+ ]
+
+ test.each(testCases)(
+ '$name',
+ ({ metadataType, testObject, expected }) => {
+ // Act
+ const extractor = metadataService.getKeyFieldExtractor(metadataType)
+
+ // Assert
+ expect(extractor).toBeDefined()
+ expect(extractor!(testObject as unknown as JsonValue)).toBe(expected)
+ }
+ )
+ })
+
+ describe('given a metadata type not in the extractors', () => {
+ it('should return undefined', () => {
+ // Arrange
+ const metadataType = 'nonExistentType'
+
+ // Act
+ const extractor = metadataService.getKeyFieldExtractor(metadataType)
+
+ // Assert
+ expect(extractor).toBeUndefined()
+ })
+ })
+ })
+})
From 21c25661305914ac57c8498a6ab9d5b52ca6fa9e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Sun, 23 Mar 2025 21:53:54 +0100
Subject: [PATCH 43/55] refactor: segregate responsibilities
---
src/constant/conflicConstant.ts | 6 +
src/merger/JsonMerger.ts | 676 +++++++---------------
src/merger/XmlMerger.ts | 2 +-
src/merger/conflictMarker.ts | 24 +
src/merger/textAttribute.ts | 70 +++
src/service/MetadataService.ts | 2 +-
src/service/NamespaceHandler.ts | 45 ++
src/types/mergeScenario.ts | 39 ++
src/utils/mergeUtils.ts | 16 +
test/unit/merger/JsonMerger.test.ts | 56 +-
test/unit/merger/XmlMerger.test.ts | 14 +-
test/unit/service/MetadataService.test.ts | 10 +-
12 files changed, 433 insertions(+), 527 deletions(-)
create mode 100644 src/constant/conflicConstant.ts
create mode 100644 src/merger/conflictMarker.ts
create mode 100644 src/merger/textAttribute.ts
create mode 100644 src/service/NamespaceHandler.ts
create mode 100644 src/types/mergeScenario.ts
create mode 100644 src/utils/mergeUtils.ts
diff --git a/src/constant/conflicConstant.ts b/src/constant/conflicConstant.ts
new file mode 100644
index 0000000..72877d2
--- /dev/null
+++ b/src/constant/conflicConstant.ts
@@ -0,0 +1,6 @@
+export const BASE = '||||||| BASE'
+export const LOCAL = '<<<<<<< LOCAL'
+export const NEWLINE = '\n'
+export const REMOTE = '>>>>>>> REMOTE'
+export const SEPARATOR = '======='
+export const TEXT_TAG = '#text'
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 4438457..bc4388f 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -1,516 +1,228 @@
-import { castArray, isEqual, isNil, keyBy, unionWith } from 'lodash-es' // , differenceWith
+import { isEmpty, isEqual, keyBy, unionWith } from 'lodash-es'
import { MetadataService } from '../service/MetadataService.js'
-import { JsonArray, JsonObject, JsonValue } from '../types/jsonTypes.js'
+import { NamespaceHandler } from '../service/NamespaceHandler.js'
+import type { JsonArray, JsonObject } from '../types/jsonTypes.js'
+import { MergeScenario, getScenario } from '../types/mergeScenario.js'
+import {
+ ensureArray,
+ getUniqueSortedProps,
+ isObject,
+} from '../utils/mergeUtils.js'
+import { addConflictMarkers } from './conflictMarker.js'
+import { mergeTextAttribute } from './textAttribute.js'
export class JsonMerger {
- private metadataService: MetadataService
- constructor() {
- this.metadataService = new MetadataService()
- }
-
- /**
- * Main entry point for merging JSON values
- */
- mergeObjects(
+ public merge(
ancestor: JsonObject | JsonArray,
ours: JsonObject | JsonArray,
- theirs: JsonObject | JsonArray,
- parent?: JsonObject | JsonArray //,
- // attrib?: string
+ theirs: JsonObject | JsonArray
): JsonArray {
- // Get all properties from three ways
- const arrProperties: string[] = []
- let caseCode: number = 0
- if (ancestor && !isEqual(ancestor, {})) {
- caseCode += 100
- arrProperties.push(...Object.keys(ancestor))
- } else {
- ancestor = {}
- }
- if (ours && !isEqual(ours, {})) {
- caseCode += 10
- arrProperties.push(...Object.keys(ours))
- } else {
- ours = {}
- }
- if (theirs && !isEqual(theirs, {})) {
- caseCode += 1
- arrProperties.push(...Object.keys(theirs))
- } else {
- theirs = {}
- }
- const allProperties = new Set(arrProperties.sort())
-
- // TODO filter the namespace here and reapply it in the end of the loop if necessary
-
- // Process each property
- const mergedContent = [] as JsonArray
- for (const property of allProperties) {
- // console.info('property: '+property+'\ntypeof: '+this.getAttributePrimarytype(
- // ancestor[property],
- // ours[property],
- // theirs[property]
- // ))
- switch (
- this.getAttributePrimarytype(
- ancestor[property],
- ours[property],
- theirs[property]
- )
- ) {
- case 'object': {
- if (parent) {
- mergedContent.push(
- ...this.mergeArrays(
- this.ensureArray(ancestor[property]),
- this.ensureArray(ours[property]),
- this.ensureArray(theirs[property]),
- this.ensureArray(parent),
- property,
- this.getKeyField(property)
- )
- )
- } else {
- let propObject = {}
- switch (caseCode) {
- case 100:
- return []
- case 11:
- if (isEqual(ours, theirs)) {
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, ours[property], {}, propObject)
- )
- mergedContent.push(propObject)
- } else {
- mergedContent.push({ '#text': '\n<<<<<<< LOCAL' })
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, ours[property], {}, propObject)
- )
- mergedContent.push(propObject)
- mergedContent.push({ '#text': '||||||| BASE' })
- mergedContent.push({ '#text': '\n' })
- mergedContent.push({ '#text': '=======' })
- propObject = {}
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, {}, theirs[property], propObject)
- )
- mergedContent.push(propObject)
- mergedContent.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- case 101:
- if (isEqual(ancestor, theirs)) {
- return []
- } else {
- mergedContent.push({ '#text': '\n<<<<<<< LOCAL' })
- mergedContent.push({ '#text': '\n' })
- mergedContent.push({ '#text': '||||||| BASE' })
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, ancestor[property], {}, propObject)
- )
- mergedContent.push(propObject)
- mergedContent.push({ '#text': '=======' })
- propObject = {}
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, {}, theirs[property], propObject)
- )
- mergedContent.push(propObject)
- mergedContent.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- case 110:
- if (isEqual(ancestor, ours)) {
- return []
- } else {
- mergedContent.push({ '#text': '\n<<<<<<< LOCAL' })
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, ours[property], {}, propObject)
- )
- mergedContent.push(propObject)
- mergedContent.push({ '#text': '||||||| BASE' })
- propObject = {}
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects({}, {}, ancestor[property], propObject)
- )
- mergedContent.push(propObject)
- mergedContent.push({ '#text': '=======' })
- mergedContent.push({ '#text': '\n' })
- mergedContent.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- default:
- propObject[property] = []
- propObject[property].push(
- ...this.mergeObjects(
- ancestor[property],
- ours[property],
- theirs[property],
- propObject
- )
- )
- mergedContent.push(propObject)
- break
- }
- }
+ const namespaceHandler = new NamespaceHandler()
+ const namespaces = namespaceHandler.processNamespaces(
+ ancestor,
+ ours,
+ theirs
+ )
+ const scenario: MergeScenario = getScenario(ancestor, ours, theirs)
+ const acc: JsonArray[] = []
+ const props = getUniqueSortedProps(ancestor, ours, theirs)
+ for (const key of props) {
+ switch (scenario) {
+ case MergeScenario.ANCESTOR_ONLY:
break
- }
- default:
- if (property.startsWith('@_') && parent) {
- if (parent[':@']) {
- parent[':@'][property] = ancestor[property]
- } else {
- parent[':@'] = {}
- parent[':@'][property] = ancestor[property]
- }
- } else {
- mergedContent.push(
- ...this.mergeTextAttribute(
- property,
- ancestor[property],
- ours[property],
- theirs[property]
- )
- )
+ case MergeScenario.OURS_AND_THEIRS:
+ acc.push(handleOursAndTheirs(key, ours, theirs))
+ break
+ case MergeScenario.ANCESTOR_AND_THEIRS:
+ acc.push(handleAncestorAndTheirs(key, ancestor, theirs))
+ break
+ case MergeScenario.ANCESTOR_AND_OURS:
+ acc.push(handleAncestorAndOurs(key, ancestor, ours))
+ break
+ default: {
+ const obj = {
+ [key]: mergeMetadata(ancestor[key], ours[key], theirs[key]),
}
+ acc.push([obj])
break
+ }
}
}
- return mergedContent
+ const result = acc.flat()
+ namespaceHandler.addNamespacesToResult(result, namespaces)
+ return result
}
+}
+const mergeMetadata = (
+ ancestor: JsonObject | JsonArray,
+ ours: JsonObject | JsonArray,
+ theirs: JsonObject | JsonArray
+): JsonArray => {
+ const acc: JsonArray[] = []
+ const props = getUniqueSortedProps(ancestor, ours, theirs)
+ for (const key of props) {
+ let values: JsonArray = []
- private mergeTextAttribute(
- attrib: string,
- ancestor: JsonValue | null,
- ours: JsonValue | null,
- theirs: JsonValue | null
- ): JsonArray {
- const objAnc: JsonObject = {}
- const objOurs: JsonObject = {}
- const objTheirs: JsonObject = {}
- let caseCode: number = 0
- if (!isNil(ancestor)) {
- objAnc[attrib] = [{ '#text': ancestor }]
- caseCode += 100
- }
- if (!isNil(ours)) {
- objOurs[attrib] = [{ '#text': ours }]
- caseCode += 10
- }
- if (!isNil(theirs)) {
- objTheirs[attrib] = [{ '#text': theirs }]
- caseCode += 1
- }
- const finalArray: JsonArray = []
- switch (caseCode) {
- case 1:
- finalArray.push(objTheirs)
- break
- case 10:
- finalArray.push(objOurs)
- break
- case 11:
- if (ours === theirs) {
- finalArray.push(objOurs)
- } else {
- finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
- finalArray.push(objOurs)
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '=======' })
- finalArray.push(objTheirs)
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- case 101:
- if (ancestor !== theirs) {
- finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push(objAnc)
- finalArray.push({ '#text': '=======' })
- finalArray.push(objTheirs)
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- case 110:
- if (ancestor !== ours) {
- finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
- finalArray.push(objOurs)
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push(objAnc)
- finalArray.push({ '#text': '=======' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- case 111:
- if (ours === theirs) {
- finalArray.push(objOurs)
- } else if (ancestor === ours) {
- finalArray.push(objTheirs)
- } else if (ancestor === theirs) {
- finalArray.push(objOurs)
- } else {
- finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
- finalArray.push(objOurs)
- finalArray.push({ '#text': '||||||| BASE' })
- finalArray.push(objAnc)
- finalArray.push({ '#text': '=======' })
- finalArray.push(objTheirs)
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
- }
- break
- default:
+ if (isObject(ancestor[key], ours[key], theirs[key])) {
+ const [ancestorkey, ourkey, theirkey] = [
+ ancestor[key],
+ ours[key],
+ theirs[key],
+ ].map(ensureArray)
+ values = mergeArrays(ancestorkey, ourkey, theirkey, key)
+ } else {
+ values = mergeTextAttribute(ancestor[key], ours[key], theirs[key], key)
}
- return finalArray
+ acc.push(values)
}
- /**
- * Gets the typeof of the attribute
- */
- private getAttributePrimarytype(
- ancestor: JsonValue | undefined | null,
- ours: JsonValue | undefined | null,
- theirs: JsonValue | undefined | null
- ): string {
- return typeof [ancestor, theirs, ours].find(ele => !isNil(ele))
- }
+ return acc.flat()
+}
- /**
- * Ensures a value is an array
- */
- private ensureArray(value: JsonValue): JsonArray {
- return isNil(value) ? [] : (castArray(value) as JsonArray)
+const handleOursAndTheirs = (
+ key: string,
+ ours: JsonObject | JsonArray,
+ theirs: JsonObject | JsonArray
+): JsonArray => {
+ const obj: JsonObject = {}
+ obj[key] = mergeMetadata({}, ours[key], {})
+ const acc: JsonArray = []
+ if (!isEqual(ours, theirs)) {
+ const theirsProp = {
+ [key]: mergeMetadata({}, {}, theirs[key]),
+ }
+ addConflictMarkers(acc, obj, {}, theirsProp)
+ } else {
+ acc.push(obj)
}
+ return acc
+}
- /**
- * Gets the key field for a property from KEY_FIELD_METADATA
- */
- private getKeyField(
- property: string
- ): ((el: JsonValue) => string) | undefined {
- return this.metadataService.getKeyFieldExtractor(property)
+const handleAncestorAndTheirs = (
+ key: string,
+ ancestor: JsonObject | JsonArray,
+ theirs: JsonObject | JsonArray
+): JsonArray => {
+ const acc: JsonArray = []
+ if (!isEqual(ancestor, theirs)) {
+ const ancestorProp = {
+ [key]: mergeMetadata({}, {}, ancestor[key]),
+ }
+ const theirsProp = {
+ [key]: mergeMetadata({}, {}, theirs[key]),
+ }
+ addConflictMarkers(acc, {}, ancestorProp, theirsProp)
}
+ return acc
+}
- /**
- * Merges arrays using the specified key field if available
- */
- private mergeArrays(
- ancestor: JsonArray,
- ours: JsonArray,
- theirs: JsonArray,
- parent: JsonArray,
- attribute: string,
- keyField?: (el: JsonValue) => string
- ): JsonArray {
- const propObject = {}
- // If no key field, use unionWith to merge arrays without duplicates
- if (!keyField) {
- propObject[attribute] = unionWith([...ours], theirs, isEqual)
- return [propObject]
+const handleAncestorAndOurs = (
+ key: string,
+ ancestor: JsonObject | JsonArray,
+ ours: JsonObject | JsonArray
+): JsonArray => {
+ const acc: JsonArray = []
+ if (!isEqual(ancestor, ours)) {
+ const oursProp = {
+ [key]: mergeMetadata({}, {}, ours[key]),
}
+ const ancestorProp = {
+ [key]: mergeMetadata({}, {}, ancestor[key]),
+ }
+ addConflictMarkers(acc, oursProp, ancestorProp, {})
+ }
+ return acc
+}
- // Merge using key field
- return this.mergeByKeyField(
- ancestor,
- ours,
- theirs,
- keyField,
- attribute,
- parent
- )
+const mergeArrays = (
+ ancestor: JsonArray,
+ ours: JsonArray,
+ theirs: JsonArray,
+ attribute: string
+): JsonArray => {
+ const keyField = MetadataService.getKeyFieldExtractor(attribute)
+ if (!keyField) {
+ const obj = {}
+ obj[attribute] = unionWith(ours, theirs, isEqual)
+ return [obj]
}
- /**
- * Merges arrays using a key field
- */
- private mergeByKeyField(
- ancestor: JsonArray,
- ours: JsonArray,
- theirs: JsonArray,
- keyField: (el: JsonValue) => string,
- attribute: string,
- parent: JsonArray
- ): JsonArray {
- const finalArray: JsonArray = []
- let caseCode: number = 0
- if (ancestor.length !== 0) {
- caseCode += 100
- }
- if (ours.length !== 0) {
- caseCode += 10
- }
- if (theirs.length !== 0) {
- caseCode += 1
- }
- // console.info(
- // 'attribute: ' +
- // attribute +
- // '\nkeyField: ' +
- // keyField +
- // '\ncaseCode: ' +
- // caseCode
- // )
- // console.dir(ours, {depth: null})
- const keyedAnc = keyBy(ancestor, keyField)
- const keyedOurs = keyBy(ours, keyField)
- const keyedTheirs = keyBy(theirs, keyField)
- const allKeys = new Set(
- [
- ...Object.keys(keyedAnc),
- ...Object.keys(keyedOurs),
- ...Object.keys(keyedTheirs),
- ].sort()
+ const [keyedAnc, keyedOurs, keyedTheirs] = [ancestor, ours, theirs].map(arr =>
+ keyBy(arr, keyField)
+ )
+ return mergeByKeyField(keyedAnc, keyedOurs, keyedTheirs, attribute)
+}
+
+const mergeByKeyField = (
+ ancestor: JsonArray,
+ ours: JsonArray,
+ theirs: JsonArray,
+ attribute: string
+): JsonArray => {
+ const acc: JsonArray = []
+ const props = getUniqueSortedProps(ancestor, ours, theirs)
+ for (const key of props) {
+ const scenario: MergeScenario = getScenario(
+ ancestor[key],
+ ours[key],
+ theirs[key]
)
- for (const key of allKeys) {
- caseCode = 0
- if (keyedAnc[key]) {
- caseCode += 100
- }
- if (keyedOurs[key]) {
- caseCode += 10
- }
- if (keyedTheirs[key]) {
- caseCode += 1
- }
- // console.log('caseCode: ' + caseCode);
- let propObject = {}
- switch (caseCode) {
- case 1:
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
- ]
- finalArray.push(propObject)
- break
- case 10:
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- ]
- finalArray.push(propObject)
- break
- case 100:
- break
- case 11:
- if (isEqual(ours, theirs)) {
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- ]
- finalArray.push(propObject)
- } else {
- // finalArray.push({ '#text': '<<<<<<< LOCAL' })
- // propObject[attribute] = [
- // ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- // ]
- // finalArray.push(propObject)
- // finalArray.push({ '#text': '||||||| BASE' })
- // finalArray.push({ '#text': '\n' })
- // finalArray.push({ '#text': '=======' })
- // propObject[attribute] = [
- // ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
- // ]
- // finalArray.push(propObject)
- // finalArray.push({ '#text': '>>>>>>> REMOTE' })
- propObject[attribute] = [
- ...this.mergeObjects(
- {},
- keyedOurs[key],
- keyedTheirs[key],
- parent
- ),
- ]
- finalArray.push(propObject)
+ const obj = {}
+ switch (scenario) {
+ case MergeScenario.THEIRS_ONLY:
+ obj[attribute] = mergeMetadata({}, {}, theirs[key])
+ break
+ case MergeScenario.OURS_ONLY:
+ obj[attribute] = mergeMetadata({}, ours[key], {})
+ break
+ case MergeScenario.ANCESTOR_ONLY:
+ break
+ case MergeScenario.OURS_AND_THEIRS:
+ if (isEqual(ours, theirs)) {
+ obj[attribute] = mergeMetadata({}, {}, theirs[key])
+ } else {
+ obj[attribute] = mergeMetadata({}, ours[key], theirs[key])
+ }
+ break
+ case MergeScenario.ANCESTOR_AND_THEIRS:
+ if (!isEqual(ancestor, theirs)) {
+ const ancestorProp = {
+ [attribute]: mergeMetadata({}, ancestor[key], {}),
}
- break
- case 101:
- if (!isEqual(ancestor, theirs)) {
- finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '||||||| BASE' })
- propObject = {}
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedAnc[key], parent),
- ]
- finalArray.push(propObject)
- finalArray.push({ '#text': '=======' })
- propObject = {}
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
- ]
- finalArray.push(propObject)
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
- // propObject[attribute] = [
- // ...this.mergeObjects(keyedAnc[key], {}, keyedTheirs[key], parent),
- // ]
- // finalArray.push(propObject)
+ const theirsProp = {
+ [attribute]: mergeMetadata({}, {}, theirs[key]),
}
- break
- case 110:
- if (!isEqual(ancestor, ours)) {
- finalArray.push({ '#text': '\n<<<<<<< LOCAL' })
- propObject = {}
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- ]
- finalArray.push(propObject)
- finalArray.push({ '#text': '||||||| BASE' })
- propObject = {}
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedAnc[key], parent),
- ]
- finalArray.push(propObject)
- finalArray.push({ '#text': '=======' })
- finalArray.push({ '#text': '\n' })
- finalArray.push({ '#text': '>>>>>>> REMOTE' })
- // propObject[attribute] = [
- // ...this.mergeObjects(keyedAnc[key], keyedOurs[key], {}, parent),
- // ]
- // finalArray.push(propObject)
+ addConflictMarkers(acc, {}, ancestorProp, theirsProp)
+ }
+ break
+ case MergeScenario.ANCESTOR_AND_OURS:
+ if (!isEqual(ancestor, ours)) {
+ const oursProp = {
+ [attribute]: mergeMetadata({}, ours[key], {}),
}
- break
- case 111:
- if (isEqual(ours, theirs)) {
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- ]
- } else if (isEqual(ancestor, ours)) {
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedTheirs[key], parent),
- ]
- } else if (isEqual(ancestor, theirs)) {
- propObject[attribute] = [
- ...this.mergeObjects({}, {}, keyedOurs[key], parent),
- ]
- } else {
- // finalArray.push({ '#text': '<<<<<<< LOCAL' })
- // finalArray.push(...this.mergeObjects({}, {}, keyedOurs[key], parent))
- // finalArray.push({ '#text': '||||||| BASE' })
- // finalArray.push(...this.mergeObjects({}, {}, keyedAnc[key], parent))
- // finalArray.push({ '#text': '=======' })
- // finalArray.push(...this.mergeObjects({}, {}, keyedTheirs[key], parent))
- // finalArray.push({ '#text': '>>>>>>> REMOTE' })
- propObject[attribute] = [
- ...this.mergeObjects(
- keyedAnc[key],
- keyedOurs[key],
- keyedTheirs[key],
- parent
- ),
- ]
+ const ancestorProp = {
+ [attribute]: mergeMetadata({}, ancestor[key], {}),
}
- finalArray.push(propObject)
- break
- default:
- }
+ addConflictMarkers(acc, oursProp, ancestorProp, {})
+ }
+ break
+ case MergeScenario.ALL:
+ if (isEqual(ours, theirs)) {
+ obj[attribute] = mergeMetadata({}, {}, theirs[key])
+ } else if (isEqual(ancestor[key], ours[key])) {
+ obj[attribute] = mergeMetadata({}, {}, theirs[key])
+ } else if (isEqual(ancestor, theirs)) {
+ obj[attribute] = mergeMetadata({}, ours[key], {})
+ } else {
+ obj[attribute] = mergeMetadata(ancestor[key], ours[key], theirs[key])
+ }
+ break
+ }
+ if (!isEmpty(obj)) {
+ acc.push(obj)
}
-
- return finalArray
}
+
+ return acc
}
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index ede3277..93f60ec 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -57,7 +57,7 @@ export class XmlMerger {
// Perform deep merge of XML objects
const jsonMerger = new JsonMerger()
- const mergedObj = jsonMerger.mergeObjects(ancestorObj, ourObj, theirObj)
+ const mergedObj = jsonMerger.merge(ancestorObj, ourObj, theirObj)
// console.log('mergedObj')
// console.dir(mergedObj, {depth:null})
diff --git a/src/merger/conflictMarker.ts b/src/merger/conflictMarker.ts
new file mode 100644
index 0000000..a7e750a
--- /dev/null
+++ b/src/merger/conflictMarker.ts
@@ -0,0 +1,24 @@
+import { isEmpty } from 'lodash-es'
+import {
+ BASE,
+ LOCAL,
+ NEWLINE,
+ REMOTE,
+ SEPARATOR,
+ TEXT_TAG,
+} from '../constant/conflicConstant.js'
+import type { JsonArray, JsonObject } from '../types/jsonTypes.js'
+export const addConflictMarkers = (
+ acc: JsonArray,
+ ours: JsonObject,
+ ancestor: JsonObject,
+ theirs: JsonObject
+): void => {
+ acc.push({ [TEXT_TAG]: `${NEWLINE}${LOCAL}` })
+ acc.push(isEmpty(ours) ? { [TEXT_TAG]: NEWLINE } : ours)
+ acc.push({ [TEXT_TAG]: BASE })
+ acc.push(isEmpty(ancestor) ? { [TEXT_TAG]: NEWLINE } : ancestor)
+ acc.push({ [TEXT_TAG]: SEPARATOR })
+ acc.push(isEmpty(theirs) ? { [TEXT_TAG]: NEWLINE } : theirs)
+ acc.push({ [TEXT_TAG]: REMOTE })
+}
diff --git a/src/merger/textAttribute.ts b/src/merger/textAttribute.ts
new file mode 100644
index 0000000..b51cffc
--- /dev/null
+++ b/src/merger/textAttribute.ts
@@ -0,0 +1,70 @@
+import { isEqual, isNil } from 'lodash-es'
+import { TEXT_TAG } from '../constant/conflicConstant.js'
+import type { JsonArray, JsonObject, JsonValue } from '../types/jsonTypes.js'
+import { MergeScenario, getScenario } from '../types/mergeScenario.js'
+import { addConflictMarkers } from './conflictMarker.js'
+
+export const mergeTextAttribute = (
+ ancestor: JsonValue | null,
+ ours: JsonValue | null,
+ theirs: JsonValue | null,
+ attrib: string
+): JsonArray => {
+ const generateObj = (value: JsonValue | null): JsonObject => {
+ return isNil(value) ? {} : { [attrib]: [{ [TEXT_TAG]: value }] }
+ }
+
+ const objAnc: JsonObject = generateObj(ancestor)
+ const objOurs: JsonObject = generateObj(ours)
+ const objTheirs: JsonObject = generateObj(theirs)
+ const scenario: MergeScenario = getScenario(objAnc, objOurs, objTheirs)
+ const acc: JsonArray = []
+
+ // Early return for identical values
+ if (
+ isEqual(ours, theirs) &&
+ (scenario === MergeScenario.OURS_AND_THEIRS ||
+ scenario === MergeScenario.ALL)
+ ) {
+ return [objOurs]
+ }
+
+ // Handle specific merge scenarios
+ switch (scenario) {
+ case MergeScenario.THEIRS_ONLY:
+ acc.push(objTheirs)
+ break
+
+ case MergeScenario.OURS_ONLY:
+ acc.push(objOurs)
+ break
+
+ case MergeScenario.OURS_AND_THEIRS:
+ addConflictMarkers(acc, objOurs, {}, objTheirs)
+ break
+
+ case MergeScenario.ANCESTOR_AND_THEIRS:
+ if (ancestor !== theirs) {
+ addConflictMarkers(acc, {}, objAnc, objTheirs)
+ }
+ break
+
+ case MergeScenario.ANCESTOR_AND_OURS:
+ if (ancestor !== ours) {
+ addConflictMarkers(acc, objOurs, objAnc, {})
+ }
+ break
+
+ case MergeScenario.ALL:
+ if (ancestor === ours) {
+ acc.push(objTheirs)
+ } else if (ancestor === theirs) {
+ acc.push(objOurs)
+ } else {
+ addConflictMarkers(acc, objOurs, objAnc, objTheirs)
+ }
+ break
+ }
+
+ return acc
+}
diff --git a/src/service/MetadataService.ts b/src/service/MetadataService.ts
index e0d4fad..dd46af0 100644
--- a/src/service/MetadataService.ts
+++ b/src/service/MetadataService.ts
@@ -1,7 +1,7 @@
import { JsonValue } from '../types/jsonTypes.js'
export class MetadataService {
- public getKeyFieldExtractor(
+ public static getKeyFieldExtractor(
metadataType: string
): ((el: JsonValue) => string) | undefined {
return metadataType in METADATA_KEY_EXTRACTORS
diff --git a/src/service/NamespaceHandler.ts b/src/service/NamespaceHandler.ts
new file mode 100644
index 0000000..a9f9e58
--- /dev/null
+++ b/src/service/NamespaceHandler.ts
@@ -0,0 +1,45 @@
+import type { JsonArray, JsonObject } from '../types/jsonTypes.js'
+
+const NAMESPACE_PREFIX = '@_'
+const NAMESPACE_ROOT = ':@'
+
+export class NamespaceHandler {
+ public processNamespaces(
+ ancestor: JsonObject | JsonArray,
+ ours: JsonObject | JsonArray,
+ theirs: JsonObject | JsonArray
+ ): JsonObject {
+ const namespaces: JsonObject = {}
+
+ // Look for namespace attributes directly at the root level
+ for (const obj of [ancestor, ours, theirs]) {
+ for (const key of Object.keys(obj)) {
+ // It's an object, check for namespace attributes and remove them
+ const childObj = obj[key] as JsonObject
+ for (const childKey of Object.keys(childObj)) {
+ if (childKey.startsWith(NAMESPACE_PREFIX)) {
+ namespaces[childKey] = childObj[childKey]
+ delete childObj[childKey] // Remove namespace attribute after extraction
+ }
+ }
+ }
+ }
+
+ return namespaces
+ }
+
+ public addNamespacesToResult(acc: JsonArray, namespaces: JsonObject): void {
+ if (Object.keys(namespaces).length > 0 && acc.length > 0) {
+ // Create a root object if needed
+ const rootObject = acc[0] as JsonObject
+
+ // The namespace should be at the top level in the result
+ rootObject[NAMESPACE_ROOT] = {}
+
+ // Add each namespace as a child of the root's :@ property
+ for (const key of Object.keys(namespaces)) {
+ ;(rootObject[NAMESPACE_ROOT] as JsonObject)[key] = namespaces[key]
+ }
+ }
+ }
+}
diff --git a/src/types/mergeScenario.ts b/src/types/mergeScenario.ts
new file mode 100644
index 0000000..56b98a1
--- /dev/null
+++ b/src/types/mergeScenario.ts
@@ -0,0 +1,39 @@
+import { isEmpty } from 'lodash-es'
+
+/**
+ * Enum representing different merge scenarios based on content presence:
+ * - First position: Ancestor content present (1) or absent (0)
+ * - Second position: Ours content present (1) or absent (0)
+ * - Third position: Theirs content present (1) or absent (0)
+ */
+export enum MergeScenario {
+ NONE = 0, // No content in any source
+ THEIRS_ONLY = 1, // Only theirs has content (001)
+ OURS_ONLY = 10, // Only ours has content (010)
+ OURS_AND_THEIRS = 11, // Both ours and theirs have content, no ancestor (011)
+ ANCESTOR_ONLY = 100, // Only ancestor has content (100)
+ ANCESTOR_AND_THEIRS = 101, // Ancestor and theirs have content, no ours (101)
+ ANCESTOR_AND_OURS = 110, // Ancestor and ours have content, no theirs (110)
+ ALL = 111, // All three sources have content (111)
+}
+
+export const getScenario = (
+ // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+ ancestor: any,
+ // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+ ours: any,
+ // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+ theirs: any
+): MergeScenario => {
+ let scenario: MergeScenario = MergeScenario.NONE
+ if (!isEmpty(ancestor)) {
+ scenario += 100
+ }
+ if (!isEmpty(ours)) {
+ scenario += 10
+ }
+ if (!isEmpty(theirs)) {
+ scenario += 1
+ }
+ return scenario
+}
diff --git a/src/utils/mergeUtils.ts b/src/utils/mergeUtils.ts
new file mode 100644
index 0000000..c587072
--- /dev/null
+++ b/src/utils/mergeUtils.ts
@@ -0,0 +1,16 @@
+import { castArray, isNil } from 'lodash-es'
+import type { JsonArray, JsonObject, JsonValue } from '../types/jsonTypes.js'
+
+export const isObject = (
+ ancestor: JsonValue | undefined | null,
+ ours: JsonValue | undefined | null,
+ theirs: JsonValue | undefined | null
+): boolean =>
+ typeof [ancestor, theirs, ours].find(ele => !isNil(ele)) === 'object'
+
+export const ensureArray = (value: JsonValue): JsonArray =>
+ isNil(value) ? [] : (castArray(value) as JsonArray)
+
+export const getUniqueSortedProps = (
+ ...objects: (JsonObject | JsonArray)[]
+): string[] => Array.from(new Set([...objects].map(Object.keys).flat())).sort()
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index bdc2b1a..183156c 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -41,7 +41,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -100,7 +100,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -146,7 +146,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -194,7 +194,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -229,7 +229,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -280,7 +280,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -354,7 +354,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -407,7 +407,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -481,7 +481,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -530,7 +530,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -586,7 +586,7 @@ describe('JsonMerger', () => {
const theirs = {}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -662,7 +662,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -718,7 +718,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -789,7 +789,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -821,7 +821,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -854,7 +854,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -885,7 +885,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -914,7 +914,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -943,7 +943,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -970,7 +970,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1003,7 +1003,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1044,7 +1044,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1085,7 +1085,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1128,7 +1128,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1193,7 +1193,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1273,7 +1273,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1326,7 +1326,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
@@ -1400,7 +1400,7 @@ describe('JsonMerger', () => {
}
// Act
- const result = sut.mergeObjects(ancestor, ours, theirs)
+ const result = sut.merge(ancestor, ours, theirs)
// Assert
expect(result).toEqual([
diff --git a/test/unit/merger/XmlMerger.test.ts b/test/unit/merger/XmlMerger.test.ts
index cc521b5..2b03a35 100644
--- a/test/unit/merger/XmlMerger.test.ts
+++ b/test/unit/merger/XmlMerger.test.ts
@@ -17,12 +17,12 @@ jest.mock('fast-xml-parser', () => {
}
})
-const mockedMergeObjects = jest.fn()
+const mockedmerge = jest.fn()
jest.mock('../../../src/merger/JsonMerger.js', () => {
return {
JsonMerger: jest.fn().mockImplementation(() => {
return {
- mergeObjects: mockedMergeObjects,
+ merge: mockedmerge,
}
}),
}
@@ -38,7 +38,7 @@ describe('MergeDriver', () => {
describe('tripartXmlMerge', () => {
it('should merge files successfully when given valid parameters', () => {
// Arrange
- mockedMergeObjects.mockReturnValue('MergedContent')
+ mockedmerge.mockReturnValue('MergedContent')
// Act
sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
@@ -51,7 +51,7 @@ describe('MergeDriver', () => {
it('should throw an error when tripartXmlMerge fails', () => {
// Arrange
- mockedMergeObjects.mockImplementation(() => {
+ mockedmerge.mockImplementation(() => {
throw new Error('Tripart XML merge failed')
})
@@ -68,7 +68,7 @@ describe('MergeDriver', () => {
const ancestorWithSpecial = '<root><special></root>'
const ourWithSpecial = '<root><modified></root>'
const theirWithSpecial = '<root><special></root>'
- mockedMergeObjects.mockReturnValue('<root><modified></root>')
+ mockedmerge.mockReturnValue('<root><modified></root>')
// Act
const result = sut.tripartXmlMerge(
@@ -87,7 +87,7 @@ describe('MergeDriver', () => {
const ancestorWithComment = '<root><!-- original comment --></root>'
const ourWithComment = '<root><!-- our comment --></root>'
const theirWithComment = '<root><!-- their comment --></root>'
- mockedMergeObjects.mockReturnValue('<root><!-- merged comment --></root>')
+ mockedmerge.mockReturnValue('<root><!-- merged comment --></root>')
// Act
const result = sut.tripartXmlMerge(
@@ -106,7 +106,7 @@ describe('MergeDriver', () => {
const ancestorWithComment = ''
const ourWithComment = ''
const theirWithComment = ''
- mockedMergeObjects.mockReturnValue('')
+ mockedmerge.mockReturnValue('')
// Act
const result = sut.tripartXmlMerge(
diff --git a/test/unit/service/MetadataService.test.ts b/test/unit/service/MetadataService.test.ts
index cc653c6..0556d0b 100644
--- a/test/unit/service/MetadataService.test.ts
+++ b/test/unit/service/MetadataService.test.ts
@@ -2,12 +2,6 @@ import { MetadataService } from '../../../src/service/MetadataService.js'
import { JsonValue } from '../../../src/types/jsonTypes.js'
describe('MetadataService', () => {
- let metadataService: MetadataService
-
- beforeEach(() => {
- metadataService = new MetadataService()
- })
-
describe('getKeyFieldExtractor', () => {
describe('given a valid metadata type', () => {
const testCases = [
@@ -342,7 +336,7 @@ describe('MetadataService', () => {
'$name',
({ metadataType, testObject, expected }) => {
// Act
- const extractor = metadataService.getKeyFieldExtractor(metadataType)
+ const extractor = MetadataService.getKeyFieldExtractor(metadataType)
// Assert
expect(extractor).toBeDefined()
@@ -357,7 +351,7 @@ describe('MetadataService', () => {
const metadataType = 'nonExistentType'
// Act
- const extractor = metadataService.getKeyFieldExtractor(metadataType)
+ const extractor = MetadataService.getKeyFieldExtractor(metadataType)
// Assert
expect(extractor).toBeUndefined()
From 40e237371d84e96662eea36df07938c1b9c312a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Sun, 23 Mar 2025 21:55:03 +0100
Subject: [PATCH 44/55] chore: upgrade dependencies
---
package-lock.json | 249 +++++++++++++++++++++++++++++++++++++++++++---
package.json | 6 +-
2 files changed, 238 insertions(+), 17 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index b4d83b2..8a4623d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -10,8 +10,8 @@
"license": "MIT",
"dependencies": {
"@oclif/core": "^4.2.10",
- "@salesforce/core": "^8.8.5",
- "@salesforce/sf-plugins-core": "^12.2.0",
+ "@salesforce/core": "^8.8.6",
+ "@salesforce/sf-plugins-core": "^12.2.1",
"fast-xml-parser": "^5.0.9",
"lodash-es": "^4.17.21",
"simple-git": "^3.27.0"
@@ -30,7 +30,7 @@
"knip": "^5.46.0",
"mocha": "^11.1.0",
"nyc": "^17.1.0",
- "oclif": "^4.17.37",
+ "oclif": "^4.17.40",
"shx": "^0.4.0",
"ts-jest": "^29.2.6",
"ts-node": "^10.9.2",
@@ -366,9 +366,9 @@
}
},
"node_modules/@aws-sdk/client-s3": {
- "version": "3.758.0",
- "resolved": "https://registry.npmjs.org/@aws-sdk/client-s3/-/client-s3-3.758.0.tgz",
- "integrity": "sha512-f8SlhU9/93OC/WEI6xVJf/x/GoQFj9a/xXK6QCtr5fvCjfSLgMVFmKTiIl/tgtDRzxUDc8YS6EGtbHjJ3Y/atg==",
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/client-s3/-/client-s3-3.772.0.tgz",
+ "integrity": "sha512-HQXlQIyyLp47h1/Hdjr36yK8/gsAAFX2vRzgDJhSRaz0vWZlWX07AJdYfrxapLUXfVU6DbBu3rwi2UGqM7ixqQ==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
@@ -376,14 +376,14 @@
"@aws-crypto/sha256-browser": "5.2.0",
"@aws-crypto/sha256-js": "5.2.0",
"@aws-sdk/core": "3.758.0",
- "@aws-sdk/credential-provider-node": "3.758.0",
+ "@aws-sdk/credential-provider-node": "3.772.0",
"@aws-sdk/middleware-bucket-endpoint": "3.734.0",
"@aws-sdk/middleware-expect-continue": "3.734.0",
"@aws-sdk/middleware-flexible-checksums": "3.758.0",
"@aws-sdk/middleware-host-header": "3.734.0",
"@aws-sdk/middleware-location-constraint": "3.734.0",
"@aws-sdk/middleware-logger": "3.734.0",
- "@aws-sdk/middleware-recursion-detection": "3.734.0",
+ "@aws-sdk/middleware-recursion-detection": "3.772.0",
"@aws-sdk/middleware-sdk-s3": "3.758.0",
"@aws-sdk/middleware-ssec": "3.734.0",
"@aws-sdk/middleware-user-agent": "3.758.0",
@@ -433,6 +433,227 @@
"node": ">=18.0.0"
}
},
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/client-sso": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/client-sso/-/client-sso-3.772.0.tgz",
+ "integrity": "sha512-sDdxepi74+cL6gXJJ2yw3UNSI7GBvoGTwZqFyPoNAzcURvaYwo8dBr7G4jS9GDanjTlO3CGVAf2VMcpqEvmoEw==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-crypto/sha256-browser": "5.2.0",
+ "@aws-crypto/sha256-js": "5.2.0",
+ "@aws-sdk/core": "3.758.0",
+ "@aws-sdk/middleware-host-header": "3.734.0",
+ "@aws-sdk/middleware-logger": "3.734.0",
+ "@aws-sdk/middleware-recursion-detection": "3.772.0",
+ "@aws-sdk/middleware-user-agent": "3.758.0",
+ "@aws-sdk/region-config-resolver": "3.734.0",
+ "@aws-sdk/types": "3.734.0",
+ "@aws-sdk/util-endpoints": "3.743.0",
+ "@aws-sdk/util-user-agent-browser": "3.734.0",
+ "@aws-sdk/util-user-agent-node": "3.758.0",
+ "@smithy/config-resolver": "^4.0.1",
+ "@smithy/core": "^3.1.5",
+ "@smithy/fetch-http-handler": "^5.0.1",
+ "@smithy/hash-node": "^4.0.1",
+ "@smithy/invalid-dependency": "^4.0.1",
+ "@smithy/middleware-content-length": "^4.0.1",
+ "@smithy/middleware-endpoint": "^4.0.6",
+ "@smithy/middleware-retry": "^4.0.7",
+ "@smithy/middleware-serde": "^4.0.2",
+ "@smithy/middleware-stack": "^4.0.1",
+ "@smithy/node-config-provider": "^4.0.1",
+ "@smithy/node-http-handler": "^4.0.3",
+ "@smithy/protocol-http": "^5.0.1",
+ "@smithy/smithy-client": "^4.1.6",
+ "@smithy/types": "^4.1.0",
+ "@smithy/url-parser": "^4.0.1",
+ "@smithy/util-base64": "^4.0.0",
+ "@smithy/util-body-length-browser": "^4.0.0",
+ "@smithy/util-body-length-node": "^4.0.0",
+ "@smithy/util-defaults-mode-browser": "^4.0.7",
+ "@smithy/util-defaults-mode-node": "^4.0.7",
+ "@smithy/util-endpoints": "^3.0.1",
+ "@smithy/util-middleware": "^4.0.1",
+ "@smithy/util-retry": "^4.0.1",
+ "@smithy/util-utf8": "^4.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/credential-provider-ini": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.772.0.tgz",
+ "integrity": "sha512-T1Ec9Q25zl5c/eZUPHZsiq8vgBeWBjHM7WM5xtZszZRPqqhQGnmFlomz1r9rwhW8RFB5k8HRaD/SLKo6jtYl/A==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-sdk/core": "3.758.0",
+ "@aws-sdk/credential-provider-env": "3.758.0",
+ "@aws-sdk/credential-provider-http": "3.758.0",
+ "@aws-sdk/credential-provider-process": "3.758.0",
+ "@aws-sdk/credential-provider-sso": "3.772.0",
+ "@aws-sdk/credential-provider-web-identity": "3.772.0",
+ "@aws-sdk/nested-clients": "3.772.0",
+ "@aws-sdk/types": "3.734.0",
+ "@smithy/credential-provider-imds": "^4.0.1",
+ "@smithy/property-provider": "^4.0.1",
+ "@smithy/shared-ini-file-loader": "^4.0.1",
+ "@smithy/types": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/credential-provider-node": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-node/-/credential-provider-node-3.772.0.tgz",
+ "integrity": "sha512-0IdVfjBO88Mtekq/KaScYSIEPIeR+ABRvBOWyj/c/qQ2KJyI0GRlSAzpANfxDLHVPn3yEHuZd9nRL6sOmOMI0A==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-sdk/credential-provider-env": "3.758.0",
+ "@aws-sdk/credential-provider-http": "3.758.0",
+ "@aws-sdk/credential-provider-ini": "3.772.0",
+ "@aws-sdk/credential-provider-process": "3.758.0",
+ "@aws-sdk/credential-provider-sso": "3.772.0",
+ "@aws-sdk/credential-provider-web-identity": "3.772.0",
+ "@aws-sdk/types": "3.734.0",
+ "@smithy/credential-provider-imds": "^4.0.1",
+ "@smithy/property-provider": "^4.0.1",
+ "@smithy/shared-ini-file-loader": "^4.0.1",
+ "@smithy/types": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/credential-provider-sso": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.772.0.tgz",
+ "integrity": "sha512-yR3Y5RAVPa4ogojcBOpZUx6XyRVAkynIJCjd0avdlxW1hhnzSr5/pzoiJ6u21UCbkxlJJTDZE3jfFe7tt+HA4w==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-sdk/client-sso": "3.772.0",
+ "@aws-sdk/core": "3.758.0",
+ "@aws-sdk/token-providers": "3.772.0",
+ "@aws-sdk/types": "3.734.0",
+ "@smithy/property-provider": "^4.0.1",
+ "@smithy/shared-ini-file-loader": "^4.0.1",
+ "@smithy/types": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/credential-provider-web-identity": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.772.0.tgz",
+ "integrity": "sha512-yHAT5Y2y0fnecSuWRUn8NMunKfDqFYhnOpGq8UyCEcwz9aXzibU0hqRIEm51qpR81hqo0GMFDH0EOmegZ/iW5w==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-sdk/core": "3.758.0",
+ "@aws-sdk/nested-clients": "3.772.0",
+ "@aws-sdk/types": "3.734.0",
+ "@smithy/property-provider": "^4.0.1",
+ "@smithy/types": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/middleware-recursion-detection": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/middleware-recursion-detection/-/middleware-recursion-detection-3.772.0.tgz",
+ "integrity": "sha512-zg0LjJa4v7fcLzn5QzZvtVS+qyvmsnu7oQnb86l6ckduZpWDCDC9+A0ZzcXTrxblPCJd3JqkoG1+Gzi4S4Ny/Q==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-sdk/types": "3.734.0",
+ "@smithy/protocol-http": "^5.0.1",
+ "@smithy/types": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/nested-clients": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/nested-clients/-/nested-clients-3.772.0.tgz",
+ "integrity": "sha512-gNJbBxR5YlEumsCS9EWWEASXEnysL0aDnr9MNPX1ip/g1xOqRHmytgV/+t8RFZFTKg0OprbWTq5Ich3MqsEuCQ==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-crypto/sha256-browser": "5.2.0",
+ "@aws-crypto/sha256-js": "5.2.0",
+ "@aws-sdk/core": "3.758.0",
+ "@aws-sdk/middleware-host-header": "3.734.0",
+ "@aws-sdk/middleware-logger": "3.734.0",
+ "@aws-sdk/middleware-recursion-detection": "3.772.0",
+ "@aws-sdk/middleware-user-agent": "3.758.0",
+ "@aws-sdk/region-config-resolver": "3.734.0",
+ "@aws-sdk/types": "3.734.0",
+ "@aws-sdk/util-endpoints": "3.743.0",
+ "@aws-sdk/util-user-agent-browser": "3.734.0",
+ "@aws-sdk/util-user-agent-node": "3.758.0",
+ "@smithy/config-resolver": "^4.0.1",
+ "@smithy/core": "^3.1.5",
+ "@smithy/fetch-http-handler": "^5.0.1",
+ "@smithy/hash-node": "^4.0.1",
+ "@smithy/invalid-dependency": "^4.0.1",
+ "@smithy/middleware-content-length": "^4.0.1",
+ "@smithy/middleware-endpoint": "^4.0.6",
+ "@smithy/middleware-retry": "^4.0.7",
+ "@smithy/middleware-serde": "^4.0.2",
+ "@smithy/middleware-stack": "^4.0.1",
+ "@smithy/node-config-provider": "^4.0.1",
+ "@smithy/node-http-handler": "^4.0.3",
+ "@smithy/protocol-http": "^5.0.1",
+ "@smithy/smithy-client": "^4.1.6",
+ "@smithy/types": "^4.1.0",
+ "@smithy/url-parser": "^4.0.1",
+ "@smithy/util-base64": "^4.0.0",
+ "@smithy/util-body-length-browser": "^4.0.0",
+ "@smithy/util-body-length-node": "^4.0.0",
+ "@smithy/util-defaults-mode-browser": "^4.0.7",
+ "@smithy/util-defaults-mode-node": "^4.0.7",
+ "@smithy/util-endpoints": "^3.0.1",
+ "@smithy/util-middleware": "^4.0.1",
+ "@smithy/util-retry": "^4.0.1",
+ "@smithy/util-utf8": "^4.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@aws-sdk/client-s3/node_modules/@aws-sdk/token-providers": {
+ "version": "3.772.0",
+ "resolved": "https://registry.npmjs.org/@aws-sdk/token-providers/-/token-providers-3.772.0.tgz",
+ "integrity": "sha512-d1Waa1vyebuokcAWYlkZdtFlciIgob7B39vPRmtxMObbGumJKiOy/qCe2/FB/72h1Ej9Ih32lwvbxUjORQWN4g==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@aws-sdk/nested-clients": "3.772.0",
+ "@aws-sdk/types": "3.734.0",
+ "@smithy/property-provider": "^4.0.1",
+ "@smithy/shared-ini-file-loader": "^4.0.1",
+ "@smithy/types": "^4.1.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
"node_modules/@aws-sdk/client-sso": {
"version": "3.758.0",
"resolved": "https://registry.npmjs.org/@aws-sdk/client-sso/-/client-sso-3.758.0.tgz",
@@ -11195,19 +11416,19 @@
}
},
"node_modules/oclif": {
- "version": "4.17.37",
- "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.17.37.tgz",
- "integrity": "sha512-sB71e7euBGmoMgIJ9UgM49QdpMVTqp26be31ZLfO1iV6MetCR7XLL2aAL+32NuucaCbTVdH9YkgbcU9xJMfZfA==",
+ "version": "4.17.40",
+ "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.17.40.tgz",
+ "integrity": "sha512-lS7tsZD0KJaKpwZe/7uC3awNRfFTJEKMAPlu18S0KfJWtdPf9sn4eIcwo+Vyd13rfmpHNx82rP+PtUUJ2n1nEw==",
"dev": true,
"license": "MIT",
"dependencies": {
"@aws-sdk/client-cloudfront": "^3.764.0",
- "@aws-sdk/client-s3": "^3.749.0",
+ "@aws-sdk/client-s3": "^3.772.0",
"@inquirer/confirm": "^3.1.22",
"@inquirer/input": "^2.2.4",
"@inquirer/select": "^2.5.0",
"@oclif/core": "^4.2.8",
- "@oclif/plugin-help": "^6.2.25",
+ "@oclif/plugin-help": "^6.2.27",
"@oclif/plugin-not-found": "^3.2.46",
"@oclif/plugin-warn-if-update-available": "^3.1.31",
"async-retry": "^1.3.3",
@@ -11223,7 +11444,7 @@
"normalize-package-data": "^6",
"semver": "^7.7.1",
"sort-package-json": "^2.15.1",
- "tiny-jsonc": "^1.0.1",
+ "tiny-jsonc": "^1.0.2",
"validate-npm-package-name": "^5.0.1"
},
"bin": {
diff --git a/package.json b/package.json
index 8ac8a05..6180c8f 100644
--- a/package.json
+++ b/package.json
@@ -11,8 +11,8 @@
},
"dependencies": {
"@oclif/core": "^4.2.10",
- "@salesforce/core": "^8.8.5",
- "@salesforce/sf-plugins-core": "^12.2.0",
+ "@salesforce/core": "^8.8.6",
+ "@salesforce/sf-plugins-core": "^12.2.1",
"fast-xml-parser": "^5.0.9",
"lodash-es": "^4.17.21",
"simple-git": "^3.27.0"
@@ -31,7 +31,7 @@
"knip": "^5.46.0",
"mocha": "^11.1.0",
"nyc": "^17.1.0",
- "oclif": "^4.17.37",
+ "oclif": "^4.17.40",
"shx": "^0.4.0",
"ts-jest": "^29.2.6",
"ts-node": "^10.9.2",
From 51f0ff262496eb2795b07005f5c81512c16040b5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Sun, 23 Mar 2025 22:25:18 +0100
Subject: [PATCH 45/55] test: improve spec naming
---
test/unit/merger/JsonMerger.test.ts | 72 ++++++++++++++---------------
1 file changed, 36 insertions(+), 36 deletions(-)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 183156c..5a799d6 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -9,8 +9,8 @@ describe('JsonMerger', () => {
sut = new JsonMerger()
})
- describe('given arrays with key fields', () => {
- it('should merge arrays using the key field to identify matching elements', () => {
+ describe('Merging objects with nested arrays containing key fields', () => {
+ it('should correctly merge arrays by using object field properties as unique identifiers', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -73,7 +73,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle the scenario when both sides modify the same element', () => {
+ it('should resolve conflicts when both sides modify the same array element with different values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -118,7 +118,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle the scenario when we modify an element and they add a new one', () => {
+ it('should preserve our modifications while incorporating their additions to the array', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -172,8 +172,8 @@ describe('JsonMerger', () => {
})
})
- describe('given arrays without key fields', () => {
- it('should merge arrays without duplicates', () => {
+ describe('Merging objects with primitive arrays (no identifying keys)', () => {
+ it('should combine string arrays from both sources while preserving unique values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -208,7 +208,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle primitive values in arrays', () => {
+ it('should properly merge numeric arrays by combining values from both sources', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -244,8 +244,8 @@ describe('JsonMerger', () => {
})
})
- describe('given mixed JSON with both key and non-key arrays', () => {
- it('should correctly merge a complex structure with both types', () => {
+ describe('Merging complex objects with multiple data types and different array merging strategies', () => {
+ it('should correctly apply appropriate merge strategies for primitive arrays, keyed arrays, and scalar values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -311,8 +311,8 @@ describe('JsonMerger', () => {
})
})
- describe('test dealing with namespace', () => {
- it('it should come at the right level', () => {
+ describe('Handling XML namespaces in metadata merges', () => {
+ it('should correctly position namespace attributes at the appropriate level in the output structure', () => {
// Arrange
const ancestor: JsonValue = {
CustomLabels: {
@@ -380,8 +380,8 @@ describe('JsonMerger', () => {
})
})
- describe('given undefined ancestor', () => {
- it('should correctly merge objects when ancestor is undefined', () => {
+ describe('Handling merge conflicts when a common base version is missing or incomplete', () => {
+ it('should generate a conflict marker structure when merging divergent changes without a base version', () => {
// Arrange
const ancestor = {}
@@ -458,7 +458,7 @@ describe('JsonMerger', () => {
])
})
- it('should correctly merge objects when ancestor key undefined', () => {
+ it('should generate field-level conflict markers when merging changes with an empty ancestor object', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {},
@@ -506,8 +506,8 @@ describe('JsonMerger', () => {
})
})
- describe('given undefined their', () => {
- it('should correctly merge objects', () => {
+ describe('Handling merge conflicts when our version is missing or incomplete', () => {
+ it('should generate conflict markers when an empty local version conflicts with modified field permissions in remote', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -638,8 +638,8 @@ describe('JsonMerger', () => {
})
})
- describe('given undefined our', () => {
- it('should correctly merge objects', () => {
+ describe('Handling merge conflicts when our version is missing or incomplete', () => {
+ it('should generate conflict markers when an empty local version conflicts with modified field permissions in remote', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -692,7 +692,7 @@ describe('JsonMerger', () => {
])
})
- it('should correctly merge objects', () => {
+ it('should generate conflict markers when an empty local version conflicts with significant structure changes in remote', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -770,7 +770,7 @@ describe('JsonMerger', () => {
})
})
- it('only ancestor key present should just be removed', () => {
+ it('should remove fields from result when they exist in ancestor but are removed in both ours and theirs', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -799,8 +799,8 @@ describe('JsonMerger', () => {
])
})
- describe('Nominal case', () => {
- it('should handle string values', () => {
+ describe('String property merging scenarios', () => {
+ it('should preserve string values when identical across all versions', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -835,7 +835,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should accept identical new string properties added in both ours and theirs', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {},
@@ -868,7 +868,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should remove string properties deleted in both ours and theirs', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -895,7 +895,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should prioritize local deletion when ours deletes a property but theirs keeps it unchanged', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -924,7 +924,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should prioritize remote deletion when theirs deletes a property but ours keeps it unchanged', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -953,7 +953,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should accept identical new properties when ancestor lacks the parent structure entirely', () => {
// Arrange
const ancestor: JsonValue = {}
@@ -984,7 +984,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should mark conflict when both sides add different values for the same new property', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {},
@@ -1025,7 +1025,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should mark conflict when ours deletes a property but theirs modifies it', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -1066,7 +1066,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should mark conflict when ours modifies a property but theirs deletes it', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -1107,7 +1107,7 @@ describe('JsonMerger', () => {
])
})
- it('should handle string values', () => {
+ it('should mark conflict when both sides modify the same property with different values', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -1153,8 +1153,8 @@ describe('JsonMerger', () => {
})
})
- describe('given special metadata kind', () => {
- it('should merge arrays by position when both sides modify different elements', () => {
+ describe('Array merging in metadata with special position handling', () => {
+ it('should successfully merge arrays when local and remote changes affect different elements', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -1234,7 +1234,7 @@ describe('JsonMerger', () => {
])
})
- it('should use their version when we did not modify an element but they did', () => {
+ it('should adopt remote changes when an element is modified only in the remote version', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -1291,7 +1291,7 @@ describe('JsonMerger', () => {
])
})
- it('should append their additional elements when their array is longer', () => {
+ it('should incorporate new elements added in remote array when remote array is longer', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
@@ -1367,7 +1367,7 @@ describe('JsonMerger', () => {
])
})
- it('should keep our additional elements when our array is longer', () => {
+ it('should preserve locally added elements while merging remote changes to existing elements', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
From 4bcfe22dc8338d14435619d361d882e486894dec Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Mon, 24 Mar 2025 12:04:40 +0100
Subject: [PATCH 46/55] test: fix spec naming
---
test/unit/merger/JsonMerger.test.ts | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 5a799d6..790831c 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -506,8 +506,8 @@ describe('JsonMerger', () => {
})
})
- describe('Handling merge conflicts when our version is missing or incomplete', () => {
- it('should generate conflict markers when an empty local version conflicts with modified field permissions in remote', () => {
+ describe('Handling merge conflicts when their version is missing or incomplete', () => {
+ it('should generate conflict markers when an empty remote version conflicts with modified field permissions in local', () => {
// Arrange
const ancestor: JsonValue = {
Profile: {
From df790b3c9581d9c29276e0d14fff4e268e5549ff Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Mon, 24 Mar 2025 12:29:21 +0100
Subject: [PATCH 47/55] test: adding testcase with only ancestor given as input
---
test/unit/merger/JsonMerger.test.ts | 23 ++++++++++++++++++++++-
1 file changed, 22 insertions(+), 1 deletion(-)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 790831c..d89f938 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -33,9 +33,9 @@ describe('JsonMerger', () => {
const theirs: JsonValue = {
Profile: {
fieldPermissions: [
+ { field: 'Account.Industry', editable: 'false', readable: 'true' },
{ field: 'Account.Name', editable: 'false', readable: 'true' },
{ field: 'Account.Type', editable: 'false', readable: 'false' },
- { field: 'Account.Industry', editable: 'false', readable: 'true' },
],
},
}
@@ -799,6 +799,27 @@ describe('JsonMerger', () => {
])
})
+ it('should give empty result when they exist in ancestor not ours and theirs', () => {
+ // Arrange
+ const ancestor: JsonValue = {
+ Profile: {
+ fieldPermissions: [
+ { field: 'Account.Name', editable: 'true', readable: 'true' },
+ ],
+ },
+ }
+
+ const ours: JsonValue = {}
+
+ const theirs: JsonValue = {}
+
+ // Act
+ const result = sut.merge(ancestor, ours, theirs)
+
+ // Assert
+ expect(result).toEqual([])
+ })
+
describe('String property merging scenarios', () => {
it('should preserve string values when identical across all versions', () => {
// Arrange
From 1986d68ad43668a9e757497a61d1aa748b013754 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Mon, 24 Mar 2025 14:37:39 +0100
Subject: [PATCH 48/55] test: adding testcases for remaining branches
---
test/unit/merger/JsonMerger.test.ts | 39 +++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index d89f938..c4c3c9f 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -15,6 +15,11 @@ describe('JsonMerger', () => {
const ancestor: JsonValue = {
Profile: {
fieldPermissions: [
+ {
+ field: 'Account.AllAndAncestorAndTheirs',
+ editable: 'false',
+ readable: 'true',
+ },
{ field: 'Account.Name', editable: 'false', readable: 'true' },
{ field: 'Account.Type', editable: 'false', readable: 'true' },
],
@@ -24,7 +29,17 @@ describe('JsonMerger', () => {
const ours: JsonValue = {
Profile: {
fieldPermissions: [
+ {
+ field: 'Account.AllAndAncestorAndTheirs',
+ editable: 'true',
+ readable: 'true',
+ },
{ field: 'Account.Name', editable: 'true', readable: 'true' },
+ {
+ field: 'Account.OursAndTheirs',
+ editable: 'false',
+ readable: 'true',
+ },
{ field: 'Account.Type', editable: 'false', readable: 'true' },
],
},
@@ -33,8 +48,18 @@ describe('JsonMerger', () => {
const theirs: JsonValue = {
Profile: {
fieldPermissions: [
+ {
+ field: 'Account.AllAndAncestorAndTheirs',
+ editable: 'false',
+ readable: 'true',
+ },
{ field: 'Account.Industry', editable: 'false', readable: 'true' },
{ field: 'Account.Name', editable: 'false', readable: 'true' },
+ {
+ field: 'Account.OursAndTheirs',
+ editable: 'false',
+ readable: 'true',
+ },
{ field: 'Account.Type', editable: 'false', readable: 'false' },
],
},
@@ -47,6 +72,13 @@ describe('JsonMerger', () => {
expect(result).toEqual([
{
Profile: [
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'true' }] },
+ { field: [{ '#text': 'Account.AllAndAncestorAndTheirs' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
{
fieldPermissions: [
{ editable: [{ '#text': 'false' }] },
@@ -61,6 +93,13 @@ describe('JsonMerger', () => {
{ readable: [{ '#text': 'true' }] },
],
},
+ {
+ fieldPermissions: [
+ { editable: [{ '#text': 'false' }] },
+ { field: [{ '#text': 'Account.OursAndTheirs' }] },
+ { readable: [{ '#text': 'true' }] },
+ ],
+ },
{
fieldPermissions: [
{ editable: [{ '#text': 'false' }] },
From 7a2676a0d265cebcfa745029208e18f168430512 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Mon, 24 Mar 2025 14:39:06 +0100
Subject: [PATCH 49/55] fix: mergeByKeyField isEqual lacked keys resulting bad
logic even though result was ok
---
src/merger/JsonMerger.ts | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index bc4388f..9fd120c 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -179,14 +179,14 @@ const mergeByKeyField = (
case MergeScenario.ANCESTOR_ONLY:
break
case MergeScenario.OURS_AND_THEIRS:
- if (isEqual(ours, theirs)) {
+ if (isEqual(ours[key], theirs[key])) {
obj[attribute] = mergeMetadata({}, {}, theirs[key])
} else {
obj[attribute] = mergeMetadata({}, ours[key], theirs[key])
}
break
case MergeScenario.ANCESTOR_AND_THEIRS:
- if (!isEqual(ancestor, theirs)) {
+ if (!isEqual(ancestor[key], theirs[key])) {
const ancestorProp = {
[attribute]: mergeMetadata({}, ancestor[key], {}),
}
@@ -197,7 +197,7 @@ const mergeByKeyField = (
}
break
case MergeScenario.ANCESTOR_AND_OURS:
- if (!isEqual(ancestor, ours)) {
+ if (!isEqual(ancestor[key], ours[key])) {
const oursProp = {
[attribute]: mergeMetadata({}, ours[key], {}),
}
@@ -208,11 +208,11 @@ const mergeByKeyField = (
}
break
case MergeScenario.ALL:
- if (isEqual(ours, theirs)) {
+ if (isEqual(ours[key], theirs[key])) {
obj[attribute] = mergeMetadata({}, {}, theirs[key])
} else if (isEqual(ancestor[key], ours[key])) {
obj[attribute] = mergeMetadata({}, {}, theirs[key])
- } else if (isEqual(ancestor, theirs)) {
+ } else if (isEqual(ancestor[key], theirs[key])) {
obj[attribute] = mergeMetadata({}, ours[key], {})
} else {
obj[attribute] = mergeMetadata(ancestor[key], ours[key], theirs[key])
From fa475d39813eab0c3119dc1d14e5109f7a9410dc Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Mon, 24 Mar 2025 15:08:29 +0100
Subject: [PATCH 50/55] feat: make sure to get an array s attribute only once
for optimization
---
src/merger/JsonMerger.ts | 58 ++++++++++++++++++++++------------------
1 file changed, 32 insertions(+), 26 deletions(-)
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 9fd120c..802ac4e 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -63,16 +63,19 @@ const mergeMetadata = (
const props = getUniqueSortedProps(ancestor, ours, theirs)
for (const key of props) {
let values: JsonArray = []
+ const ancestorOfKey = ancestor[key]
+ const oursOfKey = ours[key]
+ const theirsOfKey = theirs[key]
- if (isObject(ancestor[key], ours[key], theirs[key])) {
+ if (isObject(ancestorOfKey, oursOfKey, theirsOfKey)) {
const [ancestorkey, ourkey, theirkey] = [
- ancestor[key],
- ours[key],
- theirs[key],
+ ancestorOfKey,
+ oursOfKey,
+ theirsOfKey,
].map(ensureArray)
values = mergeArrays(ancestorkey, ourkey, theirkey, key)
} else {
- values = mergeTextAttribute(ancestor[key], ours[key], theirs[key], key)
+ values = mergeTextAttribute(ancestorOfKey, oursOfKey, theirsOfKey, key)
}
acc.push(values)
}
@@ -163,59 +166,62 @@ const mergeByKeyField = (
const acc: JsonArray = []
const props = getUniqueSortedProps(ancestor, ours, theirs)
for (const key of props) {
+ const ancestorOfKey = ancestor[key]
+ const oursOfKey = ours[key]
+ const theirsOfKey = theirs[key]
const scenario: MergeScenario = getScenario(
- ancestor[key],
- ours[key],
- theirs[key]
+ ancestorOfKey,
+ oursOfKey,
+ theirsOfKey
)
const obj = {}
switch (scenario) {
case MergeScenario.THEIRS_ONLY:
- obj[attribute] = mergeMetadata({}, {}, theirs[key])
+ obj[attribute] = mergeMetadata({}, {}, theirsOfKey)
break
case MergeScenario.OURS_ONLY:
- obj[attribute] = mergeMetadata({}, ours[key], {})
+ obj[attribute] = mergeMetadata({}, oursOfKey, {})
break
case MergeScenario.ANCESTOR_ONLY:
break
case MergeScenario.OURS_AND_THEIRS:
- if (isEqual(ours[key], theirs[key])) {
- obj[attribute] = mergeMetadata({}, {}, theirs[key])
+ if (isEqual(oursOfKey, theirsOfKey)) {
+ obj[attribute] = mergeMetadata({}, {}, theirsOfKey)
} else {
- obj[attribute] = mergeMetadata({}, ours[key], theirs[key])
+ obj[attribute] = mergeMetadata({}, oursOfKey, theirsOfKey)
}
break
case MergeScenario.ANCESTOR_AND_THEIRS:
- if (!isEqual(ancestor[key], theirs[key])) {
+ if (!isEqual(ancestorOfKey, theirsOfKey)) {
const ancestorProp = {
- [attribute]: mergeMetadata({}, ancestor[key], {}),
+ [attribute]: mergeMetadata({}, ancestorOfKey, {}),
}
const theirsProp = {
- [attribute]: mergeMetadata({}, {}, theirs[key]),
+ [attribute]: mergeMetadata({}, {}, theirsOfKey),
}
addConflictMarkers(acc, {}, ancestorProp, theirsProp)
}
break
case MergeScenario.ANCESTOR_AND_OURS:
- if (!isEqual(ancestor[key], ours[key])) {
+ if (!isEqual(ancestorOfKey, oursOfKey)) {
const oursProp = {
- [attribute]: mergeMetadata({}, ours[key], {}),
+ [attribute]: mergeMetadata({}, oursOfKey, {}),
}
const ancestorProp = {
- [attribute]: mergeMetadata({}, ancestor[key], {}),
+ [attribute]: mergeMetadata({}, ancestorOfKey, {}),
}
addConflictMarkers(acc, oursProp, ancestorProp, {})
}
break
case MergeScenario.ALL:
- if (isEqual(ours[key], theirs[key])) {
- obj[attribute] = mergeMetadata({}, {}, theirs[key])
- } else if (isEqual(ancestor[key], ours[key])) {
- obj[attribute] = mergeMetadata({}, {}, theirs[key])
- } else if (isEqual(ancestor[key], theirs[key])) {
- obj[attribute] = mergeMetadata({}, ours[key], {})
+ if (isEqual(oursOfKey, theirsOfKey)) {
+ obj[attribute] = mergeMetadata({}, {}, theirsOfKey)
+ } else if (isEqual(ancestorOfKey, oursOfKey)) {
+ obj[attribute] = mergeMetadata({}, {}, theirsOfKey)
+ } else if (isEqual(ancestorOfKey, theirsOfKey)) {
+ obj[attribute] = mergeMetadata({}, oursOfKey, {})
} else {
- obj[attribute] = mergeMetadata(ancestor[key], ours[key], theirs[key])
+ obj[attribute] = mergeMetadata(ancestorOfKey, oursOfKey, theirsOfKey)
}
break
}
From 06213e6e569610b518e28c34631d7cdd4f658781 Mon Sep 17 00:00:00 2001
From: yohanim <kevin.gossent@gmail.com>
Date: Thu, 27 Mar 2025 15:56:54 +0100
Subject: [PATCH 51/55] feat: organizing patterns and extractors and make them
complete
---
src/constant/metadataConstant.ts | 55 ++++++++--
src/service/MetadataService.ts | 179 ++++++++++++++++++++++---------
2 files changed, 171 insertions(+), 63 deletions(-)
diff --git a/src/constant/metadataConstant.ts b/src/constant/metadataConstant.ts
index 4f7014a..5644b7e 100644
--- a/src/constant/metadataConstant.ts
+++ b/src/constant/metadataConstant.ts
@@ -4,16 +4,51 @@
*/
export const METADATA_TYPES_PATTERNS = [
- 'assignmentRules',
- 'autoResponseRules',
- 'escalationRules',
- 'globalValueSet',
- 'globalValueSetTranslation',
- 'marketingappextension',
- 'matchingRule',
- 'profile',
- 'sharingRules',
+ 'labels', // CustomLabels
+ 'label', // CustomLabels decomposed
+ 'profile', // Profile
+ 'permissionset', // PermissionSet
+ 'applicationVisibility', // PermissionSet decomposed
+ 'classAccess',
+ 'customMetadataTypeAccess',
+ 'customPermission',
+ 'customSettingAccess',
+ 'externalCredentialPrincipalAccess',
+ 'externalDataSourceAccess',
+ 'fieldPermission',
+ 'flowAccess',
+ 'objectPermission',
+ 'pageAccess',
+ 'recordTypeVisibility',
+ 'tabSetting',
+ 'userPermission',
+ 'objectSettings',
+ 'permissionsetgroup', // PermissionSetGroup
+ 'permissionSetLicenseDefinition', // PermissionSetLicenseDefinition
+ 'mutingpermissionset', // MutingPermissionSet
+ 'sharingRules', // SharingRules
+ 'sharingCriteriaRule', // SharingRules decomposed
+ 'sharingGuestRule',
+ 'sharingOwnerRule',
+ 'sharingTerritoryRule',
+ 'workflow', // Workflow
+ 'workflowAlert', // Workflow decomposed
+ 'workflowFieldUpdate',
+ 'workflowFlowAction',
+ 'workflowKnowledgePublish',
+ 'workflowOutboundMessage',
+ 'workflowRule',
+ 'workflowSend',
+ 'workflowTask',
+ 'assignmentRules', // AssignmentRules
+ 'autoResponseRules', // AutoResponseRules
+ 'escalationRules', // EscalationRules
+ 'marketingappextension', // MarketingAppExtension
+ 'matchingRule', // MatchingRules
+ 'globalValueSet', // ValueSets
'standardValueSet',
+ 'globalValueSetTranslation', // ValueSets translation
'standardValueSetTranslation',
- 'workflow',
+ 'translation', // Translations
+ 'objectTranslation', // CustomObjectTranslation
]
diff --git a/src/service/MetadataService.ts b/src/service/MetadataService.ts
index dd46af0..b177a19 100644
--- a/src/service/MetadataService.ts
+++ b/src/service/MetadataService.ts
@@ -14,68 +14,141 @@ export class MetadataService {
const getPropertyValue = (el: JsonValue, property: string) =>
String((el as Record<string, unknown>)[property])
+
const METADATA_KEY_EXTRACTORS = {
- marketingAppExtActivities: (el: JsonValue) =>
- getPropertyValue(el, 'fullName'),
- alerts: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- fieldUpdates: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- flowActions: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- outboundMessages: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- rules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- knowledgePublishes: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- tasks: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- send: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- sharingCriteriaRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- sharingGuestRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- sharingOwnerRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- sharingTerritoryRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- assignmentRule: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- autoResponseRule: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- escalationRule: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- matchingRules: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- valueTranslation: (el: JsonValue) => getPropertyValue(el, 'masterLabel'),
- categoryGroupVisibilities: (el: JsonValue) =>
- getPropertyValue(el, 'dataCategoryGroup'),
+ labels: (el: JsonValue) => getPropertyValue(el, 'fullName'), // CustomLabels
applicationVisibilities: (el: JsonValue) =>
- getPropertyValue(el, 'application'),
- classAccesses: (el: JsonValue) => getPropertyValue(el, 'apexClass'),
- customMetadataTypeAccesses: (el: JsonValue) => getPropertyValue(el, 'name'),
- customPermissions: (el: JsonValue) => getPropertyValue(el, 'name'),
- customSettingAccesses: (el: JsonValue) => getPropertyValue(el, 'name'),
+ getPropertyValue(el, 'application'), // Profile // PermissionSet
+ categoryGroupVisibilities: (el: JsonValue) =>
+ getPropertyValue(el, 'dataCategoryGroup'), // Profile
+ classAccesses: (el: JsonValue) => getPropertyValue(el, 'apexClass'), // Profile // PermissionSet
+ customMetadataTypeAccesses: (el: JsonValue) => getPropertyValue(el, 'name'), // Profile // PermissionSet
+ customPermissions: (el: JsonValue) => getPropertyValue(el, 'name'), // Profile // PermissionSet // PermissionSetLicenseDefinition
+ customSettingAccesses: (el: JsonValue) => getPropertyValue(el, 'name'), // Profile // PermissionSet
externalDataSourceAccesses: (el: JsonValue) =>
- getPropertyValue(el, 'externalDataSource'),
- fieldPermissions: (el: JsonValue) => getPropertyValue(el, 'field'),
- flowAccesses: (el: JsonValue) => getPropertyValue(el, 'flow'),
- loginFlows: (el: JsonValue) => getPropertyValue(el, 'friendlyname'),
+ getPropertyValue(el, 'externalDataSource'), // Profile // PermissionSet
+ fieldPermissions: (el: JsonValue) => getPropertyValue(el, 'field'), // Profile // PermissionSet
+ flowAccesses: (el: JsonValue) => getPropertyValue(el, 'flow'), // Profile // PermissionSet
layoutAssignments: (el: JsonValue) => {
const layout = getPropertyValue(el, 'layout')
const recordType = getPropertyValue(el, 'recordType')
return [layout, recordType].filter(x => x !== String(undefined)).join('.')
- },
- loginHours: (el: JsonValue) => Object.keys(el!).join(','),
+ }, // Profile
+ loginFlows: (el: JsonValue) => getPropertyValue(el, 'friendlyname'), // Profile
+ loginHours: (el: JsonValue) => Object.keys(el!).join(','), // Profile
loginIpRanges: (el: JsonValue) => {
const startAddress = getPropertyValue(el, 'startAddress')
const endAddress = getPropertyValue(el, 'endAddress')
return `${startAddress}-${endAddress}`
- },
- objectPermissions: (el: JsonValue) => getPropertyValue(el, 'object'),
- pageAccesses: (el: JsonValue) => getPropertyValue(el, 'apexPage'),
- profileActionOverrides: (el: JsonValue) => getPropertyValue(el, 'actionName'),
- recordTypeVisibilities: (el: JsonValue) => getPropertyValue(el, 'recordType'),
- tabVisibilities: (el: JsonValue) => getPropertyValue(el, 'tab'),
- userPermissions: (el: JsonValue) => getPropertyValue(el, 'name'),
- bots: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- customApplications: (el: JsonValue) => getPropertyValue(el, 'name'),
- customLabels: (el: JsonValue) => getPropertyValue(el, 'name'),
- customPageWebLinks: (el: JsonValue) => getPropertyValue(el, 'name'),
- customTabs: (el: JsonValue) => getPropertyValue(el, 'name'),
- flowDefinitions: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- pipelineInspMetricConfigs: (el: JsonValue) => getPropertyValue(el, 'name'),
- prompts: (el: JsonValue) => getPropertyValue(el, 'name'),
- quickActions: (el: JsonValue) => getPropertyValue(el, 'name'),
- reportTypes: (el: JsonValue) => getPropertyValue(el, 'name'),
- scontrols: (el: JsonValue) => getPropertyValue(el, 'name'),
- standardValue: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- customValue: (el: JsonValue) => getPropertyValue(el, 'fullName'),
- labels: (el: JsonValue) => getPropertyValue(el, 'fullName'),
+ }, // Profile
+ objectPermissions: (el: JsonValue) => getPropertyValue(el, 'object'), // Profile // PermissionSet
+ pageAccesses: (el: JsonValue) => getPropertyValue(el, 'apexPage'), // Profile // PermissionSet
+ profileActionOverrides: (el: JsonValue) => getPropertyValue(el, 'actionName'), // Profile
+ recordTypeVisibilities: (el: JsonValue) => getPropertyValue(el, 'recordType'), // Profile // PermissionSet
+ tabVisibilities: (el: JsonValue) => getPropertyValue(el, 'tab'), // Profile // PermissionSet
+ userPermissions: (el: JsonValue) => getPropertyValue(el, 'name'), // Profile // PermissionSet
+ dataspaceScopes: (el: JsonValue) => getPropertyValue(el, 'dataspaceScope'), // PermissionSet
+ emailRoutingAddressAccesses: (el: JsonValue) => getPropertyValue(el, 'name'), // PermissionSet
+ externalCredentialPrincipalAccesses: (el: JsonValue) =>
+ getPropertyValue(el, 'externalCredentialPrincipal'), // PermissionSet
+ sharingCriteriaRules: (el: JsonValue) => getPropertyValue(el, 'fullName'), // SharingRules
+ sharingGuestRules: (el: JsonValue) => getPropertyValue(el, 'fullName'), // SharingRules
+ sharingOwnerRules: (el: JsonValue) => getPropertyValue(el, 'fullName'), // SharingRules
+ sharingTerritoryRules: (el: JsonValue) => getPropertyValue(el, 'fullName'), // SharingRules
+ criteriaItems: (el: JsonValue) => {
+ const field = getPropertyValue(el, 'field')
+ const operation = getPropertyValue(el, 'operation')
+ const value = getPropertyValue(el, 'value')
+ const valueField = getPropertyValue(el, 'valueField')
+ return [field, operation, value, valueField]
+ .filter(x => x !== String(undefined))
+ .join('.')
+ }, // SharingRules // AssignmentRules // AutoResponseRules // EscalationRules
+ // sharedTo: it should be a complete pure object compare and not an array comparison // SharingRules
+ // accountSettings: it should be a complete pure object compare and not an array comparison // SharingRules
+ alerts: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ recipients: (el: JsonValue) => getPropertyValue(el, 'type'), // Workflow
+ fieldUpdates: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ flowActions: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ flowInputs: (el: JsonValue) => getPropertyValue(el, 'name'), // Workflow
+ flowAutomation: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ knowledgePublishes: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ outboundMessages: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ rules: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ actions: (el: JsonValue) => getPropertyValue(el, 'name'), // Workflow
+ //workflowTimeTriggers: it should be a complete pure object compare and not an array comparison // Workflow
+ send: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ tasks: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Workflow
+ assignmentRule: (el: JsonValue) => getPropertyValue(el, 'fullName'), // AssignmentRules
+ //ruleEntry: it should be a complete pure object compare and not an array comparison // AssignmentRules // AutoResponseRules // EscalationRules
+ autoResponseRule: (el: JsonValue) => getPropertyValue(el, 'fullName'), // AutoResponseRules
+ escalationRule: (el: JsonValue) => getPropertyValue(el, 'fullName'), // EscalationRules
+ marketingAppExtActions: (el: JsonValue) => getPropertyValue(el, 'apiName'), // MarketingAppExtension
+ marketingAppExtActivities: (el: JsonValue) =>
+ getPropertyValue(el, 'fullName'), // MarketingAppExtension
+ matchingRules: (el: JsonValue) => getPropertyValue(el, 'fullName'), // MatchingRules
+ matchingRuleItems: (el: JsonValue) => {
+ const fieldName = getPropertyValue(el, 'fieldName')
+ const matchingMethod = getPropertyValue(el, 'matchingMethod')
+ return `${fieldName}-${matchingMethod}`
+ }, // MatchingRules
+ customValue: (el: JsonValue) => getPropertyValue(el, 'fullName'), // GlobalValueSet
+ standardValue: (el: JsonValue) => getPropertyValue(el, 'fullName'), // StandardValueSet
+ valueTranslation: (el: JsonValue) => getPropertyValue(el, 'masterLabel'), // GlobalValueSetTranslation // StandardValueSetTranslation
+ botBlocks: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ botBlockVersions: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ botDialogs: (el: JsonValue) => getPropertyValue(el, 'developerName'), // Translations
+ botSteps: (el: JsonValue) => getPropertyValue(el, 'stepIdentifier'), // Translations
+ botMessages: (el: JsonValue) => getPropertyValue(el, 'messageIdentifier'), // Translations
+ botVariableOperation: (el: JsonValue) =>
+ getPropertyValue(el, 'variableOperationIdentifier'), // Translations
+ botTemplates: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ bots: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ botVersions: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ conversationMessageDefinitions: (el: JsonValue) =>
+ getPropertyValue(el, 'name'), // Translations
+ constantValueTranslations: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ customApplications: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ customLabels: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ customPageWebLinks: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ customTabs: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ desFieldTemplateMessages: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ flowDefinitions: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ flows: (el: JsonValue) => getPropertyValue(el, 'fullName'), // Translations
+ identityVerificationCustomFieldLabels: (el: JsonValue) =>
+ getPropertyValue(el, 'name'), // Translations
+ pipelineInspMetricConfigs: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ prompts: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ promptVersions: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ quickActions: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ reportTypes: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ sections: (el: JsonValue) => {
+ const name = getPropertyValue(el, 'name') // Translations
+ const section = getPropertyValue(el, 'section') // CustomObjectTranslation
+ return [name, section].filter(x => x !== String(undefined))[0]
+ }, // Special thing because of types different// Translations // CustomObjectTranslation
+ columns: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+ scontrols: (el: JsonValue) => getPropertyValue(el, 'name'), // Translations
+
+ caseValues: (el: JsonValue) => {
+ const article = getPropertyValue(el, 'article')
+ const caseType = getPropertyValue(el, 'caseType')
+ const plural = getPropertyValue(el, 'plural')
+ const possessive = getPropertyValue(el, 'possessive')
+ return [article, caseType, plural, possessive]
+ .filter(x => x !== String(undefined))
+ .join('.')
+ }, // CustomObjectTranslation
+ fieldSets: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ fields: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ picklistValues: (el: JsonValue) => getPropertyValue(el, 'masterLabel'), // CustomObjectTranslation
+ layouts: (el: JsonValue) => getPropertyValue(el, 'layout'), // CustomObjectTranslation
+ quickActionParametersTranslation: (el: JsonValue) =>
+ getPropertyValue(el, 'name'), // CustomObjectTranslation
+ recordTypes: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ sharingReasons: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ standardFields: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ validationRules: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ webLinks: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
+ workflowTasks: (el: JsonValue) => getPropertyValue(el, 'name'), // CustomObjectTranslation
}
From 87d1c443d553b44412781ae2432cd259f5a0a80b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 28 Mar 2025 16:18:19 +0100
Subject: [PATCH 52/55] test: add empty result even with namespace
---
test/unit/merger/JsonMerger.test.ts | 1 +
1 file changed, 1 insertion(+)
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index c4c3c9f..84bf7ff 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -845,6 +845,7 @@ describe('JsonMerger', () => {
fieldPermissions: [
{ field: 'Account.Name', editable: 'true', readable: 'true' },
],
+ '@_xmlns': 'http://soap.sforce.com/2006/04/metadata',
},
}
From fdae771e2444bec2a6a21b5cff3a094c1eefaf60 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 28 Mar 2025 16:19:20 +0100
Subject: [PATCH 53/55] feat: handle exit code
---
src/commands/git/merge/driver/run.ts | 3 +-
src/driver/MergeDriver.ts | 10 ++-
src/merger/JsonMerger.ts | 19 +++--
src/merger/XmlMerger.ts | 19 +++--
src/merger/conflictMarker.ts | 36 +++++----
src/merger/textAttribute.ts | 10 +--
test/integration/run.nut.ts | 110 ++++++++++++++++++++++-----
test/unit/driver/MergeDriver.test.ts | 40 ++++++++++
test/unit/merger/JsonMerger.test.ts | 89 +++++++++++++++-------
test/unit/merger/XmlMerger.test.ts | 30 +++++---
10 files changed, 270 insertions(+), 96 deletions(-)
diff --git a/src/commands/git/merge/driver/run.ts b/src/commands/git/merge/driver/run.ts
index 2701c9d..02ee51b 100644
--- a/src/commands/git/merge/driver/run.ts
+++ b/src/commands/git/merge/driver/run.ts
@@ -41,11 +41,12 @@ export default class Run extends SfCommand<void> {
public async run(): Promise<void> {
const { flags } = await this.parse(Run)
const mergeDriver = new MergeDriver()
- await mergeDriver.mergeFiles(
+ const hasConflict = await mergeDriver.mergeFiles(
flags['ancestor-file'],
flags['our-file'],
flags['theirs-file'],
flags['output-file']
)
+ this.exit(hasConflict ? 1 : 0)
}
}
diff --git a/src/driver/MergeDriver.ts b/src/driver/MergeDriver.ts
index 872fda3..983b829 100644
--- a/src/driver/MergeDriver.ts
+++ b/src/driver/MergeDriver.ts
@@ -2,7 +2,12 @@ import { readFile, writeFile } from 'node:fs/promises'
import { XmlMerger } from '../merger/XmlMerger.js'
export class MergeDriver {
- async mergeFiles(ancestorFile, ourFile, theirFile, outputFile) {
+ async mergeFiles(
+ ancestorFile: string,
+ ourFile: string,
+ theirFile: string,
+ outputFile: string
+ ): Promise<boolean> {
// Read all three versions
const [ancestorContent, ourContent, theirContent] = await Promise.all([
readFile(ancestorFile, 'utf8'),
@@ -19,6 +24,7 @@ export class MergeDriver {
)
// Write the merged content to the output file
- await writeFile(outputFile, mergedContent)
+ await writeFile(outputFile, mergedContent.output)
+ return mergedContent.hasConflict
}
}
diff --git a/src/merger/JsonMerger.ts b/src/merger/JsonMerger.ts
index 802ac4e..b443d0d 100644
--- a/src/merger/JsonMerger.ts
+++ b/src/merger/JsonMerger.ts
@@ -8,7 +8,7 @@ import {
getUniqueSortedProps,
isObject,
} from '../utils/mergeUtils.js'
-import { addConflictMarkers } from './conflictMarker.js'
+import { ConflictMarker } from './conflictMarker.js'
import { mergeTextAttribute } from './textAttribute.js'
export class JsonMerger {
@@ -16,7 +16,7 @@ export class JsonMerger {
ancestor: JsonObject | JsonArray,
ours: JsonObject | JsonArray,
theirs: JsonObject | JsonArray
- ): JsonArray {
+ ): { output: JsonArray; hasConflict: boolean } {
const namespaceHandler = new NamespaceHandler()
const namespaces = namespaceHandler.processNamespaces(
ancestor,
@@ -51,7 +51,10 @@ export class JsonMerger {
const result = acc.flat()
namespaceHandler.addNamespacesToResult(result, namespaces)
- return result
+ return {
+ output: result,
+ hasConflict: ConflictMarker.hasConflictMarker(),
+ }
}
}
const mergeMetadata = (
@@ -95,7 +98,7 @@ const handleOursAndTheirs = (
const theirsProp = {
[key]: mergeMetadata({}, {}, theirs[key]),
}
- addConflictMarkers(acc, obj, {}, theirsProp)
+ ConflictMarker.addConflictMarkers(acc, obj, {}, theirsProp)
} else {
acc.push(obj)
}
@@ -115,7 +118,7 @@ const handleAncestorAndTheirs = (
const theirsProp = {
[key]: mergeMetadata({}, {}, theirs[key]),
}
- addConflictMarkers(acc, {}, ancestorProp, theirsProp)
+ ConflictMarker.addConflictMarkers(acc, {}, ancestorProp, theirsProp)
}
return acc
}
@@ -133,7 +136,7 @@ const handleAncestorAndOurs = (
const ancestorProp = {
[key]: mergeMetadata({}, {}, ancestor[key]),
}
- addConflictMarkers(acc, oursProp, ancestorProp, {})
+ ConflictMarker.addConflictMarkers(acc, oursProp, ancestorProp, {})
}
return acc
}
@@ -199,7 +202,7 @@ const mergeByKeyField = (
const theirsProp = {
[attribute]: mergeMetadata({}, {}, theirsOfKey),
}
- addConflictMarkers(acc, {}, ancestorProp, theirsProp)
+ ConflictMarker.addConflictMarkers(acc, {}, ancestorProp, theirsProp)
}
break
case MergeScenario.ANCESTOR_AND_OURS:
@@ -210,7 +213,7 @@ const mergeByKeyField = (
const ancestorProp = {
[attribute]: mergeMetadata({}, ancestorOfKey, {}),
}
- addConflictMarkers(acc, oursProp, ancestorProp, {})
+ ConflictMarker.addConflictMarkers(acc, oursProp, ancestorProp, {})
}
break
case MergeScenario.ALL:
diff --git a/src/merger/XmlMerger.ts b/src/merger/XmlMerger.ts
index 93f60ec..a56398c 100644
--- a/src/merger/XmlMerger.ts
+++ b/src/merger/XmlMerger.ts
@@ -45,7 +45,7 @@ export class XmlMerger {
ancestorContent: string,
ourContent: string,
theirContent: string
- ) {
+ ): { output: string; hasConflict: boolean } {
const parser = new XMLParser(parserOptions)
const ancestorObj = parser.parse(ancestorContent)
@@ -57,19 +57,22 @@ export class XmlMerger {
// Perform deep merge of XML objects
const jsonMerger = new JsonMerger()
- const mergedObj = jsonMerger.merge(ancestorObj, ourObj, theirObj)
+ const mergedResult = jsonMerger.merge(ancestorObj, ourObj, theirObj)
// console.log('mergedObj')
// console.dir(mergedObj, {depth:null})
// Convert back to XML and format
const builder = new XMLBuilder(builderOptions)
- const mergedXml: string = builder.build(mergedObj)
+ const mergedXml: string = builder.build(mergedResult.output)
// console.log('mergedXml')
// console.dir(mergedXml, {depth:null})
- return mergedXml.length
- ? correctConflictIndent(
- correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
- )
- : ''
+ return {
+ output: mergedXml.length
+ ? correctConflictIndent(
+ correctComments(XML_DECL.concat(handleSpecialEntities(mergedXml)))
+ )
+ : '',
+ hasConflict: mergedResult.hasConflict,
+ }
}
}
diff --git a/src/merger/conflictMarker.ts b/src/merger/conflictMarker.ts
index a7e750a..dc3bfc1 100644
--- a/src/merger/conflictMarker.ts
+++ b/src/merger/conflictMarker.ts
@@ -8,17 +8,27 @@ import {
TEXT_TAG,
} from '../constant/conflicConstant.js'
import type { JsonArray, JsonObject } from '../types/jsonTypes.js'
-export const addConflictMarkers = (
- acc: JsonArray,
- ours: JsonObject,
- ancestor: JsonObject,
- theirs: JsonObject
-): void => {
- acc.push({ [TEXT_TAG]: `${NEWLINE}${LOCAL}` })
- acc.push(isEmpty(ours) ? { [TEXT_TAG]: NEWLINE } : ours)
- acc.push({ [TEXT_TAG]: BASE })
- acc.push(isEmpty(ancestor) ? { [TEXT_TAG]: NEWLINE } : ancestor)
- acc.push({ [TEXT_TAG]: SEPARATOR })
- acc.push(isEmpty(theirs) ? { [TEXT_TAG]: NEWLINE } : theirs)
- acc.push({ [TEXT_TAG]: REMOTE })
+
+export class ConflictMarker {
+ private static hasConflict = false
+
+ public static hasConflictMarker(): boolean {
+ return ConflictMarker.hasConflict
+ }
+
+ public static addConflictMarkers(
+ acc: JsonArray,
+ ours: JsonObject,
+ ancestor: JsonObject,
+ theirs: JsonObject
+ ): void {
+ ConflictMarker.hasConflict = true
+ acc.push({ [TEXT_TAG]: `${NEWLINE}${LOCAL}` })
+ acc.push(isEmpty(ours) ? { [TEXT_TAG]: NEWLINE } : ours)
+ acc.push({ [TEXT_TAG]: BASE })
+ acc.push(isEmpty(ancestor) ? { [TEXT_TAG]: NEWLINE } : ancestor)
+ acc.push({ [TEXT_TAG]: SEPARATOR })
+ acc.push(isEmpty(theirs) ? { [TEXT_TAG]: NEWLINE } : theirs)
+ acc.push({ [TEXT_TAG]: REMOTE })
+ }
}
diff --git a/src/merger/textAttribute.ts b/src/merger/textAttribute.ts
index b51cffc..ba9eaf6 100644
--- a/src/merger/textAttribute.ts
+++ b/src/merger/textAttribute.ts
@@ -2,7 +2,7 @@ import { isEqual, isNil } from 'lodash-es'
import { TEXT_TAG } from '../constant/conflicConstant.js'
import type { JsonArray, JsonObject, JsonValue } from '../types/jsonTypes.js'
import { MergeScenario, getScenario } from '../types/mergeScenario.js'
-import { addConflictMarkers } from './conflictMarker.js'
+import { ConflictMarker } from './conflictMarker.js'
export const mergeTextAttribute = (
ancestor: JsonValue | null,
@@ -40,18 +40,18 @@ export const mergeTextAttribute = (
break
case MergeScenario.OURS_AND_THEIRS:
- addConflictMarkers(acc, objOurs, {}, objTheirs)
+ ConflictMarker.addConflictMarkers(acc, objOurs, {}, objTheirs)
break
case MergeScenario.ANCESTOR_AND_THEIRS:
if (ancestor !== theirs) {
- addConflictMarkers(acc, {}, objAnc, objTheirs)
+ ConflictMarker.addConflictMarkers(acc, {}, objAnc, objTheirs)
}
break
case MergeScenario.ANCESTOR_AND_OURS:
if (ancestor !== ours) {
- addConflictMarkers(acc, objOurs, objAnc, {})
+ ConflictMarker.addConflictMarkers(acc, objOurs, objAnc, {})
}
break
@@ -61,7 +61,7 @@ export const mergeTextAttribute = (
} else if (ancestor === theirs) {
acc.push(objOurs)
} else {
- addConflictMarkers(acc, objOurs, objAnc, objTheirs)
+ ConflictMarker.addConflictMarkers(acc, objOurs, objAnc, objTheirs)
}
break
}
diff --git a/test/integration/run.nut.ts b/test/integration/run.nut.ts
index 2a1c097..5bf4d3b 100644
--- a/test/integration/run.nut.ts
+++ b/test/integration/run.nut.ts
@@ -12,33 +12,63 @@ import { after, before, describe, it } from 'mocha'
const ROOT_FOLDER = './test/data'
const TEST_FILES_FOLDER = 'testFiles'
+const CONFLICT_TEST_FILES_FOLDER = 'conflictTestFiles'
+const EMPTY_TEST_FILES_FOLDER = 'emptyTestFiles'
+const TEST_FOLDERS = [
+ TEST_FILES_FOLDER,
+ CONFLICT_TEST_FILES_FOLDER,
+ EMPTY_TEST_FILES_FOLDER,
+]
+
+const setupTestFiles = (
+ folder: string,
+ ancestorXml: string,
+ oursXml: string,
+ theirsXml: string
+): void => {
+ writeFileSync(join(ROOT_FOLDER, folder, 'ancestor.xml'), ancestorXml)
+ writeFileSync(join(ROOT_FOLDER, folder, 'ours.xml'), oursXml)
+ writeFileSync(join(ROOT_FOLDER, folder, 'theirs.xml'), theirsXml)
+}
describe('git merge driver run', () => {
before(() => {
// Arrange
- mkdirSync(join(ROOT_FOLDER, TEST_FILES_FOLDER), { recursive: true })
- const ancestorContent = '<root>\n <item>common</item>\n</root>'
- const ourContent = '<root>\n <item>our change</item>\n</root>'
- const theirContent = '<root>\n <item>their change</item>\n</root>'
+ // Create test directories
+ TEST_FOLDERS.map(folder =>
+ mkdirSync(join(ROOT_FOLDER, folder), { recursive: true })
+ )
- writeFileSync(
- join(ROOT_FOLDER, TEST_FILES_FOLDER, 'ancestor.xml'),
- ancestorContent
+ // Setup test files
+ setupTestFiles(
+ TEST_FILES_FOLDER,
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>true</readable><editable>true</editable></fieldPermissions></Profile>',
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>true</readable><editable>false</editable></fieldPermissions></Profile>',
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>false</readable><editable>true</editable></fieldPermissions></Profile>'
)
- writeFileSync(join(ROOT_FOLDER, TEST_FILES_FOLDER, 'ours.xml'), ourContent)
- writeFileSync(
- join(ROOT_FOLDER, TEST_FILES_FOLDER, 'theirs.xml'),
- theirContent
+ setupTestFiles(
+ CONFLICT_TEST_FILES_FOLDER,
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>true</readable><editable>true</editable></fieldPermissions></Profile>',
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>true</readable><editable>false</editable></fieldPermissions></Profile>',
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>false</readable><editable>trueAndFalse</editable></fieldPermissions></Profile>'
+ )
+
+ setupTestFiles(
+ EMPTY_TEST_FILES_FOLDER,
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>true</readable><editable>true</editable></fieldPermissions></Profile>',
+ '',
+ '<Profile><fieldPermissions><field>Account.Name</field><readable>true</readable><editable>true</editable></fieldPermissions></Profile>'
)
- writeFileSync(join(ROOT_FOLDER, TEST_FILES_FOLDER, 'output.xml'), '')
})
after(() => {
// Clean up test files
- rmSync(join(ROOT_FOLDER, TEST_FILES_FOLDER), { recursive: true })
+ TEST_FOLDERS.map(folder =>
+ rmSync(join(ROOT_FOLDER, folder), { recursive: true })
+ )
})
- it('merges XML files correctly', () => {
+ it('merges XML files without conflict', () => {
// Act
execCmd(
`git merge driver run --ancestor-file ${join(TEST_FILES_FOLDER, 'ancestor.xml')} --our-file ${join(TEST_FILES_FOLDER, 'ours.xml')} --theirs-file ${join(TEST_FILES_FOLDER, 'theirs.xml')} --output-file ${join(TEST_FILES_FOLDER, 'output.xml')}`,
@@ -53,12 +83,50 @@ describe('git merge driver run', () => {
expect(existsSync(outputPath)).to.be.true
const outputContent = readFileSync(outputPath, 'utf-8')
- expect(outputContent).to.include('<root>')
- expect(outputContent).to.include('</root>')
- /*
- expect(outputContent).to.include('our change')
- expect(outputContent).to.include('their change')
- expect(outputContent).to.include('common')
- */
+ expect(outputContent).to.include('<Profile>')
+ expect(outputContent).to.include('</Profile>')
+ expect(outputContent).to.include('Account.Name')
+ })
+
+ it('merges XML files with conflict', () => {
+ // Act
+ execCmd(
+ `git merge driver run --ancestor-file ${join(CONFLICT_TEST_FILES_FOLDER, 'ancestor.xml')} --our-file ${join(CONFLICT_TEST_FILES_FOLDER, 'ours.xml')} --theirs-file ${join(CONFLICT_TEST_FILES_FOLDER, 'theirs.xml')} --output-file ${join(CONFLICT_TEST_FILES_FOLDER, 'output.xml')}`,
+ {
+ ensureExitCode: 1,
+ cwd: ROOT_FOLDER,
+ }
+ )
+
+ // Assert
+ const outputPath = join(
+ ROOT_FOLDER,
+ CONFLICT_TEST_FILES_FOLDER,
+ 'output.xml'
+ )
+ expect(existsSync(outputPath)).to.be.true
+
+ const outputContent = readFileSync(outputPath, 'utf-8')
+ expect(outputContent).to.include('<Profile>')
+ expect(outputContent).to.include('</Profile>')
+ expect(outputContent).to.include('Account.Name')
+ })
+
+ it('merges XML files with empty result', () => {
+ // Act
+ execCmd(
+ `git merge driver run --ancestor-file ${join(EMPTY_TEST_FILES_FOLDER, 'ancestor.xml')} --our-file ${join(EMPTY_TEST_FILES_FOLDER, 'ours.xml')} --theirs-file ${join(EMPTY_TEST_FILES_FOLDER, 'theirs.xml')} --output-file ${join(EMPTY_TEST_FILES_FOLDER, 'output.xml')}`,
+ {
+ ensureExitCode: 0,
+ cwd: ROOT_FOLDER,
+ }
+ )
+
+ // Assert
+ const outputPath = join(ROOT_FOLDER, EMPTY_TEST_FILES_FOLDER, 'output.xml')
+ expect(existsSync(outputPath)).to.be.true
+
+ const outputContent = readFileSync(outputPath, 'utf-8')
+ expect(outputContent).to.equal('')
})
})
diff --git a/test/unit/driver/MergeDriver.test.ts b/test/unit/driver/MergeDriver.test.ts
index 10c5f84..981d82f 100644
--- a/test/unit/driver/MergeDriver.test.ts
+++ b/test/unit/driver/MergeDriver.test.ts
@@ -48,5 +48,45 @@ describe('MergeDriver', () => {
sut.mergeFiles('AncestorFile', 'OurFile', 'TheirFile', 'OutputFile')
).rejects.toThrowError('Tripart XML merge failed')
})
+
+ it('should return true when there is a conflict', async () => {
+ // Arrange
+ mockReadFile.mockResolvedValue('<label>Test Object</label>')
+ mockedTripartXmlMerge.mockReturnValue({
+ output: '<label>Test Object</label>',
+ hasConflict: true,
+ })
+
+ // Act
+ const result = await sut.mergeFiles(
+ 'AncestorFile',
+ 'OurFile',
+ 'TheirFile',
+ 'OutputFile'
+ )
+
+ // Assert
+ expect(result).toBe(true)
+ })
+
+ it('should return false when there is no conflict', async () => {
+ // Arrange
+ mockReadFile.mockResolvedValue('<label>Test Object</label>')
+ mockedTripartXmlMerge.mockReturnValue({
+ output: '<label>Test Object</label>',
+ hasConflict: false,
+ })
+
+ // Act
+ const result = await sut.mergeFiles(
+ 'AncestorFile',
+ 'OurFile',
+ 'TheirFile',
+ 'OutputFile'
+ )
+
+ // Assert
+ expect(result).toBe(false)
+ })
})
})
diff --git a/test/unit/merger/JsonMerger.test.ts b/test/unit/merger/JsonMerger.test.ts
index 84bf7ff..469ccdb 100644
--- a/test/unit/merger/JsonMerger.test.ts
+++ b/test/unit/merger/JsonMerger.test.ts
@@ -1,4 +1,5 @@
import { JsonMerger } from '../../../src/merger/JsonMerger.js'
+import { ConflictMarker } from '../../../src/merger/conflictMarker.js'
import { JsonValue } from '../../../src/types/jsonTypes.js'
describe('JsonMerger', () => {
@@ -7,6 +8,7 @@ describe('JsonMerger', () => {
beforeEach(() => {
// Arrange
sut = new JsonMerger()
+ ConflictMarker['hasConflict'] = false
})
describe('Merging objects with nested arrays containing key fields', () => {
@@ -69,7 +71,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -110,6 +112,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should resolve conflicts when both sides modify the same array element with different values', () => {
@@ -142,7 +145,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -155,6 +158,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should preserve our modifications while incorporating their additions to the array', () => {
@@ -188,7 +192,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -208,6 +212,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
})
@@ -236,7 +241,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -245,6 +250,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should properly merge numeric arrays by combining values from both sources', () => {
@@ -271,7 +277,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -280,6 +286,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
})
@@ -322,7 +329,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ custom: ['Value1', 'Value3', 'Value2', 'Value4'] },
@@ -347,6 +354,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
})
@@ -396,7 +404,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
CustomLabels: [
{
@@ -416,6 +424,7 @@ describe('JsonMerger', () => {
},
},
])
+ expect(result.hasConflict).toBe(false)
})
})
@@ -449,7 +458,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{ '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
@@ -495,6 +504,7 @@ describe('JsonMerger', () => {
},
{ '#text': '>>>>>>> REMOTE' },
])
+ expect(result.hasConflict).toBe(true)
})
it('should generate field-level conflict markers when merging changes with an empty ancestor object', () => {
@@ -523,7 +533,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -542,6 +552,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
})
@@ -572,7 +583,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ '#text': '\n<<<<<<< LOCAL' },
@@ -597,6 +608,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
it('should correctly merge objects when theirs is undefined', () => {
@@ -628,7 +640,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{ '#text': '\n<<<<<<< LOCAL' },
{
Profile: [
@@ -674,6 +686,7 @@ describe('JsonMerger', () => {
{ '#text': '\n' },
{ '#text': '>>>>>>> REMOTE' },
])
+ expect(result.hasConflict).toBe(true)
})
})
@@ -704,7 +717,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ '#text': '\n<<<<<<< LOCAL' },
@@ -729,6 +742,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
it('should generate conflict markers when an empty local version conflicts with significant structure changes in remote', () => {
@@ -760,7 +774,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{ '#text': '\n<<<<<<< LOCAL' },
{ '#text': '\n' },
{ '#text': '||||||| BASE' },
@@ -806,6 +820,7 @@ describe('JsonMerger', () => {
},
{ '#text': '>>>>>>> REMOTE' },
])
+ expect(result.hasConflict).toBe(true)
})
})
@@ -831,11 +846,12 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should give empty result when they exist in ancestor not ours and theirs', () => {
@@ -857,7 +873,8 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([])
+ expect(result.output).toEqual([])
+ expect(result.hasConflict).toBe(false)
})
describe('String property merging scenarios', () => {
@@ -885,7 +902,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -894,6 +911,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should accept identical new string properties added in both ours and theirs', () => {
@@ -918,7 +936,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -927,6 +945,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should remove string properties deleted in both ours and theirs', () => {
@@ -949,11 +968,12 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should prioritize local deletion when ours deletes a property but theirs keeps it unchanged', () => {
@@ -978,11 +998,12 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should prioritize remote deletion when theirs deletes a property but ours keeps it unchanged', () => {
@@ -1007,11 +1028,12 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should accept identical new properties when ancestor lacks the parent structure entirely', () => {
@@ -1034,7 +1056,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -1043,6 +1065,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should mark conflict when both sides add different values for the same new property', () => {
@@ -1067,7 +1090,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ '#text': '\n<<<<<<< LOCAL' },
@@ -1084,6 +1107,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
it('should mark conflict when ours deletes a property but theirs modifies it', () => {
@@ -1108,7 +1132,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ '#text': '\n<<<<<<< LOCAL' },
@@ -1125,6 +1149,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
it('should mark conflict when ours modifies a property but theirs deletes it', () => {
@@ -1149,7 +1174,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ '#text': '\n<<<<<<< LOCAL' },
@@ -1166,6 +1191,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
it('should mark conflict when both sides modify the same property with different values', () => {
@@ -1192,7 +1218,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{ '#text': '\n<<<<<<< LOCAL' },
@@ -1211,6 +1237,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(true)
})
})
@@ -1257,7 +1284,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -1293,6 +1320,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should adopt remote changes when an element is modified only in the remote version', () => {
@@ -1337,7 +1365,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -1350,6 +1378,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should incorporate new elements added in remote array when remote array is longer', () => {
@@ -1390,7 +1419,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -1426,6 +1455,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
it('should preserve locally added elements while merging remote changes to existing elements', () => {
@@ -1464,7 +1494,7 @@ describe('JsonMerger', () => {
const result = sut.merge(ancestor, ours, theirs)
// Assert
- expect(result).toEqual([
+ expect(result.output).toEqual([
{
Profile: [
{
@@ -1500,6 +1530,7 @@ describe('JsonMerger', () => {
],
},
])
+ expect(result.hasConflict).toBe(false)
})
})
})
diff --git a/test/unit/merger/XmlMerger.test.ts b/test/unit/merger/XmlMerger.test.ts
index 2b03a35..25ee700 100644
--- a/test/unit/merger/XmlMerger.test.ts
+++ b/test/unit/merger/XmlMerger.test.ts
@@ -38,7 +38,10 @@ describe('MergeDriver', () => {
describe('tripartXmlMerge', () => {
it('should merge files successfully when given valid parameters', () => {
// Arrange
- mockedmerge.mockReturnValue('MergedContent')
+ mockedmerge.mockReturnValue({
+ output: 'MergedContent',
+ hasConflict: false,
+ })
// Act
sut.tripartXmlMerge('AncestorFile', 'OurFile', 'TheirFile')
@@ -68,7 +71,10 @@ describe('MergeDriver', () => {
const ancestorWithSpecial = '<root><special></root>'
const ourWithSpecial = '<root><modified></root>'
const theirWithSpecial = '<root><special></root>'
- mockedmerge.mockReturnValue('<root><modified></root>')
+ mockedmerge.mockReturnValue({
+ output: '<root><modified></root>',
+ hasConflict: false,
+ })
// Act
const result = sut.tripartXmlMerge(
@@ -78,8 +84,9 @@ describe('MergeDriver', () => {
)
// Assert
- expect(result).toContain('<?xml version="1.0" encoding="UTF-8"?>')
- expect(result).toContain('<modified>')
+ expect(result.output).toContain('<?xml version="1.0" encoding="UTF-8"?>')
+ expect(result.output).toContain('<modified>')
+ expect(result.hasConflict).toBe(false)
})
it('should correctly handle XML comments', () => {
@@ -87,7 +94,10 @@ describe('MergeDriver', () => {
const ancestorWithComment = '<root><!-- original comment --></root>'
const ourWithComment = '<root><!-- our comment --></root>'
const theirWithComment = '<root><!-- their comment --></root>'
- mockedmerge.mockReturnValue('<root><!-- merged comment --></root>')
+ mockedmerge.mockReturnValue({
+ output: '<root><!-- merged comment --></root>',
+ hasConflict: false,
+ })
// Act
const result = sut.tripartXmlMerge(
@@ -97,8 +107,9 @@ describe('MergeDriver', () => {
)
// Assert
- expect(result).toContain('<?xml version="1.0" encoding="UTF-8"?>')
- expect(result).toContain('<!-- merged comment -->')
+ expect(result.output).toContain('<?xml version="1.0" encoding="UTF-8"?>')
+ expect(result.output).toContain('<!-- merged comment -->')
+ expect(result.hasConflict).toBe(false)
})
it('empty files should output empty file', () => {
@@ -106,7 +117,7 @@ describe('MergeDriver', () => {
const ancestorWithComment = ''
const ourWithComment = ''
const theirWithComment = ''
- mockedmerge.mockReturnValue('')
+ mockedmerge.mockReturnValue({ output: '', hasConflict: false })
// Act
const result = sut.tripartXmlMerge(
@@ -116,7 +127,8 @@ describe('MergeDriver', () => {
)
// Assert
- expect(result).toEqual('')
+ expect(result.output).toEqual('')
+ expect(result.hasConflict).toBe(false)
})
})
})
From 3e2c3ba8f95ef2ee93ee867601518767bc355ea2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 28 Mar 2025 16:42:28 +0100
Subject: [PATCH 54/55] test: improve spec coverage
---
test/unit/service/MetadataService.test.ts | 238 ++++++++++++++++++++++
1 file changed, 238 insertions(+)
diff --git a/test/unit/service/MetadataService.test.ts b/test/unit/service/MetadataService.test.ts
index 0556d0b..0c28bc9 100644
--- a/test/unit/service/MetadataService.test.ts
+++ b/test/unit/service/MetadataService.test.ts
@@ -330,6 +330,244 @@ describe('MetadataService', () => {
},
expected: '192.168.1.1-192.168.1.255',
},
+ {
+ name: 'handles dataspaceScopes with dataspaceScope',
+ metadataType: 'dataspaceScopes',
+ testObject: { dataspaceScope: 'TestDataspaceScope' },
+ expected: 'TestDataspaceScope',
+ },
+ {
+ name: 'handles emailRoutingAddressAccesses with name',
+ metadataType: 'emailRoutingAddressAccesses',
+ testObject: { name: 'TestEmailRoutingAddress' },
+ expected: 'TestEmailRoutingAddress',
+ },
+ {
+ name: 'handles externalCredentialPrincipalAccesses with externalCredentialPrincipal',
+ metadataType: 'externalCredentialPrincipalAccesses',
+ testObject: { externalCredentialPrincipal: 'TestPrincipal' },
+ expected: 'TestPrincipal',
+ },
+ {
+ name: 'handles criteriaItems with field, operation, value, and valueField',
+ metadataType: 'criteriaItems',
+ testObject: {
+ field: 'TestField',
+ operation: 'TestOperation',
+ value: 'TestValue',
+ valueField: 'TestValueField',
+ },
+ expected: 'TestField.TestOperation.TestValue.TestValueField',
+ },
+ {
+ name: 'handles recipients with type',
+ metadataType: 'recipients',
+ testObject: { type: 'TestRecipient' },
+ expected: 'TestRecipient',
+ },
+ {
+ name: 'handles flowInputs with name',
+ metadataType: 'flowInputs',
+ testObject: { name: 'TestFlowInput' },
+ expected: 'TestFlowInput',
+ },
+ {
+ name: 'handles flowAutomation with fullName',
+ metadataType: 'flowAutomation',
+ testObject: { fullName: 'TestFlowAutomation' },
+ expected: 'TestFlowAutomation',
+ },
+ {
+ name: 'handles actions with name',
+ metadataType: 'actions',
+ testObject: { name: 'TestAction' },
+ expected: 'TestAction',
+ },
+ {
+ name: 'handles marketingAppExtActions with apiName',
+ metadataType: 'marketingAppExtActions',
+ testObject: { apiName: 'TestMarketingAppExtAction' },
+ expected: 'TestMarketingAppExtAction',
+ },
+ {
+ name: 'handles matchingRuleItems with fieldName and matchingMethod',
+ metadataType: 'matchingRuleItems',
+ testObject: { fieldName: 'TestField', matchingMethod: 'TestMethod' },
+ expected: 'TestField-TestMethod',
+ },
+ {
+ name: 'handles botTemplates with fullName',
+ metadataType: 'botTemplates',
+ testObject: { fullName: 'TestBotTemplate' },
+ expected: 'TestBotTemplate',
+ },
+ {
+ name: 'handles botVersions with fullName',
+ metadataType: 'botVersions',
+ testObject: { fullName: 'TestBotVersion' },
+ expected: 'TestBotVersion',
+ },
+ {
+ name: 'handles conversationMessageDefinitions with name',
+ metadataType: 'conversationMessageDefinitions',
+ testObject: { name: 'TestConversationMessageDefinition' },
+ expected: 'TestConversationMessageDefinition',
+ },
+ {
+ name: 'handles constantValueTranslations with name',
+ metadataType: 'constantValueTranslations',
+ testObject: { name: 'TestConstantValue' },
+ expected: 'TestConstantValue',
+ },
+ {
+ name: 'handles desFieldTemplateMessages with name',
+ metadataType: 'desFieldTemplateMessages',
+ testObject: { name: 'TestDesFieldTemplateMessage' },
+ expected: 'TestDesFieldTemplateMessage',
+ },
+ {
+ name: 'handles flows with fullName',
+ metadataType: 'flows',
+ testObject: { fullName: 'TestFlow' },
+ expected: 'TestFlow',
+ },
+ {
+ name: 'handles identityVerificationCustomFieldLabels with name',
+ metadataType: 'identityVerificationCustomFieldLabels',
+ testObject: { name: 'TestIdentityVerificationCustomFieldLabel' },
+ expected: 'TestIdentityVerificationCustomFieldLabel',
+ },
+ {
+ name: 'handles promptVersions with name',
+ metadataType: 'promptVersions',
+ testObject: { name: 'TestPromptVersion' },
+ expected: 'TestPromptVersion',
+ },
+ {
+ name: 'handles botBlocks with fullName',
+ metadataType: 'botBlocks',
+ testObject: { fullName: 'TestBotBlock' },
+ expected: 'TestBotBlock',
+ },
+ {
+ name: 'handles botBlockVersions with fullName',
+ metadataType: 'botBlockVersions',
+ testObject: { fullName: 'TestBotBlockVersion' },
+ expected: 'TestBotBlockVersion',
+ },
+ {
+ name: 'handles botDialogs with developerName',
+ metadataType: 'botDialogs',
+ testObject: { developerName: 'TestBotDialog' },
+ expected: 'TestBotDialog',
+ },
+ {
+ name: 'handles botSteps with stepIdentifier',
+ metadataType: 'botSteps',
+ testObject: { stepIdentifier: 'TestStep' },
+ expected: 'TestStep',
+ },
+ {
+ name: 'handles botMessages with messageIdentifier',
+ metadataType: 'botMessages',
+ testObject: { messageIdentifier: 'TestMessage' },
+ expected: 'TestMessage',
+ },
+ {
+ name: 'handles botVariableOperation with variableOperationIdentifier',
+ metadataType: 'botVariableOperation',
+ testObject: { variableOperationIdentifier: 'TestOperation' },
+ expected: 'TestOperation',
+ },
+ {
+ name: 'handles sections with name or section',
+ metadataType: 'sections',
+ testObject: { name: 'TestSectionName', section: 'TestSection' },
+ expected: 'TestSectionName',
+ },
+ {
+ name: 'handles columns with name',
+ metadataType: 'columns',
+ testObject: { name: 'TestColumn' },
+ expected: 'TestColumn',
+ },
+ {
+ name: 'handles caseValues with article, caseType, plural, and possessive',
+ metadataType: 'caseValues',
+ testObject: {
+ article: 'TestArticle',
+ caseType: 'TestCaseType',
+ plural: 'TestPlural',
+ possessive: 'TestPossessive',
+ },
+ expected: 'TestArticle.TestCaseType.TestPlural.TestPossessive',
+ },
+ {
+ name: 'handles fieldSets with name',
+ metadataType: 'fieldSets',
+ testObject: { name: 'TestFieldSet' },
+ expected: 'TestFieldSet',
+ },
+ {
+ name: 'handles fields with name',
+ metadataType: 'fields',
+ testObject: { name: 'TestField' },
+ expected: 'TestField',
+ },
+ {
+ name: 'handles picklistValues with masterLabel',
+ metadataType: 'picklistValues',
+ testObject: { masterLabel: 'TestPicklistValue' },
+ expected: 'TestPicklistValue',
+ },
+ {
+ name: 'handles layouts with layout',
+ metadataType: 'layouts',
+ testObject: { layout: 'TestLayout' },
+ expected: 'TestLayout',
+ },
+ {
+ name: 'handles quickActionParametersTranslation with name',
+ metadataType: 'quickActionParametersTranslation',
+ testObject: { name: 'TestQuickActionParam' },
+ expected: 'TestQuickActionParam',
+ },
+ {
+ name: 'handles recordTypes with name',
+ metadataType: 'recordTypes',
+ testObject: { name: 'TestRecordType' },
+ expected: 'TestRecordType',
+ },
+ {
+ name: 'handles sharingReasons with name',
+ metadataType: 'sharingReasons',
+ testObject: { name: 'TestSharingReason' },
+ expected: 'TestSharingReason',
+ },
+ {
+ name: 'handles standardFields with name',
+ metadataType: 'standardFields',
+ testObject: { name: 'TestStandardField' },
+ expected: 'TestStandardField',
+ },
+ {
+ name: 'handles validationRules with name',
+ metadataType: 'validationRules',
+ testObject: { name: 'TestValidationRule' },
+ expected: 'TestValidationRule',
+ },
+ {
+ name: 'handles webLinks with name',
+ metadataType: 'webLinks',
+ testObject: { name: 'TestWebLink' },
+ expected: 'TestWebLink',
+ },
+ {
+ name: 'handles workflowTasks with name',
+ metadataType: 'workflowTasks',
+ testObject: { name: 'TestWorkflowTask' },
+ expected: 'TestWorkflowTask',
+ },
]
test.each(testCases)(
From f2581d5bd91de8d66a2c04e07e352cef9b1ad740 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Colladon?= <colladonsebastien@gmail.com>
Date: Fri, 28 Mar 2025 16:42:50 +0100
Subject: [PATCH 55/55] chore: upgrade dependencies
---
package-lock.json | 128 +++++++++++++++++++++++++---------------------
package.json | 10 ++--
2 files changed, 76 insertions(+), 62 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index 8a4623d..f8336dd 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -10,7 +10,7 @@
"license": "MIT",
"dependencies": {
"@oclif/core": "^4.2.10",
- "@salesforce/core": "^8.8.6",
+ "@salesforce/core": "^8.8.7",
"@salesforce/sf-plugins-core": "^12.2.1",
"fast-xml-parser": "^5.0.9",
"lodash-es": "^4.17.21",
@@ -22,17 +22,17 @@
"@oclif/plugin-help": "^6.2.27",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
- "@types/chai": "^5.2.0",
+ "@types/chai": "^5.2.1",
"@types/jest": "^29.5.14",
"chai": "^5.2.0",
"husky": "^9.1.7",
"jest": "^29.7.0",
- "knip": "^5.46.0",
+ "knip": "^5.46.2",
"mocha": "^11.1.0",
"nyc": "^17.1.0",
- "oclif": "^4.17.40",
+ "oclif": "^4.17.41",
"shx": "^0.4.0",
- "ts-jest": "^29.2.6",
+ "ts-jest": "^29.3.0",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typescript": "^5.8.2",
@@ -3881,9 +3881,9 @@
}
},
"node_modules/@jsforce/jsforce-node": {
- "version": "3.6.6",
- "resolved": "https://registry.npmjs.org/@jsforce/jsforce-node/-/jsforce-node-3.6.6.tgz",
- "integrity": "sha512-WdIo2lLbrz6nkfiaz2UynyaNiM8o+fEjaRev7zA4KKSaQYB1MJ66xHubeI5Iheq8WgkY9XGwWKAwPDhuV+GROQ==",
+ "version": "3.7.0",
+ "resolved": "https://registry.npmjs.org/@jsforce/jsforce-node/-/jsforce-node-3.7.0.tgz",
+ "integrity": "sha512-v9pc3lPM5RMuB81Gasz5/NKcjktE1LLEACRFopB9LiXRafb4K9bStSMl3nLEHq7+OFdtxfQB3Sx2rYXJGG4DKw==",
"license": "MIT",
"dependencies": {
"@sindresorhus/is": "^4",
@@ -3913,31 +3913,6 @@
"url": "https://github.com/sindresorhus/is?sponsor=1"
}
},
- "node_modules/@jsforce/jsforce-node/node_modules/csv-parse": {
- "version": "5.6.0",
- "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-5.6.0.tgz",
- "integrity": "sha512-l3nz3euub2QMg5ouu5U09Ew9Wf6/wQ8I++ch1loQ0ljmzhmfZYrH9fflS22i/PQEvsPvxCwxgz5q7UB8K1JO4Q==",
- "license": "MIT"
- },
- "node_modules/@jsforce/jsforce-node/node_modules/csv-stringify": {
- "version": "6.5.2",
- "resolved": "https://registry.npmjs.org/csv-stringify/-/csv-stringify-6.5.2.tgz",
- "integrity": "sha512-RFPahj0sXcmUyjrObAK+DOWtMvMIFV328n4qZJhgX3x2RqkQgOTU2mCUmiFR0CzM6AzChlRSUErjiJeEt8BaQA==",
- "license": "MIT"
- },
- "node_modules/@jsforce/jsforce-node/node_modules/xml2js": {
- "version": "0.6.2",
- "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.6.2.tgz",
- "integrity": "sha512-T4rieHaC1EXcES0Kxxj4JWgaUQHDk+qwHcYOCFHfiwKz7tOVPLq7Hjq9dM1WCMhylqMEfP7hMcOIChvotiZegA==",
- "license": "MIT",
- "dependencies": {
- "sax": ">=0.6.0",
- "xmlbuilder": "~11.0.0"
- },
- "engines": {
- "node": ">=4.0.0"
- }
- },
"node_modules/@kwsites/file-exists": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/@kwsites/file-exists/-/file-exists-1.1.1.tgz",
@@ -4248,12 +4223,12 @@
}
},
"node_modules/@salesforce/core": {
- "version": "8.8.6",
- "resolved": "https://registry.npmjs.org/@salesforce/core/-/core-8.8.6.tgz",
- "integrity": "sha512-RQK7iUvOv579qZkz93DtXOTFY6HZrOF1iJB5JntnzzmWgKXwdeRdoyIYlLksrDp0vkNtjtNTZZz+IJY4x6eCig==",
+ "version": "8.8.7",
+ "resolved": "https://registry.npmjs.org/@salesforce/core/-/core-8.8.7.tgz",
+ "integrity": "sha512-AuPSmb/GZ7F8eV5GO6NcfFq3YSOVnPL4sssEQEvKduOSJMs8RTJ92kEefrId/tgFBYfw4b7UzndjFtdgrGGeoA==",
"license": "BSD-3-Clause",
"dependencies": {
- "@jsforce/jsforce-node": "^3.6.5",
+ "@jsforce/jsforce-node": "^3.7.0",
"@salesforce/kit": "^3.2.2",
"@salesforce/schemas": "^1.9.0",
"@salesforce/ts-types": "^2.0.10",
@@ -5297,9 +5272,9 @@
}
},
"node_modules/@types/chai": {
- "version": "5.2.0",
- "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.0.tgz",
- "integrity": "sha512-FWnQYdrG9FAC8KgPVhDFfrPL1FBsL3NtIt2WsxKvwu/61K6HiuDF3xAb7c7w/k9ML2QOUHcwTgU7dKLFPK6sBg==",
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.1.tgz",
+ "integrity": "sha512-iu1JLYmGmITRzUgNiLMZD3WCoFzpYtueuyAgHTXqgwSRAMIlFTnZqG6/xenkpUGRJEzSfklUTI4GNSzks/dc0w==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -6813,6 +6788,18 @@
"integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==",
"license": "MIT"
},
+ "node_modules/csv-parse": {
+ "version": "5.6.0",
+ "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-5.6.0.tgz",
+ "integrity": "sha512-l3nz3euub2QMg5ouu5U09Ew9Wf6/wQ8I++ch1loQ0ljmzhmfZYrH9fflS22i/PQEvsPvxCwxgz5q7UB8K1JO4Q==",
+ "license": "MIT"
+ },
+ "node_modules/csv-stringify": {
+ "version": "6.5.2",
+ "resolved": "https://registry.npmjs.org/csv-stringify/-/csv-stringify-6.5.2.tgz",
+ "integrity": "sha512-RFPahj0sXcmUyjrObAK+DOWtMvMIFV328n4qZJhgX3x2RqkQgOTU2mCUmiFR0CzM6AzChlRSUErjiJeEt8BaQA==",
+ "license": "MIT"
+ },
"node_modules/dateformat": {
"version": "4.6.3",
"resolved": "https://registry.npmjs.org/dateformat/-/dateformat-4.6.3.tgz",
@@ -10399,9 +10386,9 @@
}
},
"node_modules/knip": {
- "version": "5.46.0",
- "resolved": "https://registry.npmjs.org/knip/-/knip-5.46.0.tgz",
- "integrity": "sha512-WedHSK5xNBWYgm64Rt5B9b0CVXL2kRBcyCeet3NHgdv9en3QE4AWSDPEiX48NoPUBW3h//9S0VwLF5MG/MPi3g==",
+ "version": "5.46.2",
+ "resolved": "https://registry.npmjs.org/knip/-/knip-5.46.2.tgz",
+ "integrity": "sha512-QGVkUVUwNv1zDOmb9ob4jraWNZu06O5xPa5cl97wzHmGGqJHkLfuvAzGTpuVxgujq+FKOXTbD8vv1TfimKTPAQ==",
"dev": true,
"funding": [
{
@@ -11416,9 +11403,9 @@
}
},
"node_modules/oclif": {
- "version": "4.17.40",
- "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.17.40.tgz",
- "integrity": "sha512-lS7tsZD0KJaKpwZe/7uC3awNRfFTJEKMAPlu18S0KfJWtdPf9sn4eIcwo+Vyd13rfmpHNx82rP+PtUUJ2n1nEw==",
+ "version": "4.17.41",
+ "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.17.41.tgz",
+ "integrity": "sha512-l1VlcXDOXXpMmClGmxJSyas/vMbq1XdyZsCGG7s83oNAIcEdZZFe5NPmxO2ZPRCPFhKy+zoV8f5/NpUuoc4H8Q==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -11427,7 +11414,7 @@
"@inquirer/confirm": "^3.1.22",
"@inquirer/input": "^2.2.4",
"@inquirer/select": "^2.5.0",
- "@oclif/core": "^4.2.8",
+ "@oclif/core": "^4.2.10",
"@oclif/plugin-help": "^6.2.27",
"@oclif/plugin-not-found": "^3.2.46",
"@oclif/plugin-warn-if-update-available": "^3.1.31",
@@ -13496,21 +13483,21 @@
}
},
"node_modules/tldts": {
- "version": "6.1.82",
- "resolved": "https://registry.npmjs.org/tldts/-/tldts-6.1.82.tgz",
- "integrity": "sha512-KCTjNL9F7j8MzxgfTgjT+v21oYH38OidFty7dH00maWANAI2IsLw2AnThtTJi9HKALHZKQQWnNebYheadacD+g==",
+ "version": "6.1.85",
+ "resolved": "https://registry.npmjs.org/tldts/-/tldts-6.1.85.tgz",
+ "integrity": "sha512-gBdZ1RjCSevRPFix/hpaUWeak2/RNUZB4/8frF1r5uYMHjFptkiT0JXIebWvgI/0ZHXvxaUDDJshiA0j6GdL3w==",
"license": "MIT",
"dependencies": {
- "tldts-core": "^6.1.82"
+ "tldts-core": "^6.1.85"
},
"bin": {
"tldts": "bin/cli.js"
}
},
"node_modules/tldts-core": {
- "version": "6.1.82",
- "resolved": "https://registry.npmjs.org/tldts-core/-/tldts-core-6.1.82.tgz",
- "integrity": "sha512-Jabl32m21tt/d/PbDO88R43F8aY98Piiz6BVH9ShUlOAiiAELhEqwrAmBocjAqnCfoUeIsRU+h3IEzZd318F3w==",
+ "version": "6.1.85",
+ "resolved": "https://registry.npmjs.org/tldts-core/-/tldts-core-6.1.85.tgz",
+ "integrity": "sha512-DTjUVvxckL1fIoPSb3KE7ISNtkWSawZdpfxGxwiIrZoO6EbHVDXXUIlIuWympPaeS+BLGyggozX/HTMsRAdsoA==",
"license": "MIT"
},
"node_modules/tmp": {
@@ -13564,9 +13551,9 @@
"license": "MIT"
},
"node_modules/ts-jest": {
- "version": "29.2.6",
- "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.2.6.tgz",
- "integrity": "sha512-yTNZVZqc8lSixm+QGVFcPe6+yj7+TWZwIesuOWvfcn4B9bz5x4NDzVCQQjOs7Hfouu36aEqfEbo9Qpo+gq8dDg==",
+ "version": "29.3.0",
+ "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.3.0.tgz",
+ "integrity": "sha512-4bfGBX7Gd1Aqz3SyeDS9O276wEU/BInZxskPrbhZLyv+c1wskDCqDFMJQJLWrIr/fKoAH4GE5dKUlrdyvo+39A==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -13578,6 +13565,7 @@
"lodash.memoize": "^4.1.2",
"make-error": "^1.3.6",
"semver": "^7.7.1",
+ "type-fest": "^4.37.0",
"yargs-parser": "^21.1.1"
},
"bin": {
@@ -13612,6 +13600,19 @@
}
}
},
+ "node_modules/ts-jest/node_modules/type-fest": {
+ "version": "4.38.0",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.38.0.tgz",
+ "integrity": "sha512-2dBz5D5ycHIoliLYLi0Q2V7KRaDlH0uWIvmk7TYlAg5slqwiPv1ezJdZm1QEM0xgk29oYWMCbIG7E6gHpvChlg==",
+ "dev": true,
+ "license": "(MIT OR CC0-1.0)",
+ "engines": {
+ "node": ">=16"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
"node_modules/ts-node": {
"version": "10.9.2",
"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
@@ -14126,6 +14127,19 @@
}
}
},
+ "node_modules/xml2js": {
+ "version": "0.6.2",
+ "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.6.2.tgz",
+ "integrity": "sha512-T4rieHaC1EXcES0Kxxj4JWgaUQHDk+qwHcYOCFHfiwKz7tOVPLq7Hjq9dM1WCMhylqMEfP7hMcOIChvotiZegA==",
+ "license": "MIT",
+ "dependencies": {
+ "sax": ">=0.6.0",
+ "xmlbuilder": "~11.0.0"
+ },
+ "engines": {
+ "node": ">=4.0.0"
+ }
+ },
"node_modules/xmlbuilder": {
"version": "11.0.1",
"resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-11.0.1.tgz",
diff --git a/package.json b/package.json
index 6180c8f..e7c8748 100644
--- a/package.json
+++ b/package.json
@@ -11,7 +11,7 @@
},
"dependencies": {
"@oclif/core": "^4.2.10",
- "@salesforce/core": "^8.8.6",
+ "@salesforce/core": "^8.8.7",
"@salesforce/sf-plugins-core": "^12.2.1",
"fast-xml-parser": "^5.0.9",
"lodash-es": "^4.17.21",
@@ -23,17 +23,17 @@
"@oclif/plugin-help": "^6.2.27",
"@salesforce/cli-plugins-testkit": "^5.3.39",
"@salesforce/dev-config": "^4.3.1",
- "@types/chai": "^5.2.0",
+ "@types/chai": "^5.2.1",
"@types/jest": "^29.5.14",
"chai": "^5.2.0",
"husky": "^9.1.7",
"jest": "^29.7.0",
- "knip": "^5.46.0",
+ "knip": "^5.46.2",
"mocha": "^11.1.0",
"nyc": "^17.1.0",
- "oclif": "^4.17.40",
+ "oclif": "^4.17.41",
"shx": "^0.4.0",
- "ts-jest": "^29.2.6",
+ "ts-jest": "^29.3.0",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typescript": "^5.8.2",