Remove node specific checks and unblock running in workers (#899)

* fix node env checking

* remove node specific calls

* only set accept-encoding in non browser envs

* lint

* remove os package usage

Author: skarimo

.generator/src/generator/templates/common_index.j2

@@ -6,4 +6,3 @@ export { setServerVariables } from "./configuration"
 export { Configuration } from "./configuration"
 export * from "./exception";
 export * from "./servers";
-

.generator/src/generator/templates/configuration.j2

@@ -2,6 +2,7 @@ import { HttpLibrary, HttpConfiguration, RequestContext, ZstdCompressorCallback
 import { IsomorphicFetchHttpLibrary as DefaultHttpLibrary } from "./http/isomorphic-fetch";
 import { BaseServerConfiguration, server1, servers, operationServers } from "./servers";
 import { configureAuthMethods, AuthMethods, AuthMethodsConfiguration } from "./auth";
+import { isNode } from "./util";
 
 export interface Configuration {
   readonly baseServer?: BaseServerConfiguration;
@@ -68,7 +69,7 @@ export interface ConfigurationParameters {
  * @param conf partial configuration
  */
 export function createConfiguration(conf: ConfigurationParameters = {}): Configuration {
-  if (process !== undefined && process.env.DD_SITE) {
+  if (isNode && process.env.DD_SITE) {
     const serverConf = server1.getConfiguration();
     server1.setVariables({"site": process.env.DD_SITE} as (typeof serverConf));
     for (const op in operationServers) {
@@ -79,7 +80,7 @@ export function createConfiguration(conf: ConfigurationParameters = {}): Configu
   const authMethods = conf.authMethods || {};
   {%- for name, schema in openapi.components.securitySchemes.items()  %}
   {%- if schema.get("type") == "apiKey" and schema.get("in") == "header" %}
-  if (!("{{ name }}" in authMethods) && process !== undefined && process.env.{{ schema["x-env-name"] }}) {
+  if (!("{{ name }}" in authMethods) && isNode && process.env.{{ schema["x-env-name"] }}) {
     authMethods["{{ name }}"] = process.env.{{ schema["x-env-name"] }};
   }
   {%- endif %}

.generator/src/generator/templates/http/http.j2

@@ -2,6 +2,7 @@ import { userAgent } from "../../../userAgent";
 // TODO: evaluate if we can easily get rid of this library
 import FormData from "form-data";
 import URLParse from "url-parse";
+import { isBrowser } from "../util";
 
 /**
  * Interface for aborting fetch requests.
@@ -82,7 +83,7 @@ export interface HttpConfiguration {
  * Represents an HTTP request context
  */
 export class RequestContext {
-  private headers: { [key: string]: string } = { "user-agent": userAgent };
+  private headers: { [key: string]: string } = {};
   private body: RequestBody = undefined;
   private url: URLParse;
   private httpConfig: HttpConfiguration = {};
@@ -95,6 +96,9 @@ export class RequestContext {
    */
   public constructor(url: string, private httpMethod: HttpMethod) {
     this.url = new URLParse(url, true);
+    if (!isBrowser) {
+      this.headers = { "user-agent": userAgent };
+    }
   }
 
   /*

.generator/src/generator/templates/http/isomorphic-fetch.j2

@@ -2,6 +2,7 @@ import { HttpLibrary, RequestContext, ResponseContext, ZstdCompressorCallback }
 import fetch from "cross-fetch";
 import pako from "pako";
 import bufferFrom from "buffer-from";
+import { isBrowser } from "../util";
 
 export class IsomorphicFetchHttpLibrary implements HttpLibrary {
   public debug = false;
@@ -20,6 +21,7 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
     }
 
     const headers = request.getHeaders();
+
     if (typeof body === "string") {
       if (headers["Content-Encoding"] == "gzip") {
         body = bufferFrom(pako.gzip(body).buffer);
@@ -34,12 +36,14 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
       }
     }
 
-    if (!headers["Accept-Encoding"]) {
-      if (compress) {
-        headers["Accept-Encoding"] = "gzip,deflate";
-      } else {
-        // We need to enforce it otherwise node-fetch will set a default
-        headers["Accept-Encoding"] = "identity";
+    if (!isBrowser) {
+      if (!headers["Accept-Encoding"]) {
+        if (compress) {
+          headers["Accept-Encoding"] = "gzip,deflate";
+        } else {
+          // We need to enforce it otherwise node-fetch will set a default
+          headers["Accept-Encoding"] = "identity";
+        }
       }
     }
 

.generator/src/generator/templates/util.j2

@@ -14,3 +14,7 @@ export type AttributeTypeMap = {
     format?: string;
   };
 }
+
+export const isBrowser: boolean = typeof window !== "undefined" && typeof window.document !== "undefined";
+
+export const isNode: boolean = typeof process !== "undefined" && process.release.name === 'node';

logger.ts

@@ -1,6 +1,6 @@
 import log from "loglevel";
 
 const logger = log.noConflict();
-logger.setLevel((process !== undefined && process.env.DEBUG) ? logger.levels.DEBUG : logger.levels.INFO);
+logger.setLevel((typeof process !== "undefined" && process.release.name === 'node' && process.env.DEBUG) ? logger.levels.DEBUG : logger.levels.INFO);
 
 export { logger };

packages/datadog-api-client-common/configuration.ts

@@ -16,6 +16,7 @@ import {
   AuthMethods,
   AuthMethodsConfiguration,
 } from "./auth";
+import { isNode } from "./util";
 
 export interface Configuration {
   readonly baseServer?: BaseServerConfiguration;
@@ -83,7 +84,7 @@ export interface ConfigurationParameters {
 export function createConfiguration(
   conf: ConfigurationParameters = {}
 ): Configuration {
-  if (process !== undefined && process.env.DD_SITE) {
+  if (isNode && process.env.DD_SITE) {
     const serverConf = server1.getConfiguration();
     server1.setVariables({ site: process.env.DD_SITE } as typeof serverConf);
     for (const op in operationServers) {
@@ -92,18 +93,10 @@ export function createConfiguration(
   }
 
   const authMethods = conf.authMethods || {};
-  if (
-    !("apiKeyAuth" in authMethods) &&
-    process !== undefined &&
-    process.env.DD_API_KEY
-  ) {
+  if (!("apiKeyAuth" in authMethods) && isNode && process.env.DD_API_KEY) {
     authMethods["apiKeyAuth"] = process.env.DD_API_KEY;
   }
-  if (
-    !("appKeyAuth" in authMethods) &&
-    process !== undefined &&
-    process.env.DD_APP_KEY
-  ) {
+  if (!("appKeyAuth" in authMethods) && isNode && process.env.DD_APP_KEY) {
     authMethods["appKeyAuth"] = process.env.DD_APP_KEY;
   }
 

packages/datadog-api-client-common/http/http.ts

@@ -2,6 +2,7 @@ import { userAgent } from "../../../userAgent";
 // TODO: evaluate if we can easily get rid of this library
 import FormData from "form-data";
 import URLParse from "url-parse";
+import { isBrowser } from "../util";
 
 /**
  * Interface for aborting fetch requests.
@@ -82,7 +83,7 @@ export interface HttpConfiguration {
  * Represents an HTTP request context
  */
 export class RequestContext {
-  private headers: { [key: string]: string } = { "user-agent": userAgent };
+  private headers: { [key: string]: string } = {};
   private body: RequestBody = undefined;
   private url: URLParse;
   private httpConfig: HttpConfiguration = {};
@@ -95,6 +96,9 @@ export class RequestContext {
    */
   public constructor(url: string, private httpMethod: HttpMethod) {
     this.url = new URLParse(url, true);
+    if (!isBrowser) {
+      this.headers = { "user-agent": userAgent };
+    }
   }
 
   /*

packages/datadog-api-client-common/http/isomorphic-fetch.ts

@@ -7,6 +7,7 @@ import {
 import fetch from "cross-fetch";
 import pako from "pako";
 import bufferFrom from "buffer-from";
+import { isBrowser } from "../util";
 
 export class IsomorphicFetchHttpLibrary implements HttpLibrary {
   public debug = false;
@@ -25,6 +26,7 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
     }
 
     const headers = request.getHeaders();
+
     if (typeof body === "string") {
       if (headers["Content-Encoding"] == "gzip") {
         body = bufferFrom(pako.gzip(body).buffer);
@@ -39,12 +41,14 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
       }
     }
 
-    if (!headers["Accept-Encoding"]) {
-      if (compress) {
-        headers["Accept-Encoding"] = "gzip,deflate";
-      } else {
-        // We need to enforce it otherwise node-fetch will set a default
-        headers["Accept-Encoding"] = "identity";
+    if (!isBrowser) {
+      if (!headers["Accept-Encoding"]) {
+        if (compress) {
+          headers["Accept-Encoding"] = "gzip,deflate";
+        } else {
+          // We need to enforce it otherwise node-fetch will set a default
+          headers["Accept-Encoding"] = "identity";
+        }
       }
     }
 

packages/datadog-api-client-common/util.ts

@@ -13,3 +13,9 @@ export type AttributeTypeMap = {
     format?: string;
   };
 };
+
+export const isBrowser: boolean =
+  typeof window !== "undefined" && typeof window.document !== "undefined";
+
+export const isNode: boolean =
+  typeof process !== "undefined" && process.release.name === "node";