Merge pull request graphql-dotnet#362 from graphql-dotnet/instance

Initial work for supporting a schema builder

Author: joemcbride

README.md

@@ -38,86 +38,103 @@ Define your schema with a top level query object then execute that query.
 
 A more full-featured example including all classes required can be found [here](https://github.com/graphql-dotnet/graphql-dotnet/tree/master/src/GraphQL.StarWars).
 
+### Hello World
+
 ```csharp
-namespace ConsoleApplication
+var schema = Schema.For(@"
+  type Query {
+    hello: String
+  }
+");
+
+var root = new { Hello = "Hello World!" };
+var result = schema.Execute(_ =>
 {
-    using System;
-    using System.Threading.Tasks;
-    using GraphQL;
-    using GraphQL.Http;
-    using GraphQL.Types;
-
-    public class Program
-    {
-        public static void Main(string[] args)
-        {
-          Run();
-        }
-
-        private static async void Run()
-        {
-          Console.WriteLine("Hello GraphQL!");
-
-          var schema = new Schema { Query = new StarWarsQuery() };
-
-          var result = await new DocumentExecuter().ExecuteAsync( _ =>
-          {
-            _.Schema = schema;
-            _.Query = @"
-                query {
-                  hero {
-                    id
-                    name
-                  }
-                }
-              ";
-          }).ConfigureAwait(false);
-
-          var json = new DocumentWriter(indent: true).Write(result);
-
-          Console.WriteLine(json);
-        }
-    }
-
-    public class Droid
-    {
-      public string Id { get; set; }
-      public string Name { get; set; }
-    }
-
-    public class DroidType : ObjectGraphType<Droid>
-    {
-      public DroidType()
-      {
-        Field(x => x.Id).Description("The Id of the Droid.");
-        Field(x => x.Name, nullable: true).Description("The name of the Droid.");
-      }
-    }
-
-    public class StarWarsQuery : ObjectGraphType
-    {
-      public StarWarsQuery()
-      {
-        Field<DroidType>(
-          "hero",
-          resolve: context => new Droid { Id = "1", Name = "R2-D2" }
-        );
-      }
-    }
-}
+  _.Query = "{ hello }";
+  _.Root = root;
+});
+
+Console.WriteLine(result);
 ```
 
-Output
+### Handler/Endpoints
+
+```csharp
+public class Droid
+{
+  public string Id { get; set; }
+  public string Name { get; set; }
+}
+
+public class Query
+{
+  [GraphQLMetadata("hero")]
+  public Droid GetHero()
+  {
+    return new Droid { Id = "123", Name = "R2-D2" };
+  }
+}
+
+var schema = Schema.For(@"
+  type Droid {
+    id: String
+    name: String
+  }
+
+  type Query {
+    hero: Droid
+  }
+", _ => {
+    _.Types.Include<Query>();
+});
+
+var result = schema.Execute(_ =>
+{
+  _.Query = "{ hero { id name } }";
+});
 ```
-Hello GraphQL!
+
+### Parameters
+
+```csharp
+public class Droid
+{
+  public string Id { get; set; }
+  public string Name { get; set; }
+}
+
+public class Query
 {
-  "data": {
-    "hero": {
-      "id": "1",
-      "name": "R2-D2"
-    }
+  private List<Droid> _droids = new List<Droid>
+  {
+    new Droid { Id = "123", Name = "R2-D2" }
+  };
+
+  [GraphQLMetadata("hero")]
+  public Droid GetHero(string id)
+  {
+    return _droids.FirstOrDefault(x => x.Id == id);
   }
 }
+
+var schema = Schema.For(@"
+  type Droid {
+    id: String
+    name: String
+  }
+
+  type Query {
+    hero(id: String): Droid
+  }
+", _ => {
+    _.Types.Include<Query>();
+});
+
+string id = "123";
+var result = schema.Execute(_ =>
+{
+  _.Query = $"{{ hero(id: \"{id}\") {{ id name }} }}";
+});
 ```
 
 ## Roadmap
@@ -204,7 +221,7 @@ publish nuget from MyGet
 ### Running on .NET Core
 The GraphQL.GraphiQLCore project runs on `.NET Core 1.1`. You can run from Visual Studio Code or from the command line using `dotnet run`. When you run the project, you will see the GraphiQL editor open.
 
-When using Visual Studio Code, open to the `./src/GraphQL.GraphiQLCore` folder. You will get a warning "Required assets to build and debug are missing from 'GraphQL.GraphiQLCore'. Add Them?". Choose `Yes`. This will add the necessary launch.json and tasks.json files. 
+When using Visual Studio Code, open to the `./src/GraphQL.GraphiQLCore` folder. You will get a warning "Required assets to build and debug are missing from 'GraphQL.GraphiQLCore'. Add Them?". Choose `Yes`. This will add the necessary launch.json and tasks.json files.
 
 ### Running on OSX with mono
 To run this project on OSX with mono you will need to add some configuration.  Make sure mono is installed and add the following to your bash configuration:
@@ -217,4 +234,3 @@ See the following for more details:
 
 * [Building VS 2017 MSBuild csproj Projects with Mono on Linux](https://stackoverflow.com/questions/42747722/building-vs-2017-msbuild-csproj-projects-with-mono-on-linux)
 * [using .NET Framework as targets framework, the osx/unix build fails](https://github.com/dotnet/netcorecli-fsc/wiki/.NET-Core-SDK-rc4#using-net-framework-as-targets-framework-the-osxunix-build-fails)
-

appveyor.yml

@@ -1,4 +1,4 @@
-version: 0.17.3.{build}
+version: 2.0.0.{build}
 pull_requests:
   do_not_increment_build_number: true
 skip_tags: true
@@ -36,3 +36,4 @@ deploy:
     branch:
       - master
       - dev
+      - instance

package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-dotnet",
-  "version": "0.17.3",
+  "version": "2.0.0",
   "description": "GraphQL for .NET",
   "main": "index.js",
   "scripts": {

src/GraphQL.GraphiQL/Bootstrapper.cs

@@ -1,15 +1,13 @@
-using System.Web.Http.Dependencies;
-using GraphQL.Http;
+using GraphQL.Http;
 using GraphQL.StarWars;
 using GraphQL.StarWars.IoC;
 using GraphQL.StarWars.Types;
-using GraphQL.Types;
 
 namespace GraphQL.GraphiQL
 {
     public class Bootstrapper
     {
-        public IDependencyResolver Resolver()
+        public System.Web.Http.Dependencies.IDependencyResolver Resolver()
         {
             var container = BuildContainer();
             var resolver = new SimpleContainerDependencyResolver(container);
@@ -29,7 +27,7 @@ private ISimpleContainer BuildContainer()
             container.Register<HumanInputType>();
             container.Register<DroidType>();
             container.Register<CharacterInterface>();
-            container.Singleton(new StarWarsSchema(type => (GraphType) container.Get(type)));
+            container.Singleton(new StarWarsSchema(new FuncDependencyResolver(type => container.Get(type))));
 
             return container;
         }

src/GraphQL.GraphiQL/SimpleContainerDependencyResolver.cs

@@ -6,7 +6,7 @@
 
 namespace GraphQL.GraphiQL
 {
-    public class SimpleContainerDependencyResolver : IDependencyResolver
+    public class SimpleContainerDependencyResolver : System.Web.Http.Dependencies.IDependencyResolver
     {
         private readonly ISimpleContainer _container;
 

src/GraphQL.GraphiQLCore/GraphQLMiddleware.cs

@@ -1,10 +1,10 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
 using GraphQL.Http;
+using GraphQL.Types;
 using Microsoft.AspNetCore.Http;
 using Newtonsoft.Json;
 
@@ -29,15 +29,15 @@ public GraphQLMiddleware(
             _writer = writer;
         }
 
-        public async Task Invoke(HttpContext context)
+        public async Task Invoke(HttpContext context, ISchema schema)
         {
             if (!IsGraphQLRequest(context))
             {
-                await _next(context).ConfigureAwait(false);
+                await _next(context);
                 return;
             }
 
-            await ExecuteAsync(context);
+            await ExecuteAsync(context, schema);
         }
 
         private bool IsGraphQLRequest(HttpContext context)
@@ -46,7 +46,7 @@ private bool IsGraphQLRequest(HttpContext context)
                 && string.Equals(context.Request.Method, "POST", StringComparison.OrdinalIgnoreCase);
         }
 
-        private async Task ExecuteAsync(HttpContext context)
+        private async Task ExecuteAsync(HttpContext context, ISchema schema)
         {
             string body;
             using (var streamReader = new StreamReader(context.Request.Body))
@@ -58,10 +58,11 @@ private async Task ExecuteAsync(HttpContext context)
 
             var result = await _executer.ExecuteAsync(_ =>
             {
-                _.Schema = _settings.Schema;
+                _.Schema = schema;
                 _.Query = request.Query;
                 _.OperationName = request.OperationName;
                 _.Inputs = request.Variables.ToInputs();
+                _.UserContext = _settings.BuildUserContext?.Invoke(context);
             });
 
             await WriteResponseAsync(context, result);

src/GraphQL.GraphiQLCore/GraphQLSettings.cs

@@ -1,11 +1,11 @@
-using GraphQL.Types;
+using System;
 using Microsoft.AspNetCore.Http;
 
 namespace GraphQL.GraphiQLCore
 {
     public class GraphQLSettings
     {
         public PathString Path { get; set; } = "/api/graphql";
-        public ISchema Schema { get; set; }
+        public Func<HttpContext, object> BuildUserContext { get; set; }
     }
 }

src/GraphQL.GraphiQLCore/GraphQLUserContext.cs

@@ -0,0 +1,9 @@
+using System.Security.Claims;
+
+namespace GraphQL.GraphiQLCore
+{
+    public class GraphQLUserContext
+    {
+        public ClaimsPrincipal User { get; set; }
+    }
+}

src/GraphQL.GraphiQLCore/Startup.cs

@@ -4,6 +4,7 @@
 using GraphQL.Types;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
@@ -24,7 +25,10 @@ public void ConfigureServices(IServiceCollection services)
             services.AddSingleton<DroidType>();
             services.AddSingleton<CharacterInterface>();
             services.AddSingleton<EpisodeEnum>();
-            services.AddSingleton<ISchema>(s => new StarWarsSchema(type => (GraphType) s.GetService(type)));
+            services.AddSingleton<ISchema>(
+                s => new StarWarsSchema(new FuncDependencyResolver(type => (GraphType) s.GetService(type))));
+
+            services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
         }
 
         public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
@@ -38,7 +42,10 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
 
             app.UseMiddleware<GraphQLMiddleware>(new GraphQLSettings
             {
-                Schema = app.ApplicationServices.GetService<ISchema>()
+                BuildUserContext = ctx => new GraphQLUserContext
+                {
+                    User = ctx.User
+                }
             });
             app.UseDefaultFiles();
             app.UseStaticFiles();

src/GraphQL.StarWars/StarWarsSchema.cs

@@ -1,15 +1,14 @@
-using System;
-using GraphQL.Types;
+using GraphQL.Types;
 
 namespace GraphQL.StarWars
 {
     public class StarWarsSchema : Schema
     {
-        public StarWarsSchema(Func<Type, GraphType> resolveType)
-            : base(resolveType)
+        public StarWarsSchema(IDependencyResolver resolver)
+            : base(resolver)
         {
-            Query = (StarWarsQuery)resolveType(typeof (StarWarsQuery));
-            Mutation = (StarWarsMutation) resolveType(typeof(StarWarsMutation));
+            Query = resolver.Resolve<StarWarsQuery>();
+            Mutation = resolver.Resolve<StarWarsMutation>();
         }
     }
 }