chore!: update env variables to avoid naming misunderstanding (Issue #…

…427) (#310)
epam · Jan 4, 2024 · e77f268 · e77f268
1 parent ab0b0ae
commit e77f268
Show file tree

Hide file tree

Showing 11 changed files with 155 additions and 94 deletions.
diff --git a/.env.development b/.env.development
@@ -1,7 +1,7 @@
-# OpenAI keys
-OPENAI_API_HOST=""
-OPENAI_API_KEY=""
-OPENAI_API_VERSION="2023-03-15-preview"
+# Dial environment variables
+DIAL_API_HOST=""
+DIAL_API_KEY=""
+DIAL_API_VERSION="2023-03-15-preview"
 
 # App Settings
 APP_BASE_PATH=""
@@ -86,10 +86,10 @@ THEMES_CONFIG_HOST=""
 FOOTER_HTML_MESSAGE="For API access please fill&nbsp;<a href="#requestApiKey"><u><strong>this form</strong></u></a>.&nbsp;If you have a problem please&nbsp;<a href="#reportAnIssue"><u><strong>report an issue</strong></u></a>. Version %%VERSION%%"
 AZURE_FUNCTIONS_API_HOST=""
 
-## Report issue modal
+## Report issue modal code
 REPORT_ISSUE_CODE=""
 
-## Request API Key code
+## Request API Key modal code
 REQUEST_API_KEY_CODE=""
 
 ## Warning regarding code generation

diff --git a/.github/pr-title-checker-config.json b/.github/pr-title-checker-config.json
@@ -4,7 +4,7 @@
     "color": "EEEEEE"
   },
   "CHECKS": {
-    "prefixes": ["fix: ", "feat: ", "feature: ", "chore: ", "hotfix: ", "e2e: "]
+    "prefixes": ["fix: ", "feat: ", "feature: ", "chore: ", "hotfix: ", "e2e: ", "fix!: ", "feat!: ", "feature!: ", "chore!: ", "hotfix!: "]
   },
   "MESSAGES": {
     "success": "All OK",

diff --git a/README.md b/README.md
diff --git a/environment.d.ts b/environment.d.ts
@@ -3,11 +3,73 @@ export {};
 declare global {
   namespace NodeJS {
     interface ProcessEnv {
-      OPENAI_API_KEY: string;
-      OPENAI_API_HOST: string;
-      OPENAI_API_VERSION?: string;
+      DIAL_API_KEY: string;
+      DIAL_API_HOST: string;
 
+      DIAL_API_VERSION?: string;
+      APP_BASE_PATH?: string;
+      APP_BASE_ORIGIN?: string;
+      ALLOWED_IFRAME_ORIGINS?: string;
+      IS_IFRAME?: string;
+      ENABLED_FEATURES?: string;
+      NEXT_PUBLIC_APP_NAME?: string;
+      NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT?: string;
+      NEXT_PUBLIC_DEFAULT_TEMPERATURE?: string;
+      DEFAULT_MODEL?: string;
+      DEFAULT_ASSISTANT_SUB_MODEL?: string;
+      RECENT_MODELS_IDS?: string;
+      RECENT_ADDONS_IDS?: string;
+      E2E_HOST?: string;
+      E2E_USERNAME?: string;
+      E2E_PASSWORD?: string;
       TRACES_URL?: string;
+      TMS_URL?: string;
+      ISSUE_URL?: string;
+      THEMES_CONFIG_HOST?: string;
+      FOOTER_HTML_MESSAGE?: string;
+      ANNOUNCEMENT_HTML_MESSAGE?: string;
+      AZURE_FUNCTIONS_API_HOST?: string;
+      REPORT_ISSUE_CODE?: string;
+      REQUEST_API_KEY_CODE?: string;
+      CODE_GENERATION_WARNING?: string;
+      SHOW_TOKEN_SUB?: string;
+      STORAGE_TYPE?: string;
+      TRACES_URL?: string;
+
+      AUTH_DISABLED?: string;
+      NEXTAUTH_URL?: string;
+      NEXTAUTH_SECRET?: string;
+      AUTH_TEST_TOKEN?: string;
+      AUTH_AUTH0_AUDIENCE?: string;
+      AUTH_AUTH0_CLIENT_ID?: string;
+      AUTH_AUTH0_HOST?: string;
+      AUTH_AUTH0_NAME?: string;
+      AUTH_AUTH0_SECRET?: string;
+      AUTH_AUTH0_SCOPE?: string;
+      AUTH_AZURE_AD_CLIENT_ID?: string;
+      AUTH_AZURE_AD_NAME?: string;
+      AUTH_AZURE_AD_SECRET?: string;
+      AUTH_AZURE_AD_TENANT_ID?: string;
+      AUTH_AZURE_AD_SCOPE?: string;
+      AUTH_GITLAB_CLIENT_ID?: string;
+      AUTH_GITLAB_HOST?: string;
+      AUTH_GITLAB_NAME?: string;
+      AUTH_GITLAB_SECRET?: string;
+      AUTH_GITLAB_SCOPE?: string;
+      AUTH_GOOGLE_CLIENT_ID?: string;
+      AUTH_GOOGLE_NAME?: string;
+      AUTH_GOOGLE_SECRET?: string;
+      AUTH_GOOGLE_SCOPE?: string;
+      AUTH_KEYCLOAK_CLIENT_ID?: string;
+      AUTH_KEYCLOAK_HOST?: string;
+      AUTH_KEYCLOAK_NAME?: string;
+      AUTH_KEYCLOAK_SECRET?: string;
+      AUTH_KEYCLOAK_SCOPE?: string;
+      AUTH_PING_ID_CLIENT_ID?: string;
+      AUTH_PING_ID_HOST?: string;
+      AUTH_PING_ID_NAME?: string;
+      AUTH_PING_ID_SECRET?: string;
+      AUTH_PING_ID_SCOPE?: string;
     }
   }
 }
diff --git a/src/constants/default-settings.ts b/src/constants/default-settings.ts
@@ -3,17 +3,16 @@ import { OpenAIEntityModelID, OpenAIEntityModels } from '@/src/types/openai';
 export const DEFAULT_SYSTEM_PROMPT =
   process.env.NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT ?? '';
 
-export const OPENAI_API_HOST =
-  process.env.OPENAI_API_HOST || 'https://api.openai.com';
+export const DIAL_API_HOST = process.env.DIAL_API_HOST;
 
 export const DEFAULT_TEMPERATURE = parseFloat(
   process.env.NEXT_PUBLIC_DEFAULT_TEMPERATURE || '1',
 );
 
 export const DEFAULT_CONVERSATION_NAME = 'New conversation';
 
-export const OPENAI_API_VERSION =
-  process.env.OPENAI_API_VERSION || '2023-03-15-preview';
+export const DIAL_API_VERSION =
+  process.env.DIAL_API_VERSION || '2023-03-15-preview';
 
 export const DEFAULT_ASSISTANT_SUBMODEL =
   OpenAIEntityModels[OpenAIEntityModelID.GPT_4];
diff --git a/src/pages/api/files/file/[...slug].ts b/src/pages/api/files/file/[...slug].ts
@@ -64,7 +64,7 @@ async function handlePutRequest(
   if (!slugs || slugs.length === 0) {
     throw new OpenAIError('No file path provided', '', '', '400');
   }
-  const url = `${process.env.OPENAI_API_HOST}/v1/files/${encodeURI(
+  const url = `${process.env.DIAL_API_HOST}/v1/files/${encodeURI(
     slugs.join('/'),
   )}`;
   const proxyRes = await fetch(url, {
@@ -101,7 +101,7 @@ async function handleGetRequest(
   if (!slugs || slugs.length === 0) {
     throw new OpenAIError('No file path provided', '', '', '400');
   }
-  const url = `${process.env.OPENAI_API_HOST}/v1/files/${encodeURI(
+  const url = `${process.env.DIAL_API_HOST}/v1/files/${encodeURI(
     slugs.join('/'),
   )}`;
   const proxyRes = await fetch(url, {
@@ -134,7 +134,7 @@ async function handleDeleteRequest(
   if (!slugs || slugs.length === 0) {
     throw new OpenAIError('No file path provided', '', '', '400');
   }
-  const url = `${process.env.OPENAI_API_HOST}/v1/files/${encodeURI(
+  const url = `${process.env.DIAL_API_HOST}/v1/files/${encodeURI(
     slugs.join('/'),
   )}`;
 

diff --git a/src/pages/api/files/listing.ts b/src/pages/api/files/listing.ts
@@ -35,7 +35,7 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) => {
 
     const token = await getToken({ req });
 
-    const url = `${process.env.OPENAI_API_HOST}/v1/files/metadata/${bucket}${
+    const url = `${process.env.DIAL_API_HOST}/v1/files/metadata/${bucket}${
       path && `/${encodeURI(path)}`
     }/`;
 

diff --git a/src/pages/api/rate.ts b/src/pages/api/rate.ts
@@ -8,7 +8,7 @@ import { logger } from '@/src/utils/server/logger';
 
 import { RateBody } from '../../types/chat';
 
-import { OPENAI_API_HOST } from '@/src/constants/default-settings';
+import { DIAL_API_HOST } from '@/src/constants/default-settings';
 import { errorsMessages } from '@/src/constants/errors';
 
 import { authOptions } from './auth/[...nextauth]';
@@ -30,7 +30,7 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) => {
       return res.status(400).send(errorsMessages[400]);
     }
 
-    const url = `${OPENAI_API_HOST}/v1/${modelId}/rate`;
+    const url = `${DIAL_API_HOST}/v1/${modelId}/rate`;
     const token = await getToken({ req });
 
     await fetch(url, {

diff --git a/src/utils/server/get-entities.ts b/src/utils/server/get-entities.ts
@@ -1,8 +1,8 @@
 import { EntityType } from '@/src/types/common';
 
 import {
-  OPENAI_API_HOST,
-  OPENAI_API_VERSION,
+  DIAL_API_HOST,
+  DIAL_API_VERSION,
 } from '../../constants/default-settings';
 
 import { getApiHeaders } from './get-headers';
@@ -14,7 +14,7 @@ export async function getEntities<T>(
   jwt: string,
   jobTitle: string | undefined,
 ): Promise<T> {
-  const url = `${OPENAI_API_HOST}/openai/${type}s?api-version=${OPENAI_API_VERSION}`;
+  const url = `${DIAL_API_HOST}/openai/${type}s?api-version=${DIAL_API_VERSION}`;
   const errMsg = `Request for ${type}s returned an error`;
   const response = await fetch(url, {
     headers: getApiHeaders({ jwt, jobTitle }),

diff --git a/src/utils/server/get-headers.ts b/src/utils/server/get-headers.ts
@@ -17,7 +17,7 @@ export const getApiHeaders = ({
   if (jwt) {
     headers['authorization'] = 'Bearer ' + jwt;
   } else if (process.env.AUTH_DISABLED === 'true') {
-    headers['Api-Key'] = process.env.OPENAI_API_KEY;
+    headers['Api-Key'] = process.env.DIAL_API_HOST;
   }
 
   if (jobTitle) {

diff --git a/src/utils/server/index.ts b/src/utils/server/index.ts
@@ -8,8 +8,8 @@ import {
 
 import {
   DEFAULT_ASSISTANT_SUBMODEL,
-  OPENAI_API_HOST,
-  OPENAI_API_VERSION,
+  DIAL_API_HOST,
+  DIAL_API_VERSION,
 } from '../../constants/default-settings';
 import { errorsMessages } from '@/src/constants/errors';
 
@@ -42,10 +42,10 @@ function getUrl(
   isAddonsAdded: boolean,
 ): string {
   if (modelType === EntityType.Model && isAddonsAdded) {
-    return `${OPENAI_API_HOST}/openai/deployments/assistant/chat/completions?api-version=${OPENAI_API_VERSION}`;
+    return `${DIAL_API_HOST}/openai/deployments/assistant/chat/completions?api-version=${DIAL_API_VERSION}`;
   }
 
-  return `${OPENAI_API_HOST}/openai/deployments/${modelId}/chat/completions?api-version=${OPENAI_API_VERSION}`;
+  return `${DIAL_API_HOST}/openai/deployments/${modelId}/chat/completions?api-version=${DIAL_API_VERSION}`;
 }
 
 const encoder = new TextEncoder();