Skip to main content

Introducing SignalWire – Magical Plumbing with your Data Store + C# and LINQ in your HTML pages

imageSignalWire is an experimental Server<->Client plumbing project I started, that magically wires up your HTML5 front end to the collections/tables in your data store or ORM, and I just pushed the first commit to Github. SignalWire uses SignalR and Roslyn libraries to implement features like

  • Exposing collections in your Back end directly over the wire for CRUD operations and for performing LINQ queries from your JavaScript.
  • Enable using C# in your HTML applications.

I got inspired by Meteor and started SignalWire as a POC to implement some of these features on the .NET stack, but I’ve got few more ideas on the way and thought about pushing this to Github.  See the codebase in Github

Check out this quick video (no sound, sorry), a simple Taskboard built using SignalWire. See how we are accessing the collections in Javascript, and check how we are issuing LINQ queries

As of now, support is available for EntityFramework and MongoDb as the back end. Also, it provides

  • A light weight permission framework (wip)
  • A Client side Javascript API to access your collections with minimal/no serverside code
  • Model Validation support using normal C#/ASP.NET Data Validation attributes
  • LINQ support to issue Linq queires from HTML pages (highly experimental, as of now no sandboxing support per caller)
  • C# code in your HTML pages (wip)

How To Start

You may start with Creating an Empty ASP.NET Project in Visual Studio 2012 (You need .NET 4.5 as we are using Roslyn September CTP libraries). Then, install SignalWire using Nuget. In Package Manager console

Install-Package SignalWire

This will add the following components to your project.

  • Models\TaskDb.cs - An example Entity Framework Data Context. You can use your instead
  • Hubs\DataHub.cs - An example Datahub.
  • Scripts\SignalWire.js - Clientside JQuery Pluin for SignalR.

Now, goto Index.html, and verify all your JS file versions are correct. Run the application and see

Server – Data Context and Hub

The Only server side code you need is your POCO objects and a hub inherited from the DataHub base class, which is defined in the SignalWire library. You need to use the Collections attribute to map a POCO class with the set/collection, and make sure you always do that in lower case.

   //Simple POCO class to represent a task
    [Collection("tasks")]
    public class Task
    {
        [Required]
        public int Id { get; set; }

        [Required]
        [MaxLength(100, ErrorMessage = "Subject cannot be longer than 40 characters.")]
        public string Subject { get; set; }

        [Required]
        [MaxLength(200, ErrorMessage = "Details cannot be longer than 40 characters.")]
        public string Details { get; set; }

        public bool Completed { get; set; }
    }


   //Simple demo db context   
    public class TaskDb : DbContext
    {
        public DbSet<Task> Tasks { get; set; }
    }

Now, you need a hub. By convention, Wire assume’s the server hub’s name as Data if it is not specified in the init method of $.wire.init(..). In the example you get when you install the Nuget package, you’ll see we are using an Entity Framework Context Provider, for TaskDb which is a DataContext. Replace TaskDb with your own EF Data context if required. Once you do that, all your collections/sets with in the context can be accessed over the wire. In the example, you’ve only on set in your TaskDb data context as you can see above - that is Tasks. Let us create the Hub.

public class Data : DataHub<EFContextProvider<TaskDb>> 

That's all you need to access collections via the Wire.

Client - Initializing and Issuing Queries

SignalWire magically exposes all your Tables/Sets/Collections in your Data back end via the $.wire Javascript object at client side. You can initialize $.wire using the init() method, which returns a JQuery Deferred. Here is a quick example regarding initializing Wire and issuing a LINQ query.

     //Initialize wire
     $.wire.init().done(function () {

      //Now you can access the tasks collection in your data context
      //You can issue a LINQ Query.
      $.wire.tasks.query("from Task t in Tasks select t")
               .done(function (result) {
                    $.each(result, function (index, task) {
                       //Do something with each task
                    });
                }).fail(function (result) {
                    alert(JSON.stringify(result.Error));
                });
         });

Other Wire Methods

You can use $.wire.yourcollection.add(..) to add objects to a specific collection. The add method will return the added item with updated Id up on completion.

    var t = {
        "subject": $("#subject").val(),
        "details": $("#details").val(),
    };


    //Add a task to the Tasks collection                    
    $.wire.tasks.add(t)
       .done(function (task) {
          //Note that you'll get the auto generated Id
       }).fail(function (result) {
            //result.Error contains the error if any                        
            //result.ValidationResults contains the Validation results if any 
            alert(JSON.stringify(result.Error)); 
       });

Similarly, you can use

  • $.wire.yourcollection.remove(item) to remove items
  • $.wire.yourcollection.update(item) to update an item (based on Id match).
  • $.wire.yourcollection.read({"query":"expression", "skip":"xxx", "take":"xxx"}) to read from a specific collection

Permissions

You can decorate your Model classes with Custom permission attributes that implements IPermission. This will check if the user in the current context can actually perform a specific operation on a Model entity.

What's More

I'm planning the following features based on my time

  • Sandboxed execution for C# scripts in HTML page that can access client side context
  • Publishing and data sync
  • Permission based events, may be using something like PushQA.

Fork on Github to play around

Popular posts from this blog

Top 7 Coding Standards & Guideline Documents For C#/.NET Developers

Some time back, I collated a list of 7 Must Read, Free EBooks for .NET Developers, and a lot of people found it useful. So, I thought about putting together a list of Coding Standard guidelines/checklists for .NET /C# developers as well.As you may already know, it is easy to come up with a document - the key is in implementing these standards in your organization, through methods like internal trainings, Peer Reviews, Check in policies, Automated code review tools etc. You can have a look at FxCop and/or StyleCop for automating the review process to some extent, and can customize the rules based on your requirements.Anyway, here is a list of some good Coding Standard Documents. They are useful not just from a review perspective - going through these documents can definitely help you and me to iron out few hidden glitches we might have in the programming portion of our brain. So, here we go, the listing is not in any specific order.1 – IDesign C# Coding StandardsIDesign C# coding stand…

5 Awesome Learning Resources For Programmers (To help you and your kids to grow the geek neurons)

Happy New Year, this is my first post in 2012. I’ll be sharing few awesome learning resources I’ve bookmarked, and will be pointing out some specific computer/programming related courses I've found interesting from these resources.Also, thought about saving this blog post for my kids as well - instead of investing in these Child education schemes (though they are too small as of today, 2 years and 60 days respectively ). Anyway, personally my new year resolution is to see as much videos from this course collections (assuming I can find some free time in between my regular job && changing my babies diapers).1 – Khan AcademyAs I mentioned some time back, you and your kids are missing some thing huge if you havn’t heard about Khan Academy.  It is an awesome learning resource, especially if you want to re-visit your basics in Math, Science etc.With a library of over 2,600 videos covering everything from arithmetic to physics, finance, and history and 268 practice exercises, th…

Hack Raspberry Pi – How To Build Apps In C#, WinForms and ASP.NET Using Mono In Pi

Recently I was doing a bit of R&D related to finding a viable, low cost platform for client nodes. Obviously, I came across Raspberry Pi, and found the same extremely interesting. Now, the missing piece of the puzzle was how to get going using C# and .NET in the Pi. C# is a great language, and there are a lot of C# developers out there in the wild who are interested in the Pi.In this article, I’ll just document my findings so far, and will explain how develop using C# leveraging Mono in a Raspberry Pi. Also, we’ll see how to write few minimal Windows Forms & ASP.NET applications in the Pie as well.Step 1: What is Raspberry Pi?Raspberry Pi is an ARM/Linux box for just ~ $30. It was introduced with a vision to teach basic computer science in schools. How ever, it got a lot of attention from hackers all around the world, as it is an awesome low cost platform to hack and experiment cool ideas as Pi is almost a full fledged computer.  More About R-Pi From Wikipedia.The Raspberry Pi