9333128056

Committed 01 Jun 2024 09:00PM UTC coverage: 50.077% (+0.4%) from 49.637%

Build # 9333128056

Build Type

push

github

Committed by

bcomnes

Commit Message

Support scheduled episodes

This adds rudimentary support for scheduled episodes.
It's not perfect, but upcoming livestreams will wait and activate correctly now.

Run Details

431 of 684 branches covered (63.01%)

Branch coverage included in aggregate %.

23 of 76 new or added lines in 7 files covered. (30.26%)

126 existing lines in 7 files now uncovered.

7334 of 14822 relevant lines covered (49.48%)

0.99 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

70.31

/packages/web/plugins/cache.js

import fp from 'fastify-plugin'
// @ts-ignore
import abstractCacheRedis from 'abstract-cache-redis'

/**
 * @typedef {Object} FileKeyParams
 * @property {string} userId - The user ID.
 * @property {string} episodeId - The episode ID.
 * @property {string} sourceUrl - The source URL of the file.
 * @property {string} type - The type of the file.
 * @property {string} medium - The medium of the file.
 */

/**
 * @typedef {Object} YTDLPMetaKeyParams
 * @property {string} url - The URL of the YTDLP source.
 * @property {string} medium - The medium of the YTDLP source.
 * @property {number} attempt - Cache busting attempt key.
 */

/**
 * This plugins adds fastify/fastify-caching
 *
 * @see https://github.com/fastify/fastify-caching
 */
export default fp(async function (fastify, _) {
  const cache = abstractCacheRedis({
    // eslint-disable-next-line dot-notation
    client: fastify.redis['cache']
  })

  /**
   * Generates a file key based on the provided parameters.
   *
   * @param {FileKeyParams} params - The parameters for generating the file key.
   * @returns {string} The generated file key.
   */
  function getFileKey ({
    userId,
    episodeId,
    sourceUrl,
    type,
    medium
  }) {
    return [
      'file',
      userId,
      episodeId,
      sourceUrl,
      type,
      medium
    ].join(':')
  }

  const urlCacheTtl = 1000 * 60 * 20 // 20 mins

  fastify.decorate(cache, cache)

  fastify.decorate('urlCache', {
    /**
     * @param {FileKeyParams} params - The parameters for retrieving the cached value.
     * @returns {Promise<any>} The cached value.
     */
    async get ({ userId, episodeId, sourceUrl, type, medium }) {
      const key = getFileKey({ userId, episodeId, sourceUrl, type, medium })
      const results = await cache.get(key)
      return results?.item
    },

    /**
     * @param {FileKeyParams} params - The parameters for setting the cached value.
     * @param {any} value - The value to cache.
     * @returns {Promise<void>}
     */
    set ({ userId, episodeId, sourceUrl, type, medium }, value) {
      const key = getFileKey({ userId, episodeId, sourceUrl, type, medium })
      return cache.set(key, value, urlCacheTtl)
    }
  })

  /**
   * Generates a YTDLP meta key based on the provided parameters.
   *
   * @param {YTDLPMetaKeyParams} params - The parameters for generating the YTDLP meta key.
   * @returns {string} The generated YTDLP meta key.
   */
  function getYTDLPMetaKey ({
    url,
    medium,
    attempt = 0
  }) {
    return [
      'meta',
      url,
      medium,
      attempt
    ].join(':')
  }

  const ytdlpTtl = 1000 * 60 * 20 // 20 mins

  fastify.decorate('ytdlpCache', {
  /**
   * @param {YTDLPMetaKeyParams} params - The parameters for retrieving the cached value.
   * @returns {Promise<any>} The cached value.
   */
    async get ({ url, medium, attempt }) {
      const key = getYTDLPMetaKey({ url, medium, attempt })
      const results = await cache.get(key)
      return results?.item
    },

    /**
   * @param {YTDLPMetaKeyParams} params - The parameters for setting the cached value.
   * @param {any} value - The value to cache.
   * @returns {Promise<void>}
   */
    set ({ url, medium, attempt }, value) {
      const key = getYTDLPMetaKey({ url, medium, attempt })
      return cache.set(key, value, ytdlpTtl)
    }
  })
}, {
  name: 'cache',
  dependencies: ['redis']
})

1	import fp from 'fastify-plugin'	2✔
2	// @ts-ignore	2✔
3	import abstractCacheRedis from 'abstract-cache-redis'	2✔
4		2✔
5	/**	2✔
6	* @typedef {Object} FileKeyParams	2✔
7	* @property {string} userId - The user ID.	2✔
8	* @property {string} episodeId - The episode ID.	2✔
9	* @property {string} sourceUrl - The source URL of the file.	2✔
10	* @property {string} type - The type of the file.	2✔
11	* @property {string} medium - The medium of the file.	2✔
12	*/	2✔
13		2✔
14	/**	2✔
15	* @typedef {Object} YTDLPMetaKeyParams	2✔
16	* @property {string} url - The URL of the YTDLP source.	2✔
17	* @property {string} medium - The medium of the YTDLP source.	2✔
18	* @property {number} attempt - Cache busting attempt key.	2✔
19	*/	2✔
20		2✔
21	/**	2✔
22	* This plugins adds fastify/fastify-caching	2✔
23	*	2✔
24	* @see https://github.com/fastify/fastify-caching	2✔
25	*/	2✔
26	export default fp(async function (fastify, _) {	2✔
27	const cache = abstractCacheRedis({	2✔
28	// eslint-disable-next-line dot-notation	2✔
29	client: fastify.redis['cache']	2✔
30	})	2✔
31		2✔
32	/**	2✔
33	* Generates a file key based on the provided parameters.	2✔
34	*	2✔
35	* @param {FileKeyParams} params - The parameters for generating the file key.	2✔
36	* @returns {string} The generated file key.	2✔
37	*/	2✔
38	function getFileKey ({	2✔
UNCOV 39	userId,	×
UNCOV 40	episodeId,	×
UNCOV 41	sourceUrl,	×
42	type,	×
43	medium	×
44	}) {	×
UNCOV 45	return [	×
UNCOV 46	'file',	×
47	userId,	×
48	episodeId,	×
49	sourceUrl,	×
UNCOV 50	type,	×
UNCOV 51	medium	×
UNCOV 52	].join(':')	×
53	}	×
54		2✔
55	const urlCacheTtl = 1000 * 60 * 20 // 20 mins	2✔
56		2✔
57	fastify.decorate(cache, cache)	2✔
58		2✔
59	fastify.decorate('urlCache', {	2✔
60	/**	2✔
61	* @param {FileKeyParams} params - The parameters for retrieving the cached value.	2✔
62	* @returns {Promise<any>} The cached value.	2✔
63	*/	2✔
64	async get ({ userId, episodeId, sourceUrl, type, medium }) {	2✔
UNCOV 65	const key = getFileKey({ userId, episodeId, sourceUrl, type, medium })	×
UNCOV 66	const results = await cache.get(key)	×
UNCOV 67	return results?.item	×
68	},	2✔
69		2✔
70	/**	2✔
71	* @param {FileKeyParams} params - The parameters for setting the cached value.	2✔
72	* @param {any} value - The value to cache.	2✔
73	* @returns {Promise<void>}	2✔
74	*/	2✔
75	set ({ userId, episodeId, sourceUrl, type, medium }, value) {	2✔
76	const key = getFileKey({ userId, episodeId, sourceUrl, type, medium })	×
UNCOV 77	return cache.set(key, value, urlCacheTtl)	×
UNCOV 78	}	×
79	})	2✔
80		2✔
81	/**	2✔
82	* Generates a YTDLP meta key based on the provided parameters.	2✔
83	*	2✔
84	* @param {YTDLPMetaKeyParams} params - The parameters for generating the YTDLP meta key.	2✔
85	* @returns {string} The generated YTDLP meta key.	2✔
86	*/	2✔
87	function getYTDLPMetaKey ({	2✔
UNCOV 88	url,	×
UNCOV 89	medium,	×
UNCOV 90	attempt = 0	×
UNCOV 91	}) {	×
UNCOV 92	return [	×
UNCOV 93	'meta',	×
UNCOV 94	url,	×
UNCOV 95	medium,	×
UNCOV 96	attempt	×
UNCOV 97	].join(':')	×
UNCOV 98	}	×
99		2✔
100	const ytdlpTtl = 1000 * 60 * 20 // 20 mins	2✔
101		2✔
102	fastify.decorate('ytdlpCache', {	2✔
103	/**	2✔
104	* @param {YTDLPMetaKeyParams} params - The parameters for retrieving the cached value.	2✔
105	* @returns {Promise<any>} The cached value.	2✔
106	*/	2✔
107	async get ({ url, medium, attempt }) {	2✔
UNCOV 108	const key = getYTDLPMetaKey({ url, medium, attempt })	×
UNCOV 109	const results = await cache.get(key)	×
UNCOV 110	return results?.item	×
111	},	2✔
112		2✔
113	/**	2✔
114	* @param {YTDLPMetaKeyParams} params - The parameters for setting the cached value.	2✔
115	* @param {any} value - The value to cache.	2✔
116	* @returns {Promise<void>}	2✔
117	*/	2✔
118	set ({ url, medium, attempt }, value) {	2✔
UNCOV 119	const key = getYTDLPMetaKey({ url, medium, attempt })	×
UNCOV 120	return cache.set(key, value, ytdlpTtl)	×
UNCOV 121	}	×
122	})	2✔
123	}, {	2✔
124	name: 'cache',	2✔
125	dependencies: ['redis']	2✔
126	})	2✔

hifiwi-fi / breadcrum.net / 9333128056

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous