#28561: GraphQL added CORS headers (static test fix)

michalderlatka · michalderlatka · commit 5ba8fd7888cc · 2020-06-23T10:23:21.000+02:00
diff --git a/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowCredentialsHeaderProvider.php b/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowCredentialsHeaderProvider.php
@@ -15,6 +15,9 @@
  */
 class CorsAllowCredentialsHeaderProvider implements HeaderProviderInterface
 {
+    /**
+     * @var string
+     */
     private $headerName;
 
     /**
@@ -24,6 +27,10 @@ class CorsAllowCredentialsHeaderProvider implements HeaderProviderInterface
      */
     private $corsConfiguration;
 
+    /**
+     * @param ConfigurationInterface $corsConfiguration
+     * @param string $headerName
+     */
     public function __construct(
         ConfigurationInterface $corsConfiguration,
         string $headerName
@@ -32,16 +39,31 @@ public function __construct(
         $this->headerName = $headerName;
     }
 
+    /**
+     * Get name of header
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->headerName;
     }
 
+    /**
+     * Get value for header
+     *
+     * @return string
+     */
     public function getValue()
     {
-        return true;
+        return "1";
     }
 
+    /**
+     * Check if header can be applied
+     *
+     * @return bool
+     */
     public function canApply() : bool
     {
         return $this->corsConfiguration->isEnabled() && $this->corsConfiguration->isCredentialsAllowed();
diff --git a/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowHeadersHeaderProvider.php b/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowHeadersHeaderProvider.php
@@ -15,6 +15,9 @@
  */
 class CorsAllowHeadersHeaderProvider implements HeaderProviderInterface
 {
+    /**
+     * @var string
+     */
     private $headerName;
 
     /**
@@ -24,6 +27,10 @@ class CorsAllowHeadersHeaderProvider implements HeaderProviderInterface
      */
     private $corsConfiguration;
 
+    /**
+     * @param ConfigurationInterface $corsConfiguration
+     * @param string $headerName
+     */
     public function __construct(
         ConfigurationInterface $corsConfiguration,
         string $headerName
@@ -32,16 +39,31 @@ public function __construct(
         $this->headerName = $headerName;
     }
 
+    /**
+     * Get name of header
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->headerName;
     }
 
+    /**
+     * Check if header can be applied
+     *
+     * @return bool
+     */
     public function canApply() : bool
     {
         return $this->corsConfiguration->isEnabled() && $this->getValue();
     }
 
+    /**
+     * Get value for header
+     *
+     * @return string
+     */
     public function getValue()
     {
         return $this->corsConfiguration->getAllowedHeaders();
diff --git a/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowMethodsHeaderProvider.php b/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowMethodsHeaderProvider.php
@@ -32,16 +32,31 @@ public function __construct(
         $this->headerName = $headerName;
     }
 
+    /**
+     * Get name of header
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->headerName;
     }
 
+    /**
+     * Check if header can be applied
+     *
+     * @return bool
+     */
     public function canApply() : bool
     {
         return $this->corsConfiguration->isEnabled() && $this->getValue();
     }
 
+    /**
+     * Get value for header
+     *
+     * @return string
+     */
     public function getValue()
     {
         return $this->corsConfiguration->getAllowedMethods();
diff --git a/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowOriginHeaderProvider.php b/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsAllowOriginHeaderProvider.php
@@ -32,16 +32,31 @@ public function __construct(
         $this->headerName = $headerName;
     }
 
+    /**
+     * Get name of header
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->headerName;
     }
 
+    /**
+     * Check if header can be applied
+     *
+     * @return bool
+     */
     public function canApply() : bool
     {
         return $this->corsConfiguration->isEnabled() && $this->getValue();
     }
 
+    /**
+     * Get value for header
+     *
+     * @return string
+     */
     public function getValue()
     {
         return $this->corsConfiguration->getAllowedOrigins();
diff --git a/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsMaxAgeHeaderProvider.php b/app/code/Magento/GraphQl/Controller/HttpResponse/Cors/CorsMaxAgeHeaderProvider.php
@@ -32,16 +32,31 @@ public function __construct(
         $this->headerName = $headerName;
     }
 
+    /**
+     * Get name of header
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->headerName;
     }
 
+    /**
+     * Check if header can be applied
+     *
+     * @return bool
+     */
     public function canApply()
     {
         return $this->corsConfiguration->isEnabled() && $this->getValue();
     }
 
+    /**
+     * Get value for header
+     *
+     * @return string
+     */
     public function getValue()
     {
         return $this->corsConfiguration->getMaxAge();
diff --git a/app/code/Magento/GraphQl/Model/Cors/Configuration.php b/app/code/Magento/GraphQl/Model/Cors/Configuration.php
@@ -24,41 +24,73 @@ class Configuration implements ConfigurationInterface
     /**
      * @var ScopeConfigInterface
      */
-    protected $scopeConfig;
+    private $scopeConfig;
 
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     */
     public function __construct(ScopeConfigInterface $scopeConfig)
     {
         $this->scopeConfig = $scopeConfig;
     }
 
+    /**
+     * Are CORS headers enabled
+     *
+     * @return bool
+     */
     public function isEnabled(): bool
     {
         return $this->scopeConfig->isSetFlag(self::XML_PATH_CORS_HEADERS_ENABLED);
     }
 
+    /**
+     * Get allowed origins or null if stored configuration is empty
+     *
+     * @return string|null
+     */
     public function getAllowedOrigins(): ?string
     {
         return $this->scopeConfig->getValue(self::XML_PATH_CORS_ALLOWED_ORIGINS);
     }
 
+    /**
+     * Get allowed headers or null if stored configuration is empty
+     *
+     * @return string|null
+     */
     public function getAllowedHeaders(): ?string
     {
         return $this->scopeConfig->getValue(self::XML_PATH_CORS_ALLOWED_HEADERS);
     }
 
+    /**
+     * Get allowed methods or null if stored configuration is empty
+     *
+     * @return string|null
+     */
     public function getAllowedMethods(): ?string
     {
         return $this->scopeConfig->getValue(self::XML_PATH_CORS_ALLOWED_METHODS);
     }
 
+    /**
+     * Get max age header value
+     *
+     * @return int
+     */
     public function getMaxAge(): int
     {
         return (int) $this->scopeConfig->getValue(self::XML_PATH_CORS_MAX_AGE);
     }
 
+    /**
+     * Are credentials allowed
+     *
+     * @return bool
+     */
     public function isCredentialsAllowed(): bool
     {
         return $this->scopeConfig->isSetFlag(self::XML_PATH_CORS_ALLOW_CREDENTIALS);
     }
-
 }
diff --git a/app/code/Magento/GraphQl/Model/Cors/ConfigurationInterface.php b/app/code/Magento/GraphQl/Model/Cors/ConfigurationInterface.php
@@ -12,15 +12,45 @@
  */
 interface ConfigurationInterface
 {
+    /**
+     * Are CORS headers enabled
+     *
+     * @return bool
+     */
     public function isEnabled() : bool;
 
+    /**
+     * Get allowed origins or null if stored configuration is empty
+     *
+     * @return string|null
+     */
     public function getAllowedOrigins() : ?string;
 
+    /**
+     * Get allowed headers or null if stored configuration is empty
+     *
+     * @return string|null
+     */
     public function getAllowedHeaders() : ?string;
 
+    /**
+     * Get allowed methods or null if stored configuration is empty
+     *
+     * @return string|null
+     */
     public function getAllowedMethods() : ?string;
 
+    /**
+     * Get max age header value
+     *
+     * @return int
+     */
     public function getMaxAge() : int;
 
+    /**
+     * Are credentials allowed
+     *
+     * @return bool
+     */
     public function isCredentialsAllowed() : bool;
 }
diff --git a/app/code/Magento/GraphQl/etc/config.xml b/app/code/Magento/GraphQl/etc/config.xml
@@ -1,4 +1,10 @@
 <?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
     <default>
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/CorsHeadersTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/CorsHeadersTest.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
 namespace Magento\GraphQl;
 
@@ -15,7 +20,6 @@ class CorsHeadersTest extends GraphQlAbstract
      * @var Config $config
      */
     private $resourceConfig;
-
     /**
      * @var ReinitableConfigInterface
      */

Original file line number	Diff line number	Diff line change
`@@ -32,16 +32,31 @@ public function __construct(`
`32`	`32`	`$this->headerName = $headerName;`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ /**`
	`36`	`+ * Get name of header`
	`37`	`+ *`
	`38`	`+ * @return string`
	`39`	`+ */`
`35`	`40`	`public function getName()`
`36`	`41`	`{`
`37`	`42`	`return $this->headerName;`
`38`	`43`	`}`
`39`	`44`
	`45`	`+ /**`
	`46`	`+ * Check if header can be applied`
	`47`	`+ *`
	`48`	`+ * @return bool`
	`49`	`+ */`
`40`	`50`	`public function canApply() : bool`
`41`	`51`	`{`
`42`	`52`	`return $this->corsConfiguration->isEnabled() && $this->getValue();`
`43`	`53`	`}`
`44`	`54`
	`55`	`+ /**`
	`56`	`+ * Get value for header`
	`57`	`+ *`
	`58`	`+ * @return string`
	`59`	`+ */`
`45`	`60`	`public function getValue()`
`46`	`61`	`{`
`47`	`62`	`return $this->corsConfiguration->getAllowedMethods();`
Original file line number	Diff line number	Diff line change
`@@ -24,41 +24,73 @@ class Configuration implements ConfigurationInterface`
`24`	`24`	`/**`
`25`	`25`	`* @var ScopeConfigInterface`
`26`	`26`	`*/`
`27`		`- protected $scopeConfig;`
	`27`	`+ private $scopeConfig;`
`28`	`28`
	`29`	`+ /**`
	`30`	`+ * @param ScopeConfigInterface $scopeConfig`
	`31`	`+ */`
`29`	`32`	`public function __construct(ScopeConfigInterface $scopeConfig)`
`30`	`33`	`{`
`31`	`34`	`$this->scopeConfig = $scopeConfig;`
`32`	`35`	`}`
`33`	`36`
	`37`	`+ /**`
	`38`	`+ * Are CORS headers enabled`
	`39`	`+ *`
	`40`	`+ * @return bool`
	`41`	`+ */`
`34`	`42`	`public function isEnabled(): bool`
`35`	`43`	`{`
`36`	`44`	`return $this->scopeConfig->isSetFlag(self::XML_PATH_CORS_HEADERS_ENABLED);`
`37`	`45`	`}`
`38`	`46`
	`47`	`+ /**`
	`48`	`+ * Get allowed origins or null if stored configuration is empty`
	`49`	`+ *`
	`50`	`+ * @return string\|null`
	`51`	`+ */`
`39`	`52`	`public function getAllowedOrigins(): ?string`
`40`	`53`	`{`
`41`	`54`	`return $this->scopeConfig->getValue(self::XML_PATH_CORS_ALLOWED_ORIGINS);`
`42`	`55`	`}`
`43`	`56`
	`57`	`+ /**`
	`58`	`+ * Get allowed headers or null if stored configuration is empty`
	`59`	`+ *`
	`60`	`+ * @return string\|null`
	`61`	`+ */`
`44`	`62`	`public function getAllowedHeaders(): ?string`
`45`	`63`	`{`
`46`	`64`	`return $this->scopeConfig->getValue(self::XML_PATH_CORS_ALLOWED_HEADERS);`
`47`	`65`	`}`
`48`	`66`
	`67`	`+ /**`
	`68`	`+ * Get allowed methods or null if stored configuration is empty`
	`69`	`+ *`
	`70`	`+ * @return string\|null`
	`71`	`+ */`
`49`	`72`	`public function getAllowedMethods(): ?string`
`50`	`73`	`{`
`51`	`74`	`return $this->scopeConfig->getValue(self::XML_PATH_CORS_ALLOWED_METHODS);`
`52`	`75`	`}`
`53`	`76`
	`77`	`+ /**`
	`78`	`+ * Get max age header value`
	`79`	`+ *`
	`80`	`+ * @return int`
	`81`	`+ */`
`54`	`82`	`public function getMaxAge(): int`
`55`	`83`	`{`
`56`	`84`	`return (int) $this->scopeConfig->getValue(self::XML_PATH_CORS_MAX_AGE);`
`57`	`85`	`}`
`58`	`86`
	`87`	`+ /**`
	`88`	`+ * Are credentials allowed`
	`89`	`+ *`
	`90`	`+ * @return bool`
	`91`	`+ */`
`59`	`92`	`public function isCredentialsAllowed(): bool`
`60`	`93`	`{`
`61`	`94`	`return $this->scopeConfig->isSetFlag(self::XML_PATH_CORS_ALLOW_CREDENTIALS);`
`62`	`95`	`}`
`63`		`-`
`64`	`96`	`}`