error-map.ts

import { stripIndent, stripIndents } from "common-tags"
import { IOptionalGraphQLInfoContext, Level, Type } from "./types"

const optionalGraphQLInfo = (context: IOptionalGraphQLInfoContext): string =>
  `${context.codeFrame ? `\n\n${context.codeFrame}` : ``}${
    context.filePath ? `\n\nFile path: ${context.filePath}` : ``
  }${context.urlPath ? `\nUrl path: ${context.urlPath}` : ``}${
    context.plugin ? `\nPlugin: ${context.plugin}` : ``
  }`

export enum ErrorCategory {
  USER = `USER`,
  SYSTEM = `SYSTEM`,
  THIRD_PARTY = `THIRD_PARTY`,
}

const errors = {
  "": {
    text: (context): string => {
      const sourceMessage =
        context && context.sourceMessage
          ? context.sourceMessage
          : `There was an error`
      return sourceMessage
    },
    level: Level.ERROR,
  },
  "95312": {
    text: (context): string =>
      `"${context.ref}" is not available during server side rendering.`,
    level: Level.ERROR,
    docsUrl: `https://gatsby.dev/debug-html`,
    category: ErrorCategory.USER,
  },
  "95313": {
    text: (context): string =>
      `Building static HTML failed${
        context.errorPath ? ` for path "${context.errorPath}"` : ``
      }`,
    level: Level.ERROR,
    docsUrl: `https://gatsby.dev/debug-html`,
  },
  "98123": {
    text: (context): string =>
      `${context.stageLabel} failed\n\n${
        context.sourceMessage ?? context.message
      }`,
    type: Type.WEBPACK,
    level: Level.ERROR,
  },
  "98124": {
    text: (context): string =>
      `${context.stageLabel} failed\n\n${context.sourceMessage}\n\nIf you're trying to use a package make sure that '${context.packageName}' is installed. If you're trying to use a local file make sure that the path is correct.`,
    type: Type.WEBPACK,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85901": {
    text: (context): string =>
      stripIndent(`
        There was an error in your GraphQL query:\n\n${
          context.sourceMessage
        }${optionalGraphQLInfo(context)}`),
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  // Deprecated
  "85907": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${context.message}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  "85908": {
    text: (context): string => {
      const closestFragment = context.closestFragment
        ? `\n\nDid you mean to use ` + `"${context.closestFragment}"?`
        : ``

      return `There was an error in your GraphQL query:\n\nThe fragment "${context.fragmentName}" does not exist.\n\n${context.codeFrame}${closestFragment}`
    },
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // Deprecated
  "85909": {
    text: (context): string => context.sourceMessage,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  "85910": {
    text: (context): string =>
      stripIndents(`
        Multiple "root" queries found: "${context.name}" and "${context.otherName}".
        Only the first ("${context.otherName}") will be registered.

        Instead of:

        ${context.beforeCodeFrame}

        Do:

        ${context.afterCodeFrame}

        This can happen when you use two page/static queries in one file. Please combine those into one query.
        If you're defining multiple components (each with a static query) in one file, you'll need to move each component to its own file.
      `),
    type: Type.GRAPHQL,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/graphql/`,
    category: ErrorCategory.USER,
  },
  "85911": {
    text: (context): string =>
      stripIndent(`
        There was a problem parsing "${context.filePath}"; any GraphQL
        fragments or queries in this file were not processed.

        This may indicate a syntax error in the code, or it may be a file type
        that Gatsby does not know how to parse.
      `),
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85912": {
    text: (context): string =>
      `Failed to parse preprocessed file ${context.filePath}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  "85913": {
    text: (context): string =>
      `There was a problem reading the file: ${context.filePath}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  "85914": {
    text: (context): string =>
      `There was a problem reading the file: ${context.filePath}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  // default parsing error
  "85915": {
    text: (context): string =>
      `There was a problem parsing the GraphQL query in file: ${context.filePath}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  "85916": {
    text: (context): string =>
      `String interpolation is not allowed in graphql tag:\n\n${context.codeFrame}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85917": {
    text: (context): string =>
      `Unexpected empty graphql tag${
        context.codeFrame ? `\n\n${context.codeFrame}` : ``
      }`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
  },
  "85918": {
    text: (context): string =>
      stripIndent(`
        GraphQL syntax error in query:\n\n${context.sourceMessage}${
        context.codeFrame ? `\n\n${context.codeFrame}` : ``
      }`),
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // Duplicate fragment
  "85919": {
    text: (context): string =>
      stripIndent(`
      Found two different GraphQL fragments with identical name "${context.fragmentName}". Fragment names must be unique

      File: ${context.leftFragment.filePath}
      ${context.leftFragment.codeFrame}

      File: ${context.rightFragment.filePath}
      ${context.rightFragment.codeFrame}
    `),
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // Undefined variables in Queries
  "85920": {
    text: (context): string => {
      const staticQueryMessage = stripIndents(`Suggestion 1:

      If you're not using a page query but a useStaticQuery / StaticQuery you see this error because they currently don't support variables. To learn more about the limitations of useStaticQuery / StaticQuery, please visit these docs:

      https://www.gatsbyjs.org/docs/use-static-query/
      https://www.gatsbyjs.org/docs/static-query/`)

      const generalMessage = stripIndents(`Suggestion 2:

      You might have a typo in the variable name "${context.variableName}" or you didn't provide the variable via context to this page query. Have a look at the docs to learn how to add data to context:

      https://www.gatsbyjs.org/docs/page-query/#how-to-add-query-variables-to-a-page-query`)

      return stripIndent(`
        There was an error in your GraphQL query:\n\n${
          context.sourceMessage
        }${optionalGraphQLInfo(
        context
      )}\n\n${staticQueryMessage}\n\n${generalMessage}`)
    },
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85921": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${context.sourceMessage}\n\nIf you're e.g. filtering for specific nodes make sure that you choose the correct field (that has the same type "${context.inputType}") or adjust the context variable to the type "${context.expectedType}".`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85922": {
    text: (context): string =>
      `There was an error in your GraphQL query:

      ${context.sourceMessage}

      This can happen if you e.g. accidentally added { } to the field "${context.fieldName}". If you didn't expect "${context.fieldName}" to be of type "${context.fieldType}" make sure that your input source and/or plugin is correct.
      However, if you expect "value" to exist, the field might be accessible in another subfield. Please try your query in GraphiQL and use the GraphiQL explorer to see which fields you can query and what shape they have.

      It is recommended to explicitly type your GraphQL schema if you want to use optional fields. This way you don't have to add the mentioned
      "dummy content". Visit our docs to learn how you can define the schema for "${context.type}":
      https://www.gatsbyjs.org/docs/schema-customization/#creating-type-definitions`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85923": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${context.sourceMessage}\n\nIf you don't expect "${context.field}" to exist on the type "${context.type}" it is most likely a typo.\nHowever, if you expect "${context.field}" to exist there are a couple of solutions to common problems:\n\n- If you added a new data source and/or changed something inside gatsby-node.js/gatsby-config.js, please try a restart of your development server\n- The field might be accessible in another subfield, please try your query in GraphiQL and use the GraphiQL explorer to see which fields you can query and what shape they have\n- You want to optionally use your field "${context.field}" and right now it is not used anywhere. Therefore Gatsby can't infer the type and add it to the GraphQL schema. A quick fix is to add at least one entry with that field ("dummy content")\n\nIt is recommended to explicitly type your GraphQL schema if you want to use optional fields. This way you don't have to add the mentioned "dummy content". Visit our docs to learn how you can define the schema for "${context.type}":\nhttps://www.gatsbyjs.org/docs/schema-customization/#creating-type-definitions`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85924": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${
        context.sourceMessage
      }\n\nThis can happen when you or a plugin/theme explicitly defined the GraphQL schema for this GraphQL object type via the schema customization API and "${
        context.value
      }" doesn't match the (scalar) type of "${
        context.type
      }".${optionalGraphQLInfo(context)}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85925": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${
        context.sourceMessage
      }\n\nThe field "${
        context.field
      }" was explicitly defined as non-nullable via the schema customization API (by yourself or a plugin/theme). This means that this field is not optional and you have to define a value. If this is not your desired behavior and you defined the schema yourself, go to "createTypes" in gatsby-node.js. If you're using a plugin/theme, you can learn more here on how to fix field types:\nhttps://www.gatsbyjs.org/docs/schema-customization/#fixing-field-types${optionalGraphQLInfo(
        context
      )}`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85926": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${context.sourceMessage}\n\nThis can happen when you used graphql\`{ ...yourQuery }\` instead of graphql(\`{ ...yourQuery }\`) inside gatsby-node.js\n\nYou can't use the template literal function you're used to (from page queries) and rather have to call graphql() as a normal function.`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "85927": {
    text: (context): string =>
      `There was an error in your GraphQL query:\n\n${context.sourceMessage}\n\nSee if ${context.variable} has a typo or ${context.operation} doesn't actually require this variable.`,
    type: Type.GRAPHQL,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // Config errors
  "10122": {
    text: (context): string =>
      `The site's gatsby-config.js failed validation:\n\n${context.sourceMessage}`,
    type: Type.CONFIG,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "10123": {
    text: (context): string =>
      `We encountered an error while trying to load your site's ${context.configName}. Please fix the error and try again.`,
    type: Type.CONFIG,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "10124": {
    text: (context): string =>
      `It looks like you were trying to add the config file? Please rename "${context.nearMatch}" to "${context.configName}.js"`,
    type: Type.CONFIG,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "10125": {
    text: (context): string =>
      `Your ${context.configName} file is in the wrong place. You've placed it in the src/ directory. It must instead be at the root of your site next to your package.json file.`,
    type: Type.CONFIG,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "10126": {
    text: (context): string =>
      `${context.path}/${context.configName} cannot export a function.` +
      `\n\nA ${context.configName} exported as a Function can only be used as a theme and not run directly.` +
      `\nIf you are trying to run a theme directly, use the theme in an example site or starter instead and run that site to test.` +
      `\nIf you are in the root gatsby-config.js for your site, change the export to be an object and not a function as functions` +
      `\nare not supported in the root gatsby-config.`,
    type: Type.CONFIG,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "10226": {
    text: (context): string =>
      [
        `Couldn't find the "${context.themeName}" plugin declared in "${context.configFilePath}".`,
        context.pathToLocalTheme &&
          `Tried looking for a local plugin in ${context.pathToLocalTheme}.`,
        `Tried looking for an installed package in the following paths:\n${context.nodeResolutionPaths
          .map(potentialLocationPath => ` - ${potentialLocationPath}`)
          .join(`\n`)}`,
      ]
        .filter(Boolean)
        .join(`\n\n`),
    type: Type.CONFIG,
    level: Level.ERROR,
  },
  // Plugin errors
  "11321": {
    text: (context): string =>
      `"${context.pluginName}" threw an error while running the ${
        context.api
      } lifecycle:\n\n${
        context.sourceMessage ?? context.message
      }${optionalGraphQLInfo(context)}`,
    type: Type.PLUGIN,
    level: Level.ERROR,
  },
  "11322": {
    text: (context): string =>
      `${
        context.pluginName
      } created a page and didn't pass the path to the component.\n\nThe page object passed to createPage:\n${JSON.stringify(
        context.pageObject,
        null,
        4
      )}\n\nSee the documentation for the "createPage" action — https://www.gatsbyjs.org/docs/actions/#createPage`,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "11323": {
    text: (context): string =>
      `${
        context.pluginName
      } must set the page path when creating a page.\n\nThe page object passed to createPage:\n${JSON.stringify(
        context.pageObject,
        null,
        4
      )}\n\nSee the documentation for the "createPage" action — https://www.gatsbyjs.org/docs/actions/#createPage`,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "11324": {
    text: (context): string =>
      `${context.message}\n\nSee the documentation for the "createPage" action — https://www.gatsbyjs.org/docs/actions/#createPage`,
    level: Level.ERROR,
  },
  "11325": {
    text: (context): string =>
      `${
        context.pluginName
      } created a page with a component that doesn't exist.\n\nThe path to the missing component is "${
        context.component
      }"\n\nThe page object passed to createPage:\n${JSON.stringify(
        context.pageObject,
        null,
        4
      )}\n\nSee the documentation for the "createPage" action — https://www.gatsbyjs.org/docs/actions/#createPage`,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "11326": {
    text: (context): string =>
      `${
        context.pluginName
      } must set the absolute path to the page component when create creating a page.\n\nThe (relative) path you used for the component is "${
        context.component
      }"\n\nYou can convert a relative path to an absolute path by requiring the path module and calling path.resolve() e.g.\n\nconst path = require("path")\npath.resolve("${
        context.component
      }")\n\nThe page object passed to createPage:\n${JSON.stringify(
        context.pageObject,
        null,
        4
      )}\n\nSee the documentation for the "createPage" action — https://www.gatsbyjs.org/docs/actions/#createPage`,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "11327": {
    text: (context): string =>
      `You have an empty file in the "src/pages" directory at "${context.relativePath}". Please remove it or make it a valid component`,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  "11328": {
    text: (context): string =>
      `A page component must export a React component for it to be valid. Please make sure this file exports a React component:\n\n${context.fileName}`,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // invalid or deprecated APIs
  "11329": {
    text: (context): string =>
      [
        stripIndent(`
          Your plugins must export known APIs from their gatsby-${context.exportType}.js.

          See https://www.gatsbyjs.org/docs/${context.exportType}-apis/ for the list of Gatsby ${context.exportType} APIs.
        `),
      ]
        .concat([``].concat(context.errors))
        .concat(
          context.fixes.length > 0
            ? [
                ``,
                `Some of the following may help fix the error(s):`,
                ``,
                ...context.fixes.map(fix => `- ${fix}`),
              ]
            : []
        )
        .join(`\n`),
    level: Level.ERROR,
  },
  // "X" is not defined in Gatsby's node APIs
  "11330": {
    text: (context): string =>
      `"${context.pluginName}" threw an error while running the ${
        context.api
      } lifecycle:\n\n${context.sourceMessage ?? context.message}\n\n${
        context.codeFrame
      }\n\nMake sure that you don't have a typo somewhere and use valid arguments in ${
        context.api
      } lifecycle.\nLearn more about ${
        context.api
      } here: https://www.gatsbyjs.org/docs/node-apis/#${context.api}`,
    type: Type.PLUGIN,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // Invalid plugin options
  "11331": {
    text: (context): string =>
      [
        stripIndent(`
          Invalid plugin options for "${context.pluginName}"${
          context.configDir ? `, configured by ${context.configDir}` : ``
        }:
        `),
      ]
        .concat([``])
        .concat(
          context.validationErrors.map(error => `- ${error.message}`).join(`\n`)
        )
        .join(`\n`),
    type: Type.PLUGIN,
    level: Level.ERROR,
    category: ErrorCategory.USER,
  },
  // node object didn't pass validation
  "11467": {
    text: (context): string =>
      [
        `The new node didn't pass validation: ${context.validationErrorMessage}`,
        `Failing node:`,
        JSON.stringify(context.node, null, 4),
        `Note: there might be more nodes that failed validation. Output is limited to one node per type of validation failure to limit terminal spam.`,
        context.codeFrame,
      ]
        .filter(Boolean)
        .join(`\n\n`),
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/actions/#createNode`,
  },
  // local SSL certificate errors
  "11521": {
    text: (): string =>
      `for custom ssl --https, --cert-file, and --key-file must be used together`,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/local-https/#custom-key-and-certificate-files`,
    category: ErrorCategory.USER,
  },
  "11522": {
    text: (): string => `Failed to generate dev SSL certificate`,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/local-https/#setup`,
  },
  // cli new command errors
  "11610": {
    text: (context): string =>
      `It looks like you gave wrong argument orders . Try running instead "gatsby new ${context.starter} ${context.rootPath}"`,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/gatsby-cli/#new`,
    category: ErrorCategory.USER,
  },
  "11611": {
    text: (context): string =>
      `It looks like you passed a URL to your project name. Try running instead "gatsby new new-gatsby-project ${context.rootPath}"`,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/gatsby-cli/#new`,
    category: ErrorCategory.USER,
  },
  "11612": {
    text: (context): string =>
      `Could not create a project in "${context.path}" because it's not a valid path`,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/gatsby-cli/#new`,
    category: ErrorCategory.USER,
  },
  "11613": {
    text: (context): string =>
      `Directory ${context.rootPath} is already an npm project`,
    level: Level.ERROR,
    docsUrl: `https://www.gatsbyjs.org/docs/gatsby-cli/#new`,
  },
  // Watchdog
  "11701": {
    text: (context): string =>
      `Terminating the process (due to GATSBY_WATCHDOG_STUCK_STATUS_TIMEOUT):\n\nGatsby is in "${
        context.status
      }" state without any updates for ${(
        context.stuckStatusWatchdogTimeoutDelay / 1000
      ).toFixed(
        3
      )} seconds. Activities preventing Gatsby from transitioning to idle state:\n\n${
        context.stuckStatusDiagnosticMessage
      }`,
    level: Level.ERROR,
  },
}

export type ErrorId = string | keyof typeof errors

export const errorMap: Record<ErrorId, IErrorMapEntry> = errors

export const defaultError = errorMap[``]

export interface IErrorMapEntry {
  text: (context) => string
  // keyof typeof is used for these enums so that the public facing API (e.g. used by setErrorMap) doesn't rely on enum but gives an union
  level: keyof typeof Level
  type?: keyof typeof Type
  category?: keyof typeof ErrorCategory
  docsUrl?: string
}