Deprecate the Dynamic Links component

kreait · Aug 20, 2024 · f78398b · f78398b
1 parent c5e8892
commit f78398b
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,13 @@ Please read about the future of the Firebase Admin PHP SDK on the
 
 * Added support for PHP 8.4
 
+### Deprecated
+
+* Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on 
+  August 25, 2025. The component will remain in the SDK until then, but as the Firebase service is deprecated,
+  this component is also deprecated.
+  ([Dynamic Links Deprecation FAQ](https://firebase.google.com/support/dynamic-links-faq))
+
 ## [7.13.1] - 2024-07-02
 
 ### Fixed

diff --git a/src/Firebase/Contract/DynamicLinks.php b/src/Firebase/Contract/DynamicLinks.php
@@ -15,6 +15,14 @@
 use Stringable;
 
 /**
+ * @deprecated 7.14.0 Firebase Dynamic Links is deprecated and should not be used in new projects. The service will
+ *                    shut down on August 25, 2025. The component will remain in the SDK until then, but as the
+ *                    Firebase service is deprecated, this component is also deprecated
+ *
+ * @see https://firebase.google.com/support/dynamic-links-faq Dynamic Links Deprecation FAQ
+ *
+ * @see https://firebase.google.com/docs/dynamic-links/rest Create Dynamic Links with the REST API
+ *
  * @phpstan-import-type CreateDynamicLinkShape from CreateDynamicLink
  * @phpstan-import-type ShortenLongDynamicLinkShape from ShortenLongDynamicLink
  */

diff --git a/src/Firebase/DynamicLinks.php b/src/Firebase/DynamicLinks.php
@@ -21,6 +21,12 @@
 /**
  * @internal
  *
+ * @deprecated 7.14.0 Firebase Dynamic Links is deprecated and should not be used in new projects. The service will
+ *                    shut down on August 25, 2025. The component will remain in the SDK until then, but as the
+ *                    Firebase service is deprecated, this component is also deprecated
+ *
+ * @see https://firebase.google.com/support/dynamic-links-faq Dynamic Links Deprecation FAQ
+ *
  * @phpstan-import-type CreateDynamicLinkShape from CreateDynamicLink
  * @phpstan-import-type ShortenLongDynamicLinkShape from ShortenLongDynamicLink
  */

diff --git a/src/Firebase/Factory.php b/src/Firebase/Factory.php
@@ -432,6 +432,12 @@ public function createMessaging(): Contract\Messaging
     }
 
     /**
+     * @deprecated 7.14.0 Firebase Dynamic Links is deprecated and should not be used in new projects. The service will
+     *                    shut down on August 25, 2025. The component will remain in the SDK until then, but as the
+     *                    Firebase service is deprecated, this component is also deprecated
+     *
+     * @see https://firebase.google.com/support/dynamic-links-faq Dynamic Links Deprecation FAQ
+     *
      * @param Stringable|non-empty-string|null $defaultDynamicLinksDomain
      */
     public function createDynamicLinksService($defaultDynamicLinksDomain = null): Contract\DynamicLinks

diff --git a/tests/Integration/DynamicLinksTest.php b/tests/Integration/DynamicLinksTest.php
@@ -12,6 +12,12 @@
 use function mb_strlen;
 
 /**
+ * @deprecated 7.14.0 Firebase Dynamic Links is deprecated and should not be used in new projects. The service will
+ *                    shut down on August 25, 2025. The component will remain in the SDK until then, but as the
+ *                    Firebase service is deprecated, this component is also deprecated
+ *
+ * @see https://firebase.google.com/support/dynamic-links-faq Dynamic Links Deprecation FAQ
+ *
  * @internal
  */
 final class DynamicLinksTest extends IntegrationTestCase

diff --git a/tests/Unit/DynamicLinksTest.php b/tests/Unit/DynamicLinksTest.php
@@ -32,6 +32,12 @@
 use Psr\Http\Message\RequestInterface;
 
 /**
+ * @deprecated 7.14.0 Firebase Dynamic Links is deprecated and should not be used in new projects. The service will
+ *                    shut down on August 25, 2025. The component will remain in the SDK until then, but as the
+ *                    Firebase service is deprecated, this component is also deprecated
+ *
+ * @see https://firebase.google.com/support/dynamic-links-faq Dynamic Links Deprecation FAQ
+ *
  * @internal
  */
 final class DynamicLinksTest extends TestCase

diff --git a/tests/Unit/FactoryTest.php b/tests/Unit/FactoryTest.php
@@ -68,6 +68,7 @@ private function assertServices(Factory $factory): void
         $factory->createDatabase();
         $this->addToAssertionCount(1);
 
+        // @phpstan-ignore method.deprecated
         $factory->createDynamicLinksService();
         $this->addToAssertionCount(1);