@tyvm/knowhow 0.0.36 → 0.0.38

package/src/login.ts

@@ -5,8 +5,9 @@ import { chmod } from "fs/promises";
 import { ask } from "./utils";
 import { getConfig, updateConfig } from "./config";
 import { KNOWHOW_API_URL } from "./services/KnowhowClient";
+import { BrowserLoginService } from "./auth/browserLogin";
 
-export async function login(jwtFlag?: string): Promise<void> {
+export async function login(jwtFlag?: boolean): Promise<void> {
   if (!KNOWHOW_API_URL) {
     throw new Error("Error: KNOWHOW_API_URL environment variable not set.");
   }
@@ -24,6 +25,18 @@ export async function login(jwtFlag?: string): Promise<void> {
     fs.writeFileSync(jwtFile, jwt);
     fs.chmodSync(jwtFile, 0o600);
     console.log("JWT updated successfully.");
+  } else {
+    // Use browser login as default method
+    console.log("Starting browser-based authentication...");
+    try {
+      const browserLoginService = new BrowserLoginService();
+      await browserLoginService.login();
+      console.log("Successfully authenticated via browser!");
+    } catch (error) {
+      console.error("Browser authentication failed:", error.message);
+      console.log("You can try manual JWT login with: knowhow login --jwt");
+      throw error;
+    }
   }
 
   // Get current user/org information

package/src/microphone.ts

@@ -1,7 +1,6 @@
 import { exec } from "child_process";
 import * as fs from "fs";
 import * as path from "path";
-import { openai } from "./ai";
 import { execAsync, ask } from "./utils";
 import { convertToText, convertAudioToText } from "./conversion";
 

package/src/plugins/downloader/downloader.ts

@@ -8,11 +8,12 @@ import { execAsync, fileExists, readFile, mkdir } from "../../utils";
 import OpenAI from "openai";
 import { Clients } from "../../clients";
 import { Models } from "../../types";
+import { openai } from "../../ai";
 
 const logger = Logger();
 
 export class DownloaderService {
-  constructor(private openAi: OpenAI, private clients: typeof Clients) {}
+  constructor(private clients: typeof Clients) {}
 
   async askGptVision(
     imageUrl: string,
@@ -131,6 +132,7 @@ export class DownloaderService {
     }
 
     const allTranscripts = [];
+    const openAi = openai();
     for (const file of files) {
       const chunkName = path.parse(file).name;
       const chunkTranscriptPath = path.join(
@@ -157,7 +159,7 @@ export class DownloaderService {
       }
 
       console.log("Transcribing", file);
-      const transcript = await this.openAi.audio.transcriptions
+      const transcript = await openAi.audio.transcriptions
         .create({
           file: fs.createReadStream(file),
           model: "whisper-1",

package/src/services/KnowhowClient.ts

@@ -127,7 +127,7 @@ export class KnowhowSimpleClient {
 
   getModels() {
     this.checkJwt();
-    return axios.get(`${this.baseUrl}/api/proxy/v1/models`, {
+    return axios.get(`${this.baseUrl}/api/proxy/v1/models?type=all`, {
       headers: this.headers,
     });
   }

package/src/services/index.ts

@@ -1,4 +1,3 @@
-import { openai } from "../ai";
 import { DownloaderService } from "../plugins/downloader/downloader";
 import { Clients } from "../clients";
 import { Plugins } from "../plugins/plugins";
@@ -41,7 +40,7 @@ export const services = (): typeof Singletons => {
     const Tools = new ToolsService();
     const Events = new EventService();
     const Agents = new AgentService(Tools, Events);
-    const Downloader = new DownloaderService(openai, Clients);
+    const Downloader = new DownloaderService(Clients);
     Singletons = {
       Tools,
       Events,

package/tests/manual/browser-login/README.md

@@ -0,0 +1,189 @@
+# Browser Login Manual Tests
+
+This directory contains comprehensive manual tests for the browser-based login functionality in the Knowhow CLI.
+
+## Test Overview
+
+The browser login implementation includes the following key features:
+- Browser-based authentication as the default login method
+- Cross-platform browser opening (macOS, Windows, Linux)
+- Polling mechanism with exponential backoff
+- JWT token retrieval and secure storage
+- Graceful error handling and user cancellation
+- Backwards compatibility with `--jwt` flag
+
+## Test Files
+
+### 1. `test_browser_login_basic.ts`
+**Purpose**: Tests the core browser login flow end-to-end
+
+**What it tests**:
+- Session creation with the API
+- Browser opening for user authentication
+- Authentication polling and completion
+- JWT retrieval and secure storage
+- File permissions (0o600)
+- JWT format validation
+
+**Prerequisites**:
+- Valid `KNOWHOW_API_URL` environment variable
+- Network connection to Knowhow API
+- Default browser available
+
+**Usage**:
+```bash
+npx tsx ./tests/manual/browser-login/test_browser_login_basic.ts
+```
+
+**Manual steps required**:
+- Complete authentication in the opened browser window
+- Verify browser opened to correct URL
+
+### 2. `test_cli_integration.ts`
+**Purpose**: Tests CLI command integration and backwards compatibility
+
+**What it tests**:
+- `knowhow login` uses browser login by default
+- `knowhow login --jwt` prompts for manual JWT input
+- Command help shows correct options
+- JWT file creation through CLI
+
+**Prerequisites**:
+- Built CLI application (`npm run build`)
+- Valid `KNOWHOW_API_URL` environment variable
+
+**Usage**:
+```bash
+npx tsx ./tests/manual/browser-login/test_cli_integration.ts
+```
+
+**Manual steps required**:
+- Complete browser authentication when prompted
+- Verify help output is correct
+
+### 3. `test_cross_platform_browser.ts`
+**Purpose**: Tests browser opening across different operating systems
+
+**What it tests**:
+- Platform detection (macOS, Windows, Linux)
+- Correct browser command selection (`open`, `start`, `xdg-open`)
+- Browser command availability
+- URL handling with special characters
+- Graceful fallback when browser opening fails
+
+**Prerequisites**:
+- Default browser installed
+- Platform-specific browser commands available
+
+**Usage**:
+```bash
+npx tsx ./tests/manual/browser-login/test_cross_platform_browser.ts
+```
+
+**Manual steps required**:
+- Verify browser opens to test URLs
+- Confirm platform-specific behavior
+
+### 4. `test_error_scenarios.ts`
+**Purpose**: Tests error handling and edge cases
+
+**What it tests**:
+- Invalid API URL handling
+- Missing API URL configuration
+- JWT validation with various inputs
+- File permission handling
+- Error code propagation
+- Graceful cancellation mechanisms
+
+**Prerequisites**:
+- Ability to modify environment variables temporarily
+
+**Usage**:
+```bash
+npx tsx ./tests/manual/browser-login/test_error_scenarios.ts
+```
+
+**Manual steps required**:
+- None (fully automated error scenario testing)
+
+## Running All Tests
+
+To run all tests in sequence:
+
+```bash
+# Run individual tests
+npx tsx ./tests/manual/browser-login/test_error_scenarios.ts
+npx tsx ./tests/manual/browser-login/test_cross_platform_browser.ts
+npx tsx ./tests/manual/browser-login/test_cli_integration.ts
+npx tsx ./tests/manual/browser-login/test_browser_login_basic.ts
+```
+
+## Test Results Interpretation
+
+### ✅ PASSED
+Test completed successfully with expected behavior.
+
+### ⚠️ WARNING  
+Test completed but with minor issues or platform-specific concerns that don't prevent functionality.
+
+### ❌ FAILED
+Test failed due to errors or unexpected behavior that needs to be addressed.
+
+### Manual Verification Required
+Some tests require manual verification (e.g., confirming browser opened correctly) as they test user interaction flows.
+
+## Common Issues and Troubleshooting
+
+### Browser Not Opening
+- **Symptoms**: Browser opening fails or command not found
+- **Solutions**: 
+  - Ensure default browser is installed
+  - Check platform-specific command availability (`open`, `start`, `xdg-open`)
+  - Verify display environment for Linux systems
+
+### Network Errors
+- **Symptoms**: API connection failures or timeouts
+- **Solutions**:
+  - Verify `KNOWHOW_API_URL` is set correctly
+  - Check network connectivity
+  - Confirm API endpoints are accessible
+
+### Permission Errors
+- **Symptoms**: Cannot create or write JWT files
+- **Solutions**:
+  - Check write permissions in project directory
+  - Verify `.knowhow` directory can be created
+  - Check for filesystem restrictions
+
+### Authentication Timeout
+- **Symptoms**: Polling times out before user completes authentication
+- **Solutions**:
+  - Complete authentication more quickly
+  - Check if browser session is blocked by ad blockers
+  - Verify correct authentication URL
+
+## Integration with CI/CD
+
+These manual tests are designed for human verification and are not suitable for automated CI/CD pipelines. For automated testing, consider:
+
+1. Mocking the browser opening functionality
+2. Creating integration tests with test authentication endpoints
+3. Unit testing individual components separately
+
+## Security Considerations
+
+When running these tests:
+- JWT tokens are stored temporarily and cleaned up
+- File permissions are tested to ensure secure storage (0o600)
+- No sensitive data should be logged or persisted beyond test execution
+- Tests clean up after themselves to avoid leaving test artifacts
+
+## Contributing
+
+When adding new tests:
+1. Follow the existing test file naming pattern
+2. Include comprehensive error handling
+3. Provide clear manual steps in comments
+4. Clean up any created files or state
+5. Add appropriate timeout handling
+6. Update this README with new test descriptions

package/tests/manual/browser-login/test_browser_login_basic.ts

@@ -0,0 +1,115 @@
+#!/usr/bin/env npx tsx
+
+/**
+ * Manual Test: Basic Browser Login Flow
+ * 
+ * This test validates the complete browser-based authentication flow:
+ * 1. Creates a login session with the API
+ * 2. Opens browser for user authentication
+ * 3. Polls for authentication completion
+ * 4. Retrieves and stores JWT token
+ * 
+ * Prerequisites:
+ * - Valid KNOWHOW_API_URL environment variable
+ * - Network connection to Knowhow API
+ * - Browser available on the system
+ * 
+ * Usage: npx tsx ./tests/manual/browser-login/test_browser_login_basic.ts
+ */
+
+import { BrowserLoginService } from '../../../src/auth/browserLogin';
+import * as fs from 'fs';
+import * as path from 'path';
+
+async function testBasicBrowserLogin(): Promise<void> {
+  console.log('\n=== Basic Browser Login Test ===\n');
+  
+  let success = false;
+  const configDir = path.join(process.cwd(), '.knowhow');
+  const jwtFile = path.join(configDir, '.jwt');
+  
+  // Clean up any existing JWT file
+  if (fs.existsSync(jwtFile)) {
+    fs.unlinkSync(jwtFile);
+    console.log('🧹 Cleaned up existing JWT file');
+  }
+  
+  try {
+    console.log('1. Initializing BrowserLoginService...');
+    const browserLogin = new BrowserLoginService();
+    
+    console.log('2. Starting browser login flow...');
+    console.log('   Note: This will open your browser and require manual authentication');
+    console.log('   Please complete the authentication process in your browser');
+    
+    await browserLogin.login();
+    
+    console.log('3. Verifying JWT file was created...');
+    if (fs.existsSync(jwtFile)) {
+      const jwtContent = fs.readFileSync(jwtFile, 'utf8');
+      
+      // Check file permissions
+      const stats = fs.statSync(jwtFile);
+      const permissions = stats.mode & parseInt('777', 8);
+      
+      console.log(`   ✅ JWT file created: ${jwtFile}`);
+      console.log(`   ✅ JWT length: ${jwtContent.length} characters`);
+      console.log(`   ✅ File permissions: ${permissions.toString(8)} (should be 600)`);
+      
+      // Basic JWT validation
+      const parts = jwtContent.split('.');
+      if (parts.length === 3) {
+        console.log('   ✅ JWT has correct structure (3 parts)');
+        success = true;
+      } else {
+        console.log('   ❌ JWT has incorrect structure');
+      }
+      
+      if (permissions === parseInt('600', 8)) {
+        console.log('   ✅ JWT file has correct permissions (600)');
+      } else {
+        console.log(`   ⚠️  JWT file permissions may be incorrect: ${permissions.toString(8)}`);
+      }
+      
+    } else {
+      console.log('   ❌ JWT file was not created');
+    }
+    
+  } catch (error) {
+    console.error('❌ Test failed with error:', error.message);
+    
+    if (error.code === 'USER_CANCELLED') {
+      console.log('   ℹ️  Authentication was cancelled by user (this is expected for Ctrl+C)');
+    } else if (error.code === 'TIMEOUT') {
+      console.log('   ⚠️  Authentication timed out (user may not have completed authentication)');
+    } else if (error.code === 'NETWORK_ERROR') {
+      console.log('   ❌ Network error - check API connectivity');
+    }
+  }
+  
+  console.log('\n=== Test Results ===');
+  if (success) {
+    console.log('✅ Browser login test PASSED');
+    console.log('   - Session created successfully');
+    console.log('   - Browser opened for authentication');
+    console.log('   - JWT retrieved and stored securely');
+    process.exit(0);
+  } else {
+    console.log('❌ Browser login test FAILED');
+    console.log('   See error details above');
+    process.exit(1);
+  }
+}
+
+// Handle graceful shutdown
+process.on('SIGINT', () => {
+  console.log('\n\n🛑 Test interrupted by user (Ctrl+C)');
+  console.log('   This tests the graceful cancellation feature');
+  process.exit(0);
+});
+
+// Run the test
+testBasicBrowserLogin().catch((error) => {
+  console.error('Unhandled error:', error);
+  process.exit(1);
+});

package/tests/manual/browser-login/test_cli_integration.ts

@@ -0,0 +1,169 @@
+#!/usr/bin/env npx tsx
+
+/**
+ * Manual Test: CLI Integration Test
+ * 
+ * This test validates the integration of browser login with the CLI command system:
+ * 1. Tests `knowhow login` (browser login as default)
+ * 2. Tests `knowhow login --jwt` (legacy JWT input)
+ * 3. Verifies backwards compatibility
+ * 4. Tests login status verification
+ * 
+ * Prerequisites:
+ * - Built CLI application
+ * - Valid KNOWHOW_API_URL environment variable
+ * - Network connection to Knowhow API
+ * 
+ * Usage: npx tsx ./tests/manual/browser-login/test_cli_integration.ts
+ */
+
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import * as fs from 'fs';
+import * as path from 'path';
+
+const execAsync = promisify(exec);
+
+async function testCliIntegration(): Promise<void> {
+  console.log('\n=== CLI Integration Test ===\n');
+  
+  const configDir = path.join(process.cwd(), '.knowhow');
+  const jwtFile = path.join(configDir, '.jwt');
+  let testResults: string[] = [];
+  
+  try {
+    // Clean up any existing JWT file
+    if (fs.existsSync(jwtFile)) {
+      fs.unlinkSync(jwtFile);
+      console.log('🧹 Cleaned up existing JWT file\n');
+    }
+    
+    console.log('=== Test 1: Browser Login as Default ===');
+    console.log('Testing: knowhow login (should use browser login)');
+    console.log('Note: This will open your browser - please complete authentication\n');
+    
+    try {
+      // This should use browser login by default
+      const { stdout, stderr } = await execAsync('npm run build && node dist/cli.js login', {
+        timeout: 120000 // 2 minutes timeout
+      });
+      
+      console.log('Command output:', stdout);
+      if (stderr) console.log('Command stderr:', stderr);
+      
+      // Check if JWT file was created
+      if (fs.existsSync(jwtFile)) {
+        const jwtContent = fs.readFileSync(jwtFile, 'utf8');
+        if (jwtContent.split('.').length === 3) {
+          console.log('✅ Test 1 PASSED: Browser login created valid JWT');
+          testResults.push('✅ Browser login as default: PASSED');
+        } else {
+          console.log('❌ Test 1 FAILED: Invalid JWT created');
+          testResults.push('❌ Browser login as default: FAILED (invalid JWT)');
+        }
+      } else {
+        console.log('❌ Test 1 FAILED: No JWT file created');
+        testResults.push('❌ Browser login as default: FAILED (no JWT file)');
+      }
+      
+    } catch (error) {
+      if (error.killed && error.signal === 'SIGTERM') {
+        console.log('⚠️  Test 1 TIMEOUT: User may not have completed authentication');
+        testResults.push('⚠️  Browser login as default: TIMEOUT');
+      } else {
+        console.log('❌ Test 1 ERROR:', error.message);
+        testResults.push('❌ Browser login as default: ERROR');
+      }
+    }
+    
+    // Clean up for next test
+    if (fs.existsSync(jwtFile)) {
+      fs.unlinkSync(jwtFile);
+    }
+    
+    console.log('\n=== Test 2: Legacy JWT Input ===');
+    console.log('Testing: knowhow login --jwt (should prompt for manual JWT input)');
+    
+    // Create a mock interaction that immediately exits
+    try {
+      const { stdout, stderr } = await execAsync('echo "" | npm run build && echo "" | node dist/cli.js login --jwt', {
+        timeout: 10000
+      });
+      
+      console.log('Command output:', stdout);
+      if (stderr) console.log('Command stderr:', stderr);
+      
+      // The command should have prompted for JWT input
+      if (stdout.includes('JWT') || stdout.includes('token') || stderr.includes('JWT') || stderr.includes('token')) {
+        console.log('✅ Test 2 PASSED: --jwt flag triggers manual JWT input');
+        testResults.push('✅ Legacy JWT input: PASSED');
+      } else {
+        console.log('❌ Test 2 FAILED: --jwt flag not working correctly');
+        testResults.push('❌ Legacy JWT input: FAILED');
+      }
+      
+    } catch (error) {
+      // This is expected since we're not providing valid JWT input
+      if (error.message.includes('JWT') || error.message.includes('token')) {
+        console.log('✅ Test 2 PASSED: --jwt flag triggered JWT input prompt');
+        testResults.push('✅ Legacy JWT input: PASSED');
+      } else {
+        console.log('❌ Test 2 FAILED:', error.message);
+        testResults.push('❌ Legacy JWT input: FAILED');
+      }
+    }
+    
+    console.log('\n=== Test 3: Command Help ===');
+    console.log('Testing: knowhow login --help');
+    
+    try {
+      const { stdout, stderr } = await execAsync('npm run build && node dist/cli.js login --help');
+      
+      console.log('Help output:', stdout);
+      
+      if (stdout.includes('--jwt') && stdout.includes('browser')) {
+        console.log('✅ Test 3 PASSED: Help shows both browser and JWT options');
+        testResults.push('✅ Command help: PASSED');
+      } else {
+        console.log('❌ Test 3 FAILED: Help missing expected options');
+        testResults.push('❌ Command help: FAILED');
+      }
+      
+    } catch (error) {
+      console.log('❌ Test 3 ERROR:', error.message);
+      testResults.push('❌ Command help: ERROR');
+    }
+    
+  } catch (error) {
+    console.error('❌ Test suite failed:', error.message);
+  }
+  
+  // Print summary
+  console.log('\n=== Test Summary ===');
+  testResults.forEach(result => console.log(result));
+  
+  const passedTests = testResults.filter(r => r.includes('PASSED')).length;
+  const totalTests = testResults.length;
+  
+  console.log(`\nResults: ${passedTests}/${totalTests} tests passed`);
+  
+  if (passedTests === totalTests) {
+    console.log('🎉 All CLI integration tests PASSED!');
+    process.exit(0);
+  } else {
+    console.log('❌ Some CLI integration tests FAILED');
+    process.exit(1);
+  }
+}
+
+// Handle graceful shutdown
+process.on('SIGINT', () => {
+  console.log('\n\n🛑 Test interrupted by user (Ctrl+C)');
+  process.exit(0);
+});
+
+// Run the test
+testCliIntegration().catch((error) => {
+  console.error('Unhandled error:', error);
+  process.exit(1);
+});