Files
windmill/backend/windmill-queue/src/schedule.rs
T
Ruben Fiszel c2deea13b7 fix(security): a WM_TOKEN job token can never be a global superadmin (GHSA-hfh4-cx4h-3fcr) (#10124)
* fix(security): a WM_TOKEN job token can never be a global superadmin (GHSA-hfh4-cx4h-3fcr)

Privilege escalation: an app/flow/schedule/trigger execution policy's `on_behalf_of`
(which a `wm_deployers` member can set) could point at a superadmin email. The
resulting job `WM_TOKEN` then passed the email-based superadmin checks, granting
instance superadmin. `forbid_superadmin_job_token` only guarded ~15 of ~75 routes.

Fix at the token layer: a WM_TOKEN must never satisfy a superadmin gate,
regardless of whose email it runs as (sentinel OR a real superadmin).

- `ApiAuthed` gains a `job_id` field, stamped once in `AuthCache::get_opt_job_authed`
  from the resolved token's job_id (correct even on cache hits).
- `require_super_admin(db, email)` -> `require_super_admin(db, &ApiAuthed)`, rejects
  `authed.job_id.is_some()`. `require_super_admin_email` kept for the few internal
  callers without an ApiAuthed.
- `is_super_admin_authed(db, &ApiAuthed)` for the boolean `is_super_admin_email`
  authorization branches on request handlers (workspace deletion, fork drops,
  dev-workspace attach/archive, object-storage SSRF exemption, custom dbname, EE GHES
  + connected repositories, ...). Migrate ~75 sites (OSS + EE).
- CUSTOM_INSTANCE_DB reads the *authenticated* job_id, not the caller-supplied
  `?job_id` query param. Worker-tag check takes a precomputed job-aware `is_super_admin`
  on the request path.

Execution-time on-behalf checks (scheduled/flow worker-tag, Cloud enqueue quota,
is_devops_email) are hardened in a follow-up — see
docs/followup-onbehalf-execution-privilege-hardening.md.

Regression tests: a superadmin-email WM_TOKEN is rejected on `require_super_admin`
routes, on `DELETE /workspaces/delete/{w}` (403, workspace preserved), and on the
CUSTOM_INSTANCE_DB lookup with no `?job_id` (401); real superadmin tokens still succeed.

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

* fix: cap devops role at workspace admin and reject reserved on_behalf_of identities

Extends the job-token cap with three pieces:

- `require_devops_role` takes `&ApiAuthed` and rejects job tokens.
  `is_devops_email` is true for superadmin emails, so every worker-management,
  instance-config and service-log route was reachable by the same superadmin
  `WM_TOKEN` that `require_super_admin` already rejects.
- A `job_id` claim that does not parse as a uuid rejects the token rather than
  resolving to `None`, which would clear the job provenance and uncap it. Applies
  to the internal JWT and the external `jwt_ext_` path.
- Defense in depth at store time: `validate_on_behalf_of` refuses the reserved
  internal sentinels as an `on_behalf_of` on apps/flows/scripts/schedules/triggers,
  and app execution refuses a policy carrying one — covering already-persisted and
  forked-app rows that predate the cap. Deploying on behalf of a real user,
  including a real superadmin, stays allowed; the cap handles that at execution.

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

* fix(mcp): preserve job-token provenance when minting the proxy JWT

The MCP endpoint-tool proxy re-mints a JWT from the caller's ApiAuthed to
forward the proxied request, but passed job_id: None. A job's WM_TOKEN is
capped at workspace admin (GHSA-hfh4-cx4h-3fcr); dropping the job_id here
re-minted an uncapped token that satisfies require_super_admin /
require_devops_role on the proxied route (e.g. listWorkers exposing worker
IPs, job/workspace IDs, and sensitive tags).

Carry api_authed.job_id into create_jwt_token. Adds an in-module regression
that decodes the forwarded JWT and asserts the job_id is preserved for a job
caller and absent for a non-job caller.

Reported by Codex CI review (P1) on #10124.

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

* fix: cap the admin-or-devops gate at workspace admin for job tokens

require_admin_or_devops (the EE critical-alerts endpoints) grants when the
caller is a workspace admin OR an instance devops. is_devops_email is true
for superadmins, so a WM_TOKEN running on-behalf of a superadmin who is not a
member of the target workspace could clear the devops branch and read/ack that
workspace's critical alerts (GHSA-hfh4-cx4h-3fcr). This gate takes a bare
email, not an ApiAuthed, so the token-layer cap could not see it.

Thread the caller's job-token provenance and reject the devops branch for job
tokens, matching require_devops_role. The workspace-admin branch stays allowed
— that is the cap ceiling. Adds an enterprise-gated regression proving the
bypass is closed and a real superadmin token still clears the gate.

Found while auditing the PR for bare-email gates the choke-point cap misses.

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

* fix: cap instance-global is_admin gates at workspace admin for job tokens

Three instance-global routes gate on the caller's own `is_admin` claim, which
`ApiAuthed.is_admin` carries into a WM_TOKEN (it is a workspace-admin claim,
true for superadmins too). A job token is capped at workspace admin
(GHSA-hfh4-cx4h-3fcr), so its is_admin claim must not authorize instance
actions on a route with no workspace binding:

- `unarchive_workspace` — unarchive an arbitrary workspace by id
- `prune_concurrency_group` — delete a global concurrency group
- `list_worker_groups` — return unobfuscated `env_vars_static` (may hold secrets)

Add job-token-aware `is_instance_admin` / `require_instance_admin` helpers (the
same shape as `require_super_admin` / `require_devops_role`) and use them at
these three sites. Workspace-scoped `require_admin(authed.is_admin, ...)` gates
are intentionally left unchanged — a workspace-admin job token is within the
cap there. Regression added covering all three; verified it lets a WM_TOKEN
unarchive/leak without the fix and is blocked with it.

Reported by Codex CI review (P1) on #10124.

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

* fix(mcp): drop orphaned path_field_renames from EndpointTool test helper

The merge with main adopted main's mcp path-substitution refactor (#10162),
which removed the `path_field_renames` field from `EndpointTool` and its
consumer (`substitute_path_params` no longer takes per-field path renames).
main's `runner.rs` `ep` test helper still constructed the struct with
`path_field_renames: None`, so the workspace test build (cargo test --all,
which compiles windmill-mcp's own #[cfg(test)] module under the `server`
feature) failed with E0560. A plain `cargo check` does not compile that test
module, so it only surfaced in CI's cargo_test.

Remove the orphaned field to match the struct.

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

* test: describe the sentinel-rejection policy the forged-identity test asserts

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: complete ApiAuthed initializers in feature-gated tests after merge

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: stop job tokens minting credentials that shed their provenance

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: cap the MCP OAuth approval mint at the same elevated-job-token gate

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: cap the self-service password reset at the elevated-job-token gate

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: cap app embed/SDK mints and scope widening at the elevated-job-token gate

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: keep job tokens from destroying the account they run on behalf of

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: deny job tokens a foreign-workspace admin claim and workspace ejection

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: keep the follow-up inventory in the PR instead of the repo

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: make the session workspace status gate job-token aware

session_workspace_status derived its superadmin branch from a bare email
check, so a job token carrying a superadmin identity resolved the existence
of workspaces it has no relationship with rather than seeing them as
deleted. Switch to is_super_admin_authed, matching every other instance
gate reached from a request ApiAuthed.

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

* revert: leave the global concurrency-group listing on the plain admin gate

The listing exposes concurrency keys across workspaces, which is metadata
rather than a capability, and it 401s rather than degrading. Keep the guard
on the prune route next to it, which is the destructive one.

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

* fix: keep the instance-admin gate on the global concurrency listing

The listing spans every workspace's concurrency keys, and the gate rejects
only job tokens: the !is_admin branch is the pre-existing check, so
workspaced tokens and interactive admins are unaffected.

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

* chore: update ee-repo-ref to d30af67d38954f9012f7bad08da23e347344b4c6

This commit updates the EE repository reference after PR #664 was merged in windmill-ee-private.

Previous ee-repo-ref: 7870573dbc3360f99bada143f094c67dce0d9e9c

New ee-repo-ref: d30af67d38954f9012f7bad08da23e347344b4c6

Automated by sync-ee-ref workflow.

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: hugocasa <hugo@casademont.ch>
Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com>
2026-08-19 22:33:46 +02:00

762 lines
28 KiB
Rust

/*
* Author: Ruben Fiszel
* Copyright: Windmill Labs, Inc 2022
* This file and its contents are licensed under the AGPLv3 License.
* Please see the included NOTICE for copyright information and
* LICENSE-AGPL for a copy of the license.
*/
use crate::push;
use crate::PushIsolationLevel;
use anyhow::Context;
use chrono::DateTime;
use chrono::Utc;
use sqlx::{PgExecutor, Postgres, Transaction};
use std::collections::HashMap;
use std::str::FromStr;
use windmill_common::db::Authed;
use windmill_common::ee_oss::LICENSE_KEY_VALID;
use windmill_common::flows::Retry;
use windmill_common::get_flow_version_info_from_version;
use windmill_common::get_latest_flow_version_id_for_path;
use windmill_common::jobs::check_tag_available_for_workspace_internal;
use windmill_common::jobs::JobPayload;
use windmill_common::jobs::JobTriggerKind;
use windmill_common::jobs::OnBehalfOf;
use windmill_common::runnable_settings::ConcurrencySettings;
use windmill_common::runnable_settings::DebouncingSettings;
use windmill_common::schedule::schedule_to_user;
use windmill_common::scripts::ScriptHash;
use windmill_common::triggers::TriggerMetadata;
use windmill_common::utils::WarnAfterExt;
use windmill_common::worker::to_raw_value;
use windmill_common::FlowVersionInfo;
use windmill_common::DB;
use windmill_common::{
error::{self, Result},
schedule::Schedule,
utils::{now_from_db, ScheduleType, StripPath},
};
/// Helper to fetch metadata for a schedule's script or flow
async fn get_schedule_metadata<'c>(
tx: &mut sqlx::Transaction<'c, sqlx::Postgres>,
db: &DB,
schedule: &Schedule,
) -> Result<(
Option<String>, // tag
Option<i32>, // timeout
Option<OnBehalfOf>, // identity the runnable is deployed to run as
Option<ScriptHash>, // hash (for scripts)
Option<i64>, // flow_version (for flows)
Option<Retry>, // retry
)> {
let parsed_retry = schedule
.retry
.clone()
.and_then(|r| serde_json::from_value::<Retry>(r).ok());
if schedule.is_flow {
let version = get_latest_flow_version_id_for_path(
None,
&mut **tx,
&schedule.workspace_id,
&schedule.script_path,
false,
)
.await?;
let flow_info = get_flow_version_info_from_version(
&mut **tx,
version,
&schedule.workspace_id,
&schedule.script_path,
)
.await?;
Ok((
flow_info.tag.clone(),
None,
flow_info.on_behalf_of(&schedule.workspace_id, db).await?,
None,
Some(version),
parsed_retry,
))
} else {
let (
hash,
tag,
_custom_concurrency_key,
_concurrent_limit,
_concurrency_time_window_s,
_debounce_key,
_debounce_delay_s,
_cache_ttl,
_cache_ignore_s3_path,
_language,
_dedicated_worker,
_priority,
timeout,
on_behalf_of,
_runnable_settings_handle,
_labels,
) = windmill_common::get_latest_hash_for_path(
&mut **tx,
db,
&schedule.workspace_id,
&schedule.script_path,
false,
)
.await?;
Ok((tag, timeout, on_behalf_of, Some(hash), None, parsed_retry))
}
}
pub async fn push_scheduled_job<'c>(
db: &DB,
mut tx: Transaction<'c, Postgres>,
schedule: &Schedule,
authed: Option<&Authed>,
now_cutoff: Option<DateTime<Utc>>,
) -> Result<Transaction<'c, Postgres>> {
if !LICENSE_KEY_VALID.load(std::sync::atomic::Ordering::Relaxed) {
return Err(error::Error::BadRequest(
"License key is not valid. Go to your superadmin settings to update your license key."
.to_string(),
));
}
let sched =
ScheduleType::from_str(&schedule.schedule, schedule.cron_version.as_deref(), false)?;
let tz = chrono_tz::Tz::from_str(&schedule.timezone)
.map_err(|e| error::Error::BadRequest(e.to_string()))?;
let now = now_from_db(&mut *tx).await?;
let now = match now_cutoff {
Some(now_cutoff) if now_cutoff >= now => {
tracing::error!(
"now_cutoff ({:?}) is after now ({:?}) for schedule {}. Using now_cutoff + 1s. This likely means the pg clock was shifted backwards.",
now_cutoff,
now,
&schedule.path
);
now_cutoff + chrono::Duration::seconds(1)
}
_ => now,
};
let starting_from = match schedule.paused_until {
Some(paused_until) if paused_until > now => paused_until.with_timezone(&tz),
paused_until_o => {
if paused_until_o.is_some() {
sqlx::query!(
"UPDATE schedule SET paused_until = NULL WHERE workspace_id = $1 AND path = $2",
&schedule.workspace_id,
&schedule.path
)
.execute(&mut *tx)
.warn_after_seconds_with_sql(1, "update_schedule_paused_until".to_string())
.await
.context("Failed to clear paused_until for schedule")?;
}
now.with_timezone(&tz)
}
};
let next = sched.find_next(&starting_from);
// println!("next event ({:?}): {}", tz, next);
// println!("next event(UTC): {}", next.with_timezone(&chrono::Utc));
// Scheduled events must be stored in the database in UTC
let next = next.with_timezone(&chrono::Utc);
// panic!("next: {}", next);
let already_exists: bool = sqlx::query_scalar!(
// Query plan:
// - use of the `ix_v2_job_root_by_path` index; hence the `parent_job IS NULL` clause.
// - select from `v2_job` first, then join with `v2_job_queue` to avoid a full table scan
// on `scheduled_for = $3`.
"SELECT EXISTS (
SELECT 1 FROM v2_job j JOIN v2_job_queue USING (id)
WHERE j.workspace_id = $1 AND trigger_kind = 'schedule' AND trigger = $2 AND runnable_path = $4
AND parent_job IS NULL
AND scheduled_for = $3
)",
&schedule.workspace_id,
&schedule.path,
next,
&schedule.script_path
)
.fetch_one(&mut *tx)
.warn_after_seconds_with_sql(1, "already_exists_job".to_string())
.await?
.unwrap_or(false);
if already_exists {
tracing::warn!(
"Job for schedule {} at {} already exists",
&schedule.path,
next
);
return Ok(tx);
}
let mut args: HashMap<String, Box<serde_json::value::RawValue>> = HashMap::new();
if let Some(args_v) = &schedule.args {
if let Ok(args_m) =
serde_json::from_str::<HashMap<String, Box<serde_json::value::RawValue>>>(args_v.get())
{
args = args_m.clone()
} else {
return Err(error::Error::ExecutionErr(
"args of scripts needs to be dict".to_string(),
));
}
}
// Managed ducklake maintenance schedule (enterprise): the runnable is a
// generated DuckDB script, not a deployed one — built in the EE module.
// None (CE build, or no enabled maintenance config for the path's lake)
// falls through to normal script resolution, so a user schedule that
// pre-dates the reserved prefix keeps running its script and a stale
// managed row fails resolution with NotFound (auto-disabling it with
// schedule.error recorded).
let maintenance_payload =
if windmill_common::workspaces::lake_from_ducklake_maintenance_path(&schedule.path)
.is_some()
{
crate::ducklake_maintenance::build_maintenance_schedule_payload(&mut tx, schedule)
.await?
} else {
None
};
// If schedule handler is defined, wrap the scheduled job in a synthetic flow
// with the handler as the first step (with stop_after_if to skip if handler returns false)
let (payload, tag, timeout, on_behalf_of) = if let Some(maintenance_payload) =
maintenance_payload
{
maintenance_payload
} else if let Some(handler_path) = &schedule.dynamic_skip {
// Build skip handler args
let mut skip_handler_args = HashMap::<String, Box<serde_json::value::RawValue>>::new();
skip_handler_args.insert(
"scheduled_for".to_string(),
to_raw_value(&next.to_rfc3339()),
);
let stop_condition = "result !== true".to_string();
let stop_message = format!(
"Schedule handler {} did not return true for datetime {}. Handler must return boolean true to execute scheduled job.",
handler_path,
next.to_rfc3339()
);
// Get metadata from the scheduled script/flow for tag, timeout, etc.
let (tag, timeout, on_behalf_of, hash, flow_version, retry) =
get_schedule_metadata(&mut tx, db, schedule).await?;
(
JobPayload::SingleStepFlow {
path: schedule.script_path.clone(),
hash,
flow_version,
language: None,
args: args.clone(),
retry,
error_handler_path: None,
error_handler_args: None,
skip_handler: Some(windmill_common::jobs::SkipHandler {
path: handler_path.clone(),
args: skip_handler_args,
stop_condition,
stop_message,
}),
cache_ttl: None,
cache_ignore_s3_path: None,
priority: None,
tag_override: schedule.tag.clone(),
trigger_path: None,
apply_preprocessor: false,
concurrency_settings: ConcurrencySettings::default(),
debouncing_settings: DebouncingSettings::default(),
},
if schedule.tag.as_ref().is_some_and(|x| x != "") {
schedule.tag.clone()
} else {
tag
},
timeout,
on_behalf_of,
)
} else if schedule.is_flow {
let version = get_latest_flow_version_id_for_path(
None,
&mut *tx,
&schedule.workspace_id,
&schedule.script_path,
false,
)
.warn_after_seconds_with_sql(1, "get_latest_flow_version_id_for_path".to_string())
.await?;
let flow_info = get_flow_version_info_from_version(
&mut *tx,
version,
&schedule.workspace_id,
&schedule.script_path,
)
.warn_after_seconds_with_sql(1, "get_flow_version_info_from_version".to_string())
.await?;
let on_behalf_of = flow_info.on_behalf_of(&schedule.workspace_id, db).await?;
let FlowVersionInfo { version, tag, dedicated_worker, labels, .. } = flow_info;
(
JobPayload::Flow {
path: schedule.script_path.clone(),
dedicated_worker,
apply_preprocessor: false,
version,
labels,
},
tag,
None,
on_behalf_of,
)
} else {
let (
hash,
tag,
concurrency_key,
concurrent_limit,
concurrency_time_window_s,
debounce_key,
debounce_delay_s,
cache_ttl,
cache_ignore_s3_path,
language,
dedicated_worker,
priority,
timeout,
on_behalf_of,
runnable_settings_handle,
labels,
) = windmill_common::get_latest_hash_for_path(
&mut *tx,
db,
&schedule.workspace_id,
&schedule.script_path,
false,
)
.warn_after_seconds_with_sql(1, "get_latest_hash_for_path".to_string())
.await?;
// NB: read on the non-RLS pool (`db`), not `tx`. push_scheduled_job is
// also invoked with an RLS user_db transaction (api-schedule/api-flows),
// under which these lookups would resolve against the caller's row
// visibility rather than the full table. The dual-connection here is
// intentional and required for correctness.
let (debouncing_settings, concurrency_settings) =
windmill_common::runnable_settings::prefetch_cached_from_handle(
runnable_settings_handle,
db,
)
.await?;
if schedule.retry.is_some() {
let parsed_retry = serde_json::from_value::<Retry>(schedule.retry.clone().unwrap())
.map_err(|err| {
error::Error::internal_err(format!(
"Unable to parse retry information from schedule: {}",
err.to_string(),
))
})?;
let mut static_args = HashMap::<String, Box<serde_json::value::RawValue>>::new();
for (arg_name, arg_value) in args.clone() {
static_args.insert(arg_name, arg_value);
}
// A retry on a scheduled script is materialized into a native retry
// (see `push`): `Some(language)` opts in. Completion handlers are
// driven from the terminal attempt, and the per-occurrence
// failure/recovery counting queries (apply_schedule_handlers) resolve
// terminal status across the retry chain — so on_failure/on_recovery
// (incl. multi-count/exact) are all handled. A `retry_if` gate is
// evaluated at failure time; on a worker built without quickjs it
// cannot be evaluated and fails closed (no retry).
(
JobPayload::SingleStepFlow {
path: schedule.script_path.clone(),
hash: Some(hash),
flow_version: None,
language: Some(language),
retry: Some(parsed_retry),
error_handler_path: None,
error_handler_args: None,
skip_handler: None,
args: static_args,
cache_ttl,
cache_ignore_s3_path,
priority,
tag_override: schedule.tag.clone(),
trigger_path: None,
apply_preprocessor: false,
// Carry the script's concurrency/debounce settings (fetched
// above) into the native retry materialization, so a retrying
// concurrency-limited scheduled script still inserts its
// concurrency_key instead of running unbounded.
concurrency_settings,
debouncing_settings,
},
if schedule.tag.as_ref().is_some_and(|x| x != "") {
schedule.tag.clone()
} else {
tag
},
timeout,
on_behalf_of.clone(),
)
} else {
(
JobPayload::ScriptHash {
hash,
path: schedule.script_path.clone(),
cache_ttl,
cache_ignore_s3_path,
dedicated_worker,
language,
priority,
apply_preprocessor: false,
debouncing_settings: debouncing_settings
.maybe_fallback(debounce_key, debounce_delay_s),
concurrency_settings: concurrency_settings.maybe_fallback(
concurrency_key,
concurrent_limit,
concurrency_time_window_s,
),
labels,
},
if schedule.tag.as_ref().is_some_and(|x| x != "") {
schedule.tag.clone()
} else {
tag
},
timeout,
on_behalf_of,
)
}
};
if let Err(e) = sqlx::query!(
"UPDATE schedule SET error = NULL WHERE workspace_id = $1 AND path = $2",
&schedule.workspace_id,
&schedule.path
)
.execute(&mut *tx)
.warn_after_seconds_with_sql(1, "clear_schedule_error".to_string())
.await
{
tracing::error!(
"Failed to clear error for schedule {}: {}",
&schedule.path,
e
);
};
let (email, permissioned_as, push_authed, revert_to_windmill_user) = if let Some(obo) =
on_behalf_of.as_ref()
{
let is_windmill_user =
sqlx::query_scalar!("SELECT CURRENT_USER = 'windmill_user' as \"is_windmill_user!\"")
.fetch_one(&mut *tx)
.warn_after_seconds_with_sql(1, "is_windmill_user".to_string())
.await?;
if is_windmill_user {
sqlx::query!("SET LOCAL ROLE NONE")
.execute(&mut *tx)
.warn_after_seconds_with_sql(1, "set_local_role_none".to_string())
.await?;
}
(
obo.email.clone(),
obo.permissioned_as.clone(),
None,
is_windmill_user,
)
} else {
let permissioned_as = schedule.permissioned_as.clone();
let resolved_email = windmill_common::users::get_email_from_permissioned_as(
&permissioned_as,
&schedule.workspace_id,
db,
)
.await?;
(resolved_email, permissioned_as, authed, false)
};
let obo_authed;
let push_authed = match push_authed {
Some(a) => Some(a),
None => {
obo_authed = windmill_common::auth::fetch_authed_from_permissioned_as(
&permissioned_as,
&email,
&schedule.workspace_id,
&mut *tx,
)
.await
.ok();
obo_authed.as_ref()
}
};
if let Some(tag) = tag.as_deref().filter(|t| !t.is_empty()) {
let is_super_admin = windmill_common::auth::is_super_admin_email(db, &email).await?;
check_tag_available_for_workspace_internal(
db,
&schedule.workspace_id,
&tag,
is_super_admin,
None, // no token for schedules so no scopes so no scope_tags
)
.warn_after_seconds_with_sql(1, "check_tag_available_for_workspace_internal".to_string())
.await?;
}
tracing::info!(
"Pushing next scheduled job for schedule {} at {} (schedule: {})",
&schedule.path,
next,
&schedule.schedule
);
let tx = PushIsolationLevel::Transaction(tx);
let (_, mut tx) = push(
&db,
tx,
&schedule.workspace_id,
payload,
crate::PushArgs { args: &args, extra: None },
&schedule_to_user(&schedule.path),
&email,
permissioned_as,
Some(&schedule.path),
None,
Some(next),
Some(schedule.path.clone()),
None,
None,
None,
None,
false,
false,
None,
true,
tag,
timeout,
None,
None,
push_authed,
false,
None,
Some(TriggerMetadata::new(
Some(schedule.path.clone()),
JobTriggerKind::Schedule,
)),
None,
)
.warn_after_seconds_with_sql(1, "push in push_scheduled_job".to_string())
.await?;
if revert_to_windmill_user {
sqlx::query!("SET LOCAL ROLE windmill_user")
.execute(&mut *tx)
.warn_after_seconds_with_sql(1, "set_local_role_windmill_user".to_string())
.await?;
}
Ok(tx) // TODO: Bubble up pushed UUID from here
}
/// Enabled schedules with no occurrence in the queue, as `(workspace_id, path)`.
///
/// Every path that completes a scheduled job pushes the next occurrence in the
/// same transaction (for flows, on entry to step 0), so an enabled schedule
/// always has a queued occurrence — a run in progress is itself one. A run that
/// dies through an abnormal path can skip that push though, leaving the schedule
/// enabled yet dead until it is manually disabled and re-enabled. This is how the
/// monitor spots that state; see `rearm_schedule` for the recovery.
///
/// Not an authorization boundary: it reports schedules across every workspace, so
/// this is for system callers (the monitor's reconciliation pass) only and its
/// result must never be returned to a user unfiltered.
pub async fn find_unarmed_schedules(db: &DB) -> Result<Vec<(String, String)>> {
let rows = sqlx::query!(
// Query plan: the anti-join builds from `v2_job_queue` (only pending and
// running jobs) rather than probing `v2_job` once per schedule.
"SELECT s.workspace_id, s.path
FROM schedule s JOIN workspace w ON w.id = s.workspace_id AND NOT w.deleted
WHERE s.enabled IS TRUE
AND NOT EXISTS (
SELECT 1 FROM v2_job_queue q JOIN v2_job j USING (id)
WHERE j.workspace_id = s.workspace_id
AND j.trigger_kind = 'schedule'
AND j.trigger = s.path
AND j.runnable_path = s.script_path
AND j.parent_job IS NULL
)"
)
.fetch_all(db)
.await?;
Ok(rows.into_iter().map(|r| (r.workspace_id, r.path)).collect())
}
#[derive(Debug, PartialEq, Eq)]
pub enum RearmOutcome {
/// The next occurrence was pushed.
Rearmed,
/// Nothing to do: the schedule was deleted or disabled since it was found.
NoOp,
}
/// Push the next occurrence of a schedule that has none queued.
///
/// Only ever starts a schedule, never stops one: re-arming something that did not
/// need it costs one extra run, whereas wrongly disabling one is the silent
/// permanent stoppage this whole mechanism exists to prevent. So an occurrence
/// that cannot be pushed is logged and left alone — the schedule is already not
/// running, and `try_schedule_next_job` still disables on the completion path,
/// where the population is limited to actively-cycling schedules. Keep it that
/// way: this sweeps *every* enabled schedule, including ones broken long before
/// this code existed and never swept before.
///
/// Not an authorization boundary: it pushes under the schedule's own
/// `permissioned_as` identity for any `(w_id, path)`, so this is for system
/// callers (the monitor's reconciliation pass) only. A caller acting for a user
/// MUST already have enforced their permissions on `w_id` and `path`.
pub async fn rearm_schedule(db: &DB, w_id: &str, path: &str) -> Result<RearmOutcome> {
let mut tx = db.begin().await?;
// Lock the row for the whole push: an edit or a disable committing between the
// read and the push would otherwise leave a queued occurrence for a schedule
// that is disabled, or one built from superseded settings.
let schedule = sqlx::query_as::<_, Schedule>(
"SELECT workspace_id, path, edited_by, edited_at, schedule, timezone, enabled, script_path, is_flow, args, extra_perms, email, permissioned_as, error, on_failure, on_failure_times, on_failure_exact, on_failure_extra_args, on_recovery, on_recovery_times, on_recovery_extra_args, on_success, on_success_extra_args, ws_error_handler_muted, retry, no_flow_overlap, summary, description, tag, paused_until, cron_version, dynamic_skip, labels FROM schedule WHERE path = $1 AND workspace_id = $2 FOR UPDATE",
)
.bind(path)
.bind(w_id)
.fetch_optional(&mut *tx)
.await?;
let Some(schedule) = schedule else {
return Ok(RearmOutcome::NoOp);
};
if !schedule.enabled {
return Ok(RearmOutcome::NoOp);
}
// Re-check for a queued occurrence now that the row is locked: a normal
// completion, an edit, or a re-enable could have pushed one between the unarmed
// scan and this lock. push_scheduled_job only dedups the exact computed
// scheduled_for, so re-arming a schedule that has since become armed and crossed a
// cron boundary would queue a second root occurrence. Mirrors the anti-join in
// find_unarmed_schedules.
let already_armed: bool = sqlx::query_scalar(
"SELECT EXISTS (
SELECT 1 FROM v2_job_queue q JOIN v2_job j USING (id)
WHERE j.workspace_id = $1
AND j.trigger_kind = 'schedule'
AND j.trigger = $2
AND j.runnable_path = $3
AND j.parent_job IS NULL
)",
)
.bind(w_id)
.bind(path)
.bind(&schedule.script_path)
.fetch_one(&mut *tx)
.await?;
if already_armed {
return Ok(RearmOutcome::NoOp);
}
match push_scheduled_job(db, tx, &schedule, None, None).await {
Ok(tx) => {
tx.commit().await?;
Ok(RearmOutcome::Rearmed)
}
// An occurrence that can never be pushed (runnable gone, quota blown) is
// reported, not acted on — see the note above on why this never disables.
Err(err @ (error::Error::NotFound(_) | error::Error::QuotaExceeded(_))) => {
tracing::error!(
"Could not re-arm schedule {path} in {w_id}: {err}. Leaving it enabled; it will not run until the cause is fixed."
);
Ok(RearmOutcome::NoOp)
}
Err(err) => Err(err),
}
}
pub async fn get_schedule_opt<'c>(
e: impl PgExecutor<'c>,
w_id: &str,
path: &str,
) -> Result<Option<Schedule>> {
let schedule_opt = sqlx::query_as::<_, Schedule>(
"SELECT workspace_id, path, edited_by, edited_at, schedule, timezone, enabled, script_path, is_flow, args, extra_perms, email, permissioned_as, error, on_failure, on_failure_times, on_failure_exact, on_failure_extra_args, on_recovery, on_recovery_times, on_recovery_extra_args, on_success, on_success_extra_args, ws_error_handler_muted, retry, no_flow_overlap, summary, description, tag, paused_until, cron_version, dynamic_skip, labels FROM schedule WHERE path = $1 AND workspace_id = $2",
)
.bind(path)
.bind(w_id)
.fetch_optional(e)
.await?;
Ok(schedule_opt)
}
pub async fn exists_schedule(
tx: &mut Transaction<'_, Postgres>,
w_id: String,
path: StripPath,
) -> Result<bool> {
let path = path.to_path();
let exists = sqlx::query_scalar!(
"SELECT EXISTS(SELECT 1 FROM schedule WHERE path = $1 AND workspace_id = $2)",
path,
w_id
)
.fetch_one(&mut **tx)
.await?
.unwrap_or(false);
Ok(exists)
}
pub async fn clear_schedule<'c>(
tx: &mut Transaction<'c, Postgres>,
path: &str,
w_id: &str,
) -> Result<()> {
tracing::info!("Clearing schedule {}", path);
// Delete the queued jobs (cascading their v2_job_queue-keyed side tables), then route the
// freed ids through delete_jobs so v2_job and its no-longer-cascading side tables go too.
let deleted_ids: Vec<uuid::Uuid> = sqlx::query_scalar!(
"WITH to_delete AS (
SELECT id FROM v2_job_queue
JOIN v2_job j USING (id)
WHERE trigger_kind = 'schedule'
AND trigger = $1
AND j.workspace_id = $2
AND flow_step_id IS NULL
AND running = false
FOR UPDATE
)
DELETE FROM v2_job_queue
WHERE id IN (SELECT id FROM to_delete)
RETURNING id",
path,
w_id
)
.fetch_all(&mut **tx)
.await?;
windmill_common::jobs::delete_jobs(&mut **tx, &deleted_ids).await?;
Ok(())
}