Merge pull request #325 from addnab/master

Allow setting of `headers`
schickling · Nov 3, 2017 · 219e34d · 219e34d
2 parents 6fca427 + 94b7a22
commit 219e34d
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -156,6 +156,7 @@ const chromeless = new Chromeless({
 - [`scrollTo(x: number, y: number)`](docs/api.md#api-scrollto)
 - [`scrollToElement(selector: string)`](docs/api.md#api-scrolltoelement)
 - [`setHtml(html: string)`](docs/api.md#api-sethtml)
+- [`setExtraHTTPHeaders(headers: Headers)`](docs/api.md#api-setextrahttpheaders)
 - [`setViewport(options: DeviceMetrics)`](docs/api.md#api-setviewport)
 - [`evaluate<U extends any>(fn: (...args: any[]) => void, ...args: any[])`](docs/api.md#api-evaluate)
 - [`inputValue(selector: string)`](docs/api.md#api-inputvalue)

diff --git a/docs/api.md b/docs/api.md
@@ -357,6 +357,26 @@ __Example__
 await chromeless.setHtml('<h1>Hello world!</h1>')
 ```
 
+  ---------------------------------------
+
+<a name="api-setextrahttpheaders" />
+
+### setExtraHTTPHeaders(headers: Headers): Chromeless<T>
+
+Sets extra HTTP headers.
+
+__Arguments__
+- `headers` - headers as keys / values of JSON object
+
+__Example__
+
+```js
+await chromeless.setExtraHTTPHeaders({
+  'accept-language': 'en-US,en;q=0.8'
+})
+```
+
+
 ---------------------------------------
 
 <a name="api-setviewport" />

diff --git a/src/api.ts b/src/api.ts
@@ -3,6 +3,7 @@ import ChromeRemote from './chrome/remote'
 import Queue from './queue'
 import {
   ChromelessOptions,
+  Headers,
   Cookie,
   CookieQuery,
   PdfOptions,
@@ -187,6 +188,12 @@ export default class Chromeless<T extends any> implements Promise<T> {
     return this
   }
 
+  setExtraHTTPHeaders(headers: Headers): Chromeless<T> {
+    this.queue.enqueue({ type: 'setExtraHTTPHeaders', headers })
+
+    return this
+  }
+
   evaluate<U extends any>(
     fn: (...args: any[]) => void,
     ...args: any[]

diff --git a/src/chrome/local-runtime.ts b/src/chrome/local-runtime.ts
@@ -2,6 +2,7 @@ import {
   Client,
   Command,
   ChromelessOptions,
+  Headers,
   Cookie,
   CookieQuery,
   PdfOptions,
@@ -21,6 +22,7 @@ import {
   scrollTo,
   scrollToElement,
   setHtml,
+  setExtraHTTPHeaders,
   press,
   setViewport,
   clearCookies,
@@ -96,6 +98,8 @@ export default class LocalRuntime {
         return this.clearCookies()
       case 'setHtml':
         return this.setHtml(command.html)
+      case 'setExtraHTTPHeaders':
+        return this.setExtraHTTPHeaders(command.headers)
       case 'cookies':
         return this.cookies(command.nameOrQuery)
       case 'allCookies':
@@ -293,6 +297,10 @@ export default class LocalRuntime {
     return await getAllCookies(this.client)
   }
 
+  async setExtraHTTPHeaders(headers: Headers): Promise<void> {
+    return await setExtraHTTPHeaders(this.client, headers)
+  }
+
   async setCookies(
     nameOrCookies: string | Cookie | Cookie[],
     value?: string,

diff --git a/src/types.ts b/src/types.ts
@@ -126,6 +126,10 @@ export type Command =
       type: 'setHtml'
       html: string
     }
+  | {
+      type: 'setExtraHTTPHeaders'
+      headers: Headers
+    }
   | {
       type: 'press'
       keyCode: number
@@ -179,6 +183,8 @@ export type Command =
       files: string[]
     }
 
+export type Headers = Record<string, string>
+
 export interface Cookie {
   url?: string
   domain?: string

diff --git a/src/util.ts b/src/util.ts
@@ -2,7 +2,7 @@ import * as fs from 'fs'
 import * as os from 'os'
 import * as path from 'path'
 import * as cuid from 'cuid'
-import { Client, Cookie, DeviceMetrics, PdfOptions, BoxModel, Viewport } from './types'
+import { Client, Cookie, DeviceMetrics, PdfOptions, BoxModel, Viewport, Headers } from './types'
 import * as CDP from 'chrome-remote-interface'
 import * as AWS from 'aws-sdk'
 
@@ -362,6 +362,14 @@ export async function setCookies(
   }
 }
 
+export async function setExtraHTTPHeaders(
+  client: Client,
+  headers: Headers,
+): Promise<void> {
+  const { Network } = client
+  await Network.setExtraHTTPHeaders({ headers })
+}
+
 export async function mousedown(
   client: Client,
   selector: string,