Stop using chrome.webRequest.onSendHeaders

scripts/brave_rewards/publisher/common/XHREvents.ts

@@ -0,0 +1,48 @@
+export class Headers {[name: string] : string}
+
+export function makeEvent<T>(eventName: string, args: T) {
+  return new CustomEvent<T>(
+    eventName,
+    {detail: args}
+  )
+}
+
+export function subscribe<T>(eventName: string, callback: (args: T) => void) {
+  addEventListener(eventName, (e: CustomEvent<T>) => callback(e?.detail))
+}
+
+
+export class HeadersHandlerMessageEvent {
+  static eventName = 'header-handler-message'
+  url?: string;
+  headers: Headers;
+
+  static makeEvent(args: HeadersHandlerMessageEvent) {
+    return new CustomEvent<HeadersHandlerMessageEvent>(
+      this.eventName,
+      {detail: args}
+    )
+  }
+
+  static subscribe(callback: (args: HeadersHandlerMessageEvent) => void) {
+    addEventListener(this.eventName,
+    (e: CustomEvent<HeadersHandlerMessageEvent>) => callback(e?.detail))
+  }
+}
+
+export class RegisterHeadersHandlerEvent{
+  urlPattern?: string;
+  static eventName = 'register-header-handler'
+
+  static makeEvent(args: RegisterHeadersHandlerEvent) {
+    return new CustomEvent<RegisterHeadersHandlerEvent>(
+      this.eventName,
+      {detail: args}
+    )
+  }
+
+  static subscribe<T>(callback: (args: RegisterHeadersHandlerEvent) => void) {
+    addEventListener(this.eventName,
+    (e: CustomEvent<RegisterHeadersHandlerEvent>) => callback(e?.detail))
+  }
+}

scripts/brave_rewards/publisher/common/XHRInterceptor.ts

@@ -0,0 +1,53 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at https://mozilla.org/MPL/2.0/. */
+
+ import {HeadersHandlerMessageEvent, RegisterHeadersHandlerEvent} from '../common/XHREvents'
+
+let headerProcessUrlPattern: RegExp | undefined;
+class CustomXMLHttpRequest extends XMLHttpRequest {
+  headers: {[header: string]: string} = {}
+  url: string | undefined;
+
+  override open(method: string, url: string | URL): void;
+  override open(
+      method: string, url: string | URL, isAsync: boolean,
+      username?: any): void;
+  override open(
+      method: string, url: string | URL, isAsync?: boolean,
+      username?: any,
+      password?: any): void {
+
+    this.url = url instanceof URL ? url.toString() : url
+    const realAsync = isAsync ? isAsync : true;
+    super.open(method, url, realAsync, username, password);
+  }
+
+  override setRequestHeader(name: string, value: string): void {
+    this.headers[name] = value
+    super.setRequestHeader(name, value)
+  }
+
+  override send(body?: any): void {
+    if (!headerProcessUrlPattern || !this.url || this.url.search(headerProcessUrlPattern) >= 0) {
+      window.dispatchEvent(HeadersHandlerMessageEvent.makeEvent(
+        {url: this.url, headers: this.headers}))
+    }
+    super.send(body)
+  }
+}
+
+const initHeadersHandler = (urlPattern?: string) => {
+  XMLHttpRequest = CustomXMLHttpRequest
+  headerProcessUrlPattern = urlPattern ? new RegExp(urlPattern) : undefined
+}
+
+
+export const initScript = () => {
+  RegisterHeadersHandlerEvent.subscribe((e) => {
+    const urlPattern = e.urlPattern
+    initHeadersHandler(urlPattern)
+  })
+}
+
+initScript()

scripts/brave_rewards/publisher/common/webRequestHandlers.ts

@@ -3,9 +3,9 @@
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { getPort } from '../common/messaging'
+import {HeadersHandlerMessageEvent, RegisterHeadersHandlerEvent} from '../common/XHREvents'
 
 let registeredOnCompletedWebRequestHandler = false
-let registeredOnSendHeadersWebRequest = false
 
 export const registerOnCompletedWebRequestHandler = (
   mediaType: string,
@@ -41,41 +41,12 @@ export const registerOnCompletedWebRequestHandler = (
   })
 }
 
-export const registerOnSendHeadersWebRequest = (
-  mediaType: string,
-  urlPatterns: string[],
-  extra: string[],
-  callback: (mediaType: string, details: any) => void
-) => {
-  if (!mediaType || registeredOnSendHeadersWebRequest) {
-    return
-  }
-
-  registeredOnSendHeadersWebRequest = true
-
-  const port = getPort()
-  if (!port) {
-    return
-  }
-
-  port.postMessage({
-    type: 'RegisterOnSendHeadersWebRequest',
-    mediaType,
-    data: {
-      urlPatterns,
-      extra
-    }
-  })
 
-  port.onMessage.addListener(function (msg: any) {
-    if (!msg.data) {
-      return
-    }
-    switch (msg.type) {
-      case 'OnSendHeadersWebRequest': {
-        callback(msg.mediaType, msg.data.details)
-        break
-      }
-    }
-  })
+export const registerHeadersHandler = (
+  urlPattern: string | undefined,
+  callback: (headers: any) => void
+) => {
+  HeadersHandlerMessageEvent.subscribe((e) => callback(e.headers))
+  console.log('send RegisterHeadersHandlerEvent')
+  dispatchEvent(RegisterHeadersHandlerEvent.makeEvent({urlPattern}))
 }

scripts/brave_rewards/publisher/twitter/auth.ts

@@ -16,14 +16,18 @@ const authTokenCookieRegex = /[; ]_twitter_sess=([^\s;]*)/
 
 let lastSessionId: SessionId = null
 
-let authHeaders: any = {}
+class AuthHeaders {
+  [header: string]: string;
+}
+
+let authHeaders: AuthHeaders = {}
 
-const readSessionCookie = (cookiesString: string): SessionId => {
-  if (!cookiesString) {
+const readSessionCookie = (): SessionId => {
+  if (!document.cookie) {
     return null
   }
 
-  const match = cookiesString.match(authTokenCookieRegex)
+  const match = document.cookie.match(authTokenCookieRegex)
   if (!match) {
     return null
   }
@@ -41,26 +45,27 @@ export const hasRequiredAuthHeaders = () => {
           (authHeaders['x-csrf-token'] && authHeaders['x-guest-token']))
 }
 
-export const processRequestHeaders = (requestHeaders: any[]) => {
+export const processRequestHeaders = (requestHeaders: {[header: string]: string}) => {
   if (!requestHeaders) {
     return false
   }
 
-  let headers = {}
+  let headers = new AuthHeaders()
 
-  for (const header of requestHeaders) {
+  const currentSessionId = readSessionCookie()
+  const hasAuthChanged = (currentSessionId !== lastSessionId)
+  if (hasAuthChanged) {
+    // Clear cached auth data when session changes
+    lastSessionId = currentSessionId
+    // TODO: why it was headers = {}?
+    authHeaders = {}
+  }
+  for (const name in requestHeaders) {
+    const value = requestHeaders[name]
     // Parse cookies for session id
-    if (header.name === 'Cookie') {
-      const currentSessionId = readSessionCookie(header.value as string)
-      const hasAuthChanged = (currentSessionId !== lastSessionId)
-      if (hasAuthChanged) {
-        // Clear cached auth data when session changes
-        lastSessionId = currentSessionId
-        headers = {}
-      }
-    } else if (authHeaderNames.includes(header.name) ||
-               header.name.startsWith('x-twitter-')) {
-      headers[header.name] = header.value
+    if (authHeaderNames.includes(name) ||
+               name.startsWith('x-twitter-')) {
+      headers[name] = value
     }
   }
 

scripts/brave_rewards/publisher/twitter/twitterBase.ts

@@ -11,12 +11,9 @@ import * as types from './types'
 import * as utils from '../common/utils'
 import * as webRequestHandlers from '../common/webRequestHandlers'
 
-const handleOnSendHeadersWebRequest = (mediaType: string, details: any) => {
-  if (mediaType !== types.mediaType || !details || !details.requestHeaders) {
-    return
-  }
-
-  if (auth.processRequestHeaders(details.requestHeaders)) {
+const handleHeaders = (headers: any) => {
+  console.log('handleHeaders', headers)
+  if (auth.processRequestHeaders(headers)) {
     publisherInfo.send()
   }
 }
@@ -59,12 +56,14 @@ const initScript = () => {
       }
     })
 
-    webRequestHandlers.registerOnSendHeadersWebRequest(
-      types.mediaType,
-      types.sendHeadersUrls,
-      types.sendHeadersExtra,
-      handleOnSendHeadersWebRequest)
-    tabHandlers.registerOnUpdatedTab(types.mediaType, handleOnUpdatedTab)
+    // TODO: remove the timeout when XHRInterceptor is injected automatically.
+    setTimeout( () => {
+      webRequestHandlers.registerHeadersHandler(
+        types.sendHeadersUrl,
+        handleHeaders)
+
+      tabHandlers.registerOnUpdatedTab(types.mediaType, handleOnUpdatedTab)
+    }, 5000);
   })
 
   console.info('Greaselion script loaded: twitterBase.ts')

scripts/brave_rewards/publisher/twitter/types.ts

@@ -6,5 +6,4 @@ export const mediaType = 'twitter'
 export const mediaDomain = 'twitter.com'
 
 export const baseApiUrl = 'https://api.' + location.hostname
-export const sendHeadersUrls = [baseApiUrl + '/1.1/*']
-export const sendHeadersExtra = ['requestHeaders', 'extraHeaders']
+export const sendHeadersUrl = baseApiUrl + '/1.1/*'

webpack.config.js

@@ -11,6 +11,7 @@ const rewardsDir = 'scripts/brave_rewards'
 const togetherDir = 'scripts/brave_talk'
 
 const allEntries = [
+  `${rewardsDir}/publisher/common/XHRInterceptor`,
   `${rewardsDir}/publisher/github/githubBase`,
   `${rewardsDir}/publisher/github/githubAutoContribution`,
   `${rewardsDir}/publisher/reddit/redditBase`,