Verify that the GraphQL identifier matches a valid Mongo ObjectId

Question

Verify that the GraphQL identifier matches a valid Mongo ObjectId

Currently, I am using Apollo Server to construct a graphql based server that communicates with a MongoDB instance. My goal is to ensure that if the client provides a value for a field that has a graphql type of ID, the value must be a valid mongo ObjectId. Even though mongoose has a utility function to check this, my main concern is to receive a validation error at the graphql level (i.e., a 400) if the value is not a valid ObjectId. I want to avoid encountering a 500 error later in the process when attempting to use that value as an ObjectId and I do not wish to validate the value multiple times within the server.

In essence, I aim to implement validation logic at the graphql level specifically for the ID scalar type, if that clarifies things.

javascript mongodb validation graphql apollo

Answer 1

Answer №1

To achieve the desired functionality, it is recommended to implement a custom scalar instead of using the ID type. You have the option to create your own custom scalar or utilize an existing one.

import { Kind, GraphQLError, GraphQLScalarType, ValueNode } from 'graphql';

const MONGODB_OBJECTID_REGEX = /*#__PURE__*/ new RegExp(/^[A-Fa-f0-9]{24}$/);

export const GraphQLObjectID = /*#__PURE__*/ new GraphQLScalarType({
  name: 'ObjectID',

  description:
    'A field whose value adheres to the standard MongoDB Object ID format as specified in the documentation here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c',

  serialize(value: string) {
    if (!MONGODB_OBJECTID_REGEX.test(value)) {
      throw new TypeError(
        `Value is not a valid MongoDB Object ID in the form: ${value}`,
      );
    }

    return value;
  },

  parseValue(value: string) {
    if (!MONGODB_OBJECTID_REGEX.test(value)) {
      throw new TypeError(
        `Value is not a valid MongoDB Object ID in the form: ${value}`,
      );
    }

    return value;
  },

  parseLiteral(ast: ValueNode) {
    if (ast.kind !== Kind.STRING) {
      throw new GraphQLError(
        `Only strings can be validated as MongoDB Object IDs, but received: ${ast.kind}`,
      );
    }

    if (!MONGODB_OBJECTID_REGEX.test(ast.value)) {
      throw new TypeError(
        `Value is not a valid MongoDB Object ID in the form: ${ast.value}`,
      );
    }

    return ast.value;
  },
});

Answer 2

To achieve the desired functionality, it is recommended to implement a custom scalar instead of using the ID type. You have the option to create your own custom scalar or utilize an existing one.

import { Kind, GraphQLError, GraphQLScalarType, ValueNode } from 'graphql';

const MONGODB_OBJECTID_REGEX = /*#__PURE__*/ new RegExp(/^[A-Fa-f0-9]{24}$/);

export const GraphQLObjectID = /*#__PURE__*/ new GraphQLScalarType({
  name: 'ObjectID',

  description:
    'A field whose value adheres to the standard MongoDB Object ID format as specified in the documentation here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c',

  serialize(value: string) {
    if (!MONGODB_OBJECTID_REGEX.test(value)) {
      throw new TypeError(
        `Value is not a valid MongoDB Object ID in the form: ${value}`,
      );
    }

    return value;
  },

  parseValue(value: string) {
    if (!MONGODB_OBJECTID_REGEX.test(value)) {
      throw new TypeError(
        `Value is not a valid MongoDB Object ID in the form: ${value}`,
      );
    }

    return value;
  },

  parseLiteral(ast: ValueNode) {
    if (ast.kind !== Kind.STRING) {
      throw new GraphQLError(
        `Only strings can be validated as MongoDB Object IDs, but received: ${ast.kind}`,
      );
    }

    if (!MONGODB_OBJECTID_REGEX.test(ast.value)) {
      throw new TypeError(
        `Value is not a valid MongoDB Object ID in the form: ${ast.value}`,
      );
    }

    return ast.value;
  },
});

Verify that the GraphQL identifier matches a valid Mongo ObjectId

Answer №1

Similar questions

Create a JSON file on the fly

What could be the reason for AngularJS encoding the URLs for my POST parameters?

Transferring a data point within the MongoDB aggregation pipeline to be used in sorting the final outcomes

Manage and preserve your node.js/express sessions with this offer

The AJAX function fails to trigger the MVC controller method

The timer freezes at one minute remaining

Node.js Express post query failing to set content type

Ways to invoke a function within a React Material-UI component

Issue with Framework7: Swiper slider link not functional

Establish the editor's starting state

Is it possible to reuse variables declared in a Javascript function within the same function?

Tips on extracting images from a blob:http localhost URL using jquery, angularjs, or webgl

No reply from Axios after using async await

Alexa Skills Issue: Problem with Playing AudioPlayer HLS Stream URL

The FuelUx scheduler forgets which day we've chosen when selecting weekly recurrence

Restart the _.after function counter

Retrieving a portion of a file using Jquery ajax

Enclose this within Stencil.js components

Blend the power of Node's CommonJS with the versatility of Typescript's ES modules

Finding Exponential Moving Averages (EMA) with the power of JavaScript