Skip to content

feat: add getDebugInfo utility for browser and platform information #2592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sbrjt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add getDebugInfo utility for browser and platform information #2592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/wxt/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@
"types": "./dist/utils/content-script-context.d.mts",
"default": "./dist/utils/content-script-context.mjs"
},
"./utils/debug-info": {
"types": "./dist/utils/debug-info.d.mts",
"default": "./dist/utils/debug-info.mjs"
},
"./utils/content-script-ui/types": {
"types": "./dist/utils/content-script-ui/types.d.mts",
"default": "./dist/utils/content-script-ui/types.mjs"
Expand Down
53 changes: 53 additions & 0 deletions packages/wxt/src/utils/debug-info.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/** @module wxt/utils/debug-info */
import { browser } from 'wxt/browser';

/**
* Collect debug information about the current browser and platform.
*
* @example
* ```ts
* const info = await getDebugInfo();
* // {
* // "extensionVersion": "1.0.0",
* // "browser": [
* // {
* // "brand": "Google Chrome",
* // "version": "..."
* // },
* // {
* // "brand": "Chromium",
* // "version": "..."
* // }
* // ],
* // "platform": {
* // "os": "Windows",
* // "arch": "x86"
* // }
* // }
* ```;
*/
export async function getDebugInfo() {
const debugInfo: Record<string, unknown> = {
extensionVersion: browser.runtime.getManifest().version,
};

if (import.meta.env.FIREFOX) {
// @ts-ignore
debugInfo.browser = await browser.runtime.getBrowserInfo();
debugInfo.platform = await browser.runtime.getPlatformInfo();
}

if (import.meta.env.CHROME) {
// @ts-ignore
const ua = await navigator.userAgentData.getHighEntropyValues([
'fullVersionList',
'architecture',
'platform',
]);

debugInfo.browser = ua.fullVersionList;
debugInfo.platform = { os: ua.platform, arch: ua.architecture };
}

return debugInfo;
}