Fix URI path generation in the Realtime Database Component

kreait · Oct 5, 2021 · 3b7f972 · 3b7f972
1 parent 417e9b3
commit 3b7f972
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@
 ### Changed
 * Bumped `kreait/firebase-tokens` to `^1.16.1` to ensure a minor security fix in `lcobucci/jwt` 
   (More info: [GHSA-7322-jrq4-x5hf](https://github.com/lcobucci/jwt/security/advisories/GHSA-7322-jrq4-x5hf))
+### Fixed
+* Fixed a bug that occurs when using Realtime Database Paths without a leading slash with newer
+  releases of `guzzle/psr7`
 
 ## [5.23.0] - 2021-08-26
 ### Added

diff --git a/src/Firebase/Database.php b/src/Firebase/Database.php
@@ -35,6 +35,8 @@ public function getReference(?string $path = null): Reference
             $path = '/';
         }
 
+        $path = '/'.\ltrim($path, '/');
+
         try {
             return new Reference($this->uri->withPath($path), $this->client);
         } catch (\InvalidArgumentException $e) {
@@ -59,14 +61,14 @@ public function getReferenceFromUrl($uri): Reference
 
     public function getRuleSet(): RuleSet
     {
-        $rules = $this->client->get($this->uri->withPath('.settings/rules'));
+        $rules = $this->client->get($this->uri->withPath('/.settings/rules'));
 
         return RuleSet::fromArray($rules);
     }
 
     public function updateRules(RuleSet $ruleSet): void
     {
-        $this->client->updateRules($this->uri->withPath('.settings/rules'), $ruleSet);
+        $this->client->updateRules($this->uri->withPath('/.settings/rules'), $ruleSet);
     }
 
     public function runTransaction(callable $callable)

diff --git a/src/Firebase/Database/Reference.php b/src/Firebase/Database/Reference.php
@@ -79,7 +79,7 @@ public function getParent(): self
             throw new OutOfRangeException('Cannot get parent of root reference');
         }
 
-        return new self($this->uri->withPath($parentPath), $this->apiClient, $this->validator);
+        return new self($this->uri->withPath('/'.\ltrim($parentPath, '/')), $this->apiClient, $this->validator);
     }
 
     /**
@@ -106,7 +106,7 @@ public function getRoot(): self
      */
     public function getChild(string $path): self
     {
-        $childPath = \sprintf('%s/%s', \trim($this->uri->getPath(), '/'), \trim($path, '/'));
+        $childPath = \sprintf('/%s/%s', \trim($this->uri->getPath(), '/'), \trim($path, '/'));
 
         try {
             return new self($this->uri->withPath($childPath), $this->apiClient, $this->validator);

diff --git a/src/Firebase/Http/Middleware.php b/src/Firebase/Http/Middleware.php
@@ -21,7 +21,7 @@ public static function ensureJsonSuffix(): callable
         return static function (callable $handler) {
             return static function (RequestInterface $request, ?array $options = null) use ($handler) {
                 $uri = $request->getUri();
-                $path = $uri->getPath();
+                $path = '/'.\ltrim($uri->getPath(), '/');
 
                 if (!\str_ends_with($path, '.json')) {
                     $uri = $uri->withPath($path.'.json');

diff --git a/tests/Unit/Database/Reference/ValidatorTest.php b/tests/Unit/Database/Reference/ValidatorTest.php
@@ -29,15 +29,15 @@ protected function setUp(): void
 
     public function testValidateDepth(): void
     {
-        $uri = $this->uri->withPath(\str_pad('', (Validator::MAX_DEPTH + 1) * 2, 'x/'));
+        $uri = $this->uri->withPath('/'.\str_pad('', (Validator::MAX_DEPTH + 1) * 2, 'x/'));
 
         $this->expectException(InvalidArgumentException::class);
         $this->validator->validateUri($uri);
     }
 
     public function testValidateKeySize(): void
     {
-        $uri = $this->uri->withPath(\str_pad('', Validator::MAX_KEY_SIZE + 1, 'x'));
+        $uri = $this->uri->withPath('/'.\str_pad('', Validator::MAX_KEY_SIZE + 1, 'x'));
 
         $this->expectException(InvalidArgumentException::class);
         $this->validator->validateUri($uri);
@@ -48,7 +48,7 @@ public function testValidateKeySize(): void
      */
     public function testValidateChars(string $value): void
     {
-        $uri = $this->uri->withPath($value);
+        $uri = $this->uri->withPath('/'.\ltrim($value, '/'));
 
         $this->expectException(InvalidArgumentException::class);
         $this->validator->validateUri($uri);

diff --git a/tests/Unit/DatabaseTest.php b/tests/Unit/DatabaseTest.php
@@ -34,7 +34,7 @@ protected function setUp(): void
 
     public function testGetReference(): void
     {
-        $this->assertSame('any', \trim($this->database->getReference('any')->getUri()->getPath(), '/'));
+        $this->assertSame('any', $this->database->getReference('any')->getPath());
     }
 
     public function testGetRootReference(): void
@@ -66,7 +66,7 @@ public function testGetRuleSet(): void
     {
         $this->apiClient
             ->method('get')
-            ->with($this->uri->withPath('.settings/rules'))
+            ->with($this->uri->withPath('/.settings/rules'))
             ->willReturn($expected = RuleSet::default()->getRules())
         ;