feat: Pr/875 (#885)

shetzel · prashanthjos · svc-cli-bot · web-flow · commit 411d0111a0a5 · 2023-03-13T14:29:23.000-06:00
* fix(mixedcontentsourceadapter.ts): error - Delete operation of experiencepropertytype metadata

this change is to fix the error during delete operation for experiencepropertytype metadata api. as
the bundle is all json files and there is no xml file in place delete operation is failing when the
metadata API is failing in the backend and this is the fix for same.

* feat(mixedcontentsourceadapter.ts): error during delete operation of experiencepropertytype bundle

This change is to fix the error during the delete operation for experiencepropertytype metadata
bundle. As the bundle is all JSON files and there is no XML file in the bundle there will be an
error when the delete operation fails in the backend and this is the fix for the same.

* fix(mixedcontentsourceadapter.test.ts): error during delete operation of experiencepropertytype

This change is to fix the error during the delete operation for experiencepropertytype metadata
bundle. As the bundle is all JSON files and there is no XML file in the bundle there will be an
error when the delete operation fails in the backend and this is the fix for the same.

* test: record perf

* fix: lint fix

* test: record perf

---------

Co-authored-by: Prashanth Josyula &lt;prashanth.16@gmail.com&gt;
Co-authored-by: svc-cli-bot &lt;svc_cli_bot@salesforce.com&gt;
diff --git a/src/registry/metadataRegistry.json b/src/registry/metadataRegistry.json
@@ -3388,6 +3388,7 @@
       "inFolder": false,
       "strictDirectoryName": true,
       "supportsPartialDelete": true,
+      "metaFileSuffix": "schema.json",
       "strategies": {
         "adapter": "bundle"
       }
diff --git a/src/resolve/adapters/mixedContentSourceAdapter.ts b/src/resolve/adapters/mixedContentSourceAdapter.ts
@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { dirname, basename, sep } from 'path';
+import { dirname, basename, sep, join } from 'path';
 import { Messages, SfError } from '@salesforce/core';
 import { baseName } from '../../utils/path';
 import { SourcePath } from '../../common';
@@ -68,6 +68,7 @@ export class MixedContentSourceAdapter extends BaseSourceAdapter {
           name: baseName(contentPath),
           type: this.type,
           content: contentPath,
+          xml: this.type.metaFileSuffix && join(contentPath, this.type.metaFileSuffix),
         },
         this.tree,
         this.forceIgnore
diff --git a/test/mock/index.ts b/test/mock/index.ts
@@ -13,6 +13,7 @@ export {
   mixedContentDirectory,
   mixedContentInFolder,
   mixedContentSingleFile,
+  experiencePropertyTypeContentSingleFile,
   decomposed,
   nonDecomposed,
   decomposedtoplevel,
diff --git a/test/mock/type-constants/experiencePropertyTypeBundleConstants.ts b/test/mock/type-constants/experiencePropertyTypeBundleConstants.ts
@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { join } from 'path';
+
+import { registry, SourceComponent } from '../../../src';
+
+/**
+ * Experience Property Type Bundle will be of the following shape:
+ *
+ * experiencePropertyTypeBundles/
+ * ├── prop1/
+ * |   ├── schema.json
+ * |   ├── design.json
+ *
+ * schema.json is always expected to be in the bundle, while design.json is optional.
+ *
+ * NOTE: there is no -meta.xml. schema.json acts as the meta XML file.
+ */
+
+// This is the type defined in metadataRegistry.json
+const type = registry.types.experiencepropertytypebundle;
+
+// This will be the root directory experiencePropertyTypeBundles.It is something like /path/to/experiencePropertyTypeBundles
+export const TYPE_DIRECTORY = join('path', 'to', type.directoryName);
+
+// This is the name of the property type we are creating.
+export const COMPONENT_NAME = 'prop1';
+
+// This is the schema.json and design.json paths inside the property type.
+export const CONTENT_NAMES = [type.metaFileSuffix, 'design.json'];
+
+// This is the complete path to the content. It is something like /path/to/experiencePropertyTypeBundles/prop1/schema.json.
+export const CONTENT_PATHS = CONTENT_NAMES.map((n) => join(TYPE_DIRECTORY, join(COMPONENT_NAME, n)));
+
+// Finally we construct our component.
+export const COMPONENT = SourceComponent.createVirtualComponent(
+  {
+    name: COMPONENT_NAME,
+    type,
+    content: join(TYPE_DIRECTORY, COMPONENT_NAME),
+    xml: CONTENT_PATHS[0],
+  },
+  [
+    {
+      dirPath: TYPE_DIRECTORY,
+      children: [COMPONENT_NAME],
+    },
+  ]
+);
diff --git a/test/mock/type-constants/index.ts b/test/mock/type-constants/index.ts
@@ -11,6 +11,7 @@ import * as document from './documentConstants';
 import * as mixedContentDirectory from './staticresourceConstant';
 import * as mixedContentInFolder from './documentFolderConstant';
 import * as mixedContentSingleFile from './staticresourceComponentConstant';
+import * as experiencePropertyTypeContentSingleFile from './experiencePropertyTypeBundleConstants';
 import * as decomposed from './customObjectConstant';
 import * as decomposedtoplevel from './customObjectTranslationConstant';
 import * as nonDecomposed from './customlabelsConstant';
@@ -32,4 +33,5 @@ export {
   nestedTypes,
   lwcBundle,
   digitalExperienceBundle,
+  experiencePropertyTypeContentSingleFile,
 };
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-CPU-E5-2673-v3-2-40GHz/eda.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-CPU-E5-2673-v3-2-40GHz/eda.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 345.28876100000343
+    "duration": 360.789472000004
   },
   {
     "name": "sourceToMdapi",
-    "duration": 8330.387101
+    "duration": 8919.91247500002
   },
   {
     "name": "sourceToZip",
-    "duration": 5822.162848000007
+    "duration": 6025.233091000002
   },
   {
     "name": "mdapiToSource",
-    "duration": 6123.899523999979
+    "duration": 6253.451692000002
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-CPU-E5-2673-v3-2-40GHz/lotsOfClasses.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-CPU-E5-2673-v3-2-40GHz/lotsOfClasses.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 675.3449159999727
+    "duration": 744.0605729999952
   },
   {
     "name": "sourceToMdapi",
-    "duration": 11995.010080000007
+    "duration": 13127.422728999984
   },
   {
     "name": "sourceToZip",
-    "duration": 9518.928809000005
+    "duration": 10371.91620399995
   },
   {
     "name": "mdapiToSource",
-    "duration": 7432.586432000011
+    "duration": 7902.201856
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-CPU-E5-2673-v3-2-40GHz/lotsOfClassesOneDir.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-CPU-E5-2673-v3-2-40GHz/lotsOfClassesOneDir.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 1170.5348080000258
+    "duration": 1188.3639100000146
   },
   {
     "name": "sourceToMdapi",
-    "duration": 17969.274023000035
+    "duration": 18936.191220000037
   },
   {
     "name": "sourceToZip",
-    "duration": 14706.58613000001
+    "duration": 15125.748401999997
   },
   {
     "name": "mdapiToSource",
-    "duration": 13242.275161000027
+    "duration": 12817.04882299999
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8272CL-CPU-2-60GHz/eda.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8272CL-CPU-2-60GHz/eda.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 222.67407499998808
+    "duration": 226.34448500000872
   },
   {
     "name": "sourceToMdapi",
-    "duration": 6166.7441540000145
+    "duration": 4705.3344459999935
   },
   {
     "name": "sourceToZip",
-    "duration": 4826.558009000029
+    "duration": 4886.161657999997
   },
   {
     "name": "mdapiToSource",
-    "duration": 4281.85755700001
+    "duration": 4058.82406600003
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8272CL-CPU-2-60GHz/lotsOfClasses.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8272CL-CPU-2-60GHz/lotsOfClasses.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 442.19902300002286
+    "duration": 447.82590599998366
   },
   {
     "name": "sourceToMdapi",
-    "duration": 8834.219169000047
+    "duration": 8922.643469000002
   },
   {
     "name": "sourceToZip",
-    "duration": 7419.940933000005
+    "duration": 6673.310636000009
   },
   {
     "name": "mdapiToSource",
-    "duration": 5108.842208000016
+    "duration": 4866.022824999993
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8272CL-CPU-2-60GHz/lotsOfClassesOneDir.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8272CL-CPU-2-60GHz/lotsOfClassesOneDir.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 780.378497000027
+    "duration": 774.8018560000346
   },
   {
     "name": "sourceToMdapi",
-    "duration": 12146.644433000009
+    "duration": 12633.609111000027
   },
   {
     "name": "sourceToZip",
-    "duration": 10558.852648
+    "duration": 10770.84330399998
   },
   {
     "name": "mdapiToSource",
-    "duration": 9052.254910999967
+    "duration": 8976.685232000018
   }
-]
+]
diff --git a/test/resolve/adapters/mixedContentSourceAdapter.test.ts b/test/resolve/adapters/mixedContentSourceAdapter.test.ts
@@ -15,7 +15,7 @@ import {
   MIXED_CONTENT_DIRECTORY_CONTENT_PATH,
   MIXED_CONTENT_DIRECTORY_VIRTUAL_FS_NO_XML,
 } from '../../mock/type-constants/staticresourceConstant';
-import { mixedContentDirectory, mixedContentSingleFile } from '../../mock';
+import { mixedContentDirectory, mixedContentSingleFile, experiencePropertyTypeContentSingleFile } from '../../mock';
 
 const messages = Messages.load('@salesforce/source-deploy-retrieve', 'sdr', ['error_expected_source_files']);
 
@@ -77,6 +77,28 @@ describe('MixedContentSourceAdapter', () => {
     });
   });
 
+  describe('Experience Property Type File Content', () => {
+    const component = experiencePropertyTypeContentSingleFile.COMPONENT;
+    const adapter = new MixedContentSourceAdapter(
+      registry.types.experiencepropertytypebundle,
+      registryAccess,
+      undefined,
+      component.tree
+    );
+
+    it('Should return expected SourceComponent when given a schema.json path', () => {
+      const result = adapter.getComponent(component.xml);
+
+      expect(result).to.deep.equal(component);
+    });
+
+    it('Should return expected SourceComponent when given a source path', () => {
+      const result = adapter.getComponent(component.content);
+
+      expect(result).to.deep.equal(component);
+    });
+  });
+
   describe('Directory Content', () => {
     const {
       MIXED_CONTENT_DIRECTORY_COMPONENT,

Original file line number	Diff line number	Diff line change
`@@ -3388,6 +3388,7 @@`
`3388`	`3388`	`"inFolder": false,`
`3389`	`3389`	`"strictDirectoryName": true,`
`3390`	`3390`	`"supportsPartialDelete": true,`
	`3391`	`+ "metaFileSuffix": "schema.json",`
`3391`	`3392`	`"strategies": {`
`3392`	`3393`	`"adapter": "bundle"`
`3393`	`3394`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 345.28876100000343`
	`4`	`+ "duration": 360.789472000004`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 8330.387101`
	`8`	`+ "duration": 8919.91247500002`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 5822.162848000007`
	`12`	`+ "duration": 6025.233091000002`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 6123.899523999979`
	`16`	`+ "duration": 6253.451692000002`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 675.3449159999727`
	`4`	`+ "duration": 744.0605729999952`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 11995.010080000007`
	`8`	`+ "duration": 13127.422728999984`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 9518.928809000005`
	`12`	`+ "duration": 10371.91620399995`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 7432.586432000011`
	`16`	`+ "duration": 7902.201856`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 1170.5348080000258`
	`4`	`+ "duration": 1188.3639100000146`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 17969.274023000035`
	`8`	`+ "duration": 18936.191220000037`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 14706.58613000001`
	`12`	`+ "duration": 15125.748401999997`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 13242.275161000027`
	`16`	`+ "duration": 12817.04882299999`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 222.67407499998808`
	`4`	`+ "duration": 226.34448500000872`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 6166.7441540000145`
	`8`	`+ "duration": 4705.3344459999935`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 4826.558009000029`
	`12`	`+ "duration": 4886.161657999997`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 4281.85755700001`
	`16`	`+ "duration": 4058.82406600003`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 442.19902300002286`
	`4`	`+ "duration": 447.82590599998366`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 8834.219169000047`
	`8`	`+ "duration": 8922.643469000002`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 7419.940933000005`
	`12`	`+ "duration": 6673.310636000009`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 5108.842208000016`
	`16`	`+ "duration": 4866.022824999993`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 780.378497000027`
	`4`	`+ "duration": 774.8018560000346`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 12146.644433000009`
	`8`	`+ "duration": 12633.609111000027`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 10558.852648`
	`12`	`+ "duration": 10770.84330399998`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 9052.254910999967`
	`16`	`+ "duration": 8976.685232000018`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`