@ds-sfdc/sfparty 1.3.5 → 1.3.7

package/README.md

@@ -1,6 +1,6 @@
 # @ds-sfdc/sfparty
 
-[![NPM](https://img.shields.io/npm/v/@ds-sfdc/sfparty.svg?label=@ds-sfdc/sfparty)](https://www.npmjs.com/package/@ds-sfdc/sfparty) [![Downloads/week](https://img.shields.io/npm/dw/@ds-sfdc/sfparty.svg)](https://npmjs.org/package/@ds-sfdc/sfparty) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://github.com/TimPaulaskasDS/sfparty/blob/main/LICENSE.md)
+[![NPM](https://img.shields.io/npm/v/@ds-sfdc/sfparty.svg?label=@ds-sfdc/sfparty)](https://www.npmjs.com/package/@ds-sfdc/sfparty) [![Downloads/week](https://img.shields.io/npm/dw/@ds-sfdc/sfparty.svg)](https://npmjs.org/package/@ds-sfdc/sfparty) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://github.com/TimPaulaskasDS/sfparty/blob/main/LICENSE.md) ![CI/CD](https://github.com/TimPaulaskasDS/sfparty/actions/workflows/cicd.yaml/badge.svg)
 
 ## Why use sfparty?
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ds-sfdc/sfparty",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "Salesforce metadata XML splitter for CI/CD",
   "type": "module",
   "repository": {
@@ -33,6 +33,7 @@
     "marked": "^4.2.12",
     "marked-terminal": "^5.1.1",
     "pinst": "^3.0.0",
+    "semver": "^7.3.8",
     "util": "^0.10.3",
     "winston": "^3.8.2",
     "xml2js": "^0.4.23",

package/src/index.js

@@ -139,9 +139,17 @@ yargs(hideBin(process.argv))
                 .check(yargCheck)
         },
         handler: (argv) => {
-            checkVersion(axios, spawnSync, pkgObj.default.version, true)
+            checkVersion({axios, spawnSync, currentVersion: pkgObj.default.version, update: true})
         }
     })
+    .command({
+        command: '[version]',
+        alias: 'version',
+        builder: (yargs) => {
+            yargs
+                .check(yargCheck)
+        },
+    })
     .command({
         command: '[split]',
         alias: 'split',
@@ -154,7 +162,7 @@ yargs(hideBin(process.argv))
                 .check(yargCheck)
         },
         handler: (argv) => {
-            checkVersion(axios, spawnSync, pkgObj.default.version)
+            checkVersion({axios, spawnSync, currentVersion: pkgObj.default.version})
             global.format = argv.format
             splitHandler(argv, processStartTime)
         }
@@ -171,7 +179,7 @@ yargs(hideBin(process.argv))
                 .check(yargCheck)
         },
         handler: (argv) => {
-            checkVersion(axios, spawnSync, pkgObj.default.version)
+            checkVersion({axios, spawnSync, currentVersion: pkgObj.default.version})
             global.format = argv.format
             const startProm = new Promise((resolve, reject) => {
                 if (argv.git !== undefined) {
@@ -253,6 +261,10 @@ function yargCheck(argv, options) {
         !options.array.includes(key)
         )
 
+    if (!argv._.includes('update')) {
+        checkVersion({axios, spawnSync, currentVersion: pkgObj.default.version, update: false})        
+    }
+    
     if (invalidKeys.length > 0) {
         const invalidKeysWithColor = invalidKeys.map(key => clc.redBright(key))
         throw new Error(`Invalid options specified: ${invalidKeysWithColor.join(', ')}`)
@@ -547,8 +559,8 @@ function processCombine(typeItem, argv) {
 
 function gitFiles(data) {
     data.forEach(item => {
-        if (item.path.indexOf(packageDir + '-party' + path.sep) == 0) {
-            const pathArray = item.path.split(path.sep)
+        if (item.path.indexOf(packageDir + '-party/') == 0) {
+            const pathArray = item.path.split('/')
             if (pathArray.length > 3) {
                 if (getDirectories().includes(pathArray[3])) {
                     switch (item.action) {

package/src/lib/checkVersion.js

@@ -1,4 +1,5 @@
 import clc from 'cli-color'
+import semver from 'semver'
 
 class NpmNotInstalledError extends Error {
     constructor(message) {
@@ -21,14 +22,15 @@ class UpdateError extends Error {
     }
 }
 
-export async function checkVersion(axios, spawnSync, currentVersion, update = false) {
+export async function checkVersion({axios, spawnSync, currentVersion, update = false}) {
     try {
         const { data } = await axios.get('https://registry.npmjs.org/@ds-sfdc/sfparty', {
             params: {
                 field: 'dist-tags.latest'
             }
         })
-        if (currentVersion !== data['dist-tags'].latest) {
+        const latestVersion = data['dist-tags'].latest
+        if (semver.gt(latestVersion, currentVersion)) {
             let icon
             const version = clc.bgCyanBright(data['dist-tags'].latest)
             if (update) {
@@ -41,11 +43,11 @@ export async function checkVersion(axios, spawnSync, currentVersion, update = fa
                 console.log(`Please upgrade by running ${clc.cyanBright('sfparty update')}`)
                 return 'A newer version'
             } else {
-                let command = 'npm i -g @ds-sfdc/sfparty'.split(' ')
+                let command = 'npm i -g @ds-sfdc/sfparty@latest'.split(' ')
                 console.log(`Updating the application using ${clc.cyanBright(command.join(' '))}`)
                 try {
                     const npmVersion = spawnSync('npm', ['-v'])
-                    if (npmVersion.stderr.toString().trim() === 'command not found') {
+                    if (npmVersion.stderr && npmVersion.stderr.toString().trim() === 'command not found') {
                         throw new NpmNotInstalledError("npm is not installed on this system. Please install npm and run the command again.")
                     }
                     const update = spawnSync(command[0], command.slice(1))
@@ -54,11 +56,6 @@ export async function checkVersion(axios, spawnSync, currentVersion, update = fa
                     }
                     console.log("Application updated successfully.")
                 } catch (err) {
-                    if (err instanceof NpmNotInstalledError) {
-                        console.error(err)
-                    } else if (err instanceof UpdateError) {
-                        console.error(err)
-                    }
                     throw err
                 }
             }
@@ -72,7 +69,6 @@ export async function checkVersion(axios, spawnSync, currentVersion, update = fa
         if (error.response && error.response.status === 404) {
             error = new PackageNotFoundError("Package not found on the npm registry")
         }
-        console.error(error)
         throw error
     }
 }

package/src/lib/gitUtils.js

@@ -57,7 +57,7 @@ export function diff(dir, gitRef = 'HEAD', existsSyncStub = existsSync, execSync
 
         let data = ''
         try {
-            data = execSyncStub(`git diff --name-status --oneline --relative ${gitRef}`, { cwd: dir, maxBuffer: 1024 * 1024 * 10 }).toString()
+            data = execSyncStub(`git diff --name-status --oneline --relative ${gitRef} -- *-party/*`, { cwd: dir, maxBuffer: 1024 * 1024 * 10 }).toString()
         } catch (error) {
             reject(error)
         }

package/src/lib/packageUtil.js

@@ -25,7 +25,6 @@ export class Package {
                                 processJSON(that, json, fileUtils)
                                 resolve('existing')                                    
                             } catch (error) {
-                                console.error(error)
                                 reject(error)
                             }
                         })
@@ -55,6 +54,20 @@ export class Package {
             }
             that.packageJSON = json
             if (json.Package.types !== undefined) transformJSON(json.Package.types)
+            cleanPackage(that)
+        }
+
+        function cleanPackage(that) {
+            if (that.packageJSON === undefined) throw new Error('getPackageXML must be called before adding members')
+            if (that.packageJSON.Package == undefined) throw new Error('Package initialization failed')
+            if (that.packageJSON.Package.types === undefined) return 'No types found'
+        
+            const typeArray = Object.values(global.metaTypes).map(metaType => metaType.definition.root);
+            that.packageJSON.Package.types.forEach(typeItem => {
+                if (typeArray.includes(typeItem.name)) {
+                    typeItem.members = typeItem.members.filter(member => !member.endsWith(`.${global.format}`))
+                }
+            })
         }
     }
 

package/test/{checkVersion.spec.js → lib/checkVersion.spec.js}

@@ -1,7 +1,7 @@
 import axios from 'axios'
 import { spawnSync } from 'child_process'
 import clc from 'cli-color'
-import { checkVersion } from '../src/lib/checkVersion.js'
+import { checkVersion } from '../../src/lib/checkVersion.js'
 
 global.icons = {
     "success": clc.greenBright('✔'),
@@ -24,46 +24,72 @@ describe('checkVersion', () => {
 
     it('should return "A newer version" if a newer version is available', async () => {
         axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '2.0.0' } } })
-        const result = await checkVersion(axios, spawnSync, '1.0.0')
+        const result = await checkVersion({axios, spawnSync, currentVersion: '1.0.0'})
         expect(result).toBe('A newer version')
-    })
+    }, { silent: true })
 
     it('should return "You are on the latest version" if the current version is the latest version', async () => {
         axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '1.0.0' } } })
-        const result = await checkVersion(axios, spawnSync, '1.0.0')
+        const result = await checkVersion({axios, spawnSync, currentVersion: '1.0.0'})
         expect(result).toBe('You are on the latest version')
-    })
+    }, { silent: true })
 
     it('should throw a NpmNotInstalledError if npm is not installed', async () => {
         axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '2.0.0' } } })
         spawnSync.mockReturnValue({ status: 1, stderr: { toString: () => 'command not found' } })
         try {
-            await checkVersion(axios, spawnSync, '1.0.0', true)
+            await checkVersion({axios, spawnSync, currentVersion: '1.0.0', update: true})
         } catch (err) {
             expect(err.name).toBe('NpmNotInstalledError')
             expect(err.message).toBe('npm is not installed on this system. Please install npm and run the command again.')
         }
-    })
+    }, { silent: true })
 
     it('should throw a PackageNotFoundError if the package is not found on the npm registry', async () => {
         axios.get.mockRejectedValue({ response: { status: 404 } });
         try {
-            await checkVersion(axios, spawnSync, '1.0.0');
+            await checkVersion({axios, spawnSync, currentVersion: '1.0.0'});
         } catch (err) {
             expect(err.name).toBe('PackageNotFoundError');
             expect(err.message).toBe('Package not found on the npm registry');
         }
-    });
+    }, { silent: true });
     
     it('should throw a UpdateError if an error occurs while updating the package', async () => {
         axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '2.0.0' } } });
         spawnSync.mockReturnValue({ status: 1, stderr: { toString: () => 'Update error' } });
         try {
-            await checkVersion(axios, spawnSync, '1.0.0', true);
+            await checkVersion({axios, spawnSync, currentVersion: '1.0.0', update: true});
+        } catch (err) {
+            expect(err.name).toBe('UpdateError');
+            expect(err.message).toBe('Error updating the application.');
+        }
+    }, { silent: true });
+
+    it('should throw a UpdateError if update.status !== 0', async () => {
+        axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '2.0.0' } } });
+        spawnSync.mockImplementationOnce(() => ({ status: 0 }));
+        spawnSync.mockImplementationOnce(() => ({ status: 1, stderr: { toString: () => 'Update error' } }));
+        try {
+            await checkVersion({axios, spawnSync, currentVersion: '1.0.0', update: true});
         } catch (err) {
             expect(err.name).toBe('UpdateError');
             expect(err.message).toBe('Error updating the application.');
         }
-    });
+    }, { silent: true });
+    
+    
+    it('should log "You are on the latest version" if update flag is true and the current version is the latest version', async () => {
+        axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '1.0.0' } } });
+        await checkVersion({axios, spawnSync, currentVersion: '1.0.0', update: true});
+        expect(console.log).toHaveBeenCalledWith(`${global.icons.success} You are on the latest version.`);
+    }, { silent: true });
+    
+    it('should log "Application updated successfully." after successful update', async () => {
+        axios.get.mockResolvedValue({ data: { 'dist-tags': { latest: '2.0.0' } } });
+        spawnSync.mockReturnValue({ status: 0 });
+        await checkVersion({axios, spawnSync, currentVersion: '1.0.0', update: true});
+        expect(console.log).toHaveBeenCalledWith("Application updated successfully.");
+    }, { silent: true });
     
 })

package/test/lib/package/getPackageXML.spec.js

@@ -1,5 +1,39 @@
+
 import * as packageDefinition from '../../../src/meta/Package.js'
 import { Package } from '../../../src/lib/packageUtil.js'
+import * as labelDefinition from '../../../src/meta/CustomLabels.js'
+import * as profileDefinition from '../../../src/meta/Profiles.js'
+import * as permsetDefinition from '../../../src/meta/PermissionSets.js'
+import * as workflowDefinition from '../../../src/meta/Workflows.js'
+
+global.__basedir = '.'
+
+global.metaTypes = {
+    label: {
+        type: labelDefinition.metadataDefinition.filetype,
+        definition: labelDefinition.metadataDefinition,
+        add: { files: [], directories: [] },
+        remove: { files: [], directories: [] },
+    },
+    profile: {
+        type: profileDefinition.metadataDefinition.filetype,
+        definition: profileDefinition.metadataDefinition,
+        add: { files: [], directories: [] },
+        remove: { files: [], directories: [] },
+    },
+    permset: {
+        type: permsetDefinition.metadataDefinition.filetype,
+        definition: permsetDefinition.metadataDefinition,
+        add: { files: [], directories: [] },
+        remove: { files: [], directories: [] },
+    },
+    workflow: {
+        type: workflowDefinition.metadataDefinition.filetype,
+        definition: workflowDefinition.metadataDefinition,
+        add: { files: [], directories: [] },
+        remove: { files: [], directories: [] },
+    },
+}
 
 let pkg;
 const fileUtils = {
@@ -9,7 +43,8 @@ const fileUtils = {
 beforeEach(() => {
     pkg = new Package('xmlPath');
 });
-global.__basedir = '.'
+
+
 afterEach(() => {
     jest.clearAllMocks();
 });
@@ -55,3 +90,79 @@ it('should throw an error if error occurs during processing', async () => {
     fileUtils.readFile.mockRejectedValue(new Error('Error'));
     await expect(pkg.getPackageXML(fileUtils)).rejects.toThrowError('Error');
 });
+
+it('should catch errors and reject the promise', async () => {
+    fileUtils.fileExists.mockReturnValue(true);
+    fileUtils.readFile.mockRejectedValue(new Error('Test Error'));
+    global.git = { append: true }
+    try {
+        await pkg.getPackageXML(fileUtils);
+    } catch (error) {
+        expect(error.message).toEqual('Test Error');
+    }
+});
+
+it('should default to an empty package if the read file is empty', async () => {
+    fileUtils.fileExists.mockReturnValue(true);
+    fileUtils.readFile.mockResolvedValue('');
+    global.git = { append: true }
+    const result = await pkg.getPackageXML(fileUtils);
+    expect(result).toBe('existing');
+    expect(pkg.packageJSON).toEqual(packageDefinition.metadataDefinition.emptyPackage);
+    expect(fileUtils.fileExists).toHaveBeenCalled();
+    expect(fileUtils.readFile).toHaveBeenCalled();
+});
+
+it('should throw an error if fileUtils.readFile() returns a rejected promise', async () => {
+    fileUtils.fileExists.mockReturnValue(true);
+    fileUtils.readFile.mockRejectedValue(new Error('Test Error'));
+    global.git = { append: true }
+    await expect(pkg.getPackageXML(fileUtils)).rejects.toThrowError('Test Error');
+    expect(fileUtils.fileExists).toHaveBeenCalled();
+    expect(fileUtils.readFile).toHaveBeenCalled();
+});
+
+it('should correctly process the json object returned from the XML file', async () => {
+    fileUtils.fileExists.mockReturnValue(true);
+    fileUtils.readFile.mockResolvedValue({
+        "Package": {
+            "types": [{
+                "members": ["Test", "Test.yaml"],
+                "name": "CustomLabels"
+            }, {
+                "members": ["Test", "Test.yaml"],
+                "name": "Profile"
+            }, {
+                "members": ["Test", "Test.yaml"],
+                "name": "PermissionSet"
+            }, {
+                "members": ["Test", "Test.yaml"],
+                "name": "Workflow"
+            }],
+            "version": "56.0"
+        }
+    });
+    global.git = { append: true }
+    const result = await pkg.getPackageXML(fileUtils);
+    expect(result).toBe('existing');
+    expect(fileUtils.fileExists).toHaveBeenCalled();
+    expect(fileUtils.readFile).toHaveBeenCalled();
+    expect(pkg.packageJSON).toEqual({
+        "Package": {
+            "types": [{
+                "members": ["Test", "Test.yaml"],
+                "name": "CustomLabels"
+            }, {
+                "members": ["Test", "Test.yaml"],
+                "name": "Profile"
+            }, {
+                "members": ["Test", "Test.yaml"],
+                "name": "PermissionSet"
+            }, {
+                "members": ["Test", "Test.yaml"],
+                "name": "Workflow"
+            }],
+            "version": "56.0"
+        }
+    });
+});