Sm/registry-completeness-bug (#582)

* fix: registry completeness test bug (use internal coverage report)

* feat: new metadata types

* feat: found more types

* chore: update for contention on `.policy` suffix

* chore: adding types for SDR

* style: comment about apiVersion vs. coverage url

* chore: adding types for SDR

* fix: better env error for slack notifications

* refactor: env check at the end

Author: mshanemc

METADATA_SUPPORT.md

@@ -4,7 +4,7 @@ This list compares metadata types found in Salesforce v54 with the [metadata reg
 
 This repository is used by both the Salesforce CLIs and Salesforce's VSCode Extensions.
 
-Currently, there are 421/465 supported metadata types.
+Currently, there are 442/465 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)
 
@@ -22,11 +22,11 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |ActionLinkGroupTemplate|✅||
 |ActionPlanTemplate|✅||
 |ActionsSettings|✅||
-|ActivationPlatform|❌|Not supported, but support could be added|
+|ActivationPlatform|✅||
 |ActivitiesSettings|✅||
 |AddressSettings|✅||
 |AdvAccountForecastSet|✅||
-|AdvAcctForecastDimSource|❌|Not supported, but support could be added|
+|AdvAcctForecastDimSource|✅||
 |AdvAcctForecastPeriodGroup|✅||
 |AnalyticSnapshot|✅||
 |AnalyticsDataServicesSettings|✅||
@@ -43,8 +43,8 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |AppExperienceSettings|✅||
 |AppMenu|✅||
 |ApplicationRecordTypeConfig|✅||
-|ApplicationSubtypeDefinition|❌|Not supported, but support could be added|
-|AppointmentAssignmentPolicy|❌|Not supported, but support could be added|
+|ApplicationSubtypeDefinition|✅||
+|AppointmentAssignmentPolicy|✅||
 |AppointmentSchedulingPolicy|✅||
 |ApprovalProcess|✅||
 |ArchiveSettings|✅||
@@ -76,7 +76,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |BusinessHoursSettings|✅||
 |BusinessProcess|✅||
 |BusinessProcessGroup|✅||
-|BusinessProcessTypeDefinition|❌|Not supported, but support could be added|
+|BusinessProcessTypeDefinition|✅||
 |CMSConnectSource|✅||
 |CallCenter|✅||
 |CallCenterRoutingMap|✅||
@@ -85,7 +85,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |CampaignSettings|✅||
 |CanvasMetadata|✅||
 |CareBenefitVerifySettings|✅||
-|CareLimitType|❌|Not supported, but support could be added|
+|CareLimitType|✅||
 |CareProviderSearchConfig|✅||
 |CareRequestConfiguration|✅||
 |CareSystemFieldMapping|✅||
@@ -139,7 +139,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |Dashboard|✅||
 |DashboardFolder|✅||
 |DataCategoryGroup|✅||
-|DataConnectorIngestApi|❌|Not supported, but support could be added|
+|DataConnectorIngestApi|✅||
 |DataConnectorS3|✅||
 |DataDotComSettings|✅||
 |DataMapping|✅||
@@ -148,7 +148,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |DataMappingSchema|✅||
 |DataSource|✅||
 |DataSourceObject|✅||
-|DataSourceTenant|❌|Not supported, but support could be added|
+|DataSourceTenant|✅||
 |DataStreamDefinition|✅||
 |DecisionTable|✅||
 |DecisionTableDatasetLink|✅||
@@ -166,8 +166,8 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |DocumentType|✅||
 |DuplicateRule|✅||
 |EACSettings|✅||
-|ESignatureConfig|❌|Not supported, but support could be added|
-|ESignatureEnvelopeConfig|❌|Not supported, but support could be added|
+|ESignatureConfig|✅||
+|ESignatureEnvelopeConfig|✅||
 |EclairGeoData|✅||
 |EinsteinAgentSettings|✅||
 |EinsteinAssistantSettings|✅||
@@ -198,8 +198,8 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |EventSettings|✅||
 |ExperienceBundle|✅||
 |ExperienceBundleSettings|✅||
-|ExplainabilityActionDefinition|❌|Not supported, but support could be added|
-|ExplainabilityActionVersion|❌|Not supported, but support could be added|
+|ExplainabilityActionDefinition|✅||
+|ExplainabilityActionVersion|✅||
 |ExternalAIModel|❌|Not supported, but support could be added|
 |ExternalCredential|❌|Not supported, but support could be added|
 |ExternalDataConnector|✅||
@@ -253,7 +253,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |IndustriesSettings|✅||
 |InstalledPackage|⚠️|Supports deploy/retrieve but not source tracking|
 |InterestTaggingSettings|✅||
-|InternalDataConnector|❌|Not supported, but support could be added|
+|InternalDataConnector|✅||
 |InventorySettings|✅||
 |InvocableActionSettings|✅||
 |IoTSettings|✅||
@@ -295,11 +295,11 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |MktCalcInsightObjectDef|✅||
 |MktDataTranObject|✅||
 |MlDomain|✅||
-|MobSecurityCertPinConfig|❌|Not supported, but support could be added|
+|MobSecurityCertPinConfig|✅||
 |MobileApplicationDetail|✅||
-|MobileSecurityAssignment|❌|Not supported, but support could be added|
-|MobileSecurityPolicy|❌|Not supported, but support could be added|
-|MobileSecurityPolicySet|❌|Not supported, but support could be added|
+|MobileSecurityAssignment|✅||
+|MobileSecurityPolicy|✅||
+|MobileSecurityPolicySet|✅||
 |MobileSettings|✅||
 |ModerationRule|✅||
 |MutingPermissionSet|✅||
@@ -321,7 +321,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |OmniChannelSettings|✅||
 |OmniDataTransform|✅||
 |OmniIntegrationProcedure|✅||
-|OmniInteractionAccessConfig|❌|Not supported, but support could be added|
+|OmniInteractionAccessConfig|✅||
 |OmniInteractionConfig|✅||
 |OmniScript|✅||
 |OmniUiCard|✅||
@@ -356,7 +356,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |PresenceDeclineReason|✅||
 |PresenceUserConfig|✅||
 |PrivacySettings|✅||
-|ProductAttributeSet|❌|Not supported, but support could be added|
+|ProductAttributeSet|✅||
 |ProductSettings|✅||
 |Profile|✅||
 |ProfilePasswordPolicy|✅||
@@ -371,8 +371,8 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |RecommendationBuilderSettings|✅||
 |RecommendationStrategy|✅||
 |RecordActionDeployment|✅||
-|RecordAlertCategory|❌|Not supported, but support could be added|
-|RecordAlertDataSource|❌|Not supported, but support could be added|
+|RecordAlertCategory|✅||
+|RecordAlertDataSource|✅||
 |RecordPageSettings|✅||
 |RecordType|✅||
 |RedirectWhitelistUrl|✅||
@@ -483,15 +483,19 @@ v55 introduces the following new types.  Here's their current level of support
 
 |Metadata Type|Support|Notes|
 |:---|:---|:---|
+|AssessmentQuestion|❌|Not supported, but support could be added|
 |BotTemplate|❌|Not supported, but support could be added|
+|ConvReasonReportSegment|❌|Not supported, but support could be added|
 |Experience|undefined|undefined|
+|ExperienceMetadataResource|undefined|undefined|
+|ExperienceSpace|undefined|undefined|
 |ExternalDataSrcDescriptor|❌|Not supported, but support could be added|
 |ExternalDataTranField|❌|Not supported, but support could be added|
 |ExternalDataTranObject|❌|Not supported, but support could be added|
 |FavoriteTransferDestination|❌|Not supported, but support could be added|
 |IndustriesAutomotiveSettings|✅||
-|IndustriesMfgServiceSettings|✅||
 |InvLatePymntRiskCalcSettings|✅||
+|MarketingAppExtAction|❌|Not supported, but support could be added|
 |PaymentsManagementEnabledSettings|✅||
 |RegisteredExternalService|❌|Not supported, but support could be added|
 |StreamingAppDataConnector|❌|Not supported, but support could be added|
@@ -516,6 +520,7 @@ v55 introduces the following new types.  Here's their current level of support
 - FormSection
 - Portal
 - EmbeddedServiceFieldService
+- FlowTest
 - EventType
 - EventSubscription
 - EventDelivery

contributing/metadata.md

@@ -15,6 +15,8 @@ To simplify modifying the registry, there's a script.
 
 > Note: The script depends on being able to create an org that will have your type. If you have a working org, but your type isn't compatible with scratch org, you can [use an existing org](#use-an-existing-org)
 
+> Note: The script will use your default dev hub. If you don't have one, set one up. If you want to use a different hub, update your default.
+
 The script will:
 
 1. Look for missing types (similar to the completeness test)

package.json

@@ -98,7 +98,7 @@
     "pretest": "sf-compile-test",
     "repl": "node --inspect ./scripts/repl.js",
     "test": "sf-test",
-    "test:registry": "nyc mocha ./test/registry/registryCompleteness.test.ts",
+    "test:registry": "mocha ./test/registry/registryCompleteness.test.ts",
     "update-registry": "npx ts-node scripts/update-registry/update2.ts",
     "update-supported-metadata": "npx ts-node scripts/update-registry/update-supported-metadata.ts"
   },

scripts/update-registry/preview.ts

@@ -1,11 +1,11 @@
 import got from 'got';
 import { getMissingTypes } from '../../test/utils/getMissingTypes';
 import { registry } from '../../src';
-import {getCurrentApiVersion, getCoverage} from './shared'
+import { getCurrentApiVersion, getCoverage } from '../../src/registry/coverage';
 
 (async () => {
   const currentApiVersion = await getCurrentApiVersion();
-  const nextCoverage = await getCoverage(currentApiVersion + 1)
+  const nextCoverage = await getCoverage(currentApiVersion + 1);
 
   const missingTypes = getMissingTypes(nextCoverage, registry).map((type) => type[0]);
 
@@ -44,6 +44,9 @@ import {getCurrentApiVersion, getCoverage} from './shared'
       },
     ],
   };
+  if (!process.env.DEFAULT_SLACK_WEBHOOK) {
+    throw new Error('DEFAULT_SLACK_WEBHOOK is not set in the environment');
+  }
   try {
     await got.post(process.env.DEFAULT_SLACK_WEBHOOK, {
       json,

scripts/update-registry/shared.ts

@@ -1,5 +1,5 @@
 import { CoverageObject } from '../../src/registry/types';
-import { getCurrentApiVersion, getCoverage } from './shared';
+import { getCurrentApiVersion, getCoverage } from '../../src/registry/coverage';
 import { registry as untypedRegistry } from '../../src';
 import { MetadataRegistry } from '../../src';
 import * as shell from 'shelljs';

scripts/update-registry/update-supported-metadata.ts

@@ -7,7 +7,7 @@ import * as deepmerge from 'deepmerge';
 import { CoverageObject, CoverageObjectType } from '../../src/registry/types';
 import { AnyJson } from '@salesforce/ts-types';
 import { getMissingTypes } from '../../test/utils/getMissingTypes';
-import { getCurrentApiVersion, getCoverage } from './shared';
+import { getCurrentApiVersion, getCoverage } from '../../src/registry/coverage';
 
 export const registry = fs.readJsonSync('./src/registry/metadataRegistry.json') as unknown as MetadataRegistry;
 export let metadataCoverage: CoverageObject;

scripts/update-registry/update2.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 got from 'got';
+import { CoverageObject } from '../../src/registry/types';
+
+export const getCurrentApiVersion = async (): Promise<number> => {
+  return (
+    JSON.parse((await got('https://mdcoverage.secure.force.com/services/apexrest/report')).body) as {
+      versions: { selected: number };
+    }
+  ).versions.selected;
+};
+
+export const getCoverage = async (apiVersion: number): Promise<CoverageObject> =>
+  JSON.parse(
+    // this is a constant offset between each apiVersion and the url.
+    // ex: v55=na46, v54=na45, etc.
+    (await got(`https://na${apiVersion - 9}.test1.pc-rnd.salesforce.com/mdcoverage/api.jsp`)).body
+  ) as CoverageObject;