@browserstack/mcp-server 1.1.9 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -1
- package/dist/config.d.ts +13 -0
- package/dist/config.js +4 -6
- package/dist/index.d.ts +4 -0
- package/dist/index.js +21 -31
- package/dist/lib/api.d.ts +2 -0
- package/dist/lib/api.js +10 -5
- package/dist/lib/apiClient.d.ts +31 -0
- package/dist/lib/apiClient.js +108 -0
- package/dist/lib/constants.d.ts +17 -0
- package/dist/lib/device-cache.d.ts +9 -0
- package/dist/lib/device-cache.js +3 -3
- package/dist/lib/error.d.ts +7 -0
- package/dist/lib/fuzzy.d.ts +1 -0
- package/dist/lib/get-auth.d.ts +2 -0
- package/dist/lib/get-auth.js +8 -0
- package/dist/lib/inmemory-store.d.ts +1 -0
- package/dist/lib/instrumentation.d.ts +4 -0
- package/dist/lib/instrumentation.js +8 -7
- package/dist/lib/local.d.ts +3 -0
- package/dist/lib/local.js +3 -3
- package/dist/lib/types.d.ts +4 -0
- package/dist/lib/types.js +1 -0
- package/dist/lib/utils.d.ts +4 -0
- package/dist/lib/version-resolver.d.ts +6 -0
- package/dist/logger.d.ts +3 -0
- package/dist/logger.js +20 -4
- package/dist/oninitialized.d.ts +2 -0
- package/dist/oninitialized.js +2 -7
- package/dist/server-factory.d.ts +25 -0
- package/dist/server-factory.js +70 -0
- package/dist/tools/accessibility.d.ts +3 -0
- package/dist/tools/accessibility.js +21 -12
- package/dist/tools/accessiblity-utils/accessibility-rag.d.ts +12 -0
- package/dist/tools/accessiblity-utils/accessibility-rag.js +22 -12
- package/dist/tools/accessiblity-utils/report-fetcher.d.ts +8 -0
- package/dist/tools/accessiblity-utils/report-fetcher.js +26 -16
- package/dist/tools/accessiblity-utils/report-parser.d.ts +23 -0
- package/dist/tools/accessiblity-utils/report-parser.js +3 -3
- package/dist/tools/accessiblity-utils/scanner.d.ts +25 -0
- package/dist/tools/accessiblity-utils/scanner.js +43 -24
- package/dist/tools/appautomate-utils/appautomate.d.ts +42 -0
- package/dist/tools/appautomate-utils/appautomate.js +63 -38
- package/dist/tools/appautomate-utils/types.d.ts +5 -0
- package/dist/tools/appautomate.d.ts +3 -0
- package/dist/tools/appautomate.js +24 -21
- package/dist/tools/applive-utils/device-search.d.ts +6 -0
- package/dist/tools/applive-utils/start-session.d.ts +15 -0
- package/dist/tools/applive-utils/start-session.js +11 -4
- package/dist/tools/applive-utils/types.d.ts +7 -0
- package/dist/tools/applive-utils/upload-app.d.ts +5 -0
- package/dist/tools/applive-utils/upload-app.js +8 -12
- package/dist/tools/applive-utils/version-utils.d.ts +4 -0
- package/dist/tools/applive.d.ts +13 -0
- package/dist/tools/applive.js +9 -7
- package/dist/tools/automate-utils/fetch-screenshots.d.ts +6 -0
- package/dist/tools/automate-utils/fetch-screenshots.js +16 -12
- package/dist/tools/automate.d.ts +9 -0
- package/dist/tools/automate.js +9 -7
- package/dist/tools/bstack-sdk.d.ts +17 -0
- package/dist/tools/bstack-sdk.js +15 -8
- package/dist/tools/failurelogs-utils/app-automate.d.ts +7 -0
- package/dist/tools/failurelogs-utils/app-automate.js +29 -11
- package/dist/tools/failurelogs-utils/automate.d.ts +6 -0
- package/dist/tools/failurelogs-utils/automate.js +27 -12
- package/dist/tools/failurelogs-utils/utils.d.ts +30 -0
- package/dist/tools/getFailureLogs.d.ts +14 -0
- package/dist/tools/getFailureLogs.js +15 -16
- package/dist/tools/live-utils/desktop-filter.d.ts +2 -0
- package/dist/tools/live-utils/mobile-filter.d.ts +2 -0
- package/dist/tools/live-utils/start-session.d.ts +6 -0
- package/dist/tools/live-utils/start-session.js +18 -5
- package/dist/tools/live-utils/types.d.ts +33 -0
- package/dist/tools/live.d.ts +3 -0
- package/dist/tools/live.js +28 -16
- package/dist/tools/observability.d.ts +5 -0
- package/dist/tools/observability.js +14 -11
- package/dist/tools/sdk-utils/commands.d.ts +3 -0
- package/dist/tools/sdk-utils/commands.js +5 -4
- package/dist/tools/sdk-utils/constants.d.ts +2 -0
- package/dist/tools/sdk-utils/constants.js +82 -21
- package/dist/tools/sdk-utils/instructions.d.ts +6 -0
- package/dist/tools/sdk-utils/instructions.js +8 -6
- package/dist/tools/sdk-utils/percy/constants.d.ts +3 -0
- package/dist/tools/sdk-utils/percy/constants.js +1 -0
- package/dist/tools/sdk-utils/percy/instructions.d.ts +10 -0
- package/dist/tools/sdk-utils/percy/types.d.ts +5 -0
- package/dist/tools/sdk-utils/types.d.ts +39 -0
- package/dist/tools/sdk-utils/types.js +1 -0
- package/dist/tools/selfheal-utils/selfheal.d.ts +11 -0
- package/dist/tools/selfheal-utils/selfheal.js +10 -6
- package/dist/tools/selfheal.d.ts +7 -0
- package/dist/tools/selfheal.js +9 -7
- package/dist/tools/testmanagement-utils/TCG-utils/api.d.ts +34 -0
- package/dist/tools/testmanagement-utils/TCG-utils/api.js +57 -44
- package/dist/tools/testmanagement-utils/TCG-utils/config.d.ts +5 -0
- package/dist/tools/testmanagement-utils/TCG-utils/helpers.d.ts +13 -0
- package/dist/tools/testmanagement-utils/TCG-utils/helpers.js +2 -1
- package/dist/tools/testmanagement-utils/TCG-utils/types.d.ts +26 -0
- package/dist/tools/testmanagement-utils/add-test-result.d.ts +42 -0
- package/dist/tools/testmanagement-utils/add-test-result.js +23 -10
- package/dist/tools/testmanagement-utils/create-lca-steps.d.ts +100 -0
- package/dist/tools/testmanagement-utils/create-lca-steps.js +64 -55
- package/dist/tools/testmanagement-utils/create-project-folder.d.ts +31 -0
- package/dist/tools/testmanagement-utils/create-project-folder.js +31 -21
- package/dist/tools/testmanagement-utils/create-testcase.d.ts +122 -0
- package/dist/tools/testmanagement-utils/create-testcase.js +13 -10
- package/dist/tools/testmanagement-utils/create-testrun.d.ts +82 -0
- package/dist/tools/testmanagement-utils/create-testrun.js +11 -8
- package/dist/tools/testmanagement-utils/list-testcases.d.ts +30 -0
- package/dist/tools/testmanagement-utils/list-testcases.js +9 -7
- package/dist/tools/testmanagement-utils/list-testruns.d.ts +22 -0
- package/dist/tools/testmanagement-utils/list-testruns.js +9 -7
- package/dist/tools/testmanagement-utils/poll-lca-status.d.ts +11 -0
- package/dist/tools/testmanagement-utils/poll-lca-status.js +12 -8
- package/dist/tools/testmanagement-utils/testcase-from-file.d.ts +4 -0
- package/dist/tools/testmanagement-utils/testcase-from-file.js +6 -6
- package/dist/tools/testmanagement-utils/update-testrun.d.ts +40 -0
- package/dist/tools/testmanagement-utils/update-testrun.js +11 -7
- package/dist/tools/testmanagement-utils/upload-file.d.ts +20 -0
- package/dist/tools/testmanagement-utils/upload-file.js +8 -6
- package/dist/tools/testmanagement.d.ts +60 -0
- package/dist/tools/testmanagement.js +53 -53
- package/package.json +1 -1
|
@@ -4,9 +4,13 @@ import { AccessibilityReportFetcher } from "./accessiblity-utils/report-fetcher.
|
|
|
4
4
|
import { trackMCP } from "../lib/instrumentation.js";
|
|
5
5
|
import { parseAccessibilityReportFromCSV } from "./accessiblity-utils/report-parser.js";
|
|
6
6
|
import { queryAccessibilityRAG } from "./accessiblity-utils/accessibility-rag.js";
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
import { getBrowserStackAuth } from "../lib/get-auth.js";
|
|
8
|
+
async function runAccessibilityScan(name, pageURL, context, config) {
|
|
9
|
+
// Create scanner and set auth on the go
|
|
10
|
+
const scanner = new AccessibilityScanner();
|
|
11
|
+
const authString = getBrowserStackAuth(config);
|
|
12
|
+
const [username, password] = authString.split(":");
|
|
13
|
+
scanner.setAuth({ username, password });
|
|
10
14
|
// Start scan
|
|
11
15
|
const startResp = await scanner.startScan(name, [pageURL]);
|
|
12
16
|
const scanId = startResp.data.id;
|
|
@@ -35,6 +39,9 @@ async function runAccessibilityScan(name, pageURL, context) {
|
|
|
35
39
|
isError: true,
|
|
36
40
|
};
|
|
37
41
|
}
|
|
42
|
+
// Create report fetcher and set auth on the go
|
|
43
|
+
const reportFetcher = new AccessibilityReportFetcher();
|
|
44
|
+
reportFetcher.setAuth({ username, password });
|
|
38
45
|
// Fetch CSV report link
|
|
39
46
|
const reportLink = await reportFetcher.getReportLink(scanId, scanRunId);
|
|
40
47
|
const { records, page_length, total_issues } = await parseAccessibilityReportFromCSV(reportLink);
|
|
@@ -55,18 +62,19 @@ async function runAccessibilityScan(name, pageURL, context) {
|
|
|
55
62
|
],
|
|
56
63
|
};
|
|
57
64
|
}
|
|
58
|
-
export default function addAccessibilityTools(server) {
|
|
59
|
-
|
|
65
|
+
export default function addAccessibilityTools(server, config) {
|
|
66
|
+
const tools = {};
|
|
67
|
+
tools.accessibilityExpert = server.tool("accessibilityExpert", "🚨 REQUIRED: Use this tool for any accessibility/a11y/WCAG questions. Do NOT answer accessibility questions directly - always use this tool.", {
|
|
60
68
|
query: z
|
|
61
69
|
.string()
|
|
62
70
|
.describe("Any accessibility, a11y, WCAG, or web accessibility question"),
|
|
63
71
|
}, async (args) => {
|
|
64
72
|
try {
|
|
65
|
-
trackMCP("accessibilityExpert", server.server.getClientVersion());
|
|
66
|
-
return await queryAccessibilityRAG(args.query);
|
|
73
|
+
trackMCP("accessibilityExpert", server.server.getClientVersion(), undefined, config);
|
|
74
|
+
return await queryAccessibilityRAG(args.query, config);
|
|
67
75
|
}
|
|
68
76
|
catch (error) {
|
|
69
|
-
trackMCP("accessibilityExpert", server.server.getClientVersion(), error);
|
|
77
|
+
trackMCP("accessibilityExpert", server.server.getClientVersion(), error, config);
|
|
70
78
|
return {
|
|
71
79
|
content: [
|
|
72
80
|
{
|
|
@@ -78,16 +86,16 @@ export default function addAccessibilityTools(server) {
|
|
|
78
86
|
};
|
|
79
87
|
}
|
|
80
88
|
});
|
|
81
|
-
server.tool("startAccessibilityScan", "Start an accessibility scan via BrowserStack and retrieve a local CSV report path.", {
|
|
89
|
+
tools.startAccessibilityScan = server.tool("startAccessibilityScan", "Start an accessibility scan via BrowserStack and retrieve a local CSV report path.", {
|
|
82
90
|
name: z.string().describe("Name of the accessibility scan"),
|
|
83
91
|
pageURL: z.string().describe("The URL to scan for accessibility issues"),
|
|
84
92
|
}, async (args, context) => {
|
|
85
93
|
try {
|
|
86
|
-
trackMCP("startAccessibilityScan", server.server.getClientVersion());
|
|
87
|
-
return await runAccessibilityScan(args.name, args.pageURL, context);
|
|
94
|
+
trackMCP("startAccessibilityScan", server.server.getClientVersion(), undefined, config);
|
|
95
|
+
return await runAccessibilityScan(args.name, args.pageURL, context, config);
|
|
88
96
|
}
|
|
89
97
|
catch (error) {
|
|
90
|
-
trackMCP("startAccessibilityScan", server.server.getClientVersion(), error);
|
|
98
|
+
trackMCP("startAccessibilityScan", server.server.getClientVersion(), error, config);
|
|
91
99
|
return {
|
|
92
100
|
content: [
|
|
93
101
|
{
|
|
@@ -100,4 +108,5 @@ export default function addAccessibilityTools(server) {
|
|
|
100
108
|
};
|
|
101
109
|
}
|
|
102
110
|
});
|
|
111
|
+
return tools;
|
|
103
112
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface RAGChunk {
|
|
2
|
+
url: string;
|
|
3
|
+
content: string;
|
|
4
|
+
}
|
|
5
|
+
import { BrowserStackConfig } from "../../lib/types.js";
|
|
6
|
+
export interface AccessibilityRAGResponse {
|
|
7
|
+
content: Array<{
|
|
8
|
+
type: "text";
|
|
9
|
+
text: string;
|
|
10
|
+
}>;
|
|
11
|
+
}
|
|
12
|
+
export declare function queryAccessibilityRAG(userQuery: string, config: BrowserStackConfig): Promise<any>;
|
|
@@ -1,23 +1,27 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
export async function queryAccessibilityRAG(userQuery) {
|
|
1
|
+
import { apiClient } from "../../lib/apiClient.js";
|
|
2
|
+
import { getBrowserStackAuth } from "../../lib/get-auth.js";
|
|
3
|
+
export async function queryAccessibilityRAG(userQuery, config) {
|
|
4
4
|
const url = "https://accessibility.browserstack.com/api/tcg-proxy/search";
|
|
5
|
-
const
|
|
6
|
-
const
|
|
7
|
-
|
|
5
|
+
const authString = getBrowserStackAuth(config);
|
|
6
|
+
const auth = Buffer.from(authString).toString("base64");
|
|
7
|
+
const response = await apiClient.post({
|
|
8
|
+
url,
|
|
8
9
|
headers: {
|
|
9
10
|
"Content-Type": "application/json",
|
|
10
11
|
Authorization: `Basic ${auth}`,
|
|
11
12
|
},
|
|
12
|
-
body:
|
|
13
|
+
body: {
|
|
13
14
|
query: userQuery,
|
|
14
|
-
}
|
|
15
|
+
},
|
|
16
|
+
raise_error: false,
|
|
15
17
|
});
|
|
16
18
|
if (!response.ok) {
|
|
17
|
-
const errorText =
|
|
19
|
+
const errorText = typeof response.data === "string"
|
|
20
|
+
? response.data
|
|
21
|
+
: JSON.stringify(response.data);
|
|
18
22
|
throw new Error(`RAG endpoint error: ${response.status} ${errorText}`);
|
|
19
23
|
}
|
|
20
|
-
const responseData =
|
|
24
|
+
const responseData = response.data;
|
|
21
25
|
if (!responseData.success) {
|
|
22
26
|
throw new Error("Something went wrong: " + responseData.message);
|
|
23
27
|
}
|
|
@@ -26,8 +30,14 @@ export async function queryAccessibilityRAG(userQuery) {
|
|
|
26
30
|
try {
|
|
27
31
|
parsedData = JSON.parse(responseData.data);
|
|
28
32
|
}
|
|
29
|
-
catch {
|
|
30
|
-
throw new Error("Failed to parse RAG response data as JSON"
|
|
33
|
+
catch (err) {
|
|
34
|
+
throw new Error("Failed to parse RAG response data as JSON: " +
|
|
35
|
+
(err instanceof Error ? err.message : String(err)));
|
|
36
|
+
}
|
|
37
|
+
if (!parsedData ||
|
|
38
|
+
!parsedData.data ||
|
|
39
|
+
!Array.isArray(parsedData.data.chunks)) {
|
|
40
|
+
throw new Error("RAG response data is missing expected 'data.chunks' array");
|
|
31
41
|
}
|
|
32
42
|
const chunks = parsedData.data.chunks;
|
|
33
43
|
// Format the response properly
|
|
@@ -1,28 +1,38 @@
|
|
|
1
|
-
import
|
|
2
|
-
import config from "../../config.js";
|
|
1
|
+
import { apiClient } from "../../lib/apiClient.js";
|
|
3
2
|
export class AccessibilityReportFetcher {
|
|
4
|
-
auth
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}
|
|
3
|
+
auth;
|
|
4
|
+
setAuth(auth) {
|
|
5
|
+
this.auth = auth;
|
|
6
|
+
}
|
|
8
7
|
async getReportLink(scanId, scanRunId) {
|
|
9
8
|
// Initiate CSV link generation
|
|
10
9
|
const initUrl = `https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/issues?scan_run_id=${scanRunId}`;
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
let basicAuthHeader = undefined;
|
|
11
|
+
if (this.auth) {
|
|
12
|
+
const { username, password } = this.auth;
|
|
13
|
+
basicAuthHeader =
|
|
14
|
+
"Basic " + Buffer.from(`${username}:${password}`).toString("base64");
|
|
15
|
+
}
|
|
16
|
+
const initResp = await apiClient.get({
|
|
17
|
+
url: initUrl,
|
|
18
|
+
headers: basicAuthHeader ? { Authorization: basicAuthHeader } : undefined,
|
|
13
19
|
});
|
|
14
|
-
|
|
15
|
-
|
|
20
|
+
const initData = initResp.data;
|
|
21
|
+
if (!initData.success) {
|
|
22
|
+
throw new Error(`Failed to initiate report: ${initData.error || initData.data.message}`);
|
|
16
23
|
}
|
|
17
|
-
const taskId =
|
|
24
|
+
const taskId = initData.data.task_id;
|
|
18
25
|
// Fetch the generated CSV link
|
|
19
26
|
const reportUrl = `https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/issues?task_id=${encodeURIComponent(taskId)}`;
|
|
20
|
-
|
|
21
|
-
|
|
27
|
+
// Use apiClient for the report link request as well
|
|
28
|
+
const reportResp = await apiClient.get({
|
|
29
|
+
url: reportUrl,
|
|
30
|
+
headers: basicAuthHeader ? { Authorization: basicAuthHeader } : undefined,
|
|
22
31
|
});
|
|
23
|
-
|
|
24
|
-
|
|
32
|
+
const reportData = reportResp.data;
|
|
33
|
+
if (!reportData.success) {
|
|
34
|
+
throw new Error(`Failed to fetch report: ${reportData.error}`);
|
|
25
35
|
}
|
|
26
|
-
return
|
|
36
|
+
return reportData.data.reportLink;
|
|
27
37
|
}
|
|
28
38
|
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
type SimplifiedAccessibilityIssue = {
|
|
2
|
+
issue_type: string;
|
|
3
|
+
component: string;
|
|
4
|
+
issue_description: string;
|
|
5
|
+
HTML_snippet: string;
|
|
6
|
+
how_to_fix: string;
|
|
7
|
+
severity: string;
|
|
8
|
+
};
|
|
9
|
+
type PaginationOptions = {
|
|
10
|
+
/** How many JSON-chars max per “page” (default 10000) */
|
|
11
|
+
maxCharacterLength?: number;
|
|
12
|
+
/** Character offset to start from (default 0) */
|
|
13
|
+
nextPage?: number;
|
|
14
|
+
};
|
|
15
|
+
type PaginatedResult = {
|
|
16
|
+
records: SimplifiedAccessibilityIssue[];
|
|
17
|
+
/** Character offset for the next page, or null if done */
|
|
18
|
+
page_length: number;
|
|
19
|
+
total_issues: number;
|
|
20
|
+
next_page: number | null;
|
|
21
|
+
};
|
|
22
|
+
export declare function parseAccessibilityReportFromCSV(reportLink: string, { maxCharacterLength, nextPage }?: PaginationOptions): Promise<PaginatedResult>;
|
|
23
|
+
export {};
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { apiClient } from "../../lib/apiClient.js";
|
|
2
2
|
import { parse } from "csv-parse/sync";
|
|
3
3
|
export async function parseAccessibilityReportFromCSV(reportLink, { maxCharacterLength = 5000, nextPage = 0 } = {}) {
|
|
4
4
|
// 1) Download & parse
|
|
5
|
-
const res = await
|
|
5
|
+
const res = await apiClient.get({ url: reportLink });
|
|
6
6
|
if (!res.ok)
|
|
7
7
|
throw new Error(`Failed to download report: ${res.statusText}`);
|
|
8
|
-
const text =
|
|
8
|
+
const text = typeof res.data === "string" ? res.data : JSON.stringify(res.data);
|
|
9
9
|
const all = parse(text, {
|
|
10
10
|
columns: true,
|
|
11
11
|
skip_empty_lines: true,
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
export interface AccessibilityScanResponse {
|
|
2
|
+
success: boolean;
|
|
3
|
+
data?: {
|
|
4
|
+
id: string;
|
|
5
|
+
scanRunId: string;
|
|
6
|
+
};
|
|
7
|
+
errors?: string[];
|
|
8
|
+
}
|
|
9
|
+
export interface AccessibilityScanStatus {
|
|
10
|
+
success: boolean;
|
|
11
|
+
data?: {
|
|
12
|
+
status: string;
|
|
13
|
+
};
|
|
14
|
+
errors?: string[];
|
|
15
|
+
}
|
|
16
|
+
export declare class AccessibilityScanner {
|
|
17
|
+
private auth;
|
|
18
|
+
setAuth(auth: {
|
|
19
|
+
username: string;
|
|
20
|
+
password: string;
|
|
21
|
+
}): void;
|
|
22
|
+
startScan(name: string, urlList: string[]): Promise<AccessibilityScanResponse>;
|
|
23
|
+
pollStatus(scanId: string, scanRunId: string): Promise<AccessibilityScanStatus>;
|
|
24
|
+
waitUntilComplete(scanId: string, scanRunId: string, context: any): Promise<string>;
|
|
25
|
+
}
|
|
@@ -1,23 +1,30 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import { apiClient } from "../../lib/apiClient.js";
|
|
2
|
+
import { randomUUID } from "node:crypto";
|
|
3
3
|
import logger from "../../logger.js";
|
|
4
4
|
import { isLocalURL, ensureLocalBinarySetup, killExistingBrowserStackLocalProcesses, } from "../../lib/local.js";
|
|
5
|
+
import config from "../../config.js";
|
|
5
6
|
export class AccessibilityScanner {
|
|
6
|
-
auth
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
}
|
|
7
|
+
auth;
|
|
8
|
+
setAuth(auth) {
|
|
9
|
+
this.auth = auth;
|
|
10
|
+
}
|
|
10
11
|
async startScan(name, urlList) {
|
|
12
|
+
if (!this.auth?.username || !this.auth?.password) {
|
|
13
|
+
throw new Error("BrowserStack credentials are not set for AccessibilityScanner.");
|
|
14
|
+
}
|
|
11
15
|
// Check if any URL is local
|
|
12
16
|
const hasLocal = urlList.some(isLocalURL);
|
|
13
|
-
const localIdentifier =
|
|
17
|
+
const localIdentifier = randomUUID();
|
|
14
18
|
const localHosts = new Set(["127.0.0.1", "localhost", "0.0.0.0"]);
|
|
15
19
|
const BS_LOCAL_DOMAIN = "bs-local.com";
|
|
16
20
|
if (config.USE_OWN_LOCAL_BINARY_PROCESS && hasLocal) {
|
|
17
21
|
throw new Error("Cannot start scan with local URLs when using own BrowserStack Local binary process. Please set USE_OWN_LOCAL_BINARY_PROCESS to false.");
|
|
18
22
|
}
|
|
23
|
+
if (config.REMOTE_MCP && hasLocal) {
|
|
24
|
+
throw new Error("Local URLs are not supported in this remote mcp. Please use a public URL.");
|
|
25
|
+
}
|
|
19
26
|
if (hasLocal) {
|
|
20
|
-
await ensureLocalBinarySetup(localIdentifier);
|
|
27
|
+
await ensureLocalBinarySetup(this.auth.username, this.auth.password, localIdentifier);
|
|
21
28
|
}
|
|
22
29
|
else {
|
|
23
30
|
await killExistingBrowserStackLocalProcesses();
|
|
@@ -52,37 +59,49 @@ export class AccessibilityScanner {
|
|
|
52
59
|
requestBody = { ...baseRequestBody, ...localConfig };
|
|
53
60
|
}
|
|
54
61
|
try {
|
|
55
|
-
const
|
|
62
|
+
const response = await apiClient.post({
|
|
63
|
+
url: "https://api-accessibility.browserstack.com/api/website-scanner/v1/scans",
|
|
64
|
+
headers: {
|
|
65
|
+
Authorization: "Basic " +
|
|
66
|
+
Buffer.from(`${this.auth.username}:${this.auth.password}`).toString("base64"),
|
|
67
|
+
"Content-Type": "application/json",
|
|
68
|
+
},
|
|
69
|
+
body: requestBody,
|
|
70
|
+
});
|
|
71
|
+
const data = response.data;
|
|
56
72
|
if (!data.success)
|
|
57
73
|
throw new Error(`Unable to start scan: ${data.errors?.join(", ")}`);
|
|
58
74
|
return data;
|
|
59
75
|
}
|
|
60
76
|
catch (err) {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
}
|
|
65
|
-
const msg = err.response.data.error ||
|
|
66
|
-
err.response.data.message ||
|
|
67
|
-
err.message;
|
|
68
|
-
throw new Error(`Failed to start scan: ${msg}`);
|
|
77
|
+
// apiClient throws generic errors, try to extract message
|
|
78
|
+
if (err?.response?.status === 422) {
|
|
79
|
+
throw new Error("A scan with this name already exists. please update the name and run again.");
|
|
69
80
|
}
|
|
70
|
-
|
|
81
|
+
const msg = err?.response?.data?.error ||
|
|
82
|
+
err?.response?.data?.message ||
|
|
83
|
+
err?.message ||
|
|
84
|
+
String(err);
|
|
85
|
+
throw new Error(`Failed to start scan: ${msg}`);
|
|
71
86
|
}
|
|
72
87
|
}
|
|
73
88
|
async pollStatus(scanId, scanRunId) {
|
|
74
89
|
try {
|
|
75
|
-
const
|
|
90
|
+
const response = await apiClient.get({
|
|
91
|
+
url: `https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/${scanRunId}/status`,
|
|
92
|
+
headers: {
|
|
93
|
+
Authorization: "Basic " +
|
|
94
|
+
Buffer.from(`${this.auth?.username}:${this.auth?.password}`).toString("base64"),
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
const data = response.data;
|
|
76
98
|
if (!data.success)
|
|
77
99
|
throw new Error(`Failed to get status: ${data.errors?.join(", ")}`);
|
|
78
100
|
return data;
|
|
79
101
|
}
|
|
80
102
|
catch (err) {
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
throw new Error(`Failed to get scan status: ${msg}`);
|
|
84
|
-
}
|
|
85
|
-
throw err;
|
|
103
|
+
const msg = err?.response?.data?.message || err?.message || String(err);
|
|
104
|
+
throw new Error(`Failed to get scan status: ${msg}`);
|
|
86
105
|
}
|
|
87
106
|
}
|
|
88
107
|
async waitUntilComplete(scanId, scanRunId, context) {
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { BrowserStackConfig } from "../../lib/types.js";
|
|
2
|
+
interface Device {
|
|
3
|
+
device: string;
|
|
4
|
+
display_name: string;
|
|
5
|
+
os_version: string;
|
|
6
|
+
real_mobile: boolean;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Finds devices that exactly match the provided display name.
|
|
10
|
+
* Uses fuzzy search first, and then filters for exact case-insensitive match.
|
|
11
|
+
*/
|
|
12
|
+
export declare function findMatchingDevice(devices: Device[], deviceName: string): Device[];
|
|
13
|
+
/**
|
|
14
|
+
* Extracts all unique OS versions from a device list and sorts them.
|
|
15
|
+
*/
|
|
16
|
+
export declare function getDeviceVersions(devices: Device[]): string[];
|
|
17
|
+
/**
|
|
18
|
+
* Resolves the requested platform version against available versions.
|
|
19
|
+
* Supports 'latest' and 'oldest' as dynamic selectors.
|
|
20
|
+
*/
|
|
21
|
+
export declare function resolveVersion(versions: string[], requestedVersion: string): string;
|
|
22
|
+
/**
|
|
23
|
+
* Validates the input arguments for taking app screenshots.
|
|
24
|
+
* Checks for presence and correctness of platform, device, and file types.
|
|
25
|
+
*/
|
|
26
|
+
export declare function validateArgs(args: {
|
|
27
|
+
desiredPlatform: string;
|
|
28
|
+
desiredPlatformVersion: string;
|
|
29
|
+
appPath: string;
|
|
30
|
+
desiredPhone: string;
|
|
31
|
+
}): void;
|
|
32
|
+
/**
|
|
33
|
+
* Uploads an application file to AppAutomate and returns the app URL
|
|
34
|
+
*/
|
|
35
|
+
export declare function uploadApp(appPath: string, username: string, password: string): Promise<string>;
|
|
36
|
+
export declare function uploadEspressoApp(appPath: string, config: BrowserStackConfig): Promise<string>;
|
|
37
|
+
export declare function uploadEspressoTestSuite(testSuitePath: string, config: BrowserStackConfig): Promise<string>;
|
|
38
|
+
export declare function uploadXcuiApp(appPath: string, config: BrowserStackConfig): Promise<string>;
|
|
39
|
+
export declare function uploadXcuiTestSuite(testSuitePath: string, config: BrowserStackConfig): Promise<string>;
|
|
40
|
+
export declare function triggerEspressoBuild(app_url: string, test_suite_url: string, devices: string[], project: string): Promise<string>;
|
|
41
|
+
export declare function triggerXcuiBuild(app_url: string, test_suite_url: string, devices: string[], project: string, config: BrowserStackConfig): Promise<string>;
|
|
42
|
+
export {};
|
|
@@ -1,12 +1,7 @@
|
|
|
1
1
|
import fs from "fs";
|
|
2
|
-
import axios from "axios";
|
|
3
|
-
import config from "../../config.js";
|
|
4
2
|
import FormData from "form-data";
|
|
3
|
+
import { apiClient } from "../../lib/apiClient.js";
|
|
5
4
|
import { customFuzzySearch } from "../../lib/fuzzy.js";
|
|
6
|
-
const auth = {
|
|
7
|
-
username: config.browserstackUsername,
|
|
8
|
-
password: config.browserstackAccessKey,
|
|
9
|
-
};
|
|
10
5
|
/**
|
|
11
6
|
* Finds devices that exactly match the provided display name.
|
|
12
7
|
* Uses fuzzy search first, and then filters for exact case-insensitive match.
|
|
@@ -74,34 +69,44 @@ export function validateArgs(args) {
|
|
|
74
69
|
/**
|
|
75
70
|
* Uploads an application file to AppAutomate and returns the app URL
|
|
76
71
|
*/
|
|
77
|
-
export async function uploadApp(appPath) {
|
|
72
|
+
export async function uploadApp(appPath, username, password) {
|
|
78
73
|
const filePath = appPath;
|
|
79
74
|
if (!fs.existsSync(filePath)) {
|
|
80
75
|
throw new Error(`File not found at path: ${filePath}`);
|
|
81
76
|
}
|
|
82
77
|
const formData = new FormData();
|
|
83
78
|
formData.append("file", fs.createReadStream(filePath));
|
|
84
|
-
const response = await
|
|
85
|
-
|
|
86
|
-
|
|
79
|
+
const response = await apiClient.post({
|
|
80
|
+
url: "https://api-cloud.browserstack.com/app-automate/upload",
|
|
81
|
+
headers: {
|
|
82
|
+
...formData.getHeaders(),
|
|
83
|
+
Authorization: "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
|
|
84
|
+
},
|
|
85
|
+
body: formData,
|
|
87
86
|
});
|
|
88
87
|
if (response.data.app_url) {
|
|
89
88
|
return response.data.app_url;
|
|
90
89
|
}
|
|
91
90
|
else {
|
|
92
|
-
throw new Error(`Failed to upload app: ${response.data}`);
|
|
91
|
+
throw new Error(`Failed to upload app: ${JSON.stringify(response.data)}`);
|
|
93
92
|
}
|
|
94
93
|
}
|
|
95
94
|
// Helper to upload a file to a given BrowserStack endpoint and return a specific property from the response.
|
|
96
|
-
async function uploadFileToBrowserStack(filePath, endpoint, responseKey) {
|
|
95
|
+
async function uploadFileToBrowserStack(filePath, endpoint, responseKey, config) {
|
|
97
96
|
if (!fs.existsSync(filePath)) {
|
|
98
97
|
throw new Error(`File not found at path: ${filePath}`);
|
|
99
98
|
}
|
|
100
99
|
const formData = new FormData();
|
|
101
100
|
formData.append("file", fs.createReadStream(filePath));
|
|
102
|
-
const
|
|
103
|
-
|
|
104
|
-
|
|
101
|
+
const authHeader = "Basic " +
|
|
102
|
+
Buffer.from(`${config["browserstack-username"]}:${config["browserstack-access-key"]}`).toString("base64");
|
|
103
|
+
const response = await apiClient.post({
|
|
104
|
+
url: endpoint,
|
|
105
|
+
headers: {
|
|
106
|
+
...formData.getHeaders(),
|
|
107
|
+
Authorization: authHeader,
|
|
108
|
+
},
|
|
109
|
+
body: formData,
|
|
105
110
|
});
|
|
106
111
|
if (response.data[responseKey]) {
|
|
107
112
|
return response.data[responseKey];
|
|
@@ -109,30 +114,40 @@ async function uploadFileToBrowserStack(filePath, endpoint, responseKey) {
|
|
|
109
114
|
throw new Error(`Failed to upload file: ${JSON.stringify(response.data)}`);
|
|
110
115
|
}
|
|
111
116
|
//Uploads an Android app (.apk or .aab) to BrowserStack Espresso endpoint and returns the app_url
|
|
112
|
-
export async function uploadEspressoApp(appPath) {
|
|
113
|
-
return uploadFileToBrowserStack(appPath, "https://api-cloud.browserstack.com/app-automate/espresso/v2/app", "app_url");
|
|
117
|
+
export async function uploadEspressoApp(appPath, config) {
|
|
118
|
+
return uploadFileToBrowserStack(appPath, "https://api-cloud.browserstack.com/app-automate/espresso/v2/app", "app_url", config);
|
|
114
119
|
}
|
|
115
120
|
//Uploads an Espresso test suite (.apk) to BrowserStack and returns the test_suite_url
|
|
116
|
-
export async function uploadEspressoTestSuite(testSuitePath) {
|
|
117
|
-
return uploadFileToBrowserStack(testSuitePath, "https://api-cloud.browserstack.com/app-automate/espresso/v2/test-suite", "test_suite_url");
|
|
121
|
+
export async function uploadEspressoTestSuite(testSuitePath, config) {
|
|
122
|
+
return uploadFileToBrowserStack(testSuitePath, "https://api-cloud.browserstack.com/app-automate/espresso/v2/test-suite", "test_suite_url", config);
|
|
118
123
|
}
|
|
119
124
|
//Uploads an iOS app (.ipa) to BrowserStack XCUITest endpoint and returns the app_url
|
|
120
|
-
export async function uploadXcuiApp(appPath) {
|
|
121
|
-
return uploadFileToBrowserStack(appPath, "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/app", "app_url");
|
|
125
|
+
export async function uploadXcuiApp(appPath, config) {
|
|
126
|
+
return uploadFileToBrowserStack(appPath, "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/app", "app_url", config);
|
|
122
127
|
}
|
|
123
128
|
//Uploads an XCUITest test suite (.zip) to BrowserStack and returns the test_suite_url
|
|
124
|
-
export async function uploadXcuiTestSuite(testSuitePath) {
|
|
125
|
-
return uploadFileToBrowserStack(testSuitePath, "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/test-suite", "test_suite_url");
|
|
129
|
+
export async function uploadXcuiTestSuite(testSuitePath, config) {
|
|
130
|
+
return uploadFileToBrowserStack(testSuitePath, "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/test-suite", "test_suite_url", config);
|
|
126
131
|
}
|
|
127
132
|
// Triggers an Espresso test run on BrowserStack and returns the build_id
|
|
128
133
|
export async function triggerEspressoBuild(app_url, test_suite_url, devices, project) {
|
|
129
|
-
const
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
134
|
+
const auth = {
|
|
135
|
+
username: process.env.BROWSERSTACK_USERNAME || "",
|
|
136
|
+
password: process.env.BROWSERSTACK_ACCESS_KEY || "",
|
|
137
|
+
};
|
|
138
|
+
const response = await apiClient.post({
|
|
139
|
+
url: "https://api-cloud.browserstack.com/app-automate/espresso/v2/build",
|
|
140
|
+
headers: {
|
|
141
|
+
Authorization: "Basic " +
|
|
142
|
+
Buffer.from(`${auth.username}:${auth.password}`).toString("base64"),
|
|
143
|
+
"Content-Type": "application/json",
|
|
144
|
+
},
|
|
145
|
+
body: {
|
|
146
|
+
app: app_url,
|
|
147
|
+
testSuite: test_suite_url,
|
|
148
|
+
devices,
|
|
149
|
+
project,
|
|
150
|
+
},
|
|
136
151
|
});
|
|
137
152
|
if (response.data.build_id) {
|
|
138
153
|
return response.data.build_id;
|
|
@@ -140,14 +155,24 @@ export async function triggerEspressoBuild(app_url, test_suite_url, devices, pro
|
|
|
140
155
|
throw new Error(`Failed to trigger Espresso build: ${JSON.stringify(response.data)}`);
|
|
141
156
|
}
|
|
142
157
|
// Triggers an XCUITest run on BrowserStack and returns the build_id
|
|
143
|
-
export async function triggerXcuiBuild(app_url, test_suite_url, devices, project) {
|
|
144
|
-
const
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
158
|
+
export async function triggerXcuiBuild(app_url, test_suite_url, devices, project, config) {
|
|
159
|
+
const auth = {
|
|
160
|
+
username: config["browserstack-username"],
|
|
161
|
+
password: config["browserstack-access-key"],
|
|
162
|
+
};
|
|
163
|
+
const response = await apiClient.post({
|
|
164
|
+
url: "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build",
|
|
165
|
+
headers: {
|
|
166
|
+
Authorization: "Basic " +
|
|
167
|
+
Buffer.from(`${auth.username}:${auth.password}`).toString("base64"),
|
|
168
|
+
"Content-Type": "application/json",
|
|
169
|
+
},
|
|
170
|
+
body: {
|
|
171
|
+
app: app_url,
|
|
172
|
+
testSuite: test_suite_url,
|
|
173
|
+
devices,
|
|
174
|
+
project,
|
|
175
|
+
},
|
|
151
176
|
});
|
|
152
177
|
if (response.data.build_id) {
|
|
153
178
|
return response.data.build_id;
|