1060 buffer reset (#1061)

Implemented buffer reset contents capability

Author: bwsw

adapters/python/bridge/buffer.py

@@ -1,5 +1,6 @@
 import json
 import os
+import shutil
 import signal
 import time
 from typing import Dict, Optional, Tuple, Union
@@ -97,6 +98,9 @@ def __init__(self):
         self.message_dump = MessageDumpConfig()
         self.idle_polling_period = opt_config('IDLE_POLLING_PERIOD', 0.005, float)
         self.stats_log_interval = opt_config('STATS_LOG_INTERVAL', 60, int)
+        self.buffer_reset_on_restart = opt_config(
+            'BUFFER_RESET_ON_RESTART', False, strtobool
+        )
         self.metrics = MetricsConfig()
 
 
@@ -572,6 +576,18 @@ def main():
     # To gracefully shut down the adapter on SIGTERM (raise KeyboardInterrupt)
     signal.signal(signal.SIGTERM, signal.getsignal(signal.SIGINT))
     config = Config()
+    if config.buffer_reset_on_restart and os.path.exists(config.buffer.path):
+        logger.info(
+            'Resetting the buffer contents. Removing %s contents.', config.buffer.path
+        )
+        # iterate over the directory and remove all files
+        for file in os.listdir(config.buffer.path):
+            # if a regular file, remove it
+            if os.path.isfile(os.path.join(config.buffer.path, file)):
+                os.remove(os.path.join(config.buffer.path, file))
+            # if a directory, remove it
+            elif os.path.isdir(os.path.join(config.buffer.path, file)):
+                shutil.rmtree(os.path.join(config.buffer.path, file))
     queue = PersistentQueueWithCapacity(
         config.buffer.path,
         config.buffer.len + config.buffer.service_messages,

docs/source/savant_101/10_adapters.rst

@@ -1797,6 +1797,10 @@ The Buffer Bridge Adapter buffers messages from a source and sends them to a mod
 - ``MESSAGE_DUMP_PATH``: a directory to dump message segment files; default is ``/tmp/buffer-adapter-dump``;
 - ``MESSAGE_DUMP_SEGMENT_DURATION``: a duration of a message segment in seconds; default is ``60``.
 - ``MESSAGE_DUMP_SEGMENT_TEMPLATE``: a template for message segment file names; default is ``dump-%Y-%m-%d-%H-%M-%S.msgpack``.
+- ``BUFFER_RESET_ON_RESTART``: a flag indicating whether to reset the buffer contents on restart; default is ``False``.
+
+.. note::
+    When the buffer is reset on restart, the adapter will remove the buffer directory and create a new one.
 
 Running the adapter with Docker:
 

samples/buffer_adapter/docker-compose.l4t.yml

@@ -41,6 +41,7 @@ services:
       - MESSAGE_DUMP_ENABLED=False # Set to True to enable message dumping for later analysis
       - MESSAGE_DUMP_SEGMENT_DURATION=30
       - MESSAGE_DUMP_PATH=/tmp/message-dump
+      - BUFFER_RESET_ON_RESTART=True
     command: python -m adapters.python.bridge.buffer
 
   module:

scripts/run_bridge.py

@@ -46,6 +46,12 @@ def build_common_bridge_envs(
     help='Maximum amount of messages in the buffer.',
     show_default=True,
 )
+@click.option(
+    '--buffer-reset-on-restart',
+    default=False,
+    is_flag=True,
+    help='Reset the buffer contents on restart.',
+)
 @click.option(
     '--mount-buffer-path',
     default=False,
@@ -126,6 +132,7 @@ def buffer_bridge(
     metrics_extra_labels: str,
     docker_image: str,
     buffer_path: str,
+    buffer_reset_on_restart: bool,
 ):
     """Buffers messages from a source to BUFFER_PATH and sends them to a module.
 
@@ -152,6 +159,7 @@ def buffer_bridge(
         f'METRICS_FRAME_PERIOD={metrics_frame_period}',
         f'METRICS_HISTORY={metrics_history}',
         f'METRICS_EXTRA_LABELS={metrics_extra_labels}',
+        f'BUFFER_RESET_ON_RESTART={buffer_reset_on_restart}',
     ]
     if metrics_time_period:
         envs.append(f'METRICS_TIME_PERIOD={metrics_time_period}')