chore(graphql): add linter to ensure docstrings on graphene graphql o…

…bjects (#7669)

js_modules/dagit/packages/core/src/scripts/generateGraphQLTypes.ts

@@ -8,19 +8,18 @@ console.log('Downloading schema...');
 const TARGET_FILE = './src/graphql/schema.graphql';
 
 // https://github.com/dagster-io/dagster/issues/2623
+// Initially, write schema.graphql in the SDL format, without descriptions
+// Otherwise, the generated types in Typescript would also have descriptions.
 const result = execSync(
   `dagster-graphql --ephemeral-instance --empty-workspace -t '${getIntrospectionQuery({
     descriptions: false,
   })}'`,
   {cwd: '../../../../examples/docs_snippets/'},
 ).toString();
-
 const schemaJson = JSON.parse(result).data;
-
-// Write schema.graphql in the SDL format
 const sdl = printSchema(buildClientSchema(schemaJson));
 
-console.log('Generating schema.graphql...');
+console.log('Generating schema.graphql without descriptions...');
 
 writeFileSync(TARGET_FILE, sdl);
 
@@ -45,6 +44,19 @@ execSync(
   {stdio: 'inherit'},
 );
 
+// https://github.com/dagster-io/dagster/issues/2623
+// Finally, write schema.graphql in the SDL format, with descriptions
+const resultWithDescriptions = execSync(
+  `dagster-graphql --ephemeral-instance --empty-workspace -t '${getIntrospectionQuery()}'`,
+  {cwd: '../../../../examples/docs_snippets/'},
+).toString();
+const schemaJsonWithDescriptions = JSON.parse(resultWithDescriptions).data;
+const sdlWithDescriptions = printSchema(buildClientSchema(schemaJsonWithDescriptions));
+
+console.log('Generating schema.graphql with descriptions...');
+
+writeFileSync(TARGET_FILE, sdlWithDescriptions);
+
 execSync(`yarn prettier --loglevel silent --write ${TARGET_FILE}`, {stdio: 'inherit'});
 
 console.log('Done!');

python_modules/dagster-graphql/dagster_graphql/schema/asset_graph.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 from typing import TYPE_CHECKING, List, Optional, Sequence, Union
 
 import graphene

python_modules/dagster-graphql/dagster_graphql/schema/asset_key.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from .util import non_null_list

python_modules/dagster-graphql/dagster_graphql/schema/backfill.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/config_type_or_error.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from .config_types import (

python_modules/dagster-graphql/dagster_graphql/schema/config_types.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/dagster_types.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 from dagster_graphql.implementation.events import iterate_metadata_entries
 from dagster_graphql.schema.metadata import GrapheneMetadataEntry

python_modules/dagster-graphql/dagster_graphql/schema/errors.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/execution.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/external.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 from dagster_graphql.implementation.fetch_runs import (
     get_in_progress_runs_by_step,

python_modules/dagster-graphql/dagster_graphql/schema/inputs.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 import pendulum
 

python_modules/dagster-graphql/dagster_graphql/schema/instance.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import sys
 
 import graphene

python_modules/dagster-graphql/dagster_graphql/schema/instigation.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import sys
 import warnings
 

python_modules/dagster-graphql/dagster_graphql/schema/logs/compute_logs.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/logs/events.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/logs/log_level.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import logging
 
 import graphene

python_modules/dagster-graphql/dagster_graphql/schema/metadata.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from .asset_key import GrapheneAssetKey

python_modules/dagster-graphql/dagster_graphql/schema/paging.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 

python_modules/dagster-graphql/dagster_graphql/schema/partition_sets.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 from dagster_graphql.implementation.fetch_partition_sets import (
     get_partition_by_name,

python_modules/dagster-graphql/dagster_graphql/schema/permissions.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/config.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 from collections import namedtuple
 
 import graphene

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/config_result.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from ..errors import GraphenePipelineNotFoundError, GraphenePythonError

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/logger.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/mode.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/pipeline.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 import yaml
 

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/pipeline_errors.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/pipeline_ref.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/pipeline_run_stats.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/resource.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/snapshot.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/status.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 

python_modules/dagster-graphql/dagster_graphql/schema/pipelines/subscription.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from ..logs.events import GrapheneDagsterRunEvent

python_modules/dagster-graphql/dagster_graphql/schema/repository_origin.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/roots/assets.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from ..errors import GrapheneAssetNotFoundError, GraphenePythonError

python_modules/dagster-graphql/dagster_graphql/schema/roots/execution_plan.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from ..errors import GraphenePipelineNotFoundError, GraphenePythonError

python_modules/dagster-graphql/dagster_graphql/schema/roots/mutation.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/roots/pipeline.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from ..errors import GrapheneGraphNotFoundError, GraphenePipelineNotFoundError, GraphenePythonError

python_modules/dagster-graphql/dagster_graphql/schema/roots/query.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/roots/subscription.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/run_config.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/runs.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import json
 
 import graphene

python_modules/dagster-graphql/dagster_graphql/schema/schedules/__init__.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster import check

python_modules/dagster-graphql/dagster_graphql/schema/schedules/schedules.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 from dagster_graphql.implementation.loader import RepositoryScopedBatchLoader
 

python_modules/dagster-graphql/dagster_graphql/schema/schedules/ticks.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from dagster.core.scheduler.instigation import TickStatus

python_modules/dagster-graphql/dagster_graphql/schema/sensors.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 from dagster_graphql.implementation.loader import RepositoryScopedBatchLoader
 from dagster_graphql.implementation.utils import capture_error, check_permission

python_modules/dagster-graphql/dagster_graphql/schema/solids.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 from functools import lru_cache
 
 import graphene

python_modules/dagster-graphql/dagster_graphql/schema/table.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from .util import non_null_list

python_modules/dagster-graphql/dagster_graphql/schema/tags.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from .util import non_null_list

python_modules/dagster-graphql/dagster_graphql/schema/used_solid.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-graphene-docstring
 import graphene
 
 from .pipelines.pipeline import GraphenePipeline

python_modules/dagster/dagster/utils/linter.py

@@ -35,6 +35,11 @@ class DagsterChecker(BaseChecker):
                 "pendulum datetime"
             ),
         ),
+        "W0005": (
+            "Graphene object without docstring",
+            "missing-graphene-docstring",
+            "A docstring must be written for Graphene GraphQL object",
+        ),
     }
     options = ()
 
@@ -92,6 +97,10 @@ def visit_call(self, node):
         ):
             self.add_message("pendulum-in-tz", node=node)
 
+    def visit_classdef(self, node):
+        if any(n for n in node.basenames if "graphene" in n) and not node.doc_node:
+            self.add_message("missing-graphene-docstring", node=node)
+
 
 def register_solid_transform():
     def _is_solid_or_op(node):