Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MihaelIsaev/VaporCron
⏲ Swift cron scheduler for Vapor
https://github.com/MihaelIsaev/VaporCron
Last synced: 16 days ago
JSON representation
⏲ Swift cron scheduler for Vapor
- Host: GitHub
- URL: https://github.com/MihaelIsaev/VaporCron
- Owner: MihaelIsaev
- License: mit
- Created: 2019-03-07T23:28:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-14T08:50:35.000Z (10 months ago)
- Last Synced: 2024-07-15T19:47:02.643Z (4 months ago)
- Language: Swift
- Homepage:
- Size: 19.5 KB
- Stars: 85
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://mihaelisaev.com)
#### Support this lib by giving a ⭐️
Built for Vapor4
> 💡Vapor3 version is available in `vapor3` branch and from `1.0.0` tag
## How to install
### Swift Package Manager
```swift
.package(url: "https://github.com/MihaelIsaev/VaporCron.git", from:"2.6.0")
```
In your target's dependencies add `"VaporCron"` e.g. like this:
```swift
.target(name: "App", dependencies: ["VaporCron"]),
```
## Usage
### Simple job with closure
```swift
import VaporCron
let job = try app.cron.schedule("* * * * *") { // or add one more * to launch every second
print("Closure fired")
}
```
### Complex job in dedicated struct
```swift
import Vapor
import VaporCron
/// Your job should conform to `VaporCronSchedulable` or `VaporCronInstanceSchedulable`
struct ComplexJob: VaporCronSchedulable {
static var expression: String { "* * * * *" } // or add one more * to launch every second
static func task(on application: Application) -> EventLoopFuture {
return application.eventLoopGroup.future().always { _ in
print("ComplexJob fired")
}
}
}
let complexJob = try app.cron.schedule(ComplexJob.self)
struct ComplexInstanceJob: VaporCronInstanceSchedulable {
static var expression: String { "* * * * *" } // or add one more * to launch every second
private let application: Application
init(application: Application) {
self.application = application
}
func task() -> EventLoopFuture {
return application.eventLoopGroup.future().always { _ in
print("ComplexJob fired")
}
}
}
let complexInstanceJob = try app.cron.schedule(ComplexInstanceJob.self)
```
> 💡you also could call `req.cron.schedule(...)``
> 💡💡Scheduled job may be cancelled just by calling `.cancel()`
### Concurrency (swift>=5.5)
use `AsyncVaporCronSchedulable` instead `VaporCronSchedulable`
use `AsyncVaporCronInstanceSchedulable` instead `VaporCronInstanceSchedulable`
```swift
public struct TestCron: AsyncVaporCronSchedulable {
public typealias T = Void
public static var expression: String {
"*/1 * * * *" // or add one more * to launch every 1st second
}
public static func task(on application: Application) async throws -> Void {
application.logger.info("\(Self.self) is running...")
}
}
```
## Where to define
#### On boot
You could define all cron jobs in your `boot.swift` cause here is `app: Application` which contains `eventLoop`
```swift
import Vapor
import VaporCron
// Called before your application initializes.
func configure(_ app: Application) throws {
let complexJob = try app.cron.schedule(ComplexJob.self)
/// This example code will cancel scheduled job after 120 seconds
/// so in a console you'll see "Closure fired" three times only
app.eventLoopGroup.next().scheduleTask(in: .seconds(120)) {
complexJob.cancel()
}
}
```
#### In request handler
Some jobs you may want to schedule from some request handler like this
```swift
import Vapor
import VaporCron
func routes(_ app: Application) throws {
app.get("test") { req -> HTTPStatus in
try req.cron.schedule(ComplexJob.self).transform(to: .ok)
}
}
```
### How to do something in the database every 5 minutes?
```swift
import Vapor
import VaporCron
struct Every5MinJob: VaporCronSchedulable {
static var expression: String { "*/5 * * * *" } // every 5 minutes
static func task(on application: Application) -> Future {
application.db.query(Todo.self).all().map { rows in
print("ComplexJob fired, found \(rows.count) todos")
}
}
}
```
## Dependencies
- [NIOCronScheduler](https://github.com/MihaelIsaev/NIOCronScheduler)
- [SwifCron](https://github.com/MihaelIsaev/SwifCron)
## Contributing
Please feel free to contribute!