-`The ideal time to grow a business was yesterday, but the next best time to invest in one is now.`
+`The ideal time to grow a business was yesterday..`
+ `..but the next best time to invest in one is now!`
+
+ACAP, a cutting-edge system, aims to revolutionize content distribution and engagement.
+With its dynamic and adaptable features, it ensures that your clients and services receive
+precisely tailored content in real-time, promptly responding to evolving needs and
+preferences for a seamless, personalized experience. Its automated processes streamline
+content distribution, allowing you to focus on essential tasks. ACAP enhances user
+engagement by delivering timely, relevant, and diverse content across platforms or
+channels, fostering increased customer satisfaction, loyalty, and business growth.
+
+Moreover, ACAP stands apart from traditional CMS solutions; it's not just a standalone
+system but a versatile building block or core system. It offers the flexibility to
+abstract and build your own CMS tailored to your unique requirements. Additionally,
+ACAP provides a user-friendly web UI for content preview before triggering distribution.
+
+ACAP's versatility extends far beyond content management; it seamlessly integrates into
+various environments, serving as a multipurpose tool for diverse applications. Whether
+you're automating your home or setting up a home lab for experimentation and learning,
+ACAP adapts to your needs with ease. From orchestrating smart home devices to managing
+data and services in your home lab, ACAP empowers you to achieve more with less effort.
+
+Say goodbye to static, cumbersome content management and embrace ACAP's transformative
+capabilities, empowering you to innovate and thrive in today's dynamic digital landscape.
-ACAP is a cutting-edge system designed to revolutionize content distribution and engagement. With its dynamic and adaptable features, it ensures that your clients and services receive the right content at the right time. ACAP responds in real-time to changing needs and preferences, guaranteeing a seamless and personalized experience. Its automated processes make content distribution effortless, allowing you to focus on what matters most. Moreover, ACAP empowers you to enhance user engagement by delivering timely, relevant, and diverse content through its platform or channels. This means increased customer satisfaction and loyalty, leading to business growth. Say goodbye to static and cumbersome content management and hello to ACAP's game-changing capabilities.
-
-
-
-
@@ -76,543 +74,17 @@ powered by
-
-Table of Contents
-
-
-[Getting Started](#getting-started)
-[Serialization and Persistence](#serialization-and-persistance)
-[Example Use Cases](#example-use-cases)
-[Whats in the box?](#whats-in-the-box)
-[Content Validation](#content-validation)
-[Content Encryption](#content-encryption)
-[Caching](#caching)
-[Redis Publish Subscribe](#redis-publish-subscribe)
-[MQTT](#mqtt)
-[Kafka](#kafka)
-[RabbitMQ](#rabbitmq)
-[BullMQ](#bullmq)
-[Outbreak API](#outbreak-api)
-
-
-
-
-## Getting Started
-
-
-
-> VSCODE: Before we start, please do yourself a favor and open the **.code-workspace**
-file in the project root with vscode. Trust me, it will make your life much simpler. Now back to topic.
-
-Getting ACAP up and running is pretty straight forward.
-
-
Docker
-
-Run the following commands to install the required dependencies:
-
-- `npm i -g pnpm && pnpm install`.
-- `sudo apt install python3 python3-pip`
-- `pip install jinja2`
-
-Generate the docker-compose.yml:
-
-- `pnpm run -r genpose`.
-
-You can optionally add the **--up** flag to automatically start the containers
-defined in your docker-compose.yml file after it's generated.
-
-Genpose creates the docker-compose.yml file using the values of your environment variables
-which are defined in `./apps/backend/env/.env`, `./apps/ms-bridge/env/.env` or if set globally.
-
-- USE_REDIS_PUBSUB
-- USE_BULLMQ
-- USE_MQTT
-- USE_KAFKA
-- USE_RABBITMQ
-
-Please note that the backend relies on RabbitMQ to emit events to the message bridge,
-which then distributes them to the brokers.
-By default the message bridge as well as all brokers are disabled.
-
-
CLI
-
-We recommend utilizing [pnpm](https://pnpm.io/), as it streamlines the execution of tests,
-linting processes, and script initialization, resulting in improved efficiency and ease of use.
-
-- Install pnpm `npm i -g pnpm`.
-- Install the dependencies `pnpm install`.
-- Run `pnpm run -r start:dev`
-
-> Make sure all the required services aka databases etc are up and running.
-> If you ran docker previously, then you most likely will get an error compiling the dist folders.
-> Simply `sudo rm -rf` those folders in every workspace.
-
-You can run storybook explicitly or execute tests in parallel:
-
-- Storybook `pnpm run --filter frontend storybook`
-- Run tests parallel in all workspaces `pnpm run -r test`.
-
-
Config
-
-**ACAP** simplifies the initialization process by providing a convenient ready-to-use setup.
-It leverages a `config.yml` file, reducing dependence on system environment variables,
-while still allowing flexibility to set them when required.
-
-When utilizing ACAP in Docker or Kubernetes, configuring the service is effortless.
-By binding the `/app/config.yml` to a volume, you can easily adjust the service settings.
-The `config.yml` file contains default presets, which, when combined with Docker Compose,
-enable a speedy setup for local development. This approach facilitates a seamless spin-up
-process for your projects.
-
-
-
-
-Expand to see the sample config.yml file
-
-
-
-```yml
-appConfig:
- port: 3001
- address: 0.0.0.0
- printEnv: true
- startSwagger: true
- nodeEnv: "local"
- bodyLimit: "104857600"
- crypto:
- secret: CryptoShield2024
- realm:
- ttl: 300
- resolveEnv: true
- namespacePostfix: ACAP
- gzipThreshold: 20
- brokers:
- useBullMQ: true
-
-mongoConfig:
- uri: mongodb://mongo:27017
- ssl: false
- tlsAllowInvalidCertificates: false
- dbName: ACAP
- user: mongo
- pass: mongo
-
-minioConfig:
- endPoint: "minio"
- port: 9000
- useSSL: false
- accessKey: "minio"
- secretKey: "minio2024"
- bucket: "acap"
-
-redisConfig:
- host: keydb
- port: 6379
- ttl: 600
- max: 100
- db: 0
- password: redis
- username: default
-
-bullMQConfig:
- connection:
- port: 6379
- host: keydb
- password: redis
- username: default
-```
-
-
-
-
-
-
-
-Expand to see the sample docker compose file
-
-
-
-```yml
-services:
- frontend:
- container_name: frontend
- build:
- context: ./apps/frontend
- target: local
- depends_on:
- - backend
- volumes:
- - ./apps/frontend:/app
- - ./node_modules:/node_modules
- environment:
- - ./apps/frontend/.env.development
- ports:
- - "5173:5173"
- networks:
- - acap-network
-
- backend:
- container_name: backend
- build:
- context: ./apps/backend
- target: local
- volumes:
- - ./apps/backend:/app
- - ./node_modules:/node_modules
- depends_on:
- - mongo
- - minio
- - keydb
- - msbridge
- env_file:
- - ./apps/backend/env/.env
- ports:
- - 3001:3001
- networks:
- - acap-network
-
- msbridge:
- container_name: msbridge
- build:
- context: ./apps/ms-bridge
- target: local
- volumes:
- - ./apps/ms-bridge:/app
- - ./node_modules:/node_modules
- depends_on:
- - keydb
- - kafka
- - mosquitto
- - rabbitmq
- env_file:
- - ./apps/ms-bridge/env/.env
- environment:
- - KAFKAJS_NO_PARTITIONER_WARNING=1
- ports:
- - 3002:3002
- networks:
- - acap-network
-
- keydb:
- image: eqalpha/keydb
- container_name: keydb
- ports:
- - 6379:6379
- volumes:
- - keydb_data:/data
- - ./apps/ms-bridge/keydb.conf:/usr/local/etc/keydb/keydb.conf
- command: keydb-server /usr/local/etc/keydb/keydb.conf
- networks:
- - acap-network
- restart: unless-stopped
-
- mongo:
- command: mongod --quiet --wiredTigerCacheSizeGB 1.5 --logpath /dev/null
- image: mongo
- container_name: mongo
- environment:
- - MONGO_INITDB_ROOT_USERNAME=mongo
- - MONGO_INITDB_ROOT_PASSWORD=mongo
- - MONGO_INITDB_DATABASE=ACAP
- volumes:
- - mongo_data:/data/db
- ports:
- - 27017:27017
- networks:
- - acap-network
- restart: unless-stopped
-
- minio:
- image: "bitnami/minio"
- container_name: minio
- ports:
- - "9000:9000"
- - "9002:9001" # Management UI port (optional)
- environment:
- - MINIO_ROOT_USER=minio
- - MINIO_ROOT_PASSWORD=minio2024
- - MINIO_SKIP_CLIENT=yes
- - MINIO_DEFAULT_BUCKETS=acap
- volumes:
- - minio_data:/bitnami/minio/data
- networks:
- - acap-network
- restart: unless-stopped
-
- mosquitto:
- image: eclipse-mosquitto
- container_name: mosquitto
- ports:
- - 1883:1883
- - 9001:9001
- volumes:
- - mosquitto_data:/mosquitto/data
- - ./mosquitto.conf:/mosquitto/config/mosquitto.conf
- - mosquitto_log:/mosquitto/log
- networks:
- - acap-network
- restart: unless-stopped
-
- kafka:
- image: 'bitnami/kafka'
- container_name: kafka
- ports:
- - '9092:9092'
- - '9093:9093'
- volumes:
- - kafka_data:/bitnami/kafka
- environment:
- - KAFKA_CFG_NODE_ID=1
- - KAFKA_CFG_PROCESS_ROLES=broker,controller
- - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=1@kafka:9093
- - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093
- - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092
- - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
- - KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true
- - KAFKA_CFG_OFFSETS_TOPIC_REPLICATION_FACTOR=1
- - KAFKA_CFG_TRANSACTION_STATE_LOG_REPLICATION_FACTOR=1
- - KAFKA_CFG_TRANSACTION_STATE_LOG_MIN_ISR=1
- - KAFKA_CFG_LOG_DIRS=/bitnami/kafka/data
- - ALLOW_PLAINTEXT_LISTENER=yes
- networks:
- - acap-network
- restart: unless-stopped
-
- kafdrop:
- image: obsidiandynamics/kafdrop
- container_name: kafdrop
- ports:
- - '9003:9000'
- environment:
- KAFKA_BROKERCONNECT: 'kafka:9092'
- JVM_OPTS: '-Xms32M -Xmx64M'
- depends_on:
- - kafka
- networks:
- - acap-network
-
- rabbitmq:
- image: rabbitmq
- container_name: rabbitmq
- ports:
- - "5672:5672"
- - "15672:15672"
- volumes:
- - rabbitmq_data:/bitnami/rabbitmq
- - ./apps/ms-bridge/rabbitmq.conf:/etc/rabbitmq/rabbitmq.conf
- networks:
- - acap-network
- restart: unless-stopped
-
-volumes:
- mongo_data:
- minio_data:
- keydb_data:
- kafka_data:
- rabbitmq_data:
- mosquitto_data:
- mosquitto_config:
- mosquitto_log:
-
-networks:
- acap-network:
- driver: bridge
-```
-
-
-
-
-
-
-As mentioned earlier, you can still utilize system environment variables either in conjunction with the config.yml file. System environment variables, if set, take precedence over the values specified in the config.yml file. Here are the system environment variables that are available for utilization.
-
-Expand to see the sample .env file
-
-
-
-```sh
-PORT=3001
-ADDRESS='0.0.0.0'
-NODE_ENV='local'
-REALM_TTL=300
-REALM_NAMESPACE_POSTFIX='ACAP'
-REALM_GZIP_THRESHOLD=20
-PRINT_ENV=true
-START_SWAGGER=true
-REALM_RESOLVE_ENV=true
-USE_REDIS_PUBSUB=true
-USE_BULLMQ=true
-USE_MQTT=true
-SYMMETRIC_KEY='a4e8b65e2c3e167942bcf48abf6e9d71'
-BODY_LIMIT=104857600
-
-REDIS_PUBSUB_PORT=6379
-REDIS_PUBSUB_USER='default'
-REDIS_PUBSUB_PASS='redis'
-REDIS_PUBSUB_HOST='redis'
-
-BULLMQ_REDIS_PORT=6379
-BULLMQ_REDIS_USER='default'
-BULLMQ_REDIS_PASS='redis'
-BULLMQ_REDIS_HOST='redis'
-
-MQTT_KEEPALIVE=5000
-MQTT_CONNECTION_TIMEOUT=5000
-MQTT_RECONNECT_PERIOD=1000
-MQTT_RESUBSCRIBE=true
-MQTT_BROKER_URL='mqtt://localhost'
-MQTT_PROTOCOL='mqtt'
-MQTT_HOSTNAME='localhost'
-MQTT_PORT=1883
-MQTT_USERNAME='mqtt'
-MQTT_PASSWORD='mqtt'
-
-MONGO_USER='mongo'
-MONGO_PASS='mongo'
-MONGO_DB_NAME='ACAP'
-MONGO_URI='mongodb://mongo:27017'
-MONGO_SSL=false
-MONGO_TLS_ALLOW_INVALID_CERTIFICATES=true
-
-REDIS_USER='default'
-REDIS_PASS='redis'
-REDIS_HOST='redis'
-REDIS_PORT=6379
-REDIS_TTL=600
-REDIS_MAX_RESPONSES=100
-REDIS_DB_INDEX=0
-
-MINIO_ENDPOINT='minio'
-MINIO_ACCESS_KEY='minio'
-MINIO_SECRET_KEY='minio'
-MINIO_PORT=9000
-MINIO_USE_SSL=false
-MINIO_BUCKET='acap'
-```
-
-
-
-
-
-
-With this, you have everything you need to make the ACAP your own and harness its full potential to power your applications and drive business growth.
-
-
-
-## Serialization and Persistance
-
-Structured data, like JSON and YAML, is housed in mongoDB for persistence. Meanwhile, unstructured data such as images and files is stored in minio, with their metadata structured and stored in mongoDB for efficient retrieval. Structured is cached by redis, while unstructured is cached and managed by minio.
-
-
-
-## Example Use Cases
-
-One example use case for ACAP could be serving base64-encoded images to web clients. This setup allows for dynamic switching of content on the fly, similar to how it is commonly done in a content management system (CMS). Of course, this capability is not limited solely to images.
-
-Another use case could involve inter-service communication, enabling a centralized configuration as a single source of truth. This can be achieved by leveraging technologies such as **bullMQ**, **MQTT** and **RedisPubSub** which facilitate real-time provision and distribution of these configurations.
-
-There are instances where utilizing ACAP as a proxy can be advantageous. By creating content that references external sources holding the required datasets, you can leverage the capabilities of ACAP without the need for directly handling large datasets. This approach greatly enhances the efficiency of data retrieval and management.
-
-In certain scenarios, there may be a need to describe and validate content. ACAP accomplishes this by utilizing JSON schema with the help of **avj**. In IDEs like **Visual Studio Code** and similar environments, you have the ability to link the **$schema** , which enables highlighting and validation. Alternatively, you can fetch the schema on the client side and perform data validation in real time during runtime.
-
-## Whats in the box?
-
-Postman, Insomnia and Swagger OpenApi were yesterday! ACAP delivers a sleek, modern, and intuitive user interface, designed to effortlessly manage and organize your content (**WIP**). With crisp content management and immediate processing, your experience is seamless and efficient. ACAP simplifies the process for developers to enable or disable optional features like Redis Publish Subscribe, MQTT, and BullMQ as per their requirements.
-
-### Content Validation
-
-When creating and managing content, you can freely choose between a strict or lenient approach to describe its structure. Validation of your content involves checking if a JSON schema matches the content. ACAP knows which content belongs to which schema by simply referencing the realm identifier. In simpler terms, if you create content with a realm value of **MY_REALM** and a schema that also has a realm value of **MY_REALM**, your content will be validated against that schema. The content itself is not bound to any particular structure or value. It even has the capability to fetch system variables when enabled, as long as the content identifier matches the specified system variable key. By default, this feature is disabled to ensure security. For a more comprehensive understanding of content and schema declarations, please refer to the [Wiki](https://github.com/ehildt/ACAP/wiki/ACAP).
-
-`This powerful feature provides industry-leading flexibility in managing content structure, empowering companies to customize and validate their content with ease and efficiency. Experience unparalleled control and adaptability in content management, unlocking new possibilities for your business's success.`
-
-### Content Encryption
-
-In ACAP, we prioritize your freedom of choice, including your security preferences. By default, ACAP conducts content upserts without encryption, suitable for most scenarios. However, recognizing the paramount importance of data security, we empower you to strengthen defenses by encrypting content before it's stored.
-
-Within ACAP, we leverage the globally recognized Advanced Encryption Standard (AES). You have access to multiple block cipher modes: AES-256-CBC, AES-192-CBC, and AES-128-CBC, with respective key lengths of 32, 24, and 16 bytes.
-
-In essence, these AES-CBC modes form a robust security foundation. Your choice depends on specific security and performance needs. Opt for AES-256-CBC for peak security, accepting a slight performance trade-off. Or choose AES-128-CBC, delivering strong security without performance compromise. For a balanced blend, consider AES-192-CBC.
-
-With ACAP, it's your data, your choice, fortified by our robust security options. Elevate your data protection standards while retaining the flexibility to apply encryption as you see fit. Your security, your way, with ACAP's formidable security toolkit.
+`Have inquiries or eager to engage and contribute?`
+`Don't hesitate to reach out to us via email or by creating an issue`
-
-
-Expand to get more insight into AES
-
+
+ Wiki |
+ Report an Issue |
+ Contact Us |
+ Support us
+
-${\color{pink}AES-256-CBC}$
-
-Security: AES-256-CBC uses a 256-bit key, which provides a very high level of security. As of 2021, it is considered highly secure and resistant to brute force attacks. The key length is so long that it would require an astronomical amount of computational power and time to break the encryption by trying all possible keys. Drawbacks: The main drawback of AES-256-CBC is its computational overhead. Encrypting and decrypting data with a longer key can be slower compared to AES-128-CBC or AES-192-CBC. This difference may not be noticeable for small amounts of data but could become significant for large datasets or high-throughput applications.
-
-${\color{pink}AES-192-CBC}$
-
-Security: AES-192-CBC uses a 192-bit key, which is also considered very secure. It strikes a balance between the strong security of AES-256-CBC and the computational efficiency of AES-128-CBC. Drawbacks: Like AES-256-CBC, the main drawback is the computational overhead, although it's generally slightly faster than AES-256-CBC. It may be a good choice when you need strong security but want slightly better performance than AES-256-CBC.
-
-${\color{pink}AES-128-CBC}$
-
-Security: AES-128-CBC uses a 128-bit key, which is still considered secure but is theoretically more susceptible to brute force attacks compared to AES-192-CBC and AES-256-CBC. However, in practice, it offers a high level of security for most applications. Drawbacks: The primary advantage of AES-128-CBC is its speed and lower computational overhead. It's generally faster than AES-192-CBC and AES-256-CBC. The drawback is that, in rare cases of highly motivated attackers with immense computational resources, it might be less secure compared to the longer key lengths.
-
-
-
-
-### KeyDB
-
-Under the hood, ACAP utilizes [KeyDB](https://docs.keydb.dev/), a drop-in alternative for [Redis](https://redis.io/). ACAP builds on top of KeyDB and efficiently updates the cache whenever content is modified or fetched. Notably, only structured data is cached in memory. Unstructured data and all optimization are handled by MinIO. However, the metadata of unstructured files is stored and cached in memory as a reference and persisted in MongoDB.
-
-> KeyDB, ValKey, and Dragonfly are just a few drop-in alternatives to Redis. Feel free to use any compatible in-memory cache service you prefer.
-
-`KeyDB is a high performance open source database used at Snap, and a powerful drop-in alternative to Redis. While many databases keep the best features locked in their paid offerings, KeyDB remains fully open source. This best enables Snap & the community to collaborate and benefit together in the projects development.`
-
-### Publish Subscribe
-
-ACAP supports [PubSub](https://redis.io/docs/interact/pubsub/). When this feature is enabled, ACAP automatically publishes content using the realm as the channel, which can be subscribed to by other clients and services. The **fire-and-forget** strategy for **Redis Publish Subscribe** ensures non-blocking transmission, allowing for a seamless content distribution without any interruptions.
-
-### MQTT
-
-[MQTT](https://mqtt.org/) plays a crucial role in enhancing ACAP by addressing key communication challenges in the IoT ecosystem. With MQTT, ACAP benefits from the following features:
-
-- **Lightweight and Efficient:** MQTT's lightweight nature ensures minimal bandwidth usage and a small footprint, allowing ACAP to optimize resource utilization while maintaining efficient communication between devices.
-
-- **Reliable Message Delivery:** ACAP leverages MQTT's message queuing capabilities, enabling devices to reliably publish messages to specific topics. This ensures that important data is delivered without loss or duplication, guaranteeing the integrity of the information exchanged.
-- **Scalability:** MQTT's scalable nature allows ACAP to accommodate a growing number of devices within the IoT ecosystem. As your service expands, MQTT ensures seamless and efficient communication, enabling ACAP to handle a large volume of messages without sacrificing performance.
-- **Real-time Data Exchange:** MQTT's ability to handle unreliable networks makes it an ideal choice for ACAP. It ensures that real-time data exchange between devices occurs smoothly, even in challenging network conditions, enhancing the overall reliability and responsiveness of your service. By utilizing MQTT, ACAP leverages the power of this open-standard protocol to overcome communication hurdles, optimize resource usage, ensure reliable message delivery, and provide a scalable solution for real-time data exchange in IoT deployments.
-
-### Kafka
-
-Before emitting data to Kafka, make sure you create the **ACAP_BRCS** topic. This is where ACAPs MSBridge will emit it's data.
-
-to be continue..
-
-### RabbitMQ
-
-to be continue..
-
-### BullMQ
-
-[BullMQ](https://docs.bullmq.io/), a powerful job and message queue library, brings several benefits to ACAP, enhancing its capabilities and performance. Here's how BullMQ benefits ACAP:
-
-- **Job Management:** BullMQ enables ACAP to efficiently manage and prioritize jobs within the system. It provides features such as job scheduling, retries, and prioritization, ensuring that tasks are executed in a controlled and organized manner.
-
-- **Scalability and Performance:** BullMQ is designed to handle high volumes of jobs and messages, making it an ideal solution for scaling ACAP. It optimizes resource utilization, allowing ACAP to process tasks efficiently and maintain high performance even under heavy workloads.
-
-- **Distributed Processing:** BullMQ supports distributed processing, allowing ACAP to distribute jobs across multiple workers or nodes. This enables parallel processing, improves overall system throughput, and enhances the speed of task execution.
-
-- **Fault Tolerance:** BullMQ incorporates fault-tolerant mechanisms, ensuring that ACAP can recover from failures gracefully It provides features like job persistence and automatic retries, minimizing the impact of failures on the system's overall performance and reliability.
-
-- **Monitoring and Analytics:** BullMQ offers monitoring and analytics capabilities, providing insights into job execution latency, and throughput. This allows ACAP to track performance metrics, identify bottlenecks, and optimize its job processing workflow for better efficiency.
-
-By leveraging BullMQ, ACAP gains robust job management, scalability, fault tolerance, and monitoring capabilities, enabling it to handle large workloads, provide efficient task execution, and deliver a reliable and high-performance service to its users.
-
-## Outbreak API
-
-ACAP offers a convenient way to bypass its internal mechanisms that handle content persistence in the database and cache algorithm. Instead, you can effortlessly delegate the content directly to Redis Publish Subscribe, bullMQ, and MQTT. This functionality effectively covers edge cases where developers need to trigger events without relying on ACAP's underlying mechanisms. By utilizing these services, developers gain greater flexibility in managing content and achieving specific requirements within ACAP.
-
-**CAVEAT -** It is important to understand that due to certain technical constraints, modifying the channel for the bullMQ through which the content is sent is not possible. Therefore, all data must still be routed through the predefined channel known as `ACAP_MSBR`. This limitation restricts the flexibility in selecting alternative channels for specific data. However, when it comes to Redis Publish Subscribe and MQTT, the channel corresponds to the respective REALM to which the content is sent. Nonetheless, ACAP's integration with Redis Publish Subscribe, bullMQ, and MQTT empowers developers to leverage their functionalities, thereby enabling enhanced event triggering and management capabilities.
-
----
-
-`Get in touch with us if you're eager to contribute to ACAP and show your support, or show some love by treating us to a beer or coffee. We appreciate any form of collaboration and generosity!`
diff --git a/apps/backend/CHANGELOG.md b/apps/backend/CHANGELOG.md
index 745cc63f..b3496be1 100644
--- a/apps/backend/CHANGELOG.md
+++ b/apps/backend/CHANGELOG.md
@@ -1,12 +1,5 @@
# @acap/backend
-## 2.0.0
-
-### Major Changes
-
-- 303f70d: # First Init
-
- Changeset init, replacing semantic release and it's previous CHANGELOG.
## 1.0.1
### Patch Changes
diff --git a/apps/backend/jest.config.ts b/apps/backend/jest.config.ts
index df53730c..8556ec41 100755
--- a/apps/backend/jest.config.ts
+++ b/apps/backend/jest.config.ts
@@ -1,4 +1,4 @@
-module.exports = {
+export default {
preset: "ts-jest",
moduleFileExtensions: ["js", "json", "ts"],
roots: ["
/src"],
@@ -12,10 +12,10 @@ module.exports = {
coverageReporters: ["clover", "json", "cobertura"],
coverageThreshold: {
global: {
- branches: 30,
- functions: 30,
- lines: 30,
- statements: 30,
+ branches: 25,
+ functions: 25,
+ lines: 25,
+ statements: 25,
},
},
collectCoverageFrom: [
diff --git a/apps/backend/package.json b/apps/backend/package.json
index 9f072074..95e5e6ef 100755
--- a/apps/backend/package.json
+++ b/apps/backend/package.json
@@ -85,7 +85,7 @@
"jest": "^29.7.0",
"jest-extended": "^4.0.2",
"jest-junit": "^16.0.0",
- "lint-staged": "^15.2.4",
+ "lint-staged": "^15.2.5",
"npm-check-updates": "^16.14.20",
"prettier": "^3.2.5",
"source-map-support": "^0.5.21",
diff --git a/apps/backend/src/controllers/blob.controller.spec.ts b/apps/backend/src/controllers/blob.controller.spec.ts
new file mode 100644
index 00000000..603de066
--- /dev/null
+++ b/apps/backend/src/controllers/blob.controller.spec.ts
@@ -0,0 +1,115 @@
+import { Test, TestingModule } from "@nestjs/testing";
+
+import { BlobService } from "@/services/blob.service";
+import { ConfigFactoryService } from "@/services/config-factory.service";
+
+import { ObjectController } from "./blob.controller";
+
+describe("ObjectController", () => {
+ let controller: ObjectController;
+ let blobService: BlobService;
+ let factoryService: ConfigFactoryService;
+
+ beforeEach(async () => {
+ const module: TestingModule = await Test.createTestingModule({
+ controllers: [ObjectController],
+ providers: [
+ {
+ provide: BlobService,
+ useValue: {
+ getObject: jest.fn(),
+ putObject: jest.fn(),
+ },
+ },
+ {
+ provide: ConfigFactoryService,
+ useValue: {
+ minio: { bucket: "test-bucket" },
+ },
+ },
+ ],
+ }).compile();
+
+ controller = module.get(ObjectController);
+ blobService = module.get(BlobService);
+ factoryService = module.get(ConfigFactoryService);
+ });
+
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+
+ it("should be defined", () => {
+ expect(controller).toBeDefined();
+ });
+
+ describe("getObject", () => {
+ it("should call blobService.getObject with correct cuid2 and bucket", async () => {
+ const cuid2 = "test-cuid2";
+ const result = { file: "test-file" as any };
+ jest.spyOn(blobService, "getObject").mockResolvedValueOnce(result as any);
+ await expect(controller.getObject(cuid2)).resolves.toEqual(result.file);
+ expect(blobService.getObject).toHaveBeenCalledWith(
+ cuid2,
+ factoryService.minio.bucket,
+ );
+ });
+ });
+
+ describe("putObjects", () => {
+ it("should call blobService.putObject for each file and return uploaded blobs", async () => {
+ const request = {
+ files: jest.fn().mockImplementation(() => [
+ {
+ toBuffer: jest.fn().mockResolvedValueOnce(Buffer.from("test-data")),
+ filename: "test.txt",
+ mimetype: "text/plain",
+ },
+ {
+ toBuffer: jest.fn().mockResolvedValueOnce(Buffer.from("test-data")),
+ filename: "test2.txt",
+ mimetype: "text/plain",
+ },
+ ]),
+ };
+ const expectedUploadedBlobs = [
+ {
+ filename: "test.txt",
+ mimetype: "text/plain",
+ cuid2: expect.any(String),
+ },
+ {
+ filename: "test2.txt",
+ mimetype: "text/plain",
+ cuid2: expect.any(String),
+ },
+ ];
+
+ await expect(controller.putObjects(request)).resolves.toEqual(
+ expectedUploadedBlobs,
+ );
+
+ expect(blobService.putObject).toHaveBeenCalledTimes(2);
+ expect(blobService.putObject).toHaveBeenCalledWith(
+ factoryService.minio.bucket,
+ expect.any(String),
+ expect.any(Buffer),
+ expect.any(Number),
+ expect.objectContaining({
+ filename: "test.txt",
+ mimetype: "text/plain",
+ }),
+ );
+ expect(blobService.putObject).toHaveBeenCalledWith(
+ factoryService.minio.bucket,
+ expect.any(String),
+ expect.any(Buffer),
+ expect.any(Number),
+ expect.objectContaining({
+ filename: "test2.txt",
+ mimetype: "text/plain",
+ }),
+ );
+ });
+ });
+});
diff --git a/apps/backend/src/services/blob.service.spec.ts b/apps/backend/src/services/blob.service.spec.ts
new file mode 100644
index 00000000..52dd4e4b
--- /dev/null
+++ b/apps/backend/src/services/blob.service.spec.ts
@@ -0,0 +1,66 @@
+import { Test, TestingModule } from "@nestjs/testing";
+
+import { MINIO_CLIENT } from "@/modules/minio-client.module";
+
+import { BlobService } from "./blob.service";
+
+describe("BlobService", () => {
+ let service: BlobService;
+ const mockMinioClient = {
+ getObject: jest.fn(),
+ createBucketIfNotExists: jest.fn(),
+ putObject: jest.fn(),
+ };
+
+ beforeEach(async () => {
+ const module: TestingModule = await Test.createTestingModule({
+ providers: [
+ BlobService,
+ {
+ provide: MINIO_CLIENT,
+ useValue: mockMinioClient,
+ },
+ ],
+ }).compile();
+
+ service = module.get(BlobService);
+ });
+
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+
+ it("should be defined", () => {
+ expect(service).toBeDefined();
+ });
+
+ describe("getObject", () => {
+ it("should call minioClient.getObject with correct parameters", async () => {
+ const id = "test-id";
+ const bucket = "test-bucket";
+ await service.getObject(id, bucket);
+ expect(mockMinioClient.getObject).toHaveBeenCalledWith(bucket, id);
+ });
+ });
+
+ describe("putObject", () => {
+ it("should call minioClient.createBucketIfNotExists and minioClient.putObject with correct parameters", async () => {
+ const bucketName = "test-bucket";
+ const objectName = "test-object";
+ const stream = "test-stream";
+ const size = 123;
+ const metaData = { key: "value" };
+ await service.putObject(bucketName, objectName, stream, size, metaData);
+ expect(mockMinioClient.createBucketIfNotExists).toHaveBeenCalledWith(
+ bucketName,
+ );
+ expect(mockMinioClient.putObject).toHaveBeenCalledWith(
+ bucketName,
+ objectName,
+ stream,
+ size,
+ metaData,
+ );
+ });
+ });
+});
diff --git a/apps/backend/tsconfig.json b/apps/backend/tsconfig.json
index cf3ae80d..57f1cb99 100755
--- a/apps/backend/tsconfig.json
+++ b/apps/backend/tsconfig.json
@@ -15,5 +15,10 @@
}
},
"files": ["shims.d.ts"],
- "include": ["src/", "eslint.config.mjs", ".prettier.config.mjs"]
+ "include": [
+ "src/",
+ "eslint.config.mjs",
+ ".prettier.config.mjs",
+ "jest.config.ts"
+ ]
}
diff --git a/apps/frontend/package.json b/apps/frontend/package.json
index 31946bef..76d0a2e7 100755
--- a/apps/frontend/package.json
+++ b/apps/frontend/package.json
@@ -94,7 +94,7 @@
"globals": "^15.3.0",
"husky": "^9.0.11",
"jsdom": "latest",
- "lint-staged": "^15.2.4",
+ "lint-staged": "^15.2.5",
"npm-check-updates": "^16.14.20",
"postcss": "^8.4.38",
"prettier": "^3.2.5",
diff --git a/apps/ms-bridge/CHANGELOG.md b/apps/ms-bridge/CHANGELOG.md
index d04c2344..db45b86d 100644
--- a/apps/ms-bridge/CHANGELOG.md
+++ b/apps/ms-bridge/CHANGELOG.md
@@ -1,12 +1,5 @@
# @acap/ms-bridge
-## 2.0.0
-
-### Major Changes
-
-- 303f70d: # First Init
-
- Changeset init, replacing semantic release and it's previous CHANGELOG.
## 1.0.1
### Patch Changes
diff --git a/apps/ms-bridge/jest.config.ts b/apps/ms-bridge/jest.config.ts
index 5b984377..8556ec41 100755
--- a/apps/ms-bridge/jest.config.ts
+++ b/apps/ms-bridge/jest.config.ts
@@ -12,10 +12,10 @@ export default {
coverageReporters: ["clover", "json", "cobertura"],
coverageThreshold: {
global: {
- branches: 30,
- functions: 30,
- lines: 30,
- statements: 30,
+ branches: 25,
+ functions: 25,
+ lines: 25,
+ statements: 25,
},
},
collectCoverageFrom: [
diff --git a/apps/ms-bridge/package.json b/apps/ms-bridge/package.json
index c801f700..1aa80dd5 100755
--- a/apps/ms-bridge/package.json
+++ b/apps/ms-bridge/package.json
@@ -85,7 +85,7 @@
"jest": "^29.7.0",
"jest-extended": "^4.0.2",
"jest-junit": "^16.0.0",
- "lint-staged": "^15.2.4",
+ "lint-staged": "^15.2.5",
"npm-check-updates": "^16.14.20",
"prettier": "^3.2.5",
"rimraf": "^5.0.7",
diff --git a/apps/ms-bridge/src/services/outbreak.service.spec.ts b/apps/ms-bridge/src/services/outbreak.service.spec.ts
index 3769cc11..7d4556ef 100644
--- a/apps/ms-bridge/src/services/outbreak.service.spec.ts
+++ b/apps/ms-bridge/src/services/outbreak.service.spec.ts
@@ -1,11 +1,13 @@
-import { ClientKafka, ClientProxy } from "@nestjs/microservices";
+import { ClientKafka, ClientProxy, ClientRMQ } from "@nestjs/microservices";
import { Test } from "@nestjs/testing";
-import { Queue } from "bullmq";
+import { Queue, Worker } from "bullmq";
import { AppBrokers } from "@/configs/config-yml/config.model";
import {
ACAP_BRCS,
+ ACAP_MSBR,
KAFKA_CLIENT,
+ RABBITMQ_CLIENT,
REDIS_PUBSUB,
} from "@/constants/app.constants";
import { BreakoutUpsertReq } from "@/dtos/breakout-upsert.dto.req";
@@ -14,10 +16,17 @@ import { MQTT_CLIENT, MqttClient } from "@/modules/mqtt-client.module";
import { ConfigFactoryService } from "./config-factory.service";
import { OutbreakService } from "./outbreak.service";
+jest.mock("bullmq", () => ({
+ Worker: jest.fn(() => ({
+ run: jest.fn(),
+ })),
+}));
+
describe("OutbreakService", () => {
let outbreakService: OutbreakService;
let mockRedisPubSub: jest.Mocked;
let mockKafka: jest.Mocked;
+ let mockRabbitMQ: jest.Mocked;
let mockMQTTClient: jest.Mocked;
let mockBullMQQueue: jest.Mocked;
let mockConfigFactory: Partial;
@@ -26,7 +35,9 @@ describe("OutbreakService", () => {
mockConfigFactory = {
app: {
brokers: {},
- bullMQ: {},
+ } as any,
+ bullMQ: {
+ connection: {},
} as any,
};
const moduleRef = await Test.createTestingModule({
@@ -48,6 +59,12 @@ describe("OutbreakService", () => {
emit: jest.fn(),
},
},
+ {
+ provide: RABBITMQ_CLIENT,
+ useValue: {
+ emit: jest.fn(),
+ },
+ },
{
provide: MQTT_CLIENT,
useValue: {
@@ -57,7 +74,7 @@ describe("OutbreakService", () => {
{
provide: ACAP_BRCS,
useValue: {
- add: jest.fn(),
+ add: jest.fn().mockResolvedValue(true),
},
},
],
@@ -68,6 +85,7 @@ describe("OutbreakService", () => {
mockMQTTClient = moduleRef.get(MQTT_CLIENT);
mockBullMQQueue = moduleRef.get(ACAP_BRCS);
mockKafka = moduleRef.get(KAFKA_CLIENT);
+ mockRabbitMQ = moduleRef.get(RABBITMQ_CLIENT);
});
afterEach(() => {
@@ -75,6 +93,13 @@ describe("OutbreakService", () => {
});
describe("delegate", () => {
+ it("should initialize Worker on module init", () => {
+ outbreakService.onModuleInit();
+ expect(Worker).toHaveBeenCalledWith(ACAP_MSBR, expect.any(Function), {
+ connection: mockConfigFactory.bullMQ.connection,
+ });
+ });
+
it("should distribute data to realms using enabled messaging options", async () => {
const reqs: BreakoutUpsertReq[] = [
{
@@ -92,15 +117,16 @@ describe("OutbreakService", () => {
useKafka: true,
useRedisPubSub: true,
useMQTT: true,
- useBullMQ: true,
+ useBullMQ: false,
};
await outbreakService.delegate(reqs, args);
expect(mockRedisPubSub.emit).toHaveBeenCalledTimes(2);
expect(mockKafka.emit).toHaveBeenCalledTimes(2);
expect(mockMQTTClient.publish).toHaveBeenCalledTimes(2);
- // TODO: fix test - mockable?
- expect(mockBullMQQueue.add).toHaveBeenCalledTimes(0);
+ expect(mockRabbitMQ.emit).toHaveBeenCalledTimes(2);
+ // TODO: is this one mockable at all?
+ expect(mockBullMQQueue.add).not.toHaveBeenCalled();
});
it("should not distribute data if no messaging options are enabled", async () => {
diff --git a/cspell.ignore.txt b/cspell.ignore.txt
index 2082fcc8..8c251075 100755
--- a/cspell.ignore.txt
+++ b/cspell.ignore.txt
@@ -84,6 +84,7 @@ Securityscorecard
Servicestack
sonarjs
spdx
+transformative
treeshake
tseslint
upserted
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 390173b9..1a7e942f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -172,8 +172,8 @@ importers:
specifier: ^16.0.0
version: 16.0.0
lint-staged:
- specifier: ^15.2.4
- version: 15.2.4
+ specifier: ^15.2.5
+ version: 15.2.5
npm-check-updates:
specifier: ^16.14.20
version: 16.14.20
@@ -389,8 +389,8 @@ importers:
specifier: latest
version: 24.0.0(canvas@2.11.2(encoding@0.1.13))
lint-staged:
- specifier: ^15.2.4
- version: 15.2.4
+ specifier: ^15.2.5
+ version: 15.2.5
npm-check-updates:
specifier: ^16.14.20
version: 16.14.20
@@ -582,8 +582,8 @@ importers:
specifier: ^16.0.0
version: 16.0.0
lint-staged:
- specifier: ^15.2.4
- version: 15.2.4
+ specifier: ^15.2.5
+ version: 15.2.5
npm-check-updates:
specifier: ^16.14.20
version: 16.14.20
@@ -4578,10 +4578,6 @@ packages:
resolution: {integrity: sha512-L0cdwZrKlwZQkMSFnCflJ6J2Y+5egO/p3vgRSDQGxQt++QbUZe5gMbRO6kg6gzwQDPvq2Fk9AmoxUNfZ5gdqaQ==}
engines: {node: '>= 10.4.0'}
- fill-range@7.0.1:
- resolution: {integrity: sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==}
- engines: {node: '>=8'}
-
fill-range@7.1.1:
resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==}
engines: {node: '>=8'}
@@ -5777,8 +5773,8 @@ packages:
lines-and-columns@1.2.4:
resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==}
- lint-staged@15.2.4:
- resolution: {integrity: sha512-3F9KRQIS2fVDGtCkBp4Bx0jswjX7zUcKx6OF0ZeY1prksUyKPRIIUqZhIUYAstJfvj6i48VFs4dwVIbCYwvTYQ==}
+ lint-staged@15.2.5:
+ resolution: {integrity: sha512-j+DfX7W9YUvdzEZl3Rk47FhDF6xwDBV5wwsCPw6BwWZVPYJemusQmvb9bRsW23Sqsaa+vRloAWogbK4BUuU2zA==}
engines: {node: '>=18.12.0'}
hasBin: true
@@ -5999,6 +5995,10 @@ packages:
resolution: {integrity: sha512-Y4Ypn3oujJYxJcMacVgcs92wofTHxp9FzfDpQON4msDefoC0lb3ETvQLOdLcbhSwU1bz8HrL/1sygfBIHudrkQ==}
engines: {node: '>=8.6'}
+ micromatch@4.0.7:
+ resolution: {integrity: sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==}
+ engines: {node: '>=8.6'}
+
mime-db@1.52.0:
resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==}
engines: {node: '>= 0.6'}
@@ -9902,7 +9902,7 @@ snapshots:
jest-haste-map: 29.7.0
jest-regex-util: 29.6.3
jest-util: 29.7.0
- micromatch: 4.0.6
+ micromatch: 4.0.7
pirates: 4.0.6
slash: 3.0.0
write-file-atomic: 4.0.2
@@ -12303,7 +12303,7 @@ snapshots:
braces@3.0.2:
dependencies:
- fill-range: 7.0.1
+ fill-range: 7.1.1
braces@3.0.3:
dependencies:
@@ -13699,10 +13699,6 @@ snapshots:
filesize@10.1.1: {}
- fill-range@7.0.1:
- dependencies:
- to-regex-range: 5.0.1
-
fill-range@7.1.1:
dependencies:
to-regex-range: 5.0.1
@@ -13755,7 +13751,7 @@ snapshots:
find-yarn-workspace-root2@1.2.16:
dependencies:
- micromatch: 4.0.6
+ micromatch: 4.0.7
pkg-dir: 4.2.0
findup-sync@5.0.0:
@@ -14737,7 +14733,7 @@ snapshots:
jest-runner: 29.7.0
jest-util: 29.7.0
jest-validate: 29.7.0
- micromatch: 4.0.6
+ micromatch: 4.0.7
parse-json: 5.2.0
pretty-format: 29.7.0
slash: 3.0.0
@@ -14797,7 +14793,7 @@ snapshots:
jest-regex-util: 29.6.3
jest-util: 29.7.0
jest-worker: 29.7.0
- micromatch: 4.0.6
+ micromatch: 4.0.7
walker: 1.0.8
optionalDependencies:
fsevents: 2.3.3
@@ -14828,7 +14824,7 @@ snapshots:
'@types/stack-utils': 2.0.3
chalk: 4.1.2
graceful-fs: 4.2.11
- micromatch: 4.0.6
+ micromatch: 4.0.7
pretty-format: 29.7.0
slash: 3.0.0
stack-utils: 2.0.6
@@ -15041,7 +15037,7 @@ snapshots:
chalk: 4.1.2
flow-parser: 0.236.0
graceful-fs: 4.2.11
- micromatch: 4.0.6
+ micromatch: 4.0.7
neo-async: 2.6.2
node-dir: 0.1.17
recast: 0.23.6
@@ -15180,7 +15176,7 @@ snapshots:
lines-and-columns@1.2.4: {}
- lint-staged@15.2.4:
+ lint-staged@15.2.5:
dependencies:
chalk: 5.3.0
commander: 12.1.0
@@ -15188,7 +15184,7 @@ snapshots:
execa: 8.0.1
lilconfig: 3.1.1
listr2: 8.2.1
- micromatch: 4.0.6
+ micromatch: 4.0.7
pidtree: 0.6.0
string-argv: 0.3.2
yaml: 2.4.2
@@ -15438,6 +15434,11 @@ snapshots:
braces: 3.0.3
picomatch: 4.0.2
+ micromatch@4.0.7:
+ dependencies:
+ braces: 3.0.3
+ picomatch: 2.3.1
+
mime-db@1.52.0: {}
mime-types@2.1.35: