feat: [#911] add query context accessor by almas-x · Pull Request #1401 · goravel/framework

almas-x · 2026-03-10T05:37:52Z

📑 Description

This PR adds Query.Context() to expose the context carried by Orm.WithContext(...), making that context available to downstream ORM logic such as global scopes. In practice, this allows code running inside global scopes to access the same context passed through facades.Orm().WithContext(ctx).
Example:

package main

import (
	"context"
	"fmt"

	contractsorm "github.com/goravel/framework/contracts/database/orm"
	"github.com/goravel/framework/database/orm"
)

type User struct {
	orm.Model `form:",squash"`
	Name      string
}

func (r *User) GlobalScopes() map[string]func(contractsorm.Query) contractsorm.Query {
	return map[string]func(contractsorm.Query) contractsorm.Query{
		"name": func(query contractsorm.Query) contractsorm.Query {
			fmt.Println(query.Context().Value("abc"))
			return query.Where("name", "goravel")
		},
	}
}

func main() {
	var users []models.User
	c := context.WithValue(context.Background(), "abc", "123")
	facades.Orm().WithContext(c).Query().Find(&users)
}

Output:

It also updates Event to retrieve context via query.Context() instead of reading it directly from the query internals. As a result, the existing event-related unit tests now indirectly cover query.Context() as well.

Summary by CodeRabbit

Improvements
- Enhanced query context management by introducing a new context accessor, providing better visibility and control over execution context throughout query operations.
- Updated query infrastructure components to utilize consistent context access patterns.

✅ Checks

Added test cases for my code

codecov · 2026-03-10T05:40:03Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.53%. Comparing base (4939fdf) to head (0e6ee58).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1401      +/-   ##
==========================================
+ Coverage   72.52%   72.53%   +0.01%     
==========================================
  Files         292      292              
  Lines       19564    19564              
==========================================
+ Hits        14188    14190       +2     
+ Misses       4798     4797       -1     
+ Partials      578      577       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

hwbrzzl · 2026-03-10T08:18:13Z

@coderabbitai review

coderabbitai · 2026-03-10T08:18:27Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2026-03-10T08:24:02Z

📝 Walkthrough

Walkthrough

A new method Context() context.Context is added to the Query interface to expose the execution context. The concrete Query implementation returns its internal context field, and existing code is updated to access context through the method instead of direct field access. Mock implementations are also updated with full fluent interface support.

Changes

Cohort / File(s)	Summary
Interface Definition `contracts/database/orm/orm.go`	Added new `Context() context.Context` method to the Query interface contract.
Implementation `database/gorm/query.go`	Implemented the Context method on Query struct, returning the internal context field.
Caller Updates `database/gorm/event.go`	Modified Event.Context() to access context via the new `e.query.Context()` method instead of direct field access.
Mock Updates `mocks/database/orm/Query.go`	Added complete mock implementation for Context method, including Query_Context_Call struct and fluent interface methods (Run, Return, RunAndReturn).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A context now flows through our queries so grand,
Where scopes can access what's at hand—
No more hidden fields, just a method so clean,
Multi-tenant dreams? Yes, we've foreseen! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a query context accessor method, with reference to the linked issue `#911`.
Linked Issues check	✅ Passed	The PR successfully implements the core requirement from `#911` by adding Context() method to the Query interface and implementations, enabling global scopes to access context information passed via WithContext().
Out of Scope Changes check	✅ Passed	All changes are directly aligned with the PR objective of adding a query context accessor; no out-of-scope modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings (stacked PR)
📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch almas/#911

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@contracts/database/orm/orm.go`:
- Around line 48-49: You added Context() to the public orm.Query interface which
is a breaking change; instead revert Context() from orm.Query and introduce a
new optional interface (e.g., interface name QueryWithContext) that declares
Context() context.Context, then update only the call sites that need the context
to type-assert to QueryWithContext (e.g., if q, ok := query.(QueryWithContext);
ok { ctx := q.Context(); ... }) so consumers that don't implement the accessor
remain compatible; ensure the new interface is declared near orm.Query so it
lives in the same contracts package and update imports/usages accordingly.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9bf5ce72-5c05-429a-bd84-f25765f32a50

📥 Commits

Reviewing files that changed from the base of the PR and between 4939fdf and 0e6ee58.

📒 Files selected for processing (4)

contracts/database/orm/orm.go
database/gorm/event.go
database/gorm/query.go
mocks/database/orm/Query.go

coderabbitai · 2026-03-10T08:24:05Z

contracts/database/orm/orm.go

+	// Context gets the context used by the query.
+	Context() context.Context


⚠️ Potential issue | 🟠 Major

Adding Context() here is a breaking change to the public orm.Query contract.

Any app, plugin, or handwritten test double that implements orm.Query will stop compiling until it adds this new method. If this feature needs to remain backwards-compatible, expose the accessor behind a new optional interface and type-assert where it is consumed instead of extending Query directly.

As per coding guidelines, contracts/**/*.go: Contracts should be Go interfaces that define the public API for each module, located in the contracts/ directory organized by module.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed. In `@contracts/database/orm/orm.go` around lines 48 - 49, You added Context() to the public orm.Query interface which is a breaking change; instead revert Context() from orm.Query and introduce a new optional interface (e.g., interface name QueryWithContext) that declares Context() context.Context, then update only the call sites that need the context to type-assert to QueryWithContext (e.g., if q, ok := query.(QueryWithContext); ok { ctx := q.Context(); ... }) so consumers that don't implement the accessor remain compatible; ensure the new interface is declared near orm.Query so it lives in the same contracts package and update imports/usages accordingly.

hwbrzzl

LGTM, thanks!

* chore: Update upgrade DB packages (#1374) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Internalize file rotation logic from goravel/file-rotatelogs (#1375) * Initial plan * Implement internal file rotation to replace goravel/file-rotatelogs Co-authored-by: hwbrzzl <[email protected]> * Improve cleanup logic with glob pattern matching and add comprehensive tests Co-authored-by: hwbrzzl <[email protected]> * Address code review feedback: fix trailing whitespace, add cleanup wait, and make tests deterministic Co-authored-by: hwbrzzl <[email protected]> * optimize --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> Co-authored-by: Bowen <[email protected]> * chore: Update non-major dependencies (#1373) * chore: Update non-major dependencies * optimize * optimize * renovate/non-major-dependencies * optimize --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bowen <[email protected]> * feat: [#726] Add HTTP server and client telemetry instrumentation [5] (#1326) * add http middleware * add http transport * optimise http telemetry package * add test cases for Telemetry middleware * add auto instrumentation configs * add config to enable Telemetry for http clients * add docs for config facade * add ConfigFacade nil warning * disable default telemetry * optimise transport * add kill switch for instrumentation * update the stubs * remove unnecessary handler * optimise log instrumentation * move route registration in the end * lazily initialize middleware and transport to work with new application_builder * optimise channel test * optimise channel test * accept telemetry facade as an input instead of using global instance * use a callback to resolve the telemetry facade instance * optimise grpc handler to remove usage of telemetry and config facade * optimise the grpc handler * use telemetry transport if enabled * optimise http auto instrumentation * optimize log test cases * optimise * optimise * optimise * optimise * revert PR#1357 * fix log test cases * revert GRPC changes * optimise middleware * remove zipkin trace driver * correct GRPC enable condition * correct http transport enable condition * correct log channel enable condition * update go mod * fix test cases * fix test cases * fix test cases * fix tests --------- Co-authored-by: Bowen <[email protected]> * chore: optimize runner tests for Windows (#1377) Co-authored-by: Bowen <[email protected]> * chore: Update non-major dependencies (#1378) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix: runner stuck (#1381) * fix: runner stuck * optimize * optimize * optimize * optimize * optimize * chore: Update non-major dependencies (#1382) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * feat: [#849] Add table support to the console context (#1380) * add table function in cli * add test cases for new method Table * update mocks * add column level styles * fix lint error * move style vars to new file * add GlobalHuhTheme * update go mod tidy * feat: [#546] artisan command up and down to set website Maintenance mode (#1198) * Add up and down command * Use file helper to create files and add unit tests * Fix the foundation.App dependency * Use support/path instead of foundation.App * Add unit test case * Add some missing checks * Add more missing checks * One more * Fix tmpfile path * Use T.TempDir instead of os.TempDir in tests * Add reason to the down command * Add option to the tests * Change the maintenance file name * close created file handles * Defer abort * Fix the linter issue * Add more options to the down command * Use options * Check for maintenance mode respond * Fix down_command_test * Add more unit test cases * Fix more lint issues * Fix lint issue * fix tests * fix tests * fix tests * fix tests * Address PR comments * Fix check_for_maintenance_test * Check Aborts in check_for_maintenance * Rename check_for_maintenance_mode * Fix and Write more unit tests for check_for_maintenance_mode middleware * fix down command * Fix down_command_test * Fix up_command --------- Co-authored-by: Bowen <[email protected]> * feat: Laravel-style Collection library (#1134) Merges comprehensive Collection library with 100+ methods for data manipulation. Implements both eager (Collection) and lazy (LazyCollection) evaluation strategies. Closes goravel/goravel#566 Follow-up improvements tracked in: goravel/goravel#883 * Increase route module coverage for factory, provider, and runner wiring paths (#1384) * Initial plan * test(route): cover route factory and service provider paths Co-authored-by: hwbrzzl <[email protected]> * optimize * optimize --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> Co-authored-by: Bowen <[email protected]> * chore: optimize interface (#1389) * Increase crypt module coverage by exercising AES key validation and failure paths (#1385) * Initial plan * test: add crypt AES edge-case coverage Co-authored-by: hwbrzzl <[email protected]> * test: improve readability of crypt key-length cases Co-authored-by: hwbrzzl <[email protected]> * test: address crypt PR feedback and simplify test structure Co-authored-by: hwbrzzl <[email protected]> * test: use configmock EXPECT style in TestNewAES Co-authored-by: hwbrzzl <[email protected]> * test: standardize config mock setup across aes tests Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * Increase filesystem module test coverage for storage, service provider, and file facade paths (#1387) * Initial plan * Add filesystem application and provider coverage tests Co-authored-by: hwbrzzl <[email protected]> * Polish filesystem coverage tests after review feedback Co-authored-by: hwbrzzl <[email protected]> * Refine filesystem tests based on review feedback Co-authored-by: hwbrzzl <[email protected]> * Apply review style suggestions in filesystem tests Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * Increase mail module test coverage to 70%+ with focused unit tests (#1386) * Initial plan * test(mail): add focused unit coverage for application, options, and service provider Co-authored-by: hwbrzzl <[email protected]> * test(mail): address review feedback on test specificity and readability Co-authored-by: hwbrzzl <[email protected]> * test(mail): merge application unit tests and remove untyped mock matchers Co-authored-by: hwbrzzl <[email protected]> * test(mail): deduplicate matchers and tighten queue job assertion Co-authored-by: hwbrzzl <[email protected]> * test(mail): use AnythingOfType and any in application tests Co-authored-by: hwbrzzl <[email protected]> * test(mail): derive bind callback type string from any signature Co-authored-by: hwbrzzl <[email protected]> * test(mail): simplify bind callback type matcher Co-authored-by: hwbrzzl <[email protected]> * test(mail): use AnythingOfType for template render expectations Co-authored-by: hwbrzzl <[email protected]> * test(mail): restore specific MatchedBy assertions per review clarification Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * Increase hash module coverage with targeted tests for driver selection and service provider paths (#1388) * Initial plan * test: increase hash module coverage for driver and provider paths Co-authored-by: hwbrzzl <[email protected]> * test: cover hash provider and driver selection paths Co-authored-by: hwbrzzl <[email protected]> * test: address hash module review feedback Co-authored-by: hwbrzzl <[email protected]> * test: merge hash module tests into application_test Co-authored-by: hwbrzzl <[email protected]> * test: use EXPECT API in hash service provider test Co-authored-by: hwbrzzl <[email protected]> * test: use any alias in hash singleton callback test Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * chore: add AI instructions file (#1393) * Increase core framework coverage via targeted service provider and builder-path tests (#1391) * Initial plan * Add service provider coverage tests for core modules Co-authored-by: hwbrzzl <[email protected]> * Expand core module coverage tests and validate suite Co-authored-by: hwbrzzl <[email protected]> * Revert unintended test module dependency drift Co-authored-by: hwbrzzl <[email protected]> * Address actionable PR review suggestions in coverage tests Co-authored-by: hwbrzzl <[email protected]> * Finalize review feedback handling Co-authored-by: hwbrzzl <[email protected]> * Revert unintended tests module dependency updates Co-authored-by: hwbrzzl <[email protected]> * Tighten provider test matchers per review feedback Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * Increase infrastructure module coverage by adding Process/Packages/Log/Schedule tests and fixing errors.As target forwarding (#1392) * Initial plan * test(errors): cover As/Unwrap/Ignore/Join edge cases Co-authored-by: hwbrzzl <[email protected]> * test(errors): use wrapped error in As coverage test Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module file changes Co-authored-by: hwbrzzl <[email protected]> * test: add coverage for process packages log schedule modules Co-authored-by: hwbrzzl <[email protected]> * test: refine schedule coverage tests per review Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module dependency updates Co-authored-by: hwbrzzl <[email protected]> * test: assert boot no-panic in log and process providers Co-authored-by: hwbrzzl <[email protected]> * chore: finalize review feedback responses for boot test assertions Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module file changes Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * test: expand service-layer coverage across Event, Queue, gRPC, Cache, and Console (#1390) * Initial plan * test(event): cover service provider and queued listener dispatch paths Co-authored-by: hwbrzzl <[email protected]> * chore: finalize event coverage validation Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module dependency updates Co-authored-by: hwbrzzl <[email protected]> * test(event): address review suggestions for robust command matching and queue error path Co-authored-by: hwbrzzl <[email protected]> * chore: finalize PR feedback follow-up Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module file updates Co-authored-by: hwbrzzl <[email protected]> * test: add focused coverage cases for queue grpc cache console Co-authored-by: hwbrzzl <[email protected]> * test: clarify queue nil args in empty chain test Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module dependency updates Co-authored-by: hwbrzzl <[email protected]> * test: avoid nil context in console usage-error test Co-authored-by: hwbrzzl <[email protected]> * chore: finalize lint ci fix validation Co-authored-by: hwbrzzl <[email protected]> * chore: revert unintended tests module dependency drift Co-authored-by: hwbrzzl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hwbrzzl <[email protected]> * chore: Update non-major dependencies (#1399) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore: add generate flag to artisan build command (#1402) * feat: [#911] add query context accessor (#1401) * chore: optimize agents (#1396) * chore: optimize agents * optimize * address comments * Initial plan * fix: backport migrate rollback default handling to v1.17.x Co-authored-by: hwbrzzl <[email protected]> * chore: align branch tree with v1.17.x before backporting rollback fix Co-authored-by: hwbrzzl <[email protected]> * optimize * optimize --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bowen <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: hwbrzzl <[email protected]> Co-authored-by: krishan kumar <[email protected]> Co-authored-by: Bowen <[email protected]> Co-authored-by: Mohan Raj <[email protected]> Co-authored-by: Ahmed M. Ammar <[email protected]> Co-authored-by: 耗子 <[email protected]> Co-authored-by: ALMAS <[email protected]>

feat: [#911] add query context accessor

0e6ee58

almas-x requested a review from a team as a code owner March 10, 2026 05:37

almas-x added the 🚀 Review Ready label Mar 10, 2026

coderabbitai bot reviewed Mar 10, 2026

View reviewed changes

hwbrzzl approved these changes Mar 10, 2026

View reviewed changes

almas-x merged commit 628ed45 into master Mar 10, 2026
18 checks passed

almas-x deleted the almas/#911 branch March 10, 2026 10:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [#911] add query context accessor#1401

feat: [#911] add query context accessor#1401
almas-x merged 1 commit intomasterfrom
almas/#911

almas-x commented Mar 10, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

codecov bot commented Mar 10, 2026 •

edited

Loading

Uh oh!

hwbrzzl commented Mar 10, 2026

Uh oh!

coderabbitai bot commented Mar 10, 2026

Uh oh!

coderabbitai bot commented Mar 10, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Mar 10, 2026

Uh oh!

hwbrzzl left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		// Context gets the context used by the query.
		Context() context.Context

Conversation

almas-x commented Mar 10, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📑 Description

Summary by CodeRabbit

✅ Checks

Uh oh!

codecov bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

hwbrzzl commented Mar 10, 2026

Uh oh!

coderabbitai bot commented Mar 10, 2026

Uh oh!

coderabbitai bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

almas-x commented Mar 10, 2026 •

edited by coderabbitai bot

Loading

codecov bot commented Mar 10, 2026 •

edited

Loading

coderabbitai bot commented Mar 10, 2026 •

edited

Loading