m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code

Handle extension unloaded and reloaded error: "Extension context invalidated" during dapp use for chromium browsers (#16306)

Browse Source 
* dapp: handle ext unloaded or reloaded error

* dapp: handle ext unloaded or reloaded error pt. 2
- use const
- mention case is unsupported in Firefox

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
This commit is contained in:
Ariella Vu 2022-12-12 19:24:12 +07:00 committed by GitHub
parent 5cca4b9b44
commit 4d4e487ffc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
app/scripts/contentscript.js
View File

@ -4,6 +4,7 @@ import ObjectMultiplex from 'obj-multiplex';
import browser from 'webextension-polyfill'; import browser from 'webextension-polyfill';
import PortStream from 'extension-port-stream'; import PortStream from 'extension-port-stream';
import { obj as createThoughStream } from 'through2'; import { obj as createThoughStream } from 'through2';
import log from 'loglevel';
import { EXTENSION_MESSAGES, MESSAGE_TYPE } from '../../shared/constants/app'; import { EXTENSION_MESSAGES, MESSAGE_TYPE } from '../../shared/constants/app';
import { checkForLastError } from '../../shared/modules/browser-runtime.utils'; import { checkForLastError } from '../../shared/modules/browser-runtime.utils';
@ -85,6 +86,9 @@ function injectScript(content) {
* SERVICE WORKER LOGIC * SERVICE WORKER LOGIC
*/ */
const EXTENSION_CONTEXT_INVALIDATED_CHROMIUM_ERROR =
'Extension context invalidated.';
const WORKER_KEEP_ALIVE_INTERVAL = 1000; const WORKER_KEEP_ALIVE_INTERVAL = 1000;
const WORKER_KEEP_ALIVE_MESSAGE = 'WORKER_KEEP_ALIVE_MESSAGE'; const WORKER_KEEP_ALIVE_MESSAGE = 'WORKER_KEEP_ALIVE_MESSAGE';
const TIME_45_MIN_IN_MS = 45 * 60 * 1000; const TIME_45_MIN_IN_MS = 45 * 60 * 1000;
@ -103,6 +107,24 @@ const IGNORE_INIT_METHODS_FOR_KEEP_ALIVE = [
let keepAliveInterval; let keepAliveInterval;
let keepAliveTimer; let keepAliveTimer;
/**
* Sending a message to the extension to receive will keep the service worker alive.
*
* If the extension is unloaded or reloaded during a session and the user attempts to send a
* message to the extension, an "Extension context invalidated." error will be thrown from
* chromium browsers. When this happens, prompt the user to reload the extension. Note: Handling
* this error is not supported in Firefox here.
*/
const sendMessageWorkerKeepAlive = () => {
browser.runtime
.sendMessage({ name: WORKER_KEEP_ALIVE_MESSAGE })
.catch((e) => {
e.message === EXTENSION_CONTEXT_INVALIDATED_CHROMIUM_ERROR
? log.error(`Please refresh the page. MetaMask: ${e}`)
: log.error(`MetaMask: ${e}`);
});
};
/** /**
* Running this method will ensure the service worker is kept alive for 45 minutes. * Running this method will ensure the service worker is kept alive for 45 minutes.
* The first message is sent immediately and subsequent messages are sent at an * The first message is sent immediately and subsequent messages are sent at an
@ -117,11 +139,11 @@ const runWorkerKeepAliveInterval = () => {
clearInterval(keepAliveInterval); clearInterval(keepAliveInterval);
browser.runtime.sendMessage({ name: WORKER_KEEP_ALIVE_MESSAGE }); sendMessageWorkerKeepAlive();
keepAliveInterval = setInterval(() => { keepAliveInterval = setInterval(() => {
if (browser.runtime.id) { if (browser.runtime.id) {
browser.runtime.sendMessage({ name: WORKER_KEEP_ALIVE_MESSAGE }); sendMessageWorkerKeepAlive();
} }
}, WORKER_KEEP_ALIVE_INTERVAL); }, WORKER_KEEP_ALIVE_INTERVAL);
}; };