shotor / graphql-modules-tools-repro

graphql-modules-tools-repro

yarn
yarn start

Go to http://localhost:4000/graphql

{
  userWithError {
    id
    email
  }
}

Should throw error when auth header is not present. But directive is never executed.

Description

src/modules/shared/directives/is-authenticated.ts

1. fieldConfig.resolve is never called: Line 49
2. Potential problem - MapperKind.TYPE never finds the directive: Line 12

import { GraphQLSchema, defaultFieldResolver } from "graphql";
import { mapSchema, MapperKind, getDirective } from "@graphql-tools/utils";
import { ApolloError } from "apollo-server-express";

const DIRECTIVE_NAME = "isAuthenticated";

export const authDirectiveTransformer = (schema: GraphQLSchema) => {
  const typeDirectiveArgumentMaps: Record<string, any> = {};

  mapSchema(schema, {
    [MapperKind.TYPE]: (type) => {
      const directive = getDirective(schema, type, DIRECTIVE_NAME)?.[0];

      // this is always undefined. is this correct?
      console.log("TYPE", directive);

      if (directive) {
        typeDirectiveArgumentMaps[type.name] = directive;
      }

      return undefined;
    },
    [MapperKind.OBJECT_FIELD]: (fieldConfig, _fieldName, typeName) => {
      const directive =
        getDirective(schema, fieldConfig, DIRECTIVE_NAME)?.[0] ??
        typeDirectiveArgumentMaps[typeName];

      if (directive) {
        const { error } = directive;

        // for Query.userWithError:

        // OBJECT_FIELD { error: true }
        console.log("OBJECT_FIELD", directive);

        // {"type":"User","args":{},"astNode":{"kind":"FieldDefinition","name":{"kind":"Name","value":"userWithError","loc":{"start":86,"end":99}},"arguments":[],"type":{"kind":"NamedType","name":{"kind":"Name","value":"User","loc":{"start":101,"end":105}},"loc":{"start":101,"end":105}},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"isAuthenticated","loc":{"start":107,"end":122}},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"error","loc":{"start":123,"end":128}},"value":{"kind":"BooleanValue","value":true,"loc":{"start":130,"end":134}},"loc":{"start":123,"end":134}}],"loc":{"start":106,"end":135}}],"loc":{"start":86,"end":135}}}
        console.log("OBJECT_FIELD_FIELD_CONFIG", JSON.stringify(fieldConfig));

        // undefined
        console.log(
          "OBJECT_FIELD_FIELD_CONFIG_RESOLVE",
          JSON.stringify(fieldConfig.resolve)
        );

        const { resolve = defaultFieldResolver } = fieldConfig;

        // expect this resolve function to called when calling the query
        // but it's never called
        fieldConfig.resolve = (source, args, context, info) => {
          console.log("RESOLVE_IS_AUTHENTICATED");

          if (!context.headers["auth"]) {
            if (error) {
              throw new ApolloError("unauthorized");
            }

            return null;
          }

          return resolve(source, args, context, info);
        };
      }

      return fieldConfig;
    },
  });
};

Wiring

src/modules/shared/index.ts

// loads the directive graphql type from ./schema/directive-is-authenticated.graphql
const typeDefsArray = loadFilesSync(`${__dirname}/schema/*.graphql`, {
  useRequire: true,
});

src/modules/index.ts

export const createSchema = () => {
  // create schema
  const schema = AppModule.createSchemaForApollo();

  // transform schema to include auth directive
  authDirectiveTransformer(schema);

  return schema;
};

src/index.ts

import { ApolloServer } from "apollo-server-express";

const startApolloServer = async () => {
  // get transformed schema
  const schema = createSchema();

  // and pass it to apollo-server-express
  const server = new ApolloServer({
    schema,
    plugins: [ApolloServerPluginLandingPageGraphQLPlayground()],
  });

  await server.start();
  const app = express();

  server.applyMiddleware({ app });

  app.listen({ port: 4000 }, () => {
    console.log(`🚀 Server ready at http://localhost:4000/graphql`);
  });
};