Validate subgraph manifests using a GraphQL schema

[Jannis]

This validates subgraph manifests when loading them, using a GraphQL schema (manifest-schema.graphql).

We'll want to perform more validation for the GraphQL schema, the ABIs and the mappings. I'll create an epic for this.

Some of the error messages this generates:

Value with incorrect type

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph:

Error at specVersion:
Expected string, found list:
- 1
- 2

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph:

Error at dataSources:
Expected list, found map:
kind: ethereum/contract
name: ENSRegistrar
source:
  address: '0x314159265dd8dbb310642f98f50c066173c1259b'
  abi: EnsRegistrar
mapping:
  kind: ethereum/events
  apiVersion: 0.0.1
  language: wasm/assemblyscript
  file: ./src/ensRegistrar.ts
  entities:
    - Domain
    - Transfer
  abis:
    - name: EnsRegistrar
      file: ./abis/EtherscanAbi.json
  eventHandlers:
    - event: 'Transfer(bytes32,address)'
      handler: transfer
    - event: 'NewOwner(bytes32,bytes32,address)'
      handler: newOwner

Missing file

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph:

Error at schema/file:
File does not exist: ./schema.graphql1

Missing value

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph:

Error at dataSources/0/name:
No value provided

[nenadjaja]

Thank you so much for this!! I was adding it myself any time I got that error message

[Jannis]

Yeah, I know 👍

[Jannis]

@graphprotocol/developers Any suggestions for a better output formatting would be appreciated. What we have to play with are:

1. The path of the field that was invalid (e.g. ["schema", "file"]).
2. The error message.

We could add more hints if we want.

[nenadjaja]

Do we want to leave this commented out?

[Jannis]

Oops, we want to remove it.

[nenadjaja]

@graphprotocol/developers Any suggestions for a better output formatting would be appreciated. What we have to play with are:

1. The path of the field that was invalid (e.g. ["schema", "file"]).
2. The error message.

We could add more hints if we want.

I think that's good! Could we add a line of code, or a method name?

[Jannis]

@nenadjaja I'm not sure what you mean by method name.

I looked into YAML parsers that contain line/column information. They all only provide character start/end positions through YAML ASTs. It would be quite a lot of code to perform the validation using YAML ASTs. I'd rather keep it simple and perform the validation using JS data structures for now, since we may not even use YAML in the final version.

[Jannis]

I've updated the error formatting a little:

Value with incorrect type

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph: Error in subgraph.yaml:

  Path: / > specVersion
  Expected string, found list:
  - 1
  - 2

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph: Error in subgraph.yaml:

  Path: / > dataSources
  Expected list, found map:
  kind: ethereum/contract
  name: ENSRegistrar
  source:
    address: '0x314159265dd8dbb310642f98f50c066173c1259b'
    abi: EnsRegistrar
  mapping:
    kind: ethereum/events
    apiVersion: 0.0.1
    language: wasm/assemblyscript
    file: ./src/ensRegistrar.ts
    entities:
      - EnsDomain
      - Transfer
    abis:
      - name: EnsRegistrar
        file: ./abis/EtherscanAbi.json
    eventHandlers:
      - event: 'Transfer(bytes32,address)'
        handler: transfer
      - event: 'NewOwner(bytes32,bytes32,address)'
        handler: newOwner

Missing file

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph: Error in subgraph.yaml:

  Path: / > schema > file
  File does not exist: ./schema.graphql1

Missing value

➜  ens-subgraph git:(master) ✗ graph build subgraph.yaml
Failed to load subgraph: Error in subgraph.yaml:

  Path: / > dataSources > 0 > name
  No value provided

[Jannis]

@graphprotocol/developers Could you take another look?

[leoyvens]

Really nice, works great!