Skip to content

[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasonvarga merged 5 commits into from
Mar 25, 2025
Merged

[5.x] Support query scopes in GraphQL #11533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
566e9a5
Support query scopes in REST API
ryanmitchell Oct 3, 2024
9075956
Use handles rather than numeric keys
ryanmitchell Oct 3, 2024
19e9e8a
Support query scopes in GraphQL entries
ryanmitchell Mar 5, 2025
9234837
Merge branch '5.x' into features/query-scopes-in-graphql
jasonvarga Mar 25, 2025
aef4302
It should be query_scope, not filter. Add test.
jasonvarga Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/GraphQL/Middleware/AuthorizeQueryScopes.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
{
$allowedScopes = collect($root->allowedScopes($args));

$forbidden = collect($args['query_scope'] ?? [])
->keys()
->filter(fn ($filter) => ! $allowedScopes->contains($filter));

if ($forbidden->isNotEmpty()) {
throw ValidationException::withMessages([
'query_scope' => 'Forbidden: '.$forbidden->join(', '),
]);
}

return $next($root, $args, $context, $info);
}
}
24 changes: 24 additions & 0 deletions src/GraphQL/Queries/Concerns/ScopesQuery.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
use QueriesConditions;

/**
* @param \Statamic\Contracts\Query\Builder $query
* @param array $scopes
* @return void
*/
private function scopeQuery($query, $scopes)
{
foreach ($scopes as $handle => $value) {
Scope::find($handle)?->apply($query, Arr::wrap($value));
}
}
}
14 changes: 14 additions & 0 deletions src/GraphQL/Queries/EntriesQuery.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
filterQuery as traitFilterQuery;
}

use ScopesQuery;

protected $attributes = [
'name' => 'entries',
];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
AuthorizeSubResources::class,
ResolvePage::class,
AuthorizeFilters::class,
AuthorizeQueryScopes::class,
];

public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
'limit' => GraphQL::int(),
'page' => GraphQL::int(),
'filter' => GraphQL::type(JsonArgument::NAME),
'query_scope' => GraphQL::type(JsonArgument::NAME),
'sort' => GraphQL::listOf(GraphQL::string()),
'site' => GraphQL::string(),
];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

$this->filterQuery($query, $args['filter'] ?? []);

$this->scopeQuery($query, $args['query_scope'] ?? []);

$this->sortQuery($query, $args['sort'] ?? []);

return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
{
return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
}

public function allowedScopes($args)
{
return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
}
}
100 changes: 100 additions & 0 deletions tests/Feature/GraphQL/EntriesTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
['id' => 'a'],
]]]]);
}

#[Test]
public function it_cannot_use_query_scopes_by_default()
{
$this->createEntries();

$query = <<<'GQL'
{
entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
data {
id
title
}
}
}
GQL;

$this
->withoutExceptionHandling()
->post('/graphql', ['query' => $query])
->assertJson([
'errors' => [[
'message' => 'validation',
'extensions' => [
'validation' => [
'query_scope' => ['Forbidden: test_scope'],
],
],
]],
'data' => [
'entries' => null,
],
]);
}

#[Test]
public function it_can_use_a_query_scope_when_configuration_allows_for_it()
{
$this->createEntries();

ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
ResourceAuthorizer::makePartial();

app('statamic.scopes')['test_scope'] = TestScope::class;

config()->set('statamic.graphql.resources.collections.pages', [
'allowed_query_scopes' => ['test_scope'],
]);

$query = <<<'GQL'
{
entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
data {
id
title
}
}
}
GQL;

$this
->withoutExceptionHandling()
->post('/graphql', ['query' => $query])
->assertGqlOk()
->assertExactJson(['data' => ['entries' => ['data' => [
['id' => '1', 'title' => 'Standard Blog Post'],
]]]]);

$query = <<<'GQL'
{
entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
data {
id
title
}
}
}
GQL;

$this
->withoutExceptionHandling()
->post('/graphql', ['query' => $query])
->assertGqlOk()
->assertExactJson(['data' => ['entries' => ['data' => [
['id' => '2', 'title' => 'Art Directed Blog Post'],
['id' => '3', 'title' => 'Event One'],
['id' => '4', 'title' => 'Event Two'],
['id' => '5', 'title' => 'Hamburger'],
]]]]);
}
}

class TestScope extends Scope
{
public function apply($query, $values)
{
$query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[5.x] Support query scopes in GraphQL by ryanmitchell · Pull Request #11533 · statamic/cms · GitHub
Skip to content
[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 5 commits into

from

Mar 25, 2025
 Merged


[5.x] Support query scopes in GraphQL
#11533
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
566e9a5

Support query scopes in REST API


ryanmitchell Oct 3, 2024
9075956

Use handles rather than numeric keys


ryanmitchell Oct 3, 2024
19e9e8a

Support query scopes in GraphQL entries


ryanmitchell Mar 5, 2025
9234837

Merge branch '5.x' into features/query-scopes-in-graphql


jasonvarga Mar 25, 2025
aef4302

It should be query_scope, not filter. Add test.


jasonvarga Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 28 additions & 0 deletions
src/GraphQL/Middleware/AuthorizeQueryScopes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
 public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
 {
 $allowedScopes = collect($root->allowedScopes($args));

 $forbidden = collect($args['query_scope'] ?? [])
 ->keys()
 ->filter(fn ($filter) => ! $allowedScopes->contains($filter));

 if ($forbidden->isNotEmpty()) {
 throw ValidationException::withMessages([
 'query_scope' => 'Forbidden: '.$forbidden->join(', '),
 ]);
 }

 return $next($root, $args, $context, $info);
 }
}

24 changes: 24 additions & 0 deletions
src/GraphQL/Queries/Concerns/ScopesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
 use QueriesConditions;

 /**
 * @param \Statamic\Contracts\Query\Builder $query
 * @param array $scopes
 * @return void
 */
 private function scopeQuery($query, $scopes)
 {
 foreach ($scopes as $handle => $value) {
 Scope::find($handle)?->apply($query, Arr::wrap($value));
 }
 }
}

14 changes: 14 additions & 0 deletions
src/GraphQL/Queries/EntriesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
 filterQuery as traitFilterQuery;
 }

 use ScopesQuery;

 protected $attributes = [
 'name' => 'entries',
 ];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
 AuthorizeSubResources::class,
 ResolvePage::class,
 AuthorizeFilters::class,
 AuthorizeQueryScopes::class,
 ];

 public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
 'limit' => GraphQL::int(),
 'page' => GraphQL::int(),
 'filter' => GraphQL::type(JsonArgument::NAME),
 'query_scope' => GraphQL::type(JsonArgument::NAME),
 'sort' => GraphQL::listOf(GraphQL::string()),
 'site' => GraphQL::string(),
 ];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

 $this->filterQuery($query, $args['filter'] ?? []);

 $this->scopeQuery($query, $args['query_scope'] ?? []);

 $this->sortQuery($query, $args['sort'] ?? []);

 return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
 {
 return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }

 public function allowedScopes($args)
 {
 return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }
}

100 changes: 100 additions & 0 deletions
tests/Feature/GraphQL/EntriesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
 ['id' => 'a'],
 ]]]]);
 }

 #[Test]
 public function it_cannot_use_query_scopes_by_default()
 {
 $this->createEntries();

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertJson([
 'errors' => [[
 'message' => 'validation',
 'extensions' => [
 'validation' => [
 'query_scope' => ['Forbidden: test_scope'],
 ],
 ],
 ]],
 'data' => [
 'entries' => null,
 ],
 ]);
 }

 #[Test]
 public function it_can_use_a_query_scope_when_configuration_allows_for_it()
 {
 $this->createEntries();

 ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
 ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
 ResourceAuthorizer::makePartial();

 app('statamic.scopes')['test_scope'] = TestScope::class;

 config()->set('statamic.graphql.resources.collections.pages', [
 'allowed_query_scopes' => ['test_scope'],
 ]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '1', 'title' => 'Standard Blog Post'],
 ]]]]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '2', 'title' => 'Art Directed Blog Post'],
 ['id' => '3', 'title' => 'Event One'],
 ['id' => '4', 'title' => 'Event Two'],
 ['id' => '5', 'title' => 'Hamburger'],
 ]]]]);
 }
}

class TestScope extends Scope
{
 public function apply($query, $values)
 {
 $query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Support query scopes in GraphQL by ryanmitchell · Pull Request #11533 · statamic/cms · GitHub
Skip to content
[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 5 commits into

from

Mar 25, 2025
 Merged


[5.x] Support query scopes in GraphQL
#11533
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
566e9a5

Support query scopes in REST API


ryanmitchell Oct 3, 2024
9075956

Use handles rather than numeric keys


ryanmitchell Oct 3, 2024
19e9e8a

Support query scopes in GraphQL entries


ryanmitchell Mar 5, 2025
9234837

Merge branch '5.x' into features/query-scopes-in-graphql


jasonvarga Mar 25, 2025
aef4302

It should be query_scope, not filter. Add test.


jasonvarga Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 28 additions & 0 deletions
src/GraphQL/Middleware/AuthorizeQueryScopes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
 public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
 {
 $allowedScopes = collect($root->allowedScopes($args));

 $forbidden = collect($args['query_scope'] ?? [])
 ->keys()
 ->filter(fn ($filter) => ! $allowedScopes->contains($filter));

 if ($forbidden->isNotEmpty()) {
 throw ValidationException::withMessages([
 'query_scope' => 'Forbidden: '.$forbidden->join(', '),
 ]);
 }

 return $next($root, $args, $context, $info);
 }
}

24 changes: 24 additions & 0 deletions
src/GraphQL/Queries/Concerns/ScopesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
 use QueriesConditions;

 /**
 * @param \Statamic\Contracts\Query\Builder $query
 * @param array $scopes
 * @return void
 */
 private function scopeQuery($query, $scopes)
 {
 foreach ($scopes as $handle => $value) {
 Scope::find($handle)?->apply($query, Arr::wrap($value));
 }
 }
}

14 changes: 14 additions & 0 deletions
src/GraphQL/Queries/EntriesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
 filterQuery as traitFilterQuery;
 }

 use ScopesQuery;

 protected $attributes = [
 'name' => 'entries',
 ];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
 AuthorizeSubResources::class,
 ResolvePage::class,
 AuthorizeFilters::class,
 AuthorizeQueryScopes::class,
 ];

 public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
 'limit' => GraphQL::int(),
 'page' => GraphQL::int(),
 'filter' => GraphQL::type(JsonArgument::NAME),
 'query_scope' => GraphQL::type(JsonArgument::NAME),
 'sort' => GraphQL::listOf(GraphQL::string()),
 'site' => GraphQL::string(),
 ];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

 $this->filterQuery($query, $args['filter'] ?? []);

 $this->scopeQuery($query, $args['query_scope'] ?? []);

 $this->sortQuery($query, $args['sort'] ?? []);

 return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
 {
 return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }

 public function allowedScopes($args)
 {
 return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }
}

100 changes: 100 additions & 0 deletions
tests/Feature/GraphQL/EntriesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
 ['id' => 'a'],
 ]]]]);
 }

 #[Test]
 public function it_cannot_use_query_scopes_by_default()
 {
 $this->createEntries();

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertJson([
 'errors' => [[
 'message' => 'validation',
 'extensions' => [
 'validation' => [
 'query_scope' => ['Forbidden: test_scope'],
 ],
 ],
 ]],
 'data' => [
 'entries' => null,
 ],
 ]);
 }

 #[Test]
 public function it_can_use_a_query_scope_when_configuration_allows_for_it()
 {
 $this->createEntries();

 ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
 ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
 ResourceAuthorizer::makePartial();

 app('statamic.scopes')['test_scope'] = TestScope::class;

 config()->set('statamic.graphql.resources.collections.pages', [
 'allowed_query_scopes' => ['test_scope'],
 ]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '1', 'title' => 'Standard Blog Post'],
 ]]]]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '2', 'title' => 'Art Directed Blog Post'],
 ['id' => '3', 'title' => 'Event One'],
 ['id' => '4', 'title' => 'Event Two'],
 ['id' => '5', 'title' => 'Hamburger'],
 ]]]]);
 }
}

class TestScope extends Scope
{
 public function apply($query, $values)
 {
 $query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Support query scopes in GraphQL by ryanmitchell · Pull Request #11533 · statamic/cms · GitHub
Skip to content
[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 5 commits into

from

Mar 25, 2025
 Merged


[5.x] Support query scopes in GraphQL
#11533
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
566e9a5

Support query scopes in REST API


ryanmitchell Oct 3, 2024
9075956

Use handles rather than numeric keys


ryanmitchell Oct 3, 2024
19e9e8a

Support query scopes in GraphQL entries


ryanmitchell Mar 5, 2025
9234837

Merge branch '5.x' into features/query-scopes-in-graphql


jasonvarga Mar 25, 2025
aef4302

It should be query_scope, not filter. Add test.


jasonvarga Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 28 additions & 0 deletions
src/GraphQL/Middleware/AuthorizeQueryScopes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
 public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
 {
 $allowedScopes = collect($root->allowedScopes($args));

 $forbidden = collect($args['query_scope'] ?? [])
 ->keys()
 ->filter(fn ($filter) => ! $allowedScopes->contains($filter));

 if ($forbidden->isNotEmpty()) {
 throw ValidationException::withMessages([
 'query_scope' => 'Forbidden: '.$forbidden->join(', '),
 ]);
 }

 return $next($root, $args, $context, $info);
 }
}

24 changes: 24 additions & 0 deletions
src/GraphQL/Queries/Concerns/ScopesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
 use QueriesConditions;

 /**
 * @param \Statamic\Contracts\Query\Builder $query
 * @param array $scopes
 * @return void
 */
 private function scopeQuery($query, $scopes)
 {
 foreach ($scopes as $handle => $value) {
 Scope::find($handle)?->apply($query, Arr::wrap($value));
 }
 }
}

14 changes: 14 additions & 0 deletions
src/GraphQL/Queries/EntriesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
 filterQuery as traitFilterQuery;
 }

 use ScopesQuery;

 protected $attributes = [
 'name' => 'entries',
 ];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
 AuthorizeSubResources::class,
 ResolvePage::class,
 AuthorizeFilters::class,
 AuthorizeQueryScopes::class,
 ];

 public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
 'limit' => GraphQL::int(),
 'page' => GraphQL::int(),
 'filter' => GraphQL::type(JsonArgument::NAME),
 'query_scope' => GraphQL::type(JsonArgument::NAME),
 'sort' => GraphQL::listOf(GraphQL::string()),
 'site' => GraphQL::string(),
 ];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

 $this->filterQuery($query, $args['filter'] ?? []);

 $this->scopeQuery($query, $args['query_scope'] ?? []);

 $this->sortQuery($query, $args['sort'] ?? []);

 return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
 {
 return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }

 public function allowedScopes($args)
 {
 return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }
}

100 changes: 100 additions & 0 deletions
tests/Feature/GraphQL/EntriesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
 ['id' => 'a'],
 ]]]]);
 }

 #[Test]
 public function it_cannot_use_query_scopes_by_default()
 {
 $this->createEntries();

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertJson([
 'errors' => [[
 'message' => 'validation',
 'extensions' => [
 'validation' => [
 'query_scope' => ['Forbidden: test_scope'],
 ],
 ],
 ]],
 'data' => [
 'entries' => null,
 ],
 ]);
 }

 #[Test]
 public function it_can_use_a_query_scope_when_configuration_allows_for_it()
 {
 $this->createEntries();

 ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
 ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
 ResourceAuthorizer::makePartial();

 app('statamic.scopes')['test_scope'] = TestScope::class;

 config()->set('statamic.graphql.resources.collections.pages', [
 'allowed_query_scopes' => ['test_scope'],
 ]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '1', 'title' => 'Standard Blog Post'],
 ]]]]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '2', 'title' => 'Art Directed Blog Post'],
 ['id' => '3', 'title' => 'Event One'],
 ['id' => '4', 'title' => 'Event Two'],
 ['id' => '5', 'title' => 'Hamburger'],
 ]]]]);
 }
}

class TestScope extends Scope
{
 public function apply($query, $values)
 {
 $query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[5.x] Support query scopes in GraphQL by ryanmitchell · Pull Request #11533 · statamic/cms · GitHub
Skip to content
[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 5 commits into

from

Mar 25, 2025
 Merged


[5.x] Support query scopes in GraphQL
#11533
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
566e9a5

Support query scopes in REST API


ryanmitchell Oct 3, 2024
9075956

Use handles rather than numeric keys


ryanmitchell Oct 3, 2024
19e9e8a

Support query scopes in GraphQL entries


ryanmitchell Mar 5, 2025
9234837

Merge branch '5.x' into features/query-scopes-in-graphql


jasonvarga Mar 25, 2025
aef4302

It should be query_scope, not filter. Add test.


jasonvarga Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 28 additions & 0 deletions
src/GraphQL/Middleware/AuthorizeQueryScopes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
 public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
 {
 $allowedScopes = collect($root->allowedScopes($args));

 $forbidden = collect($args['query_scope'] ?? [])
 ->keys()
 ->filter(fn ($filter) => ! $allowedScopes->contains($filter));

 if ($forbidden->isNotEmpty()) {
 throw ValidationException::withMessages([
 'query_scope' => 'Forbidden: '.$forbidden->join(', '),
 ]);
 }

 return $next($root, $args, $context, $info);
 }
}

24 changes: 24 additions & 0 deletions
src/GraphQL/Queries/Concerns/ScopesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
 use QueriesConditions;

 /**
 * @param \Statamic\Contracts\Query\Builder $query
 * @param array $scopes
 * @return void
 */
 private function scopeQuery($query, $scopes)
 {
 foreach ($scopes as $handle => $value) {
 Scope::find($handle)?->apply($query, Arr::wrap($value));
 }
 }
}

14 changes: 14 additions & 0 deletions
src/GraphQL/Queries/EntriesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
 filterQuery as traitFilterQuery;
 }

 use ScopesQuery;

 protected $attributes = [
 'name' => 'entries',
 ];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
 AuthorizeSubResources::class,
 ResolvePage::class,
 AuthorizeFilters::class,
 AuthorizeQueryScopes::class,
 ];

 public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
 'limit' => GraphQL::int(),
 'page' => GraphQL::int(),
 'filter' => GraphQL::type(JsonArgument::NAME),
 'query_scope' => GraphQL::type(JsonArgument::NAME),
 'sort' => GraphQL::listOf(GraphQL::string()),
 'site' => GraphQL::string(),
 ];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

 $this->filterQuery($query, $args['filter'] ?? []);

 $this->scopeQuery($query, $args['query_scope'] ?? []);

 $this->sortQuery($query, $args['sort'] ?? []);

 return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
 {
 return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }

 public function allowedScopes($args)
 {
 return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }
}

100 changes: 100 additions & 0 deletions
tests/Feature/GraphQL/EntriesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
 ['id' => 'a'],
 ]]]]);
 }

 #[Test]
 public function it_cannot_use_query_scopes_by_default()
 {
 $this->createEntries();

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertJson([
 'errors' => [[
 'message' => 'validation',
 'extensions' => [
 'validation' => [
 'query_scope' => ['Forbidden: test_scope'],
 ],
 ],
 ]],
 'data' => [
 'entries' => null,
 ],
 ]);
 }

 #[Test]
 public function it_can_use_a_query_scope_when_configuration_allows_for_it()
 {
 $this->createEntries();

 ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
 ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
 ResourceAuthorizer::makePartial();

 app('statamic.scopes')['test_scope'] = TestScope::class;

 config()->set('statamic.graphql.resources.collections.pages', [
 'allowed_query_scopes' => ['test_scope'],
 ]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '1', 'title' => 'Standard Blog Post'],
 ]]]]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '2', 'title' => 'Art Directed Blog Post'],
 ['id' => '3', 'title' => 'Event One'],
 ['id' => '4', 'title' => 'Event Two'],
 ['id' => '5', 'title' => 'Hamburger'],
 ]]]]);
 }
}

class TestScope extends Scope
{
 public function apply($query, $values)
 {
 $query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Support query scopes in GraphQL by ryanmitchell · Pull Request #11533 · statamic/cms · GitHub
Skip to content
[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 5 commits into

from

Mar 25, 2025
 Merged


[5.x] Support query scopes in GraphQL
#11533
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
566e9a5

Support query scopes in REST API


ryanmitchell Oct 3, 2024
9075956

Use handles rather than numeric keys


ryanmitchell Oct 3, 2024
19e9e8a

Support query scopes in GraphQL entries


ryanmitchell Mar 5, 2025
9234837

Merge branch '5.x' into features/query-scopes-in-graphql


jasonvarga Mar 25, 2025
aef4302

It should be query_scope, not filter. Add test.


jasonvarga Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 28 additions & 0 deletions
src/GraphQL/Middleware/AuthorizeQueryScopes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
 public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
 {
 $allowedScopes = collect($root->allowedScopes($args));

 $forbidden = collect($args['query_scope'] ?? [])
 ->keys()
 ->filter(fn ($filter) => ! $allowedScopes->contains($filter));

 if ($forbidden->isNotEmpty()) {
 throw ValidationException::withMessages([
 'query_scope' => 'Forbidden: '.$forbidden->join(', '),
 ]);
 }

 return $next($root, $args, $context, $info);
 }
}

24 changes: 24 additions & 0 deletions
src/GraphQL/Queries/Concerns/ScopesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
 use QueriesConditions;

 /**
 * @param \Statamic\Contracts\Query\Builder $query
 * @param array $scopes
 * @return void
 */
 private function scopeQuery($query, $scopes)
 {
 foreach ($scopes as $handle => $value) {
 Scope::find($handle)?->apply($query, Arr::wrap($value));
 }
 }
}

14 changes: 14 additions & 0 deletions
src/GraphQL/Queries/EntriesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
 filterQuery as traitFilterQuery;
 }

 use ScopesQuery;

 protected $attributes = [
 'name' => 'entries',
 ];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
 AuthorizeSubResources::class,
 ResolvePage::class,
 AuthorizeFilters::class,
 AuthorizeQueryScopes::class,
 ];

 public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
 'limit' => GraphQL::int(),
 'page' => GraphQL::int(),
 'filter' => GraphQL::type(JsonArgument::NAME),
 'query_scope' => GraphQL::type(JsonArgument::NAME),
 'sort' => GraphQL::listOf(GraphQL::string()),
 'site' => GraphQL::string(),
 ];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

 $this->filterQuery($query, $args['filter'] ?? []);

 $this->scopeQuery($query, $args['query_scope'] ?? []);

 $this->sortQuery($query, $args['sort'] ?? []);

 return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
 {
 return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }

 public function allowedScopes($args)
 {
 return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }
}

100 changes: 100 additions & 0 deletions
tests/Feature/GraphQL/EntriesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
 ['id' => 'a'],
 ]]]]);
 }

 #[Test]
 public function it_cannot_use_query_scopes_by_default()
 {
 $this->createEntries();

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertJson([
 'errors' => [[
 'message' => 'validation',
 'extensions' => [
 'validation' => [
 'query_scope' => ['Forbidden: test_scope'],
 ],
 ],
 ]],
 'data' => [
 'entries' => null,
 ],
 ]);
 }

 #[Test]
 public function it_can_use_a_query_scope_when_configuration_allows_for_it()
 {
 $this->createEntries();

 ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
 ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
 ResourceAuthorizer::makePartial();

 app('statamic.scopes')['test_scope'] = TestScope::class;

 config()->set('statamic.graphql.resources.collections.pages', [
 'allowed_query_scopes' => ['test_scope'],
 ]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '1', 'title' => 'Standard Blog Post'],
 ]]]]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '2', 'title' => 'Art Directed Blog Post'],
 ['id' => '3', 'title' => 'Event One'],
 ['id' => '4', 'title' => 'Event Two'],
 ['id' => '5', 'title' => 'Hamburger'],
 ]]]]);
 }
}

class TestScope extends Scope
{
 public function apply($query, $values)
 {
 $query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
[5.x] Support query scopes in GraphQL by ryanmitchell · Pull Request #11533 · statamic/cms · GitHub
Skip to content
[5.x] Support query scopes in GraphQL#11533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 5 commits into

from

Mar 25, 2025
 Merged


[5.x] Support query scopes in GraphQL
#11533
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
566e9a5

Support query scopes in REST API


ryanmitchell Oct 3, 2024
9075956

Use handles rather than numeric keys


ryanmitchell Oct 3, 2024
19e9e8a

Support query scopes in GraphQL entries


ryanmitchell Mar 5, 2025
9234837

Merge branch '5.x' into features/query-scopes-in-graphql


jasonvarga Mar 25, 2025
aef4302

It should be query_scope, not filter. Add test.


jasonvarga Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 28 additions & 0 deletions
src/GraphQL/Middleware/AuthorizeQueryScopes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
<?php

namespace Statamic\GraphQL\Middleware;

use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Validation\ValidationException;
use Rebing\GraphQL\Support\Middleware;

class AuthorizeQueryScopes extends Middleware
{
 public function handle($root, $args, $context, ResolveInfo $info, Closure $next)
 {
 $allowedScopes = collect($root->allowedScopes($args));

 $forbidden = collect($args['query_scope'] ?? [])
 ->keys()
 ->filter(fn ($filter) => ! $allowedScopes->contains($filter));

 if ($forbidden->isNotEmpty()) {
 throw ValidationException::withMessages([
 'query_scope' => 'Forbidden: '.$forbidden->join(', '),
 ]);
 }

 return $next($root, $args, $context, $info);
 }
}

24 changes: 24 additions & 0 deletions
src/GraphQL/Queries/Concerns/ScopesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<?php

namespace Statamic\GraphQL\Queries\Concerns;

use Statamic\Facades\Scope;
use Statamic\Support\Arr;
use Statamic\Tags\Concerns\QueriesConditions;

trait ScopesQuery
{
 use QueriesConditions;

 /**
 * @param \Statamic\Contracts\Query\Builder $query
 * @param array $scopes
 * @return void
 */
 private function scopeQuery($query, $scopes)
 {
 foreach ($scopes as $handle => $value) {
 Scope::find($handle)?->apply($query, Arr::wrap($value));
 }
 }
}

14 changes: 14 additions & 0 deletions
src/GraphQL/Queries/EntriesQuery.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,17 @@
namespace Statamic\GraphQL\Queries;

use Facades\Statamic\API\FilterAuthorizer;
use Facades\Statamic\API\QueryScopeAuthorizer;
use Facades\Statamic\API\ResourceAuthorizer;
use GraphQL\Type\Definition\Type;
use Statamic\Facades\Entry;
use Statamic\Facades\GraphQL;
use Statamic\GraphQL\Middleware\AuthorizeFilters;
use Statamic\GraphQL\Middleware\AuthorizeQueryScopes;
use Statamic\GraphQL\Middleware\AuthorizeSubResources;
use Statamic\GraphQL\Middleware\ResolvePage;
use Statamic\GraphQL\Queries\Concerns\FiltersQuery;
use Statamic\GraphQL\Queries\Concerns\ScopesQuery;
use Statamic\GraphQL\Types\EntryInterface;
use Statamic\GraphQL\Types\JsonArgument;
use Statamic\Support\Str;
Expand All@@ -21,6 +24,8 @@ class EntriesQuery extends Query
 filterQuery as traitFilterQuery;
 }

 use ScopesQuery;

 protected $attributes = [
 'name' => 'entries',
 ];
Expand All@@ -29,6 +34,7 @@ class EntriesQuery extends Query
 AuthorizeSubResources::class,
 ResolvePage::class,
 AuthorizeFilters::class,
 AuthorizeQueryScopes::class,
 ];

 public function type(): Type
Expand All@@ -43,6 +49,7 @@ public function args(): array
 'limit' => GraphQL::int(),
 'page' => GraphQL::int(),
 'filter' => GraphQL::type(JsonArgument::NAME),
 'query_scope' => GraphQL::type(JsonArgument::NAME),
 'sort' => GraphQL::listOf(GraphQL::string()),
 'site' => GraphQL::string(),
 ];
Expand All@@ -60,6 +67,8 @@ public function resolve($root, $args)

 $this->filterQuery($query, $args['filter'] ?? []);

 $this->scopeQuery($query, $args['query_scope'] ?? []);

 $this->sortQuery($query, $args['sort'] ?? []);

 return $query->paginate($args['limit'] ?? 1000);
Expand DownExpand Up@@ -105,4 +114,9 @@ public function allowedFilters($args)
 {
 return FilterAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }

 public function allowedScopes($args)
 {
 return QueryScopeAuthorizer::allowedForSubResources('graphql', 'collections', $args['collection'] ?? '*');
 }
}

100 changes: 100 additions & 0 deletions
tests/Feature/GraphQL/EntriesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Statamic\Facades\Blueprint;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
use Statamic\Query\Scopes\Scope;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

Expand DownExpand Up@@ -949,4 +950,103 @@ public function it_filters_out_past_entries_from_past_private_collection()
 ['id' => 'a'],
 ]]]]);
 }

 #[Test]
 public function it_cannot_use_query_scopes_by_default()
 {
 $this->createEntries();

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertJson([
 'errors' => [[
 'message' => 'validation',
 'extensions' => [
 'validation' => [
 'query_scope' => ['Forbidden: test_scope'],
 ],
 ],
 ]],
 'data' => [
 'entries' => null,
 ],
 ]);
 }

 #[Test]
 public function it_can_use_a_query_scope_when_configuration_allows_for_it()
 {
 $this->createEntries();

 ResourceAuthorizer::shouldReceive('isAllowed')->with('graphql', 'collections')->andReturnTrue();
 ResourceAuthorizer::shouldReceive('allowedSubResources')->with('graphql', 'collections')->andReturn(Collection::handles()->all());
 ResourceAuthorizer::makePartial();

 app('statamic.scopes')['test_scope'] = TestScope::class;

 config()->set('statamic.graphql.resources.collections.pages', [
 'allowed_query_scopes' => ['test_scope'],
 ]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "is", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '1', 'title' => 'Standard Blog Post'],
 ]]]]);

 $query = <<<'GQL'
{
 entries(query_scope: { test_scope: { operator: "isnt", value: 1 }}) {
 data {
 id
 title
 }
 }
}
GQL;

 $this
 ->withoutExceptionHandling()
 ->post('/graphql', ['query' => $query])
 ->assertGqlOk()
 ->assertExactJson(['data' => ['entries' => ['data' => [
 ['id' => '2', 'title' => 'Art Directed Blog Post'],
 ['id' => '3', 'title' => 'Event One'],
 ['id' => '4', 'title' => 'Event Two'],
 ['id' => '5', 'title' => 'Hamburger'],
 ]]]]);
 }
}

class TestScope extends Scope
{
 public function apply($query, $values)
 {
 $query->where('id', $values['operator'] == 'is' ? '=' : '!=', $values['value']);
 }
}