[gql] Add boolean endpoint for whether a location has integrated docs (#29216)

## Summary

Adds a boolean `hasLocationDocs` endpoint which returns whether a
location has integrated docs. Nested under `GrapheneRepository`, along
with moving the endpoint from #29167

## How I Tested These Changes

Update unit test.

Author: benpankow

js_modules/dagster-ui/packages/ui-core/src/graphql/possibleTypes.generated.json

@@ -1,5 +1,5 @@
 import asyncio
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Optional, cast
 
 import graphene
 from dagster import _check as check
@@ -19,10 +19,16 @@
 from dagster._core.remote_representation.handle import RepositoryHandle
 from dagster._core.workspace.context import WorkspaceProcessContext
 from dagster._core.workspace.workspace import CodeLocationEntry, CodeLocationLoadStatus
+from dagster.components.core.load_defs import PLUGIN_COMPONENT_TYPES_JSON_METADATA_KEY
 
 from dagster_graphql.implementation.fetch_solids import get_solid, get_solids
 from dagster_graphql.implementation.loader import RepositoryScopedBatchLoader, StaleStatusLoader
+from dagster_graphql.implementation.utils import capture_error
 from dagster_graphql.schema.asset_graph import GrapheneAssetGroup, GrapheneAssetNode
+from dagster_graphql.schema.env_vars import (
+    GrapheneLocationDocsJson,
+    GrapheneLocationDocsJsonOrError,
+)
 from dagster_graphql.schema.errors import GraphenePythonError, GrapheneRepositoryNotFoundError
 from dagster_graphql.schema.partition_sets import GraphenePartitionSet
 from dagster_graphql.schema.permissions import GraphenePermission
@@ -265,6 +271,15 @@ class GrapheneRepository(graphene.ObjectType):
     displayMetadata = non_null_list(GrapheneRepositoryMetadata)
     assetGroups = non_null_list(GrapheneAssetGroup)
     allTopLevelResourceDetails = non_null_list(GrapheneResourceDetails)
+    hasLocationDocs = graphene.Field(
+        graphene.NonNull(graphene.Boolean),
+        description="Retrieves whether the code location has integrated docs.",
+    )
+
+    locationDocsJsonOrError = graphene.Field(
+        graphene.NonNull(GrapheneLocationDocsJsonOrError),
+        description="Retrieves JSON blob to drive integrated code location docs.",
+    )
 
     class Meta:
         name = "Repository"
@@ -420,6 +435,33 @@ def resolve_allTopLevelResourceDetails(self, graphene_info) -> list[GrapheneReso
             if resource.is_top_level
         ]
 
+    def resolve_hasLocationDocs(self, graphene_info: ResolveInfo):
+        repository = self.get_repository(graphene_info)
+
+        return bool(
+            repository.repository_snap.metadata
+            and repository.repository_snap.metadata.get(PLUGIN_COMPONENT_TYPES_JSON_METADATA_KEY)
+        )
+
+    @capture_error
+    def resolve_locationDocsJsonOrError(
+        self,
+        graphene_info: ResolveInfo,
+    ) -> GrapheneLocationDocsJson:
+        repository = self.get_repository(graphene_info)
+        plugin_docs_json = (
+            cast(
+                list,
+                repository.repository_snap.metadata.get(
+                    PLUGIN_COMPONENT_TYPES_JSON_METADATA_KEY, [[]]
+                ),
+            )[0]
+            if repository.repository_snap.metadata
+            else []
+        )
+
+        return GrapheneLocationDocsJson(json=plugin_docs_json)
+
 
 class GrapheneRepositoryConnection(graphene.ObjectType):
     nodes = non_null_list(GrapheneRepository)

js_modules/dagster-ui/packages/ui-core/src/graphql/schema.graphql

@@ -21,7 +21,6 @@
 from dagster._core.scheduler.instigation import InstigatorStatus, InstigatorType
 from dagster._core.storage.event_log.base import AssetRecord
 from dagster._core.workspace.permissions import Permissions
-from dagster.components.core.load_defs import PLUGIN_COMPONENT_TYPES_JSON_METADATA_KEY
 
 from dagster_graphql.implementation.execution.backfill import get_asset_backfill_preview
 from dagster_graphql.implementation.external import (
@@ -119,11 +118,7 @@
     GraphenePartitionBackfillsOrError,
 )
 from dagster_graphql.schema.entity_key import GrapheneAssetKey
-from dagster_graphql.schema.env_vars import (
-    GrapheneEnvVarWithConsumersListOrError,
-    GrapheneLocationDocsJson,
-    GrapheneLocationDocsJsonOrError,
-)
+from dagster_graphql.schema.env_vars import GrapheneEnvVarWithConsumersListOrError
 from dagster_graphql.schema.external import (
     GrapheneRepositoriesOrError,
     GrapheneRepositoryConnection,
@@ -317,12 +312,6 @@ class Meta:
         description="Retrieve all the utilized environment variables for the given repo.",
     )
 
-    locationDocsJsonOrError = graphene.Field(
-        graphene.NonNull(GrapheneLocationDocsJsonOrError),
-        repositorySelector=graphene.NonNull(GrapheneRepositorySelector),
-        description="Retrieves JSON blob to drive integrated code location docs.",
-    )
-
     sensorOrError = graphene.Field(
         graphene.NonNull(GrapheneSensorOrError),
         sensorSelector=graphene.NonNull(GrapheneSensorSelector),
@@ -778,27 +767,6 @@ def resolve_utilizedEnvVarsOrError(self, graphene_info: ResolveInfo, **kwargs):
             RepositorySelector.from_graphql_input(kwargs.get("repositorySelector")),
         )
 
-    @capture_error
-    def resolve_locationDocsJsonOrError(
-        self, graphene_info: ResolveInfo, repositorySelector: GrapheneRepositorySelector
-    ) -> GrapheneLocationDocsJson:
-        repo_selector = RepositorySelector.from_graphql_input(repositorySelector)
-
-        location = graphene_info.context.get_code_location(repo_selector.location_name)
-        repository = location.get_repository(repo_selector.repository_name)
-        plugin_docs_json = (
-            cast(
-                list,
-                repository.repository_snap.metadata.get(
-                    PLUGIN_COMPONENT_TYPES_JSON_METADATA_KEY, [[]]
-                ),
-            )[0]
-            if repository.repository_snap.metadata
-            else []
-        )
-
-        return GrapheneLocationDocsJson(json=plugin_docs_json)
-
     @capture_error
     def resolve_sensorOrError(
         self, graphene_info: ResolveInfo, sensorSelector: GrapheneRepositorySelector

js_modules/dagster-ui/packages/ui-core/src/graphql/types.ts

@@ -11,12 +11,12 @@
 
 ensure_dagster_tests_import()
 
-GET_DOCS_JSON_QUERY = """
-query GetDocsJson {
-  locationDocsJsonOrError(repositorySelector: {repositoryLocationName: "test_location", repositoryName: "__repository__"}) {
+GET_HAS_LOCATION_DOCS_QUERY = """
+query GetHasLocationDocs {
+  repositoryOrError(repositorySelector: {repositoryLocationName: "test_location", repositoryName: "__repository__"}) {
     __typename
-    ... on LocationDocsJson {
-      json
+    ... on Repository {
+      hasLocationDocs
     }
     ... on PythonError {
       message
@@ -25,6 +25,25 @@
 }
 """
 
+GET_DOCS_JSON_QUERY = """
+query GetDocsJson {
+  repositoryOrError(repositorySelector: {repositoryLocationName: "test_location", repositoryName: "__repository__"}) {
+    __typename
+    ... on Repository {
+      locationDocsJsonOrError {
+        __typename
+        ... on LocationDocsJson {
+          json
+        }
+        ... on PythonError {
+          message
+        }
+      }
+    }
+  }
+}
+"""
+
 
 def get_empty_repo() -> RepositoryDefinition:
     return Definitions().get_repository_def()
@@ -35,13 +54,24 @@ def test_get_empty_docs_json():
         instance_for_test() as instance,
         define_out_of_process_context(__file__, "get_empty_repo", instance) as context,
     ):
+        has_location_docs_result = execute_dagster_graphql(context, GET_HAS_LOCATION_DOCS_QUERY)
+        assert has_location_docs_result.data["repositoryOrError"]["__typename"] == "Repository"
+        assert has_location_docs_result.data["repositoryOrError"]["hasLocationDocs"] is False
+
         get_docs_json_result = execute_dagster_graphql(context, GET_DOCS_JSON_QUERY)
+        assert get_docs_json_result.data["repositoryOrError"]["__typename"] == "Repository"
         assert (
-            get_docs_json_result.data["locationDocsJsonOrError"]["__typename"] == "LocationDocsJson"
+            get_docs_json_result.data["repositoryOrError"]["locationDocsJsonOrError"]["__typename"]
+            == "LocationDocsJson"
+        )
+        assert (
+            get_docs_json_result.data["repositoryOrError"]["locationDocsJsonOrError"]["json"]
+            is not None
         )
-        assert get_docs_json_result.data["locationDocsJsonOrError"]["json"] is not None
 
-        json_contents = json.loads(get_docs_json_result.data["locationDocsJsonOrError"]["json"])
+        json_contents = json.loads(
+            get_docs_json_result.data["repositoryOrError"]["locationDocsJsonOrError"]["json"]
+        )
         assert len(json_contents) == 0
 
 
@@ -71,12 +101,23 @@ def test_get_docs_json():
         instance_for_test() as instance,
         define_out_of_process_context(__file__, "get_components_repo", instance) as context,
     ):
+        has_location_docs_result = execute_dagster_graphql(context, GET_HAS_LOCATION_DOCS_QUERY)
+        assert has_location_docs_result.data["repositoryOrError"]["__typename"] == "Repository"
+        assert has_location_docs_result.data["repositoryOrError"]["hasLocationDocs"] is True
+
         get_docs_json_result = execute_dagster_graphql(context, GET_DOCS_JSON_QUERY)
+        assert get_docs_json_result.data["repositoryOrError"]["__typename"] == "Repository"
+        assert (
+            get_docs_json_result.data["repositoryOrError"]["locationDocsJsonOrError"]["__typename"]
+            == "LocationDocsJson"
+        )
         assert (
-            get_docs_json_result.data["locationDocsJsonOrError"]["__typename"] == "LocationDocsJson"
+            get_docs_json_result.data["repositoryOrError"]["locationDocsJsonOrError"]["json"]
+            is not None
         )
-        assert get_docs_json_result.data["locationDocsJsonOrError"]["json"] is not None
 
-        json_contents = json.loads(get_docs_json_result.data["locationDocsJsonOrError"]["json"])
+        json_contents = json.loads(
+            get_docs_json_result.data["repositoryOrError"]["locationDocsJsonOrError"]["json"]
+        )
         assert len(json_contents) == 1
         assert json_contents[0]["name"] == "dagster_test"