[refactor] rename FetchTask to FetchUrlTask

- Replaced FetchTask with FetchUrlTask across the codebase to improve clarity and functionality.
- Updated documentation to reflect the new FetchUrlTask, including usage examples and available options.
- Added comprehensive tests for FetchUrlTask to ensure robust functionality and error handling.
- Enhanced the task's ability to handle various response types and progress tracking during fetch operations.

Author: sroussey

examples/web/src/main.tsx

@@ -12,7 +12,7 @@ import {
 } from "@workglow/ai";
 import { installDevToolsFormatters, isDarkMode } from "@workglow/debug";
 import { Task, TaskGraph, Workflow } from "@workglow/task-graph";
-import { DebugLogTask, DelayTask, FetchTask, JsonTask, LambdaTask } from "@workglow/tasks";
+import { DebugLogTask, DelayTask, FetchUrlTask, JsonTask, LambdaTask } from "@workglow/tasks";
 import ReactDOM from "react-dom/client";
 import { App } from "./App";
 import "./main.css";
@@ -37,7 +37,7 @@ installDevToolsFormatters();
   TaskGraph,
   JsonTask,
   DelayTask,
-  FetchTask,
+  FetchUrlTask,
   LambdaTask,
 ].forEach((item) => {
   window[item.name] = item;

packages/tasks/README.md

@@ -8,7 +8,7 @@ A package of task types for common operations, workflow management, and data pro
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Available Tasks](#available-tasks)
-  - [FetchTask](#fetchtask)
+  - [FetchUrlTask](#fetchurltask)
   - [DebugLogTask](#debuglogtask)
   - [DelayTask](#delaytask)
   - [JavaScriptTask](#javascripttask)
@@ -41,10 +41,10 @@ const results = await workflow.run();
 ```
 
 ```typescript
-import { FetchTask, DebugLogTask, DelayTask } from "@workglow/tasks";
+import { FetchUrlTask, DebugLogTask, DelayTask } from "@workglow/tasks";
 
 // Simple sequence using Task classes directly
-const fetchResult = await new FetchTask({
+const fetchResult = await new FetchUrlTask({
   url: "https://api.example.com/data",
   response_type: "json",
 }).run();
@@ -72,7 +72,7 @@ await debugLog({
 
 ## Available Tasks
 
-### FetchTask
+### FetchUrlTask
 
 Makes HTTP requests with built-in retry logic, progress tracking, and multiple response types.
 
@@ -97,14 +97,14 @@ Makes HTTP requests with built-in retry logic, progress tracking, and multiple r
 
 ```typescript
 // Simple GET request
-const response = await new FetchTask({
+const response = await new FetchUrlTask({
   url: "https://api.example.com/users",
   response_type: "json",
 }).run();
 console.log(response.json);
 
 // POST request with headers
-const postResponse = await new FetchTask({
+const postResponse = await new FetchUrlTask({
   url: "https://api.example.com/users",
   method: "POST",
   headers: {
@@ -116,7 +116,7 @@ const postResponse = await new FetchTask({
 }).run();
 
 // Text response
-const textResponse = await new FetchTask({
+const textResponse = await new FetchUrlTask({
   url: "https://example.com/readme.txt",
   response_type: "text",
 }).run();
@@ -380,7 +380,7 @@ Creates and executes task graphs from JSON configurations, enabling dynamic work
 ```typescript
 interface JsonTaskItem {
   id: string; // Unique task identifier
-  type: string; // Task type (e.g., "FetchTask", "DelayTask")
+  type: string; // Task type (e.g., "FetchUrlTask", "DelayTask")
   input?: any; // Task input data
   config?: any; // Task configuration
   dependencies?: {
@@ -403,7 +403,7 @@ const linearWorkflow = await new JsonTask({
   json: JSON.stringify([
     {
       id: "fetch-data",
-      type: "FetchTask",
+      type: "FetchUrlTask",
       input: {
         url: "https://api.example.com/users",
         response_type: "json",
@@ -432,15 +432,15 @@ const complexWorkflow = await new JsonTask({
   json: JSON.stringify([
     {
       id: "fetch-users",
-      type: "FetchTask",
+      type: "FetchUrlTask",
       input: {
         url: "https://api.example.com/users",
         response_type: "json",
       },
     },
     {
       id: "fetch-posts",
-      type: "FetchTask",
+      type: "FetchUrlTask",
       input: {
         url: "https://api.example.com/posts",
         response_type: "json",
@@ -532,7 +532,7 @@ Tasks include comprehensive error handling:
 
 ```typescript
 try {
-  const result = await new FetchTask({
+  const result = await new FetchUrlTask({
     url: "https://api.example.com/data",
     response_type: "json",
     timeout: 5000,
@@ -556,7 +556,7 @@ Tasks support various configuration options:
 
 ```typescript
 // Task-specific configuration
-const fetchTask = new FetchTask(
+const fetchTask = new FetchUrlTask(
   {
     url: "https://api.example.com/data",
   },

packages/tasks/src/index.ts

@@ -6,7 +6,7 @@
 
 export * from "./task/DebugLogTask";
 export * from "./task/DelayTask";
-export * from "./task/FetchTask";
+export * from "./task/FetchUrlTask";
 export * from "./task/JavaScriptTask";
 export * from "./task/JsonTask";
 export * from "./task/LambdaTask";

packages/tasks/src/task/FetchTask.ts packages/tasks/src/task/FetchUrlTask.tspackages/tasks/src/task/FetchTask.ts renamed to packages/tasks/src/task/FetchUrlTask.ts

@@ -95,10 +95,10 @@ const outputSchema = {
   additionalProperties: false,
 } as const satisfies DataPortSchema;
 
-export type FetchTaskInput = FromSchema<typeof inputSchema>;
-export type FetchTaskOutput = FromSchema<typeof outputSchema>;
+export type FetchUrlTaskInput = FromSchema<typeof inputSchema>;
+export type FetchUrlTaskOutput = FromSchema<typeof outputSchema>;
 
-export type FetchTaskConfig = JobQueueTaskConfig;
+export type FetchUrlTaskConfig = JobQueueTaskConfig;
 
 async function fetchWithProgress(
   url: string,
@@ -165,14 +165,14 @@ async function fetchWithProgress(
  * Extends the base Job class to provide custom execution functionality
  * through a provided function.
  */
-export class FetchJob<
-  Input extends FetchTaskInput = FetchTaskInput,
-  Output = FetchTaskOutput,
+export class FetchUrlJob<
+  Input extends FetchUrlTaskInput = FetchUrlTaskInput,
+  Output = FetchUrlTaskOutput,
 > extends Job<Input, Output> {
   constructor(config: JobQueueTaskConfig & { input: Input } = { input: {} as Input }) {
     super(config);
   }
-  static readonly type: string = "FetchJob";
+  static readonly type: string = "FetchUrlJob";
   /**
    * Executes the job using the provided function.
    */
@@ -257,14 +257,14 @@ export class FetchJob<
 }
 
 /**
- * FetchTask provides a task for fetching data from a URL.
+ * FetchUrlTask provides a task for fetching data from a URL.
  */
-export class FetchTask<
-  Input extends FetchTaskInput = FetchTaskInput,
-  Output extends FetchTaskOutput = FetchTaskOutput,
-  Config extends FetchTaskConfig = FetchTaskConfig,
+export class FetchUrlTask<
+  Input extends FetchUrlTaskInput = FetchUrlTaskInput,
+  Output extends FetchUrlTaskOutput = FetchUrlTaskOutput,
+  Config extends FetchUrlTaskConfig = FetchUrlTaskConfig,
 > extends JobQueueTask<Input, Output, Config> {
-  public static type = "FetchTask";
+  public static type = "FetchUrlTask";
   public static category = "Input";
   public static title = "Fetch";
   public static description =
@@ -291,11 +291,11 @@ export class FetchTask<
 
     // If response_type is null or undefined, return all output types (static schema)
     if (responseType === null || responseType === undefined) {
-      return (this.constructor as typeof FetchTask).outputSchema();
+      return (this.constructor as typeof FetchUrlTask).outputSchema();
     }
 
     // If response_type is a specific value, return only that output type
-    const staticSchema = (this.constructor as typeof FetchTask).outputSchema();
+    const staticSchema = (this.constructor as typeof FetchUrlTask).outputSchema();
     if (typeof staticSchema === "boolean") {
       return staticSchema;
     }
@@ -334,7 +334,7 @@ export class FetchTask<
       config.queue = false; // change default to false to run directly
     }
     super(input, config);
-    this.jobClass = FetchJob;
+    this.jobClass = FetchUrlJob;
   }
 
   /**
@@ -387,20 +387,20 @@ export class FetchTask<
   }
 }
 
-TaskRegistry.registerTask(FetchTask);
+TaskRegistry.registerTask(FetchUrlTask);
 
-export const fetch = async (
-  input: FetchTaskInput,
-  config: FetchTaskConfig = {}
-): Promise<FetchTaskOutput> => {
-  const result = await new FetchTask(input, config).run();
-  return result as FetchTaskOutput;
+export const fetchUrl = async (
+  input: FetchUrlTaskInput,
+  config: FetchUrlTaskConfig = {}
+): Promise<FetchUrlTaskOutput> => {
+  const result = await new FetchUrlTask(input, config).run();
+  return result as FetchUrlTaskOutput;
 };
 
 declare module "@workglow/task-graph" {
   interface Workflow {
-    fetch: CreateWorkflow<FetchTaskInput, FetchTaskOutput, FetchTaskConfig>;
+    fetch: CreateWorkflow<FetchUrlTaskInput, FetchUrlTaskOutput, FetchUrlTaskConfig>;
   }
 }
 
-Workflow.prototype.fetch = CreateWorkflow(FetchTask);
+Workflow.prototype.fetch = CreateWorkflow(FetchUrlTask);