Merge pull request #437 from ember-nexus/feature/gh-433-add-cron

Feature/gh 433 add cron

Author: Syndesi

.github/workflows/ci-test.yml

@@ -277,7 +277,7 @@ jobs:
           docker exec --user "$(id -u):$(id -g)" ember-nexus-api-dev bash -c "php bin/console healthcheck"
       - name: Controller Example Generation Test
         run: |
-          docker exec --user "$(id -u):$(id -g)" ember-nexus-api-dev bash -c "export API_DOMAIN=\"http://ember-nexus-api\" && echo \$API_DOMAIN && composer test:example-generation-controller && composer test:example-generation-controller:deprecated"
+          docker exec --user "$(id -u):$(id -g)" ember-nexus-api-dev bash -c "export API_DOMAIN=\"http://ember-nexus-api\" && echo \$API_DOMAIN && composer test:example-generation-controller && composer test:example-generation-controller:with-different-configuration && composer test:example-generation-controller:deprecated"
 
 
   test-example-generation-command:

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- Add support for executing cron jobs in a plug-n-play ready fashion, closes #433.
+
 ### Changed
 - Get me endpoint returns status code 403 instead of 500, if anonymous user is missing. Related to #415.
 

composer.json

@@ -105,6 +105,7 @@
     "test:feature:test": "php bin/console cache:clear && ./bin/test-feature-prepare && php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/FeatureTests --group test",
     "test:feature:test-fast": "php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/FeatureTests --group test",
     "test:example-generation-controller": "php bin/console cache:clear && ./bin/test-feature-prepare && php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/ExampleGenerationController --exclude-group deprecated && php bin/console cache:clear",
+    "test:example-generation-controller:with-different-configuration": "cp -f ./config/packages/ember_nexus.yaml ./config/packages/ember_nexus_orig.yaml.dis && cp -f ./tests/ExampleGenerationControllerWithDifferentConfiguration/configuration.yml ./config/packages/ember_nexus.yaml && php bin/console cache:clear && php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/ExampleGenerationControllerWithDifferentConfiguration && mv -f ./config/packages/ember_nexus_orig.yaml.dis ./config/packages/ember_nexus.yaml && php bin/console cache:clear",
     "test:example-generation-controller:deprecated": "php bin/console cache:clear && ./bin/test-feature-prepare && php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/ExampleGenerationController --group deprecated && php bin/console cache:clear",
     "test:example-generation-controller:test-orig": "php bin/console cache:clear && ./bin/test-feature-prepare && php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/ExampleGenerationController --group test && php bin/console cache:clear",
     "test:example-generation-controller:test": "php vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.feature.xml.dist ./tests/ExampleGenerationController --group test",

config/internal-parameters.yaml

@@ -1,4 +1,6 @@
 parameters:
   _dev_version: 'dev'
+  _false: false
   version: '%env(default:_dev_version:VERSION)%'
-  anonymousUserUUID: '%env(ANONYMOUS_USER_UUID)%'
+  anonymousUserUUID: '%env(string:ANONYMOUS_USER_UUID)%'
+  isCronDisabled: '%env(bool:default:_false:DISABLE_CRON)%'

docker/Caddyfile

@@ -8,6 +8,9 @@
 		output stdout
 		format json
 	}
+	supervisor {
+		supercronic -json /etc/crontabs/supercronic
+	}
 }
 
 :80 {

docker/Dockerfile

@@ -1,3 +1,21 @@
+ARG FRANKENPHP_VERSION='1.11.1'
+ARG PHP_VERSION='8.5.1'
+
+FROM dunglas/frankenphp:${FRANKENPHP_VERSION}-builder-php${PHP_VERSION}-alpine AS frankenphp_builder
+COPY --from=caddy:2-builder-alpine /usr/bin/xcaddy /usr/bin/xcaddy
+RUN CGO_ENABLED=1 \
+    XCADDY_SETCAP=1 \
+    XCADDY_GO_BUILD_FLAGS="-tags=nobadger,nomysql,nopgx -ldflags='-w -s -extldflags \'-Wl,-z,stack-size=0x80000\''" \
+    CGO_CFLAGS=$(php-config --includes) \
+    CGO_LDFLAGS="$(php-config --ldflags) $(php-config --libs)" \
+    xcaddy build \
+        --output /usr/local/bin/frankenphp \
+        --with github.com/dunglas/frankenphp=./ \
+        --with github.com/dunglas/frankenphp/caddy=./caddy/ \
+        --with github.com/dunglas/caddy-cbrotli \
+        --with github.com/baldinof/caddy-supervisor
+
+
 FROM golang:1.25-alpine AS go_builder
 COPY ./lib/ExprCli /build
 RUN cd /build && \
@@ -6,7 +24,8 @@ RUN cd /build && \
     go build -ldflags="-s -w" -o expr-cli main.go && \
     upx --best --lzma expr-cli
 
-FROM dunglas/frankenphp:1.11.1-php8.5.1-alpine AS php
+
+FROM dunglas/frankenphp:${FRANKENPHP_VERSION}-php${PHP_VERSION}-alpine AS php
 # see also https://github.com/opencontainers/image-spec/blob/main/annotations.md
 LABEL org.opencontainers.image.vendor="Ember Nexus" \
     org.opencontainers.image.authors="Sören Klein / Syndesi <soerenklein98@gmail.com>" \
@@ -18,7 +37,10 @@ LABEL org.opencontainers.image.vendor="Ember Nexus" \
 # Background: If the en user uses the dev mode, it is epected that he knows what he does.
 ARG VERSION=dev
 ENV VERSION=${VERSION}
+ARG FRANKENPHP_VERSION
+ENV FRANKENPHP_VERSION=${FRANKENPHP_VERSION}
 
+COPY --from=frankenphp_builder /usr/local/bin/frankenphp /usr/local/bin/frankenphp
 RUN apk add --no-cache \
 		ca-certificates \
 		curl \
@@ -27,6 +49,7 @@ RUN apk add --no-cache \
 # https://github.com/docker-library/php/issues/494
 		openssl \
         pcre \
+        supercronic \
 		tar \
 		xz \
         zlib \
@@ -49,12 +72,13 @@ RUN apk add --no-cache \
 
 COPY ./docker/Caddyfile /etc/frankenphp/Caddyfile
 COPY ./docker/docker-entrypoint.sh /usr/local/bin/
+COPY ./docker/supercronic /etc/crontabs/supercronic
 COPY --from=go_builder /build/expr-cli /usr/local/bin/expr-cli
 RUN set -x \
     && chmod +x /usr/local/bin/docker-entrypoint.sh \
     && adduser -D worker \
 	&& setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/frankenphp \
-	&& chown -R worker:worker /config/caddy /data/caddy
+	&& chown -R worker:worker /config/caddy /data/caddy /etc/crontabs/supercronic
 
 STOPSIGNAL SIGTERM
 
@@ -103,6 +127,8 @@ LABEL org.opencontainers.image.vendor="Ember Nexus" \
 # Background: If the en user uses the dev mode, it is epected that he knows what he does.
 ARG VERSION=dev
 ENV VERSION=${VERSION}
+ARG FRANKENPHP_VERSION
+ENV FRANKENPHP_VERSION=${FRANKENPHP_VERSION}
 
 COPY --from=production-build / /
 

docker/supercronic

@@ -0,0 +1,10 @@
+#  + seconds
+#  |   + minutes
+#  |   |   + hours
+#  |   |   |   + day of month
+#  |   |   |   |   + month
+#  |   |   |   |   |   + day of week
+#  |   |   |   |   |   |   + year
+#  |   |   |   |   |   |   |   + command
+#  |   |   |   |   |   |   |   |
+   0   */2 *   *   *   *   *   php bin/console cron

docs/commands/assets/system-healthcheck.html

@@ -55,8 +55,8 @@
 
 ┌<span class="bold "> Check internal services </span>──────────────────────────────────────────────────────
 │ Alpine version:        3.23.2
-│ FrankenPHP version:    1.11.1
 │ Caddy version:         2.10.2
+│ FrankenPHP version:    1.11.1
 │ PHP version:           8.5.1
 └ Internal services are ok.
 

src/Command/CronCommand.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Command;
+
+use App\Style\EmberNexusStyle;
+use LogicException;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\OutputStyle;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+
+/**
+ * @psalm-suppress PropertyNotSetInConstructor $io
+ */
+#[AsCommand(name: 'cron', description: 'Executes background tasks')]
+class CronCommand extends Command
+{
+    private OutputStyle $io;
+
+    public function __construct(
+        private ParameterBagInterface $bag,
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->io = new EmberNexusStyle($input, $output);
+
+        $this->io->title('Cron');
+
+        $this->io->writeln('This command is currently a placeholder.');
+        $this->io->newLine();
+
+        $isCronDisabled = $this->bag->get('isCronDisabled');
+        if (!is_bool($isCronDisabled)) {
+            throw new LogicException(sprintf('Expected "isCronDisabled" to be of type boolean, got %s.', get_debug_type($isCronDisabled)));
+        }
+        if ($isCronDisabled) {
+            $this->io->finalMessage('Cron is disabled; this command terminates early.');
+
+            return Command::SUCCESS;
+        }
+
+        $this->io->finalMessage('Finished.');
+
+        return Command::SUCCESS;
+    }
+}

src/Command/HealthcheckCommand.php

@@ -128,24 +128,28 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $alpineVersion
         ));
 
-        $frankenPhpVersion = 'unknown';
         $caddyVersion = 'unknown';
-        $frankenPhpVersionOutput = explode(' ', \Safe\shell_exec('frankenphp -v 2>&1') ?? '');
-        if (count($frankenPhpVersionOutput) > 6) {
-            $frankenPhpVersion = \Safe\preg_replace('/[^0-9.]/', '', $frankenPhpVersionOutput[1]);
-            $caddyVersion = \Safe\preg_replace('/[^0-9.]/', '', $frankenPhpVersionOutput[5]);
+        $caddyVersionOutput = explode(' ', \Safe\shell_exec('frankenphp -v 2>&1') ?? '');
+        if (count($caddyVersionOutput) > 1) {
+            $caddyVersion = \Safe\preg_replace('/[^0-9.]/', '', $caddyVersionOutput[0]);
         }
-        /** @var string $frankenPhpVersion */
         /** @var string $caddyVersion */
-        $this->io->writeln(sprintf(
-            'FrankenPHP version:    %s',
-            $frankenPhpVersion
-        ));
         $this->io->writeln(sprintf(
             'Caddy version:         %s',
             $caddyVersion
         ));
 
+        $frankenPhpVersion = 'unknown';
+        $frankenPhpVersionOutput = getenv('FRANKENPHP_VERSION');
+        if (is_string($frankenPhpVersionOutput)) {
+            $frankenPhpVersion = \Safe\preg_replace('/[^0-9.]/', '', $frankenPhpVersionOutput);
+        }
+        /** @var string $frankenPhpVersion */
+        $this->io->writeln(sprintf(
+            'FrankenPHP version:    %s',
+            $frankenPhpVersion
+        ));
+
         /**
          * @psalm-suppress PossiblyFalseArgument
          */