Add forced full-site rendering
This commit is contained in:
@@ -258,6 +258,7 @@ pub enum Message {
|
||||
),
|
||||
ValidateMedia,
|
||||
GenerateSite,
|
||||
ForceGenerateSite,
|
||||
RunMetadataDiff,
|
||||
MetadataDiffLoaded(Result<engine::metadata_diff::DiffReport, String>),
|
||||
RepairMetadataDiffItem {
|
||||
@@ -428,6 +429,7 @@ pub enum Message {
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
enum SiteGenerationKind {
|
||||
Full,
|
||||
Forced,
|
||||
Validation,
|
||||
}
|
||||
|
||||
@@ -2839,6 +2841,7 @@ impl BdsApp {
|
||||
| Message::TranslationValidationLoaded(_)
|
||||
| Message::ValidateMedia
|
||||
| Message::GenerateSite
|
||||
| Message::ForceGenerateSite
|
||||
| Message::RunMetadataDiff
|
||||
| Message::MetadataDiffLoaded(_)
|
||||
| Message::RepairMetadataDiffItem { .. }
|
||||
@@ -4444,6 +4447,7 @@ impl BdsApp {
|
||||
)
|
||||
}
|
||||
MenuAction::GenerateSitemap => Task::done(Message::GenerateSite),
|
||||
MenuAction::ForceRenderSite => Task::done(Message::ForceGenerateSite),
|
||||
MenuAction::ValidateSite => {
|
||||
self.open_singleton_tab(TabType::SiteValidation, "tabBar.siteValidation");
|
||||
self.start_site_validation()
|
||||
@@ -10137,7 +10141,7 @@ fn remote_error_closes_connection(code: &str) -> bool {
|
||||
mod tests {
|
||||
use super::{
|
||||
BdsApp, Message, POST_AUTO_SAVE_DELAY_MS, PersistedMediaState, PersistedPostState,
|
||||
PostStatus, SettingsMsg, active_post_tab_id, dropped_image_target,
|
||||
PostStatus, SettingsMsg, SiteGenerationKind, active_post_tab_id, dropped_image_target,
|
||||
flush_embeddings_and_exit, localize_chat_error, month_abbreviation,
|
||||
persist_media_editor_state_impl, persist_post_editor_preview_state_impl,
|
||||
persist_post_editor_state_impl, remote_error_closes_connection,
|
||||
@@ -11215,6 +11219,28 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn forced_generation_uses_its_own_full_site_task_group() {
|
||||
let (db, project, tmp) = setup();
|
||||
enable_generation(&tmp);
|
||||
let mut app = make_app(db, project, &tmp);
|
||||
|
||||
let _task = app.handle_engine_message(Message::ForceGenerateSite);
|
||||
let snapshots = app.task_manager.snapshots();
|
||||
|
||||
assert_eq!(snapshots.len(), 5);
|
||||
assert!(
|
||||
snapshots
|
||||
.iter()
|
||||
.all(|task| { task.group_name.as_deref() == Some("Force Render Site") })
|
||||
);
|
||||
let group_id = snapshots[0].group_id.as_ref().unwrap();
|
||||
assert_eq!(
|
||||
app.site_generation_workflows[group_id].kind,
|
||||
SiteGenerationKind::Forced
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn search_index_is_queued_only_after_every_render_task_succeeds() {
|
||||
let (db, project, tmp) = setup();
|
||||
|
||||
@@ -144,6 +144,7 @@ impl BdsApp {
|
||||
)
|
||||
}
|
||||
Message::GenerateSite => self.queue_site_generation(None),
|
||||
Message::ForceGenerateSite => self.queue_forced_site_generation(),
|
||||
Message::RunMetadataDiff => {
|
||||
self.open_singleton_tab(TabType::MetadataDiff, "tabBar.metadataDiff");
|
||||
self.start_metadata_diff()
|
||||
@@ -311,19 +312,22 @@ impl BdsApp {
|
||||
Err(error) => {
|
||||
self.task_manager.fail(task_id, error.clone());
|
||||
self.task_manager.cancel_group(&group_id);
|
||||
if let Some(workflow) = self.site_generation_workflows.remove(&group_id)
|
||||
&& workflow.kind == SiteGenerationKind::Validation
|
||||
let workflow = self.site_generation_workflows.remove(&group_id);
|
||||
if workflow
|
||||
.as_ref()
|
||||
.is_some_and(|workflow| workflow.kind == SiteGenerationKind::Validation)
|
||||
{
|
||||
self.site_validation_state.is_applying = false;
|
||||
self.site_validation_state.error_message = Some(error.clone());
|
||||
}
|
||||
let operation = workflow.map_or_else(
|
||||
|| t(self.ui_locale, "engine.renderSiteGroup"),
|
||||
|workflow| workflow.group_name,
|
||||
);
|
||||
let message = tw(
|
||||
self.ui_locale,
|
||||
"common.operationFailed",
|
||||
&[
|
||||
("operation", &t(self.ui_locale, "engine.renderSiteGroup")),
|
||||
("error", &error),
|
||||
],
|
||||
&[("operation", &operation), ("error", &error)],
|
||||
);
|
||||
self.notify(ToastLevel::Error, &message);
|
||||
self.refresh_task_snapshots();
|
||||
|
||||
@@ -36,9 +36,23 @@ impl BdsApp {
|
||||
pub(super) fn queue_site_generation(
|
||||
&mut self,
|
||||
validation: Option<engine::validate_site::SiteValidationReport>,
|
||||
) -> Task<Message> {
|
||||
self.queue_site_generation_mode(validation, false)
|
||||
}
|
||||
|
||||
pub(super) fn queue_forced_site_generation(&mut self) -> Task<Message> {
|
||||
self.queue_site_generation_mode(None, true)
|
||||
}
|
||||
|
||||
fn queue_site_generation_mode(
|
||||
&mut self,
|
||||
validation: Option<engine::validate_site::SiteValidationReport>,
|
||||
force: bool,
|
||||
) -> Task<Message> {
|
||||
let kind = if validation.is_some() {
|
||||
SiteGenerationKind::Validation
|
||||
} else if force {
|
||||
SiteGenerationKind::Forced
|
||||
} else {
|
||||
SiteGenerationKind::Full
|
||||
};
|
||||
@@ -94,10 +108,10 @@ impl BdsApp {
|
||||
let group_id = format!("site-generation:{}", Uuid::new_v4());
|
||||
let group_name = t(
|
||||
self.ui_locale,
|
||||
if kind == SiteGenerationKind::Full {
|
||||
"engine.renderSiteGroup"
|
||||
} else {
|
||||
"engine.applyValidationGroup"
|
||||
match kind {
|
||||
SiteGenerationKind::Full => "engine.renderSiteGroup",
|
||||
SiteGenerationKind::Forced => "engine.forceRenderSiteGroup",
|
||||
SiteGenerationKind::Validation => "engine.applyValidationGroup",
|
||||
},
|
||||
);
|
||||
let mut render_task_ids = Vec::new();
|
||||
@@ -128,6 +142,7 @@ impl BdsApp {
|
||||
task_id,
|
||||
section,
|
||||
task_validation,
|
||||
force,
|
||||
locale,
|
||||
)
|
||||
})
|
||||
@@ -189,33 +204,46 @@ impl BdsApp {
|
||||
let output_dir = workflow.data_dir.join("html");
|
||||
let progress_manager = Arc::clone(&task_manager);
|
||||
let cancel_manager = Arc::clone(&task_manager);
|
||||
engine::generation::build_site_search_index_with_progress(
|
||||
db.conn(),
|
||||
&output_dir,
|
||||
&workflow.project_id,
|
||||
&metadata,
|
||||
move |current, total, path| {
|
||||
let progress = if total == 0 {
|
||||
1.0
|
||||
} else {
|
||||
current as f32 / total as f32
|
||||
};
|
||||
progress_manager.report_progress(
|
||||
task_id,
|
||||
Some(progress),
|
||||
Some(tw(
|
||||
locale,
|
||||
"engine.builtSearchFile",
|
||||
&[
|
||||
("path", path),
|
||||
("current", ¤t.to_string()),
|
||||
("total", &total.to_string()),
|
||||
],
|
||||
)),
|
||||
);
|
||||
},
|
||||
move || cancel_manager.is_cancelled(task_id),
|
||||
)
|
||||
let on_file = move |current: usize, total: usize, path: &str| {
|
||||
let progress = if total == 0 {
|
||||
1.0
|
||||
} else {
|
||||
current as f32 / total as f32
|
||||
};
|
||||
progress_manager.report_progress(
|
||||
task_id,
|
||||
Some(progress),
|
||||
Some(tw(
|
||||
locale,
|
||||
"engine.builtSearchFile",
|
||||
&[
|
||||
("path", path),
|
||||
("current", ¤t.to_string()),
|
||||
("total", &total.to_string()),
|
||||
],
|
||||
)),
|
||||
);
|
||||
};
|
||||
let is_cancelled = move || cancel_manager.is_cancelled(task_id);
|
||||
if workflow.kind == SiteGenerationKind::Forced {
|
||||
engine::generation::build_site_search_index_forced_with_progress(
|
||||
db.conn(),
|
||||
&output_dir,
|
||||
&workflow.project_id,
|
||||
&metadata,
|
||||
on_file,
|
||||
is_cancelled,
|
||||
)
|
||||
} else {
|
||||
engine::generation::build_site_search_index_with_progress(
|
||||
db.conn(),
|
||||
&output_dir,
|
||||
&workflow.project_id,
|
||||
&metadata,
|
||||
on_file,
|
||||
is_cancelled,
|
||||
)
|
||||
}
|
||||
.map_err(|error| error.to_string())
|
||||
})
|
||||
.await
|
||||
@@ -422,6 +450,7 @@ fn run_site_generation_section(
|
||||
task_id: TaskId,
|
||||
section: engine::generation::GenerationSection,
|
||||
validation: Option<engine::validate_site::SiteValidationReport>,
|
||||
force: bool,
|
||||
locale: UiLocale,
|
||||
) -> Result<engine::generation::GenerationReport, String> {
|
||||
if !task_manager.wait_until_runnable(task_id) {
|
||||
@@ -487,6 +516,16 @@ fn run_site_generation_section(
|
||||
on_page,
|
||||
is_cancelled,
|
||||
),
|
||||
None if force => engine::generation::render_site_section_forced_with_progress(
|
||||
db.conn(),
|
||||
&output_dir,
|
||||
&project_id,
|
||||
&metadata,
|
||||
&sources,
|
||||
section,
|
||||
on_page,
|
||||
is_cancelled,
|
||||
),
|
||||
None => engine::generation::render_site_section_with_progress(
|
||||
db.conn(),
|
||||
&output_dir,
|
||||
|
||||
@@ -8,6 +8,13 @@ use crate::app::Message;
|
||||
use crate::state::tabs::TabType;
|
||||
use bds_core::i18n::{UiLocale, translate};
|
||||
|
||||
const BLOG_SITE_ACTIONS: [MenuAction; 4] = [
|
||||
MenuAction::GenerateSitemap,
|
||||
MenuAction::ForceRenderSite,
|
||||
MenuAction::ValidateSite,
|
||||
MenuAction::UploadSite,
|
||||
];
|
||||
|
||||
/// Every custom menu item that the application handles.
|
||||
///
|
||||
/// Edit commands are custom actions because Iced widgets are not native Cocoa
|
||||
@@ -51,6 +58,7 @@ pub enum MenuAction {
|
||||
ValidateTranslations,
|
||||
FillMissingTranslations,
|
||||
GenerateSitemap,
|
||||
ForceRenderSite,
|
||||
ValidateSite,
|
||||
UploadSite,
|
||||
// Help
|
||||
@@ -98,6 +106,7 @@ impl MenuAction {
|
||||
MenuAction::ValidateTranslations,
|
||||
MenuAction::FillMissingTranslations,
|
||||
MenuAction::GenerateSitemap,
|
||||
MenuAction::ForceRenderSite,
|
||||
MenuAction::ValidateSite,
|
||||
MenuAction::UploadSite,
|
||||
MenuAction::About,
|
||||
@@ -142,7 +151,8 @@ impl MenuAction {
|
||||
"regenerate_calendar" => Self::RegenerateCalendar,
|
||||
"validate_translations" => Self::ValidateTranslations,
|
||||
"fill_missing_translations" => Self::FillMissingTranslations,
|
||||
"generate_sitemap" | "force_render_site" => Self::GenerateSitemap,
|
||||
"generate_sitemap" => Self::GenerateSitemap,
|
||||
"force_render_site" => Self::ForceRenderSite,
|
||||
"validate_site" => Self::ValidateSite,
|
||||
"upload_site" => Self::UploadSite,
|
||||
"about" => Self::About,
|
||||
@@ -189,6 +199,7 @@ impl MenuAction {
|
||||
Self::ValidateTranslations => "menu.item.validateTranslations",
|
||||
Self::FillMissingTranslations => "menu.item.fillMissingTranslations",
|
||||
Self::GenerateSitemap => "menu.item.generateSitemap",
|
||||
Self::ForceRenderSite => "menu.item.forceRenderSite",
|
||||
Self::ValidateSite => "menu.item.validateSite",
|
||||
Self::UploadSite => "menu.item.uploadSite",
|
||||
Self::About => "menu.item.about",
|
||||
@@ -231,6 +242,7 @@ pub(crate) fn action_enabled(
|
||||
| MenuAction::ValidateTranslations
|
||||
| MenuAction::FillMissingTranslations
|
||||
| MenuAction::GenerateSitemap
|
||||
| MenuAction::ForceRenderSite
|
||||
| MenuAction::ValidateSite
|
||||
| MenuAction::UploadSite
|
||||
);
|
||||
@@ -264,6 +276,7 @@ pub(crate) fn action_enabled(
|
||||
| MenuAction::ValidateTranslations
|
||||
| MenuAction::FillMissingTranslations
|
||||
| MenuAction::GenerateSitemap
|
||||
| MenuAction::ForceRenderSite
|
||||
| MenuAction::ValidateSite => has_project,
|
||||
_ => true,
|
||||
}
|
||||
@@ -531,30 +544,22 @@ pub fn build_menu_bar(locale: UiLocale) -> (Menu, MenuRegistry) {
|
||||
None,
|
||||
));
|
||||
let _ = blog_menu.append(&PredefinedMenuItem::separator());
|
||||
let _ = blog_menu.append(&item(
|
||||
&mut reg,
|
||||
MenuAction::GenerateSitemap,
|
||||
locale,
|
||||
Some(Accelerator::new(Some(CMD_OR_CTRL), Code::KeyR)),
|
||||
));
|
||||
let _ = blog_menu.append(&item(
|
||||
&mut reg,
|
||||
MenuAction::ValidateSite,
|
||||
locale,
|
||||
Some(Accelerator::new(
|
||||
Some(CMD_OR_CTRL | Modifiers::SHIFT),
|
||||
Code::KeyL,
|
||||
)),
|
||||
));
|
||||
let _ = blog_menu.append(&item(
|
||||
&mut reg,
|
||||
MenuAction::UploadSite,
|
||||
locale,
|
||||
Some(Accelerator::new(
|
||||
Some(CMD_OR_CTRL | Modifiers::SHIFT),
|
||||
Code::KeyU,
|
||||
)),
|
||||
));
|
||||
for action in BLOG_SITE_ACTIONS {
|
||||
let accelerator = match action {
|
||||
MenuAction::GenerateSitemap => Accelerator::new(Some(CMD_OR_CTRL), Code::KeyR),
|
||||
MenuAction::ForceRenderSite => {
|
||||
Accelerator::new(Some(CMD_OR_CTRL | Modifiers::SHIFT), Code::KeyR)
|
||||
}
|
||||
MenuAction::ValidateSite => {
|
||||
Accelerator::new(Some(CMD_OR_CTRL | Modifiers::SHIFT), Code::KeyL)
|
||||
}
|
||||
MenuAction::UploadSite => {
|
||||
Accelerator::new(Some(CMD_OR_CTRL | Modifiers::SHIFT), Code::KeyU)
|
||||
}
|
||||
_ => unreachable!("site action list contains only site actions"),
|
||||
};
|
||||
let _ = blog_menu.append(&item(&mut reg, action, locale, Some(accelerator)));
|
||||
}
|
||||
|
||||
// -- Help --
|
||||
let help_menu = Submenu::new(translate(locale, "menu.group.help"), true);
|
||||
@@ -680,6 +685,24 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn force_render_script_action_is_distinct_from_normal_render() {
|
||||
assert_eq!(
|
||||
MenuAction::from_script_name("force_render_site"),
|
||||
Some(MenuAction::ForceRenderSite)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn force_render_is_immediately_below_normal_render_in_the_blog_menu() {
|
||||
let normal = BLOG_SITE_ACTIONS
|
||||
.iter()
|
||||
.position(|action| *action == MenuAction::GenerateSitemap)
|
||||
.unwrap();
|
||||
|
||||
assert_eq!(BLOG_SITE_ACTIONS[normal + 1], MenuAction::ForceRenderSite);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn enabled_state_follows_application_rules() {
|
||||
assert!(action_enabled(
|
||||
|
||||
@@ -128,6 +128,14 @@ mod tests {
|
||||
&[serde_json::json!("new_post")],
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(queued.lock().unwrap().as_slice(), &[MenuAction::NewPost]);
|
||||
handler(Arc::clone(&queued), String::new())(
|
||||
"trigger_menu_action",
|
||||
&[serde_json::json!("force_render_site")],
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(
|
||||
queued.lock().unwrap().as_slice(),
|
||||
&[MenuAction::NewPost, MenuAction::ForceRenderSite]
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user