Improve actual support for PLATFORM_ROUTES

[gilzow]

List of php-based templates that in some way use/depend on PLATFORM_ROUTES

• wordpress-bedrock
• wordpress-vanilla
• wordpress-woocommerce
• drupal8-multisite (both directly and via psh config reader - 1, 2)
• drupal9-multisite (both directly and via psh config reader - 1, 2)
• magento2ce
• nextcloud
• laravel (via laravel-bridge, via psh config reader)
• typo3 (via psh config reader)
• wordpress-composer (via psh config reader)
• drupa8-govcms8 (via psh config reader - 1, 2)
• drupa9-govcms9 (via psh config reader)
• drupal8-opigno (via psh config reader)
• drupal8 (via psh config reader)
• drupal9 (via psh config reader)
• pimcore (via psh config reader)

[rfay]

Thanks so much!

[lolautruche]

Here is the documentation page about routes: https://docs.platform.sh/define-routes.html
However, it doesn't explain the properties in the JSON object (most notably the original_url property).

[gilzow]

just ran into an issue trying to use nextcloud which uses PLATFORM_ROUTES in its config.

Currently in ddev, $platform_sh_url is set to ${DDEV_PRIMARY_URL} which means the explode at line 6 produces only one key, so the attempt to grab key 1 results in passing null to rtrim, and then everything just falls apart after that.

[rfay]

@gilzow if from a template, can you link to the template please? (Oh, I see from link that it is from template)

[lolautruche]

It's this one: https://github.com/platformsh-templates/nextcloud

Use of $PLATFORM_ROUTES is here.

[gilzow]

BTW, we're in the process of updating this template, hence why I'm working with it in DDEV.

For now I'm rebuilding the PLATFORM_ROUTES info with the DDEV reported URL hardcoded in .ddev/config.platformsh.yaml but we can't really ask developers to do that.

DDEV has calculated and stored the generated URL in .ddev/.ddev-docker-compose-full.yaml. Is it possible to have the actual URL used when creating PLATFORM_ROUTES vs using the ${DDEV_PRIMARY_URL} variable?

[rfay]

Yes, it should use the actual URL. The question will be when there are many URLs of course.

[lolautruche]

@gilzow Can you please share what you're expecting to get (and that you set in .ddev/config.platformsh.yaml), vs what you're getting?

Thanks

[gilzow]

what i'm getting is

{
  "${DDEV_PRIMARY_URL}": {
    "primary": true,
    "id": null,
    "production_url": "${DDEV_PRIMARY_URL}",
    "attributes": {},
    "upstream": "drupal",
    "type": "upstream",
    "original_url": "https://{default}/"
  }
}

What I'm expecting is:

{
  "https://nexcloud-upgrade-test.ddev.site/": {
    "primary": true,
    "id": null,
    "production_url": "https://nexcloud-upgrade-test.ddev.site/",
    "attributes": {},
    "upstream": "drupal",
    "type": "upstream",
    "original_url": "https://{default}/"
  }
}

!!! IMPORTANT SIDE NOTE !!!

please notice the inclusion of the trailing end slash (/) in both the route key and the production_url property. According to our docs, all generated routes now have a trailing slash. I mention this because the current value of ${DDEV_PRIMARY_URL} does not contain the trailing slash.

What i set in .ddev/config.platformsh.yaml is the base64 encoded version of the above:

"- PLATFORM_ROUTES=eyJodHRwczovL25leGNsb3VkLXVwZ3JhZGUtdGVzdC5kZGV2LnNpdGUvIjp7InByaW1hcnkiOnRydWUsImlkIjpudWxsLCJwcm9kdWN0aW9uX3VybCI6Imh0dHBzOi8vbmV4Y2xvdWQtdXBncmFkZS10ZXN0LmRkZXYuc2l0ZS8iLCJhdHRyaWJ1dGVzIjp7fSwidXBzdHJlYW0iOiJkcnVwYWwiLCJ0eXBlIjoidXBzdHJlYW0iLCJvcmlnaW5hbF91cmwiOiJodHRwczovL3tkZWZhdWx0fS8ifX0K"

[rfay]

The trailing slash probably won't make a difference here, but we'll add it anyway!

[lolautruche]

@rfay Do you know why ${DDEV_PRIMARY_URL} is not resolved?

[rfay]

Interesting, not sure the context it's being evaluated in. Looks like it's not even being processed by bash, because if it were even being evaluated, it would then be empty.

[lolautruche]

Could it be because of the HEREDOC?

  platform_routes=$(cat <<-"ENDROUTES"
  {
  "${DDEV_PRIMARY_URL}": {
    "primary": true,
    "id": null,
    "production_url": "${DDEV_PRIMARY_URL}",
    "attributes": {},
    "upstream": "drupal",
    "type": "upstream",
    "original_url": "https://{default}/"  }
  }
  ENDROUTES
  )