fix: detection of CustomMetadata type (scolladon#844)

deloitte-engineering · Apr 22, 2024 · 412592b · 412592b
1 parent b161622
commit 412592b
Show file tree

Hide file tree

Showing 5 changed files with 118 additions and 89 deletions.
diff --git a/__tests__/unit/lib/metadata/MetadataRepositoryImpl.test.ts b/__tests__/unit/lib/metadata/MetadataRepositoryImpl.test.ts
@@ -22,6 +22,13 @@ describe('MetadataRepositoryImpl', () => {
         suffix: 'app',
         xmlName: 'CustomApplication',
       },
+      {
+        directoryName: 'customMetadata',
+        inFolder: false,
+        metaFile: false,
+        suffix: 'md',
+        xmlName: 'CustomMetadata',
+      },
       {
         directoryName: 'documents',
         inFolder: true,
@@ -228,6 +235,17 @@ describe('MetadataRepositoryImpl', () => {
       })
 
       describe('special cases where it should only match on folder', () => {
+        it('matches `md` files inside `customMetadata` folder', () => {
+          // Act
+          const result = sut.get(
+            'force-app/customMetadata/testCustomMetadata.md'
+          )
+
+          // Assert
+          expect(result).toStrictEqual(
+            expect.objectContaining({ directoryName: 'customMetadata' })
+          )
+        })
         it('matches `xml` files inside `emailservices` folder', () => {
           // Act
           const result = sut.get('force-app/emailservices/testService.xml')
@@ -346,7 +364,7 @@ describe('MetadataRepositoryImpl', () => {
         expect(result).toBeUndefined()
       })
 
-      it('matches on folder', () => {
+      it('does not match `app` files outside `applications` folder', () => {
         // Act
         const result = sut.get(
           'Z force-app/main/folder/aura/TestApp/TestApp.app'
@@ -357,6 +375,14 @@ describe('MetadataRepositoryImpl', () => {
           expect.objectContaining({ directoryName: 'aura' })
         )
       })
+
+      it('does not match `md` files outside `customMetadata` folder', () => {
+        // Act
+        const result = sut.get('README.md')
+
+        // Assert
+        expect(result).toBeUndefined()
+      })
     })
   })
 

diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
   "author": "Sebastien Colladon <colladonsebastien@gmail.com>",
   "dependencies": {
     "@salesforce/command": "^5.3.9",
-    "@salesforce/core": "^7.3.0",
+    "@salesforce/core": "^7.3.1",
     "async": "^3.2.5",
     "fast-xml-parser": "^4.3.6",
     "fs-extra": "^11.2.0",
@@ -178,7 +178,7 @@
     "@commitlint/config-conventional": "^19.2.2",
     "@jest/globals": "^29.7.0",
     "@oclif/dev-cli": "^1.26.10",
-    "@salesforce/cli-plugins-testkit": "^5.2.1",
+    "@salesforce/cli-plugins-testkit": "^5.2.3",
     "@salesforce/dev-config": "^4.1.0",
     "@salesforce/ts-sinon": "^1.4.19",
     "@stryker-mutator/core": "^8.2.6",
@@ -188,8 +188,8 @@
     "@types/jest": "^29.5.12",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.12.7",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
     "benchmark": "^2.1.4",
     "chai": "^4.3.10",
     "eslint": "^8.57.0",

diff --git a/src/constant/metadataConstants.ts b/src/constant/metadataConstants.ts
@@ -1,6 +1,7 @@
 'use strict'
 export const CUSTOM_APPLICATION_SUFFIX = 'app'
-export const EMAILSERVICESFUNCTION_SUFFIX = 'xml'
+export const CUSTOM_METADATA_SUFFIX = 'md'
+export const EMAIL_SERVICES_FUNCTION_SUFFIX = 'xml'
 export const FIELD_DIRECTORY_NAME = 'fields'
 export const FLOW_XML_NAME = 'Flow'
 export const INFOLDER_SUFFIX = `Folder`

diff --git a/src/metadata/MetadataRepositoryImpl.ts b/src/metadata/MetadataRepositoryImpl.ts
@@ -5,7 +5,8 @@ import { parse } from 'path'
 import { DOT, PATH_SEP } from '../constant/fsConstants'
 import {
   CUSTOM_APPLICATION_SUFFIX,
-  EMAILSERVICESFUNCTION_SUFFIX,
+  CUSTOM_METADATA_SUFFIX,
+  EMAIL_SERVICES_FUNCTION_SUFFIX,
   METAFILE_SUFFIX,
   OBJECT_TRANSLATION_TYPE,
   OBJECT_TYPE,
@@ -129,7 +130,8 @@ export class MetadataRepositoryImpl implements MetadataRepository {
 
   private static UNSAFE_EXTENSION = new Set([
     CUSTOM_APPLICATION_SUFFIX,
-    EMAILSERVICESFUNCTION_SUFFIX,
+    EMAIL_SERVICES_FUNCTION_SUFFIX,
+    CUSTOM_METADATA_SUFFIX,
   ])
 
   private static COMPOSED_TYPES = new Set([