bring agendaTS into agenda main repo

[simllll]

As discussed and suggested here #1082 the idea is to bring agendaTS as new major version of agenda main.

Checklist (WIP):

• try to create a PR that is based on the current agenda master, and try to keep as many commits from the agendaTS to have a change history. in case of merge conflicts, keep the agendaTS code.
• rename everything back to agenda
• improve docs of new features
• write down list of breaking changes and transition guide

New features in agendaTS:

• touch() can have an optional progress parameter (0-100)
• job forking in seperate threads (https://github.com/hokify/agenda#sandboxed-worker---use-child-processes)
• getRunningStats()

List of currently known breaking changes:

• not supported in agendaTS: Feat: Add top level disable and enable (Add top level disable and enable #1109) thanks @pdfowler
• not supported in agendaTS: shouldSaveResult (see Support for shouldSaveResult hokify/agenda#29)
• not supported in agendaTS: Feat: Add drain() method for graceful process shutdowns (added drain func #1488) thanks @nmehmedrnd
• agenda default export (cjs?) - check compatiblity
• not supported in agendaTS: no support for "non public api" export of internal db connection (there is currently no _collection workaround: const collection = agenda._collection?.collection || genda._collection || agenda.db?.collection; see agendash not working with this fork hokify/agenda#27
• not supported in agendaTS: Add ability to schedule jobs with startDate, endDate, and skipping (Run job between start and end date + run job every x days #361) thanks @suryanaik
• define() config paramter moved from 2nd position to 3rd

feel free to add comments, ideas and other things you come up with :)

[harisvsulaiman]

What about tests?

[harisvsulaiman]

@simllll I hope this will be a starting point.

[harisvsulaiman]

@simllll Is there any update on this issue?

[simllll]

Sorry for still not working on it, I have it still in my list, but couldn't really find time yet. Hopefully within the next few weeks though!

[harisvsulaiman]

@simllll Is this on the agenda ? (Pun intended)

[simllll]

It's still on my list, but unfortunately didn't find time yet... Maybe I can start working on it next weekend, to get things rolling... 🤞

[harisvsulaiman]

@simllll let me know if you need anything. I will try to find time to help out if possible

[sebamarynissen]

Hi there,

Would it be possible to create a v5 branch based on 8f46df0? I've added support for mongodb@5, but it's based on the code of v5.0.0 that's on npm, and since #1503 it doesn't make sense to file a PR against the master branch - see #1547.

I think it would be nice to add support for mongodb@5 in a semver minor v5.1.0 without waiting for the next release with agendaTS merged into the repo.

[harisvsulaiman]

@simllll Is there any update on this?

[GimpMaster]

I'm curious on where I should get agenda as well. Looks like npmjs is showing version 5.0.0 only, but this repo shows change logs into the 6.X @simllll

[koresar]

@GimpMaster the 6.x development halted unfortunately.

[GimpMaster]

@koresar - is the 5.X considered stable? I’m still back on 3.X and was just looking to upgrade.

[koresar]

I do not know which is more stable. Sorry.

[sebamarynissen]

@GimpMaster 5.x is stable, but it doesn't work with mongodb@6 due to a few breaking changes in the mongodb package.

I've published my own fork @whisthub/agenda on npm, which is compatible with mongodb 4, 5 and 6 (beware mongodb is a peer dependency now). I've been using this in production for about 3 weeks now without any issues.

[GimpMaster]

Thank you

[tomups]

@sebamarynissen thanks for that, got excited for a moment but because your fork is ESM only, it doesn't work with NestJS :(

Hopefully NestJS will move to ESM one of these days...

[sebamarynissen]

@tomups Is it an option for you to use dynamic import? As most of agenda is async anyway, this could be an option in cjs projects:

const { default: agenda } = await import('@whisthub/agenda');
await agenda.start();

// Instead of
const agenda = require('@whisthub/agenda');
await agenda.start();

[tomups]

@sebamarynissen I don't use agenda directly in NestJS but via https://github.com/jongolden/agenda-nest which makes it work in a more NestJS way. So I don't think using dynamic import in that way would work. Maybe forking agenda-nest and trying it...

But with dynamic import we lose TypeScript types :(