3.2.2 (#413)

* feat(config): add support for groq AI provider, including config validation and engine implementation (#381)

* fix migrations (#414)

---------

Co-authored-by: Takanori Matsumoto <matscube@gmail.com>
Co-authored-by: BILLY Maxime <ozeliurs@gmail.com>

src/commands/commit.ts

@@ -183,7 +183,11 @@ ${chalk.grey('——————————————————')}`
       }
     }
   } catch (error) {
-    commitGenerationSpinner.stop('📝 Commit message generated');
+    commitGenerationSpinner.stop(
+      `${chalk.red('✖')} Failed to generate the commit message`
+    );
+
+    console.log(error);
 
     const err = error as Error;
     outro(`${chalk.red('✖')} ${err?.message || err}`);

src/commands/config.ts

@@ -76,6 +76,16 @@ export const MODEL_LIST = {
     'gemini-1.0-pro',
     'gemini-pro-vision',
     'text-embedding-004'
+  ],
+
+  groq: [
+    'llama3-70b-8192', // Meta Llama 3 70B (default one, no daily token limit and 14 400 reqs/day)
+    'llama3-8b-8192', // Meta Llama 3 8B
+    'llama-guard-3-8b', // Llama Guard 3 8B
+    'llama-3.1-8b-instant', // Llama 3.1 8B (Preview)
+    'llama-3.1-70b-versatile', // Llama 3.1 70B (Preview)
+    'gemma-7b-it', // Gemma 7B
+    'gemma2-9b-it' // Gemma 2 9B
   ]
 };
 
@@ -87,6 +97,8 @@ const getDefaultModel = (provider: string | undefined): string => {
       return MODEL_LIST.anthropic[0];
     case 'gemini':
       return MODEL_LIST.gemini[0];
+    case 'groq':
+      return MODEL_LIST.groq[0];
     default:
       return MODEL_LIST.openai[0];
   }
@@ -241,9 +253,15 @@ export const configValidators = {
 
     validateConfig(
       CONFIG_KEYS.OCO_AI_PROVIDER,
-      ['openai', 'anthropic', 'gemini', 'azure', 'test', 'flowise'].includes(
-        value
-      ) || value.startsWith('ollama'),
+      [
+        'openai',
+        'anthropic',
+        'gemini',
+        'azure',
+        'test',
+        'flowise',
+        'groq'
+      ].includes(value) || value.startsWith('ollama'),
       `${value} is not supported yet, use 'ollama', 'anthropic', 'azure', 'gemini', 'flowise' or 'openai' (default)`
     );
 
@@ -288,7 +306,8 @@ export enum OCO_AI_PROVIDER_ENUM {
   GEMINI = 'gemini',
   AZURE = 'azure',
   TEST = 'test',
-  FLOWISE = 'flowise'
+  FLOWISE = 'flowise',
+  GROQ = 'groq'
 }
 
 export type ConfigType = {
@@ -352,7 +371,6 @@ export const DEFAULT_CONFIG = {
   OCO_AI_PROVIDER: OCO_AI_PROVIDER_ENUM.OPENAI,
   OCO_ONE_LINE_COMMIT: false,
   OCO_TEST_MOCK_TYPE: 'commit-message',
-  OCO_FLOWISE_ENDPOINT: ':',
   OCO_WHY: false,
   OCO_GITPUSH: true // todo: deprecate
 };
@@ -444,6 +462,25 @@ interface GetConfigOptions {
   setDefaultValues?: boolean;
 }
 
+const cleanUndefinedValues = (config: ConfigType) => {
+  return Object.fromEntries(
+    Object.entries(config).map(([_, v]) => {
+      try {
+        if (typeof v === 'string') {
+          if (v === 'undefined') return [_, undefined];
+          if (v === 'null') return [_, null];
+
+          const parsedValue = JSON.parse(v);
+          return [_, parsedValue];
+        }
+        return [_, v];
+      } catch (error) {
+        return [_, v];
+      }
+    })
+  );
+};
+
 export const getConfig = ({
   envPath = defaultEnvPath,
   globalPath = defaultConfigPath
@@ -453,7 +490,9 @@ export const getConfig = ({
 
   const config = mergeConfigs(envConfig, globalConfig);
 
-  return config;
+  const cleanConfig = cleanUndefinedValues(config);
+
+  return cleanConfig as ConfigType;
 };
 
 export const setConfig = (

src/engine/groq.ts

@@ -0,0 +1,10 @@
+import { OpenAiConfig, OpenAiEngine } from './openAi';
+
+interface GroqConfig extends OpenAiConfig {}
+
+export class GroqEngine extends OpenAiEngine {
+  constructor(config: GroqConfig) {
+    config.baseURL = 'https://api.groq.com/openai/v1';
+    super(config);
+  }
+}

src/engine/openAi.ts

@@ -4,7 +4,7 @@ import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitD
 import { tokenCount } from '../utils/tokenCount';
 import { AiEngine, AiEngineConfig } from './Engine';
 
-interface OpenAiConfig extends AiEngineConfig {}
+export interface OpenAiConfig extends AiEngineConfig {}
 
 export class OpenAiEngine implements AiEngine {
   config: OpenAiConfig;
@@ -12,7 +12,12 @@ export class OpenAiEngine implements AiEngine {
 
   constructor(config: OpenAiConfig) {
     this.config = config;
-    this.client = new OpenAI({ apiKey: config.apiKey });
+
+    if (!config.baseURL) {
+      this.client = new OpenAI({ apiKey: config.apiKey });
+    } else {
+      this.client = new OpenAI({ apiKey: config.apiKey, baseURL: config.baseURL });
+    }
   }
 
   public generateCommitMessage = async (

src/migrations/02_set_missing_default_values.ts

@@ -10,10 +10,12 @@ export default function () {
     const entriesToSet: [key: string, value: string | boolean | number][] = [];
     for (const entry of Object.entries(DEFAULT_CONFIG)) {
       const [key, _value] = entry;
-      if (config[key] === 'undefined') entriesToSet.push(entry);
+      if (config[key] === 'undefined' || config[key] === undefined)
+        entriesToSet.push(entry);
     }
 
     if (entriesToSet.length > 0) setConfig(entriesToSet);
+    console.log(entriesToSet);
   };
 
   setDefaultConfigValues(getGlobalConfig());

src/migrations/_run.ts

@@ -53,6 +53,7 @@ export const runMigrations = async () => {
             migration.name
           }: ${error}`
         );
+        process.exit(1);
       }
 
       isMigrated = true;

src/utils/engine.ts

@@ -7,6 +7,7 @@ import { GeminiEngine } from '../engine/gemini';
 import { OllamaEngine } from '../engine/ollama';
 import { OpenAiEngine } from '../engine/openAi';
 import { TestAi, TestMockType } from '../engine/testAi';
+import { GroqEngine } from '../engine/groq';
 
 export function getEngine(): AiEngine {
   const config = getConfig();
@@ -39,6 +40,9 @@ export function getEngine(): AiEngine {
     case OCO_AI_PROVIDER_ENUM.FLOWISE:
       return new FlowiseEngine(DEFAULT_CONFIG);
 
+    case OCO_AI_PROVIDER_ENUM.GROQ:
+      return new GroqEngine(DEFAULT_CONFIG);
+
     default:
       return new OpenAiEngine(DEFAULT_CONFIG);
   }