.NET Core 2.2 -> 3.0

Directory.Build.props

@@ -1,24 +1,23 @@
 <Project>
-
   <PropertyGroup>
-    <NetCoreAppVersion>netcoreapp2.2</NetCoreAppVersion>
-    <NetStandardVersion>netstandard2.0</NetStandardVersion>
-    <AspNetCoreVersion>2.2.*</AspNetCoreVersion>
-    <MicrosoftLoggingVersion>2.2.*</MicrosoftLoggingVersion>
-    <MicrosoftConfigurationVersion>2.2.*</MicrosoftConfigurationVersion>
-    <MicrosoftOptionsVersion>2.2.*</MicrosoftOptionsVersion>
-    <EFCoreVersion>2.2.*</EFCoreVersion>
-    <EFCoreToolsVersion>2.2.*</EFCoreToolsVersion>
-    <NpgsqlVersion>4.0.0</NpgsqlVersion>
-    <NpgsqlPostgreSQLVersion>2.1.0</NpgsqlPostgreSQLVersion>
+    <NetCoreAppVersion>netcoreapp3.0</NetCoreAppVersion>
+    <NetStandardVersion>netstandard2.1</NetStandardVersion>
+    <AspNetCoreVersion>3.*</AspNetCoreVersion>
+    <MicrosoftLoggingVersion>3.*</MicrosoftLoggingVersion>
+    <MicrosoftConfigurationVersion>3.*</MicrosoftConfigurationVersion>
+    <MicrosoftOptionsVersion>3.*</MicrosoftOptionsVersion>
+    <EFCoreVersion>3.*</EFCoreVersion>
+    <EFCoreToolsVersion>3.*</EFCoreToolsVersion>
+    <NpgsqlVersion>4.1.1</NpgsqlVersion>
+    <NpgsqlPostgreSQLVersion>3.0.1</NpgsqlPostgreSQLVersion>
     <TuplesVersion>4.5.0</TuplesVersion>
   </PropertyGroup>
 
   <!-- Test Project Dependencies -->
   <PropertyGroup>
-    <TestSdkVersion>15.7.2</TestSdkVersion>
-    <XUnitVersion>2.3.1</XUnitVersion>
-    <BogusVersion>22.1.2</BogusVersion>
-    <MoqVersion>4.8.3</MoqVersion>
+    <TestSdkVersion>16.3.0</TestSdkVersion>
+    <XUnitVersion>2.4.1</XUnitVersion>
+    <BogusVersion>28.4.1</BogusVersion>
+    <MoqVersion>4.13.1</MoqVersion>
   </PropertyGroup>
 </Project>

JsonApiDotnetCore.sln

@@ -41,6 +41,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonApiDotNetCore", "src\Js
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GettingStarted", "src\Examples\GettingStarted\GettingStarted.csproj", "{067FFD7A-C66B-473D-8471-37F5C95DF61C}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IntegrationTests", "test\IntegrationTests\IntegrationTests.csproj", "{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -158,6 +160,18 @@ Global
 		{067FFD7A-C66B-473D-8471-37F5C95DF61C}.Release|x64.Build.0 = Release|Any CPU
 		{067FFD7A-C66B-473D-8471-37F5C95DF61C}.Release|x86.ActiveCfg = Release|Any CPU
 		{067FFD7A-C66B-473D-8471-37F5C95DF61C}.Release|x86.Build.0 = Release|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Debug|x64.Build.0 = Debug|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Debug|x86.Build.0 = Debug|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Release|x64.ActiveCfg = Release|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Release|x64.Build.0 = Release|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Release|x86.ActiveCfg = Release|Any CPU
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -173,6 +187,7 @@ Global
 		{789085E1-048F-4996-B600-791B9CA3A663} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
 		{8BCFF95F-4850-427C-AEDB-B5B4F62B2C7B} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
 		{21D27239-138D-4604-8E49-DCBE41BCE4C8} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
+		{CEB08B86-6BF1-4227-B20F-45AE9C1CC6D9} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {A2421882-8F0A-4905-928F-B550B192F9A4}

README.md

@@ -12,6 +12,19 @@
 
 A framework for building [json:api](http://jsonapi.org/) compliant web APIs. The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection making extensibility incredibly easy.
 
+
+
+## Compatibility
+
+A lot of changes were introduced in v4.0.0, the following chart should help you with compatibility issues between .NET Core versions
+
+| .NET Core Version | JADNC Version |
+| ----------------- | ------------- |
+| 2.0 - 2.2         | v3.*          |
+| 3.*               | v4.*          |
+
+
+
 ## Getting Started
 
 These are some steps you can take to help you understand what this project is and how you can use it:
@@ -53,10 +66,12 @@ public class Article : Identifiable
 ```csharp
 public class ArticlesController : JsonApiController<Article>
 {
-    public ArticlesController(
-        IJsonApiContext jsonApiContext,
-        IResourceService<Article> resourceService) 
-    : base(jsonApiContext, resourceService) { }
+        public ArticlesController(
+            IJsonApiOptions jsonApiOptions,
+            IResourceService<Article> resourceService,
+            ILoggerFactory loggerFactory) 
+            : base(jsonApiOptions, resourceService, loggerFactory)
+        { }
 }
 ```
 
@@ -79,19 +94,18 @@ public class Startup
 
 ### Development
 
-Restore all nuget packages with:
+Restore all NuGet packages with:
 
 ```bash
 dotnet restore
 ```
 
 #### Testing
 
-Running tests locally requires access to a postgresql database.  
-If you have docker installed, this can be propped up via: 
+Running tests locally requires access to a PostgreSQL database.  If you have docker installed, this can be propped up via: 
 
 ```bash
-docker run --rm --name jsonapi-dotnet-core-testing  -e POSTGRES_DB=JsonApiDotNetCoreExample -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432   postgres
+docker run --rm --name jsonapi-dotnet-core-testing  -e POSTGRES_DB=JsonApiDotNetCoreExample -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres
 ```
 
 And then to run the tests:

src/Examples/GettingStarted/GettingStarted.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp2.0</TargetFramework>
+    <TargetFramework>$(NetCoreAppVersion)</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
@@ -14,7 +14,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore" Version="$(AspNetCoreVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="$(EFCoreVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="$(EFCoreVersion)" />
   </ItemGroup>

src/Examples/GettingStarted/Startup.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.EntityFrameworkCore;
@@ -21,11 +21,10 @@ public void ConfigureServices(IServiceCollection services)
                 discover => discover.AddCurrentAssembly(), mvcBuilder: mvcBuilder);
         }
 
-        public void Configure(IApplicationBuilder app, IHostingEnvironment env, SampleDbContext context)
+        public void Configure(IApplicationBuilder app, SampleDbContext context)
         {
             context.Database.EnsureDeleted(); // indicies need to be reset
             context.Database.EnsureCreated();
-
             app.UseJsonApi();
         }
     }

src/Examples/JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj

@@ -13,7 +13,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore" Version="$(AspNetCoreVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Abstractions" Version="$(EFCoreVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Proxies" Version="$(EFCoreVersion)" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="$(MicrosoftConfigurationVersion)" />

src/Examples/JsonApiDotNetCoreExample/Resources/PersonResource.cs

@@ -31,7 +31,7 @@ public Dictionary<string, object> GetMeta()
         {
             return new Dictionary<string, object> {
                 { "copyright", "Copyright 2015 Example Corp." },
-                { "authors", new string[] { "Jared Nance", "Maurits Moeys" } }
+                { "authors", new string[] { "Jared Nance", "Maurits Moeys", "Harro van der Kroft" } }
             };
         }
     }

src/Examples/JsonApiDotNetCoreExample/Resources/UserResource.cs

@@ -26,10 +26,13 @@ private IQueryable<User> FirstCharacterFilter(IQueryable<User> users, FilterQuer
         {
             switch (filterQuery.Operation)
             {
+                // need to cast to list first because getting the first
+                // char in a string is apparently not something LINQ can translate
+                // to a query.
                 case "lt":
-                    return users.Where(u => u.Username[0] < filterQuery.Value[0]);
+                    return users.ToList().Where(u => u.Username.First() < filterQuery.Value[0]).AsQueryable();
                 default:
-                    return users.Where(u => u.Username[0] == filterQuery.Value[0]);
+                    return users.ToList().Where(u => u.Username.First() == filterQuery.Value[0]).AsQueryable();
             }
         }
     }

src/Examples/JsonApiDotNetCoreExample/Startup.cs

@@ -14,18 +14,17 @@ public class Startup
     {
         public readonly IConfiguration Config;
 
-        public Startup(IHostingEnvironment env)
+        public Startup(IWebHostEnvironment env)
         {
             var builder = new ConfigurationBuilder()
                 .SetBasePath(env.ContentRootPath)
                 .AddJsonFile("appsettings.json", optional: true, reloadOnChange: false)
                 .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
                 .AddEnvironmentVariables();
-
             Config = builder.Build();
         }
 
-        public virtual IServiceProvider ConfigureServices(IServiceCollection services)
+        public virtual void ConfigureServices(IServiceCollection services)
         {
             var loggerFactory = new LoggerFactory();
             services
@@ -45,15 +44,15 @@ public virtual IServiceProvider ConfigureServices(IServiceCollection services)
                     options.LoaDatabaseValues = true;
                 },
                 discovery => discovery.AddCurrentAssembly());
-            return services.BuildServiceProvider();
+            services.AddClientSerialization();
         }
 
         public virtual void Configure(
             IApplicationBuilder app,
-            IHostingEnvironment env,
             ILoggerFactory loggerFactory,
             AppDbContext context)
         {
+
             context.Database.EnsureCreated();
             app.UseJsonApi();
         }

src/Examples/NoEntityFrameworkExample/NoEntityFrameworkExample.csproj

@@ -14,8 +14,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore" Version="$(AspNetCoreVersion)" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="$(AspNetCoreVersion)" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="$(MicrosoftLoggingVersion)" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="$(NpgsqlPostgreSQLVersion)" />
     <PackageReference Include="Npgsql" Version="$(NpgsqlVersion)" />

src/Examples/NoEntityFrameworkExample/Startup.cs

@@ -15,7 +15,7 @@ namespace NoEntityFrameworkExample
 {
     public class Startup
     {
-        public Startup(IHostingEnvironment env)
+        public Startup(IWebHostEnvironment env)
         {
             var builder = new ConfigurationBuilder()
                 .SetBasePath(env.ContentRootPath)
@@ -28,7 +28,7 @@ public Startup(IHostingEnvironment env)
         public IConfigurationRoot Configuration { get; }
 
         // This method gets called by the runtime. Use this method to add services to the container.
-        public virtual IServiceProvider ConfigureServices(IServiceCollection services)
+        public virtual void ConfigureServices(IServiceCollection services)
         {
             // Add framework services.
             var mvcBuilder = services.AddMvcCore();
@@ -47,7 +47,6 @@ public virtual IServiceProvider ConfigureServices(IServiceCollection services)
             services.AddSingleton<IConfiguration>(Configuration);
             services.AddSingleton(optionsBuilder.Options);
             services.AddScoped<AppDbContext>();
-            return services.BuildServiceProvider();
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.

src/Examples/ReportsExample/ReportsExample.csproj

@@ -13,8 +13,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore" Version="$(AspNetCoreVersion)" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.Core" Version="$(AspNetCoreVersion)" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="$(MicrosoftLoggingVersion)" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="$(NpgsqlPostgreSQLVersion)" />
     <PackageReference Include="Npgsql" Version="$(NpgsqlVersion)" />

src/Examples/ReportsExample/Startup.cs

@@ -11,7 +11,7 @@ public class Startup
     {
         public readonly IConfiguration Config;
 
-        public Startup(IHostingEnvironment env)
+        public Startup(IWebHostEnvironment env)
         {
             var builder = new ConfigurationBuilder()
                 .SetBasePath(env.ContentRootPath)
@@ -29,10 +29,5 @@ public virtual void ConfigureServices(IServiceCollection services)
                 opt => opt.Namespace = "api", 
                 discovery => discovery.AddCurrentAssembly(), mvcBuilder: mvcBuilder);
         }
-
-        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
-        {
-            app.UseMvc();
-        }
     }
 }

src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs

@@ -42,6 +42,11 @@ public JsonApiApplicationBuilder(IServiceCollection services, IMvcCoreBuilder mv
             _mvcBuilder = mvcBuilder;
         }
 
+        internal void ConfigureLogging()
+        {
+            _services.AddLogging();
+        }
+
         /// <summary>
         /// Executes the action provided by the user to configure <see cref="JsonApiOptions"/>
         /// </summary>
@@ -62,17 +67,17 @@ public void ConfigureMvc()
             _serviceDiscoveryFacade = intermediateProvider.GetRequiredService<IServiceDiscoveryFacade>();
             var exceptionFilterProvider = intermediateProvider.GetRequiredService<IJsonApiExceptionFilterProvider>();
             var typeMatchFilterProvider = intermediateProvider.GetRequiredService<IJsonApiTypeMatchFilterProvider>();
+            var routingConvention = intermediateProvider.GetRequiredService<IJsonApiRoutingConvention>();
 
-            _mvcBuilder.AddMvcOptions(mvcOptions =>
+            _mvcBuilder.AddMvcOptions(options =>
             {
-                mvcOptions.Filters.Add(exceptionFilterProvider.Get());
-                mvcOptions.Filters.Add(typeMatchFilterProvider.Get());
-                mvcOptions.InputFormatters.Insert(0, new JsonApiInputFormatter());
-                mvcOptions.OutputFormatters.Insert(0, new JsonApiOutputFormatter());
+                options.EnableEndpointRouting = true;
+                options.Filters.Add(exceptionFilterProvider.Get());
+                options.Filters.Add(typeMatchFilterProvider.Get());
+                options.InputFormatters.Insert(0, new JsonApiInputFormatter());
+                options.OutputFormatters.Insert(0, new JsonApiOutputFormatter());
+                options.Conventions.Insert(0, routingConvention);
             });
-
-            var routingConvention = intermediateProvider.GetRequiredService<IJsonApiRoutingConvention>();
-            _mvcBuilder.AddMvcOptions(opt => opt.Conventions.Insert(0, routingConvention));
             _services.AddSingleton<IControllerResourceMapping>(routingConvention);
         }
 
@@ -148,7 +153,7 @@ public void ConfigureServices()
             _services.AddSingleton<ILinksConfiguration>(JsonApiOptions);
             _services.AddSingleton(resourceGraph);
             _services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
-            _services.AddSingleton<IResourceGraph>(resourceGraph);
+            _services.AddSingleton(resourceGraph);
             _services.AddSingleton<IResourceContextProvider>(resourceGraph);
             _services.AddScoped<ICurrentRequest, CurrentRequest>();
             _services.AddScoped<IScopedServiceProvider, RequestScopedServiceProvider>();