Web: Fix CAN options visibility for non-CAN boards by garvit000 · Pull Request #209 · ArduPilot/CustomBuild

garvit000 · 2026-01-17T18:11:24Z

This PR fixes Issue #151 where the "CAN" feature category remained visible even when selecting a board that does not support CAN.

The Fix:

Updated fillBuildOptions in JS to re-render the category list whenever the board selection changes.
Added logic to hide the "CAN" category if the selected board's metadata indicates has_can: false.
Updated backend metadata fetching to correctly identify CAN support for newer boards (e.g., CubeOrange) by following include directives in hwdef.dat.

Test Plan:

Select "CubeOrange" -> Verify "CAN" category is visible (True Positive).
Select "KakuteF4-Mini" -> Verify "CAN" category disappears (True Negative).

Closes #151

shiv-tyagi · 2026-01-18T16:17:10Z

metadata_manager/ap_src_meta_fetcher.py

                f"Redis connection established with {redis_host}:{redis_port}"
            )
-            self.__boards_key_prefix = "boards-"
+            # bump version to invalidate stale board metadata in cache


Please remove this change. We can handle the upgrade by manually clearing the cache.

Reverted the change

shiv-tyagi · 2026-01-18T16:22:00Z

metadata_manager/ap_src_meta_fetcher.py

+
    def __get_boards_at_commit_from_repo(self, remote: str,
-                                         commit_ref: str) -> tuple[list, list]:
+                                         commit_ref: str) -> tuple[list[dict], list[dict]]:


Needs to be documented in the comment.

Updated the comment

shiv-tyagi · 2026-01-18T16:23:38Z

metadata_manager/ap_src_meta_fetcher.py

+            try:
+                non_periph_boards, periph_boards = boards
+                needs_upgrade = False
+                if non_periph_boards and isinstance(non_periph_boards[0], str):


Let's remove this as well. No need to worry about the upgrade due to cached stuff. We can clear it manually.

shiv-tyagi · 2026-01-18T16:24:27Z

web/app.py

            vehicle_id=vehicle,
        )
-        if board not in boards_at_commit:
+        board_names_at_commit = [b["name"] for b in boards_at_commit]


Better define a class for board with id, name and attributes, in the attributed put the has_can thing.

Defined a BoardMetadata class for above listed

garvit000 · 2026-01-18T18:46:45Z

Hey @shiv-tyagi thanks for reviewing, I have addressed all the requested changes could you re-review it.

shiv-tyagi · 2026-01-19T11:54:55Z

metadata_manager/ap_src_meta_fetcher.py

-
+import re
+
+class BoardMetadata:


Let us just call it board.

shiv-tyagi · 2026-01-19T11:55:54Z

metadata_manager/ap_src_meta_fetcher.py

+        def __init__(self, id: str, name: str, attributes: dict):
+            self.id = id
+            self.name = name
+            self.attributes = attributes


Suggested change

self.attributes = attributes

self.attributes = dict(attributes)

Let us make sure the board is not affected even it the passed attributes get mutated externally.

shiv-tyagi · 2026-01-19T11:58:37Z

metadata_manager/ap_src_meta_fetcher.py

+                "name": self.name,
+                "attributes": self.attributes,
+            }
+            if "has_can" in self.attributes:


Either keep the has_can thing at top level or inside attributes property. Not both.

shiv-tyagi · 2026-01-19T12:00:29Z

metadata_manager/ap_src_meta_fetcher.py

-                - A list contains boards for the 'ap_periph' target.
+                - A list of board metadata dictionaries for NON-'ap_periph' targets.
+                - A list of board metadata dictionaries for the 'ap_periph' target.
+            Each board dict exposes: id, name, attributes (has_can), and has_can (legacy).


I don't think there is anything like "(legacy)" in our case which we need to handle..

shiv-tyagi · 2026-01-19T12:03:45Z

metadata_manager/ap_src_meta_fetcher.py

+        def build_board_metadata(board_names: list[str]) -> list[dict]:
+            board_data: list[dict] = []
+            for board_name in board_names:
+                hwdef_path = None
+                if hwdef_dir:
+                    candidate_path = os.path.join(hwdef_dir, board_name, "hwdef.dat")
+                    if os.path.isfile(candidate_path):
+                        hwdef_path = candidate_path
+                    else:
+                        self.logger.debug(
+                            "hwdef.dat not found for board %s at %s",
+                            board_name,
+                            candidate_path,
+                        )
+
+                has_can = self.__board_has_can(hwdef_path) if hwdef_path else False
+                board = BoardMetadata(
+                    id=board_name,
+                    name=board_name,
+                    attributes={"has_can": has_can},
+                )
+                board_data.append(board.to_dict())
+            return board_data
+
        return (
-            non_periph_boards_sorted,
-            periph_boards_sorted,
+            build_board_metadata(non_periph_boards_sorted),
+            build_board_metadata(periph_boards_sorted),


The repo needs to stay locked till you are done doing everything.

shiv-tyagi · 2026-01-19T12:06:27Z

metadata_manager/ap_src_meta_fetcher.py

            tuple: A tuple of two lists in order:
-                - A list contains boards for NON-'ap_periph' targets.
-                - A list contains boards for the 'ap_periph' target.
+                - A list of board metadata dictionaries for NON-'ap_periph' targets.


Instead of these dictionaries. We should just return a list of Board objects. We would also need to handle the caching of those.

shiv-tyagi · 2026-01-19T12:07:14Z

metadata_manager/ap_src_meta_fetcher.py

+            list: A list of board metadata dictionaries, each containing
+            the board name and whether it supports CAN (has_can).


Suggested change

list: A list of board metadata dictionaries, each containing

the board name and whether it supports CAN (has_can).

list: A list of Boards.

shiv-tyagi · 2026-01-19T12:10:22Z

web/static/js/add_build.js

+    // Store current features for re-rendering when board changes
+    currentFeatures = buildOptions;
+
+    const selectedBoard = getSelectedBoardMetadata();
+    // Default to hiding (false) if metadata is missing to be safe
+    const boardHasCan = selectedBoard && selectedBoard.has_can !== undefined
+        ? Boolean(selectedBoard.has_can)
+        : false; 
+
    let output = document.getElementById('build_options');
    output.innerHTML =  `<div class="d-flex mb-3 justify-content-between">
-                            <div class="d-flex d-flex align-items-center">
-                                <p class="card-text"><strong>Available features for the current selection are:</strong></p>
-                            </div>
-                            <button type="button" class="btn btn-outline-primary" id="exp_col_button" onclick="toggle_all_categories();"><i class="bi bi-chevron-expand me-2"></i>Expand/Collapse all categories</button> 
-                        </div>`;
-
-    buildOptions.forEach((category, cat_idx) => {
-        if (cat_idx % 4 == 0) {
-            let new_row = document.createElement('div');
-            new_row.setAttribute('class', 'row');
-            new_row.id = 'category_'+parseInt(cat_idx/4)+'_row';
-            output.appendChild(new_row);
+                             <div class="d-flex d-flex align-items-center">
+                                 <p class="card-text"><strong>Available features for the current selection are:</strong></p>
+                             </div>
+                             <button type="button" class="btn btn-outline-primary" id="exp_col_button" onclick="toggle_all_categories();"><i class="bi bi-chevron-expand me-2"></i>Expand/Collapse all categories</button> 
+                          </div>`;
+    
+    let visibleCategoryIdx = 0;
+
+    buildOptions.forEach((category) => {
+        // HIDE CAN CATEGORY IF BOARD HAS NO CAN
+        if (category.name && category.name.includes("CAN") && boardHasCan === false) {
+            return;
        }
-        let col_element = document.createElement('div');
-        col_element.setAttribute('class', 'col-md-3 col-sm-6 mb-2');
-        col_element.appendChild(createCategoryCard(category['name'], category['options'], init_categories_expanded));
-        document.getElementById('category_'+parseInt(cat_idx/4)+'_row').appendChild(col_element);
-    });
-}
+
+        if (visibleCategoryIdx % 4 === 0) {
+             let new_row = document.createElement('div');
+             new_row.setAttribute('class', 'row');
+             new_row.id = 'category_'+parseInt(visibleCategoryIdx/4)+'_row';
+             output.appendChild(new_row);
+         }
+
+         let col_element = document.createElement('div');
+         col_element.setAttribute('class', 'col-md-3 col-sm-6 mb-2');
+         col_element.appendChild(createCategoryCard(category['name'], category['options'], init_categories_expanded));
+
+         let row = document.getElementById('category_'+parseInt(visibleCategoryIdx/4)+'_row');        
+         if (row) {
+            row.appendChild(col_element);
+         }
+
+         visibleCategoryIdx += 1;
+     });
+ }


Instead of hiding stuff at the frontend, we should make sure they don't even get returned from the backend. The filtering logic has to go in the backend.

Also, when we make some features disappear the features which are dependent on those should also disappear.

shiv-tyagi · 2026-01-19T12:11:29Z

metadata_manager/ap_src_meta_fetcher.py

        )
        self.logger.debug(f"periph_boards sorted: {periph_boards_sorted}")

+        def build_board_metadata(board_names: list[str]) -> list[dict]:


Please follow the pattern in the codebase. Define a separate method in this class to do this parsing. You can prefix the method names with underscores to avoid potential external usage.

Web: Fix CAN category visibility and update backend board metadata

76c69d8

shiv-tyagi requested changes Jan 18, 2026

View reviewed changes

Use standard BoardMetadata class and revert cache changes.

a0cb13a

shiv-tyagi requested changes Jan 19, 2026

View reviewed changes

garvit000 marked this pull request as draft January 31, 2026 17:32

	self.attributes = attributes
	self.attributes = dict(attributes)

		list: A list of board metadata dictionaries, each containing
		the board name and whether it supports CAN (has_can).

	list: A list of board metadata dictionaries, each containing
	the board name and whether it supports CAN (has_can).
	list: A list of Boards.

Conversation

garvit000 commented Jan 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

garvit000 commented Jan 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants