enhance(page): add other_translations to non-Doc pages (#272)

* refactor(translations): extract other_translations()

* fix(spa): add other_translations

* fix(translation): read SPA separately

* chore(translations): move other_translations()

* chore(translations): unpublish get_other_translations_for()

It is no longer used anywhere else.

* refactor(translations): pass doc through

* chore(translations): use Page::from_url()

* chore(translations): use current locale directly

* fix(translations): check url for "/docs/"

* chore(pages): simplify other_translations for conflicting/orphaned

* chore(pages): inline other_translations where possible

* chore(pages): inline parents where possible

* refactor(translations): use Page::internal_from_url()

* enhance(page): avoid unnecessary lookups

* refactor(page): inverse if-else logic

* chore(page): revert special Blog Index handling

We don't currently need this yet, because we don't call
`other_translations()` to determine the ones from the blog indices.

* refactor(page): improve readability

Co-authored-by: Florian Dieminger <[email protected]>

---------

Co-authored-by: Florian Dieminger <[email protected]>

Author: caugner

crates/rari-doc/src/pages/build.rs

@@ -12,7 +12,7 @@ use scraper::Html;
 use super::json::{
     BuiltPage, Compat, ContributorSpotlightHyData, JsonBlogPostDoc, JsonBlogPostPage,
     JsonCurriculumPage, JsonDoc, JsonDocPage, JsonGenericHyData, JsonGenericPage, Prose, Section,
-    Source, SpecificationSection, TocEntry, Translation,
+    Source, SpecificationSection, TocEntry,
 };
 use super::page::{Page, PageBuilder, PageLike};
 use super::types::contributors::ContributorSpotlight;
@@ -30,7 +30,7 @@ use crate::html::sections::{split_sections, BuildSection, BuildSectionType, Spli
 use crate::html::sidebar::{
     build_sidebars, expand_details_and_mark_current_for_inline_sidebar, postprocess_sidebar,
 };
-use crate::pages::json::{CommonJsonData, JsonContributorSpotlightPage};
+use crate::pages::json::{CommonJsonData, JsonContributorSpotlightPage, Translation};
 use crate::pages::templates::{
     BlogRenderer, ContributorSpotlightRenderer, CurriculumRenderer, DocPageRenderer,
     GenericRenderer,
@@ -45,7 +45,7 @@ use crate::pages::types::spa::SPA;
 use crate::pages::types::utils::FmTempl;
 use crate::specs::extract_specifications;
 use crate::templ::render::{decode_ref, render, Rendered};
-use crate::translations::get_other_translations_for;
+use crate::translations::other_translations;
 
 impl From<BuildSection<'_>> for Section {
     fn from(value: BuildSection) -> Self {
@@ -270,21 +270,20 @@ fn build_doc(doc: &Doc) -> Result<BuiltPage, DocError> {
         history.map(|entry| entry.hash.as_str()).unwrap_or_default()
     );
     let popularity = popularities().popularities.get(doc.url()).cloned();
-    let other_translations = get_other_translations_for(doc.slug(), doc.locale())
-        .into_iter()
-        .map(|(locale, title)| Translation {
-            native: locale.into(),
-            locale,
-            title,
-        })
-        .collect();
-
     let no_indexing =
         doc.meta.slug == "MDN/Kitchensink" || doc.is_orphaned() || doc.is_conflicting();
-    let parents = if !doc.is_conflicting() && !doc.is_orphaned() {
-        parents(doc)
+
+    let (parents, other_translations) = if !doc.is_conflicting() && !doc.is_orphaned() {
+        (parents(doc), other_translations(doc))
     } else {
-        Default::default()
+        (
+            Default::default(),
+            vec![Translation {
+                native: doc.locale().into(),
+                locale: doc.locale(),
+                title: doc.title().to_string(),
+            }],
+        )
     };
 
     Ok(BuiltPage::Doc(Box::new(JsonDocPage {
@@ -354,24 +353,28 @@ fn build_blog_post(post: &BlogPost) -> Result<BuiltPage, DocError> {
         locale: post.locale(),
         blog_meta: Some((&post.meta).into()),
         page_title: page_title(post, false)?,
-        common: CommonJsonData {
-            parents: parents(post),
-            ..Default::default()
-        },
         image: Some(format!(
             "{}{}{}",
             base_url(),
             post.url(),
             post.meta.image.file
         )),
+        common: CommonJsonData {
+            parents: parents(post),
+            other_translations: vec![Translation {
+                native: post.locale().into(),
+                locale: post.locale(),
+                title: post.title().to_string(),
+            }],
+            ..Default::default()
+        },
         renderer: BlogRenderer::BlogPost,
         ..Default::default()
     })))
 }
 
 fn build_generic_page(page: &Generic) -> Result<BuiltPage, DocError> {
     let built = build_content(page);
-    let parents = parents(page);
     let PageContent { body, toc, .. } = built?;
     Ok(BuiltPage::GenericPage(Box::new(JsonGenericPage {
         hy_data: JsonGenericHyData {
@@ -389,7 +392,8 @@ fn build_generic_page(page: &Generic) -> Result<BuiltPage, DocError> {
         id: page.meta.page.clone(),
         common: CommonJsonData {
             description: page.meta.description.clone(),
-            parents,
+            parents: parents(page),
+            other_translations: other_translations(page),
         },
         renderer: match page.meta.template {
             super::types::generic::Template::GenericDoc => GenericRenderer::GenericDoc,
@@ -406,8 +410,7 @@ fn build_spa(spa: &SPA) -> Result<BuiltPage, DocError> {
 fn build_curriculum(curriculum: &Curriculum) -> Result<BuiltPage, DocError> {
     let PageContent { body, toc, .. } = build_content(curriculum)?;
     let sidebar = build_sidebar().ok();
-    let parents = parents(curriculum);
-    let group = curriculum_group(&parents);
+    let group = curriculum_group(&parents(curriculum));
     let modules = match curriculum.meta.template {
         Template::Overview => build_overview_modules(curriculum.slug())?,
         Template::Landing => build_landing_modules()?,
@@ -424,7 +427,7 @@ fn build_curriculum(curriculum: &Curriculum) -> Result<BuiltPage, DocError> {
             locale: curriculum.locale(),
             native: curriculum.locale().into(),
             mdn_url: curriculum.meta.url.clone(),
-            parents,
+            parents: parents(curriculum),
             page_title: page_title(curriculum, true)?,
             summary: curriculum.meta.summary.clone(),
             body,
@@ -462,15 +465,15 @@ fn build_contributor_spotlight(cs: &ContributorSpotlight) -> Result<BuiltPage, D
         usernames: cs.meta.usernames.clone(),
         quote: cs.meta.quote.clone(),
     };
-    let parents = parents(cs);
     Ok(BuiltPage::ContributorSpotlight(Box::new(
         JsonContributorSpotlightPage {
             url: cs.meta.url.clone(),
             page_title: cs.meta.title.clone(),
             hy_data: contributor_spotlight_data,
             common: CommonJsonData {
                 description: cs.meta.description.clone(),
-                parents,
+                parents: parents(cs),
+                other_translations: other_translations(cs),
             },
             renderer: ContributorSpotlightRenderer::ContributorSpotlight,
         },

crates/rari-doc/src/pages/json.rs

@@ -961,10 +961,11 @@ pub struct JsonGenericPage {
 }
 
 #[derive(Debug, Clone, Default, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
 #[schemars(rename = "GenericPage")]
 pub struct CommonJsonData {
     pub description: Option<String>,
     #[serde(skip_serializing_if = "Vec::is_empty")]
     pub parents: Vec<Parent>,
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub other_translations: Vec<Translation>,
 }

crates/rari-doc/src/pages/page.rs

@@ -114,10 +114,24 @@ impl Page {
                 .ok_or(DocError::PageNotFound(url.to_string(), PageCategory::SPA)),
             PageCategory::Doc => Doc::page_from_slug_path(&folder_path, locale, fallback)
                 .map_err(|_| DocError::PageNotFound(url.to_string(), PageCategory::Doc)),
+            PageCategory::BlogPost if locale != Locale::EnUs => {
+                // Blog is en-US only.
+                Err(DocError::PageNotFound(
+                    url.to_string(),
+                    PageCategory::BlogPost,
+                ))
+            }
             PageCategory::BlogPost => BlogPost::page_from_url(url).ok_or(DocError::PageNotFound(
                 url.to_string(),
                 PageCategory::BlogPost,
             )),
+            PageCategory::Curriculum if locale != Locale::EnUs => {
+                // Curriculum is en-US only.
+                Err(DocError::PageNotFound(
+                    url.to_string(),
+                    PageCategory::Curriculum,
+                ))
+            }
             PageCategory::Curriculum => Curriculum::page_from_url(url).ok_or(
                 DocError::PageNotFound(url.to_string(), PageCategory::Curriculum),
             ),

crates/rari-doc/src/pages/types/spa.rs

@@ -22,12 +22,13 @@ use crate::helpers::parents::parents;
 use crate::helpers::title::page_title;
 use crate::pages::json::{
     BlogIndex, BuiltPage, CommonJsonData, ItemContainer, JsonBlogPostDoc, JsonBlogPostPage,
-    JsonHomePage, JsonHomePageSPAHyData, JsonSpaPage, Parent,
+    JsonHomePage, JsonHomePageSPAHyData, JsonSpaPage, Parent, Translation,
 };
 use crate::pages::page::{Page, PageLike, PageReader};
 use crate::pages::templates::{BlogRenderer, HomeRenderer, SpaBuildTemplate, SpaRenderer};
 use crate::pages::types::blog::BlogMeta;
 use crate::pages::types::utils::FmTempl;
+use crate::translations::other_translations;
 
 #[derive(Debug, Clone)]
 pub struct SPA {
@@ -144,6 +145,11 @@ impl SPA {
                         uri: "/en-US/blog/".to_string(),
                         title: self.title().to_owned(),
                     }],
+                    other_translations: vec![Translation {
+                        native: self.locale().into(),
+                        locale: self.locale(),
+                        title: self.title().to_string(),
+                    }],
                     ..Default::default()
                 },
                 image: None,
@@ -159,6 +165,7 @@ impl SPA {
                 url: concat_strs!(self.base_slug.as_ref(), self.slug),
                 common: CommonJsonData {
                     parents: parents(self),
+                    other_translations: other_translations(self),
                     ..Default::default()
                 },
                 renderer: match self.template {
@@ -189,6 +196,7 @@ impl SPA {
                 url: concat_strs!(self.base_slug.as_ref(), self.slug),
                 common: CommonJsonData {
                     parents: parents(self),
+                    other_translations: other_translations(self),
                     ..Default::default()
                 },
                 renderer: SpaRenderer::SpaNotFound,
@@ -212,6 +220,7 @@ impl SPA {
                 },
                 common: CommonJsonData {
                     parents: parents(self),
+                    other_translations: other_translations(self),
                     ..Default::default()
                 },
                 renderer: HomeRenderer::Homepage,

crates/rari-doc/src/translations.rs

@@ -10,8 +10,8 @@ use rari_types::globals::cache_content;
 use rari_types::locale::Locale;
 
 use crate::cached_readers::{STATIC_DOC_PAGE_FILES, STATIC_DOC_PAGE_TRANSLATED_FILES};
-use crate::pages::page::PageLike;
-use crate::pages::types::doc::Doc;
+use crate::pages::json::Translation;
+use crate::pages::page::{Page, PageLike};
 
 pub type TranslationsOf<'a> = BTreeMap<Locale, &'a str>;
 
@@ -44,23 +44,32 @@ pub(crate) fn init_translations_from_static_docs() {
     TRANSLATIONS_BY_SLUG.set(all).unwrap();
 }
 
-/// Retrieves translations for a specific slug, _excluding_ the specified locale.
-///
-/// This function looks up translations for the given slug in the global `TRANSLATIONS_BY_SLUG` cache.
-/// It filters out the translation for the specified locale and returns a vector of tuples containing
-/// the locale and the corresponding title for each translation.
+/// Determines all available translations for a specific page.
 ///
 /// # Arguments
 ///
-/// * `slug` - A string slice that holds the slug of the documentation page.
-/// * `locale` - A `Locale` that specifies the locale to be excluded from the results.
+/// * `doc` - The page for which the translations should be determined.
 ///
 /// # Returns
 ///
-/// * `Vec<(Locale, String)>` - Returns a vector of tuples, where each tuple contains a `Locale` and a `String`
-///   representing the title of the translation. If no translations are found, an empty vector is returned.
-pub(crate) fn get_other_translations_for(slug: &str, locale: Locale) -> Vec<(Locale, String)> {
-    if cache_content() {
+/// * `Vec<Translation>` - The vector of translations (including the current locale).
+pub(crate) fn other_translations<T: PageLike>(doc: &T) -> Vec<Translation> {
+    get_other_translations_for(doc)
+        .into_iter()
+        .map(|(locale, title)| Translation {
+            native: locale.into(),
+            locale,
+            title,
+        })
+        .collect()
+}
+
+fn get_other_translations_for<T: PageLike>(doc: &T) -> Vec<(Locale, String)> {
+    let slug = doc.slug();
+    let locale = doc.locale();
+    let url = doc.url();
+
+    if cache_content() && url.contains("/docs/") {
         TRANSLATIONS_BY_SLUG
             .get()
             .and_then(|by_slug| {
@@ -82,9 +91,13 @@ pub(crate) fn get_other_translations_for(slug: &str, locale: Locale) -> Vec<(Loc
         Locale::for_generic_and_spas()
             .iter()
             .filter_map(|l| {
-                Doc::page_from_slug(slug, *l, false)
-                    .ok()
-                    .map(|d| (*l, d.title().to_string()))
+                if *l == locale {
+                    Some((*l, doc.title().to_string()))
+                } else {
+                    Page::internal_from_url(url, Some(*l), false)
+                        .ok()
+                        .map(|d| (*l, d.title().to_string()))
+                }
             })
             .collect()
     }