@platformatic/runtime 2.53.2 → 2.54.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2532Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2540Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -216,6 +216,23 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2532Json = {
     [k: string]: string;
   };
   sourceMaps?: boolean;
+  scheduler?: {
+    enabled?: boolean | string;
+    name: string;
+    cron: string;
+    callbackUrl: string;
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: {
+      [k: string]: string;
+    };
+    body?:
+      | string
+      | {
+          [k: string]: unknown;
+        };
+    maxRetries?: number;
+    [k: string]: unknown;
+  }[];
 };
 
 export interface UndiciInterceptor {

package/lib/runtime.js

@@ -18,6 +18,7 @@ const errors = require('./errors')
 const { createLogger } = require('./logger')
 const { startManagementApi } = require('./management-api')
 const { startPrometheusServer } = require('./prom-server')
+const { startScheduler } = require('./scheduler')
 const { createSharedStore } = require('./shared-http-cache')
 const { getRuntimeTmpDir } = require('./utils')
 const { sendViaITC, waitEventFromITC } = require('./worker/itc')
@@ -74,6 +75,7 @@ class Runtime extends EventEmitter {
   #restartingWorkers
   #sharedHttpCache
   servicesConfigsPatches
+  #scheduler
 
   constructor (configManager, runtimeLogsDir, env) {
     super()
@@ -199,6 +201,10 @@ class Runtime extends EventEmitter {
 
     this.#dispatcher = new Agent(dispatcherOpts).compose(interceptors)
 
+    if (config.scheduler) {
+      this.#scheduler = startScheduler(config.scheduler, this.#dispatcher, logger)
+    }
+
     this.#updateStatus('init')
   }
 
@@ -263,6 +269,10 @@ class Runtime extends EventEmitter {
   }
 
   async stop (silent = false) {
+    if (this.#scheduler) {
+      await this.#scheduler.stop()
+    }
+
     if (this.#status === 'starting') {
       await once(this, 'started')
     }
@@ -289,6 +299,7 @@ class Runtime extends EventEmitter {
     }
 
     await this.#meshInterceptor.close()
+
     this.#updateStatus('stopped')
   }
 

package/lib/scheduler.js

@@ -0,0 +1,121 @@
+'use strict'
+
+const { CronJob, validateCronExpression } = require('cron')
+const { setTimeout } = require('node:timers/promises')
+const { request } = require('undici')
+
+class SchedulerService {
+  constructor (schedulerConfig, dispatcher, logger) {
+    this.logger = logger
+    this.jobsConfig = []
+    this.cronJobs = []
+    this.dispatcher = dispatcher
+    this.validateCronSchedulers(schedulerConfig)
+  }
+
+  validateCronSchedulers (schedulerConfig) {
+    for (const config of schedulerConfig) {
+      // Skip disabled schedulers
+      if (config.enabled === false) {
+        continue
+      }
+
+      // Validate cron expression
+      const validation = validateCronExpression(config.cron)
+      if (!validation.valid) {
+        throw new Error(`Invalid cron expression "${config.cron}" for scheduler "${config.name}"`)
+      }
+
+      // Set defaults for optional fields
+      const job = {
+        ...config,
+        headers: config.headers || {},
+        body: config.body || {},
+        maxRetries: config.maxRetries || 3
+      }
+      this.jobsConfig.push(job)
+    }
+  }
+
+  start () {
+    for (const job of this.jobsConfig) {
+      this.logger.info(`Configuring scheduler "${job.name}" with cron "${job.cron}"`)
+      const cronJob = CronJob.from({
+        cronTime: job.cron,
+        onTick: async () => {
+          this.logger.info(`Executing scheduler "${job.name}"`)
+          // This cannot throw, the try/catch is inside
+          await this.executeCallback(job)
+        },
+        start: true,
+        timeZone: 'UTC',
+        waitForCompletion: true,
+      })
+
+      this.cronJobs.push(cronJob)
+    }
+  }
+
+  async stop () {
+    for (const job of this.cronJobs) {
+      await job.stop()
+    }
+  }
+
+  async executeCallback (scheduler) {
+    let attempt = 0
+    let success = false
+
+    while (!success && attempt < scheduler.maxRetries) {
+      try {
+        const delay = attempt > 0 ? 100 * Math.pow(2, attempt) : 0
+
+        if (delay > 0) {
+          this.logger.info(`Retrying scheduler "${scheduler.name}" in ${delay}ms (attempt ${attempt + 1}/${scheduler.maxRetries})`)
+          await setTimeout(delay)
+        }
+        const headers = {
+          'x-retry-attempt': attempt + 1,
+          ...scheduler.headers
+        }
+
+        const bodyString = typeof scheduler.body === 'string' ? scheduler.body : JSON.stringify(scheduler.body)
+        const response = await request(scheduler.callbackUrl, {
+          method: scheduler.method,
+          headers,
+          body: bodyString,
+          dispatcher: this.dispatcher
+        })
+
+        // Consumes the body, but we are not interested in the body content,
+        // we don't save it anywere, so we just dump it
+        await response.body.dump()
+
+        if (response.statusCode >= 200 && response.statusCode < 300) {
+          this.logger.info(`Scheduler "${scheduler.name}" executed successfully`)
+          success = true
+        } else {
+          throw new Error(`HTTP error ${response.statusCode}`)
+        }
+      } catch (error) {
+        this.logger.error(`Error executing scheduler "${scheduler.name}" (attempt ${attempt + 1}/${scheduler.maxRetries}):`, error.message)
+        attempt++
+      }
+    }
+
+    if (!success) {
+      this.logger.error(`Scheduler "${scheduler.name}" failed after ${scheduler.maxRetries} attempts`)
+    }
+  }
+}
+
+const startScheduler = (config, interceptors, logger) => {
+  const schedulerService = new SchedulerService(config, interceptors, logger)
+  schedulerService.start()
+  return schedulerService
+}
+
+module.exports = {
+  startScheduler,
+  SchedulerService
+}

package/lib/schema.js

@@ -478,6 +478,51 @@ const platformaticRuntimeSchema = {
     sourceMaps: {
       type: 'boolean',
       default: false
+    },
+    scheduler: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          enabled: {
+            anyOf: [{
+              type: 'boolean'
+            }, {
+              type: 'string'
+            }],
+            default: true
+          },
+          name: {
+            type: 'string'
+          },
+          cron: {
+            type: 'string'
+          },
+          callbackUrl: {
+            type: 'string'
+          },
+          method: {
+            type: 'string',
+            enum: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],
+            default: 'GET'
+          },
+          headers: {
+            type: 'object',
+            additionalProperties: {
+              type: 'string'
+            }
+          },
+          body: {
+            anyOf: [{ type: 'string' }, { type: 'object', additionalProperties: true }]
+          },
+          maxRetries: {
+            type: 'number',
+            minimum: 0,
+            default: 3
+          }
+        },
+        required: ['name', 'cron', 'callbackUrl']
+      }
     }
   },
   anyOf: [{ required: ['autoload'] }, { required: ['services'] }, { required: ['web'] }],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.53.2",
+  "version": "2.54.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -37,12 +37,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.53.2",
-    "@platformatic/db": "2.53.2",
-    "@platformatic/node": "2.53.2",
-    "@platformatic/sql-graphql": "2.53.2",
-    "@platformatic/sql-mapper": "2.53.2",
-    "@platformatic/service": "2.53.2"
+    "@platformatic/db": "2.54.0",
+    "@platformatic/composer": "2.54.0",
+    "@platformatic/node": "2.54.0",
+    "@platformatic/service": "2.54.0",
+    "@platformatic/sql-graphql": "2.54.0",
+    "@platformatic/sql-mapper": "2.54.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -56,6 +56,7 @@
     "change-case-all": "^2.1.0",
     "close-with-grace": "^2.0.0",
     "commist": "^3.2.0",
+    "cron": "^4.1.0",
     "debounce": "^2.0.0",
     "desm": "^1.3.1",
     "dotenv": "^16.4.5",
@@ -76,13 +77,13 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.13.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.53.2",
-    "@platformatic/config": "2.53.2",
-    "@platformatic/itc": "2.53.2",
-    "@platformatic/telemetry": "2.53.2",
-    "@platformatic/ts-compiler": "2.53.2",
-    "@platformatic/utils": "2.53.2",
-    "@platformatic/generators": "2.53.2"
+    "@platformatic/basic": "2.54.0",
+    "@platformatic/generators": "2.54.0",
+    "@platformatic/itc": "2.54.0",
+    "@platformatic/config": "2.54.0",
+    "@platformatic/telemetry": "2.54.0",
+    "@platformatic/ts-compiler": "2.54.0",
+    "@platformatic/utils": "2.54.0"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=300000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.53.2.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.54.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -1412,6 +1412,72 @@
     "sourceMaps": {
       "type": "boolean",
       "default": false
+    },
+    "scheduler": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "enabled": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "string"
+              }
+            ],
+            "default": true
+          },
+          "name": {
+            "type": "string"
+          },
+          "cron": {
+            "type": "string"
+          },
+          "callbackUrl": {
+            "type": "string"
+          },
+          "method": {
+            "type": "string",
+            "enum": [
+              "GET",
+              "POST",
+              "PUT",
+              "PATCH",
+              "DELETE"
+            ],
+            "default": "GET"
+          },
+          "headers": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "body": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "additionalProperties": true
+              }
+            ]
+          },
+          "maxRetries": {
+            "type": "number",
+            "minimum": 0,
+            "default": 3
+          }
+        },
+        "required": [
+          "name",
+          "cron",
+          "callbackUrl"
+        ]
+      }
     }
   },
   "anyOf": [