Script to audit a GraphQL schema against previous commit.

audit-graphql-schema.js

/*
  This is free and unencumbered software released into the public domain.

  Anyone is free to copy, modify, publish, use, compile, sell, or
  distribute this software, either in source code form or as a compiled
  binary, for any purpose, commercial or non-commercial, and by any
  means.

  In jurisdictions that recognize copyright laws, the author or authors
  of this software dedicate any and all copyright interest in the
  software to the public domain. We make this dedication for the benefit
  of the public at large and to the detriment of our heirs and
  successors. We intend this dedication to be an overt act of
  relinquishment in perpetuity of all present and future rights to this
  software under copyright law.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  OTHER DEALINGS IN THE SOFTWARE.

  For more information, please refer to <http://unlicense.org/>
*/

const path = require('path')
const fs = require('fs')
const { execSync } = require('child_process')
const { diff } = require('@graphql-inspector/core')
const { buildSchema } = require('graphql')
const chalk = require('chalk')

const oldFile = execSync('git show HEAD:www/generated/schema.graphql')
const newFile = fs.readFileSync(
  path.join(__dirname, 'www/generated/schema.graphql'),
)

const oldSchema = buildSchema(oldFile.toString())
const newSchema = buildSchema(newFile.toString())

const changes = diff(oldSchema, newSchema)
const changeCount = changes.length
if (changeCount < 1) {
  console.log('No changes to GraphQL schema since last commit!')
} else {
  console.log(
    `Detected the following ${
      changeCount > 1 ? changeCount + ' changes' : 'change'
    } to the GraphQL schema since last commit:\n`,
  )

  const nonBreaking = changes.filter(
    ({ criticality: { level } }) => level === 'NON_BREAKING',
  )
  nonBreaking.forEach((change) => logChange(change))

  const dangerous = changes.filter(
    ({ criticality: { level } }) => level === 'DANGEROUS',
  )
  dangerous.forEach((change) => logChange(change))

  const breaking = changes.filter(
    ({ criticality: { level } }) => level === 'BREAKING',
  )
  breaking.forEach((change) => logChange(change))

  console.log(
    `\nPlease review the previous ${
      changeCount > 1 ? changeCount + ' changes' : 'change'
    } to the GraphQL schema since last commit!
 ${chalk.red('✖')} Breaking: ${breaking.length}
 ${chalk.yellow('⚠')} Dangerous: ${dangerous.length}
 ${chalk.green('✔')} OK: ${nonBreaking.length}.`,
  )
}

function logChange({ criticality: { level, reason }, message }) {
  if (level === 'NON_BREAKING')
    console.log(`${printLevel(level)} ${printMessage(message)}`)
  else
    console.log(
      `${printLevel(level)} ${printMessage(message)}\n  - Reason: ${reason}`,
    )
}

function printMessage(msg) {
  const findSingleQuotes = /\'([^']+)\'/gim
  const findDoubleQuotes = /\"([^"]+)\"/gim

  return msg
    .replace(findSingleQuotes, (_, value) => chalk.bold(value))
    .replace(findDoubleQuotes, (_, value) => chalk.bold(value))
}

function printLevel(level) {
  const levels = {
    DANGEROUS: chalk.yellow('⚠'),
    BREAKING: chalk.red('✖'),
    NON_BREAKING: chalk.green('✔'),
  }

  return levels[level]
}