Add proxy support to HttpStore for remote caches (attempt 3)

Summary:
Add HTTPS proxying support to `HttpStore`, for use by remote cache configurations.

```
 - **[Feature]**: Support `proxy` and `socketPath` in remote cache `HttpStore`
```

Reviewed By: GijsWeterings

Differential Revision: D73036895

fbshipit-source-id: 5c4bf8f39bd0dd41683fce3c90afab36f0075f00

Author: robhogan

flow-typed/npm/https-proxy-agent_v7.x.x.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ * @format
+ */
+
+declare module 'https-proxy-agent' {
+  type HttpHeaders = {[key: string]: string | Array<string>};
+
+  declare export type HttpsProxyAgentOptions = tls$connectOptions &
+    http$agentOptions & {
+      headers?: HttpHeaders | (() => HttpHeaders),
+      ...
+    };
+
+  declare export class HttpsProxyAgent extends http$Agent<net$Socket> {
+    static protocols: ['http', 'https'];
+    +proxy: URL;
+    proxyHeaders: HttpHeaders | (() => HttpHeaders);
+    connectOpts: tls$connectOptions;
+    constructor(proxy: string | URL, opts?: HttpsProxyAgentOptions): this;
+    connect(
+      req: http$requestOptions,
+      opts: http$agentOptions,
+    ): Promise<net$Socket>;
+  }
+}

packages/metro-cache/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "exponential-backoff": "^3.1.1",
     "flow-enums-runtime": "^0.0.6",
+    "https-proxy-agent": "^7.0.5",
     "metro-core": "0.82.1"
   },
   "devDependencies": {

packages/metro-cache/src/stores/HttpStore.js

@@ -10,15 +10,12 @@
 
 'use strict';
 
-import type {Agent as HttpAgent} from 'http';
-import type {Agent as HttpsAgent} from 'https';
-
 const HttpError = require('./HttpError');
 const NetworkError = require('./NetworkError');
 const {backOff} = require('exponential-backoff');
 const http = require('http');
 const https = require('https');
-const url = require('url');
+const {HttpsProxyAgent} = require('https-proxy-agent');
 const zlib = require('zlib');
 
 export type Options =
@@ -46,14 +43,16 @@ type EndpointOptions = {
   maxAttempts?: number,
   retryNetworkErrors?: boolean,
   retryStatuses?: $ReadOnlySet<number>,
+  socketPath?: string,
+  proxy?: string,
 };
 
 type Endpoint = {
   module: typeof http | typeof https,
   host: string,
   path: string,
   port: number,
-  agent: HttpAgent | HttpsAgent,
+  agent: http$Agent<tls$TLSSocket> | http$Agent<net$Socket>,
   params: URLSearchParams,
   headers?: {[string]: string},
   timeout: number,
@@ -92,7 +91,7 @@ class HttpStore<T> {
   }
 
   createEndpointConfig(options: EndpointOptions): Endpoint {
-    const agentConfig: http$agentOptions = {
+    const agentConfig = {
       family: options.family,
       keepAlive: true,
       keepAliveMsecs: options.timeout || 5000,
@@ -115,19 +114,29 @@ class HttpStore<T> {
       agentConfig.ca = options.ca;
     }
 
-    const uri = url.parse(options.endpoint);
+    if (options.socketPath != null) {
+      // $FlowFixMe `socketPath` is missing in the Flow definition
+      agentConfig.socketPath = options.socketPath;
+    }
+
+    const uri = new URL(options.endpoint);
     const module = uri.protocol === 'http:' ? http : https;
 
+    const agent =
+      options.proxy != null
+        ? new HttpsProxyAgent(options.proxy, agentConfig)
+        : new module.Agent(agentConfig);
+
     if (!uri.hostname || !uri.pathname) {
       throw new TypeError('Invalid endpoint: ' + options.endpoint);
     }
 
     return {
+      agent,
       headers: options.headers,
       host: uri.hostname,
       path: uri.pathname,
       port: +uri.port,
-      agent: new module.Agent(agentConfig),
       params: new URLSearchParams(options.params),
       timeout: options.timeout || 5000,
       module: uri.protocol === 'http:' ? http : https,

yarn.lock

@@ -1530,6 +1530,13 @@ acorn@^8.9.0:
   resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.10.0.tgz#8be5b3907a67221a81ab23c7889c4c5526b62ec5"
   integrity sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==
 
+agent-base@^7.0.2:
+  version "7.1.1"
+  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-7.1.1.tgz#bdbded7dfb096b751a2a087eeeb9664725b2e317"
+  integrity sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==
+  dependencies:
+    debug "^4.3.4"
+
 ajv@^6.12.4:
   version "6.12.6"
   resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4"
@@ -2133,6 +2140,13 @@ [email protected], debug@^2.6.9:
   dependencies:
     ms "2.0.0"
 
+debug@4:
+  version "4.3.7"
+  resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.7.tgz#87945b4151a011d76d95a198d7111c865c360a52"
+  integrity sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==
+  dependencies:
+    ms "^2.1.3"
+
 debug@^3.2.7:
   version "3.2.7"
   resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.7.tgz#72580b7e9145fb39b6676f9c5e5fb100b934179a"
@@ -3072,6 +3086,14 @@ html-escaper@^2.0.0:
   resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.0.tgz#71e87f931de3fe09e56661ab9a29aadec707b491"
   integrity sha512-a4u9BeERWGu/S8JiWEAQcdrg9v4QArtP9keViQjGMdff20fBdd8waotXaNmODqBe6uZ3Nafi7K/ho4gCQHV3Ig==
 
+https-proxy-agent@^7.0.5:
+  version "7.0.5"
+  resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz#9e8b5013873299e11fab6fd548405da2d6c602b2"
+  integrity sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==
+  dependencies:
+    agent-base "^7.0.2"
+    debug "4"
+
 human-signals@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0"