Replace all instances of db.DefaultContext with a custom context

[delvh]

Problem

Early on, people often used db.DefaultContext whenever they did not have access to to a context.Context (from the Go standard library).

Nowadays, we see the problems from this approach as it means that data is added to transactions it doesn't belong, or requests hang forever waiting for some condition to be met.

Solution

As such, any database call should be started from a fitting context that is not db.DefaultContext.
The only places where db.DefaultContext is still allowed, is inside tests (files ending with test.go).
Any other occurrence should be replaced with an additional ctx context.Context function parameter (that should be the first function parameter).

Where to get the ctx param?

If you don't know where to get it from, in the worst case, you need to pass the context down from the route handler (routers/ package, i.e. routers/web/web.go) until you reach the respective function.

How to find all occurrences in need of conversion?

On Posix systems (MacOS, Linux, BSD), simply execute the following in a shell in the root directory of the gitea source code:

grep -irnH 'db\.DefaultContext' {routers,services,models,modules} | grep -v 'test.*\.go'

or if you have ag installed:

ag 'db\.DefaultContext' | grep -v 'test.*\.go' 

Alternatively, you can use whatever graphical tool you like. This works on all systems.

[JakobDev]

I will try to fix it at some places

[JakobDev]

I opened a first PR. More will follow.

btw: If someone wants to use the GitHub search, here's a Link.

[JakobDev]

@delvh How should I deal with functions that are used by templates?

[delvh]

Yes, those are unfortunately impossible yet.
We are currently working towards implementing ctxFunctions in the templates that could be called similar to the already existing mechanism of ctx.Locale.Tr, but that process isn't finished yet.

[JakobDev]

This can be closed now

[delvh]

All remaining 47 instances are inherently unfixable?

[lunny]

I think left db.DefaultContext is not easy to change and we can close this issue.