chore: add readme section for backend url and use in llm analysis (fabric8-analytics#853)

Author: Strum355

README.md

@@ -92,6 +92,10 @@ The Red Hat Dependency Analytics extension has some configurable parameters that
 
 ### Configurable parameters
 
+#### Exhort backend URL
+
+Specify the URL of the Exhort backend used to analyze project dependencies. The default URL is https://rhda.rhcloud.com.
+
 #### Red Hat Dependency Analytics Report File Path:
 Specify the local path to create the Red Hat Dependency Analytics report file.
 The default path is `/tmp/redhatDependencyAnalyticsReport.html`.

src/config.ts

@@ -63,6 +63,8 @@ class Config {
   private readonly DEFAULT_SKOPEO_EXECUTABLE = 'skopeo';
   private readonly DEFAULT_DOCKER_EXECUTABLE = 'docker';
   private readonly DEFAULT_PODMAN_EXECUTABLE = 'podman';
+  private readonly DEFAULT_EXHORT_DEV_URL = 'https://exhort.stage.devshift.net';
+  private readonly DEFAULT_EXHORT_PROD_URL = 'https://rhda.rhcloud.com';
 
   /**
    * Creates an instance of the Config class.
@@ -95,11 +97,13 @@ class Config {
     const redhatPreferGradleWrapper = vscode.workspace.getConfiguration('java.import.gradle.wrapper').get('enabled', true);
     const preferGradleWrapper = rhdaPreferGradleWrapper === 'fallback' ? redhatPreferGradleWrapper : rhdaPreferGradleWrapper === 'true';
 
+    const defaultBackendUrl = process.env['TRUSTIFY_DA_DEV_MODE'] === 'true' ? this.DEFAULT_EXHORT_DEV_URL : this.DEFAULT_EXHORT_PROD_URL;
+
     this.stackAnalysisCommand = commands.STACK_ANALYSIS_COMMAND;
     this.trackRecommendationAcceptanceCommand = commands.TRACK_RECOMMENDATION_ACCEPTANCE_COMMAND;
     this.recommendationsEnabled = rhdaConfig.recommendations.enabled;
     this.utmSource = GlobalState.UTM_SOURCE;
-    this.backendUrl = rhdaConfig.backendUrl || this.DEFAULT_BACKEND_URL;
+    this.backendUrl = rhdaConfig.backendUrl || defaultBackendUrl;
     this.exhortProxyUrl = this.getEffectiveHttpProxyUrl();
     /* istanbul ignore next */
     this.matchManifestVersions = rhdaConfig.matchManifestVersions ? 'true' : 'false';

src/llmAnalysis.ts

@@ -1,3 +1,5 @@
+import { globalConfig } from './config';
+
 /* eslint-disable @typescript-eslint/naming-convention */
 export interface ListModelCardResponse {
     id: string,
@@ -56,9 +58,6 @@ export interface ModelCardResponse {
     }[]
 }
 
-export const exhortDevDefaultUrl = 'https://exhort.stage.devshift.net';
-export const exhortDefaultUrl = 'https://rhda.rhcloud.com';
-
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export async function llmAnalysis(models: string[]): Promise<ListModelCardResponse[] | undefined> {
     const reqBody = JSON.stringify({
@@ -69,7 +68,7 @@ export async function llmAnalysis(models: string[]): Promise<ListModelCardRespon
         })
     });
 
-    const resp = await fetch(`${selectExhortBackend()}/api/v4/model-cards/`, {
+    const resp = await fetch(`${globalConfig.backendUrl}/api/v4/model-cards/`, {
         method: 'POST',
         body: reqBody,
     });
@@ -81,16 +80,10 @@ export async function llmAnalysis(models: string[]): Promise<ListModelCardRespon
 }
 
 export async function llmAnalysisDetails(modelID: string): Promise<ModelCardResponse | undefined> {
-    const resp = await fetch(`${selectExhortBackend()}/api/v4/model-cards/${modelID}`);
+    const resp = await fetch(`${globalConfig.backendUrl}/api/v4/model-cards/${modelID}`);
     if (!resp.ok) {
         return undefined;
     }
     return resp.json() as Promise<ModelCardResponse>;
 }
 
-function selectExhortBackend() {
-    if (process.env['TRUSTIFY_DA_DEV_MODE'] === 'true') {
-        return exhortDevDefaultUrl;
-    }
-    return exhortDefaultUrl;
-}