|
| 1 | +/** |
| 2 | + * Copyright (c) Facebook, Inc. and its affiliates. |
| 3 | + * |
| 4 | + * This source code is licensed under the MIT license found in the |
| 5 | + * LICENSE file in the root directory of this source tree. |
| 6 | + * |
| 7 | + * @flow strict-local |
| 8 | + */ |
| 9 | + |
| 10 | +declare var chrome: any; |
| 11 | + |
| 12 | +import {__DEBUG__} from 'react-devtools-shared/src/constants'; |
| 13 | +import { |
| 14 | + EXTENSION_INSTALL_CHECK_MESSAGE, |
| 15 | + EXTENSION_INSTALLATION_TYPE, |
| 16 | + INTERNAL_EXTENSION_ID, |
| 17 | + EXTENSION_NAME, |
| 18 | +} from './constants'; |
| 19 | + |
| 20 | +export function checkForDuplicateInstallations(callback: boolean => void) { |
| 21 | + switch (EXTENSION_INSTALLATION_TYPE) { |
| 22 | + case 'chrome-web-store': { |
| 23 | + // If this is the Chrome Web Store extension, check if an internal build of the |
| 24 | + // extension is also installed, and if so, disable this extension. |
| 25 | + chrome.runtime.sendMessage( |
| 26 | + INTERNAL_EXTENSION_ID, |
| 27 | + EXTENSION_INSTALL_CHECK_MESSAGE, |
| 28 | + response => { |
| 29 | + if (__DEBUG__) { |
| 30 | + console.log( |
| 31 | + '[main] checkForDuplicateInstallations: Duplicate installation check responded with', |
| 32 | + { |
| 33 | + response, |
| 34 | + error: chrome.runtime.lastError?.message, |
| 35 | + currentExtension: EXTENSION_INSTALLATION_TYPE, |
| 36 | + }, |
| 37 | + ); |
| 38 | + } |
| 39 | + if (chrome.runtime.lastError != null) { |
| 40 | + callback(false); |
| 41 | + } else { |
| 42 | + callback(response === true); |
| 43 | + } |
| 44 | + }, |
| 45 | + ); |
| 46 | + break; |
| 47 | + } |
| 48 | + case 'internal': { |
| 49 | + // If this is the internal extension, keep this one enabled. |
| 50 | + // Other installations disable themselves if they detect this installation. |
| 51 | + // TODO show warning if other installations are present. |
| 52 | + callback(false); |
| 53 | + break; |
| 54 | + } |
| 55 | + case 'unknown': { |
| 56 | + if (__DEV__) { |
| 57 | + // If this extension was built locally during development, then we check for other |
| 58 | + // installations of the extension via the `chrome.management` API (which is only |
| 59 | + // enabled in local development builds). |
| 60 | + // If we detect other installations, we disable this one and show a warning |
| 61 | + // for the developer to disable the other installations. |
| 62 | + // NOTE: Ideally in this case we would disable any other extensions except the |
| 63 | + // development one. However, since we don't have a stable extension ID for dev builds, |
| 64 | + // doing so would require for other installations to wait for a message from this extension, |
| 65 | + // which could unnecessarily delay initialization of those extensions. |
| 66 | + chrome.management.getAll(extensions => { |
| 67 | + if (chrome.runtime.lastError != null) { |
| 68 | + const errorMessage = |
| 69 | + 'React Developer Tools: Unable to access `chrome.management` to check for duplicate extensions. This extension will be disabled.' + |
| 70 | + 'If you are developing this extension locally, make sure to build the extension using the `yarn build:<browser>:dev` command.'; |
| 71 | + console.error(errorMessage); |
| 72 | + chrome.devtools.inspectedWindow.eval( |
| 73 | + `console.error("${errorMessage}")`, |
| 74 | + ); |
| 75 | + callback(true); |
| 76 | + return; |
| 77 | + } |
| 78 | + const devToolsExtensions = extensions.filter( |
| 79 | + extension => extension.name === EXTENSION_NAME && extension.enabled, |
| 80 | + ); |
| 81 | + if (devToolsExtensions.length > 1) { |
| 82 | + // TODO: Show warning in UI of extension that remains enabled |
| 83 | + const errorMessage = |
| 84 | + 'React Developer Tools: You are running multiple installations of the React Developer Tools extension, which will conflict with this development build of the extension.' + |
| 85 | + 'In order to prevent conflicts, this development build of the extension will be disabled. In order to continue local development, please disable or uninstall ' + |
| 86 | + 'any other installations of the extension in your browser.'; |
| 87 | + chrome.devtools.inspectedWindow.eval( |
| 88 | + `console.error("${errorMessage}")`, |
| 89 | + ); |
| 90 | + console.error(errorMessage); |
| 91 | + callback(true); |
| 92 | + } else { |
| 93 | + callback(false); |
| 94 | + } |
| 95 | + }); |
| 96 | + break; |
| 97 | + } |
| 98 | + |
| 99 | + // If this extension wasn't built locally during development, we can't reliably |
| 100 | + // detect if there are other installations of DevTools present. |
| 101 | + // In this case, assume there are no duplicate exensions and show a warning about |
| 102 | + // potential conflicts. |
| 103 | + const warnMessage = |
| 104 | + 'React Developer Tools: You are running an unrecognized installation of the React Developer Tools extension, which might conflict with other versions of the extension installed in your browser.' + |
| 105 | + 'Please make sure you only have a single version of the extension installed or enabled.' + |
| 106 | + 'If you are developing this extension locally, make sure to build the extension using the `yarn build:<browser>:dev` command.'; |
| 107 | + console.warn(warnMessage); |
| 108 | + chrome.devtools.inspectedWindow.eval(`console.warn("${warnMessage}")`); |
| 109 | + callback(false); |
| 110 | + break; |
| 111 | + } |
| 112 | + default: { |
| 113 | + (EXTENSION_INSTALLATION_TYPE: empty); |
| 114 | + } |
| 115 | + } |
| 116 | +} |
0 commit comments