feat: Support URL objects (#598)

googleapis · Feb 1, 2024 · ef40c61 · ef40c61
1 parent 16dac84
commit ef40c61
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 9 deletions.
diff --git a/src/common.ts b/src/common.ts
@@ -147,9 +147,12 @@ export interface GaxiosOptions {
     options: GaxiosOptions,
     defaultAdapter: (options: GaxiosOptions) => GaxiosPromise<T>
   ) => GaxiosPromise<T>;
-  url?: string;
-  baseUrl?: string; // deprecated
-  baseURL?: string;
+  url?: string | URL;
+  /**
+   * @deprecated
+   */
+  baseUrl?: string;
+  baseURL?: string | URL;
   method?:
     | 'GET'
     | 'HEAD'
@@ -395,7 +398,8 @@ export function defaultErrorRedactor<T = any>(data: {
     redactObject(data.config.body);
 
     try {
-      const url = new URL(data.config.url || '');
+      const url = new URL('', data.config.url);
+
       if (url.searchParams.has('token')) {
         url.searchParams.set('token', REDACT);
       }

diff --git a/src/gaxios.ts b/src/gaxios.ts
@@ -79,13 +79,13 @@ function loadProxy() {
 
 loadProxy();
 
-function skipProxy(url: string) {
+function skipProxy(url: string | URL) {
   const noProxyEnv = process.env.NO_PROXY ?? process.env.no_proxy;
   if (!noProxyEnv) {
     return false;
   }
   const noProxyUrls = noProxyEnv.split(',');
-  const parsedURL = new URL(url);
+  const parsedURL = url instanceof URL ? url : new URL(url);
   return !!noProxyUrls.find(url => {
     if (url.startsWith('*.') || url.startsWith('.')) {
       url = url.replace(/^\*\./, '.');
@@ -98,7 +98,7 @@ function skipProxy(url: string) {
 
 // Figure out if we should be using a proxy. Only if it's required, load
 // the https-proxy-agent module as it adds startup cost.
-function getProxy(url: string) {
+function getProxy(url: string | URL) {
   // If there is a match between the no_proxy env variables and the url, then do not proxy
   if (skipProxy(url)) {
     return undefined;
@@ -239,7 +239,7 @@ export class Gaxios {
     // baseUrl has been deprecated, remove in 2.0
     const baseUrl = opts.baseUrl || opts.baseURL;
     if (baseUrl) {
-      opts.url = baseUrl + opts.url;
+      opts.url = baseUrl.toString() + opts.url;
     }
 
     opts.paramsSerializer = opts.paramsSerializer || this.paramsSerializer;
@@ -248,7 +248,7 @@ export class Gaxios {
       if (additionalQueryParams.startsWith('?')) {
         additionalQueryParams = additionalQueryParams.slice(1);
       }
-      const prefix = opts.url.includes('?') ? '&' : '?';
+      const prefix = opts.url.toString().includes('?') ? '&' : '?';
       opts.url = opts.url + prefix + additionalQueryParams;
     }
 

diff --git a/test/test.getch.ts b/test/test.getch.ts
@@ -136,6 +136,13 @@ describe('🚙 error handling', () => {
 });
 
 describe('🥁 configuration options', () => {
+  it('should accept URL objects', async () => {
+    const scope = nock(url).get('/').reply(204);
+    const res = await request({url: new URL(url)});
+    scope.done();
+    assert.strictEqual(res.config.method, 'GET');
+  });
+
   it('should use options passed into the constructor', async () => {
     const scope = nock(url).head('/').reply(200);
     const inst = new Gaxios({method: 'HEAD'});