nikrozman/element-web
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Clear account idb table on logout (#28996)

Browse Source 
* Clear account idb table on logout

to remove old deactivated refresh token when logging out

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Simplify code

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Fix test

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

---------

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski
2025-01-14 12:01:19 +00:00
committed by GitHub
parent 5882b004f5
commit 2559cba482
3 changed files with 47 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Lifecycle.ts
View File

@@ -1049,9 +1049,9 @@ async function clearStorage(opts?: { deleteEverything?: boolean }): Promise<void
window.localStorage.clear();
try {
await StorageAccess.idbDelete("account", ACCESS_TOKEN_STORAGE_KEY);
await StorageAccess.idbClear("account");
} catch (e) {
logger.error("idbDelete failed for account:mx_access_token", e);
logger.error("idbClear failed for account", e);
}
// now restore those invites, registration time and previously set device language

72
src/utils/StorageAccess.ts
View File

@@ -44,6 +44,27 @@ async function idbInit(): Promise<void> {
});
}
async function idbTransaction(
table: string,
mode: IDBTransactionMode,
fn: (objectStore: IDBObjectStore) => IDBRequest<any>,
): Promise<any> {
if (!idb) {
await idbInit();
}
return new Promise((resolve, reject) => {
const txn = idb!.transaction([table], mode);
txn.onerror = reject;
const objectStore = txn.objectStore(table);
const request = fn(objectStore);
request.onerror = reject;
request.onsuccess = (): void => {
resolve(request.result);
};
});
}
/**
* Loads an item from an IndexedDB table within the underlying `matrix-react-sdk` database.
*
@@ -57,17 +78,7 @@ export async function idbLoad(table: string, key: string | string[]): Promise<an
if (!idb) {
await idbInit();
}
return new Promise((resolve, reject) => {
const txn = idb!.transaction([table], "readonly");
txn.onerror = reject;
const objectStore = txn.objectStore(table);
const request = objectStore.get(key);
request.onerror = reject;
request.onsuccess = (event): void => {
resolve(request.result);
};
});
return idbTransaction(table, "readonly", (objectStore) => objectStore.get(key));
}
/**
@@ -84,17 +95,7 @@ export async function idbSave(table: string, key: string | string[], data: any):
if (!idb) {
await idbInit();
}
return new Promise((resolve, reject) => {
const txn = idb!.transaction([table], "readwrite");
txn.onerror = reject;
const objectStore = txn.objectStore(table);
const request = objectStore.put(data, key);
request.onerror = reject;
request.onsuccess = (event): void => {
resolve();
};
});
return idbTransaction(table, "readwrite", (objectStore) => objectStore.put(data, key));
}
/**
@@ -110,15 +111,20 @@ export async function idbDelete(table: string, key: string | string[]): Promise<
if (!idb) {
await idbInit();
}
return new Promise((resolve, reject) => {
const txn = idb!.transaction([table], "readwrite");
txn.onerror = reject;
const objectStore = txn.objectStore(table);
const request = objectStore.delete(key);
request.onerror = reject;
request.onsuccess = (): void => {
resolve();
};
});
return idbTransaction(table, "readwrite", (objectStore) => objectStore.delete(key));
}
/**
* Clears all records from an IndexedDB table within the underlying `matrix-react-sdk` database.
*
* If IndexedDB access is not supported in the environment, an error is thrown.
*
* @param {string} table The name of the object store where the records are stored.
* @returns {Promise<void>} A Promise that resolves when the record(s) have been successfully deleted.
*/
export async function idbClear(table: string): Promise<void> {
if (!idb) {
await idbInit();
}
return idbTransaction(table, "readwrite", (objectStore) => objectStore.clear());
}

7
test/unit-tests/Lifecycle-test.ts
View File

@@ -143,6 +143,11 @@ describe("Lifecycle", () => {
const table = mockStore[tableKey];
delete table?.[key as string];
});
jest.spyOn(StorageAccess, "idbClear")
.mockClear()
.mockImplementation(async (tableKey: string) => {
mockStore[tableKey] = {};
});
};
const homeserverUrl = "https://server.org";
@@ -613,7 +618,7 @@ describe("Lifecycle", () => {
it("should clear stores", async () => {
await setLoggedIn(credentials);
expect(StorageAccess.idbDelete).toHaveBeenCalledWith("account", "mx_access_token");
expect(StorageAccess.idbClear).toHaveBeenCalledWith("account");
expect(sessionStorage.clear).toHaveBeenCalled();
expect(mockClient.clearStores).toHaveBeenCalled();
});