pageOverrides.tsx

import { PageOverrides } from "../site/LongFormPage.js"
import { BAKED_BASE_URL } from "../settings/serverSettings.js"
import { urlToSlug, FullPost } from "@ourworldindata/utils"
import { FormattingOptions } from "@ourworldindata/types"
import { getTopSubnavigationParentItem } from "../site/gdocs/utils.js"
import { logErrorAndMaybeCaptureInSentry } from "../serverUtils/errorLog.js"
import {
    getFullPostBySlugFromSnapshot,
    isPostSlugCitable,
} from "../db/model/Post.js"
import { KnexReadonlyTransaction } from "../db/db.js"

export const getPostBySlugLogToSlackNoThrow = async (
    knex: KnexReadonlyTransaction,
    slug: string
) => {
    try {
        return await getFullPostBySlugFromSnapshot(knex, slug)
    } catch (err) {
        void logErrorAndMaybeCaptureInSentry(err)
        return undefined
    }
}

export const getLandingOnlyIfParent = async (
    knex: KnexReadonlyTransaction,
    post: FullPost,
    formattingOptions: FormattingOptions
) => {
    if (!formattingOptions.subnavId) return

    const landingItemHref = getTopSubnavigationParentItem(
        formattingOptions.subnavId
    )?.href
    if (!landingItemHref) return

    const landingSlug = urlToSlug(landingItemHref)
    if (landingSlug === post.slug) return

    // Using no-throw version to prevent throwing and stopping baking mid-way.
    // It is more desirable to temporarily deploy with citation overrides
    // absent, while fixing the issue.
    const landing = await getPostBySlugLogToSlackNoThrow(knex, landingSlug)
    if (!landing) {
        // todo: the concept of "citation overrides" does not belong to that
        // generic function. Logging this message should be the responsibility
        // of the caller function.
        await logErrorAndMaybeCaptureInSentry(
            new Error(
                // This error often shows up intermittently as a false-positive (DB unavailable when calling getPostBySlug()?)
                // If it happens systematically, please check
                // the href of the "subnavs[${formattingOptions.subnavId}]"
                // landing page (the first item in the array): it might be
                // out-of-date and redirected.
                `Citation overrides not applied for ${post.slug}. This might be an intermittent issue.`
            )
        )
    }

    return landing
}

export const getPageOverrides = async (
    knex: KnexReadonlyTransaction,
    post: FullPost,
    formattingOptions: FormattingOptions
): Promise<PageOverrides | undefined> => {
    const landing = await getLandingOnlyIfParent(knex, post, formattingOptions)
    if (!landing) return

    const isParentLandingCitable = isPostSlugCitable(landing.slug)
    if (!isParentLandingCitable) return

    return {
        citationTitle: landing.title,
        citationSlug: landing.slug,
        citationCanonicalUrl: `${BAKED_BASE_URL}/${landing.slug}`,
        citationAuthors: landing.authors,
        citationPublicationDate: landing.date,
    }
}

export const isPageOverridesCitable = (pageOverrides?: PageOverrides) => {
    if (!pageOverrides) return false

    return (
        !!pageOverrides.citationTitle &&
        !!pageOverrides.citationSlug &&
        !!pageOverrides.citationCanonicalUrl &&
        !!pageOverrides.citationAuthors &&
        !!pageOverrides.citationPublicationDate
    )
}