Compare commits

..

3 Commits

Author SHA1 Message Date
olaven f6de0aba33 remove logging 2025-06-18 22:51:32 +02:00
olaven d065733879 remove accidental unused import 2025-06-18 22:50:57 +02:00
olaven 6a62923d6d Don't crash if email address has sub-address with special characters
Emails with [sub-addressing](https://en.wikipedia.org/wiki/Email_address#Sub-addressing) should not
cause the donations flow to crash. It currently does because the vipps redirect URL validation fails
because of the special characters involved, namely "+", e.g. "olav+subscriptions@example.com".
2025-06-18 22:47:59 +02:00
7 changed files with 37 additions and 241 deletions

View File

@ -2,15 +2,12 @@ import { assertEquals, assertExists, assertGreaterOrEqual } from "$std/assert/mo
import { nrkRadio } from "./nrk.ts";
import { forTestingOnly } from "./nrk.ts";
Deno.test(
"Verify search query `trygd` returns one result: 'Trygdekontoret'",
async () => {
Deno.test("Verify search query `trygd` returns one result: 'Trygdekontoret'", async () => {
const result = await nrkRadio.search("trygd");
assertExists(result);
assertEquals(result.length, 1);
assertEquals(result[0].seriesId, "trygdekontoret");
},
);
});
Deno.test("Verify empty search query yields `null`", async () => {
const result = await nrkRadio.search("");
@ -43,83 +40,13 @@ Deno.test("Verify getting series data for 'trygd' does not works", async () => {
assertEquals(result, null);
});
Deno.test(
"Verify getting episodeId 'l_0bc5e55a-46b5-48a5-85e5-5a46b5d8a562' for 'trygdekontoret' works",
async () => {
const result = await nrkRadio.getEpisode(
"trygdekontoret",
"l_0bc5e55a-46b5-48a5-85e5-5a46b5d8a562",
);
Deno.test("Verify getting episodeId 'l_0bc5e55a-46b5-48a5-85e5-5a46b5d8a562' for 'trygdekontoret' works", async () => {
const result = await nrkRadio.getEpisode("trygdekontoret", "l_0bc5e55a-46b5-48a5-85e5-5a46b5d8a562");
assertExists(result);
assertEquals(result.duration.seconds, 4152);
},
);
});
Deno.test(
"Verify getting episodeId 'null' for 'trygdekontoret' yields `null`",
async () => {
Deno.test("Verify getting episodeId 'null' for 'trygdekontoret' yields `null`", async () => {
const result = await nrkRadio.getEpisode("trygdekontoret", "null");
assertEquals(result, null);
},
);
Deno.test("Can get episodes for seriesnakk", async () => {
const result = await nrkRadio.getSeries("seriesnakk");
assertExists(result);
});
Deno.test("Seriesnakk, an umbrella series yields all seasons", async () => {
const seriesData = await forTestingOnly.getSeriesData("seriesnakk");
assertExists(seriesData);
assertGreaterOrEqual(seriesData.episodes.length, 1);
const titles = seriesData.episodes.map((e) => e.titles.title);
const thereseTitle = "Therese-saken: Hva kan et vitne huske? (1:5)";
assertEquals(
titles.includes(thereseTitle),
true,
`Titles include "${thereseTitle}"`,
);
const maktaTitle = " Vi er ikke idioter og tror at det var elsparkesykler i 1975";
assertEquals(
titles.includes(maktaTitle),
true,
`Titles include "${maktaTitle}"`,
);
const soLongMarianneTitle = "- Se og hør sov på dørmatta hennes! (1:8)";
assertEquals(
titles.includes(soLongMarianneTitle),
true,
`Titles include "${soLongMarianneTitle}"`,
);
const nerdrumTitle = "Seriesnakk: Familien Nerdrum";
assertEquals(
titles.includes(nerdrumTitle),
true,
`Titles include "${nerdrumTitle}"`,
);
const selinaTitle = " Som å se meg selv (1:6)";
assertEquals(
titles.includes(selinaTitle),
true,
`Titles include "${selinaTitle}"`,
);
const skamTitle = " William må svare (4:9)";
assertEquals(
titles.includes(skamTitle),
true,
`Titles include "${skamTitle}"`,
);
const natoTitle = " Jeg ville slite ut Jens (1:2)";
assertEquals(
titles.includes(natoTitle),
true,
`Titles include "${natoTitle}"`,
);
});

View File

@ -1,8 +1,8 @@
import { get, STATUS_CODE } from "https://deno.land/x/kall@v2.0.0/mod.ts";
import { Series } from "../storage.ts";
import { components as searchComponents } from "./nrk-search.ts";
import { components as catalogComponents } from "./nrk-catalog.ts";
import { external as playbackComponents } from "./nrk-playback.ts";
import { components as searchComponents } from "./nrk-search.ts";
import { Series } from "../storage.ts";
type ArrayElement<A> = A extends readonly (infer T)[] ? T : never;
type PodcastEpisodes = catalogComponents["schemas"]["EpisodesHalResource"];
@ -10,7 +10,6 @@ type Podcast = catalogComponents["schemas"]["SeriesHalResource"];
type PodcastEpisodesSingle = catalogComponents["schemas"]["EpisodeHalResource"];
type RadioSeriesEpisode = catalogComponents["schemas"]["EpisodesHalResource"];
type RadioSeries = catalogComponents["schemas"]["SeriesHalResource"];
type SeasonEpisodes = catalogComponents["schemas"]["PodcastSeasonHalResource"];
export type NrkSerie = catalogComponents["schemas"]["SeriesViewModel"];
export type NrkOriginalEpisode = PodcastEpisodesSingle & { url: string };
@ -19,15 +18,11 @@ export type NrkSearchResultList = searchComponents["schemas"]["seriesResult"]["r
export type SearchResult = ArrayElement<NrkSearchResultList> & {
description?: string;
};
export type SeriesData =
& { episodes: NrkOriginalEpisode[] }
& (
| RadioSeries["series"]
| Podcast["series"]
);
export type SeriesData = { episodes: NrkOriginalEpisode[] } & (RadioSeries["series"] | Podcast["series"]);
function parseSeries(nrkSeriesData: SeriesData): Series {
const imageUrl = nrkSeriesData.squareImage?.at(-1)?.url ?? "";
return {
id: nrkSeriesData.id,
title: nrkSeriesData.titles.title,
@ -67,41 +62,6 @@ async function search(query: string): Promise<NrkSearchResultList | null> {
return null;
}
async function extractEpisodes(
serieResponse: RadioSeries,
episodeResponse?: PodcastEpisodes,
): Promise<NrkOriginalEpisode[]> {
if (serieResponse.seriesType === "umbrella") {
const seasons = await Promise.all(
serieResponse._links.seasons.map(async (season) => {
const response = await get<SeasonEpisodes>(
`https://psapi.nrk.no${season.href}`,
);
return response.body;
}),
);
const episodes = await Promise.all(
seasons.flatMap((season) => {
return (
season?._embedded.episodes?._embedded.episodes?.flatMap((episode) =>
getEpisodeWithDownloadLink(episode, serieResponse.type)
) ?? []
);
}),
);
return episodes;
} else {
const episodes = await Promise.all(
episodeResponse?._embedded.episodes?.map((episode) => getEpisodeWithDownloadLink(episode, serieResponse.type)) ??
[],
);
return episodes;
}
}
async function getSeriesData(seriesId: string): Promise<SeriesData | null> {
let [
{ status: episodeStatus, body: episodeResponse },
@ -110,7 +70,9 @@ async function getSeriesData(seriesId: string): Promise<SeriesData | null> {
get<PodcastEpisodes>(
`${nrkAPI}/radio/catalog/podcast/${seriesId}/episodes`,
),
get<Podcast>(`${nrkAPI}/radio/catalog/podcast/${seriesId}`),
get<Podcast>(
`${nrkAPI}/radio/catalog/podcast/${seriesId}`,
),
]);
if (episodeStatus !== STATUS_CODE.OK || seriesStatus !== STATUS_CODE.OK) {
@ -121,17 +83,19 @@ async function getSeriesData(seriesId: string): Promise<SeriesData | null> {
get<RadioSeriesEpisode>(
`https://psapi.nrk.no/radio/catalog/series/${seriesId}/episodes`,
),
get<RadioSeries>(`https://psapi.nrk.no/radio/catalog/series/${seriesId}`),
get<RadioSeries>(
`https://psapi.nrk.no/radio/catalog/series/${seriesId}`,
),
]);
}
if (
episodeStatus === STATUS_CODE.OK &&
seriesStatus === STATUS_CODE.OK &&
serieResponse?.series &&
episodeResponse?._embedded.episodes?.length
episodeStatus === STATUS_CODE.OK && seriesStatus === STATUS_CODE.OK &&
serieResponse?.series && episodeResponse?._embedded.episodes?.length
) {
const episodes = await extractEpisodes(serieResponse, episodeResponse);
const episodes = await Promise.all(
episodeResponse._embedded.episodes.map((episode) => getEpisodeWithDownloadLink(episode, serieResponse.type)),
);
const seriesData = {
...serieResponse.series,
episodes,
@ -153,18 +117,13 @@ async function getSeries(seriesId: string): Promise<Series | null> {
return parsedSeries;
}
async function getEpisode(
seriesId: string,
episodeId: string,
): Promise<NrkPodcastEpisode | null> {
async function getEpisode(seriesId: string, episodeId: string): Promise<NrkPodcastEpisode | null> {
const url = `${nrkAPI}/radio/catalog/podcast/${seriesId}/episodes/${episodeId}`;
const { status, body: episode } = await get<NrkPodcastEpisode>(url);
if (status === STATUS_CODE.OK && episode) {
return episode;
}
console.error(
`Error getting episode ${episodeId}. Status: ${status}. Series: ${seriesId}`,
);
console.error(`Error getting episode ${episodeId}. Status: ${status}. Series: ${seriesId}`);
return null;
}

View File

@ -47,12 +47,3 @@ Deno.test("generated rss contains promo with link to donations page", () => {
"First promotion should come before the second",
);
});
Deno.test("first promotion is removed", () => {
const series = testUtils.generateSeries();
const feed = rss.assembleFeed(series);
const indexOfFirstPromotion = feed.indexOf(
"NRSS er avhengig av din Vipps-støtte",
);
assertEquals(indexOfFirstPromotion, -1, "First promotion should be removed");
});

View File

@ -53,10 +53,11 @@ function assembleFeed(series: Series): string {
}
function descriptionWithDonationPromotion(description: string): string {
const promotion =
const firstPromotion = `NRSS er avhengig av din Vipps-støtte⬇`;
const secondPromotion =
`Takk for at du bruker NRSS 🙏🌟 Vurder å støtte utviklingen via Vipps med omtrent det samme som prisen på en kaffekopp. Se mer på https://nrss.deno.dev/`;
return `${description}\n\n${promotion}`;
return `${firstPromotion}\n\n${description}\n\n${secondPromotion}`;
}
function assembleEpisode(episode: Episode, seriesId: Series["id"]): Tag {

View File

@ -1,5 +1,5 @@
import { assertEquals, assertNotEquals } from "$std/assert/mod.ts";
import { responseJSON, responseXML, withExpiry } from "./utils.ts";
import { responseJSON, responseXML } from "./utils.ts";
Deno.test("JSON response is stringified", async () => {
const body = { message: "Hello, World!" };
@ -14,41 +14,3 @@ Deno.test("XML resopnse is _not_ stringified", async () => {
assertEquals(responseBody, body);
assertNotEquals(responseBody, JSON.stringify(body));
});
Deno.test(
"Response with cache control returns a response with the correct header",
() => {
const response = responseJSON({ message: "Hello, World!" }, 200);
const cachedResponse = withExpiry(response, 3600);
assertEquals(cachedResponse.headers.get("Cache-Control"), "max-age=3600");
},
);
Deno.test(
"Response with cache control returns the same body as the original",
async () => {
const body = { message: "Hello, World!" };
const response = responseJSON(body, 200);
const cachedResponse = withExpiry(response, 3600);
assertEquals(await cachedResponse.text(), await response.text());
},
);
Deno.test("Response with cache control does not modify the original", () => {
const response = responseJSON({ message: "Hello, World!" }, 200);
withExpiry(response, 3600);
assertEquals(response.headers.get("Cache-Control"), null);
});
Deno.test(
"Response with cache control returns the correct number of seconds",
() => {
const response = responseJSON({ message: "Hello, World!" }, 200);
const ttlInSeconds = 1234;
const cachedResponse = withExpiry(response, ttlInSeconds);
assertEquals(
cachedResponse.headers.get("Cache-Control"),
`max-age=${ttlInSeconds}`,
);
},
);

View File

@ -24,13 +24,6 @@ export function responseXML(body: string, status: Status) {
return response(body, status, "xml");
}
export const withExpiry = <T>(response: Response, ttlInSeconds: number) => {
const clonedResponse = response.clone();
clonedResponse.headers.set("Cache-Control", `max-age=${ttlInSeconds}`);
clonedResponse.headers.set("Expires", new Date(Date.now() + ttlInSeconds * 1000).toUTCString());
return clonedResponse;
};
function response(body: string, status: number, type: "json" | "xml") {
return new Response(body, {
status,

View File

@ -1,55 +1,18 @@
import { FreshContext, STATUS_CODE } from "$fresh/server.ts";
import { caching } from "../../../lib/caching.ts";
import { rss } from "../../../lib/rss.ts";
import { responseJSON, responseXML, withExpiry } from "../../../lib/utils.ts";
import { responseJSON, responseXML } from "../../../lib/utils.ts";
const FEED_CACHE_KEY = "feeds-cache";
// Deno's cache API does not respect these headers.
// Until it does, manual expiry handling is needed.
// When it's working, this function would not be needed.
// See: https://github.com/denoland/deno/issues/25795
function isExpired(headers: Headers) {
const expiresHeader = headers.get("Expires");
if (!expiresHeader) {
console.log("No Expires header found, treating as expired");
return true;
}
const now = new Date();
const expiryDate = new Date(expiresHeader);
const expired = now > expiryDate;
return expired;
}
export const handler = async (
request: Request,
ctx: FreshContext,
): Promise<Response> => {
export const handler = async (_req: Request, ctx: FreshContext): Promise<Response> => {
const seriesId = ctx.params.seriesId;
const cache = await caches.open(FEED_CACHE_KEY);
const cachedResponse = await cache.match(request);
if (cachedResponse && !isExpired(cachedResponse.headers)) {
console.log(`Cache hit for feed ${seriesId}`);
return cachedResponse;
}
console.log(`Fetching feed for ${seriesId}`);
const series = await caching.getSeries({ id: seriesId });
if (!series) {
return responseJSON({ message: "Series not found" }, STATUS_CODE.NotFound);
}
const feed = rss.assembleFeed(series);
const response = withExpiry(
responseXML(feed, STATUS_CODE.OK),
// 2 hours
2 * 60 * 60,
);
const xml = responseXML(feed, STATUS_CODE.OK);
await cache.put(request, response.clone());
return response;
return xml;
};