fix: restrict construction_order when searching for node callbacks

.github/workflows/pytest.yaml

@@ -45,7 +45,7 @@ jobs:
           git clone https://github.com/tier4/caret_analyze_cpp_impl.git
       - name: Restore Cache
         id: cpp_impl-cache
-        uses: actions/cache/restore@v3
+        uses: actions/cache/restore@v4
         with:
           path: caret_analyze_cpp_impl/install
           key: ${{ runner.os }}-node-cpp_impl-${{ hashFiles('caret_analyze_cpp_impl/CARET_analyze_cpp_impl/**') }}
@@ -60,7 +60,7 @@ jobs:
 
       - name: Cache caret_analyze_cpp_impl
         if: steps.cpp_impl-cache.outputs.cache-hit != 'true'
-        uses: actions/cache/save@v3
+        uses: actions/cache/save@v4
         with:
           path: caret_analyze_cpp_impl/install
           key: ${{ runner.os }}-node-cpp_impl-${{ hashFiles('caret_analyze_cpp_impl/CARET_analyze_cpp_impl/**') }}

.pre-commit-config.yaml

@@ -19,13 +19,13 @@ repos:
         args: [--markdown-linebreak-ext=md]
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.38.0
+    rev: v0.39.0
     hooks:
       - id: markdownlint
         args: [-c, .markdownlint.yaml, --fix]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v4.0.0-alpha.4
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
 

mkdocs-requirements.txt

@@ -11,5 +11,5 @@ mike
 plantuml-markdown
 pymdown-extensions
 python-markdown-math
-mkdocstrings
+mkdocstrings<=0.23
 mkdocstrings[python]

src/caret_analyze/architecture/architecture.py

@@ -18,7 +18,7 @@
 import logging
 
 from .architecture_exporter import ArchitectureExporter
-from .architecture_loaded import NodeValuesLoaded
+from .architecture_loaded import MAX_CONSTRUCTION_ORDER, NodeValuesLoaded
 from .combine_path import CombinePath
 
 from .reader_interface import ArchitectureReader, IGNORE_TOPICS
@@ -42,6 +42,7 @@ def __init__(
         self,
         file_type: str,
         file_path: str,
+        max_construction_order: int = MAX_CONSTRUCTION_ORDER
     ) -> None:
         from .architecture_reader_factory import ArchitectureReaderFactory
         from .architecture_loaded import ArchitectureLoaded
@@ -51,7 +52,9 @@ def __init__(
 
         reader = ArchitectureReaderFactory.create_instance(
             file_type, file_path)
-        loaded = ArchitectureLoaded(reader, ignore_topics)
+        loaded = ArchitectureLoaded(reader,
+                                    ignore_topics,
+                                    max_construction_order=max_construction_order)
 
         self._nodes: list[NodeStruct] = loaded.nodes
         self._communications: list[CommunicationStruct] = loaded.communications

src/caret_analyze/architecture/architecture_loaded.py

@@ -52,6 +52,8 @@
 
 logger = getLogger(__name__)
 
+MAX_CONSTRUCTION_ORDER = 10
+
 
 def indexed_name(base_name: str, i: int, num_digit: int):
     index_str = str(i).zfill(num_digit)
@@ -62,13 +64,15 @@ class ArchitectureLoaded():
     def __init__(
         self,
         reader: ArchitectureReader,
-        ignore_topics: list[str]
+        ignore_topics: list[str],
+        max_construction_order: int = MAX_CONSTRUCTION_ORDER
     ) -> None:
 
         topic_ignored_reader = TopicIgnoredReader(reader, ignore_topics)
 
         self._nodes: list[NodeStruct]
-        nodes_loaded = NodeValuesLoaded(topic_ignored_reader)
+        nodes_loaded = NodeValuesLoaded(topic_ignored_reader,
+                                        max_construction_order=max_construction_order)
 
         self._nodes = nodes_loaded.data
 
@@ -274,6 +278,7 @@ class NodeValuesLoaded():
     def __init__(
         self,
         reader: ArchitectureReader,
+        max_construction_order: int = MAX_CONSTRUCTION_ORDER
     ) -> None:
         self._reader = reader
         nodes_struct: list[NodeStruct] = []
@@ -291,7 +296,11 @@ def __init__(
 
         for node in Progress.tqdm(nodes, 'Loading nodes.'):
             try:
-                node, cb_loaded, cbg_loaded = self._create_node(node, reader)
+                node, cb_loaded, cbg_loaded = self._create_node(
+                    node,
+                    reader,
+                    max_construction_order=max_construction_order
+                )
                 nodes_struct.append(node)
                 self._cb_loaded.append(cb_loaded)
                 self._cbg_loaded.append(cbg_loaded)
@@ -446,6 +455,7 @@ def find_callbacks(
     def _create_node(
         node: NodeValue,
         reader: ArchitectureReader,
+        max_construction_order: int = MAX_CONSTRUCTION_ORDER
     ) -> tuple[NodeStruct, CallbacksLoaded, CallbackGroupsLoaded]:
 
         callbacks_loaded = CallbacksLoaded(reader, node)
@@ -476,7 +486,12 @@ def _create_node(
         )
 
         try:
-            node_paths = NodeValuesLoaded._search_node_paths(node_struct, reader)
+            node_paths = \
+                    NodeValuesLoaded._search_node_paths(
+                        node_struct,
+                        reader,
+                        max_construction_order=max_construction_order
+                    )
             node_path_added = NodeStruct(
                 node_struct.node_name, node_struct.publishers,
                 node_struct.subscriptions,
@@ -496,14 +511,15 @@ def _create_node(
     @staticmethod
     def _search_node_paths(
         node: NodeStruct,
-        reader: ArchitectureReader
+        reader: ArchitectureReader,
+        max_construction_order: int = MAX_CONSTRUCTION_ORDER
     ) -> list[NodePathStruct]:
 
         node_paths: list[NodePathStruct] = []
 
         # add callback-graph paths
         logger.info('[callback_chain]')
-        node_paths += list(CallbackPathSearched(node).data)
+        node_paths += list(CallbackPathSearched(node, max_construction_order).data)
 
         # add pub-sub pair graph paths
         logger.info('\n[pub-sub pair]')
@@ -1588,6 +1604,7 @@ class CallbackPathSearched():
     def __init__(
         self,
         node: NodeStruct,
+        max_construction_order: int = MAX_CONSTRUCTION_ORDER
     ) -> None:
         from .graph_search import CallbackPathSearcher
         self._data: list[NodePathStruct]
@@ -1598,7 +1615,13 @@ def __init__(
         paths: list[NodePathStruct] = []
 
         if callbacks is not None:
+            skip_nodes = []
             for write_callback, read_callback in product(callbacks, callbacks):
+                if max_construction_order != 0:
+                    if write_callback.construction_order > max_construction_order or \
+                            read_callback.construction_order > max_construction_order:
+                        skip_nodes.append(node.node_name)
+                        continue
                 searched_paths = searcher.search(write_callback, read_callback, node)
                 for path in searched_paths:
                     msg = 'Path Added: '
@@ -1608,6 +1631,12 @@ def __init__(
                     logger.info(msg)
                 paths += searched_paths
 
+            from collections import Counter
+            skip_node_counts = Counter(skip_nodes)
+            for name, count in skip_node_counts.items():
+                logger.warn(f'skip due to callback construction_order over'
+                            f'({max_construction_order}): {name} ({count})')
+
         self._data = paths
 
     @property

src/caret_analyze/infra/lttng/event_counter.py

@@ -96,7 +96,7 @@ def _validate(self):
 
         # For after iron distributions
         # No need to check trace points added by fork-rclcpp
-        if self._distribution in ['iron', 'rolling']:
+        if self._distribution[0] >= 'i':
             return
 
         has_forked_inter_process_trace_points = len(

src/caret_analyze/infra/lttng/records_source.py

@@ -424,7 +424,7 @@ def intra_proc_comm_records(self) -> RecordsInterface:
             - message_timestamp
 
         """
-        if self._info.get_distribution() in ['iron', 'rolling']:
+        if self._info.get_distribution()[0] >= 'i':
             return self.intra_proc_comm_records_iron
 
         sink_records = self._data.dispatch_intra_process_subscription_callback_instances

src/caret_analyze/plot/histogram/__init__.py

@@ -12,14 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .histogram import ResponseTimeHistPlot
-from .histogram_factory import ResponseTimeHistPlotFactory
 from .histogram_plot import HistogramPlot
 from .histogram_plot_factory import HistogramPlotFactory
 
 __all__ = [
-    'ResponseTimeHistPlot',
-    'ResponseTimeHistPlotFactory',
     'HistogramPlotFactory',
     'HistogramPlot'
 ]