asp.net – Dev_Or

Asp.Net Core Api Versioning

25 junio, 201725 junio, 2017 Carlos Landeras

¡Hola a todos!

En esta nueva entrega de PlainTV, mi compañero Luis Ruiz Pavón me entrevista y hablamos sobre el versionado de Web Api en .NET Core. Gracias al paquete Microsoft.AspNetCore.Versioning, una tarea tediosa y compleja como era versionar nuestros controladores se vuelve sencilla y cómoda.

¡No te lo pierdas!

Asp.net Core with SignalR server and Autofac

3 noviembre, 20168 febrero, 2017 Carlos Landeras

SignalR server for asp.net core is currently in version 0.2.0. It has not been released yet to the official nuget repositories, so we must configure our project to use the asp.net core dev feed to obtain SignalR related packages.
Autofac for asp.net core still does not have the hubs registration extensions that we are used to when using full framework packages, but we will see how we can write them from scratch.

First of all we create a new asp.net core web project and we create a NuGet.config file so we can specify the core devevelopment NuGet feed so we can restore the websockets and SignalR packages.

The NuGet.config file should look like this:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
   <packageSources>
       <add key="AspNetCore" value="https://dotnet.myget.org/F/aspnetcore-ci-dev/api/v3/index.json" />
       <add key="NuGet" value="https://api.nuget.org/v3/index.json" />
   </packageSources>
</configuration>

<?xml version="1.0" encoding="utf-8"?>

</packageSources>

</configuration>

Once created the nuget file, we should add the dependencies to project.json. The dependencies to use SignalR and autofac are shown below:

"Microsoft.AspNetCore.SignalR.Server": "0.2.0-*",
"Microsoft.AspNetCore.WebSockets": "0.2.0-*",
"Autofac.Extensions.DependencyInjection": "4.0.0"

"Microsoft.AspNetCore.SignalR.Server": "0.2.0-*",

"Microsoft.AspNetCore.WebSockets": "0.2.0-*",

"Autofac.Extensions.DependencyInjection": "4.0.0"

We are now set to start configuring our hubs!. As an example we are going to create a ChatHub that will receive a service to keep track of connections in it’s constructor.

Let’s create first the service interface and implementation to register it with AutoFac:
IHubTrackingService.cs

public interface IHubTrackingService
{
    bool TrackConnection(HubTrack hubTrack);
}

public interface IHubTrackingService

{

bool TrackConnection(HubTrack hubTrack);

}

HubTrackingService.cs

public class HubTrackingService : IHubTrackingService
{
    public bool TrackConnection(HubTrack hubTrack)
    {
        // Do some stuff with your repo to keep tracking of connection;
        return true;
    }
}

public class HubTrackingService : IHubTrackingService

{

public bool TrackConnection(HubTrack hubTrack)

{

// Do some stuff with your repo to keep tracking of connection;

return true;

}

The HubTrack class is a POCO class with the following properties, just as an example:
HubTrack.cs

public class HubTrack
{
    public string HubName { get; set; }
    public string UserId { get; set; }
    public string ConnectionId { get; set; }
    public DateTime ConnectionTime { get; set; }
}

public class HubTrack

{

public string HubName { get; set; }

public string UserId { get; set; }

public string ConnectionId { get; set; }

public DateTime ConnectionTime { get; set; }

}

Now we are ready to create our ChatHub injecting in the constructor the HubTrackingService to allow tracking clients with OnConnected Method:

ChatHub.cs

public class ChatHub : Hub
{

    private readonly IHubTrackingService hubTrackingService;

    public ChatHub(IHubTrackingService hubTrackingService)
    {
        this.hubTrackingService = hubTrackingService;
    }
    public override Task OnConnected()
    {
        RegisterConnection();
        return base.OnConnected();
    }

    private void RegisterConnection()
    {
        this.hubTrackingService.TrackConnection(new HubTrack()
        {
            ConnectionId = Context.ConnectionId,
            HubName = nameof(ChatHub),
            UserId = Context.User?.Identity?.Name ?? string.Empty,
            ConnectionTime = DateTime.UtcNow
        });
    }
}

public class ChatHub : Hub

{

private readonly IHubTrackingService hubTrackingService;

public ChatHub(IHubTrackingService hubTrackingService)

{

this.hubTrackingService = hubTrackingService;

}

public override Task OnConnected()

{

RegisterConnection();

return base.OnConnected();

}

private void RegisterConnection()

{

this.hubTrackingService.TrackConnection(new HubTrack()

{

ConnectionId = Context.ConnectionId,

HubName = nameof(ChatHub),

UserId = Context.User?.Identity?.Name ?? string.Empty,

ConnectionTime = DateTime.UtcNow

});

}

Now, it is time to configure our Startup.cs to add SignalR Server and dependency injection.
In full framework, we use the RegisterHubs autofac extesion to register our hub classes:

builder.RegisterHubs(Assembly.GetExecutingAssembly());

1	builder.RegisterHubs(Assembly.GetExecutingAssembly());

but it is not available yet in Autofac for asp.net core so we should write a ContainerBuilder Extension to do this for us, the code is shown below:

AutofacExtensions.cs

public static class AutoFacExtensions
{

    public static IRegistrationBuilder<object, ScanningActivatorData, DynamicRegistrationStyle>
    RegisterHubs(this ContainerBuilder builder, params Assembly[] assemblies)
    {
        return builder.RegisterAssemblyTypes(assemblies)
        .Where(t => typeof(IHub).IsAssignableFrom(t))
        .ExternallyOwned();
    }
}

public static class AutoFacExtensions

{

public static IRegistrationBuilder<object, ScanningActivatorData, DynamicRegistrationStyle>

RegisterHubs(this ContainerBuilder builder, params Assembly[] assemblies)

{

return builder.RegisterAssemblyTypes(assemblies)

.Where(t => typeof(IHub).IsAssignableFrom(t))

.ExternallyOwned();

}

Note: We use ExternallyOwned() to allow SignalR disposing the Hubs instead of being managed by Autofac.

Once our extension is added to the project we should set our Configure and ConfigureServices methods in Startup.cs

Startup.cs

public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.AddSignalR();
    services.AddMvc();

    var builder = new ContainerBuilder();
    builder.RegisterType & lt; HubTrackingService & gt; ().As & lt; IHubTrackingService & gt; ();
    builder.RegisterHubs(typeof(Startup).GetTypeInfo().Assembly);
    builder.Populate(services);

    return new AutofacServiceProvider(builder.Build());
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    app.UseSignalR();
    app.UseMvc();
}

public IServiceProvider ConfigureServices(IServiceCollection services)

{

services.AddSignalR();

services.AddMvc();

var builder = new ContainerBuilder();

builder.RegisterType & lt; HubTrackingService & gt; ().As & lt; IHubTrackingService & gt; ();

builder.RegisterHubs(typeof(Startup).GetTypeInfo().Assembly);

builder.Populate(services);

return new AutofacServiceProvider(builder.Build());

}

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)

{

app.UseSignalR();

app.UseMvc();

}

Notice the line:

builder.RegisterHubs(typeof(Startup).GetTypeInfo().Assembly);

1	builder.RegisterHubs(typeof(Startup).GetTypeInfo().Assembly);

In asp.net core we don’t have Assembly.GetExecutingAssembly() so we get the assembly from the Startup.cs type
How do we use the Hubs to notify clients when execution is inside a Mvc/Api Controller? Continue reading «Asp.net Core with SignalR server and Autofac» →

Asp.net core node services to execute your nodejs scripts

18 octubre, 20168 febrero, 2017 Carlos Landeras

Nowadays, it is very common to have pieces of code developed in different languages and technologies, and today, more than ever in Javascript.

If you have a tested and battle proven javascript module, maybe you don’t want to rewrite it from scratch in C# to use it in asp.net, and you prefer to invoke it and fetch the results.

This post will show how to use Microsoft Asp Net Core Node Services in asp.net to execute our javascript commonjs modules.

In the following example, we will consume an online free json post service, that returns lorem ipsum posts information based on the request page id. To Achieve this we have a really simple nodejs module that will fetch the contents from the api using the library axios.

We are going to fetch this information through the Post Api Controller and return them in Json to the client.

Lets get started:

First of all we create a new asp.net core project:

Then we add the Reference to Microsoft.AspNetCore.NodeServices in project.json file:

To finish the setup, we have to create a npm configuration file and add the axios reference that will be used by our node script:

To add the npm configuration file use Add > new Item > client-side > npm configuration file and then add the axios dependency as the following image:

With this the setup is complete, let’s jump to the api configuration, we want to add Node Services and fast configure the JsonSerializer indentation settings on our Startup.cs class in ConfigureServices method:

  public void ConfigureServices(IServiceCollection services)
  {
     services.AddNodeServices();

     services.AddMvc().
              AddJsonOptions(options =&gt;
              {
                options.SerializerSettings.Formatting = Formatting.Indented;
              });
   }

public void ConfigureServices(IServiceCollection services)

{

services.AddNodeServices();

services.AddMvc().

AddJsonOptions(options =>

{

options.SerializerSettings.Formatting = Formatting.Indented;

});

}

Once our api is configured to use Node Services we are going to create the Post Controller, and inject the node services in the constructor. The framework will automatically provide it to us so no further configuration is needed. We want to serialize the output to be an ExpandoObject so we can dynamically access to the properties in case it is needed. Right now we just want to send the output to the client in Json format.

using System;
using System.Dynamic;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.NodeServices;

namespace Api.Core.Controllers
{
    [Route("api/[controller]")]
    public class PostController : Controller
    {
        private readonly INodeServices nodeServices;
        private const string NODE_POST_SCRIPT = "./Node/postClient";

        public PostController(INodeServices nodeServices)
        {
            this.nodeServices = nodeServices;
        }

        [HttpGet, Route("{page}")]
        public async Task<ActionResult> Get(int page)
        {
            try
            {
                dynamic postResult = await nodeServices.InvokeAsync<ExpandoObject>(NODE_POST_SCRIPT, page);
                return Json(postResult);
            }
            catch (Exception ex)
            {
                return BadRequest();
            }
        }
    }
}

using System;

using System.Dynamic;

using System.Threading.Tasks;

using Microsoft.AspNetCore.Mvc;

using Microsoft.AspNetCore.NodeServices;

namespace Api.Core.Controllers

{

[Route("api/[controller]")]

public class PostController : Controller

{

private readonly INodeServices nodeServices;

private const string NODE_POST_SCRIPT = "./Node/postClient";

public PostController(INodeServices nodeServices)

{

this.nodeServices = nodeServices;

}

[HttpGet, Route("{page}")]

public async Task<ActionResult> Get(int page)

{

try

{

dynamic postResult = await nodeServices.InvokeAsync<ExpandoObject>(NODE_POST_SCRIPT, page);

return Json(postResult);

}

catch (Exception ex)

{

return BadRequest();

}

The next step will be creating a folder called Node in our root folder and add the following nodejs script within a file named postClient.js.

This js module will just create a GET request to the api, requesting the post Id and invoking the callback based on the network request result:

var root = 'https://jsonplaceholder.typicode.com';
var axios = require('axios');

module.exports = function (callback, page) {
    var commentsUrl = root + '/posts/' + page.toString();
    console.log("Calling Url :" + commentsUrl);
    axios.get(commentsUrl)
        .then(function (response) {
            callback(null, response.data);
        }).catch(function (err) {
            callback(err, null);
        });
};

var root = 'https://jsonplaceholder.typicode.com';

var axios = require('axios');

module.exports = function (callback, page) {

var commentsUrl = root + '/posts/' + page.toString();

console.log("Calling Url :" + commentsUrl);

axios.get(commentsUrl)

.then(function (response) {

callback(null, response.data);

}).catch(function (err) {

callback(err, null);

});

};

NOTE: We should define a callback in the module parameters so Node Services can play the output results.
If we want the script to be successful we should pass a null error callback. On the other hand we will provide an error as the first callback parameter so the nodeService.InvokeAsync throws an Exception.

Final Steps, executing the controller action:

Everything is in place and we are going to use Fiddler to create requests to the post controller requesting different page ids:

Once we execute the request we can see debugging the resulting output from the js script:

And then we get the output on fiddler as well:

And that’s all for today, I hope you enjoyed.

Happy Coding!.