Изменение ответа Graphql перед отправкой

Проведя много исследований, я обнаружил, что единственными разрешенными свойствами верхнего уровня в ответах graphql являются данные, ошибки и расширения. Здесь вы можете найти соответствующую проблему в GitHub

Ошибка GitHub

для моей цели я, вероятно, буду использовать поле расширений.

с сайта graphql.org: Ответом на операцию GraphQL должна быть карта.

Если операция обнаружила какие-либо ошибки, карта ответов должна содержать запись с ключевыми ошибками. Значение этой записи описано в разделе «Ошибки». Если операция завершена без каких-либо ошибок, эта запись не должна присутствовать.

Если операция включала выполнение, карта ответов должна содержать запись с ключевыми данными. Значение этой записи описано в разделе «Данные». Если операция завершилась неудачно перед выполнением из-за синтаксической ошибки, отсутствия информации или ошибки проверки, эта запись не должна присутствовать.

Карта ответов может также содержать запись с ключевыми расширениями. Эта запись, если она установлена, должна иметь карту в качестве значения. Эта запись зарезервирована для разработчиков, которые могут расширить протокол по своему усмотрению, и, следовательно, нет никаких дополнительных ограничений на ее содержимое.

Чтобы будущие изменения протокола не нарушали работу существующих серверов и клиентов, карта ответов верхнего уровня не должна содержать никаких записей, кроме трех, описанных выше.

Пример модификатора данных

Эта функция будет объединять суффикс «: OK» для каждой строки в выходном объекте.

// Data/output modifier - concat ":OK" after each string
function outputModifier(input: any): any {
    const inputType = typeof input;

    if (inputType === 'string') {
        return input + ':OK';
    } else if (Array.isArray(input)) {
        const inputLength = input.length;
        for (let i = 0; i < inputLength; i += 1) {
            input[i] = outputModifier(input[i]);
        }
    } else if (inputType === 'object') {
        for (const key in input) {
            if (input.hasOwnProperty(key)) {
                input[key] = outputModifier(input[key]);
            }
        }
    }

    return input;
}

Решение 1. Переопределить преобразователи GraphQL

Короче говоря: у вас есть 3 основных типа (запрос, мутация и подписка). У каждого основного типа есть поля с преобразователями. Резолверы возвращают выходные данные.

Поэтому, если вы переопределите распознаватели, вы сможете изменить выходные данные.

Пример трансформатора

import { GraphQLSchema } from 'graphql';

export const exampleTransformer = (schema: GraphQLSchema): GraphQLSchema => {
    // Collect all main types & override the resolvers
    [
        schema?.getQueryType()?.getFields(),
        schema?.getMutationType()?.getFields(),
        schema?.getSubscriptionType()?.getFields()
    ].forEach(fields => {
        // Resolvers override
        Object.values(fields ?? {}).forEach(field => {
            // Check is there any resolver at all
            if (typeof field.resolve !== 'function') {
                return;
            }

            // Save the original resolver
            const originalResolve = field.resolve;

            // Override the current resolver
            field.resolve = async (source, inputData, context, info) => {
                // Get the original output
                const outputData: any = await originalResolve.apply(originalResolve.prototype, [source, inputData, context, info]);

                // Modify and return the output
                return outputModifier(outputData);
            };
        });
    });

    return schema;
};

Как это использовать:

// Attach it to the GraphQLSchema > https://graphql.org/graphql-js/type/
let schema = makeExecutableSchema({...});
schema = exampleTransformer(schema);
const server = new ApolloServer({schema});
server.listen(serverConfig.port);

Это решение будет работать на любом сервисе GraphQL-JS (apollo, express-graphql, graphql-tools и т. д.).

Имейте в виду, что с этим решением вы также сможете манипулировать inputData.

Решение 2. Изменить ответ

Это решение более элегантно, но реализуется после реализации директив и скалярных типов и не может манипулировать входными данными.

Особенностью выходного объекта является то, что данные являются null-prototype объектом (нет методов экземпляра, таких как .hasOwnProperty(), .toString(), ...), а ошибки являются заблокированными объектами (только для чтения). В примере я разблокирую объект ошибки... будьте осторожны с этим и не меняйте структуру объектов.

Пример трансформатора

import { Translator } from '@helpers/translations';
import type { GraphQLResponse, GraphQLRequestContext } from 'apollo-server-types';
import type { GraphQLFormattedError } from 'graphql';

export const exampleResponseFormatter = () => (response: GraphQLResponse, requestContext: GraphQLRequestContext) => {
    // Parse locked error fields
    response?.errors?.forEach(error => {
        (error['message'] as GraphQLFormattedError['message']) = exampleTransformer(error['message']);
        (error['extensions'] as GraphQLFormattedError['extensions']) = exampleTransformer(error['extensions']);
    });

    // Parse response data
    response.data = exampleTransformer(response.data);

    // Response
    return response;
};

Как это использовать:

// Provide the schema to the ApolloServer constructor
const server = new ApolloServer({
    schema,
    formatResponse: exampleResponseFormatter()
});

Заключение

Я использую оба решения в своих проектах. С первым вы можете управлять вводом и выводом на основе определенных директив доступа в коде или проверять весь поток данных (для любого типа graphql). И во-вторых, перевести все строки на основе заголовков контекста, предоставленных пользователем, не путая преобразователи и код с языковыми переменными.

Эти примеры протестированы на TS 4+ и GraphQL 15 и 16.