2GP Source Push Error: The consumer key is already taken

Question

I am trying to migrate metadata from a Partner Developer org to a Partner Developer scratch org for use with second-gen packaging.

I have downloaded the 1GP package, converted the metadata, and now I am doing a source push.

But one of the errors I am getting is:

Error myApp\main\default\connectedApps\MyApp.connectedApp-meta.xml The consumer key is already taken.

The simple fix to this is to remove the ConnectedApp, but before I do that, I want to confirm that my assumption was wrong about ConnnectedApp's.

I thought I was meant to ship a ConnectedApp with my managed package, so there was a common Consumer Key and Consumer Secret for that given package.

But based on this error, I am getting the impression this would not be possible.

1. As an ISV providing App's on the AppExchange, should they be shipped with a common ConnectedApp?
2. Or, should the ConnectedApp be created as part of the installation/setup process?

Answer 1

The best practice is to package up your connected app along with the other components in 2GP.

Now the way you package up the Connected App in 2GP is different, I will go down the steps here,

1. Create a 1GP Managed package in your org where you have the namespace. This package can include only the Connected App. The package needs to be Managed and Released.

2. Note down the developer name of the Connected app <connected app developer name> and the namespace namespace of your org where you have a 2GP package.

3. Create a folder named connectedApps in the source directory.

4. Create a file in the folder named connectedApps with the naming convention <connected app developer name>.connectedApp-meta.xml

5. Make sure the contents of the file as below

    <?xml version="1.0" encoding="UTF-8"?>
    <ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata">
      <developerName><namespace>__<connected app developer name></developerName>
      <label><Connected App Label></label>
     <version>1.0</version>
   </ConnectedApp>
   

6. Create package and package versions.

The above is also documented here but it is not clear so I had to hands-on dig in. I will reach the team who has it documented to make sure this is correct.

Also make sure to follow the below note carefully

When you add a connected app to a 1GP package, and upload the package, the version number of the connected app is auto incremented. For example, when version 4.0 of a connected app is added to a 1GP package, the package version increments the version number of the connected app from 4.0 to 5.0. When creating the source file for your 2GP package, specify the version number of the connected app before it was uploaded into a 1GP package, in this case, 4.0.

For Scratch Orgs

Create a 1GP package with a different namespace for testing it. Install the 1GP package in your scratch orgs to use the connected app, you can install using the below command. You need the package Id and use it in the below command.

sfdx force:package:install --package "04t...."