fix: support basic auth with LHCI

Fixes #214
harlan-zw · May 22, 2024 · bcb1bc6 · bcb1bc6
1 parent 8f3b879
commit bcb1bc6
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 3 deletions.
diff --git a/docs/content/1.guide/guides/generating-static-reports.md b/docs/content/1.guide/guides/generating-static-reports.md
@@ -239,3 +239,11 @@ unlighthouse-ci --site <your-site> --reporter lighthouseServer --lhci-host <lhci
 ```
 
 This will upload your reports to the Lighthouse CI server.
+
+### Basic Auth
+
+You can provide basic auth credentials using the `--lhci-auth` flag.
+
+```bash
+unlighthouse-ci --site <your-site> --reporter lighthouseServer --lhci-host <lhci host> --lhci-build-token <lhci buildToken> --lhci-auth <username>:<password>
+```
diff --git a/packages/cli/src/ci.ts b/packages/cli/src/ci.ts
@@ -20,6 +20,7 @@ async function run() {
   cli.option('--reporter <reporter>', 'The report to generate from results. Options: csv, csvExpanded, json, jsonExpanded or false. Default: json.')
   cli.option('--lhci-host <lhci-host>', 'URL of your LHCI server.')
   cli.option('--lhci-build-token <lhci-build-token>', 'LHCI build token, used to add data.')
+  cli.option('--lhci-auth <lhci-auth>', 'Basic auth for your LHCI server.')
 
   const { options } = cli.parse() as unknown as { options: CiOptions }
 
@@ -34,6 +35,7 @@ async function run() {
     reporterConfig: {
       lhciHost: options.lhciHost,
       lhciBuildToken: options.lhciBuildToken,
+      lhciAuth: options.lhciAuth,
     },
 
   }

diff --git a/packages/cli/src/reporters/lighthouseServer.ts b/packages/cli/src/reporters/lighthouseServer.ts
@@ -16,10 +16,16 @@ import type { ReporterConfig } from './types'
 
 export async function reportLighthouseServer(
   reports: UnlighthouseRouteReport[],
-  { lhciBuildToken, lhciHost }: ReporterConfig,
+  { lhciBuildToken, lhciHost, lhciAuth }: ReporterConfig,
 ): Promise<void> {
   try {
-    const api = new ApiClient({ fetch, rootURL: lhciHost })
+    const api = new ApiClient({
+      fetch,
+      rootURL: lhciHost,
+      basicAuth: (typeof lhciAuth === 'string' && lhciAuth.includes(':'))
+        ? { username: lhciAuth.split(':')[0], password: lhciAuth.split(':')[1] }
+        : undefined,
+    })
     api.setBuildToken(lhciBuildToken)
     const project = await api.findProjectByToken(lhciBuildToken)
     const baseBranch = project.baseBranch || 'master'

diff --git a/packages/cli/src/reporters/types.ts b/packages/cli/src/reporters/types.ts
@@ -74,4 +74,5 @@ export type ReporterConfig = Partial<{
   columns: Record<UnlighthouseTabs, UnlighthouseColumn[]>
   lhciHost: string
   lhciBuildToken: string
+  lhciAuth: string
 }>
diff --git a/packages/cli/src/types.ts b/packages/cli/src/types.ts
@@ -38,7 +38,7 @@ export interface CiOptions extends CliOptions {
   reporter?: ValidReportTypes | false
   lhciHost?: string
   lhciBuildToken?: string
-
+  lhciAuth?: string
 }
 
 export { UnlighthouseRouteReport }
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -144,6 +144,7 @@ export type ValidReportTypes = 'jsonSimple' | 'jsonExpanded' | 'lighthouseServer
 export interface ReporterConfig {
   lhciHost?: string
   lhciBuildToken?: string
+  lhciAuth?: string
 }
 
 /**