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(...

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...