Skip to content

feat: add |skipScreenFingerprint| option to handle missing screen properties #480

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
jagadeshjai wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add |skipScreenFingerprint| option to handle missing screen properties #480

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
18 changes: 16 additions & 2 deletions packages/fingerprint-generator/src/fingerprint-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export type VideoCard = {
};

export type Fingerprint = {
screen: ScreenFingerprint;
screen: ScreenFingerprint | null;
navigator: NavigatorFingerprint;
videoCodecs: Record<string, string>;
audioCodecs: Record<string, string>;
Expand Down Expand Up @@ -119,6 +119,13 @@ export interface FingerprintGeneratorOptions extends HeaderGeneratorOptions {
* Try enabling this if you are experiencing performance issues with the fingerprint injection.
*/
slim?: boolean;
/**
* When set to true, allows fingerprint generation without screen properties.
* This can be useful when screen fingerprint is not required or to avoid fingerprint generation issue.
*
* **Note:** When enabled, the `screen` property in the generated fingerprint will be null.
*/
skipScreenFingerprint?: boolean;
}

/**
Expand Down Expand Up @@ -242,7 +249,14 @@ export class FingerprintGenerator extends HeaderGenerator {
}
}

if (!fingerprint.screen) continue; // fix? sometimes, fingerprints are generated 90% empty/null. This is just a workaround.
if (!fingerprint.screen) {
// If skipScreenFingerprint is enabled, allow fingerprint without screen
if (options.skipScreenFingerprint) {
fingerprint.screen = null;
} else {
continue; // fix? sometimes, fingerprints are generated 90% empty/null. This is just a workaround.
}
}

// Manually add the set of accepted languages required by the input
const acceptLanguageHeaderValue =
Expand Down
59 changes: 36 additions & 23 deletions packages/fingerprint-injector/src/fingerprint-injector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,20 +147,22 @@ export class FingerprintInjector {
const browserVersion = await page.browser().version();

if (!browserVersion.toLowerCase().includes('firefox')) {
await (
await page.target().createCDPSession()
).send('Page.setDeviceMetricsOverride', {
screenHeight: screen.height,
screenWidth: screen.width,
width: screen.width,
height: screen.height,
mobile: /phone|android|mobile/i.test(userAgent),
screenOrientation:
screen.height > screen.width
? { angle: 0, type: 'portraitPrimary' }
: { angle: 90, type: 'landscapePrimary' },
deviceScaleFactor: screen.devicePixelRatio,
});
if (screen) {
await (
await page.target().createCDPSession()
).send('Page.setDeviceMetricsOverride', {
screenHeight: screen.height,
screenWidth: screen.width,
width: screen.width,
height: screen.height,
mobile: /phone|android|mobile/i.test(userAgent),
screenOrientation:
screen.height > screen.width
? { angle: 0, type: 'portraitPrimary' }
: { angle: 90, type: 'landscapePrimary' },
deviceScaleFactor: screen.devicePixelRatio,
});
}

await page.setExtraHTTPHeaders(
this.onlyInjectableHeaders(headers, browserVersion),
Expand Down Expand Up @@ -234,7 +236,7 @@ export class FingerprintInjector {
hasHDR,
// window.screen props
...newScreen
} = allScreenProps;
} = allScreenProps || {};

const windowScreenProps = {
innerHeight,
Expand Down Expand Up @@ -273,9 +275,15 @@ export class FingerprintInjector {
}
overrideInstancePrototype(window.navigator, navigatorProps);

overrideInstancePrototype(window.screen, newScreen);
overrideWindowDimensionsProps(windowScreenProps);
overrideDocumentDimensionsProps(documentScreenProps);
if (allScreenProps) {
overrideInstancePrototype(window.screen, newScreen);
overrideWindowDimensionsProps(
windowScreenProps as Record<string, number>,
);
overrideDocumentDimensionsProps(
documentScreenProps as Record<string, number>,
);
}

overrideInstancePrototype(window.history, {
length: historyLength,
Expand Down Expand Up @@ -346,11 +354,16 @@ export async function newInjectedContext(
userAgent: fingerprint.navigator.userAgent,
colorScheme: 'dark',
...options?.newContextOptions,
viewport: {
width: fingerprint.screen.width,
height: fingerprint.screen.height,
...options?.newContextOptions?.viewport,
},
viewport: fingerprint.screen
? {
width: fingerprint.screen.width,
height: fingerprint.screen.height,
...options?.newContextOptions?.viewport,
}
: (options?.newContextOptions?.viewport ?? {
width: 1920,
height: 1080,
}),
extraHTTPHeaders: {
'accept-language': headers['accept-language'],
...options?.newContextOptions?.extraHTTPHeaders,
Expand Down