-
-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce RequestContext: is a short-lived context that is used to store request-specific data. RequestContext could be used to clean form tmp files, close context git repo, and do some tracing in the future. Then a lot of legacy code could be removed or improved. For example: most `ctx.Repo.GitRepo.Close()` could be removed because the git repo could be closed when the request is done.
- Loading branch information
1 parent
781c6df
commit 6d5aa92
Showing
34 changed files
with
376 additions
and
419 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package reqctx | ||
|
|
||
| import ( | ||
| "context" | ||
| "io" | ||
| "sync" | ||
|
|
||
| "code.gitea.io/gitea/modules/process" | ||
| ) | ||
|
|
||
| type ContextDataProvider interface { | ||
| GetData() ContextData | ||
| } | ||
|
|
||
| type ContextData map[string]any | ||
|
|
||
| func (ds ContextData) GetData() ContextData { | ||
| return ds | ||
| } | ||
|
|
||
| func (ds ContextData) MergeFrom(other ContextData) ContextData { | ||
| for k, v := range other { | ||
| ds[k] = v | ||
| } | ||
| return ds | ||
| } | ||
|
|
||
| // RequestDataStore is a short-lived context-related object that is used to store request-specific data. | ||
| type RequestDataStore interface { | ||
| GetData() ContextData | ||
| SetContextValue(k, v any) | ||
| GetContextValue(key any) any | ||
| AddCleanUp(f func()) | ||
| AddCloser(c io.Closer) | ||
| } | ||
|
|
||
| type requestDataStoreKeyType struct{} | ||
|
|
||
| var RequestDataStoreKey requestDataStoreKeyType | ||
|
|
||
| type requestDataStore struct { | ||
| data ContextData | ||
|
|
||
| mu sync.RWMutex | ||
| values map[any]any | ||
| cleanUpFuncs []func() | ||
| } | ||
|
|
||
| func (r *requestDataStore) GetContextValue(key any) any { | ||
| if key == RequestDataStoreKey { | ||
| return r | ||
| } | ||
| r.mu.RLock() | ||
| defer r.mu.RUnlock() | ||
| return r.values[key] | ||
| } | ||
|
|
||
| func (r *requestDataStore) SetContextValue(k, v any) { | ||
| r.mu.Lock() | ||
| r.values[k] = v | ||
| r.mu.Unlock() | ||
| } | ||
|
|
||
| // GetData and the underlying ContextData are not thread-safe, callers should ensure thread-safety. | ||
| func (r *requestDataStore) GetData() ContextData { | ||
| if r.data == nil { | ||
| r.data = make(ContextData) | ||
| } | ||
| return r.data | ||
| } | ||
|
|
||
| func (r *requestDataStore) AddCleanUp(f func()) { | ||
| r.mu.Lock() | ||
| r.cleanUpFuncs = append(r.cleanUpFuncs, f) | ||
| r.mu.Unlock() | ||
| } | ||
|
|
||
| func (r *requestDataStore) AddCloser(c io.Closer) { | ||
| r.AddCleanUp(func() { _ = c.Close() }) | ||
| } | ||
|
|
||
| func (r *requestDataStore) cleanUp() { | ||
| for _, f := range r.cleanUpFuncs { | ||
| f() | ||
| } | ||
| } | ||
|
|
||
| func GetRequestDataStore(ctx context.Context) RequestDataStore { | ||
| if req, ok := ctx.Value(RequestDataStoreKey).(*requestDataStore); ok { | ||
| return req | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| type requestContext struct { | ||
| context.Context | ||
| dataStore *requestDataStore | ||
| } | ||
|
|
||
| func (c *requestContext) Value(key any) any { | ||
| if v := c.dataStore.GetContextValue(key); v != nil { | ||
| return v | ||
| } | ||
| return c.Context.Value(key) | ||
| } | ||
|
|
||
| func NewRequestContext(parentCtx context.Context, profDesc string) (_ context.Context, finished func()) { | ||
| ctx, _, processFinished := process.GetManager().AddTypedContext(parentCtx, profDesc, process.RequestProcessType, true) | ||
| reqCtx := &requestContext{Context: ctx, dataStore: &requestDataStore{values: make(map[any]any)}} | ||
| return reqCtx, func() { | ||
| reqCtx.dataStore.cleanUp() | ||
| processFinished() | ||
| } | ||
| } | ||
|
|
||
| // NewRequestContextForTest creates a new RequestContext for testing purposes | ||
| // It doesn't add the context to the process manager, nor do cleanup | ||
| func NewRequestContextForTest(parentCtx context.Context) context.Context { | ||
| return &requestContext{Context: parentCtx, dataStore: &requestDataStore{values: make(map[any]any)}} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.