refactor: project structure change (#3)

* chore: structural refactoring

* chore: docs updated

Author: rjoydip

.gitignore

@@ -15,13 +15,6 @@ logs
 _.log
 report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
 
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
 # caches
 .eslintcache
 .cache
@@ -34,4 +27,5 @@ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
 .DS_Store
 
 # Wrangler 
-.wrangler
+.wrangler
+*.vars

README.md

@@ -49,3 +49,22 @@ flowchart TD
     LAB --> API
     ML --> AI
 ```
+
+## TODO
+
+- [x] Webhook security
+  - [x] Github
+  - [x] Gitlab
+  - [x] JIRA
+- [x] Unit testing
+  - [x] AI
+  - [x] Config
+  - [x] Service
+  - [x] Types
+  - [x] Utils
+  - [x] Webhook
+  - [x] Worker
+- [x] Integrations
+  - [x] Github
+  - [x] Gitlab
+  - [x] JIRA

bun.lock

@@ -1,6 +1,6 @@
 {
     "name": "labelit.ai",
-    "version": "0.0.0",
+    "version": "0.0.1",
     "workspaces": [
         "packages/*",
         "integrations/*"
@@ -10,12 +10,10 @@
         "build": "bun run --filter './packages/*' build",
         "lint": "bun run --filter './packages/*' lint",
         "test": "bun run --filter './packages/*' test",
-        "typecheck": "bun run --filter './packages/*' typecheck"
+        "typecheck": "bun run --filter './packages/*' typecheck",
+        "update": "bun run --filter './packages/*' update --ignore-scripts --no-progress --no-summary"
     },
     "devDependencies": {
         "husky": "^9.1.7"
-    },
-    "peerDependencies": {
-        "typescript": "^5.7.3"
     }
 }

package.json

@@ -7,22 +7,26 @@
     },
     "./processor": {
       "default": "./src/processor.ts"
+    },
+    "./prompts": {
+      "default": "./src/prompts.ts"
     }
   },
   "main": "./src/index.ts",
   "scripts": {
     "lint": "eslint . --fix",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "update": "bun update"
   },
   "dependencies": {
     "@labelit/config": "workspace:*",
-    "ai": "^4.1.46",
-    "workers-ai-provider": "^0.1.1"
+    "ai": "^4.2.2",
+    "workers-ai-provider": "^0.1.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.3.0",
+    "@antfu/eslint-config": "^4.11.0",
     "@labelit/types": "workspace:*",
-    "eslint": "^9.21.0",
-    "typescript": "^5.7.3"
+    "eslint": "^9.23.0",
+    "typescript": "^5.8.2"
   }
 }

packages/ai/package.json

@@ -1,63 +1,44 @@
-import type { Bindings } from '@labelit/types/basic'
-import type { ProcessedTicket, TicketData } from '@labelit/types/ticket'
+import type { Env } from '@labelit/types'
+import type { ClassificationType, PromptResponse } from '@labelit/types/basic'
 import type { LanguageModelV1 } from 'ai'
-import { ENV } from '@labelit/config/environment'
 import { generateText } from 'ai'
 import { createWorkersAI } from 'workers-ai-provider'
 
-export class AIProcessor {
+export abstract class AIProcessor<T> {
   private model: LanguageModelV1
-  private systemPrompt: string
 
-  constructor(env: Bindings) {
+  constructor(env: Env) {
     const workersai = createWorkersAI({ binding: env.AI })
-    this.model = workersai(ENV.MODEL_NAME, {
+    this.model = workersai(env.MODEL_NAME, {
       safePrompt: true,
     })
-    this.systemPrompt = `
-      You are a ticket classification system. Classify tickets as either Bug, Story, Task, or Spike.
-
-      - Bugs: Issues or unexpected behavior
-      - Stories: User-facing features
-      - Tasks: Technical work items
-      - Spikes: Research or exploration items
-    
-      Respond only with the classification label.
-    `
   }
 
-  public async classifyTicket(ticket: TicketData): Promise<ProcessedTicket | Error> {
+  public async classify<TContent>(content: TContent, prompt: PromptResponse): Promise<ClassificationType> {
     const startTime = Date.now()
-    const userContent = `Title: ${ticket.title}\nDescription: ${ticket.description}`
 
     const { text } = await generateText({
       model: this.model,
       messages: [{
         role: 'system',
-        content: this.systemPrompt,
+        content: prompt.system,
       }, {
         role: 'user',
-        content: userContent,
+        content: prompt.user,
+      }, {
+        role: 'data',
+        content: typeof content === 'string' ? content : JSON.stringify(content),
       }],
     })
 
-    const result: ProcessedTicket = {
-      ...ticket,
-      predictedLabel: this.parseResponse(text),
+    const result: ClassificationType = {
+      text,
       processingTime: Date.now() - startTime,
     }
 
     return result
   }
 
-  private parseResponse(response: string): ProcessedTicket['predictedLabel'] {
-    const normalized = response.trim().toLowerCase()
-    if (normalized.includes('bug'))
-      return 'Bug'
-    if (normalized.includes('story'))
-      return 'Story'
-    if (normalized.includes('spike'))
-      return 'Spike'
-    return 'Task'
-  }
+  public abstract preparePrompt<P>(payload: P): PromptResponse
+  public abstract parseResponse(result: ClassificationType): T
 }

packages/ai/src/processor.ts

@@ -0,0 +1,83 @@
+export const issuePrompt = `
+ You are an advanced AI issue classification system. Your goal is to provide comprehensive and accurate ticket classification.
+
+      Classification Categories:
+
+      1. Primary Types:
+      - Bug: Unexpected behavior, system malfunction, or error
+        * Severity levels: Critical, High, Medium, Low
+        * Impact: System-wide, Feature-specific, Minor
+
+      - Story: User-facing feature or enhancement
+        * Types: 
+          * New Feature
+          * Feature Enhancement
+          * User Experience Improvement
+        * Complexity: Simple, Medium, Complex
+
+      - Task: Technical work item
+        * Categories:
+          * Refactoring
+          * Technical Debt
+          * Infrastructure
+          * DevOps
+          * Configuration
+        * Priority: High, Medium, Low
+
+      - Spike: Research or exploration
+        * Purpose:
+          * Technical Investigation
+          * Proof of Concept
+          * Architecture Exploration
+          * Technology Evaluation
+        * Duration: Short-term, Medium-term, Long-term
+
+      2. Additional Classification Dimensions:
+      - Impact Area: 
+        * Frontend
+        * Backend
+        * Database
+        * Infrastructure
+        * Security
+        * Performance
+
+      - Origin:
+        * Customer Reported
+        * Internal Discovery
+        * Proactive Improvement
+        * Regression
+
+      Evaluation Criteria:
+      - Analyze title and description comprehensively
+      - Consider implied complexity and effort
+      - Assess potential system-wide implications
+`
+export const prPrompt = `
+    You are an advanced AI pull request classifier. Your task is to provide a comprehensive analysis of pull requests.
+
+      Classification Labels:
+      1. Risk Categories:
+        - Low Risk: Minor changes, no critical system impact
+        - Medium Risk: Moderate changes, potential minor system effects
+        - High Risk: Significant changes, potential major system impacts
+
+      2. Change Types:
+        - Refactoring: Code restructuring without changing external behavior
+        - Testing: Adds or improves test coverage
+        - Feature: New functionality
+        - Bugfix: Resolves existing issues
+        - Performance: Optimization of existing code
+        - Security: Addresses security vulnerabilities
+
+      3. Complexity Indicators:
+        - Cyclomatic Complexity
+        - Number of changed files
+        - Lines of code added/removed
+        - Test coverage impact
+
+      Evaluation Criteria:
+      - Assess potential system-wide implications
+      - Consider code quality and maintainability
+      - Evaluate potential regression risks
+      - Analyze test coverage and impact
+`

packages/ai/src/prompts.ts

@@ -4,22 +4,19 @@
   "exports": {
     ".": {
       "default": "./src/index.ts"
-    },
-    "./environment": {
-      "default": "./src/environment.ts"
     }
   },
   "main": "./src/index.ts",
   "scripts": {
     "lint": "eslint . --fix",
-    "typecheck": "tsc --noEmit"
-  },
-  "dependencies": {
-    "std-env": "^3.8.0"
+    "typecheck": "tsc --noEmit",
+    "update": "bun update"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.3.0",
-    "eslint": "^9.21.0",
-    "typescript": "^5.7.3"
+    "@antfu/eslint-config": "^4.11.0",
+    "@labelit/types": "workspace:*",
+    "eslint": "^9.23.0",
+    "hono": "^4.7.5",
+    "typescript": "^5.8.2"
   }
 }

packages/config/package.json

@@ -0,0 +1 @@
+export const defaultSecretValue = 'labelit-ai'