Eliminate state entirely

Author: kevinschoon

src/buildstream/_frontend/cli.py

@@ -535,7 +535,6 @@ def build(
 #                           Inspect Command                      #
 ##################################################################
 @cli.command(name="inspect", short_help="Inspect Project Information")
-@click.option("-s", "--state", default=False, show_default=True, is_flag=True, help="Show information that requires inspecting remote state")
 @click.option(
     "--deps",
     "-d",
@@ -554,7 +553,7 @@ def build(
 )
 @click.argument("elements", nargs=-1, type=click.Path(readable=False))
 @click.pass_obj
-def inspect(app, elements, state, deps):
+def inspect(app, elements, deps):
     """Access structured data about a given buildstream project and it's computed elements.
 
     Specifying no elements will result in showing the default targets
@@ -575,24 +574,16 @@ def inspect(app, elements, state, deps):
         build: Build time dependencies, excluding the element itself
         all:   All dependencies
 
-    If ``--state`` is toggled then pipeline elements which require remote state will be
-    shown in addition to information that is available on the local system.
-
     Examples:
 
-        # Show all default elements with remote information
-        \n
-            bst inspect --state
-
-
         # A specific target (glob pattern)
         \n
-            bst inspect -s public/*.bst
+            bst inspect public/*.bst
 
 
         # With a dependency target
         \n
-            bst inspect -d run --state
+            bst inspect -d run
 
 
         # Show each remote file source (with the help of jq)
@@ -601,7 +592,7 @@ def inspect(app, elements, state, deps):
 
     """
     with app.initialized():
-        app.inspector.dump_to_stdout(elements, selection=deps, with_state=state)
+        app.inspector.dump_to_stdout(elements, selection=deps)
 
 
 ##################################################################

src/buildstream/_frontend/inspect.py

@@ -16,12 +16,8 @@ class _Element:
     name: str
     description: str
     workspace: any
-    key: str
-    key_full: str
-    # state: str
     environment: dict[str, str]
     variables: dict[str, str]
-    artifact: any
     dependencies: list[str]
     build_dependencies: list[str]
     runtime_dependencies: list[str]
@@ -201,34 +197,9 @@ def __init__(self, stream, project, context):
         self.project = project
         self.context = context
 
-    def _elements(self, dependencies, with_state=False):
+    def _elements(self, dependencies):
         for element in dependencies:
 
-            # These operations require state and are only shown if requested
-            key = None
-            key_full = None
-            state = None
-            artifact = None
-
-            if with_state:
-                key = element._get_display_key().brief
-
-                key_full = element._get_display_key().full
-
-                # BUG: Due to the assersion within .get_artifact this will
-                # error but there is no other way to determine if an artifact
-                # exists and we only want to show this value for informational
-                # purposes.
-                try:
-                    _artifact = element._get_artifact()
-                    if _artifact.cached():
-                        artifact = {
-                            "files": artifact.get_files(),
-                            "digest": artifact_files._get_digest(),
-                        }
-                except:
-                    pass
-
             sources = []
             for source in element.sources():
                 source_infos = source.collect_source_info()
@@ -260,10 +231,6 @@ def _elements(self, dependencies, with_state=False):
                 runtime_dependencies=lambda element: [
                     dependency._get_full_name() for dependency in element._dependencies(_Scope.RUN, recurse=False)
                 ],
-                key=key,
-                key_full=key_full,
-                # state=state,
-                artifact=artifact,
             )
 
     def _get_projects(self) -> [_Project]:
@@ -361,23 +328,20 @@ def _get_user_config(self) -> _UserConfig:
             remote_action_cache_service=remote_action_cache_service,
         )
 
-    def _get_output(self, dependencies, with_state=False) -> _InspectOutput:
+    def _get_output(self, dependencies) -> _InspectOutput:
         return _InspectOutput(
             project=self._get_projects(),
             user_config=self._get_user_config(),
-            elements=[element for element in self._elements(dependencies, with_state=with_state)],
+            elements=[element for element in self._elements(dependencies)],
         )
 
-    def dump_to_stdout(self, elements=[], selection=_PipelineSelection.NONE, with_state=False):
+    def dump_to_stdout(self, elements=[], selection=_PipelineSelection.NONE):
         if not elements:
             elements = self.project.get_default_targets()
 
         dependencies = self.stream.load_selection(
-            elements, selection=selection, except_targets=[], need_state=with_state
+            elements, selection=selection, except_targets=[]
         )
 
-        if with_state:
-            self.stream.query_cache(dependencies, need_state=True)
-
-        output = self._get_output(dependencies, with_state)
+        output = self._get_output(dependencies)
         json.dump(_dump_dataclass(output), sys.stdout)

tests/frontend/inspect.py

@@ -65,8 +65,8 @@ def _assert_has_source(elements, expected: _Source):
     [
         ([], ["import-local-files.bst", "import-remote-files.bst", "target.bst"]),
         (["*.bst", "**/*.bst"],["import-local-files.bst", "import-remote-files.bst", "target.bst"]),
-        (["--state"], ["import-local-files.bst", "import-remote-files.bst", "target.bst"]),
-        (["--state", "--deps", "all"], ["import-local-files.bst", "import-remote-files.bst", "target.bst"]),
+        ([], ["import-local-files.bst", "import-remote-files.bst", "target.bst"]),
+        (["--deps", "all"], ["import-local-files.bst", "import-remote-files.bst", "target.bst"]),
         (["import-*.bst"], ["import-local-files.bst", "import-remote-files.bst"])
     ],
 )