test: Add decorator and local file overload interaction tests; increase test timeouts

AlePouroullis · AlePouroullis · commit 142a4c77467d · 2025-05-21T17:50:55.000+01:00
diff --git a/tests/custom/integration/cli.test.ts b/tests/custom/integration/cli.test.ts
@@ -10,12 +10,17 @@ import {
     setupTestEnvironment,
 } from "./fixtures";
 
+// Set global timeout for all tests in this suite
+jest.setTimeout(40 * 1000); // 40 seconds
+
 // Helper function to run CLI commands with TypeScript
 async function runCli(
     args: string[],
 ): Promise<{ stdout: string; stderr: string; exitCode: number }> {
     return new Promise((resolve) => {
         const packageRoot = path.resolve(__dirname, "../../../");
+        // NB: cli.js must be compiled before running this test
+        // This is fine in CI, since we compile before running tests
         const cliPath = path.join(packageRoot, "dist/cli.js");
 
         // Use spawn to avoid shell interpretation issues
@@ -49,15 +54,12 @@ describe("CLI Integration Tests", () => {
     let syncableFiles: any[] = [];
 
     beforeAll(async () => {
-        // Increase timeout for setup operations
-        jest.setTimeout(40000); // 40 seconds
-
         // Set up test environment
         testSetup = await setupTestEnvironment("cli_test");
 
         // Create test files in Humanloop for syncing
         syncableFiles = await createSyncableFilesFixture(testSetup);
-    }, 30000);
+    });
 
     afterAll(async () => {
         await cleanupTestEnvironment(
@@ -67,25 +69,25 @@ describe("CLI Integration Tests", () => {
                 id: file.id as string,
             })),
         );
-    }, 30000);
+    });
 
     /**
      * NOTE: This test is currently skipped due to issues with CLI environment isolation.
-     * 
-     * The test attempts to verify behavior when no API key is available, but faces 
+     *
+     * The test attempts to verify behavior when no API key is available, but faces
      * challenges with how Node.js handles process execution during tests:
-     * 
-     * 1. When executed via child_process.exec, the path to nonexistent env files 
+     *
+     * 1. When executed via child_process.exec, the path to nonexistent env files
      *    causes Node to return exit code 9 (SIGKILL) instead of the expected code 1
      * 2. Shell interpretation of arguments makes it difficult to reliably test this edge case
-     * 
+     *
      * If this functionality needs testing, consider:
      * - Using child_process.spawn for better argument handling
      * - Unit testing the API key validation logic directly
      * - Moving this test to a separate process with full environment isolation
-     * 
+     *
      * @see https://nodejs.org/api/child_process.html for more info on process execution
-    */
+     */
     test.skip("pull_without_api_key: should show error when no API key is available", async () => {
         // GIVEN a temporary directory and no API key
         const { tempDir, cleanup } = createTempDir("cli-no-api-key");
@@ -118,9 +120,6 @@ describe("CLI Integration Tests", () => {
     });
 
     test("pull_basic: should pull all files successfully", async () => {
-        // Increase timeout for this test
-        jest.setTimeout(30000); // 30 seconds
-
         // GIVEN a base directory for pulled files
         const { tempDir, cleanup } = createTempDir("cli-basic-pull");
 
@@ -152,7 +151,7 @@ describe("CLI Integration Tests", () => {
         }
 
         cleanup();
-    }, 30000);
+    });
 
     test("pull_with_specific_path: should pull files from a specific path", async () => {
         // GIVEN a base directory and specific path
@@ -193,9 +192,6 @@ describe("CLI Integration Tests", () => {
     });
 
     test("pull_with_environment: should pull files from a specific environment", async () => {
-        // Increase timeout for this test
-        jest.setTimeout(30000); // 30 seconds
-
         // GIVEN a base directory and environment
         const { tempDir, cleanup } = createTempDir("cli-env-pull");
 
@@ -216,7 +212,7 @@ describe("CLI Integration Tests", () => {
         expect(result.stdout).toContain("Environment: staging");
 
         cleanup();
-    }, 30000);
+    });
 
     test("pull_with_quiet_mode: should pull files with quiet mode enabled", async () => {
         // GIVEN a base directory and quiet mode
diff --git a/tests/custom/integration/decoratorLocalFile.test.ts b/tests/custom/integration/decoratorLocalFile.test.ts
@@ -0,0 +1,107 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import { HumanloopClient } from "../../../src/humanloop.client";
+import { createTempDir } from "../fixtures";
+import { TestSetup, cleanupTestEnvironment, setupTestEnvironment } from "./fixtures";
+
+// Set global timeout for all tests in this suite
+jest.setTimeout(30 * 1000); // 30 seconds
+
+describe("Decorator and Local File Integration Tests", () => {
+    let testSetup: TestSetup;
+    let tempDirInfo: { tempDir: string; cleanup: () => void };
+    let flowId: string | null = null;
+
+    beforeAll(async () => {
+        testSetup = await setupTestEnvironment("decorator_local_file");
+        tempDirInfo = createTempDir("decorator-local-file-integration");
+    });
+
+    afterAll(async () => {
+        tempDirInfo.cleanup();
+        if (flowId) {
+            await cleanupTestEnvironment(testSetup, [
+                {
+                    type: "flow",
+                    id: flowId,
+                },
+            ]);
+        } else {
+            await cleanupTestEnvironment(testSetup);
+        }
+    });
+
+    test("flow decorator should work with local prompt files", async () => {
+        // GIVEN a local prompt file
+        const promptContent = `---
+model: gpt-4o-mini
+temperature: 0
+max_tokens: -1
+provider: openai
+endpoint: chat
+tools: []
+---
+
+<system>
+You are a helpful assistant that provides concise answers. When asked about capitals of countries, 
+you respond with just the capital name, lowercase, with no punctuation or additional text.
+</system>
+`;
+
+        // Create local file structure
+        const promptPath = `${testSetup.sdkTestDir.path}/capital_prompt`;
+        const promptFilePath = path.join(tempDirInfo.tempDir, `${promptPath}.prompt`);
+        fs.mkdirSync(path.dirname(promptFilePath), { recursive: true });
+        fs.writeFileSync(promptFilePath, promptContent);
+
+        // GIVEN a client with local files enabled
+        const client = new HumanloopClient({
+            apiKey: process.env.HUMANLOOP_API_KEY,
+            localFilesDirectory: tempDirInfo.tempDir,
+            useLocalFiles: true,
+        });
+
+        // GIVEN a flow that uses the local prompt
+        const flowPath = `${testSetup.sdkTestDir.path}/test_flow_with_local_prompt`;
+        const myFlow = client.flow({
+            path: flowPath,
+            callable: async (question: { question: string }) => {
+                // This is the key integration point - using a local prompt within a flow
+                const response = await client.prompts.call({
+                    path: promptPath,
+                    messages: [{ role: "user", content: question.question }],
+                    providerApiKeys: { openai: testSetup.openaiApiKey },
+                });
+                return response.logs?.[0]?.output || "";
+            },
+        });
+
+        // WHEN calling the flow
+        const result = await myFlow({
+            question: "What is the capital of France?",
+        });
+
+        // THEN it should work with the local prompt
+        expect(result?.toLowerCase()).toContain("paris");
+
+        // AND the logs should be properly linked
+        await new Promise((resolve) => setTimeout(resolve, 5000));
+
+        // Get file IDs for log verification
+        const [flowFile, promptFile] = await Promise.all([
+            client.files.retrieveByPath({ path: flowPath }),
+            client.files.retrieveByPath({ path: promptPath }),
+        ]);
+        flowId = flowFile.id;
+
+        // Verify the logs are linked
+        const [flowLogs, promptLogs] = await Promise.all([
+            client.logs.list({ fileId: flowFile.id, page: 1, size: 1 }),
+            client.logs.list({ fileId: promptFile.id, page: 1, size: 1 }),
+        ]);
+
+        // The key assertion - verify tracing works with local files
+        expect(promptLogs.data[0].traceParentId).toBe(flowLogs.data[0].id);
+    });
+});
diff --git a/tests/custom/integration/localFileOperations.test.ts b/tests/custom/integration/localFileOperations.test.ts
@@ -12,6 +12,9 @@ import {
     setupTestEnvironment,
 } from "./fixtures";
 
+// Set global timeout for all tests in this suite
+jest.setTimeout(40 * 1000); // 40 seconds
+
 // Define SyncableFile interface to match Python version
 interface SyncableFile {
     path: string;
@@ -34,9 +37,6 @@ describe("Local File Operations Integration Tests", () => {
     let tempDirInfo: { tempDir: string; cleanup: () => void };
 
     beforeAll(async () => {
-        // Increase timeout for setup operations
-        jest.setTimeout(30000); // 30 seconds
-
         // Set up test environment
         testSetup = await setupTestEnvironment("local_file_ops");
         tempDirInfo = createTempDir("local-file-integration");
@@ -52,7 +52,7 @@ describe("Local File Operations Integration Tests", () => {
         });
 
         await setupClient.pull();
-    }, 30000);
+    });
 
     afterAll(async () => {
         // Clean up resources
@@ -64,7 +64,7 @@ describe("Local File Operations Integration Tests", () => {
                 id: file.id as string,
             })),
         );
-    }, 30000);
+    });
 
     describe("Path Validation", () => {
         // Path validation test cases
