Skip to content

Feature: Add Local URL Support in Accessibility #48

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.

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

Merged
merged 2 commits into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 15 additions & 5 deletions src/lib/local.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,30 @@ export async function killExistingBrowserStackLocalProcesses() {
}
}

export async function ensureLocalBinarySetup(): Promise<void> {
export async function ensureLocalBinarySetup(localIdentifier?: string): Promise<void> {
logger.info(
"Ensuring local binary setup as it is required for private URLs...",
);

const localBinary = new Local();
await killExistingBrowserStackLocalProcesses();

const requestBody: {
key: string;
username: string;
localIdentifier?: string;
} = {
key: config.browserstackAccessKey,
username: config.browserstackUsername
};

if (localIdentifier) {
requestBody.localIdentifier = localIdentifier;
}

return await new Promise((resolve, reject) => {
localBinary.start(
{
key: config.browserstackAccessKey,
username: config.browserstackUsername,
},
requestBody,
(error?: Error) => {
if (error) {
logger.error(
Expand Down
52 changes: 51 additions & 1 deletion src/tools/accessiblity-utils/scanner.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import axios from "axios";
import config from "../../config.js";
import logger from "../../logger.js";
import {
isLocalURL,
ensureLocalBinarySetup,
killExistingBrowserStackLocalProcesses,
} from "../../lib/local.js";

export interface AccessibilityScanResponse {
success: boolean;
Expand All @@ -23,10 +29,54 @@ export class AccessibilityScanner {
name: string,
urlList: string[],
): Promise<AccessibilityScanResponse> {

// Check if any URL is local
const hasLocal = urlList.some(isLocalURL);
const localIdentifier = crypto.randomUUID();
const LOCAL_IP = "127.0.0.1";
const BS_LOCAL_DOMAIN = "bs-local.com";

if (hasLocal) {
await ensureLocalBinarySetup(localIdentifier);
} else {
await killExistingBrowserStackLocalProcesses();
}

const transformedUrlList = urlList.map((url) => {
try {
const parsed = new URL(url);
if (parsed.hostname === LOCAL_IP) {
parsed.hostname = BS_LOCAL_DOMAIN;
return parsed.toString();
}
return url;
} catch (e) {
logger.warn(`[AccessibilityScan] Invalid URL skipped: ${url}`);
return url;
}
});

const baseRequestBody = {
name,
urlList: transformedUrlList,
recurring: false,
};

let requestBody = baseRequestBody;
if (hasLocal) {
const localConfig = {
localTestingInfo: {
localIdentifier,
localEnabled: true,
}
};
requestBody = { ...baseRequestBody, ...localConfig };
}

try {
const { data } = await axios.post<AccessibilityScanResponse>(
"https://api-accessibility.browserstack.com/api/website-scanner/v1/scans",
{ name, urlList, recurring: false },
requestBody,
{ auth: this.auth },
);
if (!data.success)
Expand Down