Logout and delete data when user logs out of WordPress

composer.json

@@ -10,7 +10,7 @@
     },
     "files": [
       "src/plugin.php",
-      "src/Sessions/sessions.php",
+      "src/Sessions/logout.php",
       "src/Block/block.php",
       "src/Popup/popup.php",
       "src/Admin/admin.php",

frontend/iframe/platform/Platform.ts

@@ -8,28 +8,26 @@ import { ServiceWorkerHandler } from "./ServiceWorkerHandler";
 import { StorageFactory } from "./StorageFactory";
 
 export class Platform extends BasePlatform {
-    private settingsStorage: SettingsStorage;
-    private sessionInfoStorage: SessionInfoStorage;
-    private storageFactory: StorageFactory;
-    private _serviceWorkerHandler: ServiceWorkerHandler;
-
     constructor(options) {
         const assetPaths = structuredClone(options.assetPaths);
 
         // Unset serviceWorker path so that the base constructor doesn't register the service worker handler.
-        delete options.assetPaths.serviceWorker;
+        delete options.assetPaths?.serviceWorker;
         super(options);
 
         // Register our own service worker handler.
+        let serviceWorkerHandler;
         if (assetPaths.serviceWorker && "serviceWorker" in navigator) {
-            this._serviceWorkerHandler = new ServiceWorkerHandler();
-            this._serviceWorkerHandler.registerAndStart(assetPaths.serviceWorker);
+            serviceWorkerHandler = new ServiceWorkerHandler();
+            serviceWorkerHandler.registerAndStart(assetPaths.serviceWorker);
         }
 
-        this.settingsStorage = new SettingsStorage("chatrix_setting_v1_");
-        this.sessionInfoStorage = new SessionInfoStorage("chatrix_sessions_v1");
-        this.storageFactory = new StorageFactory(this._serviceWorkerHandler);
-        this.history = new History();
+        super.storageFactory = new StorageFactory(serviceWorkerHandler);
+        super._serviceWorkerHandler = serviceWorkerHandler;
+
+        super.settingsStorage = new SettingsStorage("chatrix_setting_v1_");
+        super.sessionInfoStorage = new SessionInfoStorage("chatrix_sessions_v1");
+        super.history = new History();
     }
 
     public get history(): History {

frontend/logout.ts

@@ -0,0 +1,63 @@
+window.addEventListener('DOMContentLoaded', () => {
+    const logoutCookieName = "chatrix-logout";
+    const cookies = document.cookie.split(';');
+    const hasLogoutCookie = cookies.some(item => item.trim().startsWith(`${logoutCookieName}=`));
+
+    if (!hasLogoutCookie) {
+        return;
+    }
+
+    console.log("Logging out all chatrix sessions");
+    logoutAndDeleteData().catch(error => console.log(error));
+});
+
+async function logoutAndDeleteData() {
+    let sessionsKey = "";
+    for (const [key,] of Object.entries(localStorage)) {
+        if (key.startsWith('chatrix_sessions')) {
+            sessionsKey = key;
+            break;
+        }
+    }
+
+    // Logout all sessions.
+    const sessions = JSON.parse(localStorage.getItem(sessionsKey) ?? "[]");
+    let logoutPromises: Promise<Response>[] = [];
+    if (Array.isArray(sessions)) {
+        sessions.forEach(session => logoutPromises.push(logoutSession(session)));
+    }
+
+    // Wait for all sessions to have been logged out.
+    await Promise.all(logoutPromises);
+
+    // Delete from local storage.
+    for (const [key,] of Object.entries(localStorage)) {
+        if (key.startsWith('chatrix') || key.startsWith('hydrogen')) {
+            localStorage.removeItem(key);
+        }
+    }
+
+    // Delete from indexedDB.
+    const databases = await indexedDB.databases();
+    for (const database of databases) {
+        const name = database.name ?? "";
+        if (name.startsWith('chatrix') || name.startsWith("hydrogen")) {
+            await indexedDB.deleteDatabase(name);
+        }
+    }
+}
+
+async function logoutSession(session) {
+    let promise = fetch(session.homeserver + '/_matrix/client/v3/logout', {
+        method: 'POST',
+        headers: {
+            'Authorization': 'Bearer ' + session.accessToken,
+        },
+    });
+
+    promise.catch(error => {
+        console.log(`Failed to logout chatrix session. deviceId: ${session.deviceId}`, error);
+    });
+
+    return promise;
+}

frontend/vite-logout.ts

@@ -0,0 +1,20 @@
+import { resolve } from "path";
+import { defineConfig } from "vite";
+
+export default defineConfig(() => {
+    return {
+        base: "",
+        root: __dirname,
+        envDir: __dirname,
+        build: {
+            outDir: resolve(__dirname, "../build/"),
+            lib: {
+                entry: resolve(__dirname, `./logout.ts`),
+                formats: ["iife"],
+                name: "ChatrixLogout",
+                fileName: "logout"
+            },
+            rollupOptions: {}
+        }
+    };
+});

package.json

@@ -8,7 +8,8 @@
   "scripts": {
     "start": "vite --config frontend/vite.ts",
     "start:block": "wp-scripts start --webpack-src-dir=frontend/block --output-path=build/block && cp ./frontend/block/block.json ./build/block/",
-    "build": "tsc && yarn run init && vite build --config frontend/vite-app.ts --emptyOutDir && yarn run build:iframe && yarn run build:block",
+    "build": "tsc && yarn run init && vite build --config frontend/vite-app.ts --emptyOutDir && yarn run build:logout && yarn run build:iframe && yarn run build:block",
+    "build:logout": "yarn run init && vite build --config frontend/vite-logout.ts",
     "build:iframe": "yarn run init && vite build --config frontend/vite.ts --emptyOutDir",
     "build:block": "wp-scripts build --webpack-src-dir=frontend/block --output-path=build/block && cp ./frontend/block/block.json ./build/block/",
     "init": "mkdir -p build/.tmp",

src/Sessions/logout.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Automattic\Chatrix\Sessions;
+
+function init_logout() {
+	// Set a cookie when user logs out.
+	add_action(
+		'wp_logout',
+		function () {
+			// Expire in 10 minutes.
+			$expiration = time() + ( 10 * 60 );
+			setcookie( 'chatrix-logout', 'true', $expiration, COOKIEPATH, COOKIE_DOMAIN );
+		}
+	);
+}

src/plugin.php

@@ -4,15 +4,15 @@
 
 use function Automattic\Chatrix\Block\register as register_block;
 use function Automattic\Chatrix\Popup\register as register_popup;
-use function Automattic\Chatrix\Sessions\init as init_frontend_session_management;
+use function Automattic\Chatrix\Sessions\init_logout;
 
-const LOCAL_STORAGE_KEY_PREFIX = 'chatrix';
-const SCRIPT_HANDLE_CONFIG     = 'chatrix-config';
-const SCRIPT_HANDLE_APP        = 'chatrix-app';
-const CONFIG_VARIABLE          = 'ChatrixConfig';
+const SCRIPT_HANDLE_CONFIG = 'chatrix-config';
+const SCRIPT_HANDLE_APP    = 'chatrix-app';
+const SCRIPT_HANDLE_LOGOUT = 'chatrix-logout';
+const CONFIG_VARIABLE      = 'ChatrixConfig';
 
 function main() {
-	init_frontend_session_management( LOCAL_STORAGE_KEY_PREFIX );
+	init_logout();
 	register_scripts();
 	register_block();
 	register_popup();
@@ -33,7 +33,7 @@ function () {
 			wp_enqueue_script( SCRIPT_HANDLE_CONFIG );
 			wp_add_inline_script( SCRIPT_HANDLE_CONFIG, 'window.' . CONFIG_VARIABLE . " = $json_data;" );
 
-			// Note we don't enqueue the script yet. It will be enqueue whenever SCRIPT_HANDLE_APP
+			// Note we don't enqueue the SCRIPT_HANDLE_APP script yet. It will be enqueued whenever SCRIPT_HANDLE_APP
 			// is specified as a dependency of another script.
 			wp_register_script(
 				SCRIPT_HANDLE_APP,
@@ -42,25 +42,21 @@ function () {
 				automattic_chatrix_version(),
 				true
 			);
+
+			if ( ! is_user_logged_in() ) {
+				wp_register_script(
+					SCRIPT_HANDLE_LOGOUT,
+					root_url() . '/logout.iife.js',
+					array(),
+					automattic_chatrix_version(),
+					false
+				);
+				wp_enqueue_script( SCRIPT_HANDLE_LOGOUT );
+			}
 		}
 	);
 }
 
 function root_url(): string {
 	return plugins_url() . '/chatrix/build';
 }
-
-function get_local_storage_key( string $instance_id ): string {
-	$current_user      = wp_get_current_user();
-	$local_storage_key = LOCAL_STORAGE_KEY_PREFIX;
-
-	if ( ! empty( $instance_id ) ) {
-		$local_storage_key .= '_' . $instance_id;
-	}
-
-	if ( 0 !== $current_user->ID ) {
-		$local_storage_key .= '_' . $current_user->user_login;
-	}
-
-	return $local_storage_key;
-}