stop() API and also an auto-stop logic when sbot closes

[staltz]

No description provided.

[Powersource]

@staltz

1. what is stop() needed for?
2. why is the auto-stop needed?
3. do you have an example of how auto-stop should be implemented? it does auto stop in some sense at the moment, how should it be different?

[staltz]

@Powersource
Sorry, took me a while to filter my notifications and spot this one with questions for me.

what is stop() needed for?

start() automatically monitors add-member messages and will call reindexEncrypted, among other things. This is a heavy operation, and we should allow app developers to control when those operations can happen. stop() would let app developers control that.

why is the auto-stop needed?
do you have an example of how auto-stop should be implemented? it does auto stop in some sense at the moment, how should it be different?

auto-stop on sbot closing is necessary so we properly "clean up" instead of letting abrupt cancellations (which can cause either stdout/stderr warnings or may leave left overs in the filesystem, like LOCK files that leveldb some times generates). It's handy to make the auto-stop-on-closing a one line of code that just calls stop(), that's another reason to have stop().

Here's a few examples:

• https://github.com/ssbc/ssb-db2/blob/93ca3c1b33d9b930513341e2d74f81d2cd18a366/core.js#L115-L119
• https://github.com/ssbc/ssb-conn/blob/5dbace492899b58f4e6078dd8df96dff0c8c57b2/src/conn.ts#L41-L47

[Powersource]

@staltz thx!

Is this needed in production (the github label)?

[staltz]

Yeah, can label it for prod

[Powersource]

I mean can I remove the label?

[staltz]

Hmm, I guess it can be a could. Things might work in production without this, so that makes it a could.