Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[labs/observers] Prevent failing in SSR #4591

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+24 −1
Open

[labs/observers] Prevent failing in SSR #4591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2ab0099
Add "isServer" check in observers' constructors
a11delavar Mar 22, 2024
196a8d4
Add changeset
a11delavar Mar 22, 2024
3c4aed7
Try to fix incorrect package import causing tests to fail
a11delavar Mar 22, 2024
2ccd17b
Merge branch 'main' into fix-observers-failing-in-ssr
a11delavar Mar 30, 2024
13e9db7
Allow lit-html 3.x as a dependency as well
a11delavar May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/bright-yaks-wink.md
View file
Open in desktop
@@ -0,0 +1,5 @@
---
'@lit-labs/observers': patch
---

Do not initialize observers to prevent failing in SSR environment.
3 changes: 2 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/labs/observers/package.json
View file
Open in desktop
Expand Up @@ -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": {
Expand Down
4 changes: 4 additions & 0 deletions packages/labs/observers/src/intersection-controller.ts
View file
Open in desktop
Expand Up @@ -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,
Expand Down Expand Up @@ -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(
Expand Down
4 changes: 4 additions & 0 deletions packages/labs/observers/src/mutation-controller.ts
View file
Open in desktop
Expand Up @@ -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,
Expand Down Expand Up @@ -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(
Expand Down
4 changes: 4 additions & 0 deletions packages/labs/observers/src/performance-controller.ts
View file
Open in desktop
Expand Up @@ -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,
Expand Down Expand Up @@ -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(
Expand Down
4 changes: 4 additions & 0 deletions packages/labs/observers/src/resize-controller.ts
View file
Open in desktop
Expand Up @@ -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,
Expand Down Expand Up @@ -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(
Expand Down