So hängen Sie zusätzliche Daten an eine GraphQL-Antwort auf Apollo Server an

Angenommen, wir möchten jeder GraphQL-Antwort eine eindeutige Anforderungskennung hinzufügen.

Das können wir erreichen, indem wir dem Abfragetyp ein requestId-Feld hinzufügen und dieses Feld dann in eine eindeutige Kennung auflösen, die wir im Kontext für jede Anfrage festlegen. Dies ist jedoch keine perfekte Lösung, da wir dieses Feld bei jeder einzelnen Anfrage auf unserem Client einschließen müssen und es die Größe der an den Server gesendeten Anfrage leicht erhöht.

Es gibt einen besseren Weg!

Wir können ein kleines Plugin (Middleware) erstellen, das unsere benutzerdefinierten Daten an das Erweiterungsfeld des Antworttexts anhängt.

Basierend auf den Angaben auf der Dokumentationsseite „Creating Apollo Server Plugins“ sollte unser Plugin so aussehen:

// 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
                        },
                    };
                },
            }
        }
    }
};

Fühlen Sie sich frei, console.log(requestContent.response) zu verwenden, um zu erfahren, wie die Daten strukturiert sind.

Beachten Sie, dass nur der Erweiterungsschlüssel von body.singleResult sofort funktioniert, da er Teil des GraphQL-Standards ist. Wir können requestId nicht direkt zu body.singleResult hinzufügen.

Und jetzt müssen wir es nur noch umsetzen!

In diesem Beispiel wird das ulid-Paket verwendet, um IDs zu generieren, die kompakt und zeitlich sortierbar sind.

// 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,
        }
    },
    // ...
})

und das ist es!

Warum funktioniert es? Der Kontext wird für jede Anfrage separat erstellt (kontextbezogen) und steht allen Resolvern, die die Anfrage bearbeiten, immer zur Verfügung. Es ist am besten, alle benötigten Variablen im Kontext festzulegen, da dieser erstellt wird, bevor Plugin-Hooks ausgelöst werden (z. B.: requestDidStart). Wir fügen die requestId zu unserem Kontext hinzu und machen sie überall verfügbar, dann ruft unser Plugin sie aus dem Kontext ab und hängt sie an den Antworttext an, kurz bevor sie zurückgesendet wird.

Haben Sie eine Idee, was wir unserer Antwort noch hinzufügen könnten? Teilen Sie es gerne in den Kommentaren :)

Das obige ist der detaillierte Inhalt vonSo hängen Sie zusätzliche Daten an eine GraphQL-Antwort auf Apollo Server an. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!