fix(serviceworker): Improve error handling and logging in service worker backend and network manager; update multiple dependency versions and packageManager settings.
This commit is contained in:
@@ -1,5 +1,40 @@
|
||||
import * as plugins from './plugins.js';
|
||||
import * as interfaces from '../dist_ts_interfaces/index.js';
|
||||
import { logger } from './logging.js';
|
||||
|
||||
// Add type definitions for ServiceWorker APIs
|
||||
declare global {
|
||||
interface ServiceWorkerGlobalScope extends EventTarget {
|
||||
clients: Clients;
|
||||
registration: ServiceWorkerRegistration;
|
||||
}
|
||||
|
||||
// Define Clients interface
|
||||
interface Clients {
|
||||
matchAll(options?: ClientQueryOptions): Promise<Client[]>;
|
||||
openWindow(url: string): Promise<WindowClient>;
|
||||
claim(): Promise<void>;
|
||||
get(id: string): Promise<Client | undefined>;
|
||||
}
|
||||
|
||||
interface ClientQueryOptions {
|
||||
includeUncontrolled?: boolean;
|
||||
type?: 'window' | 'worker' | 'sharedworker' | 'all';
|
||||
}
|
||||
|
||||
interface Client {
|
||||
id: string;
|
||||
type: 'window' | 'worker' | 'sharedworker';
|
||||
url: string;
|
||||
}
|
||||
|
||||
interface WindowClient extends Client {
|
||||
focused: boolean;
|
||||
visibilityState: 'hidden' | 'visible' | 'prerender' | 'unloaded';
|
||||
focus(): Promise<WindowClient>;
|
||||
navigate(url: string): Promise<WindowClient>;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This class is meant to be used only on the backend side
|
||||
@@ -34,7 +69,33 @@ export class ServiceworkerBackend {
|
||||
* reloads all clients
|
||||
*/
|
||||
public async triggerReloadAll() {
|
||||
|
||||
try {
|
||||
logger.log('info', 'Triggering reload for all clients due to new version');
|
||||
|
||||
// Send update message via DeesComms
|
||||
// This will be picked up by clients that have registered a handler for 'serviceworker_newVersion'
|
||||
await this.deesComms.postMessage({
|
||||
method: 'serviceworker_newVersion',
|
||||
request: {},
|
||||
messageId: `sw_update_${Date.now()}`
|
||||
});
|
||||
|
||||
// As a fallback, also use the clients API to reload clients that might not catch the broadcast
|
||||
// We need to type-cast self since TypeScript doesn't recognize ServiceWorker API
|
||||
const swSelf = self as unknown as ServiceWorkerGlobalScope;
|
||||
const clients = await swSelf.clients.matchAll({ type: 'window' });
|
||||
logger.log('info', `Found ${clients.length} clients to reload`);
|
||||
|
||||
for (const client of clients) {
|
||||
if ('navigate' in client) {
|
||||
// For modern browsers, navigate to the same URL to trigger reload
|
||||
(client as any).navigate(client.url);
|
||||
logger.log('info', `Navigated client to: ${client.url}`);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
logger.log('error', `Failed to reload clients: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -44,10 +105,51 @@ export class ServiceworkerBackend {
|
||||
title: string;
|
||||
body: string;
|
||||
}) {
|
||||
|
||||
try {
|
||||
// Check if we have permission to show notifications
|
||||
const permission = self.Notification?.permission;
|
||||
if (permission !== 'granted') {
|
||||
logger.log('warn', `Cannot show notification: permission is ${permission}`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Type-cast self to ServiceWorkerGlobalScope
|
||||
const swSelf = self as unknown as ServiceWorkerGlobalScope;
|
||||
|
||||
// Use type assertion for notification options to include vibrate
|
||||
const options = {
|
||||
body: notificationArg.body,
|
||||
icon: '/favicon.ico', // Assuming there's a favicon
|
||||
badge: '/favicon.ico',
|
||||
vibrate: [200, 100, 200]
|
||||
} as NotificationOptions;
|
||||
|
||||
await swSelf.registration.showNotification(notificationArg.title, options);
|
||||
|
||||
logger.log('info', `Notification shown: ${notificationArg.title}`);
|
||||
} catch (error) {
|
||||
logger.log('error', `Failed to show notification: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
|
||||
public async alert(alertText: string) {
|
||||
// Since we can't directly show alerts from service worker context,
|
||||
// we'll use notifications as a fallback
|
||||
await this.addNotification({
|
||||
title: 'Alert',
|
||||
body: alertText
|
||||
});
|
||||
|
||||
// Send message to clients who might be able to show an actual alert
|
||||
try {
|
||||
await this.deesComms.postMessage({
|
||||
method: 'serviceworker_alert',
|
||||
request: { message: alertText },
|
||||
messageId: `sw_alert_${Date.now()}`
|
||||
});
|
||||
logger.log('info', `Alert message sent to clients: ${alertText}`);
|
||||
} catch (error) {
|
||||
logger.log('error', `Failed to send alert to clients: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -96,32 +96,56 @@ export class NetworkManager {
|
||||
backoffMs = 1000
|
||||
} = options;
|
||||
|
||||
let lastError: Error;
|
||||
let lastError: Error | unknown;
|
||||
for (let i = 0; i <= retries; i++) {
|
||||
let timeoutId: number | undefined;
|
||||
const controller = new AbortController();
|
||||
|
||||
try {
|
||||
const isOnline = await this.checkOnlineStatus();
|
||||
if (!isOnline) {
|
||||
throw new Error('Device is offline');
|
||||
}
|
||||
|
||||
const controller = new AbortController();
|
||||
const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
|
||||
// Set up timeout
|
||||
timeoutId = setTimeout(() => controller.abort(), timeoutMs) as unknown as number;
|
||||
|
||||
const response = await fetch(request, {
|
||||
...typeof request === 'string' ? {} : request,
|
||||
signal: controller.signal
|
||||
});
|
||||
|
||||
// Clear timeout on successful response
|
||||
clearTimeout(timeoutId);
|
||||
return response;
|
||||
} catch (error) {
|
||||
// Always clear timeout, even on error
|
||||
if (timeoutId) {
|
||||
clearTimeout(timeoutId);
|
||||
}
|
||||
|
||||
lastError = error;
|
||||
logger.log('warn', `Request attempt ${i+1}/${retries+1} failed: ${error instanceof Error ? error.message : String(error)}`);
|
||||
|
||||
// Check if this was an abort error (timeout)
|
||||
if (error instanceof Error && error.name === 'AbortError') {
|
||||
logger.log('warn', `Request timed out after ${timeoutMs}ms`);
|
||||
}
|
||||
|
||||
// Retry with backoff if we have retries left
|
||||
if (i < retries) {
|
||||
await new Promise(resolve => setTimeout(resolve, backoffMs * (i + 1)));
|
||||
const backoffTime = backoffMs * (i + 1);
|
||||
logger.log('info', `Retrying in ${backoffTime}ms...`);
|
||||
await new Promise(resolve => setTimeout(resolve, backoffTime));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError;
|
||||
// Convert lastError to Error if it isn't already
|
||||
const finalError = lastError instanceof Error
|
||||
? lastError
|
||||
: new Error(typeof lastError === 'string' ? lastError : 'Unknown error during request');
|
||||
|
||||
throw finalError;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -57,10 +57,15 @@ export class ServiceWorker {
|
||||
const done = new Deferred();
|
||||
event.waitUntil(done.promise);
|
||||
// its important to not go async before event.waitUntil
|
||||
done.resolve();
|
||||
logger.log('success', `service worker installed! TimeStamp = ${new Date().toISOString()}`);
|
||||
selfArg.skipWaiting();
|
||||
logger.log('note', `Called skip waiting!`);
|
||||
try {
|
||||
logger.log('success', `service worker installed! TimeStamp = ${new Date().toISOString()}`);
|
||||
selfArg.skipWaiting();
|
||||
logger.log('note', `Called skip waiting!`);
|
||||
done.resolve();
|
||||
} catch (error) {
|
||||
logger.log('error', `Service worker installation error: ${error}`);
|
||||
done.reject(error);
|
||||
}
|
||||
});
|
||||
|
||||
this.serviceWindowRef.addEventListener('activate', async (event: interfaces.ServiceEvent) => {
|
||||
@@ -68,9 +73,19 @@ export class ServiceWorker {
|
||||
event.waitUntil(done.promise);
|
||||
|
||||
// its important to not go async before event.waitUntil
|
||||
await selfArg.clients.claim();
|
||||
await this.cacheManager.cleanCaches('new service worker loaded! :)');
|
||||
done.resolve();
|
||||
try {
|
||||
await selfArg.clients.claim();
|
||||
logger.log('ok', 'Clients claimed successfully');
|
||||
|
||||
await this.cacheManager.cleanCaches('new service worker loaded! :)');
|
||||
logger.log('ok', 'Caches cleaned successfully');
|
||||
|
||||
done.resolve();
|
||||
logger.log('success', `Service worker activated at ${new Date().toISOString()}`);
|
||||
} catch (error) {
|
||||
logger.log('error', `Service worker activation error: ${error}`);
|
||||
done.reject(error);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user