Files
windmill/backend/tests/list_jobs.rs
Ruben Fiszel 31d6660d56 feat: script module mode with CLI sync, preview, and WAC UI improvements (#8380)
* feat: add script module mode with folder model for Bun and Python

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: add missing modules field to RawCode in bun_executor

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* sqlx

* feat: enrich WAC templates with checkpoint and replay semantics

Add prominent comments explaining that all computation must happen
inside task/step/taskScript or it will be replayed on resume/retry.
Clarify that waitForApproval does not hold a worker and that
approve/reject URLs are available in the timeline step details.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(cli): script module sync idempotency, per-module hash tracking, and preview support

- Fix pull→push idempotency: use `??` instead of `||` for module lock
  field so empty strings are preserved (matches API's `lock: ""`)
- Add per-module hash tracking in wmill-lock.yaml following the flow
  inline script pattern (SCRIPT_TOP_HASH + per-module subpath hashes)
- Selective module lock regeneration: only regenerate locks for modules
  whose content actually changed, not all modules
- Use unfiltered rawWorkspaceDependencies for module hashes to match
  what updateModuleLocks passes to fetchScriptLock
- Show changed module names in stale script output for clarity
- Add module support to `script preview` command: read modules from
  __mod/ folder and pass them in the preview API request
- Add preview tests for taskScript pattern (flat and folder layout)
- Update test assertion for module stale detection output

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* feat(frontend): WAC UI improvements — reorder templates, module tab rename, import consolidation

- Reorder WAC template buttons: TypeScript before Python in
  ScriptBuilder, CreateActionsScript, and CreateActionsFlow
- Remove dropdown items from +Script button (simplify to direct link)
- Move "Import Workflow-as-Code" to +Flow dropdown with dedicated drawer
- Add module tab rename: pencil icon on hover opens popover with
  validation, fixed-width icon container prevents layout shift

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* feat: remaining module-mode changes from working branch

- Backend parser updates for WAC detection
- CLI sync/types updates for raw app path and module support
- Frontend UI polish (Dev.svelte, ScriptRow, script hash page)
- Test fixture updates

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* test(cli): add test for module modification detection in generate-metadata

Verifies that modifying a single module file re-triggers stale
detection and only the changed module is listed, not all modules.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(backend): critical fixes from PR review

- Fix hardcoded dev path in bun_executor.rs WAC v2 wrapper — use
  "windmill-client" import instead of absolute filesystem path
- Fix missed no_main_func → auto_kind rename in parser TS test
- Add modules column to clone_script SQL (windmill-common and
  windmill-api-workspaces) so cloned scripts retain their modules
- Add modules: None to RawCode structs in worker tests
- Restore complete sqlx cache (merge main's cache + our new queries)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(backend): fix clone warning treated as error in CI

Change `.clone()` on double reference to `*k` dereference in
scripts.rs hash implementation. Update sqlx cache with new query
hashes from modified clone_script SQL.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(frontend): use published parser wasm versions for CI build

The local file:// paths for windmill-parser-wasm-py and
windmill-parser-wasm-ts don't exist in the Cloudflare Pages build
environment. Revert to published npm versions (1.655.0).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(frontend): update parser wasm packages to 1.657.2

Use newly published windmill-parser-wasm-ts and windmill-parser-wasm-py
v1.657.2 which include auto_kind/WAC detection changes.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(frontend): regenerate package-lock.json for npm ci compatibility

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(frontend): use main's lockfile as base, update only parser wasm packages

Regenerating package-lock.json from scratch pulled different dependency
versions causing svelte-check type errors. Instead, start from main's
lockfile and only update the two changed packages.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(backend): add modules column to fetch_script_for_update query

The Script<SR> struct has a modules field (FromRow), but
fetch_script_for_update didn't SELECT modules, causing a runtime
error "no column found for name: modules" when the worker processed
dependency jobs. This was the root cause of the relock_skip test
timeout.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(backend): fix script module execution for Python and Bun

- Fix modules not passed through job queue: inject _MODULES into
  PushArgs.extra when pushing Code jobs so worker can extract them
- Fix Python module imports: use relative imports (from .helper)
  and add sys.path.insert for module directory in wrapper
- Fix Python tests: use relative imports and empty lock to prevent
  pip from resolving module names as packages
- Add local file check in Bun loader for module resolution
- Ignore Bun module test (bundle mode loader integration tracked
  separately)
- Add missing modules column to fetch_script_for_update query

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(backend): remove unnecessary empty lock in Python module tests

Relative imports (from .helper) are not parsed as pip packages,
so the empty lock workaround is not needed.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(backend): fix module execution for Python and Bun — all tests pass

Python modules:
- Use relative imports (from .helper import greet) since scripts run
  as packages
- Add sys.path.insert for module directory in wrapper to ensure local
  modules take precedence over pip packages with same name

Bun modules:
- Use bundled output (./out/main.js) as wrapper import when modules
  are present — the bundled output has module content inlined by
  Bun.build, avoiding runtime loader resolution issues
- Add local file check in loader.bun.js onResolve to short-circuit
  API URL resolution for module files on disk

Job queue:
- Inject _MODULES into PushArgs.extra when pushing Code jobs so
  the worker can extract them at execution time

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* refactor: address PR review — simplify, fix correctness, remove dead code

Critical fixes:
- Replace all CLI `no_main_func` references with `auto_kind` (string)
  to match the backend migration and API changes
- Remove duplicated `compute_python_module_dir` in worker.rs, use
  the canonical version from python_executor.rs

High priority:
- Auto-create `__init__.py` in intermediate directories for nested
  Python modules so imports like `from .utils.math import add` work
  without users manually creating __init__.py files
- Remove redundant `sys_path_insert` — relative imports use Python's
  package system, not sys.path

Medium:
- Fix lock file base name extraction: use regex to strip only the
  final extension (`.replace(/\.[^.]+$/, '')`) instead of `indexOf(".")`
  which breaks for files like `helper.test.ts`

Simplification:
- Remove dead `{#if false}` Popover block in ScriptEditor.svelte
- Guard loader.bun.js local file check to only run for relative paths
  (matching the Windows loader pattern)
- Add clarifying comment on Bun dual mechanism (build + run phases)
- Add maintenance comment on manual Hash impl for NewScript

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: final review fixes — stale cleanup, baseName, auto_kind export

- Fix sync.ts baseName extraction using indexOf(".") → regex
  (same fix as script.ts/metadata.ts, missed this instance)
- Add stale module file cleanup in writeModulesToDisk: removes files
  from __mod/ that are no longer in the modules map before writing,
  fixing the pull→push cycle that couldn't delete modules
- Log warning when _MODULES serialization fails in job push instead
  of silently dropping modules
- Use strict equality (===) for auto_kind comparison
- Exclude auto_kind from workspace export — it is auto-detected by
  the parser at deploy time from script content

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(cli): remove auto_kind from push, comparison, and metadata

auto_kind is auto-detected by the parser at deploy time, so the CLI
should not send it, compare it, or write it to script.yaml.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: remove erroneously added backend/backend/.sqlx directory

Duplicate .sqlx cache was committed at the wrong nested path.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: address PR review feedback + fix CI dead_code warning

Frontend (ScriptEditor.svelte):
- Fix switchToMain() missing lastSyncedCode update — prevents stale
  code sync on external changes while editing a module tab
- Fix formatAction saving module code to main script's localStorage
  draft — now saves main code when on a module tab
- Fix non-null assertion on inferModuleLang in renameModule — fall
  back to original language instead of force unwrap
- Remove redundant activeModuleTab truthy check in runTest

CLI (script.ts):
- Clean up empty directories after removing stale module files in
  writeModulesToDisk

Backend:
- Add path traversal guard in write_module_files — reject module
  paths containing ".."
- Fix dead_code warning on auto_kind field in workspace export struct

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* feat(frontend): improve auto_kind UX + address review findings

- Rename "Include without main function" toggle to "Include library
  scripts" in script list (ItemsList.svelte)
- Update NoMainFuncBadge: "No main" → "Library" with clearer tooltip
- Filter module file extensions by main script language — Python
  scripts only allow .py modules, TypeScript only .ts, etc.
- Split flushModuleState into flushModuleContent (no UI side-effect)
  and flushModuleState (flush + reset tab), reducing duplication
- Dynamic placeholder and hint text in add module popover based on
  main script language

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-17 01:20:09 +00:00

915 lines
27 KiB
Rust

use serde::Deserialize;
use serde_json::json;
use sqlx::{Pool, Postgres};
use windmill_common::{
jobs::{JobPayload, RawCode},
scripts::ScriptLang,
};
use windmill_test_utils::*;
#[derive(Debug, Deserialize)]
struct ListJobsResponse {
#[serde(rename = "type")]
#[allow(dead_code)]
typ: String,
id: String,
#[serde(default)]
args: Option<serde_json::Value>,
#[serde(flatten)]
_extra: std::collections::HashMap<String, serde_json::Value>,
}
/// Response struct for queue/list endpoint (no type field)
#[derive(Debug, Deserialize)]
struct QueueJobResponse {
id: String,
#[serde(default)]
args: Option<serde_json::Value>,
#[serde(flatten)]
_extra: std::collections::HashMap<String, serde_json::Value>,
}
/// Response struct for completed/list endpoint
#[cfg(feature = "python")]
#[derive(Debug, Deserialize)]
struct CompletedJobResponse {
id: String,
#[serde(default)]
args: Option<serde_json::Value>,
#[serde(flatten)]
_extra: std::collections::HashMap<String, serde_json::Value>,
}
/// Test that list_jobs returns jobs without args by default
#[sqlx::test(fixtures("base"))]
async fn test_list_jobs_without_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Push a job to the queue with specific args
let job_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.push(&db)
.await;
// Call list_jobs without include_args
let response = client
.client()
.get(format!("{}/w/test-workspace/jobs/list", client.baseurl()))
.send()
.await?;
assert!(response.status().is_success(), "list_jobs should succeed");
let jobs: Vec<ListJobsResponse> = response.json().await?;
// Find the job we created
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the created job");
// Args should be None when include_args is not set
assert!(
job.args.is_none(),
"args should not be included when include_args is not set"
);
Ok(())
}
/// Test that list_jobs returns jobs with args when include_args=true
#[sqlx::test(fixtures("base"))]
async fn test_list_jobs_with_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Push a job to the queue with specific args
let job_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.push(&db)
.await;
// Call list_jobs with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"list_jobs with include_args should succeed"
);
let jobs: Vec<ListJobsResponse> = response.json().await?;
// Find the job we created
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the created job");
// Args should be present when include_args=true
assert!(
job.args.is_some(),
"args should be included when include_args=true"
);
let args = job.args.as_ref().unwrap();
assert_eq!(
args.get("x"),
Some(&json!(42)),
"args should contain the correct value"
);
Ok(())
}
/// Test that list_jobs returns completed jobs with args when include_args=true
#[cfg(feature = "python")]
#[sqlx::test(fixtures("base"))]
async fn test_list_jobs_completed_with_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Run a job to completion
let completed_job = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.run_until_complete(&db, false, port)
.await;
let job_id = completed_job.id;
// Call list_jobs with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"list_jobs with include_args should succeed"
);
let jobs: Vec<ListJobsResponse> = response.json().await?;
// Find the completed job
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the completed job");
// Args should be present when include_args=true
assert!(
job.args.is_some(),
"args should be included for completed jobs when include_args=true"
);
let args = job.args.as_ref().unwrap();
assert_eq!(
args.get("x"),
Some(&json!(42)),
"args should contain the correct value for completed jobs"
);
Ok(())
}
/// Test that list_jobs returns both queued and completed jobs with args
#[cfg(feature = "python")]
#[sqlx::test(fixtures("base"))]
async fn test_list_jobs_mixed_queue_and_completed(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Run a job to completion first
let completed_job = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(completed_arg): return completed_arg".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("completed_arg", json!("completed_value"))
.run_until_complete(&db, false, port)
.await;
let completed_job_id = completed_job.id;
// Push another job to the queue (don't run it)
let queued_job_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(queued_arg): return queued_arg".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("queued_arg", json!("queued_value"))
.push(&db)
.await;
// Call list_jobs with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"list_jobs with include_args should succeed"
);
let jobs: Vec<ListJobsResponse> = response.json().await?;
// Find the completed job
let completed = jobs
.iter()
.find(|j| j.id == completed_job_id.to_string())
.expect("should find the completed job");
assert!(
completed.args.is_some(),
"completed job should have args when include_args=true"
);
assert_eq!(
completed.args.as_ref().unwrap().get("completed_arg"),
Some(&json!("completed_value")),
"completed job should have correct args"
);
// Find the queued job
let queued = jobs
.iter()
.find(|j| j.id == queued_job_id.to_string())
.expect("should find the queued job");
assert!(
queued.args.is_some(),
"queued job should have args when include_args=true"
);
assert_eq!(
queued.args.as_ref().unwrap().get("queued_arg"),
Some(&json!("queued_value")),
"queued job should have correct args"
);
Ok(())
}
/// Test list_jobs with multiple queued jobs and include_args
#[sqlx::test(fixtures("base"))]
async fn test_list_jobs_multiple_queued_with_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Push two jobs with different args
let job1_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(1))
.push(&db)
.await;
let job2_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(y): return y".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("y", json!(2))
.push(&db)
.await;
// Test with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(response.status().is_success(), "list_jobs should succeed");
let jobs: Vec<ListJobsResponse> = response.json().await?;
// Find both jobs
let job1 = jobs.iter().find(|j| j.id == job1_id.to_string())
.expect("should find job1");
let job2 = jobs.iter().find(|j| j.id == job2_id.to_string())
.expect("should find job2");
// Both should have args
assert!(job1.args.is_some(), "job1 args should be included");
assert!(job2.args.is_some(), "job2 args should be included");
// Check the args are correct
assert_eq!(
job1.args.as_ref().unwrap().get("x"),
Some(&json!(1)),
"job1 should have correct args"
);
assert_eq!(
job2.args.as_ref().unwrap().get("y"),
Some(&json!(2)),
"job2 should have correct args"
);
Ok(())
}
// ============================================================================
// Tests for /queue/list endpoint
// ============================================================================
/// Test that queue/list returns jobs without args by default
#[sqlx::test(fixtures("base"))]
async fn test_queue_list_without_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Push a job to the queue with specific args
let job_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.push(&db)
.await;
// Call queue/list without include_args
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/queue/list",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"queue/list should succeed"
);
let jobs: Vec<QueueJobResponse> = response.json().await?;
// Find the job we created
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the created job");
// Args should be None when include_args is not set
assert!(
job.args.is_none(),
"args should not be included when include_args is not set"
);
Ok(())
}
/// Test that queue/list returns jobs with args when include_args=true
#[sqlx::test(fixtures("base"))]
async fn test_queue_list_with_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Push a job to the queue with specific args
let job_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.push(&db)
.await;
// Call queue/list with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/queue/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"queue/list with include_args should succeed"
);
let jobs: Vec<QueueJobResponse> = response.json().await?;
// Find the job we created
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the created job");
// Args should be present when include_args=true
assert!(
job.args.is_some(),
"args should be included when include_args=true"
);
let args = job.args.as_ref().unwrap();
assert_eq!(
args.get("x"),
Some(&json!(42)),
"args should contain the correct value"
);
Ok(())
}
/// Test queue/list with multiple jobs and include_args=true
#[sqlx::test(fixtures("base"))]
async fn test_queue_list_multiple_jobs_with_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Push two jobs with different args
let job1_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(a): return a".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("a", json!("value_a"))
.push(&db)
.await;
let job2_id = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(b): return b".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("b", json!("value_b"))
.push(&db)
.await;
// Call queue/list with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/queue/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"queue/list should succeed"
);
let jobs: Vec<QueueJobResponse> = response.json().await?;
// Find both jobs
let job1 = jobs
.iter()
.find(|j| j.id == job1_id.to_string())
.expect("should find job1");
let job2 = jobs
.iter()
.find(|j| j.id == job2_id.to_string())
.expect("should find job2");
// Both should have args
assert!(job1.args.is_some(), "job1 args should be included");
assert!(job2.args.is_some(), "job2 args should be included");
// Check the args are correct
assert_eq!(
job1.args.as_ref().unwrap().get("a"),
Some(&json!("value_a")),
"job1 should have correct args"
);
assert_eq!(
job2.args.as_ref().unwrap().get("b"),
Some(&json!("value_b")),
"job2 should have correct args"
);
Ok(())
}
// ============================================================================
// Tests for /completed/list endpoint
// ============================================================================
/// Test that completed/list returns jobs without args by default
#[cfg(feature = "python")]
#[sqlx::test(fixtures("base"))]
async fn test_completed_list_without_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Run a job to completion
let completed_job = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.run_until_complete(&db, false, port)
.await;
let job_id = completed_job.id;
// Call completed/list without include_args
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/completed/list",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"completed/list should succeed"
);
let jobs: Vec<CompletedJobResponse> = response.json().await?;
// Find the completed job
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the completed job");
// Args should be None when include_args is not set
assert!(
job.args.is_none(),
"args should not be included when include_args is not set"
);
Ok(())
}
/// Test that completed/list returns jobs with args when include_args=true
#[cfg(feature = "python")]
#[sqlx::test(fixtures("base"))]
async fn test_completed_list_with_include_args(db: Pool<Postgres>) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Run a job to completion
let completed_job = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(x): return x * 2".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("x", json!(42))
.run_until_complete(&db, false, port)
.await;
let job_id = completed_job.id;
// Call completed/list with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/completed/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"completed/list with include_args should succeed"
);
let jobs: Vec<CompletedJobResponse> = response.json().await?;
// Find the completed job
let job = jobs
.iter()
.find(|j| j.id == job_id.to_string())
.expect("should find the completed job");
// Args should be present when include_args=true
assert!(
job.args.is_some(),
"args should be included when include_args=true"
);
let args = job.args.as_ref().unwrap();
assert_eq!(
args.get("x"),
Some(&json!(42)),
"args should contain the correct value"
);
Ok(())
}
/// Test completed/list with multiple jobs and include_args=true
#[cfg(feature = "python")]
#[sqlx::test(fixtures("base"))]
async fn test_completed_list_multiple_jobs_with_include_args(
db: Pool<Postgres>,
) -> anyhow::Result<()> {
initialize_tracing().await;
let server = ApiServer::start(db.clone()).await?;
let port = server.addr.port();
let client = windmill_api_client::create_client(
&format!("http://localhost:{port}"),
"SECRET_TOKEN".to_string(),
);
// Run first job to completion
let completed_job1 = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(a): return a".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("a", json!("completed_a"))
.run_until_complete(&db, false, port)
.await;
let job1_id = completed_job1.id;
// Run second job to completion
let completed_job2 = RunJob::from(JobPayload::Code(RawCode {
hash: None,
content: "def main(b): return b".to_string(),
path: None,
language: ScriptLang::Python3,
lock: None,
cache_ttl: None,
cache_ignore_s3_path: None,
dedicated_worker: None,
concurrency_settings:
windmill_common::runnable_settings::ConcurrencySettings::default().into(),
debouncing_settings: windmill_common::runnable_settings::DebouncingSettings::default(),
modules: None,
}))
.arg("b", json!("completed_b"))
.run_until_complete(&db, false, port)
.await;
let job2_id = completed_job2.id;
// Call completed/list with include_args=true
let response = client
.client()
.get(format!(
"{}/w/test-workspace/jobs/completed/list?include_args=true",
client.baseurl()
))
.send()
.await?;
assert!(
response.status().is_success(),
"completed/list should succeed"
);
let jobs: Vec<CompletedJobResponse> = response.json().await?;
// Find both completed jobs
let job1 = jobs
.iter()
.find(|j| j.id == job1_id.to_string())
.expect("should find job1");
let job2 = jobs
.iter()
.find(|j| j.id == job2_id.to_string())
.expect("should find job2");
// Both should have args
assert!(job1.args.is_some(), "job1 args should be included");
assert!(job2.args.is_some(), "job2 args should be included");
// Check the args are correct
assert_eq!(
job1.args.as_ref().unwrap().get("a"),
Some(&json!("completed_a")),
"job1 should have correct args"
);
assert_eq!(
job2.args.as_ref().unwrap().get("b"),
Some(&json!("completed_b")),
"job2 should have correct args"
);
Ok(())
}