auth0/auth0-deploy-cli

Custom Domains not ordered to run after Branding

connor-smith-ag opened this issue · 2 comments

Checklist

  • I have looked into the README and have not found a suitable solution or answer.
  • I have looked into the documentation and have not found a suitable solution or answer.
  • I have searched the issues and have not found a suitable solution or answer.
  • I have upgraded to the latest version of this tool and the issue still persists.
  • I have searched the Auth0 Community forums and have not found a suitable solution or answer.
  • I agree to the terms within the Auth0 Code of Conduct.

Description

When importing tenant.yaml with both customDomains and branding present in a fresh tenant, the following error is thrown

2023-04-29T08:06:26.358Z - error: Problem running command import during stage processChanges when processing type branding
2023-04-29T08:06:26.359Z - error: This feature requires at least one custom domain to be configured for the tenant.

Expectation

If both customDomains and branding present, I expect customDomains to be processed first, before branding.

Reproduction

tenant.yaml

customDomains:
  - domain: ##CUSTOM_DOMAIN_ADDRESS##
    primary: true
    status: ready
    tls_policy: recommended
    type: auth0_managed_certs
    verification:
      methods:
        - name: cname
          record: ##CUSTOM_DOMAIN_ADDRESS_CNAME_RECORD##
branding:
  colors:
    page_background: '#000000'
    primary: '#635dff'
  font:
    url: https://use.typekit.net/ugr5xyz.css
  logo_url: ''
  templates:
    - template: universal_login
      body: .\branding_templates\universal_login.html
...

error:

2023-04-29T08:13:52.691Z - error: Problem running command import during stage processChanges when processing type branding
2023-04-29T08:13:52.691Z - error: This feature requires at least one custom domain to be configured for the tenant.
2023-04-29T08:13:52.692Z - debug: Bad Request: This feature requires at least one custom domain to be configured for the tenant.

Deploy CLI version

7.17.2

Node version

18.14.2

@connor-smith-ag Thanks for surfacing this request. It is reasonable to expect the custom domains to process before the branding. Controlling the order here is a fairly straightforward code change, but I'll need to look into wether or not the branding settings will immediately recognize the custom domain.

In the meantime, if this is blocking you, you can leverage the AUTH0_INCLUDED_ONLY configuration (docs) to include only custom domains within the tool's purview, import once, then all normal imports thereafter should work.

We've reordered the handlers such that custom domains gets processed before branding settings. Released with 7.17.7. This should fix OP's issue. However, as noted above, there may be delays in which the custom domain configuration being registered in the backend. I would appreciate you test this out and if problem still persists, we can re-evaluate. However I'm going to close in the meantime. Thanks for opening this ticket!