[labs/observers] Prevent failing in SSR (#4591)

lit · Jul 3, 2024 · 045b6f1 · 045b6f1
1 parent feccc1b
commit 045b6f1
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 1 deletion.
diff --git a/.changeset/bright-yaks-wink.md b/.changeset/bright-yaks-wink.md
@@ -0,0 +1,5 @@
+---
+'@lit-labs/observers': patch
+---
+
+Do not initialize observers to prevent failing in SSR environment.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/labs/observers/package.json b/packages/labs/observers/package.json
@@ -168,6 +168,7 @@
     "@types/trusted-types": "^2.0.2"
   },
   "dependencies": {
+    "lit-html": "^2.4.0 || ^3.0.0",
     "@lit/reactive-element": "^1.0.0 || ^2.0.0"
   },
   "publishConfig": {

diff --git a/packages/labs/observers/src/intersection-controller.ts b/packages/labs/observers/src/intersection-controller.ts
@@ -3,6 +3,7 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: BSD-3-Clause
  */
+import {isServer} from 'lit-html/is-server.js';
 import {
   ReactiveController,
   ReactiveControllerHost,
@@ -94,6 +95,9 @@ export class IntersectionController<T = unknown> implements ReactiveController {
     }
     this._skipInitial = skipInitial ?? this._skipInitial;
     this.callback = callback;
+    if (isServer) {
+      return;
+    }
     // Check browser support.
     if (!window.IntersectionObserver) {
       console.warn(

diff --git a/packages/labs/observers/src/mutation-controller.ts b/packages/labs/observers/src/mutation-controller.ts
@@ -3,6 +3,7 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: BSD-3-Clause
  */
+import {isServer} from 'lit-html/is-server.js';
 import {
   ReactiveController,
   ReactiveControllerHost,
@@ -94,6 +95,9 @@ export class MutationController<T = unknown> implements ReactiveController {
     this._config = config;
     this._skipInitial = skipInitial ?? this._skipInitial;
     this.callback = callback;
+    if (isServer) {
+      return;
+    }
     // Check browser support.
     if (!window.MutationObserver) {
       console.warn(

diff --git a/packages/labs/observers/src/performance-controller.ts b/packages/labs/observers/src/performance-controller.ts
@@ -3,6 +3,7 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: BSD-3-Clause
  */
+import {isServer} from 'lit-html/is-server.js';
 import {
   ReactiveController,
   ReactiveControllerHost,
@@ -80,6 +81,9 @@ export class PerformanceController<T = unknown> implements ReactiveController {
     this._config = config;
     this._skipInitial = skipInitial ?? this._skipInitial;
     this.callback = callback;
+    if (isServer) {
+      return;
+    }
     // Check browser support.
     if (!window.PerformanceObserver) {
       console.warn(

diff --git a/packages/labs/observers/src/resize-controller.ts b/packages/labs/observers/src/resize-controller.ts
@@ -3,6 +3,7 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: BSD-3-Clause
  */
+import {isServer} from 'lit-html/is-server.js';
 import {
   ReactiveController,
   ReactiveControllerHost,
@@ -93,6 +94,9 @@ export class ResizeController<T = unknown> implements ReactiveController {
     this._config = config;
     this._skipInitial = skipInitial ?? this._skipInitial;
     this.callback = callback;
+    if (isServer) {
+      return;
+    }
     // Check browser support.
     if (!window.ResizeObserver) {
       console.warn(