Fixed source_code_linker finding external needs

Added simple loop search logic to try all available prefixes per id.

Author: MaximilianSoerenPollak

BUILD

@@ -13,6 +13,8 @@
 
 load("@score_cr_checker//:cr_checker.bzl", "copyright_checker")
 
+package(default_visibility = ["//visibility:public"])
+
 copyright_checker(
     name = "copyright",
     srcs = [

docs/BUILD

@@ -27,7 +27,7 @@ docs(
             "suffix": "latest",  # latest main branch documentation build
             "external_needs_info": [
                 {
-                    "base_url": "https://eclipse-score.github.io/score/main/",
+                    "base_url": "https://eclipse-score.github.io/score/main",
                     "json_url": "https://eclipse-score.github.io/score/main/needs.json",
                     "version": "0.1",
                     "id_prefix": "score_",

src/BUILD

@@ -101,16 +101,33 @@ pkg_tar(
     srcs = [":html_files"],
 )
 
+py_library(
+    name = "docs_as_code_py_modules",
+    srcs = [
+        "@score_docs_as_code//src:plantuml_for_python",
+        "@score_docs_as_code//src/extensions:score_plantuml",
+        "@score_docs_as_code//src/extensions/score_draw_uml_funcs",
+        "@score_docs_as_code//src/extensions/score_header_service",
+        "@score_docs_as_code//src/extensions/score_layout",
+        "@score_docs_as_code//src/extensions/score_metamodel",
+        "@score_docs_as_code//src/extensions/score_source_code_linker",
+        "@score_docs_as_code//src/find_runfiles",
+    ],
+    visibility = ["//visibility:public"],
+)
+
 filegroup(
     name = "score_extension_files",
     srcs = glob(
-        ["*/**"],
+        [
+            "**",
+        ],
         exclude = [
             "**/test/**",
             "**/tests/**",
             "**/__pycache__/**",
         ],
-    ),
+    ) + [":docs_as_code_py_modules"],
     visibility = ["//visibility:public"],
 )
 

src/extensions/score_metamodel/BUILD

@@ -18,7 +18,7 @@ py_library(
     name = "score_metamodel",
     srcs = glob(
         ["**/*.py"],
-    ),
+    ) + ["metamodel.yaml"],
     data = glob(["*.yaml"]),  # Needed to remove 'resolving of symlink' in score_metamodel.__init__
     imports = [
         ".",

src/extensions/score_source_code_linker/__init__.py

@@ -16,7 +16,7 @@
 
 from sphinx.application import Sphinx
 from sphinx.environment import BuildEnvironment
-from sphinx_needs.data import SphinxNeedsData
+from sphinx_needs.data import NeedsMutable, SphinxNeedsData, NeedsInfoType
 from sphinx_needs.logging import get_logger
 
 from src.extensions.score_source_code_linker.parse_source_files import GITHUB_BASE_URL
@@ -59,6 +59,21 @@ def setup(app: Sphinx) -> dict[str, str | bool]:
     }
 
 
+def find_need(
+    all_needs: NeedsMutable, id: str, prefixes: list[str]
+) -> NeedsInfoType | None:
+    if id in all_needs:
+        return all_needs[id]
+
+    # Try all possible prefixes
+    for prefix in prefixes:
+        prefixed_id = f"{prefix}{id}"
+        if prefixed_id in all_needs:
+            return all_needs[prefixed_id]
+
+    return None
+
+
 # re-qid: gd_req__req__attr_impl
 def add_source_link(app: Sphinx, env: BuildEnvironment) -> None:
     """
@@ -77,28 +92,25 @@ def add_source_link(app: Sphinx, env: BuildEnvironment) -> None:
     p5 = Path(__file__).parents[5]
 
     if str(p5).endswith("src"):
-        LOGGER.info("DEBUG: WE ARE IN THE IF")
+        LOGGER.debug("DEBUG: WE ARE IN THE IF")
         path = str(p5.parent / Path(app.confdir).name / "score_source_code_parser.json")
     else:
-        LOGGER.info("DEBUG: WE ARE IN THE ELSE")
+        LOGGER.debug("DEBUG: WE ARE IN THE ELSE")
         path = str(p5 / "score_source_code_parser.json")
 
     if app.config.score_source_code_linker_file_overwrite:
         path = app.config.score_source_code_linker_file_overwrite
 
+    # For some reason the prefix 'sphinx_needs internally' is CAPSLOCKED.
+    # So we have to make sure we uppercase the prefixes
+    prefixes = [x["id_prefix"].upper() for x in app.config.needs_external_needs]
     try:
         with open(path) as f:
             gh_json = json.load(f)
         for id, link in gh_json.items():
             id = id.strip()
-            try:
-                # NOTE: Removing & adding the need is important to make sure
-                # the needs gets 're-evaluated'.
-                need = needs_copy[id]  # NeedsInfoType
-                Needs_Data.remove_need(need["id"])
-                need["source_code_link"] = ",".join(link)
-                Needs_Data.add_need(need)
-            except KeyError:
+            need = find_need(needs_copy, id, prefixes)
+            if need is None:
                 # NOTE: manipulating link to remove git-hash,
                 # making the output file location more readable
                 files = [x.replace(GITHUB_BASE_URL, "").split("/", 1)[-1] for x in link]
@@ -107,6 +119,13 @@ def add_source_link(app: Sphinx, env: BuildEnvironment) -> None:
                     + f"Found in file(s): {files}",
                     type="score_source_code_linker",
                 )
+                continue
+
+            # NOTE: Removing & adding the need is important to make sure
+            # the needs gets 're-evaluated'.
+            Needs_Data.remove_need(need["id"])
+            need["source_code_link"] = ",".join(link)
+            Needs_Data.add_need(need)
     except Exception as e:
         LOGGER.warning(
             f"An unexpected error occurred while adding source_code_links to needs."