feat: 5 new metadata type support

mshanemc · web-flow · commit c031034cf847 · 2022-10-06T16:13:56.000-05:00
* feat: support mdType CallCtrAgentFavTrfrDest

* feat: support externalCredential

* feat: support marketSegmentDefinition

* feat: support MfgProgramTemplate

* feat: support streamingAppDataConnectors
diff --git a/METADATA_SUPPORT.md b/METADATA_SUPPORT.md
@@ -4,7 +4,7 @@ This list compares metadata types found in Salesforce v56 with the [metadata reg
 
 This repository is used by both the Salesforce CLIs and Salesforce's VSCode Extensions.
 
-Currently, there are 474/512 supported metadata types.
+Currently, there are 479/512 supported metadata types.
 For status on any existing gaps, please search or file an issue in the [Salesforce CLI issues only repo](https://github.com/forcedotcom/cli/issues).
 To contribute a new metadata type, please see the [Contributing Metadata Types to the Registry](./contributing/metadata.md)
 
@@ -89,7 +89,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |CallCenter|✅||
 |CallCenterRoutingMap|✅||
 |CallCoachingMediaProvider|⚠️|Supports deploy/retrieve but not source tracking|
-|CallCtrAgentFavTrfrDest|❌|Not supported, but support could be added|
+|CallCtrAgentFavTrfrDest|✅||
 |CampaignInfluenceModel|✅||
 |CampaignSettings|✅||
 |CanvasMetadata|✅||
@@ -223,7 +223,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |ExpressionSetDefinitionVersion|✅||
 |ExpressionSetObjectAlias|❌|Not supported, but support could be added|
 |ExternalAIModel|❌|Not supported, but support could be added|
-|ExternalCredential|❌|Not supported, but support could be added|
+|ExternalCredential|✅||
 |ExternalDataConnector|✅||
 |ExternalDataSource|✅||
 |ExternalDataSrcDescriptor|❌|Not supported, but support could be added|
@@ -315,14 +315,14 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |ManagedContentType|⚠️|Supports deploy/retrieve but not source tracking|
 |ManagedTopics|✅||
 |MapsAndLocationSettings|✅||
-|MarketSegmentDefinition|❌|Not supported, but support could be added|
+|MarketSegmentDefinition|✅||
 |MarketingAppExtActivity|❌|Not supported, but support could be added|
 |MarketingAppExtension|✅||
 |MatchingRules|✅||
 |MediaAdSalesSettings|✅||
 |MeetingsSettings|✅||
 |MessagingChannel|❌|Not supported, but support could be added (but not for tracking)|
-|MfgProgramTemplate|❌|Not supported, but support could be added|
+|MfgProgramTemplate|✅||
 |MfgServiceConsoleSettings|✅||
 |MilestoneType|✅||
 |MktCalcInsightObjectDef|✅||
@@ -459,7 +459,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |StandardValueSetTranslation|✅||
 |StaticResource|✅||
 |StnryAssetEnvSrcCnfg|✅||
-|StreamingAppDataConnector|❌|Not supported, but support could be added|
+|StreamingAppDataConnector|✅||
 |SubscriptionManagementSettings|✅||
 |SurveySettings|✅||
 |SustainabilityUom|❌|Not supported, but support could be added|
diff --git a/contributing/metadata.md b/contributing/metadata.md
@@ -112,38 +112,51 @@ SDR includes 2 registry-related tests to check your changes to the metdataRegist
 
 ## Validate the registry is correct
 
+`yarn mocha test/registry/registryValidation.test.ts`
+
 Test failures here could be types that exist in the `types` section but don't have entries in `suffixes` or `strictDirectoryNames`.
 It also checks that suffixes are unique OR only one type that shares a suffix isn't `strictDirectoryName`.
 
 ## Validate the registry is complete
 
+`yarn test:registry`
+
 The library uses the [registry file](../src/registry/metadataRegistry.json) to resolve how to process metadata types. This needs to be updated as new metadata types are added to the platform at major releases.
 
 The completeness is checked by comparing the registry to the metadata coverage report, but excluding
 
 1. Types that aren't supported in the metadata API
 2. Types in the [nonSupportedTypes file](../src/registry/nonSupportedTypes.ts) (think of it as a registry-ignore file). You can ignore the types themselves, or the feature/settings they depend on. Be sure to explain why you're choosing to ignore that type.
 
+If you find your types (or the features they require) excluded by `nonSupportedTypes.ts` but think they're ready to go, feel free to remove them from the list.
+
+There are 2 main ways this happens (or ways to make this work if it currently isn't)
+
+1. A feature is available to scratch orgs when it previously wasn't
+1. The metadata coverage report's "settings" were not sufficient to enable your type to appear in the `describe` call.
+
+Fixing those problems not only makes it easier to automate your type's support in the library, but also makes your type usable by customers (features) and fixes your documentation (coverageReport).
+
 ## Manual Testing
 
 Want to make sure your types are working as expected?
 
 1. Create a new project with `sfdx force:project:create -n registryTest`
 1. Create a scratch org `sfdx force:org:create`
 1. Open the org and create your types.
-1. Run `sfdx force:source:beta:status` and verify the remote add.
-1. Run `sfdx force:source:beta:pull` to pull the metadata and examine what is retrieved
-1. Run `sfdx force:source:beta:status` and verify the changes were retrieved and no longer appear.
+1. Run `sfdx force:source:status` and verify the remote add.
+1. Run `sfdx force:source:pull` to pull the metadata and examine what is retrieved
+1. Run `sfdx force:source:status` and verify the changes were retrieved and no longer appear.
 1. Delete the org `sfdx force:org:delete --noprompt`
 1. Create a new scratch org. `sfdx force:org:create`
-1. Push the source `sfdx force:source:beta:push`
+1. Push the source `sfdx force:source:push`
 1. Convert the source to mdapi format `sfdx force:source:convert -d mdapiOut`
 1. Look in the resulting `metadataPackage_` and `package.xml` to see that it looks as expected
 1. Deploy it to the org using `sfdx force:mdapi:deploy --deploydir mdapiOut --wait 30` and verify that it succeeds
 1. Delete the source directory `rm -rf force-app/main/default/*`
 1. Create a new scratch org and convert the source back
 1. Convert back from mdapi to source format `sfdx force:mdapi:convert -r mdapiOut -d force-app`
-1. `sfdx force:source:beta:push`
+1. `sfdx force:source:push`
 
 ### Caveats
 
diff --git a/src/registry/metadataRegistry.json b/src/registry/metadataRegistry.json
@@ -230,6 +230,14 @@
       "inFolder": false,
       "strictDirectoryName": false
     },
+    "externalcredential": {
+      "id": "externalcredential",
+      "name": "ExternalCredential",
+      "suffix": "externalCredential",
+      "directoryName": "externalCredentials",
+      "inFolder": false,
+      "strictDirectoryName": false
+    },
     "namedcredential": {
       "id": "namedcredential",
       "name": "NamedCredential",
@@ -3112,6 +3120,38 @@
       "directoryName": "relationshipGraphDefinitions",
       "inFolder": false,
       "strictDirectoryName": false
+    },
+    "callctragentfavtrfrdest": {
+      "id": "callctragentfavtrfrdest",
+      "name": "CallCtrAgentFavTrfrDest",
+      "suffix": "callCtrAgentFavTrfrDest",
+      "directoryName": "callCtrAgentFavTrfrDests",
+      "inFolder": false,
+      "strictDirectoryName": false
+    },
+    "marketsegmentdefinition": {
+      "id": "marketsegmentdefinition",
+      "name": "MarketSegmentDefinition",
+      "suffix": "marketSegmentDefinition",
+      "directoryName": "marketSegmentDefinitions",
+      "inFolder": false,
+      "strictDirectoryName": false
+    },
+    "mfgprogramtemplate": {
+      "id": "mfgprogramtemplate",
+      "name": "MfgProgramTemplate",
+      "suffix": "mfgProgramTemplate",
+      "directoryName": "MfgProgramTemplate",
+      "inFolder": false,
+      "strictDirectoryName": false
+    },
+    "streamingappdataconnector": {
+      "id": "streamingappdataconnector",
+      "name": "StreamingAppDataConnector",
+      "suffix": "streamingAppDataConnector",
+      "directoryName": "streamingAppDataConnectors",
+      "inFolder": false,
+      "strictDirectoryName": false
     }
   },
   "suffixes": {
@@ -3455,7 +3495,12 @@
     "forecastingFilter": "forecastingfilter",
     "forecastingFilterCondition": "forecastingfiltercondition",
     "schedulingObjective": "schedulingobjective",
-    "relationshipGraphDefinition": "relationshipgraphdefinition"
+    "relationshipGraphDefinition": "relationshipgraphdefinition",
+    "callCtrAgentFavTrfrDest": "callctragentfavtrfrdest",
+    "externalCredential": "externalcredential",
+    "marketSegmentDefinition": "marketsegmentdefinition",
+    "mfgProgramTemplate": "mfgprogramtemplate",
+    "streamingAppDataConnector": "streamingappdataconnector"
   },
   "strictDirectoryNames": {
     "experiences": "experiencebundle",
diff --git a/src/registry/nonSupportedTypes.ts b/src/registry/nonSupportedTypes.ts
@@ -16,18 +16,27 @@ import { CoverageObjectType } from './types';
 export const features = [
   // ERROR running force:org:create: * is not a valid Features value.
   'SERVICECATALOG',
-  'DYNAMICATTRIBUTES', // is not a valid Features value
+  'DYNAMICATTRIBUTES',
   'CONTRACTMGMT',
   'CUSTOMIZABLENAMEDCREDENTIALS',
   'INDUSTRIESMFGPROGRAMPILOT',
-  'HEALTHCLOUDHPIBETA', // is not a valid Features value
-  'MANAGETIMELINE', // is not a valid Features value
-  'HEALTHCLOUDBETA', // is not a valid Features value
-  'PARDOTADVANCED', // org:create throws a C-9999 when this is not excluded
+  'HEALTHCLOUDHPIBETA',
+  'MANAGETIMELINE',
+  'HEALTHCLOUDBETA',
   'EMBEDDEDSERVICEMESSAGING',
   'UNIFIEDHEALTHSCORING',
   'HEALTHCLOUDADDON',
   'EINSTEINDOCREADER',
+  'ACCOUNTINGSUBLEDGERACCESS',
+  'BOTBLOCKS',
+  'INSURANCECALCULATIONUSER',
+  'SCFUELTYPEPILOTFEATURE',
+  'B2CEREPRICINGKILLSWITCH',
+  'USERACCESSPOLICIESFORPILOTVISIBILITY',
+  'BOTBLOCKS',
+  'INDUSTRIESINTERACTIONCALCULATION',
+
+  'PARDOTADVANCED', // org:create throws a C-9999 when this is not excluded
 ];
 
 export const settings = [
@@ -40,12 +49,32 @@ export const metadataTypes = [
   'CustomValue',
   'StandardValue',
 
-  // the following are not describable based on their features/settings, last checked 2/24/2022
+  // the following are not describable based on their features/settings, see git blame for last time checked
   'DiscoveryStory',
   'EmployeeDataSyncProfile',
   'RelatedRecordAssocCriteria',
   'ScoreRange',
   'WorkflowFlowAction',
+
+  // org spins up fine, but describe is empty
+  'SustainabilityUom',
+
+  // the metadata coverage report seems to be missing a setting:
+  // A scratch org was created with username test-o87upqyaagax@example.com, but the settings failed to deploy due to: enableInsights
+  'ReferencedDashboard',
+
+  // spins up fine with feature B2CLOYALTYMANAGEMENT, not in describe
+  'ExpressionSetObjectAlias',
+
+  // requires no features, but not in describe
+  'ExternalDataSrcDescriptor',
+
+  // spun up with COMMONPRM, not in describe
+  'PortalDelegablePermissionSet',
+
+  // spun up with CUSTOMERDATAPLATFORM, not in describe
+  'ExternalDataTranField',
+  'ExternalDataTranObject',
 ];
 
 export const hasUnsupportedFeatures = (type: CoverageObjectType): boolean => {
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8171M-CPU-2-60GHz/eda.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8171M-CPU-2-60GHz/eda.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 256.6205029999837
+    "duration": 268.2671149999951
   },
   {
     "name": "sourceToMdapi",
-    "duration": 6281.598116000008
+    "duration": 6581.860289999982
   },
   {
     "name": "sourceToZip",
-    "duration": 5210.025618000014
+    "duration": 5667.704193000041
   },
   {
     "name": "mdapiToSource",
-    "duration": 7380.320351000002
+    "duration": 4731.902755000046
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8171M-CPU-2-60GHz/lotsOfClasses.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8171M-CPU-2-60GHz/lotsOfClasses.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 555.0700359999901
+    "duration": 471.61595299997134
   },
   {
     "name": "sourceToMdapi",
-    "duration": 9189.296593000006
+    "duration": 10091.462709999993
   },
   {
     "name": "sourceToZip",
-    "duration": 8017.621611999988
+    "duration": 8327.474572999985
   },
   {
     "name": "mdapiToSource",
-    "duration": 8382.281303000054
+    "duration": 6303.373427000013
   }
-]
+]
diff --git a/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8171M-CPU-2-60GHz/lotsOfClassesOneDir.json b/test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8171M-CPU-2-60GHz/lotsOfClassesOneDir.json
@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 897.3483720000368
+    "duration": 880.1470350000309
   },
   {
     "name": "sourceToMdapi",
-    "duration": 13820.782493999985
+    "duration": 14939.465063999989
   },
   {
     "name": "sourceToZip",
-    "duration": 12306.787045000005
+    "duration": 12281.212286000024
   },
   {
     "name": "mdapiToSource",
-    "duration": 16714.913545999967
+    "duration": 14331.859538000019
   }
-]
+]

Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "componentSetCreate",`
`4`		`- "duration": 256.6205029999837`
	`4`	`+ "duration": 268.2671149999951`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 6281.598116000008`
	`8`	`+ "duration": 6581.860289999982`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 5210.025618000014`
	`12`	`+ "duration": 5667.704193000041`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 7380.320351000002`
	`16`	`+ "duration": 4731.902755000046`
`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": 555.0700359999901`
	`4`	`+ "duration": 471.61595299997134`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 9189.296593000006`
	`8`	`+ "duration": 10091.462709999993`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 8017.621611999988`
	`12`	`+ "duration": 8327.474572999985`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 8382.281303000054`
	`16`	`+ "duration": 6303.373427000013`
`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": 897.3483720000368`
	`4`	`+ "duration": 880.1470350000309`
`5`	`5`	`},`
`6`	`6`	`{`
`7`	`7`	`"name": "sourceToMdapi",`
`8`		`- "duration": 13820.782493999985`
	`8`	`+ "duration": 14939.465063999989`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"name": "sourceToZip",`
`12`		`- "duration": 12306.787045000005`
	`12`	`+ "duration": 12281.212286000024`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"name": "mdapiToSource",`
`16`		`- "duration": 16714.913545999967`
	`16`	`+ "duration": 14331.859538000019`
`17`	`17`	`}`
`18`		`-]`
	`18`	`+]`