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

Why Database Modernization Matters for AI

  When companies transition to the cloud, they typically begin with applications and virtual machines, which is often the easier part of the process. The actual complexity arises later when databases are moved. To save time and effort, cloud adoption is more of a cloud migration in an IaaS manner, fulfilling current, but not future needs. Even organisations that are already in the cloud find that their databases, although “migrated,” are not genuinely modernised. This disparity becomes particularly evident when they begin to explore AI technologies. Understanding Modernisation Beyond Migration Database modernisation is distinct from merely relocating an outdated database to Azure. It's about making your data layer ready for future needs, like automation, real-time analytics, and AI capabilities. AI needs high throughput, which can be achieved using native DB cloud capabilities. When your database runs in a traditional setup (even hosted in the cloud), in that case, you will enc...

Cloud Myths: Migrating to the cloud is quick and easy (Pill 2 of 5 / Cloud Pills)

The idea that migration to the cloud is simple, straightforward and rapid is a wrong assumption. It’s a common misconception of business stakeholders that generates delays, budget overruns and technical dept. A migration requires laborious planning, technical expertise and a rigorous process.  Migrations, especially cloud migrations, are not one-size-fits-all journeys. One of the most critical steps is under evaluation, under budget and under consideration. The evaluation phase, where existing infrastructure, applications, database, network and the end-to-end estate are evaluated and mapped to a cloud strategy, is crucial to ensure the success of cloud migration. Additional factors such as security, compliance, and system dependencies increase the complexity of cloud migration.  A misconception regarding lift-and-shits is that they are fast and cheap. Moving applications to the cloud without changes does not provide the capability to optimise costs and performance, leading to ...

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