Re:Goroutines and APIs
by asdfasgasdgasdg on Monday November 18, 2019 @04:33PM
(#21568342)
I guess what I mean to say is: don't make your users write
in order to use the API correctly. That's just a guess, though.
[ Parent
| on HN ]
The article says almost exactly the opposite, and I agree.
Your API should present all of the things it does as synchronous functions/methods. If callers want to run them asynchronously, they can easily provide their own goroutine to do so, including whatever lifecycle management makes sense for them.
The concrete example was
// Do this
func (t *type) Run(ctx context.Context) { ... }
// Not this
func (t *type) Start() { ... }
func (t *type) Cancel() { ... }
This is generally good advice which stops a whole class of extremely common and very tricky to debug orchestration bugs outright.