symfony / recipes

Symfony Recipes Repository
https://github.com/symfony/recipes/blob/flex/main/RECIPES.md
MIT License
953 stars 472 forks source link

Add healthcheck on mercure service #1306

Closed maxhelias closed 3 months ago

maxhelias commented 3 months ago
Q A
License MIT
Doc issue/PR -
github-actions[bot] commented 3 months ago

Thanks for the PR 😍

How to test these changes in your application

  1. Define the SYMFONY_ENDPOINT environment variable:

    # On Unix-like (BSD, Linux and macOS)
    export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1306/index.json
    # On Windows
    SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1306/index.json
  2. Install the package(s) related to this recipe:

    composer req 'symfony/flex:^1.16'
    composer req 'symfony/mercure-bundle:^0.3'
  3. Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

    # On Unix-like (BSD, Linux and macOS)
    unset SYMFONY_ENDPOINT
    # On Windows
    SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes. I'm going keep this comment up to date with any updates of the attached patch.

symfony/mercure-bundle

0.1 vs 0.2 ```diff diff --git a/symfony/mercure-bundle/0.1/config/packages/mercure.yaml b/symfony/mercure-bundle/0.2/config/packages/mercure.yaml index d1947d1..17aaa0c 100644 --- a/symfony/mercure-bundle/0.1/config/packages/mercure.yaml +++ b/symfony/mercure-bundle/0.2/config/packages/mercure.yaml @@ -1,4 +1,5 @@ mercure: + enable_profiler: '%kernel.debug%' hubs: default: url: '%env(MERCURE_PUBLISH_URL)%' ```
0.2 vs 0.3 ```diff diff --git a/symfony/mercure-bundle/0.2/config/packages/mercure.yaml b/symfony/mercure-bundle/0.3/config/packages/mercure.yaml index 17aaa0c..f2a7395 100644 --- a/symfony/mercure-bundle/0.2/config/packages/mercure.yaml +++ b/symfony/mercure-bundle/0.3/config/packages/mercure.yaml @@ -1,6 +1,8 @@ mercure: - enable_profiler: '%kernel.debug%' hubs: default: - url: '%env(MERCURE_PUBLISH_URL)%' - jwt: '%env(MERCURE_JWT_TOKEN)%' + url: '%env(MERCURE_URL)%' + public_url: '%env(MERCURE_PUBLIC_URL)%' + jwt: + secret: '%env(MERCURE_JWT_SECRET)%' + publish: '*' diff --git a/symfony/mercure-bundle/0.2/manifest.json b/symfony/mercure-bundle/0.3/manifest.json index ba8f74d..5637bef 100644 --- a/symfony/mercure-bundle/0.2/manifest.json +++ b/symfony/mercure-bundle/0.3/manifest.json @@ -7,9 +7,47 @@ }, "env": { "#1": "See https://symfony.com/doc/current/mercure.html#configuration", - "MERCURE_PUBLISH_URL": "http://mercure/.well-known/mercure", - "#2": "The default token is signed with the secret key: !ChangeMe!", - "MERCURE_JWT_TOKEN": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjdXJlIjp7InB1Ymxpc2giOltdfX0.Oo0yg7y4yMa1vr_bziltxuTCqb8JVHKxp-f_FwwOim0" + "#2": "The URL of the Mercure hub, used by the app to publish updates (can be a local URL)", + "MERCURE_URL": "https://example.com/.well-known/mercure", + "#3": "The public URL of the Mercure hub, used by the browser to connect", + "MERCURE_PUBLIC_URL": "https://example.com/.well-known/mercure", + "#4": "The secret used to sign the JWTs", + "MERCURE_JWT_SECRET": "!ChangeThisMercureHubJWTSecretKey!" + }, + "docker-compose": { + "docker-compose.yml": { + "services": [ + "mercure:", + " image: dunglas/mercure", + " restart: unless-stopped", + " environment:", + " # Uncomment the following line to disable HTTPS,", + " #SERVER_NAME: ':80'", + " MERCURE_PUBLISHER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'", + " MERCURE_SUBSCRIBER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'", + " # Set the URL of your Symfony project (without trailing slash!) as value of the cors_origins directive", + " MERCURE_EXTRA_DIRECTIVES: |", + " cors_origins http://127.0.0.1:8000", + " # Comment the following line to disable the development mode", + " command: /usr/bin/caddy run --config /etc/caddy/Caddyfile.dev", + " healthcheck:", + " test: [\"CMD\", \"curl\", \"-f\", \"https://localhost/healthz\"]", + " timeout: 5s", + " retries: 5", + " start_period: 60s", + " volumes:", + " - mercure_data:/data", + " - mercure_config:/config" + ], + "volumes": ["mercure_data:", "mercure_config:"] + }, + "docker-compose.override.yml": { + "services": [ + "mercure:", + " ports:", + " - \"80\"" + ] + } }, "aliases": ["mercure"] } ```
maxhelias commented 3 months ago

friendly ping @dunglas