objectManager = Bootstrap::getObjectManager(); $this->logData = $this->objectManager->get(LogData::class); $this->schemaGenerator = $this->objectManager->get(SchemaGenerator::class); $this->request = $this->objectManager->get(HttpRequest::class); $this->response = $this->objectManager->get(HttpResponse::class); } /** * Test a graphql query is parsed correctly for logging * * @param string $query * @param array $headers * @param array $expectedResult * @dataProvider getQueryInformationDataProvider * @return void * * @magentoAppIsolation enabled */ public function testGetQueryInformation(string $query, array $headers, array $expectedResult): void { $this->request->setPathInfo('/graphql'); $this->request->setMethod('POST'); $postData = [ 'query' => $query, 'variables' => null, 'operationName' => null ]; $this->request->setContent(json_encode($postData)); $requestHeaders = $this->objectManager->create(Headers::class)->addHeaders($headers['request'] ?? []); $this->request->setHeaders($requestHeaders); $responseHeaders = $this->objectManager->create(Headers::class)->addHeaders($headers['response'] ?? []); $this->response->setHeaders($responseHeaders); $queryFields = $this->objectManager->get(Fields::class); $queryFields->setQuery($query); $queryInformation = $this->logData->getLogData( $this->request, $postData, $this->schemaGenerator->generate(), $this->response ); $this->assertEquals($expectedResult, $queryInformation); } /** * Data provider for testGetQueryInformation * * @SuppressWarnings(PHPMD.ExcessiveMethodLength) * * @return array[] */ public static function getQueryInformationDataProvider() { return [ [ // query with all headers 'query' => << [ 'request' => [ 'Store' => 1, 'Currency' => 'USD', 'Authorization' => '1234', 'Content-length' => 123 ], 'response' => [ 'X-Magento-Tags' => 'FPC', 'X-Magento-Cache-Id' => '1234' ] ], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => 1, LoggerInterface::CURRENCY_HEADER => 'USD', LoggerInterface::HAS_AUTH_HEADER => 'true', LoggerInterface::REQUEST_LENGTH => 123, LoggerInterface::HAS_MUTATION => 'false', LoggerInterface::NUMBER_OF_OPERATIONS => 1, LoggerInterface::OPERATION_NAMES => 'products', LoggerInterface::TOP_LEVEL_OPERATION_NAME => 'products', LoggerInterface::COMPLEXITY => 5, LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '1234' ] ], [ // query with no headers 'query' => << [], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => '', LoggerInterface::CURRENCY_HEADER => '', LoggerInterface::HAS_AUTH_HEADER => 'false', LoggerInterface::REQUEST_LENGTH => '', LoggerInterface::HAS_MUTATION => 'false', LoggerInterface::NUMBER_OF_OPERATIONS => 1, LoggerInterface::OPERATION_NAMES => 'products', LoggerInterface::TOP_LEVEL_OPERATION_NAME => 'products', LoggerInterface::COMPLEXITY => 5, LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '' ] ], [ // query with bad operation name 'query' => << [ 'response' => [ 'X-Magento-Tags' => 'FPC', 'X-Magento-Cache-Id' => '1234' ] ], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => '', LoggerInterface::CURRENCY_HEADER => '', LoggerInterface::HAS_AUTH_HEADER => 'false', LoggerInterface::REQUEST_LENGTH => '', LoggerInterface::HAS_MUTATION => 'false', LoggerInterface::NUMBER_OF_OPERATIONS => 0, LoggerInterface::OPERATION_NAMES => 'operationNameNotFound', LoggerInterface::TOP_LEVEL_OPERATION_NAME => 'xyz', LoggerInterface::COMPLEXITY => 5, LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '1234' ] ], [ // bad query 'query' => << [ 'response' => [ 'X-Magento-Tags' => 'FPC', 'X-Magento-Cache-Id' => '1234' ] ], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => '', LoggerInterface::CURRENCY_HEADER => '', LoggerInterface::HAS_AUTH_HEADER => 'false', LoggerInterface::REQUEST_LENGTH => '', LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '1234' ] ], [ // mutation with all headers 'query' => << [ 'request' => [ 'Store' => 1, 'Currency' => 'USD', 'Authorization' => '1234', 'Content-length' => 123 ], 'response' => [ 'X-Magento-Cache-Id' => '1234' ] ], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => '1', LoggerInterface::CURRENCY_HEADER => 'USD', LoggerInterface::HAS_AUTH_HEADER => 'true', LoggerInterface::REQUEST_LENGTH => '123', LoggerInterface::HAS_MUTATION => 'true', LoggerInterface::NUMBER_OF_OPERATIONS => 1, LoggerInterface::OPERATION_NAMES => 'placeOrder', LoggerInterface::TOP_LEVEL_OPERATION_NAME => 'placeOrder', LoggerInterface::COMPLEXITY => 3, LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '1234' ] ], [ // mutation with no headers 'query' => << [], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => '', LoggerInterface::CURRENCY_HEADER => '', LoggerInterface::HAS_AUTH_HEADER => 'false', LoggerInterface::REQUEST_LENGTH => '', LoggerInterface::HAS_MUTATION => 'true', LoggerInterface::NUMBER_OF_OPERATIONS => 1, LoggerInterface::OPERATION_NAMES => 'placeOrder', LoggerInterface::TOP_LEVEL_OPERATION_NAME => 'placeOrder', LoggerInterface::COMPLEXITY => 3, LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '' ] ], [ // multiple queries 'query' => << [ 'request' => [ 'Store' => 1, 'Currency' => 'USD', 'Authorization' => '1234', 'Content-length' => 123 ], 'response' => [ 'X-Magento-Tags' => 'FPC', 'X-Magento-Cache-Id' => '1234' ] ], 'expectedResult' => [ LoggerInterface::HTTP_METHOD => 'POST', LoggerInterface::STORE_HEADER => '1', LoggerInterface::CURRENCY_HEADER => 'USD', LoggerInterface::HAS_AUTH_HEADER => 'true', LoggerInterface::REQUEST_LENGTH => '123', LoggerInterface::HAS_MUTATION => 'false', LoggerInterface::NUMBER_OF_OPERATIONS => 2, LoggerInterface::OPERATION_NAMES => 'cart,products', LoggerInterface::TOP_LEVEL_OPERATION_NAME => 'products', LoggerInterface::COMPLEXITY => 8, LoggerInterface::HTTP_RESPONSE_CODE => 200, LoggerInterface::X_MAGENTO_CACHE_ID => '1234' ] ], ]; } }