feat(crontab): add database-based crontab configuration and execution (#151)

* feat(crontab): add database-based crontab configuration and execution

- Implement database-driven crontab configuration with migrations
- Add Crontab, Schedule, and CrontabContainer classes for task management
- Include CrontabUrl for URL-based task execution
- Add CI workflows for pull request handling and releases
- Implement logging and aspect-oriented execution tracking
- Add comprehensive test coverage for all components

* feat(Crontab): add serialization methods for cronId

Add __serialize and __unserialize methods to handle cronId property during serialization.
Also reorganize composer.json dependencies alphabetically for better maintainability.

* refactor(tests): move Crontab test files to new directory structure

Restructure test files for Crontab component by moving them from src/Crontab/tests to tests/Crontab directory. This includes test cases for ConfigProvider, CrontabContainer, CrontabUrl, CrontabProcessStarredListener, Schedule, CrontabExecutorAspect, and Crontab classes. The changes maintain all existing test functionality while improving project organization.

Author: zds-s

.gitattributes

@@ -0,0 +1,2 @@
+/tests export-ignore
+/.github export-ignore

.github/workflows/close-pull-request.yml

@@ -0,0 +1,15 @@
+name: Close Pull Request
+
+permissions: write-all
+
+on:
+  pull_request_target:
+    types: [ opened ]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: superbrothers/close-pull-request@v3
+        with:
+          comment: "Hi, this is a READ-ONLY repository, please submit your PR on the https://github.com/mineadmin/components repository.<br><br> This Pull Request will close automatically.<br><br> Thanks! "

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+on:
+  push:
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+name: Release
+permissions: write-all
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          draft: false
+          prerelease: false

Database/Migrations/2024_03_26_020159_create_crontab.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of MineAdmin.
+ *
+ * @link     https://www.mineadmin.com
+ * @document https://doc.mineadmin.com
+ * @contact  root@imoi.cn
+ * @license  https://github.com/mineadmin/MineAdmin/blob/master/LICENSE
+ */
+use Hyperf\Database\Migrations\Migration;
+use Hyperf\Database\Schema\Blueprint;
+use Hyperf\Database\Schema\Schema;
+
+class CreateCrontab extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('crontab', static function (Blueprint $table) {
+            $table->bigIncrements('id');
+            /*
+             * name string 30
+             * status tinyint 1 default 0
+             * memo string 60 default null
+             * type string 10 not null
+             * value string longtext not null
+             */
+            $table->string('name', 30);
+            $table->tinyInteger('status')->default(0);
+            $table->tinyInteger('is_on_one_server')->default(0);
+            $table->tinyInteger('is_singleton')->default(0);
+            $table->string('memo', 60)->default(null);
+            $table->string('type', 10);
+            $table->string('rule', 30);
+            $table->text('value');
+            $table->datetimes();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('crontab');
+    }
+}

Database/Migrations/2024_03_26_020825_create_crontab_execute_log.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of MineAdmin.
+ *
+ * @link     https://www.mineadmin.com
+ * @document https://doc.mineadmin.com
+ * @contact  root@imoi.cn
+ * @license  https://github.com/mineadmin/MineAdmin/blob/master/LICENSE
+ */
+use Hyperf\Database\Migrations\Migration;
+use Hyperf\Database\Schema\Blueprint;
+use Hyperf\Database\Schema\Schema;
+
+class CreateCrontabExecuteLog extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('crontab_execute_log', static function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->bigInteger('crontab_id');
+            $table->string('name', 100);
+            $table->tinyInteger('status')->default(0);
+            $table->string('target', 200);
+            $table->text('exception_info');
+            $table->datetimes();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('crontab_execute_log');
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MineAdmin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# Hyperf Crontab 加强
+
+在原有的基础上增加了定时任务从数据库读取的配置

composer.json

@@ -0,0 +1,37 @@
+{
+  "name": "mineadmin/crontab",
+  "description": "加强 Hyperf Crontab",
+  "license": "MIT",
+  "type": "library",
+  "authors": [
+    {
+      "name": "x.mo",
+      "role": "Developer"
+    },
+    {
+      "name": "zds",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "php": ">=8.1",
+    "hyperf/crontab": "^3.1",
+    "hyperf/database": "^3.1",
+    "hyperf/db-connection": "^3.1"
+  },
+  "autoload": {
+    "psr-4": {
+      "Mine\\Crontab\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Mine\\Crontab\\Tests\\": "tests/"
+    }
+  },
+  "extra": {
+    "hyperf": {
+      "config": "Mine\\Crontab\\ConfigProvider"
+    }
+  }
+}

src/Aspect/CrontabExecutorAspect.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of MineAdmin.
+ *
+ * @link     https://www.mineadmin.com
+ * @document https://doc.mineadmin.com
+ * @contact  root@imoi.cn
+ * @license  https://github.com/mineadmin/MineAdmin/blob/master/LICENSE
+ */
+
+namespace Mine\Crontab\Aspect;
+
+use Hyperf\Crontab\Crontab;
+use Hyperf\Crontab\Strategy\Executor;
+use Hyperf\DbConnection\Db;
+use Hyperf\Di\Aop\AbstractAspect;
+use Hyperf\Di\Aop\ProceedingJoinPoint;
+use Mine\Crontab\CrontabContainer;
+
+class CrontabExecutorAspect extends AbstractAspect
+{
+    public array $classes = [
+        Executor::class . '::logResult',
+    ];
+
+    public function process(ProceedingJoinPoint $proceedingJoinPoint)
+    {
+        /**
+         * @var Crontab $crontab
+         * @var bool $isSuccess
+         * @var null|\Throwable $throwable
+         */
+        [$crontab, $isSuccess, $throwable] = $proceedingJoinPoint->getArguments();
+        if ($crontab instanceof \Mine\Crontab\Crontab) {
+            $callback = $crontab->getCallback();
+            if (\is_array($callback)) {
+                $callback = json_encode($callback, \JSON_THROW_ON_ERROR | \JSON_UNESCAPED_UNICODE);
+            }
+            Db::connection(CrontabContainer::$connectionName)
+                ->table('crontab_execute_log')
+                ->insert([
+                    'crontab_id' => $crontab->getCronId(),
+                    'name' => $crontab->getName(),
+                    'target' => $callback,
+                    'status' => $isSuccess ? 1 : 0,
+                    'exception_info' => $throwable === null ? '' : $throwable->getMessage(),
+                ]);
+        }
+        return $proceedingJoinPoint->process();
+    }
+}

src/Command/CrontabMigrateCommand.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of MineAdmin.
+ *
+ * @link     https://www.mineadmin.com
+ * @document https://doc.mineadmin.com
+ * @contact  root@imoi.cn
+ * @license  https://github.com/mineadmin/MineAdmin/blob/master/LICENSE
+ */
+
+namespace Mine\Crontab\Command;
+
+use Hyperf\Command\Command as Base;
+use Hyperf\Database\Migrations\Migrator;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\NullOutput;
+
+class CrontabMigrateCommand extends Base
+{
+    protected ?string $name = 'crontab:migrate';
+
+    public function __construct(
+        private readonly Migrator $migrator
+    ) {
+        parent::__construct();
+    }
+
+    public function __invoke()
+    {
+        $connection = $this->input->getOption('connection');
+        if (empty($connection)) {
+            $connection = 'default';
+        }
+        $migrator = $this->migrator;
+        $migrator->setConnection($connection);
+        $this->migrator
+            ->setOutput(new NullOutput())
+            ->run(\dirname(__DIR__, 2) . '/Database/Migrations');
+    }
+
+    protected function getOptions(): array
+    {
+        return [
+            new InputOption('connection', 'connection', InputOption::VALUE_OPTIONAL, 'connection name'),
+        ];
+    }
+}