Skip to main content

Why you should look around before writing something from scratch

Nowadays there are a lot of SPA websites used for different purposed. Almost all of them need to access different resources in CRUD format (Create/Read/Update/Delete).
I had to take a look into a project that was using Angular to offer the SPA support. The application is hosted in Azure using Web Sites. Everything was great, except one thing. There were around 100 types of entities that were accessed by the SPA application through API controllers.
For CRUD access, the development team defined a dynamic mechanism that was able to fetch data from the database and expose it using REST services over API controllers. The code was pretty ugly, even though the design was good. Personally I had the feeling that they reinvented the wheel.
On top of this custom implementation, there was another mechanism for caching on client side, based on dictionary. Very simple, but perfect for their needs.
When the project ended, they realized one thing. Everything that was made to support client side caching and CRUD access to entities was already supported in Angular using Breeze.
Breeze is a JavaScript library that is used to access data from client side. This library has the ability to cache entities on the client browser even if the client navigates from one page to another. On top of this, you have the ability to write queries in a fluent way (LINQ style) based on OData protocol (Open Data Protocol) and promises.
Breeze is made around EntityManager object, which caches all the entities and also plays the role of the gateway when entities cannot be found in the cache.
Things that I like:
+The way we can define queries
var myFooQuery = breeze.EntityQuery()
.from(‘Users’)
.where(‘Name’,’startWith’,’Ra’)
.orderBy(‘Name’);
var entityManager = new breeze.EntityManager(myFooServiceName);
entityManager.execute(myFooQuery)
  .then(..)
  .fail(…);
+the API Controller has support for OData (out of the box support to expose the services)
+You have full control when you save data from the local instance (entityManager) to the backend
entityManager.saveChanges()
  .then(..)
  .fail(…)
+Custom validation rules (you can define your validation logic on client side)
+Full integration with Entity Framework and API Controller
[BreezeController]
public class UsersController : ApiController {
 
    readonly EFContextProvider<UserDbContext> _contextProvider =
        new EFContextProvider<UserDbContext>();
 
    // ~/breeze/users/Metadata
    [HttpGet]
    public string Metadata() {
        return _contextProvider.Metadata();
    }
 
    // ~/breeze/users/Users
    [HttpGet]
    public IQueryable<User> Users() {
        return _contextProvider.Context.Users;
    }
 
    // ~/breeze/users/SaveChanges
    [HttpPost]
    public SaveResult SaveChanges(JObject saveBundle) {
        return _contextProvider.SaveChanges(saveBundle);
    }
}
I invite all of you to take a look at Breeze.JS
Lesson learned: Investigate a problem, look to see what kind of 3rd parties you can use to solve your problem before starting to implement your own custom solution.

Comments

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provi...