Bagaimana untuk melampirkan data tambahan pada respons GraphQL pada Pelayan Apollo

Katakanlah kami ingin memasukkan pengecam permintaan unik pada setiap respons GraphQL.

Kami boleh melakukannya dengan menambahkan medan requestId pada jenis Pertanyaan, kemudian menyelesaikan medan itu kepada beberapa pengecam unik yang kami tetapkan dalam konteks untuk setiap permintaan. Ini bukanlah penyelesaian yang sempurna, kerana kami perlu memasukkan medan itu pada setiap permintaan pada pelanggan kami dan ia meningkatkan sedikit saiz permintaan yang dihantar ke pelayan.

Ada cara yang lebih baik!

Kami boleh mencipta pemalam kecil (perisian tengah) yang melampirkan data tersuai kami pada medan sambungan badan respons.

Berdasarkan perkara yang diberitahu oleh halaman dokumentasi "Mencipta Pemalam Pelayan Apollo", pemalam kami sepatutnya kelihatan seperti ini:

// extensionsPlugin.js

export const extensionsPlugin = () => {
    return {
        requestDidStart: () => {
            return {
                willSendResponse(requestContext) {
                    requestContext.response.body.singleResult = {
                        ...requestContext.response.body.singleResult,
                        extensions: {
                            ...requestContext.response.body?.extensions,
                            requestId: requestContext.contextValue.requestId
                        },
                    };
                },
            }
        }
    }
};

Jangan ragu untuk menggunakan console.log(requestContent.response) untuk mengetahui cara data distrukturkan.

Perlu diingat bahawa hanya kunci sambungan body.singleResult akan berfungsi di luar kotak, kerana ia adalah sebahagian daripada piawaian GraphQL. Kami tidak boleh menambah requestId terus pada body.singleResult.

Dan kini kita hanya perlu melaksanakannya!

Contoh ini menggunakan pakej ulid untuk menjana ID yang padat dan boleh diisih masa.

// main.js

import { ulid } from 'ulid';
import { extensionsPlugin } from "./extensionsPlugin.js";

// ...

const server = new ApolloServer({
    // ...
    plugins: [extensionsPlugin()],
    // ...
})

const { url } = await startStandaloneServer(server, {
    // ...
    context: async () => {
        // ...
        const requestId = ulid();

        return {
            requestId,
        }
    },
    // ...
})

dan itu sahaja!

Mengapa ia berfungsi? Konteks dibina untuk setiap permintaan secara berasingan (kontekstual) dan sentiasa tersedia untuk semua penyelesai yang mengendalikan permintaan. Adalah lebih baik untuk menetapkan semua pembolehubah yang diperlukan dalam konteks, kerana ia dibuat sebelum sebarang cangkuk pemalam dicetuskan (cth.: requestDidStart). Kami menambahkan requestId pada konteks kami dan menyediakannya di mana-mana sahaja, kemudian pemalam kami menariknya daripada konteks dan melampirkannya pada badan respons sejurus sebelum dihantar semula.

Mendapat idea tentang apa lagi yang boleh kami lampirkan pada respons kami? Sila kongsi dalam komen :)

Atas ialah kandungan terperinci Bagaimana untuk melampirkan data tambahan pada respons GraphQL pada Pelayan Apollo. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!