BLOCK Framework

By Raj Marni. September 12, 2023. Revised. Version: 0.1.01

The BLOCK framework provides a modular and efficient approach to building web and mobile app backends. This breakdown will delve deeper into each component and how they work together.

Flow

Imagine a Flow as the backbone of a specific functionality within your app. It represents a well-defined sequence of operations and processes that data and requests follow to achieve a particular goal, like "User Registration" or "Product Purchase". These Flows act as blueprints for your app's functionality, outlining the steps required to deliver desired outcomes.

BLOCK

Within each Flow lie BLOCKs, the workhorses of the framework. Think of them as interconnected components, each responsible for a specific task within the Flow. A User Registration Flow might contain a BLOCK dedicated to collecting user data, another for validating it, and yet another for storing it securely. Each BLOCK focuses on a single step in the larger process, ensuring modularity and clarity.

Leg

Zoom in further, and you'll find Legs residing within each BLOCK. These are like microscopic veins carrying out specific functions within the BLOCK. For example, a BLOCK responsible for collecting user documents might have one Leg for collecting PDF files and another for uploading them to an S3 bucket. Each Leg handles a unique sub-task within the BLOCK, adding further granularity and flexibility.

Asset and Resource

Legs are where Assets and Resources come into play. Think of an Asset as the brain of a Leg – a microservice, API gateway, database, S3 bucket, or any entity with built-in intelligence or data persistence. In the S3 Leg example, the S3 bucket itself is the Asset. Resources, on the other hand, act as keys unlocking that intelligence or data. IAM Roles, Policies, and Secrets are all examples of Resources, granting access and permissions to the capabilities of the associated Asset.

The Interplay

Now, imagine how these components dance together:

1. A user triggers the User Registration Flow.

2. The Flow directs data and requests through interconnected BLOCKs.

3. Within each BLOCK, Legs handle specific tasks like collecting documents, validating data, or uploading files.

4. Each Leg utilizes its designated Asset (e.g., S3 bucket) for intelligent processing or data storage.

5. Resources (e.g., IAM Roles) ensure secure access and proper functioning of the Assets.

This modular framework unlocks several benefits:

• Scalability: Adding new features or scaling existing ones is easier by adding or modifying BLOCKs and Legs without impacting the entire Flow.

• Maintainability: Debugging and updating specific functionalities become simpler by pinpointing issues within individual BLOCKs.

• Reusability: Common BLOCKs can be reused across different Flows, saving development time and effort.

• Transparency: The defined structure provides clarity and maintainability for developers working on the codebase.

• Visualization: To further illustrate the framework, consider creating visual aids like diagrams or flowcharts. These can depict the relationships between Flows, BLOCKs, Legs, Assets, and Resources, making the framework even more transparent and comprehensible.

The BLOCK framework is a powerful tool for building efficient and well-structured web and mobile app backends. By understanding its components and their interactions, you can leverage its strengths to create maintainable, scalable, and modular applications.