Skip to content

Commit 8ba2049

Browse files
Shane32Shane32
authored
Update to GraphQL.NET v7 (#58)
1 parent 1e3eb2b commit 8ba2049

29 files changed

+174
-119
lines changed

‎Directory.Build.props

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<ImplicitUsings>true</ImplicitUsings>
2121
<Nullable>enable</Nullable>
2222
<IsPackable>false</IsPackable>
23-
<GraphQLVersion>[5.3.3,6.0.0)</GraphQLVersion>
23+
<GraphQLVersion>7.0.0</GraphQLVersion>
2424
<NoWarn>$(NoWarn);IDE0056;IDE0057</NoWarn>
2525
</PropertyGroup>
2626

‎README.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,7 @@ for changes from previous versions.
3333
### Typical configuration with HTTP middleware
3434

3535
First add the `GraphQL.AspNetCore3` nuget package to your application. It requires
36-
`GraphQL` version 5.3.3 or a later 5.x version.
37-
38-
Second, install the `GraphQL.SystemTextJson` or `GraphQL.NewtonsoftJson` package within your
39-
application if you have not already done so. For best performance, please use the
40-
`GraphQL.SystemTextJson` package.
36+
`GraphQL` version 7.0.0 or a later.
4137

4238
Then update your `Program.cs` or `Startup.cs` to register the schema, the serialization engine,
4339
and optionally the HTTP middleware and WebSocket services. Configure WebSockets and GraphQL
@@ -58,8 +54,7 @@ Below is a complete sample of a .NET 6 console app that hosts a GraphQL endpoint
5854
</PropertyGroup>
5955

6056
<ItemGroup>
61-
<PackageReference Include="GraphQL.AspNetCore3" Version="4.0.1" />
62-
<PackageReference Include="GraphQL.SystemTextJson" Version="5.3.3" />
57+
<PackageReference Include="GraphQL.AspNetCore3" Version="5.0.0" />
6358
</ItemGroup>
6459

6560
</Project>
@@ -264,14 +259,14 @@ if you allow anonymous requests.
264259
#### For individual graphs, fields and query arguments
265260

266261
To configure ASP.NET Core authorization for GraphQL, add the corresponding
267-
validation rule during GraphQL configuration, typically by calling `.AddAuthorization()`
262+
validation rule during GraphQL configuration, typically by calling `.AddAuthorizationRule()`
268263
as shown below:
269264

270265
```csharp
271266
builder.Services.AddGraphQL(b => b
272267
.AddAutoSchema<Query>()
273268
.AddSystemTextJson()
274-
.AddAuthorization());
269+
.AddAuthorizationRule());
275270
```
276271

277272
Both roles and policies are supported for output graph types, fields on output graph types,
@@ -315,7 +310,7 @@ fields are marked with `AllowAnonymous`.
315310

316311
This project does not include user interfaces, such as GraphiQL or Playground,
317312
but you can include references to the ones provided by the [GraphQL Server](https://github.com/graphql-dotnet/server)
318-
repository which work well with ASP.Net Core 3.1+. Below is a list of the nuget packages offered:
313+
repository which work well with ASP.Net Core 2.1+. Below is a list of the nuget packages offered:
319314

320315
| Package | Downloads | NuGet Latest |
321316
|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -408,12 +403,15 @@ and [this](http://www.breachattack.com/#howitworks) for more details.
408403
You may choose to use the .NET Core 2.1 runtime or a .NET Framework runtime.
409404
This library has been tested with .NET Core 2.1 and .NET Framework 4.8.
410405

411-
The only additional requirement is that you must add this code in your `Startup.cs` file:
406+
One additional requirement is that you must add this code in your `Startup.cs` file:
412407

413408
```csharp
414409
services.AddHostApplicationLifetime();
415410
```
416411

412+
You will also need to reference a serializer package such as `GraphQL.NewtonsoftJson`
413+
or `GraphQL.SystemTextJson`, as `GraphQL.SystemTextJson` is not included in this case.
414+
417415
Besides that requirement, all features are supported in exactly the same manner as
418416
when using ASP.NET Core 3.1+. You may find differences in the ASP.NET Core runtime,
419417
such as CORS implementation differences, which are outside the scope of this project.
@@ -513,7 +511,7 @@ and Subscription portions of your schema, as shown below:
513511
builder.Services.AddGraphQL(b => b
514512
.AddSchema<MySchema>()
515513
.AddSystemTextJson()
516-
.AddAuthorization()); // add authorization validation rule
514+
.AddAuthorizationRule()); // add authorization validation rule
517515
518516
var app = builder.Build();
519517
app.UseDeveloperExceptionPage();

‎migration.md

+22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Version history / migration notes
22

3+
## 5.0.0
4+
5+
GraphQL.AspNetCore3 v5 requires GraphQL.NET v7 or newer.
6+
7+
`builder.AddAuthorization()` has been renamed to `builder.AddAuthorizationRule()`.
8+
The old method has been marked as deprecated.
9+
10+
The authorization validation rule and supporting methods have been changed to be
11+
asynchronous, to match the new asynchronous signatures of `IValidationRule` in
12+
GraphQL.NET v7. If you override any methods, they will need to be updated with
13+
the new signature.
14+
15+
The authorization rule now pulls `ClaimsPrincipal` indirectly from
16+
`ExecutionOptions.User`. This value must be set properly from the ASP.NET middleware.
17+
While the default implementation has this update in place, if you override
18+
`GraphQLHttpMiddleware.ExecuteRequestAsync` or do not use the provided ASP.NET
19+
middleware, you must set the value in your code. Another consequence of this
20+
change is that the constructor of `AuthorizationValidationRule` does not require
21+
`IHttpContextAccessor`, and `IHttpContextAccessor` is not required to be registered
22+
within the dependency injection framework (previously provided automatically by
23+
`builder.AddAuthorization()`).
24+
325
## 4.0.0
426

527
Remove `AllowEmptyQuery` option, as this error condition is now handled by the

‎src/GraphQL.AspNetCore3/AuthorizationValidationRule.cs

+4-14
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,19 @@ namespace GraphQL.AspNetCore3;
99
/// </summary>
1010
public class AuthorizationValidationRule : IValidationRule
1111
{
12-
private readonly IHttpContextAccessor _contextAccessor;
13-
14-
/// <inheritdoc cref="AuthorizationValidationRule"/>
15-
public AuthorizationValidationRule(IHttpContextAccessor httpContextAccessor)
16-
{
17-
_contextAccessor = httpContextAccessor ?? throw new ArgumentNullException(nameof(httpContextAccessor));
18-
}
19-
2012
/// <inheritdoc/>
21-
public virtual ValueTask<INodeVisitor?> ValidateAsync(ValidationContext context)
13+
public virtual async ValueTask<INodeVisitor?> ValidateAsync(ValidationContext context)
2214
{
23-
var httpContext = _contextAccessor.HttpContext
24-
?? throw new InvalidOperationException("HttpContext could not be retrieved from IHttpContextAccessor.");
25-
var user = httpContext.User
26-
?? throw new InvalidOperationException("ClaimsPrincipal could not be retrieved from HttpContext.");
15+
var user = context.User
16+
?? throw new InvalidOperationException("User could not be retrieved from ValidationContext. Please be sure it is set in ExecutionOptions.User.");
2717
var provider = context.RequestServices
2818
?? throw new MissingRequestServicesException();
2919
var authService = provider.GetService<IAuthorizationService>()
3020
?? throw new InvalidOperationException("An instance of IAuthorizationService could not be pulled from the dependency injection framework.");
3121

3222
var visitor = new AuthorizationVisitor(context, user, authService);
3323
// if the schema fails authentication, report the error and do not perform any additional authorization checks.
34-
return visitor.ValidateSchema(context) ? new(visitor) : default;
24+
return await visitor.ValidateSchemaAsync(context) ? visitor : null;
3525
}
3626
}
3727

‎src/GraphQL.AspNetCore3/AuthorizationVisitor.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ protected override bool IsInRole(string role)
3535
=> ClaimsPrincipal.IsInRole(role);
3636

3737
/// <inheritdoc/>
38-
protected override AuthorizationResult Authorize(string policy)
39-
=> AuthorizationService.AuthorizeAsync(ClaimsPrincipal, policy).GetAwaiter().GetResult();
38+
protected override ValueTask<AuthorizationResult> AuthorizeAsync(string policy)
39+
=> new(AuthorizationService.AuthorizeAsync(ClaimsPrincipal, policy));
4040
}

‎src/GraphQL.AspNetCore3/AuthorizationVisitorBase.Validation.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ public partial class AuthorizationVisitorBase
1010
/// Validates authorization rules for the schema.
1111
/// Returns a value indicating if validation was successful.
1212
/// </summary>
13-
public virtual bool ValidateSchema(ValidationContext context)
14-
=> Validate(context.Schema, null, context);
13+
public virtual ValueTask<bool> ValidateSchemaAsync(ValidationContext context)
14+
=> ValidateAsync(context.Schema, null, context);
1515

1616
/// <summary>
1717
/// Validate a node that is current within the context.
1818
/// </summary>
19-
private bool Validate(IProvideMetadata obj, ASTNode? node, ValidationContext context)
20-
=> Validate(BuildValidationInfo(node, obj, context));
19+
private ValueTask<bool> ValidateAsync(IProvideMetadata obj, ASTNode? node, ValidationContext context)
20+
=> ValidateAsync(BuildValidationInfo(node, obj, context));
2121

2222
/// <summary>
2323
/// Initializes a new <see cref="ValidationInfo"/> instance for the specified node.
@@ -67,7 +67,7 @@ public readonly record struct ValidationInfo(
6767
/// as this is handled elsewhere.
6868
/// Returns a value indicating if validation was successful for this node.
6969
/// </summary>
70-
protected virtual bool Validate(ValidationInfo info)
70+
protected virtual async ValueTask<bool> ValidateAsync(ValidationInfo info)
7171
{
7272
bool requiresAuthorization = info.Obj.IsAuthorizationRequired();
7373
if (!requiresAuthorization)
@@ -84,7 +84,7 @@ protected virtual bool Validate(ValidationInfo info)
8484
_policyResults ??= new Dictionary<string, AuthorizationResult>();
8585
foreach (var policy in policies) {
8686
if (!_policyResults.TryGetValue(policy, out var result)) {
87-
result = Authorize(policy);
87+
result = await AuthorizeAsync(policy);
8888
_policyResults.Add(policy, result);
8989
}
9090
if (!result.Succeeded) {
@@ -120,7 +120,7 @@ protected virtual bool Validate(ValidationInfo info)
120120
protected abstract bool IsInRole(string role);
121121

122122
/// <inheritdoc cref="IAuthorizationService.AuthorizeAsync(ClaimsPrincipal, object, string)"/>
123-
protected abstract AuthorizationResult Authorize(string policy);
123+
protected abstract ValueTask<AuthorizationResult> AuthorizeAsync(string policy);
124124

125125
/// <summary>
126126
/// Adds a error to the validation context indicating that the user is not authenticated

‎src/GraphQL.AspNetCore3/AuthorizationVisitorBase.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public AuthorizationVisitorBase(ValidationContext context)
1919
private List<TodoInfo>? _todos;
2020

2121
/// <inheritdoc/>
22-
public virtual void Enter(ASTNode node, ValidationContext context)
22+
public virtual async ValueTask EnterAsync(ASTNode node, ValidationContext context)
2323
{
2424
// if the node is the selected operation, or if it is a fragment referenced by the current operation,
2525
// then enable authorization checks on decendant nodes (_checkTree = true)
@@ -58,7 +58,7 @@ public virtual void Enter(ASTNode node, ValidationContext context)
5858

5959
// Fields, unlike types, are validated immediately.
6060
if (!fieldAnonymousAllowed) {
61-
Validate(field, node, context);
61+
await ValidateAsync(field, node, context);
6262
}
6363
}
6464

@@ -92,15 +92,15 @@ public virtual void Enter(ASTNode node, ValidationContext context)
9292
// verify field argument
9393
var arg = context.TypeInfo.GetArgument();
9494
if (arg != null) {
95-
Validate(arg, node, context);
95+
await ValidateAsync(arg, node, context);
9696
}
9797
}
9898
}
9999
}
100100
}
101101

102102
/// <inheritdoc/>
103-
public virtual void Leave(ASTNode node, ValidationContext context)
103+
public virtual async ValueTask LeaveAsync(ASTNode node, ValidationContext context)
104104
{
105105
if (!_checkTree) {
106106
// if we are within a field skipped by a directive, resume auth checks at the appropriate time
@@ -114,30 +114,30 @@ public virtual void Leave(ASTNode node, ValidationContext context)
114114
}
115115
if (node == context.Operation) {
116116
_checkTree = false;
117-
PopAndProcess();
117+
await PopAndProcessAsync();
118118
} else if (node is GraphQLFragmentDefinition fragmentDefinition) {
119119
// once a fragment is done being processed, apply it to all types waiting on fragment checks,
120120
// and process checks for types that are not waiting on any fragments
121121
_checkTree = false;
122122
var fragmentName = fragmentDefinition.FragmentName.Name.StringValue;
123123
var ti = _onlyAnonymousSelected.Pop();
124-
RecursiveResolve(fragmentName, ti, context);
124+
await RecursiveResolveAsync(fragmentName, ti, context);
125125
_fragments ??= new();
126126
_fragments.TryAdd(fragmentName, ti);
127127
} else if (_checkTree && node is GraphQLField) {
128-
PopAndProcess();
128+
await PopAndProcessAsync();
129129
}
130130

131131
// pop the current type info, and validate the type if it does not contain only fields marked
132132
// with AllowAnonymous (assuming it is not waiting on fragments)
133-
void PopAndProcess()
133+
async ValueTask PopAndProcessAsync()
134134
{
135135
var info = _onlyAnonymousSelected.Pop();
136136
var type = context.TypeInfo.GetLastType()?.GetNamedType();
137137
if (type == null)
138138
return;
139139
if (info.AnyAuthenticated || (!info.AnyAnonymous && (info.WaitingOnFragments?.Count ?? 0) == 0)) {
140-
Validate(type, node, context);
140+
await ValidateAsync(type, node, context);
141141
} else if (info.WaitingOnFragments?.Count > 0) {
142142
_todos ??= new();
143143
_todos.Add(new(BuildValidationInfo(node, type, context), info));
@@ -205,7 +205,7 @@ static bool GetDirectiveValue(GraphQLDirective directive, ValidationContext cont
205205
/// Runs when a fragment is added or updated; the fragment might not be waiting on any
206206
/// other fragments, or it still might be.
207207
/// </summary>
208-
private void RecursiveResolve(string fragmentName, TypeInfo ti, ValidationContext context)
208+
private async ValueTask RecursiveResolveAsync(string fragmentName, TypeInfo ti, ValidationContext context)
209209
{
210210
// first see if any other fragments are waiting on this fragment
211211
if (_fragments != null) {
@@ -216,7 +216,7 @@ private void RecursiveResolve(string fragmentName, TypeInfo ti, ValidationContex
216216
ti2.AnyAuthenticated |= ti.AnyAuthenticated;
217217
ti2.AnyAnonymous |= ti.AnyAnonymous;
218218
_fragments[fragment.Key] = ti2;
219-
RecursiveResolve(fragment.Key, ti2, context);
219+
await RecursiveResolveAsync(fragment.Key, ti2, context);
220220
goto Retry; // modifying a collection at runtime is not supported
221221
}
222222
}
@@ -234,7 +234,7 @@ private void RecursiveResolve(string fragmentName, TypeInfo ti, ValidationContex
234234
_todos.RemoveAt(i);
235235
count--;
236236
if (todo.AnyAuthenticated || !todo.AnyAnonymous) {
237-
Validate(todo.ValidationInfo);
237+
await ValidateAsync(todo.ValidationInfo);
238238
}
239239
}
240240
}

‎src/GraphQL.AspNetCore3/GraphQL.AspNetCore3.csproj

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
<ItemGroup Condition="'$(TargetFramework)' != 'netstandard2.0' AND '$(TargetFramework)' != 'netcoreapp2.1'">
1616
<FrameworkReference Include="Microsoft.AspNetCore.App" />
17+
<PackageReference Include="GraphQL.SystemTextJson" Version="$(GraphQLVersion)" />
1718
</ItemGroup>
1819

1920
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0' OR '$(TargetFramework)' == 'netcoreapp2.1'">

‎src/GraphQL.AspNetCore3/GraphQLBuilderExtensions.cs

+8-1
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,17 @@ public static class GraphQLBuilderExtensions
1111
/// Registers <see cref="AuthorizationValidationRule"/> with the dependency injection framework
1212
/// and configures it to be used when executing a request.
1313
/// </summary>
14+
[Obsolete("Please use AddAuthorizationRule")]
1415
public static IGraphQLBuilder AddAuthorization(this IGraphQLBuilder builder)
16+
=> AddAuthorizationRule(builder);
17+
18+
/// <summary>
19+
/// Registers <see cref="AuthorizationValidationRule"/> with the dependency injection framework
20+
/// and configures it to be used when executing a request.
21+
/// </summary>
22+
public static IGraphQLBuilder AddAuthorizationRule(this IGraphQLBuilder builder)
1523
{
1624
builder.AddValidationRule<AuthorizationValidationRule>(true);
17-
builder.Services.TryRegister<IHttpContextAccessor, HttpContextAccessor>(ServiceLifetime.Singleton);
1825
return builder;
1926
}
2027

‎src/GraphQL.AspNetCore3/GraphQLHttpMiddleware.cs

+1
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,7 @@ protected virtual async Task<ExecutionResult> ExecuteRequestAsync(HttpContext co
354354
OperationName = request?.OperationName,
355355
RequestServices = serviceProvider,
356356
UserContext = userContext,
357+
User = context.User,
357358
};
358359
if (!context.WebSockets.IsWebSocketRequest) {
359360
if (HttpMethods.IsGet(context.Request.Method)) {

‎src/GraphQL.AspNetCore3/WebSockets/GraphQLWs/SubscriptionServer.cs

+1
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ protected override async Task<ExecutionResult> ExecuteRequestAsync(OperationMess
196196
OperationName = request.OperationName,
197197
RequestServices = scope.ServiceProvider,
198198
CancellationToken = CancellationToken,
199+
User = Connection.HttpContext.User,
199200
};
200201
if (UserContext != null)
201202
options.UserContext = UserContext;

‎src/GraphQL.AspNetCore3/WebSockets/SubscriptionsTransportWs/SubscriptionServer.cs

+1
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ protected override async Task<ExecutionResult> ExecuteRequestAsync(OperationMess
176176
OperationName = request.OperationName,
177177
RequestServices = scope.ServiceProvider,
178178
CancellationToken = CancellationToken,
179+
User = Connection.HttpContext.User,
179180
};
180181
if (UserContext != null)
181182
options.UserContext = UserContext;

‎src/Samples/AuthorizationSample/AuthorizationSample.csproj

+1-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@
1818
<ItemGroup>
1919
<ProjectReference Include="..\..\GraphQL.AspNetCore3\GraphQL.AspNetCore3.csproj" />
2020
<ProjectReference Include="..\ChatSchema\Chat.csproj" />
21-
<PackageReference Include="GraphQL.Server.Ui.Playground" Version="5.2.1" />
22-
<PackageReference Include="GraphQL.SystemTextJson" Version="$(GraphQLVersion)" />
21+
<PackageReference Include="GraphQL.Server.Ui.Playground" Version="7.0.0" />
2322
</ItemGroup>
2423

2524
</Project>

‎src/Samples/AuthorizationSample/Program.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
builder.Services.AddGraphQL(b => b
3434
.AddAutoSchema<AuthorizationSample.Schema.Query>(s => s.WithMutation<AuthorizationSample.Schema.Mutation>())
3535
.AddSystemTextJson()
36-
.AddAuthorization());
36+
.AddAuthorizationRule());
3737
// ------------------------------------
3838

3939
var app = builder.Build();
@@ -61,11 +61,11 @@
6161
app.UseGraphQL("/graphql");
6262
// configure Playground at "/ui/graphql"
6363
app.UseGraphQLPlayground(
64+
"/ui/graphql",
6465
new GraphQL.Server.Ui.Playground.PlaygroundOptions {
6566
GraphQLEndPoint = new PathString("/graphql"),
6667
SubscriptionsEndPoint = new PathString("/graphql"),
67-
},
68-
"/ui/graphql");
68+
});
6969
// -------------------------------------
7070

7171
app.MapRazorPages();

‎src/Samples/BasicSample/BasicSample.csproj

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
<ItemGroup>
1111
<ProjectReference Include="..\..\GraphQL.AspNetCore3\GraphQL.AspNetCore3.csproj" />
1212
<ProjectReference Include="..\ChatSchema\Chat.csproj" />
13-
<PackageReference Include="GraphQL.Server.Ui.Playground" Version="5.2.1" />
14-
<PackageReference Include="GraphQL.SystemTextJson" Version="$(GraphQLVersion)" />
13+
<PackageReference Include="GraphQL.Server.Ui.Playground" Version="7.0.0" />
1514
</ItemGroup>
1615

1716
</Project>

0 commit comments

Comments
 (0)