2022-09-16 17:37:12 +05:30
# WebSocket adapter
WebSocket adapter provides an [WebSocket ](https://en.wikipedia.org/wiki/WebSocket#:~:text=WebSocket%20is%20a%20computer%20communications,protocol%20is%20known%20as%20WebSockets. ) API for sending and receiving messages through the platform.
## Configuration
The service is configured using the environment variables presented in the
following table. Note that any unset variables will be replaced with their
default values.
2023-07-31 15:38:35 +03:00
| Variable | Description | Default |
| ------------------------------ | --------------------------------------------------- | ------------------------------ |
| MF_WS_ADAPTER_LOG_LEVEL | Log level for the WS Adapter | info |
| MF_WS_ADAPTER_HTTP_HOST | Service WS host | |
| MF_WS_ADAPTER_HTTP_PORT | Service WS port | 8190 |
| MF_WS_ADAPTER_HTTP_SERVER_CERT | Service WS server certificate | |
| MF_WS_ADAPTER_HTTP_SERVER_KEY | Service WS server key | |
| MF_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MF_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MF_THINGS_AUTH_GRPC_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
| MF_THINGS_AUTH_GRPC_CA_CERTS | Path to trusted CAs in PEM format | |
NOISSUE - Make MQTT Broker Configurable (#1904)
* Minor changes on mqtt publisher using nats
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Remove vernemq dependencies
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Restore VerneMQ config files
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix Makefile to support custom Docker profiles
The Makefile has been updated to support custom Docker profiles.
Previously, the Makefile only supported the default profiles for the
message broker and MQTT broker. Now, the Makefile allows for custom
profiles to be specified using environment variables. If the
MF_BROKER_TYPE or MF_MQTT_BROKER_TYPE variables are not set, the
default values "nats" and "nats" will be used, respectively. This
change enables more flexibility in configuring the Docker environment
for the project.
The `run` target has also been modified to use the correct broker
configuration file based on the MF_BROKER_TYPE variable. The sed
command in the `run` target now replaces the placeholder in the
docker/docker-compose.yml file with the appropriate broker
configuration file.
This commit improves the Makefile to support custom Docker profiles
and ensures the correct broker configuration file is used when
running the project.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix queue binding issue in RabbitMQ pubsub
The commit fixes an issue in the RabbitMQ pubsub implementation where the queue binding was not correctly set up. Instead of using the topic as the queue name, the commit now uses a unique client ID generated by combining the topic and subscriber ID. This ensures that each subscriber has its own dedicated queue. The commit also updates the queue binding to use the correct queue name.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Refactor Docker config editing in Makefile
The commit refactors the `edit_docker_config` function in the Makefile to improve readability and maintainability. The changes include:
- Removing unnecessary conditionals related to the `rabbitmq` broker
These changes ensure that the Docker configuration is correctly updated based on the specified MQTT broker type.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix failing tests on RabbitMQ
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Refactor MQTT_BROKER comment in docker-compose.yml
The MQTT_BROKER comment in the docker-compose.yml file has been updated to provide a more accurate description of its functionality. The comment now states that the MQTT_BROKER handles MQTT communication between MQTT adapters and the message broker, instead of Mainflux services. This change improves clarity and aligns with the actual purpose of the MQTT_BROKER.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Rename `MF_BROKER` to `MF_MESSAGE_BROKER`
The Makefile and Semaphore configuration files have been refactored to update the variable names related to the message broker type.
These changes ensure consistency and clarity in the codebase by using more descriptive variable names related to the message broker type.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix Docker profile configuration for nats_rabbitmq
Update the Docker profile configuration for nats_rabbitmq by replacing the NATS URL in the .env file with the correct value.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Rename MF_BROKER_URL to MF_MESSAGE_BROKER_URL
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix MQTT QoS level in pubsub.go
The MQTT QoS level in the pubsub.go file was set to 1, which is the
default level. However, since NATS supports up to QoS 1, I updated the
QoS level comment to reflect this.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Refactor NewPublisher to accept QoS parameter
The NewPublisher function in the pkg/messaging/mqtt/publisher.go file has been refactored to accept a new parameter, qos, which represents the Quality of Service level for MQTT message publishing. This change allows for more flexibility in configuring the MQTT publisher.
The NewPublisher function now has the following signature:
```go
func NewPublisher(address string, qos uint8, timeout time.Duration) (messaging.Publisher, error)
```
This change ensures that the MQTT publisher can be created with the desired QoS level, enhancing the reliability and delivery guarantees of the published messages.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix test assertions in pubsub_test.go
The test assertions in the pubsub_test.go file were incorrect. This commit fixes the assertions to properly compare the expected and received message values.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Test configurable MQTT broker
Signed-off-by: rodneyosodo <blackd0t@protonmail.com>
---------
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
Signed-off-by: rodneyosodo <blackd0t@protonmail.com>
2023-10-19 22:01:09 +03:00
| MF_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
2023-07-31 15:38:35 +03:00
| MF_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MF_SEND_TELEMETRY | Send telemetry to mainflux call home server | true |
| MF_WS_ADAPTER_INSTANCE_ID | Service instance ID | "" |
2022-09-16 17:37:12 +05:30
## Deployment
2023-07-31 15:38:35 +03:00
The service is distributed as Docker container. Check the [`ws-adapter` ](https://github.com/mainflux/mainflux/blob/master/docker/docker-compose.yml#L350-L368 ) service section in docker-compose to see how the service is deployed.
2022-09-16 17:37:12 +05:30
Running this service outside of container requires working instance of the message broker service.
To start the service outside of the container, execute the following shell script:
```bash
# download the latest version of the service
git clone https://github.com/mainflux/mainflux
cd mainflux
# compile the ws
make ws
# copy binary to bin
make install
# set the environment variables and run the service
MF_WS_ADAPTER_LOG_LEVEL=[WS adapter log level] \
2023-07-31 15:38:35 +03:00
MF_WS_ADAPTER_HTTP_HOST=[Service WS host] \
MF_WS_ADAPTER_HTTP_PORT=[Service WS port] \
MF_WS_ADAPTER_HTTP_SERVER_CERT=[Service WS server certificate] \
MF_WS_ADAPTER_HTTP_SERVER_KEY=[Service WS server key] \
2022-09-16 17:37:12 +05:30
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
2023-07-31 15:38:35 +03:00
MF_THINGS_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
MF_THINGS_AUTH_GRPC_CA_CERTS=[Path to trusted CAs in PEM format] \
NOISSUE - Make MQTT Broker Configurable (#1904)
* Minor changes on mqtt publisher using nats
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Remove vernemq dependencies
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Restore VerneMQ config files
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix Makefile to support custom Docker profiles
The Makefile has been updated to support custom Docker profiles.
Previously, the Makefile only supported the default profiles for the
message broker and MQTT broker. Now, the Makefile allows for custom
profiles to be specified using environment variables. If the
MF_BROKER_TYPE or MF_MQTT_BROKER_TYPE variables are not set, the
default values "nats" and "nats" will be used, respectively. This
change enables more flexibility in configuring the Docker environment
for the project.
The `run` target has also been modified to use the correct broker
configuration file based on the MF_BROKER_TYPE variable. The sed
command in the `run` target now replaces the placeholder in the
docker/docker-compose.yml file with the appropriate broker
configuration file.
This commit improves the Makefile to support custom Docker profiles
and ensures the correct broker configuration file is used when
running the project.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix queue binding issue in RabbitMQ pubsub
The commit fixes an issue in the RabbitMQ pubsub implementation where the queue binding was not correctly set up. Instead of using the topic as the queue name, the commit now uses a unique client ID generated by combining the topic and subscriber ID. This ensures that each subscriber has its own dedicated queue. The commit also updates the queue binding to use the correct queue name.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Refactor Docker config editing in Makefile
The commit refactors the `edit_docker_config` function in the Makefile to improve readability and maintainability. The changes include:
- Removing unnecessary conditionals related to the `rabbitmq` broker
These changes ensure that the Docker configuration is correctly updated based on the specified MQTT broker type.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix failing tests on RabbitMQ
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Refactor MQTT_BROKER comment in docker-compose.yml
The MQTT_BROKER comment in the docker-compose.yml file has been updated to provide a more accurate description of its functionality. The comment now states that the MQTT_BROKER handles MQTT communication between MQTT adapters and the message broker, instead of Mainflux services. This change improves clarity and aligns with the actual purpose of the MQTT_BROKER.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Rename `MF_BROKER` to `MF_MESSAGE_BROKER`
The Makefile and Semaphore configuration files have been refactored to update the variable names related to the message broker type.
These changes ensure consistency and clarity in the codebase by using more descriptive variable names related to the message broker type.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix Docker profile configuration for nats_rabbitmq
Update the Docker profile configuration for nats_rabbitmq by replacing the NATS URL in the .env file with the correct value.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Rename MF_BROKER_URL to MF_MESSAGE_BROKER_URL
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix MQTT QoS level in pubsub.go
The MQTT QoS level in the pubsub.go file was set to 1, which is the
default level. However, since NATS supports up to QoS 1, I updated the
QoS level comment to reflect this.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Refactor NewPublisher to accept QoS parameter
The NewPublisher function in the pkg/messaging/mqtt/publisher.go file has been refactored to accept a new parameter, qos, which represents the Quality of Service level for MQTT message publishing. This change allows for more flexibility in configuring the MQTT publisher.
The NewPublisher function now has the following signature:
```go
func NewPublisher(address string, qos uint8, timeout time.Duration) (messaging.Publisher, error)
```
This change ensures that the MQTT publisher can be created with the desired QoS level, enhancing the reliability and delivery guarantees of the published messages.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Fix test assertions in pubsub_test.go
The test assertions in the pubsub_test.go file were incorrect. This commit fixes the assertions to properly compare the expected and received message values.
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
* Test configurable MQTT broker
Signed-off-by: rodneyosodo <blackd0t@protonmail.com>
---------
Signed-off-by: Rodney Osodo <socials@rodneyosodo.com>
Signed-off-by: rodneyosodo <blackd0t@protonmail.com>
2023-10-19 22:01:09 +03:00
MF_MESSAGE_BROKER_URL=[Message broker instance URL] \
2023-07-31 15:38:35 +03:00
MF_JAEGER_URL=[Jaeger server URL] \
MF_SEND_TELEMETRY=[Send telemetry to mainflux call home server] \
MF_WS_ADAPTER_INSTANCE_ID=[Service instance ID] \
2022-09-16 17:37:12 +05:30
$GOBIN/mainflux-ws
```
## Usage
For more information about service capabilities and its usage, please check out
2023-06-14 12:40:37 +02:00
the [WebSocket paragraph ](https://mainflux.readthedocs.io/en/latest/messaging/#websocket ) in the Getting Started guide.
