Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Data pages: improve citations #2806

Merged
merged 7 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion baker/GrapherBaker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import {
import * as db from "../db/db.js"
import { glob } from "glob"
import { isPathRedirectedToExplorer } from "../explorerAdminServer/ExplorerRedirects.js"
import { getPostBySlug } from "../db/model/Post.js"
import { bySlug, getPostBySlug, parsePostAuthors } from "../db/model/Post.js"
import { GrapherInterface } from "@ourworldindata/grapher"
import workerpool from "workerpool"
import ProgressBar from "progress"
Expand All @@ -60,11 +60,14 @@ import {
getDatapageJson,
parseGdocContentFromAllowedLevelOneHeadings,
} from "../datapage/Datapage.js"
import { slugify_topic } from "../site/DataPageV2Content.js"
import { ExplorerProgram } from "../explorer/ExplorerProgram.js"
import { Image } from "../db/model/Image.js"
import { logErrorAndMaybeSendToBugsnag } from "../serverUtils/errorLog.js"

import { parseFaqs } from "../db/model/Gdoc/rawToEnriched.js"
import { Gdoc } from "../db/model/Gdoc/Gdoc.js"
import { getShortPageCitation } from "../site/gdocs/utils.js"

/**
*
Expand Down Expand Up @@ -322,6 +325,42 @@ export async function renderDataPageV2({
grapherConfigForVariable ?? {}
)

const firstTopicTag = datapageData.topicTagsLinks?.[0]

if (firstTopicTag) {
const gdoc = await Gdoc.findOne({
where: {
slug: slugify_topic(firstTopicTag),
},
relations: ["tags"],
})
if (gdoc) {
const citation = getShortPageCitation(
gdoc.content.authors,
gdoc.content.title ?? "",
gdoc?.publishedAt
)
datapageData.primaryTopic = {
topicTag: firstTopicTag,
citation,
}
} else {
const post = await bySlug(slugify_topic(firstTopicTag))
if (post) {
const authors = parsePostAuthors(post.authors)
const citation = getShortPageCitation(
authors,
post.title,
post.published_at
)
datapageData.primaryTopic = {
topicTag: firstTopicTag,
citation,
}
}
}
}

// Get the charts this variable is being used in (aka "related charts")
// and exclude the current chart to avoid duplicates
datapageData.allCharts = await getRelatedChartsForVariable(
Expand Down
6 changes: 3 additions & 3 deletions datapage/Datapage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ import {
DataPageDataV2,
OwidVariableWithSource,
dayjs,
getAttributionFromVariable,
gdocIdRegex,
getETLPathComponents,
getAttributionFragmentsFromVariable,
} from "@ourworldindata/utils"
import { ExplorerProgram } from "../explorer/ExplorerProgram.js"
import { Gdoc } from "../db/model/Gdoc/Gdoc.js"
Expand All @@ -29,7 +29,7 @@ export const getDatapageDataV2 = async (
partialGrapherConfig: GrapherInterface
): Promise<DataPageDataV2> => {
{
const processingLevel = variableMetadata.processingLevel ?? "major"
const processingLevel = variableMetadata.processingLevel ?? "minor"
const version =
getETLPathComponents(variableMetadata.catalogPath ?? "")?.version ??
""
Expand Down Expand Up @@ -59,7 +59,7 @@ export const getDatapageDataV2 = async (
attributionShort: variableMetadata.presentation?.attributionShort,
titleVariant: variableMetadata.presentation?.titleVariant,
topicTagsLinks: variableMetadata.presentation?.topicTagsLinks ?? [],
attribution: getAttributionFromVariable(variableMetadata),
attributions: getAttributionFragmentsFromVariable(variableMetadata),
faqs: [],
descriptionKey: variableMetadata.descriptionKey ?? [],
descriptionProcessing: variableMetadata.descriptionProcessing,
Expand Down
10 changes: 2 additions & 8 deletions db/migrateWpPostsToArchieMl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import cheerio from "cheerio"
import {
OwidGdocPublicationContext,
OwidGdocInterface,
sortBy,
OwidArticleBackportingStatistics,
OwidGdocType,
RelatedChart,
Expand All @@ -19,6 +18,7 @@ import {
adjustHeadingLevels,
} from "./model/Gdoc/htmlToEnriched.js"
import { getRelatedCharts } from "./wpdb.js"
import { parsePostAuthors } from "./model/Post.js"

// slugs from all the linear entries we want to migrate from @edomt
const entries = new Set([
Expand Down Expand Up @@ -149,10 +149,6 @@ const migrate = async (): Promise<void> => {
? post.published_at.toLocaleDateString("en-US", options)
: ""

const authors: { author: string; order: number }[] = JSON.parse(
post.authors
)

const archieMlFieldContent: OwidGdocInterface = {
id: `wp-${post.id}`,
slug: post.slug,
Expand All @@ -162,9 +158,7 @@ const migrate = async (): Promise<void> => {
title: post.title,
subtitle: post.excerpt,
excerpt: post.excerpt,
authors: sortBy(authors, ["order"]).map(
(author) => author.author
),
authors: parsePostAuthors(post.authors),
dateline: dateline,
// TODO: this discards block level elements - those might be needed?
refs: undefined,
Expand Down
10 changes: 9 additions & 1 deletion db/model/Post.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as db from "../db.js"
import { Knex } from "knex"
import { PostRow } from "@ourworldindata/utils"
import { PostRow, sortBy } from "@ourworldindata/utils"

export const postsTable = "posts"

Expand Down Expand Up @@ -49,6 +49,14 @@ export const setTags = async (
export const bySlug = async (slug: string): Promise<PostRow | undefined> =>
(await db.knexTable("posts").where({ slug: slug }))[0]

/** The authors field in the posts table is a json column that contains an array of
{ order: 1, authors: "Max Mustermann" } like records. This function parses the
string and returns a simple string array of author names in the correct order */
export const parsePostAuthors = (authorsJson: string): string[] => {
const authors = JSON.parse(authorsJson)
return sortBy(authors, ["order"]).map((author) => author.author)
}

export const setTagsForPost = async (
postId: number,
tagIds: number[]
Expand Down
3 changes: 2 additions & 1 deletion packages/@ourworldindata/grapher/src/core/Grapher.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1535,7 +1535,8 @@ export class Grapher

const uniqueAttributions = uniq(compact(attributions))

if (uniqueAttributions.length > 3) return "Multiple sources"
if (uniqueAttributions.length > 3)
return `${attributions[0]} and other sources`

return uniqueAttributions.join("; ")
}
Expand Down
29 changes: 27 additions & 2 deletions packages/@ourworldindata/utils/src/Util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1743,16 +1743,22 @@ export function getOriginAttributionFragments(
export function getAttributionFromVariable(
variable: OwidVariableWithSource
): string {
return getAttributionFragmentsFromVariable(variable).join("; ")
}

export function getAttributionFragmentsFromVariable(
variable: OwidVariableWithSource
): string[] {
if (
variable.presentation?.attribution &&
variable.presentation?.attribution !== ""
)
return variable.presentation?.attribution
return [variable.presentation?.attribution]
const originAttributionFragments = getOriginAttributionFragments(
variable.origins
)
const sourceName = variable.source?.name
return uniq(compact([sourceName, ...originAttributionFragments])).join("; ")
return uniq(compact([sourceName, ...originAttributionFragments]))
}

interface ETLPathComponents {
Expand All @@ -1769,3 +1775,22 @@ export const getETLPathComponents = (path: string): ETLPathComponents => {
path.split("/")
return { channel, producer, version, dataset, table, indicator }
}

export const formatAuthors = ({
authors,
requireMax,
forBibtex,
}: {
authors: string[]
requireMax?: boolean
forBibtex?: boolean
}): string => {
if (requireMax && !authors.includes("Max Roser"))
authors = [...authors, "Max Roser"]

let authorsText = authors.slice(0, -1).join(forBibtex ? " and " : ", ")
if (authorsText.length === 0) authorsText = authors[0]
else authorsText += ` and ${last(authors)}`

return authorsText
}
3 changes: 3 additions & 0 deletions packages/@ourworldindata/utils/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ export {
type DataPageDataV2,
type DataPageRelatedData,
type DataPageRelatedResearch,
type PrimaryTopic,
type FaqLink,
type FaqDictionary,
type RawBlockResearchAndWritingRow,
Expand Down Expand Up @@ -340,8 +341,10 @@ export {
mergePartialGrapherConfigs,
getOriginAttributionFragments,
getAttributionFromVariable,
getAttributionFragmentsFromVariable,
copyToClipboard,
getETLPathComponents,
formatAuthors,
} from "./Util.js"

export {
Expand Down
9 changes: 8 additions & 1 deletion packages/@ourworldindata/utils/src/owidTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1464,13 +1464,19 @@ export interface FaqLink {
fragmentId: string
}

export interface PrimaryTopic {
topicTag: string
citation: string
}

export interface DataPageDataV2 {
status: "published" | "draft"
title: string
titleVariant?: string
attributionShort?: string
topicTagsLinks?: string[]
attribution: string
primaryTopic?: PrimaryTopic
attributions: string[]
descriptionShort?: string
descriptionFromProducer?: string
faqs: FaqLink[] // Todo: resolve these at this level to the point where we can preview them
Expand Down Expand Up @@ -1602,6 +1608,7 @@ export interface DataPageV2ContentFields {
faqEntries: FaqEntryData | undefined
// TODO: add gdocs for FAQs
isPreviewing?: boolean
canonicalUrl: string
}

export interface UserCountryInformation {
Expand Down
1 change: 1 addition & 0 deletions site/DataPageV2.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ export const DataPageV2 = (props: {
grapherConfig={grapherConfig}
isPreviewing={isPreviewing}
faqEntries={faqEntries}
canonicalUrl={canonicalUrl}
/>
</DebugProvider>
</div>
Expand Down
Loading
Loading