hasura/graphql-engine

print a context aware diff for metadata

Open

#3263 opened on Oct 28, 2019

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (31,371 stars) (2,787 forks)batch import
c/clihelp wantedk/enhancement

Description

Diff command added #3157 only prints a basic general purpose file diff.

With awareness of Hasura metadata and it's types a better, context aware diff can be printed, where it can do things like:

  • table abcd is tracked
  • relationship name is changed for table xyz

etc.

Contributor guide

Tech stack
typescriptnodejsgraphqlpostgresql
Domain
backendclideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Hasura metadataFamiliarity with CLI diff toolsTypeScript skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the existing diff command implemented in PR #3157. Look at the Hasura metadata types (e.g., MetadataTableConfig, RelationshipInfo) in the codebase. Understand how metadata changes are represented and how context can be extracted. Study any existing tests or documentation. Propose a design for generating human readable diffs that mention table names and relationship changes. The implementation likely requires modifying the diff output logic in the CLI component.