@pikku/schedule 0.6.1

package/CHANGELOG.md

@@ -0,0 +1,65 @@
+# @pikku/schedule
+
+## 0.6.1
+
+### Patch Changes
+
+- 0a92fa7: refactor: pulling schema into seperate package since ajv doesnt work on cloudflare (also keeps bundle size small!)
+- Updated dependencies [0a92fa7]
+  - @pikku/core@0.6.7
+
+## 0.6
+
+Marking a major release to include channels and scheduled tasks
+
+## 0.5.5
+
+### Patch Changes
+
+- 662a6cf: feat: adding scheduled tasks names
+- Updated dependencies [662a6cf]
+- Updated dependencies [c8578ea]
+- Updated dependencies [d2f8edf]
+  - @pikku/core@0.5.29
+
+## 0.5.4
+
+### Patch Changes
+
+- 886a2fb: refactor: moving singletons (like routes and channels) to global to avoid nodemodule overrides
+- Updated dependencies [a768bad]
+- Updated dependencies [886a2fb]
+- Updated dependencies [886a2fb]
+  - @pikku/core@0.5.28
+
+## 0.5.3
+
+### Patch Changes
+
+- 0f96787: refactor: dropping cjs support
+- c23524a: refactor: bump to versions to ensure correct package usage
+- Updated dependencies [0f96787]
+- Updated dependencies [64e4a1e]
+- Updated dependencies [c23524a]
+  - @pikku/core@0.5.25
+
+## 0.5.2
+
+### Patch Changes
+
+- bba25cc: chore: updating all packages to reflect major changes
+- Updated dependencies [bba25cc]
+- Updated dependencies [9deb482]
+- Updated dependencies [ee0c6ea]
+  - @pikku/core@0.5.24
+
+## 0.5.1
+
+### Patch Changes
+
+- 7fa64a0: feat: making schedule session services optional
+- 539937e: refactor: use a map instead for scheduled tasks
+- Updated dependencies [7fa64a0]
+- Updated dependencies [539937e]
+- Updated dependencies [e9a9968]
+  - @pikku/core@0.5.23

package/README.md

@@ -0,0 +1,3 @@
+# @pikku/scheduler
+
+This package is part of @pikku/mono and is responsible for scheduling tasks in pikku.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { PikkuTaskScheduler } from './pikku-task-scheduler.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { PikkuTaskScheduler } from './pikku-task-scheduler.js';

package/dist/pikku-task-scheduler.d.ts

@@ -0,0 +1,12 @@
+import { CoreServices, CoreSingletonServices, CoreUserSession, CreateSessionServices } from '@pikku/core';
+export declare class PikkuTaskScheduler<TaskName extends string> {
+    private singletonServices;
+    private createSessionServices?;
+    private jobs;
+    constructor(singletonServices: CoreSingletonServices, createSessionServices?: CreateSessionServices<CoreSingletonServices, CoreServices, CoreUserSession> | undefined);
+    startAll(): void;
+    stopAll(): void;
+    start(names: TaskName[]): void;
+    stop(names: TaskName[]): void;
+    private startJobSchedule;
+}

package/dist/pikku-task-scheduler.js

@@ -0,0 +1,49 @@
+import { CronJob } from 'cron';
+import { getScheduledTasks, runScheduledTask, } from '@pikku/core/scheduler';
+export class PikkuTaskScheduler {
+    singletonServices;
+    createSessionServices;
+    jobs = new Map();
+    constructor(singletonServices, createSessionServices) {
+        this.singletonServices = singletonServices;
+        this.createSessionServices = createSessionServices;
+    }
+    startAll() {
+        const { scheduledTasks } = getScheduledTasks();
+        scheduledTasks.forEach((task) => this.startJobSchedule(task));
+    }
+    stopAll() {
+        this.jobs.forEach((job) => job.stop());
+        this.jobs.clear();
+    }
+    start(names) {
+        const { scheduledTasks } = getScheduledTasks();
+        for (const name of names) {
+            const task = scheduledTasks.get(name);
+            if (task) {
+                this.startJobSchedule(task);
+            }
+        }
+    }
+    stop(names) {
+        for (const name of names) {
+            const job = this.jobs.get(name);
+            if (job) {
+                job.stop();
+                this.jobs.delete(name);
+            }
+        }
+    }
+    startJobSchedule(task) {
+        const job = new CronJob(task.schedule, async () => {
+            this.singletonServices.logger.info(`Running scheduled task: ${task.name}`);
+            await runScheduledTask({
+                singletonServices: this.singletonServices,
+                createSessionServices: this.createSessionServices,
+                name: task.name,
+            });
+            this.singletonServices.logger.debug(`Completed scheduled task: ${task.name}`);
+        }, null, true);
+        this.jobs.set(task.name, job);
+    }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@pikku/schedule",
+  "version": "0.6.1",
+  "author": "yasser.fadl@gmail.com",
+  "license": "MIT",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "type": "module",
+  "scripts": {
+    "tsc": "tsc",
+    "build:esm": "tsc -b",
+    "build": "yarn build:esm",
+    "ncu": "ncu",
+    "release": "npm run build && npm test",
+    "test": "bash run-tests.sh",
+    "test:watch": "bash run-tests.sh --watch",
+    "test:coverage": "bash run-tests.sh --coverage"
+  },
+  "peerDependencies": {
+    "@pikku/core": "^0.6.7"
+  },
+  "devDependencies": {
+    "@types/node": "^22.7.8",
+    "typescript": "^5.6"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "cron": "^3.2.1",
+    "cron-schedule": "^5.0.4"
+  }
+}

package/run-tests.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Enable nullglob to handle cases where no files match the pattern
+shopt -s nullglob
+
+# Initialize variables for options
+watch_mode=false
+coverage_mode=false
+
+# Parse command-line options
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    --watch)
+      watch_mode=true
+      shift
+      ;;
+    --coverage)
+      coverage_mode=true
+      shift
+      ;;
+    *)
+      echo "Unknown option: $1"
+      exit 1
+      ;;
+  esac
+done
+
+# Define the pattern to match your test files
+pattern="src/*.test.ts"
+
+# Expand the pattern into an array of files
+files=($(find src -type f -name "*.test.ts"))
+
+# Check if any files matched the pattern
+if [ ${#files[@]} -eq 0 ]; then
+  echo "No test files found matching pattern: $pattern"
+  exit 0
+fi
+
+# Construct the node command
+node_cmd="node --import tsx --test"
+
+# Append options based on flags
+if [ "$watch_mode" = true ]; then
+  node_cmd="$node_cmd --watch"
+fi
+
+if [ "$coverage_mode" = true ]; then
+  node_cmd="$node_cmd --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info"
+fi
+
+# Execute the node command with the expanded list of files
+$node_cmd "${files[@]}"

package/src/index.ts

@@ -0,0 +1 @@
+export { PikkuTaskScheduler } from './pikku-task-scheduler.js'

package/src/pikku-task-scheduler.ts

@@ -0,0 +1,83 @@
+import { CronJob } from 'cron'
+import {
+  CoreAPIFunctionSessionless,
+  CoreServices,
+  CoreSingletonServices,
+  CoreUserSession,
+  CreateSessionServices,
+} from '@pikku/core'
+import {
+  getScheduledTasks,
+  runScheduledTask,
+  CoreScheduledTask,
+} from '@pikku/core/scheduler'
+
+export class PikkuTaskScheduler<TaskName extends string> {
+  private jobs = new Map<string, CronJob>()
+
+  constructor(
+    private singletonServices: CoreSingletonServices,
+    private createSessionServices?: CreateSessionServices<
+      CoreSingletonServices,
+      CoreServices,
+      CoreUserSession
+    >
+  ) {}
+
+  public startAll() {
+    const { scheduledTasks } = getScheduledTasks()
+    scheduledTasks.forEach((task) => this.startJobSchedule(task))
+  }
+
+  public stopAll() {
+    this.jobs.forEach((job) => job.stop())
+    this.jobs.clear()
+  }
+
+  public start(names: TaskName[]) {
+    const { scheduledTasks } = getScheduledTasks()
+    for (const name of names) {
+      const task = scheduledTasks.get(name)
+      if (task) {
+        this.startJobSchedule(task)
+      }
+    }
+  }
+
+  public stop(names: TaskName[]) {
+    for (const name of names) {
+      const job = this.jobs.get(name)
+      if (job) {
+        job.stop()
+        this.jobs.delete(name)
+      }
+    }
+  }
+
+  private startJobSchedule(
+    task: CoreScheduledTask<
+      CoreAPIFunctionSessionless<void, void>,
+      CoreUserSession
+    >
+  ) {
+    const job = new CronJob(
+      task.schedule,
+      async () => {
+        this.singletonServices.logger.info(
+          `Running scheduled task: ${task.name}`
+        )
+        await runScheduledTask({
+          singletonServices: this.singletonServices,
+          createSessionServices: this.createSessionServices as any,
+          name: task.name,
+        })
+        this.singletonServices.logger.debug(
+          `Completed scheduled task: ${task.name}`
+        )
+      },
+      null,
+      true
+    )
+    this.jobs.set(task.name, job)
+  }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "module": "Node16",
+    "outDir": "dist",
+    "target": "esnext",
+    "declaration": true,
+    "resolveJsonModule": true
+  },
+  "include": ["bin/**/*.ts", "src/**/*.ts"],
+  "exclude": ["**/*.test.ts", "node_modules", "bin/dist"],
+  "references": [
+    {
+      "path": "../core/tsconfig.json"
+    }
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/index.ts","./src/pikku-task-scheduler.ts"],"version":"5.7.3"}