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.

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

fix: change window and document DOM access to self checks for SW context #2900

Merged
merged 4 commits into from
Nov 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions packages/ts/frontend/src/Connect.ts
Original file line number Diff line number Diff line change
@@ -14,9 +14,9 @@ import {
FluxConnection,
type FluxSubscriptionStateChangeEvent,
} from './FluxConnection.js';
import type { VaadinWindow } from './types.js';
import type { VaadinGlobal } from './types.js';

const $wnd = window as VaadinWindow;
const $wnd = globalThis as VaadinGlobal;

$wnd.Vaadin ??= {};
$wnd.Vaadin.registrations ??= [];
@@ -300,7 +300,8 @@ export class ConnectClient {
throw new TypeError(`2 arguments required, but got only ${arguments.length}`);
}

const csrfHeaders = getCsrfTokenHeadersForEndpointRequest(document);
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
const csrfHeaders = globalThis.document ? getCsrfTokenHeadersForEndpointRequest(globalThis.document) : {};
const headers: Record<string, string> = {
Accept: 'application/json',
'Content-Type': 'application/json',
3 changes: 2 additions & 1 deletion packages/ts/frontend/src/CookieManager.ts
Original file line number Diff line number Diff line change
@@ -5,7 +5,8 @@ export function calculatePath({ pathname }: URL): string {
}

const CookieManager: Cookies.CookiesStatic = Cookies.withAttributes({
path: calculatePath(new URL(document.baseURI)),
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
path: calculatePath(new URL(globalThis.document?.baseURI ?? '/')),
});

export default CookieManager;
3 changes: 2 additions & 1 deletion packages/ts/frontend/src/FluxConnection.ts
Original file line number Diff line number Diff line change
@@ -182,7 +182,8 @@ export class FluxConnection extends EventTarget {
}

#connectWebsocket(prefix: string, atmosphereOptions: Partial<Atmosphere.Request>) {
const extraHeaders = getCsrfTokenHeadersForEndpointRequest(document);
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
const extraHeaders = globalThis.document ? getCsrfTokenHeadersForEndpointRequest(globalThis.document) : {};
const pushUrl = 'HILLA/push';
const url = prefix.length === 0 ? pushUrl : (prefix.endsWith('/') ? prefix : `${prefix}/`) + pushUrl;
this.#socket = atmosphere.subscribe?.({
2 changes: 1 addition & 1 deletion packages/ts/frontend/src/types.d.ts
Original file line number Diff line number Diff line change
@@ -16,6 +16,6 @@ export interface Vaadin {
registrations?: VaadinRegistration[];
}

export interface VaadinWindow extends Window {
export interface VaadinGlobal {
Vaadin?: Vaadin;
}
2 changes: 1 addition & 1 deletion packages/ts/frontend/test/Connect.test.ts
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ import {
UnauthorizedResponseError,
type FluxConnection,
} from '../src/index.js';
import type { Vaadin, VaadinWindow } from '../src/types.js';
import type { Vaadin, VaadinGlobal } from '../src/types.js';
import { subscribeStub } from './mocks/atmosphere.js';
import { fluxConnectionSubscriptionStubs } from './mocks/FluxConnection.js';
import {
10 changes: 9 additions & 1 deletion packages/ts/react-i18n/src/index.ts
Original file line number Diff line number Diff line change
@@ -4,6 +4,14 @@ import { FormatCache } from './FormatCache.js';
import { getLanguageSettings, updateLanguageSettings } from './settings.js';
import type { I18nOptions, Translations, TranslationsResult } from './types.js';

interface VaadinGlobal {
Vaadin?: {
featureFlags?: {
hillaI18n?: boolean;
};
};
}

function determineInitialLanguage(options?: I18nOptions): string {
// Use explicitly configured language if defined
if (options?.language) {
@@ -31,7 +39,7 @@ export class I18n {

constructor() {
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
if (!(window as any).Vaadin?.featureFlags?.hillaI18n) {
if (!(globalThis as VaadinGlobal).Vaadin?.featureFlags?.hillaI18n) {
// Remove when removing feature flag
throw new Error(
`The Hilla I18n API is currently considered experimental and may change in the future. To use it you need to explicitly enable it in Copilot or by adding com.vaadin.experimental.hillaI18n=true to vaadin-featureflags.properties`,
10 changes: 9 additions & 1 deletion packages/ts/react-signals/src/FullStackSignal.ts
Original file line number Diff line number Diff line change
@@ -3,6 +3,14 @@ import { nanoid } from 'nanoid';
import { computed, signal, Signal } from './core.js';
import { createSetStateEvent, type StateEvent } from './events.js';

interface VaadinGlobal {
Vaadin?: {
featureFlags?: {
fullstackSignals?: boolean;
};
};
}

const ENDPOINT = 'SignalsHandler';

/**
@@ -28,7 +36,7 @@ export abstract class DependencyTrackingSignal<T> extends Signal<T> {

protected constructor(value: T | undefined, onFirstSubscribe: () => void, onLastUnsubscribe: () => void) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
if (!(window as any).Vaadin?.featureFlags?.fullstackSignals) {
if (!(globalThis as VaadinGlobal).Vaadin?.featureFlags?.fullstackSignals) {
// Remove when removing feature flag
throw new Error(
`The Hilla Fullstack Signals API is currently considered experimental and may change in the future. To use it you need to explicitly enable it in Copilot or by adding com.vaadin.experimental.fullstackSignals=true to vaadin-featureflags.properties`,