Paths

Table of Contentst

Differential D5137

[dagit] Use lint to enforce query inclusion of `id` field
ClosedPublic
Actions

Authored by dish on Nov 13 2020, 6:10 PM.

Tags

None

Subscribers

None

Details

Reviewers

dgibson
alangenfeld
• sashank
prha
bengotow

Commits

R1:075794013623: [dagit] Use lint to enforce query inclusion of `id` field

Summary

In an effort to improve our Apollo caching, use id fields more consistently in GraphQL.

Add a few new id fields where we currently have a value that can be used, plus a couple others that seemed reasonable (please push back if I'm wrong)
Use the GraphQL eslint plugin to enforce that id is used whenever it is available on a type
Repair all lint errors by adding id as needed
Remove a handful manual ids from AppCache

Ideally we would be able to use this anywhere that Apollo currently shows a cache warning.

Test Plan

Lint, jest, ts. Load Dagit, navigate around and verify that things look fine.

Diff Detail

Repository

Branch

dish-id-fields (branched from master)

Lint

Lint Passed

Unit

No Test Coverage

Event Timeline

dish created this revision.Nov 13 2020, 6:10 PM

Harbormaster completed remote builds in B21142: Diff 25645.Nov 13 2020, 6:25 PM

dish requested review of this revision.Nov 13 2020, 6:25 PM

Oh this is cool - I didn't realize that there was a linter plugin for this.

I know Apollo will look for "name" or "key" as well and automatically use that, but I think that's not sufficient for pipelines. I wonder if it's preferable to put pipeline IDs in the graphql schema or to define custom ID generators on the apollo side over here (https://www.apollographql.com/docs/react/caching/cache-configuration/#generating-unique-identifiers) to prevent collision / weird autogen'd keys?

really missing that relay build step right now

lint errors look legit, but this looks reasonable.

This revision is now accepted and ready to land.Nov 17 2020, 4:06 PM

Lint suppressions on the worker.ts file

Harbormaster completed remote builds in B21268: Diff 25798.Nov 17 2020, 5:13 PM

Rebase

Harbormaster completed remote builds in B21283: Diff 25818.Nov 17 2020, 8:29 PM

Closed by commit R1:075794013623: [dagit] Use lint to enforce query inclusion of `id` field (authored by dish). · Explain WhyNov 17 2020, 9:54 PM

This revision was automatically updated to reflect the committed changes.

dish added a commit: R1:075794013623: [dagit] Use lint to enforce query inclusion of `id` field.

Revision Contents
Changeset List

Path

Size

js_modules/

dagit/

17 lines

jest/

mocks/

dagre_layout.worker.ts

6 lines

2 lines

src/

8 lines

PipelineExplorerRoot.tsx

1 line

PipelineRunsRoot.tsx

1 line

RepositoryInformation.tsx

2 lines

__tests__/

9 lines

assets/

3 lines

types/

AssetPartitionGridFragment.ts

gaant/

RunGroupPanel.tsx

1 line

types/

RunGroupPanelQuery.ts

graph/

getFullSolidLayout.ts

2 lines

nav/

ReloadRepositoryLocationButton.tsx

1 line

RepositoryContentList.tsx

1 line

SchedulesList.tsx

2 lines

types/

ContentListSolidsQuery.ts

ReloadRepositoryLocationMutation.ts

SchedulesListQuery.ts

partitions/

PartitionGraphSet.tsx

1 line

PartitionGraphUtils.tsx

1 line

PartitionRunListForStep.tsx

1 line

PartitionRunMatrix.tsx

2 lines

PartitionsBackfill.tsx

2 lines

types/

PartitionGraphFragment.ts

PartitionGraphSetRunFragment.ts

PartitionRunListForStepQuery.ts

PartitionRunMatrixPipelineQuery.ts

PartitionRunMatrixRunFragment.ts

PartitionSetLoaderQuery.ts

PartitionSetLoaderRunFragment.ts

PartitionsBackfillSelectorQuery.ts

useChunkedPartitionsQuery.tsx

2 lines

pipelines/

PipelineOverviewRoot.tsx

7 lines

types/

OverviewScheduleFragment.ts

PipelineOverviewQuery.ts

runs/

LogsProvider.tsx

1 line

RunActionsMenu.tsx

1 line

RunFragments.tsx

1 line

1 line

1 line

RunStatusToPageAttributes.tsx

1 line

1 line

5 lines

1 line

1 line

types/

LaunchPipelineExecution.ts

LaunchPipelineReexecution.ts

PipelineEnvironmentYamlQuery.ts

PipelineRunLogsSubscriptionStatusFragment.ts

RunActionMenuFragment.ts

RunRootQuery.ts

RunStatsQuery.ts

RunStatusPipelineRunFragment.ts

RunTableRunFragment.ts

RunTimeFragment.ts

RunsRootQuery.ts

RunsSearchSpaceQuery.ts

schedules/

ScheduleRoot.tsx

1 line

ScheduleRow.tsx

1 line

ScheduleUtils.tsx

6 lines

SchedulerRoot.tsx

1 line

types/

FetchScheduleYaml.ts

ScheduleDefinitionFragment.ts

ScheduleRootQuery.ts

ScheduleStateFragment.ts

SchedulerRootQuery.ts

SchedulesRootQuery.ts

7 lines

snapshots/

SnapshotNav.tsx

1 line

types/

SnapshotQuery.ts

solids/

SolidDetailsRoot.tsx

1 line

1 line

types/

SolidsRootQuery.ts

UsedSolidDetailsQuery.ts

testing/

ApolloTestProvider.tsx

5 lines

defaultMocks.ts

2 lines

types/

PipelineExplorerRootQuery.ts

PipelineRunsRootQuery.ts

RepositoryInfoFragment.ts

workspace/

RepositoryPipelinesList.tsx

2 lines

RepositorySchedulesList.tsx

4 lines

RepositorySolidsList.tsx

1 line

WorkspaceContext.tsx

3 lines

types/

RepositoryPipelinesListQuery.ts

RepositorySchedulesListQuery.ts

RepositorySolidsListQuery.ts

RootRepositoriesQuery.ts

117 lines

python_modules/

dagster-graphql/

dagster_graphql/

schema/

8 lines

4 lines

4 lines

schedules/

schedule_definition.py

4 lines

Diff 25818

js_modules/dagit/.eslintrc.js

Loading...

js_modules/dagit/jest/mocks/dagre_layout.worker.ts

Loading...

js_modules/dagit/package.json

Loading...

js_modules/dagit/src/AppCache.tsx

Loading...

js_modules/dagit/src/PipelineExplorerRoot.tsx

Loading...

js_modules/dagit/src/PipelineRunsRoot.tsx

Loading...

js_modules/dagit/src/RepositoryInformation.tsx

Loading...

js_modules/dagit/src/tests/App.test.tsx

Loading...

js_modules/dagit/src/assets/AssetView.tsx

Loading...

js_modules/dagit/src/assets/types/AssetPartitionGridFragment.ts

Loading...

js_modules/dagit/src/assets/types/AssetQuery.ts

Loading...

js_modules/dagit/src/gaant/RunGroupPanel.tsx

Loading...

js_modules/dagit/src/gaant/types/RunGroupPanelQuery.ts

Loading...

js_modules/dagit/src/graph/getFullSolidLayout.ts

Loading...

js_modules/dagit/src/nav/ReloadRepositoryLocationButton.tsx

Loading...

js_modules/dagit/src/nav/RepositoryContentList.tsx

Loading...

js_modules/dagit/src/nav/SchedulesList.tsx

Loading...

js_modules/dagit/src/nav/types/ContentListSolidsQuery.ts

Loading...

js_modules/dagit/src/nav/types/ReloadRepositoryLocationMutation.ts

Loading...

js_modules/dagit/src/nav/types/SchedulesListQuery.ts

Loading...

js_modules/dagit/src/partitions/PartitionGraphSet.tsx

Loading...

js_modules/dagit/src/partitions/PartitionGraphUtils.tsx

Loading...

js_modules/dagit/src/partitions/PartitionRunListForStep.tsx

Loading...

js_modules/dagit/src/partitions/PartitionRunMatrix.tsx

Loading...

js_modules/dagit/src/partitions/PartitionsBackfill.tsx

Loading...

js_modules/dagit/src/partitions/types/PartitionGraphFragment.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionGraphSetRunFragment.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionRunListForStepQuery.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionRunMatrixPipelineQuery.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionRunMatrixRunFragment.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionSetLoaderQuery.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionSetLoaderRunFragment.ts

Loading...

js_modules/dagit/src/partitions/types/PartitionsBackfillSelectorQuery.ts

Loading...

js_modules/dagit/src/partitions/useChunkedPartitionsQuery.tsx

Loading...

js_modules/dagit/src/pipelines/PipelineOverviewRoot.tsx

Loading...

js_modules/dagit/src/pipelines/types/OverviewScheduleFragment.ts

Loading...

js_modules/dagit/src/pipelines/types/PipelineOverviewQuery.ts

Loading...

js_modules/dagit/src/runs/LogsProvider.tsx

Loading...

js_modules/dagit/src/runs/RunActionsMenu.tsx

Loading...

js_modules/dagit/src/runs/RunFragments.tsx

Loading...

js_modules/dagit/src/runs/RunRoot.tsx

Loading...

js_modules/dagit/src/runs/RunStats.tsx

Loading...

js_modules/dagit/src/runs/RunStatusToPageAttributes.tsx

Loading...

js_modules/dagit/src/runs/RunTable.tsx

Loading...

js_modules/dagit/src/runs/RunUtils.tsx

Loading...

js_modules/dagit/src/runs/RunsFilter.tsx

Loading...

js_modules/dagit/src/runs/RunsRoot.tsx

Loading...

js_modules/dagit/src/runs/types/Cancel.ts

Loading...

js_modules/dagit/src/runs/types/LaunchPipelineExecution.ts

Loading...

js_modules/dagit/src/runs/types/LaunchPipelineReexecution.ts

Loading...

js_modules/dagit/src/runs/types/PipelineEnvironmentYamlQuery.ts

Loading...

js_modules/dagit/src/runs/types/PipelineRunLogsSubscriptionStatusFragment.ts

Loading...

js_modules/dagit/src/runs/types/RunActionMenuFragment.ts

Loading...

js_modules/dagit/src/runs/types/RunFragment.ts

Loading...

js_modules/dagit/src/runs/types/RunRootQuery.ts

Loading...

js_modules/dagit/src/runs/types/RunStatsQuery.ts

Loading...

js_modules/dagit/src/runs/types/RunStatusPipelineRunFragment.ts

Loading...

js_modules/dagit/src/runs/types/RunTableRunFragment.ts

Loading...

js_modules/dagit/src/runs/types/RunTimeFragment.ts

Loading...

js_modules/dagit/src/runs/types/RunsRootQuery.ts

Loading...

js_modules/dagit/src/runs/types/RunsSearchSpaceQuery.ts

Loading...

js_modules/dagit/src/schedules/ScheduleRoot.tsx

Loading...

js_modules/dagit/src/schedules/ScheduleRow.tsx

Loading...

js_modules/dagit/src/schedules/ScheduleUtils.tsx

Loading...

js_modules/dagit/src/schedules/SchedulerRoot.tsx

Loading...

js_modules/dagit/src/schedules/types/FetchScheduleYaml.ts

Loading...

js_modules/dagit/src/schedules/types/ScheduleDefinitionFragment.ts

Loading...

js_modules/dagit/src/schedules/types/ScheduleRootQuery.ts

Loading...

js_modules/dagit/src/schedules/types/ScheduleStateFragment.ts

Loading...

js_modules/dagit/src/schedules/types/SchedulerRootQuery.ts

Loading...

js_modules/dagit/src/schedules/types/SchedulesRootQuery.ts

Loading...

js_modules/dagit/src/schema.graphql

Loading...

js_modules/dagit/src/snapshots/SnapshotNav.tsx

Loading...

js_modules/dagit/src/snapshots/types/SnapshotQuery.ts

Loading...

js_modules/dagit/src/solids/SolidDetailsRoot.tsx

Loading...

js_modules/dagit/src/solids/SolidsRoot.tsx

Loading...

js_modules/dagit/src/solids/types/SolidsRootQuery.ts

Loading...

js_modules/dagit/src/solids/types/UsedSolidDetailsQuery.ts

Loading...

js_modules/dagit/src/testing/ApolloTestProvider.tsx

Loading...

js_modules/dagit/src/testing/defaultMocks.ts

Loading...

js_modules/dagit/src/types/PipelineExplorerRootQuery.ts

Loading...

js_modules/dagit/src/types/PipelineRunsRootQuery.ts

Loading...

js_modules/dagit/src/types/RepositoryInfoFragment.ts

Loading...

js_modules/dagit/src/workspace/RepositoryPipelinesList.tsx

Loading...

js_modules/dagit/src/workspace/RepositorySchedulesList.tsx

Loading...

js_modules/dagit/src/workspace/RepositorySolidsList.tsx

Loading...

js_modules/dagit/src/workspace/WorkspaceContext.tsx

Loading...

js_modules/dagit/src/workspace/types/RepositoryPipelinesListQuery.ts

Loading...

js_modules/dagit/src/workspace/types/RepositorySchedulesListQuery.ts

Loading...

js_modules/dagit/src/workspace/types/RepositorySolidsListQuery.ts

Loading...

js_modules/dagit/src/workspace/types/RootRepositoriesQuery.ts

Loading...

js_modules/dagit/yarn.lock

Loading...

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

Loading...

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

Loading...

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

Loading...

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

Loading...