Add Scheduler Feature for Running Cron Jobs (#735)

Support scheduler jobs

.github/workflows/ci-generators.yml

@@ -96,6 +96,13 @@ jobs:
           REDIS_URL: redis://localhost:${{job.services.redis.ports[6379]}}
           DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres_test
 
+      - name: scheduler
+        run: cargo run -- generate scheduler
+        working-directory: ./examples/demo
+        env:
+          REDIS_URL: redis://localhost:${{job.services.redis.ports[6379]}}
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres_test
+
       - name: docker deployment
         run: cargo run -- generate deployment
         working-directory: ./examples/demo

Cargo.toml

@@ -83,8 +83,8 @@ tracing = "0.1.40"
 tracing-subscriber = { version = "0.3.16", features = ["env-filter"] }
 tracing-appender = "0.2.3"
 
-# cli/migrations
-duct = "0.13.6"
+duct = { version = "0.13.6" }
+duct_sh = { version = "0.13.7" }
 
 tower-http = { workspace = true }
 byte-unit = "4.0.19"
@@ -123,6 +123,10 @@ object_store = { version = "0.10.2", default-features = false }
 # cache
 moka = { version = "0.12.7", features = ["sync"], optional = true }
 
+# Scheduler
+tokio-cron-scheduler = { version = "0.11.0", features = ["signal"] }
+english-to-cron = {version = "0.1.2"}
+
 [workspace.dependencies]
 async-trait = { version = "0.1.74" }
 axum = { version = "0.7.5", features = ["macros"] }

examples/demo/config/development.yaml

@@ -156,3 +156,32 @@ auth:
     expiration: 604800 # 7 days
 # </snip>
 
+# Scheduler Jobs Configuration
+# <snip id="configuration-scheduler">
+scheduler:
+  # Location of shipping the command stdout and stderr.
+  output: stdout
+  # A list of jobs to be scheduled.
+  jobs:
+    # The name of the job.
+    write_content:
+      # by default false meaning executing the the run value as a task. if true execute the run value as shell command
+      shell: true
+      # command to run
+      run: "echo loco >> ./scheduler.txt"
+      # run the command as shell 
+      # The cron expression defining the job's schedule.
+      cron: run every 1 second
+      output: silent
+      tags: ['base', 'infra']
+
+    run_task:
+      run: "foo"
+      cron: "at 10:00 am"
+
+    list_if_users:
+      run: "user_report"
+      shell: true
+      cron: "* 2 * * * *"
+      tags: ['base', 'users']
+# </snip>

examples/demo/config/scheduler.yaml

@@ -0,0 +1,18 @@
+output: stdout
+jobs:
+  write_content:
+    shell: true
+    run: "echo loco >> ./scheduler.txt"
+    cron: run every 1 second
+    output: silent
+    tags: ['base', 'infra']
+
+  run_task:
+    run: "foo"
+    cron: "at 10:00 am"
+
+  list_if_users:
+    run: "user_report"
+    shell: true
+    cron: "* 2 * * * *"
+    tags: ['base', 'users']

examples/demo/config/test.yaml

@@ -131,3 +131,23 @@ auth:
     secret: PqRwLF2rhHe8J22oBeHy
     # Token expiration time in seconds
     expiration: 604800 # 7 days
+
+scheduler:
+  output: stdout
+  jobs:
+    write_content:
+      shell: true
+      run: "echo loco >> ./scheduler.txt"
+      cron: run every 1 second
+      output: silent
+      tags: ['base', 'infra']
+
+    run_task:
+      run: "foo"
+      cron: "at 10:00 am"
+
+    list_if_users:
+      run: "user_report"
+      shell: true
+      cron: "* 2 * * * *"
+      tags: ['base', 'users']

examples/demo/tests/cmd/cli.trycmd

@@ -6,14 +6,15 @@ The one-person framework for Rust
 Usage: blo-cli [OPTIONS] <COMMAND>
 
 Commands:
-  start     Start an app
-  db        Perform DB operations
-  routes    Describe all application endpoints
-  task      Run a custom task
-  generate  code generation creates a set of files and code templates based on a predefined set of rules
-  doctor    Validate and diagnose configurations
-  version   Display the app version
-  help      Print this message or the help of the given subcommand(s)
+  start      Start an app
+  db         Perform DB operations
+  routes     Describe all application endpoints
+  task       Run a custom task
+  scheduler  Run the scheduler
+  generate   code generation creates a set of files and code templates based on a predefined set of rules
+  doctor     Validate and diagnose configurations
+  version    Display the app version
+  help       Print this message or the help of the given subcommand(s)
 
 Options:
   -e, --environment <ENVIRONMENT>  Specify the environment [default: development]
@@ -59,6 +60,7 @@ Commands:
   scaffold    Generates a CRUD scaffold, model and controller
   controller  Generate a new controller with the given controller name, and test file
   task        Generate a Task based on the given name
+  scheduler   Generate a scheduler jobs configuration template
   worker      Generate worker
   mailer      Generate mailer
   deployment  Generate a deployment infrastructure

examples/demo/tests/cmd/scheduler.trycmd

@@ -0,0 +1,19 @@
+```console 
+$ LOCO_ENV=test blo-cli scheduler --list
+#      job_name        cron               tags               run
+1      list_if_users   * 2 * * * *        base, users        "user_report"
+2      run_task        at 10:00 am        -                  "foo"
+3      write_content   run every 1 second base, infra        "echo loco >> ./scheduler.txt"
+
+
+```
+
+```console 
+$ LOCO_ENV=test blo-cli scheduler --config ./config/scheduler.yaml --list
+#      job_name        cron               tags               run
+1      list_if_users   * 2 * * * *        base, users        "user_report"
+2      run_task        at 10:00 am        -                  "foo"
+3      write_content   run every 1 second base, infra        "echo loco >> ./scheduler.txt"
+
+
+```

snipdoc.yml

@@ -108,3 +108,21 @@ snippets:
   migrate-down-n-command:
     content: cargo loco db down 2
     path: ./snipdoc.yml
+  scheduler-generate-command:
+    content: cargo loco generate scheduler
+    path: ./snipdoc.yml
+  scheduler-list-command:
+    content: cargo loco scheduler --list
+    path: ./snipdoc.yml
+  scheduler-list-from-file-command:
+    content: cargo loco scheduler --path config/scheduler.yaml --list
+    path: ./snipdoc.yml
+  scheduler-list-from-env-setting-command:
+    content: LOCO_ENV=production cargo loco scheduler --list
+    path: ./snipdoc.yml
+  scheduler-run-job-by-name-command:
+    content: LOCO_ENV=production cargo loco scheduler --name 'JOB_NAME'
+    path: ./snipdoc.yml
+  scheduler-run-job-by-tag-command:
+    content: LOCO_ENV=production cargo loco scheduler --tag 'maintenance'
+    path: ./snipdoc.yml