From 9a239a5597f550cb8e196434cb54e3080ee8afb9 Mon Sep 17 00:00:00 2001
From: David Trattnig <david@subsquare.at>
Date: Thu, 12 Jan 2023 18:38:03 +0100
Subject: [PATCH] docs: add ticket refs to reviewed TODO items
steering#97 steering#120
---
src/cards/NowPlayingCard.svelte | 2 +-
src/cards/TimeslotCard.svelte | 4 ++--
src/common/Common.svelte | 2 ++
src/components/EpisodeDetail.svelte | 1 +
src/components/Programme.svelte | 1 +
src/components/ShowDetail.svelte | 4 ++++
src/components/ShowList.svelte | 2 +-
src/paper/ProgrammePaper.svelte | 2 +-
8 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/src/cards/NowPlayingCard.svelte b/src/cards/NowPlayingCard.svelte
index 9db8180..ca295ef 100644
--- a/src/cards/NowPlayingCard.svelte
+++ b/src/cards/NowPlayingCard.svelte
@@ -57,7 +57,7 @@
</span>
</span>
- <!-- #FIXME show name should be something like "show_name" or "episode.show.name" in API -->
+ <!-- #FIXME show name should be something like "show_name" or "episode.show.name" in API (@see steering#97) -->
{#if episode.name}
<span class="episode-show-name">
<Display value={episode.name} {renderHtml} />
diff --git a/src/cards/TimeslotCard.svelte b/src/cards/TimeslotCard.svelte
index f94e502..8c58b5c 100644
--- a/src/cards/TimeslotCard.svelte
+++ b/src/cards/TimeslotCard.svelte
@@ -87,7 +87,7 @@
<div class="timeslot-header">
<div class="show-title">
- <!-- #FIXME "episode.title" should be "episode.show_title" or for consistency "episode.show.title" // show "random order" doesn't follow this structure -->
+ <!-- #FIXME "episode.title" should be "episode.show_title" or for consistency "episode.show.title" // show "random order" doesn't follow this structure (@see steering#97) -->
<Display value={episode.title} {renderHtml} />
</div>
</div>
@@ -102,7 +102,7 @@
</p>
</a>
{:else if hasEpisodeTitle(episode)}
- <!-- #FIXME "emmission_ID" should be "timeslot_id", "episode_id" or "id" only -->
+ <!-- #FIXME "episode.emmission_ID" should be "episode.timeslot_id", "episode.episode_id" or "episode.id" only (@see steering#97) -->
<a href={urlEpisodeDetail + episode.emission_ID}>
<h2 class="episode-title">
<Display value={episode.note_title} {renderHtml} />
diff --git a/src/common/Common.svelte b/src/common/Common.svelte
index cd3604c..962355b 100644
--- a/src/common/Common.svelte
+++ b/src/common/Common.svelte
@@ -31,6 +31,7 @@
/** Checks if the given episode has a title set, indicating it's populated at all */
export function hasEpisodeTitle(episode) {
// #FIXME "episode.note_title" should be "episode.note.title"
+ // @see https://gitlab.servus.at/aura/steering/-/issues/97
// if (episode.note && episode.note.title && episode.note.title.trim())
if (episode.note_title && episode.note_title.trim()) return true
return false
@@ -166,6 +167,7 @@
/* Creates virtual timeslots for empty timeslots (temporary o94 workaround) */
// #TODO missing timeslots should be populated server-site
+ // @see steering#97
export function fillEmptyTimeslots(programme, urlDefaultFallbackShow) {
let newProgramme = []
for (let i = 0; i < programme.length; i++) {
diff --git a/src/components/EpisodeDetail.svelte b/src/components/EpisodeDetail.svelte
index 4dc21ed..6731fc8 100644
--- a/src/components/EpisodeDetail.svelte
+++ b/src/components/EpisodeDetail.svelte
@@ -41,6 +41,7 @@
// - show image
//
// There should be no need to do an additional show query
+ // @see https://gitlab.servus.at/aura/steering/-/issues/97
tmp_episode = data
let endpointShow = settings.api.endpoints.show
let showUrl = `${settings.api.url}/${endpointShow}/${data.show}`
diff --git a/src/components/Programme.svelte b/src/components/Programme.svelte
index 7141249..b32b79e 100644
--- a/src/components/Programme.svelte
+++ b/src/components/Programme.svelte
@@ -58,6 +58,7 @@
function processResponse(data) {
// Temporary workaround for o94
// #TODO Missing timeslots should be populated server-site
+ // @see https://gitlab.servus.at/aura/steering/-/issues/120
data = fillEmptyTimeslots(data, urlDefaultFallbackShow)
data = createtVirtualEndings(data)
/********************************/
diff --git a/src/components/ShowDetail.svelte b/src/components/ShowDetail.svelte
index 4812311..f9a9957 100644
--- a/src/components/ShowDetail.svelte
+++ b/src/components/ShowDetail.svelte
@@ -43,6 +43,7 @@
let hasMoreEpisodes = true
// #TODO AURA API - The API to fetch episodes is currently based on dates, the requested features are based on counts
+ // @see https://gitlab.servus.at/aura/steering/-/issues/97
/* Fetch more epsisodes for show */
function eventShowMore() {
@@ -95,6 +96,7 @@
console.log('Error while loading episodes:', data.error)
// TODO This is a valid result - The final Aura API schould not return an error,
// but 0 records only
+ // @see https://gitlab.servus.at/aura/steering/-/issues/97
if (data.error.includes('No timeslots found')) {
console.log('No records for given timeframe, maybe there are past ones')
hasMoreEpisodes = true
@@ -139,10 +141,12 @@
function processMoreEpisodes(data) {
if (data && data.error) {
// #FIXME API should handle 0 records not as an error / this case should compare for 0 records
+ // @see https://gitlab.servus.at/aura/steering/-/issues/97
hasMoreEpisodes = false
data = []
}
// #TODO The episodes should be provided ordered ascending by the API already (Ability to sort)
+ // @see https://gitlab.servus.at/aura/steering/-/issues/97
if (data != null && Array.isArray(data)) data = data.reverse()
if (episodes && Array.isArray(episodes)) {
diff --git a/src/components/ShowList.svelte b/src/components/ShowList.svelte
index 9c7da13..c2cee95 100644
--- a/src/components/ShowList.svelte
+++ b/src/components/ShowList.svelte
@@ -101,7 +101,7 @@
/* Filters shows by the first letter of its name */
function filterByName(response) {
- // #TODO Such feature should be provided on AURA API side
+ // #TODO Such feature should be provided on AURA API side / review if that's still needed by o94?
let results = []
let url = new URL(window.location.href)
let filter = url.searchParams.get('letter')
diff --git a/src/paper/ProgrammePaper.svelte b/src/paper/ProgrammePaper.svelte
index 4ff24b3..02e048e 100644
--- a/src/paper/ProgrammePaper.svelte
+++ b/src/paper/ProgrammePaper.svelte
@@ -67,7 +67,7 @@
url={renderLinks ? episode.customUrl : null}
{renderHtml} />
{:else if hasEpisodeTitle(episode)}
- <!-- #FIXME "emmission_ID" should be "timeslot_id", "episode_id" or "id" only -->
+ <!-- #FIXME "emmission_ID" should be "timeslot_id", "episode_id" or "id" only (@see steering#97) -->
<Display
value={episode.title}
url={renderLinks ? urlEpisodeDetail + episode.emission_ID : null}
--
GitLab