GraphQL Application Server

Der Commerce GraphQL-Anwendungsserver ermöglicht Adobe Commerce, den Status unter den Commerce GraphQL-API-Anfragen zu verwalten. GraphQL Application Server, der auf der Swoole-Erweiterung basiert, fungiert als Prozess mit Worker-Threads, die die Anforderungsverarbeitung handhaben. Durch Beibehaltung eines Bootstrapping-Anwendungszustands zwischen GraphQL-API-Anforderungen verbessert GraphQL Application Server die Anforderungsverarbeitung und die Gesamtproduktleistung. API-Anfragen werden deutlich effizienter.

GraphQL Application Server ist nur für Adobe Commerce verfügbar. Es steht nicht zur Magento Open Source zur Verfügung. Bei Cloud Pro-Projekten müssen Sie ein Ticket für den Adobe Commerce-Support senden, um den GraphQL-Anwendungsserver zu aktivieren.🔗

Architektur

Der GraphQL-Anwendungsserver behält den Status zwischen Commerce GraphQL-API-Anfragen bei und macht Bootstrapping nicht mehr erforderlich. Durch die prozessübergreifende Freigabe des Anwendungszustands werden GraphQL-Anforderungen deutlich effizienter, wodurch die Reaktionszeiten um bis zu 30 % verkürzt werden.

Das Share-Nichts PHP Ausführungsmodell stellt aus der Sicht der Latenz eine Herausforderung dar, da jede Anfrage das Bootstrapping des Frameworks erfordert. Dieser Bootstrapping-Prozess umfasst zeitaufwendige Aufgaben wie die Lesekonfiguration, das Einrichten des Bootstrap-Prozesses und das Erstellen von Dienstklassenobjekten.

Die Umstellung der Anforderungsverarbeitungslogik auf eine Ereignisschleife auf Anwendungsebene scheint die Herausforderung zu bewältigen, die Anforderungsverarbeitung auf Unternehmensebene zu optimieren. Dadurch entfällt die Notwendigkeit, das Bootstrapping während des Lebenszyklus der Anforderungsausführung durchzuführen.

Vorteile

Mit GraphQL Application Server kann Adobe Commerce den Status zwischen aufeinander folgenden Commerce GraphQL-API-Anfragen aufrechterhalten. Die Freigabe des Anwendungsstatus über Anforderungen hinweg verbessert die Effizienz von API-Anfragen, indem der Verarbeitungsaufwand minimiert und die Anforderungsverarbeitung optimiert wird. Daher kann die Reaktionszeit von GraphQL-Anfragen um bis zu 30 % reduziert werden.

Systemanforderungen

Für das Ausführen von GraphQL Application Server ist Folgendes erforderlich:

Aktivieren und Bereitstellen in der Cloud-Infrastruktur

Das Modul ApplicationServer (Magento/ApplicationServer/) aktiviert den GraphQL-Anwendungsserver.

Pro-Projekte aktivieren

Nachdem die Funktion "Anwendungsserver"für Ihr Pro-Projekt aktiviert wurde, führen Sie die folgenden Schritte aus, bevor Sie GraphQL Application Server bereitstellen:

Bereitstellen von Pro-Projekten

Nach Abschluss der Aktivierungsschritte müssen Sie Änderungen an Ihr Git-Repository senden, um GraphQL Application Server bereitzustellen:

git push

Aktivieren von Starterprojekten

Führen Sie die folgenden Schritte aus, bevor Sie GraphQL Application Server in Starterprojekten bereitstellen:

Bereitstellen von Starter-Projekten

Nachdem Sie die Aktivierung Schritte abgeschlossen haben, pushen Sie Änderungen an Ihr Git-Repository, um GraphQL Application Server bereitzustellen:

git push

Überprüfung der Aktivierung für Cloud-Projekte

Wenn diese Überprüfungsschritte erfolgreich sind, wird GraphQL Application Server ausgeführt und /graphql -Anforderungen bereitgestellt.

Aktivieren von lokalen Projekten

Das Modul ApplicationServer (Magento/ApplicationServer/) aktiviert den GraphQL-Anwendungsserver für GraphQL-APIs.

Das lokale Ausführen des GraphQL-Anwendungsservers erfordert die Installation der Swoole-Erweiterung und eine geringfügige Änderung der Nginx-Konfigurationsdatei Ihrer Bereitstellung.

Voraussetzungen

Führen Sie die folgenden Schritte aus, bevor Sie das Modul ApplicationServer aktivieren:

Nginx konfigurieren

Ihre spezifische Commerce-Bereitstellung bestimmt, wie Nginx konfiguriert wird. Im Allgemeinen trägt die Nginx-Konfigurationsdatei standardmäßig den Namen nginx.conf und befindet sich in einem dieser Verzeichnisse: /usr/local/nginx/conf, /etc/nginx oder /usr/local/etc/nginx. Weitere Informationen zur Konfiguration von Nginx finden Sie im Anfängerhandbuch .

Beispiel-Nginx-Konfiguration:

location /graphql {
    proxy_set_header Host $http_host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_pass http://127.0.0.1:9501/graphql;
}

Installieren und Konfigurieren von Swoole

Um den GraphQL-Anwendungsserver lokal auszuführen, installieren Sie die Swoole-Erweiterung (v5.0 oder höher). Es gibt mehrere Möglichkeiten, diese Erweiterung zu installieren.

Im folgenden Verfahren wird beschrieben, wie Sie die Swoole-Erweiterung für PHP 8.2 auf OSX-basierten Systemen installieren. Es ist eine von mehreren Möglichkeiten, die Swoole-Erweiterung zu installieren.

pecl install swoole

Während der Installation zeigt Adobe Commerce die Aufforderung an, die Unterstützung für openssl, mysqlnd, sockets, http2 und postgres zu aktivieren. Geben Sie yes für alle Optionen außer postgres ein.

Swoolinstallation überprüfen

Vergewissern Sie sich, dass die Erweiterung erfolgreich aktiviert wurde:

php -m | grep swoole

Häufige Fehler bei der Installation von Swoole

Fehler, die während der Installation auftreten, treten normalerweise während der pecl -Installationsphase auf. Zu den typischen Fehlern zählen fehlende openssl.h - und pcre2.h -Dateien. Um diese Fehler zu beheben, stellen Sie sicher, dass diese beiden Pakete in Ihrem lokalen System installiert sind.

openssl version -d

Dieser Befehl zeigt den Pfad, in dem openssl installiert ist.

pcre2-config --prefix

Verwenden Sie Homebrew, um die fehlenden Pakete zu installieren, wenn die Befehlsausgabe anzeigt, dass Dateien fehlen:

brew install openssl

brew install pcre2

Beheben von Problemen mit openssl

Um Probleme im Zusammenhang mit openssl zu beheben, führen Sie Folgendes aus:

export LDFLAGS="-L/opt/homebrew/etc/openssl@3/lib" export CPPFLAGS="-I/opt/homebrew/etc/openssl@3/include"

Vergewissern Sie sich, dass Sie den Pfad aus Ihrer lokalen dev-Umgebung verwenden.

Validierung der Lösung von Problemen im Zusammenhang mit Öffnungen

Sie können den folgenden Befehl erneut ausführen, um zu überprüfen, ob Probleme im Zusammenhang mit "openssl"behoben wurden:

pecl install swoole

Beheben von Problemen mit pcre2.h

Um Probleme im Zusammenhang mit pcre2.h zu beheben, verknüpfen Sie den Pfad pcre2.h mit Ihrem installierten PHP-Erweiterungsverzeichnis. Ihre spezifische installierte Version von PHP und pcr2.h bestimmt die jeweilige Version des Befehls, die Sie verwenden sollten.

GraphQL Application Server ausführen

Starten Sie GraphQL Application Server:

bin/magento server:run

Dieser Befehl startet einen HTTP-Anschluss auf 9501. Sobald der GraphQL-Anwendungsserver gestartet wird, wird Port 9501 zu einem HTTP-Proxyserver für alle GraphQL-Abfragen.

So überprüfen Sie, ob GraphQL Application Server in Ihrer Bereitstellung ausgeführt wird:

ps aux | grep php

Weitere Möglichkeiten zur Überprüfung der Ausführung von GraphQL Application Server sind:

Vergewissern Sie sich, dass GraphQL-Anforderungen verarbeitet werden

GraphQL Application Server fügt den Antwortheader X-Backend mit dem Wert graphql_server zu jeder von ihm verarbeiteten Anforderung hinzu. Um zu überprüfen, ob der GraphQL-Anwendungsserver eine Anforderung verarbeitet hat, suchen Sie nach diesem Antwortheader.

Kompatibilität von Erweiterung und Anpassung bestätigen

Entwickler und Händler von Erweiterungen sollten zunächst überprüfen, ob ihr Erweiterungs- und Anpassungscode den Richtlinien entspricht, die in Technische Richtlinien beschrieben sind.

Beachten Sie diese Richtlinien bei der Code-Bewertung:

GraphQL Application Server deaktivieren

Die Verfahren zum Deaktivieren des GraphQL-Anwendungsservers variieren je nachdem, ob der Server in einer lokalen oder Cloud-Bereitstellung ausgeführt wird.

GraphQL Application Server deaktivieren (Cloud)

GraphQL Application Server deaktivieren (vor Ort)

Diese Methode zum Deaktivieren des GraphQL-Anwendungsservers kann nützlich sein, um die Leistung schnell zu testen oder zu vergleichen.

Vergewissern Sie sich, dass GraphQL Application Server deaktiviert ist.

Geben Sie folgenden Befehl ein, um zu bestätigen, dass php-fpm GraphQL-Anforderungen anstelle des GraphQL-Anwendungsservers verarbeitet: ps aux | grep php.

Nachdem der GraphQL-Anwendungsserver deaktiviert wurde:

Integrations- und Funktionstests für GraphQL Application Server

Erweiterungsentwickler können zwei Integrationstests ausführen, um die Kompatibilität der Erweiterung mit dem GraphQL-Anwendungsserver zu überprüfen: GraphQlStateTest und ResetAfterRequestTest.

GraphQlStateTest

Der GraphQlStateTest erkennt den Status in freigegebenen Objekten, die nicht für mehrere Anforderungen wiederverwendet werden sollen.

Dieser Test dient dazu, Statusänderungen in Dienstobjekten zu erkennen, die von ObjectManager erzeugt werden. Der Test führt identische GraphQL-Abfragen zweimal aus und vergleicht den Dienstobjektstatus vor und nach der zweiten Abfrage.

GraphQlStateTest-Fehler und potenzielle Behebung

Führen Sie GraphQlStateTest aus, indem Sie vendor/bin/phpunit -c $(pwd)/dev/tests/integration/phpunit.xml dev/tests/integration/testsuite/Magento/GraphQl/App/GraphQlStateTest.php ausführen.

ResetAfterRequestTest

Der ResetAfterRequestTest sucht nach allen Klassen, die ResetAfterRequestInterface implementieren, und stellt sicher, dass die _resetState() -Methode den Status eines Objekts in dem Zustand zurückgibt, in dem es sich nach der Erstellung durch ObjectManager befindet.  Dieser Test erstellt ein Dienstobjekt mit ObjectManager, klont dieses Objekt dann, ruft _resetState() auf und vergleicht dann beide Objekte. Der Test ruft zwischen der Objektinstanziierung und _resetState() keine Methoden auf, daher wird nicht bestätigt, dass ein veränderlicher Status zurückgesetzt wird. Es gibt jedoch Probleme, bei denen ein Fehler oder Typo in _resetState() den Status auf etwas Anderes als ursprünglich festlegen kann.

ResetAfterRequestTest-Fehler und potenzielle Behebung

Funktionstests

Bei der Bereitstellung des GraphQL-Anwendungsservers sollten Erweiterungsentwickler WebAPI-Funktionstests und alle benutzerdefinierten automatisierten oder manuellen Funktionstests für GraphQL durchführen. Mithilfe dieser Funktionstests können Entwickler potenzielle Fehler oder Kompatibilitätsprobleme erkennen.

Statusanzeigemodus

Beim Ausführen von Funktionstests (oder manuellen Tests) kann der GraphQL-Anwendungsserver mit aktiviertem --state-monitor mode ausgeführt werden, um Klassen zu finden, in denen der Status unbeabsichtigt wiederverwendet wird. Starten Sie den Anwendungsserver normal, mit Ausnahme des Parameters --state-monitor .

bin/magento server:run --state-monitor

Nachdem jede Anfrage verarbeitet wurde, wird eine neue Datei zum Verzeichnis tmp hinzugefügt, z. B.: var/tmp/StateMonitor-thread-output-50-6nmxiK. Nachdem Sie die Tests abgeschlossen haben, können diese Dateien mit dem Befehl bin/magento server:state-monitor:aggregate-output zusammengeführt werden, mit dem zwei zusammengeführte Dateien erstellt werden, eine in XML und eine in JSON.

Beispiele:

/var/workspace/var/tmp/StateMonitor-json-2024-04-10T18:50:39Z-hW0ucN.json
/var/workspace/var/tmp/StateMonitor-junit-2024-04-10T18:50:39Z-oreUco.xml

Diese Dateien können mit jedem Tool überprüft werden, das Sie zum Anzeigen von XML oder JSON verwenden, das die geänderten Eigenschaften von Dienstobjekten wie GraphQlStateTest anzeigt. Der Modus --state-monitor verwendet dieselbe Liste und Filterliste wie GraphQlStateTest.