GraphQL Application Server

Med Commerce GraphQL Application Server kan Adobe Commerce upprätthålla status bland Commerce GraphQL API-begäranden. GraphQL Application Server, som bygger på svullningstillägget, fungerar som en process med arbetstrådar som hanterar bearbetningen av begäranden. Genom att bevara ett startläge för ett program bland GraphQL API-begäranden förbättrar GraphQL Application Server hanteringen av begäranden och produktens övergripande prestanda. API-förfrågningar blir betydligt effektivare.

GraphQL Application Server finns endast för Adobe Commerce. Det finns inte för Magento Open Source. För Cloud Pro-projekt måste du skicka in en Adobe Commerce Support-biljett för att aktivera GraphQL Application Server.

Arkitektur

GraphQL Application Server upprätthåller status mellan Commerce GraphQL API-begäranden och eliminerar behovet av att starta. Genom att dela applikationsstatus mellan processer blir GraphQL-förfrågningar betydligt effektivare, vilket minskar svarstiderna med upp till 30 %.

PHP-exekveringsmodellen"share-no" utgör en utmaning när det gäller latenstid eftersom varje begäran kräver att ramverket startas. Denna startprocess innehåller tidskrävande uppgifter som att läsa konfigurationen, konfigurera startprocessen och skapa tjänstklassobjekt.

Det verkar som om logiken för hantering av förfrågningar övergår till en händelselösning på programnivå som åtgärdar utmaningen att effektivisera behandlingen av förfrågningar på företagsnivå. På så sätt elimineras behovet av att starta vid körningen av begäran.

Fördelar

Med GraphQL Application Server kan Adobe Commerce hantera tillstånd mellan efterföljande Commerce GraphQL API-begäranden. Genom att dela programtillstånd mellan begäranden blir API-förfrågningens effektivitet effektivare genom att minimera belastningen på processerna och optimera hanteringen av förfrågningar. Därför kan svarstiden för GraphQL-begäranden minskas med upp till 30 %.

Systemkrav

För att köra GraphQL Application Server krävs följande:

Aktivera och distribuera i molninfrastruktur

Modulen ApplicationServer (Magento/ApplicationServer/) aktiverar GraphQL Application Server.

Aktivera Pro-projekt

När Application Server-funktionen har aktiverats i ditt Pro-projekt utför du följande steg innan du distribuerar GraphQL Application Server:

Distribuera Pro-projekt

När du är klar med aktiveringsstegen skickar du ändringarna till Git-databasen för att distribuera GraphQL Application Server:

git push

Aktivera startprojekt

Utför följande steg innan du distribuerar GraphQL Application Server i Starter-projekt:

Distribuera startprojekt

När du har slutfört aktiveringen steps skickar du ändringar till Git-databasen för att distribuera GraphQL Application Server:

git push

Verifiera aktivering i molnprojekt

Om dessa verifieringssteg lyckas körs GraphQL Application Server och hanterar /graphql begäranden.

Aktivera lokala projekt

Modulen ApplicationServer (Magento/ApplicationServer/) aktiverar API:er för GraphQL Application Server för GraphQL.

Om du kör GraphQL Application Server lokalt måste du installera SVULLE-tillägget och göra en mindre ändring i Nginx-konfigurationsfilen för distributionen.

Förutsättningar

Utför följande steg innan du aktiverar modulen ApplicationServer:

Konfigurera Nginx

Din specifika Commerce-distribution avgör hur du konfigurerar Nginx. I allmänhet är Nginx-konfigurationsfilen som standard nginx.conf och placeras i någon av följande kataloger: /usr/local/nginx/conf, /etc/nginx eller /usr/local/etc/nginx. Mer information om hur du konfigurerar Nginx finns i nybörjarhandboken.

Exempel på 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;
}

Installera och konfigurera SVG

Om du vill köra GraphQL Application Server lokalt installerar du svullningstillägget (v5.0 eller senare). Det finns flera sätt att installera det här tillägget.

I proceduren nedan beskrivs hur du installerar svullningstillägget för PHP 8.2 på OSX-baserade system. Det är ett av flera sätt att installera tillägget för svullnad.

pecl install swoole

Under installationen visas ett meddelande i Adobe Commerce om att aktivera stöd för openssl, mysqlnd, sockets, http2 och postgres. Ange yes för alla alternativ utom postgres.

Verifiera installation med svullnad

Bekräfta att tillägget har aktiverats:

php -m | grep swoole

Vanliga fel vid installation med svepfunktion

Alla fel som inträffar under svullnad inträffar vanligtvis under installationsfasen för pecl. Typiska fel är bland annat att openssl.h- och pcre2.h-filer saknas. Kontrollera att de här två paketen är installerade på din lokala dator för att åtgärda felen.

openssl version -d

Det här kommandot visar sökvägen där openssl är installerad.

pcre2-config --prefix

Använd Homebrew för att installera de saknade paketen om kommandoutdata indikerar att filer saknas:

brew install openssl

brew install pcre2

Lös problem med openssl

Om du vill lösa problem relaterade till openssl kör du:

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

Bekräfta att du använder sökvägen från din lokala dev-miljö.

Bekräfta lösning av problem relaterade till openssl

Du kan köra följande kommando igen för att kontrollera om problem som är relaterade till öppning har åtgärdats:

pecl install swoole

Lös problem med pcre2.h

Om du vill lösa problem som rör pcre2.h länkar du sökvägen pcre2.h till den installerade PHP-tilläggskatalogen. Din specifika installerade version av PHP och pcr2.h avgör vilken version av kommandot som du bör använda.

Kör GraphQL Application Server

Starta GraphQL Application Server:

bin/magento server:run

Det här kommandot startar en HTTP-port på 9501. När GraphQL Application Server startas blir port 9501 en HTTP-proxyserver för alla GraphQL-frågor.

Så här bekräftar du att GraphQL Application Server körs i din distribution:

ps aux | grep php

Ytterligare sätt att bekräfta att GraphQL Application Server körs är:

Bekräfta att GraphQL-begäranden behandlas

GraphQL Application Server lägger till svarshuvudet X-Backend med värdet graphql_server i varje begäran som bearbetas. Om du vill kontrollera om en begäran har hanterats av GraphQL Application Server ska du kontrollera den här svarshuvudet.

Bekräfta kompatibilitet för tillägg och anpassning

Tilläggsutvecklare och handlare bör först kontrollera att deras kod för tillägg och anpassning följer riktlinjerna som beskrivs i Tekniska riktlinjer.

Tänk på följande när du utvärderar koden:

Inaktivera GraphQL Application Server

Hur du inaktiverar GraphQL Application Server varierar beroende på om servern körs lokalt eller i molnet.

Inaktivera GraphQL Application Server (molnet)

Inaktivera GraphQL Application Server (lokalt)

Den här metoden för att inaktivera GraphQL Application Server kan vara användbar för att testa eller jämföra prestanda snabbt.

Bekräfta att GraphQL Application Server är inaktiverad

Bekräfta att php-fpm bearbetar GraphQL-begäranden i stället för GraphQL Application Server genom att ange följande kommando: ps aux | grep php.

När GraphQL Application Server har inaktiverats:

Integrerings- och funktionstester för GraphQL Application Server

Tilläggsutvecklare kan köra två integrationstester för att verifiera tilläggskompatibiliteten med GraphQL Application Server: GraphQlStateTest och ResetAfterRequestTest.

GraphQlStateTest

GraphQlStateTest identifierar tillstånd i delade objekt som inte ska återanvändas för flera begäranden.

Det här testet är utformat för att identifiera lägesändringar i tjänstobjekt som skapas av ObjectManager. Testet kör identiska GraphQL-frågor två gånger och jämför tjänstobjektets tillstånd före och efter den andra frågan.

GraphQlStateTest-fel och möjlig reparation

Kör GraphQlStateTest genom att köra vendor/bin/phpunit -c $(pwd)/dev/tests/integration/phpunit.xml dev/tests/integration/testsuite/Magento/GraphQl/App/GraphQlStateTest.php.

ÅterställEfterBegäranTesta

ResetAfterRequestTest söker efter alla klasser som implementerar ResetAfterRequestInterface och verifierar att metoden _resetState() returnerar ett objekts tillstånd till samma läge som det hade efter att ha konstruerats av ObjectManager.  Det här testet skapar ett tjänstobjekt med ObjectManager, klonar sedan objektet, anropar _resetState() och jämför sedan båda objekten. Testet anropar inga metoder mellan objektinstansiering och _resetState(), så det bekräftar inte att något muterbart tillstånd återställs. Det finns problem där ett fel eller ett stavfel i _resetState() kan ställa in läget på något annat än det var från början.

ResetAfterRequestTest-fel och potentiella reparationer

Funktionstestning

när du distribuerar GraphQL Application Server bör tilläggsutvecklare köra WebAPI-funktionstester och anpassade automatiska eller manuella funktionstester för GraphQL. Dessa funktionstester hjälper utvecklare att identifiera potentiella fel eller kompatibilitetsproblem.

Läge för tillståndsövervakare

När funktionstester körs (eller manuell testning) kan GraphQL Application Server köras med --state-monitor mode aktiverat för att hjälpa till att hitta klasser där tillståndet oavsiktligt återanvänds. Starta programservern normalt, förutom att lägga till parametern --state-monitor.

bin/magento server:run --state-monitor

När varje begäran har bearbetats läggs en ny fil till i katalogen tmp, till exempel: var/tmp/StateMonitor-thread-output-50-6nmxiK. När du har testat klart kan dessa filer sammanfogas med kommandot bin/magento server:state-monitor:aggregate-output, vilket skapar två sammanfogade filer, en i XML och en i JSON.

Exempel:

/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

De här filerna kan inspekteras med alla verktyg som du använder för att visa XML eller JSON som visar de ändrade egenskaperna för serviceobjekt som GraphQlStateTest gör. Läget --state-monitor använder samma hopplista och filterlista som GraphQlStateTest.