zrb 0.23.1__tar.gz → 0.23.3__tar.gz

{zrb-0.23.1 → zrb-0.23.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.23.1
+Version: 0.23.3
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
@@ -63,7 +63,7 @@ pip install zrb
 Alternatively, you can also use our installation script to install Zrb along with some prerequisites:
 
 ```bash
-source <(curl -s https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"
 ```
 
 Check our [installation guide](https://github.com/state-alchemists/zrb/blob/main/docs/installation.md) for more information about the installation methods, including installation as a docker container.

{zrb-0.23.1 → zrb-0.23.3}/README.md

@@ -31,7 +31,7 @@ pip install zrb
 Alternatively, you can also use our installation script to install Zrb along with some prerequisites:
 
 ```bash
-source <(curl -s https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"
 ```
 
 Check our [installation guide](https://github.com/state-alchemists/zrb/blob/main/docs/installation.md) for more information about the installation methods, including installation as a docker container.

{zrb-0.23.1 → zrb-0.23.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "0.23.1"
+version = "0.23.3"
 description = "A Framework to Enhance Your Workflow"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/README.md

@@ -132,12 +132,81 @@ If you want to run PascalZrbAppName on containers, you will also need `Docker` w
 
 You will also need `Pulumi` if you want to deploy PascalZrbAppName into your Kubernetes cluster.
 
+# High Level Architecture
+
+PascalZrbAppName heavily uses dependency inversion and avoids dependency injection on the same time.
+
+This architecture aims to let the developers define and choose new implementations without breaking any existing part.
+
+To achieve this, we use two elements:
+
+- __Component__: Containing interface and implementation
+- __Integration__: Instantiation of the components. Here is where you choose which component implementation to use and how we tailor the implementations.
+
+Let's see the following example.
+
+```
+     ┌────────────────────────────────────────────┐     
+     │ Component                                  │     
+     │   ┌───────────────┐     ┌────────────────┐ │     
+     │   │ Messagebus    │     │ RPC Caller     │ │     
+     │   │   ┌────────┐  │     │   ┌──────────┐ │ │     
+     │   │   │Kafka   │  ├─────┼──►│Messagebus├─┼─┼────┐
+     │   │   └────────┘  │     │   └──────────┘ │ │    │
+     │   │   ┌────────┐  │     │   ┌──────────┐ │ │    │
+  ┌──┼───┼───┤Rabbitmq│  │     │   │Grpc      │ │ │    │
+  │  │   │   └────────┘  │     │   └──────────┘ │ │    │
+  │  │   │   ┌────────┐  │     └────────────────┘ │    │
+  │  │   │   │Other   │  ├──┐                     │    │
+  │  │   │   └────────┘  │  │  ┌────────────────┐ │    │
+  │  │   └───────────────┘  │  │ RPC Server     │ │    │
+  │  │                      │  │   ┌──────────┐ │ │    │
+  │  │                      └──┼──►│Messagebus├─┼─┼─┐  │
+  │  │                         │   └──────────┘ │ │ │  │
+  │  │                         │   ┌──────────┐ │ │ │  │
+  │  │                         │   │Grpc      │ │ │ │  │
+  │  │                         │   └──────────┘ │ │ │  │
+  │  │                         └────────────────┘ │ │  │
+  │  └────────────────────────────────────────────┘ │  │
+  │                                                 │  │
+  │  ┌────────────────────────────────────────────┐ │  │
+  │  │ Integration                                │ │  │
+  │  │  ┌──────────┐                              │ │  │
+  └──┼─►│Messagebus├───────┬──────────────┐       │ │  │
+     │  └──────────┘       │              │       │ │  │
+     │                ┌────▼─────┐  ┌─────▼────┐  │ │  │
+     │                │RPC Caller│  │RPC Server│◄─┼─┘  │
+     │                └────▲─────┘  └──────────┘  │    │
+     └─────────────────────┼──────────────────────┘    │
+                           └───────────────────────────┘
+```
+
+__Components__
+
+In the example, there are three component interfaces:
+- `Messagebus`
+- `RPC Caller`
+- `RPC Server`
+
+Each interface has several implementations, for example there are two implementation of `RPC Caller`:
+- `RPCCaller.Messagebus`: RPC Caller implementation that need `Messagebus`.
+- `RPCCaller.Grpc`: RPC Caller through GRPC, doesn't need any other component.
+
+__Integration__
+
+As for integration, we need to choose particular component implementations.
+
+- `Messagebus`: For Messagebus, we choose `Messagebus.Rabbitmq` component.
+- `RPC Caller`: For RPC Caller, we choose `RPCCaller.Messasgebus`. This implementation need a `Messagebus` interface.
+- `RPC Server`: For RPC Server, we choose `RPCServer.Messasgebus`. This implementation need a `Messagebus` interface.
+
+
 # Directory Structure
 
 - `docker-compose.yml`: A multi-profile docker-compose file. This helps you to run your application as a monolith/microservices.
 - `all-module-disabled.env`: Feature flags to be used when you deactivate all modules.
 - `all-module-enabled.env`: Feature flags to be used when you activate all modules.
-- `deployment/`: Deployment directory. By default, we put deployment along with the source code to make it easier to maintain/manage. You can later move your deployments to another repository if you think you need to.
+- `deployment/`: Deployment directory. By default, we put deployment along with the source code to make it easier to maintain/manage. You can later move your deployments to another repository if you need to do so.
     - `/helm-charts`: Helm charts for Rabbitmq, Redpanda, and Postgre.
     - `__main__.py`: Main Pulumi script.
     - `template.env`: Default configuration for deployment
@@ -187,12 +256,19 @@ You will also need `Pulumi` if you want to deploy PascalZrbAppName into your Kub
 
 # Decisions and Constraints
 
+## Dependency Inversion without Dependency Injection
+
+We tend to avoid magical dependency inversion unless necessary. We want PascalZrbEntityName to be as explicit as possible. We do this by providing two elements:
+
+- Component: Containing all interfaces and implementations
+- Integration: Instantiation of components. This is where we choose and tailor the component's implementation.
+
 ## Frontend
-- PascalZrbAppName's Frontend is served as static files and is built before runtime (not SSR/Server Side Rendering). That's mean.
+PascalZrbAppName's front end serves static files built before runtime (not SSR/Server Side Rendering). That's mean.
     - The SEO is probably not good.
     - The page load is sensibly good.
 - We use Svelte for Frontend because it is easier to read/learn compared to React, Vue, or Angular.
-- At the moment, the frontend use:
+- At the moment, the front end use:
     - Sveltekit
     - TailwindCSS
     - DaisyUI
@@ -203,7 +279,7 @@ You will also need `Pulumi` if you want to deploy PascalZrbAppName into your Kub
     - Database connection
     - Database migration
     - Data manipulation
-- To create a custom database implementation, you need to create an implementation that complies with `core.repo.Repo`.
+- To create a custom database implementation, you must create one that complies with `core.repo.Repo`.
 
 ## Messaging
 
@@ -215,11 +291,11 @@ You will also need `Pulumi` if you want to deploy PascalZrbAppName into your Kub
     - No messaging platform, a.k.a: in memory. This will only work properly if you run PascalZrbAppName as a monolith.
         - `APP_BROKER_TYPE=mock`
 - To create custom event handlers, you need to implement two interfaces:
-    - `core.messagebus.Publisher`
-    - `core.messagebus.Server`
+    - `component.messagebus.Publisher`
+    - `component.messagebus.Server`
 
 ## RPC
 
 - Currently, RPC implementation depends on the messaging platforms. It is possible to override this behavior by creating you custom implementation. There are two interfaces you need to override:
-    - `core.rpc.Caller`
-    - `core.rpc.Server`
+    - `component.rpc.Caller`
+    - `component.rpc.Server`

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/frontend/src/routes/+layout.svelte

@@ -3,7 +3,7 @@
 	import Navigation from '$lib/components/navigation/Navigation.svelte';
 	import { navData } from '$lib/config/navData';
 	import { getBrand, getTitle } from '$lib/config/app';
-	import logo from '/static/logo.png';
+	import logo from '@static/logo.png';
   	import "../app.css";
 
 	let appBrand = '';

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/frontend/vite.config.ts

@@ -1,9 +1,15 @@
 import { sveltekit } from '@sveltejs/kit/vite';
 import { defineConfig } from 'vitest/config';
+import path from 'path';
 
 export default defineConfig({
 	plugins: [sveltekit()],
 	test: {
 		include: ['src/**/*.{test,spec}.{js,ts}']
-	}
+	},
+	resolve: {
+		alias: {
+			'@static': path.resolve(__dirname, 'static'),
+		},
+	},
 });

{zrb-0.23.1/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/integration → zrb-0.23.3/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/integration/app}/app.py

@@ -16,7 +16,8 @@ from config import (
 from fastapi import FastAPI, status
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse
-from integration.app_lifespan import app_lifespan, app_state
+from integration.app.app_lifespan import app_lifespan
+from integration.app.app_state import app_state
 from integration.frontend_index import frontend_index_response
 from schema.frontend_config import FrontendConfig
 

{zrb-0.23.1/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/integration → zrb-0.23.3/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/integration/app}/app_lifespan.py

@@ -12,7 +12,7 @@ from config import (
 from fastapi import FastAPI
 from fastapi.staticfiles import StaticFiles
 from helper.async_task import create_task
-from integration.app_state import app_state, set_not_ready_on_error
+from integration.app.app_state import app_state, set_not_ready_on_error
 from integration.log import logger
 from integration.messagebus import consumer
 from integration.rpc import rpc_server

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/main.py

@@ -1,9 +1,7 @@
-from integration.app import app
+from integration.app.app import app
 from module.auth.register_module import register_auth
 from module.log.register_module import register_log
 
-# Make sure app is loaded.
-# Uvicorn or adny ASGII server you use will pick it up and run the app.
 assert app
 register_auth()
 register_log()

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/module/auth/register_module.py

@@ -4,7 +4,7 @@ from config import (
     app_enable_event_handler,
     app_enable_rpc_server,
 )
-from integration.app import app
+from integration.app.app import app
 from integration.log import logger
 from integration.messagebus import consumer, publisher
 from integration.rpc import rpc_caller, rpc_server

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/module/log/register_module.py

@@ -4,7 +4,7 @@ from config import (
     app_enable_log_module,
     app_enable_rpc_server,
 )
-from integration.app import app
+from integration.app.app import app
 from integration.log import logger
 from integration.messagebus import consumer, publisher
 from integration.rpc import rpc_caller, rpc_server

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/register_module.py

@@ -4,7 +4,7 @@ from config import (
     app_enable_rpc_server,
     app_enable_snake_zrb_module_name_module,
 )
-from integration.app import app
+from integration.app.app import app
 from integration.log import logger
 from integration.messagebus import consumer, publisher
 from integration.rpc import rpc_caller, rpc_server

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/helper/string/parse_replacement.py

@@ -13,7 +13,7 @@ def parse_replacement(text: str, replacement: Mapping[str, str]):
     new_text = text
     for old, new in replacement.items():
         if len(new.strip().split("\n")) > 1:
-            pattern = "".join(["^([ \\t]+)", old])
+            pattern = "".join(["^([ \\t]+)", re.escape(old)])
             new_replacement = "".join(["\\1", new.replace("\n", "\n\\1")])
             new_text = re.sub(pattern, new_replacement, new_text, flags=re.MULTILINE)
             continue

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/task/base_remote_cmd_task.py

@@ -82,6 +82,7 @@ class SingleBaseRemoteCmdTask(CmdTask):
         post_cmd: CmdVal = "",
         post_cmd_path: CmdVal = "",
         cwd: Optional[Union[str, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
@@ -118,6 +119,7 @@ class SingleBaseRemoteCmdTask(CmdTask):
             cmd=cmd,
             cmd_path=cmd_path,
             cwd=cwd,
+            should_render_cwd=should_render_cwd,
             upstreams=upstreams,
             fallbacks=fallbacks,
             on_triggered=on_triggered,
@@ -226,7 +228,8 @@ class BaseRemoteCmdTask(BaseTask):
         cmd_path: CmdVal = "",
         post_cmd: CmdVal = "",
         post_cmd_path: CmdVal = "",
-        cwd: Optional[Union[str, pathlib.Path]] = None,
+        cwd: Optional[Union[JinjaTemplate, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
@@ -266,6 +269,7 @@ class BaseRemoteCmdTask(BaseTask):
                 post_cmd=post_cmd,
                 post_cmd_path=post_cmd_path,
                 cwd=cwd,
+                should_render_cwd=should_render_cwd,
                 upstreams=upstreams,
                 fallbacks=fallbacks,
                 on_triggered=on_triggered,

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/task/cmd_task.py

@@ -127,7 +127,8 @@ class CmdTask(BaseTask):
         executable: Optional[str] = None,
         cmd: CmdVal = "",
         cmd_path: CmdVal = "",
-        cwd: Optional[Union[str, pathlib.Path]] = None,
+        cwd: Optional[Union[JinjaTemplate, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
@@ -181,6 +182,7 @@ class CmdTask(BaseTask):
         self._cmd = cmd
         self._cmd_path = cmd_path
         self.__set_cwd(cwd)
+        self._should_render_cwd = should_render_cwd
         self._max_output_size = max_output_line
         self._max_error_size = max_error_line
         self._output_buffer: Iterable[str] = []
@@ -233,13 +235,14 @@ class CmdTask(BaseTask):
         cmd = self.get_cmd_script(*args, **kwargs)
         if self._should_show_cmd:
             self.print_out_dark("Run script: " + self.__get_multiline_repr(cmd))
+        cwd = self._get_cwd()
         if self._should_show_working_directory:
-            self.print_out_dark("Working directory: " + self._cwd)
+            self.print_out_dark("Working directory: " + cwd)
         self._output_buffer = []
         self._error_buffer = []
         process = await asyncio.create_subprocess_shell(
             cmd,
-            cwd=self._cwd,
+            cwd=cwd,
             stdout=asyncio.subprocess.PIPE,
             stderr=asyncio.subprocess.PIPE,
             env=self.get_env_map(),
@@ -272,6 +275,11 @@ class CmdTask(BaseTask):
         self.set_task_xcom(key="error", value=error)
         return CmdResult(output, error)
 
+    def _get_cwd(self) -> Union[str, pathlib.Path]:
+        if self._should_render_cwd and isinstance(self._cwd, str):
+            return self.render_str(self._cwd)
+        return self._cwd
+
     def _should_attempt(self) -> bool:
         if self._global_state.no_more_attempt:
             return False

{zrb-0.23.1 → zrb-0.23.3}/src/zrb/task/docker_compose_task.py

@@ -104,7 +104,8 @@ class DockerComposeTask(CmdTask):
         compose_env_prefix: str = "",
         setup_cmd: CmdVal = "",
         setup_cmd_path: CmdVal = "",
-        cwd: Optional[Union[str, pathlib.Path]] = None,
+        cwd: Optional[Union[JinjaTemplate, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
@@ -140,6 +141,7 @@ class DockerComposeTask(CmdTask):
             description=description,
             executable=executable,
             cwd=cwd,
+            should_render_cwd=should_render_cwd,
             upstreams=[ensure_zrb_network_task] + upstreams,
             fallbacks=fallbacks,
             on_triggered=on_triggered,