Merge branch 'review46'

helyOSFramework · Sep 26, 2024 · fd0d7a5 · fd0d7a5
2 parents bc5159d + e6c47f5
commit fd0d7a5
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 47 deletions.
diff --git a/demo/docker-compose.yml b/demo/docker-compose.yml
@@ -1,7 +1,7 @@
 version: '3.5'
 services:
 
-# ----------------- Control Tower Database and Message Broker -----------------
+    # ----------------- Control Tower Database and Message Broker -----------------
 
     local_postgres:
         image: postgres:13
@@ -16,55 +16,53 @@ services:
         networks:
             - control-tower-net
 
-
-
     local_rabbitmq:
-        image:  rabbitmq:3-management
+        image: rabbitmq:3-management
         hostname: local_rabbitmq
         volumes:
             - rbmq_data:/var/lib/rabbitmq/
 
-        ports: 
-            - 5672:5672          
-            - 15672:15672        
+        ports:
+            - 5672:5672
+            - 15672:15672
 
         networks:
             - control-tower-net
 
-# ----------------- HelyOS Core -----------------
+    # ----------------- HelyOS Core -----------------
 
     helyos_core:
         image: helyosframework/helyos_core:test
 
         ports:
-            - 5002:5002  # Websocket
-            - 5000:5000  # GraphQL
-            - 8080:8080  # HelyOS Dashboard
-
+            - 5002:5002 # Websocket
+            - 5000:5000 # GraphQL
+            - 8080:8080 # HelyOS Dashboard
 
         volumes:
             - ./settings/config:/etc/helyos/config/
             - ./settings/db_initial_data/:/etc/helyos/db_initial_data/
             - ./settings/rsa_keys/helyos_private.key:/etc/helyos/.ssl_keys/helyos_private.key:ro
             - ./settings/rsa_keys/helyos_public.key:/etc/helyos/.ssl_keys/helyos_public.key:ro
 
-        environment: # Check the documentation for more details: https://helyos-manual.readthedocs.io/en/latest/2-helyos-configuration/getting-started.html#helyos-settings
-            # DATABASE 
-            - PGUSER=helyos_db_admin 
+        environment:
+            # Check the documentation for more details: https://helyos-manual.readthedocs.io/en/latest/2-helyos-configuration/getting-started.html#helyos-settings
+            # DATABASE
+            - PGUSER=helyos_db_admin
             - PGPASSWORD=helyos_secret
-            - PGHOST=local_postgres 
-            - PGDATABASE=smartfarm_db 
+            - PGHOST=local_postgres
+            - PGDATABASE=smartfarm_db
             - PGPORT=5432
-            
+
             # GRAPHQL VARIABLES
             - GQLPORT=5000
 
-            # RABBITMQ 
-            - RBMQ_HOST=local_rabbitmq 
+            # RABBITMQ
+            - RBMQ_HOST=local_rabbitmq
             - RBMQ_PORT=5672
             - RBMQ_API_PORT=15672
             - RBMQ_SSL=False
-            - RBMQ_API_SSL=False 
+            - RBMQ_API_SSL=False
 
             # RBMQ ACCOUNTS
             - CREATE_RBMQ_ACCOUNTS=True
@@ -73,67 +71,62 @@ services:
             - AGENT_AUTO_REGISTER_TOKEN=0001-0002-0003-0000-0004
 
             # HelyOS SETTINGS
-            - RUN_MODE=production  # test | production | migration
-            - MESSAGE_RATE_LIMIT=50 
+            - RUN_MODE=production # test | production | migration
+            - MESSAGE_RATE_LIMIT=50
             - MESSAGE_UPDATE_LIMIT=20
 
-
         networks:
             - control-tower-net
 
         depends_on:
             - local_postgres
             - local_rabbitmq
 
-
-
-# ----------------- A Simple Truck Simulator -----------------
+    # ----------------- A Simple Truck Simulator -----------------
 
     agent_simulator_1:
         image: helyosframework/helyos_agent_slim_simulator:0.7.5
 
-
         environment:
 
             # AGENT ID
-            - UUID=Ab34069fc5-fdgs-434b-b87e-f19c5435113 
-            - ASSIGNMENT_FORMAT=trajectory  # fixed | trajectory | straight_to_destination | trucktrix-path 
+            - UUID=Ab34069fc5-fdgs-434b-b87e-f19c5435113
+            - ASSIGNMENT_FORMAT=trajectory # fixed | trajectory | straight_to_destination | trucktrix-path
             - NAME=MY_TRACTOR
             - X0=-28000
             - Y0=29000
             - ORIENTATION=0.329
-            - VELOCITY=1.8 
+            - VELOCITY=1.8
             - VEHICLE_PARTS=2
             - YARD_UID=1
             - UPDATE_RATE=10
 
-            # RABBITMQ 
-            - RBMQ_HOST=local_rabbitmq 
+            # RABBITMQ
+            - RBMQ_HOST=local_rabbitmq
             - RBMQ_PORT=5672
             # - RBMQ_USERNAME= using REGISTRATION_TOKEN instead
             # - RBMQ_PASSWORD= using REGISTRATION_TOKEN instead
             - REGISTRATION_TOKEN=0001-0002-0003-0000-0004
 
         networks:
-            - control-tower-net   
+            - control-tower-net
 
         depends_on:
             - helyos_core
-            - local_rabbitmq     
+            - local_rabbitmq
 
-        command: ["python", "main.py"]
+        command: [ "python", "main.py" ]
 
         deploy:
             restart_policy:
                 condition: on-failure
                 delay: 15s
                 max_attempts: 5
-                window: 60s    
-
+                window: 60s
 
 networks:
     control-tower-net:
-       external: false
+        external: false
 
 volumes:
     postgres_data:

diff --git a/demo/settings/config/microservices.yml b/demo/settings/config/microservices.yml
@@ -10,6 +10,7 @@ services:
       enable: true
       apikey: "CN783V9SygdG0deHgfesdfsaeNuCqwbm"
       timeout: 300
+      description: ""
 
       context:
         map_data: true
@@ -31,6 +32,7 @@ services:
       enable: true
       apikey: "ABy40lwSsdfafasdBiCbvU2hVEeY7t"
       timeout: 180
+      description: ""
 
       context:
         map_data: true

diff --git a/helyos_dashboard/package-lock.json b/helyos_dashboard/package-lock.json
diff --git a/helyos_dashboard/package.json b/helyos_dashboard/package.json
@@ -37,7 +37,7 @@
     "bootstrap": "^5.3.2",
     "cheap-ruler": "^3.0.2",
     "core-js": "^3.38.0",
-    "helyosjs-sdk": "2.1.0",
+    "helyosjs-sdk": "2.1.2",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "rxjs": "^7.4.1",

diff --git a/helyos_dashboard/src/app/layout/all-services/all-services.component.html b/helyos_dashboard/src/app/layout/all-services/all-services.component.html
@@ -240,6 +240,17 @@ <h4>{{ selectedItem.name }}</h4>
       </fieldset>
     </div>
 
+    <div class="row">
+      <fieldset class="form-group col-xl-12">
+        <label for="description"> Description </label>
+        <textarea
+          id="description"
+          class="form-control"
+          [(ngModel)]="selectedItem.description"
+          name="description"></textarea>
+      </fieldset>
+    </div>
+
     <button class="btn btn-primary" type="submit" (click)="editItem(selectedItem)">Save</button>
     <button class="btn btn-secondary" type="reset" (click)="getItem(selectedItem.id)">Cancel</button>
   </form>

diff --git a/helyos_database/db_schema/0004_services_table.sql b/helyos_database/db_schema/0004_services_table.sql
@@ -21,8 +21,8 @@ CREATE TABLE IF NOT EXISTS public.services (
     require_agents_data boolean DEFAULT true,
     require_mission_agents_data boolean DEFAULT true,
     require_map_data boolean DEFAULT true,
-    require_map_objects text[] DEFAULT ARRAY['__all__']
-
+    require_map_objects text[] DEFAULT ARRAY['__all__'],
+    description character varying DEFAULT ''
     );
 
 
@@ -39,4 +39,5 @@ comment on column services.is_dummy is '@ do not dispatch request; just copy req
 comment on column services.health_endpoint is '@ end-point that returns status 2XX when service is healthy';
 comment on column services.unhealthy is '@  Is microservice unhealthy?';
 comment on column services.availability_timeout is '@ maximum time helyos will hold a request waiting for the system to be healthy';
-comment on column services.filter_map_objects is '@ array used to filter map objects by type to be included in the helyOS context, sent to the microservice.';
+comment on column services.filter_map_objects is '@ array used to filter map objects by type to be included in the helyOS context, sent to the microservice.';
+comment on column services.description is '@ description of service';
diff --git a/helyos_server/src/modules/read_config_yml.js b/helyos_server/src/modules/read_config_yml.js
@@ -253,6 +253,7 @@ const flattenServicesData = (jsonObj) => {
         timeout: "result_timeout",
         availability_timeout: "availability_timeout",
         health_endpoint: "health_endpoint",
+        description: "description",
         context: {
                     all_agents_data: "require_agents_data",
                     mission_agents_data: "require_mission_agents_data",