Merge pull request schickling#325 from addnab/master

Allow setting of `headers`

Author: schickling

README.md

@@ -157,6 +157,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)

docs/api.md

@@ -376,6 +376,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" />

src/api.ts

@@ -3,6 +3,7 @@ import ChromeRemote from './chrome/remote'
 import Queue from './queue'
 import {
   ChromelessOptions,
+  Headers,
   Cookie,
   CookieQuery,
   PdfOptions,
@@ -199,6 +200,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[]

src/chrome/local-runtime.ts

@@ -3,6 +3,7 @@ import {
   Client,
   Command,
   ChromelessOptions,
+  Headers,
   Cookie,
   CookieQuery,
   PdfOptions,
@@ -22,6 +23,7 @@ import {
   scrollTo,
   scrollToElement,
   setHtml,
+  setExtraHTTPHeaders,
   press,
   setViewport,
   clearCookies,
@@ -101,6 +103,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':
@@ -346,6 +350,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,

src/types.ts

@@ -132,6 +132,10 @@ export type Command =
       type: 'setHtml'
       html: string
     }
+  | {
+      type: 'setExtraHTTPHeaders'
+      headers: Headers
+    }
   | {
       type: 'press'
       keyCode: number
@@ -189,6 +193,8 @@ export type Command =
       files: string[]
     }
 
+export type Headers = Record<string, string>
+
 export interface Cookie {
   url?: string
   domain?: string

src/util.ts

@@ -2,14 +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'
 
@@ -370,6 +363,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,