chore(media-provider): improve flags interface

Author: Kikobeats

packages/metascraper-media-provider/README.md

@@ -26,24 +26,6 @@ Type: `string`
 
 It specifies cache based on file system to be used by [youtube-dl](youtube-dl).
 
-##### getProxy
-
-Type: `function`
-
-It will be called to determinate if a proxy should be used for resolving the next request URL.
-
-```js
-const getProxy = ({ url, retryCount }) => {
-  if (retryCount === 0) return false
-  return 'http://user:pwd@proxy:8001'
-}
-```
-
-##### gotOpts
-
-Type: `object`
-
-Any option provided here will passed to [got#options](https://github.com/sindresorhus/got#options).
 
 ##### retry
 
@@ -59,6 +41,20 @@ Default: `30000`
 
 The maximum time allowed to wait until considering the request as timed out.
 
+##### flags
+
+Type: `function`<br>
+Default: `object`
+
+It defines a function that will determine the flags to be passed to [youtube-dl](youtube-dl):
+
+```js
+const getFlags = ({ flags, url, retryCount }) => {
+  flags.addHeader = [`referer:${url}`]
+  return flags
+}
+```
+
 ## License
 
 **metascraper-media-provider** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/metascraper/blob/master/LICENSE.md) License.<br>

packages/metascraper-media-provider/src/get-media.js

@@ -6,56 +6,36 @@ const debug = require('debug-logfmt')(
 const { serializeError } = require('serialize-error')
 const asyncMemoizeOne = require('async-memoize-one')
 const youtubedl = require('youtube-dl-exec')
-const { get, constant } = require('lodash')
 const pTimeout = require('p-timeout')
 
 const RE_UNSUPORTED_URL = /Unsupported URL/
 
-const getFlags = ({ proxy, url, userAgent, cacheDir }) => {
-  const flags = {
-    dumpSingleJson: true,
-    noCheckCertificates: true,
-    noWarnings: true,
-    preferFreeFormats: true
-  }
-
-  flags.addHeader = [
-    `referer:${url}`,
-    userAgent && `user-agent:${userAgent}`
-  ].filter(Boolean)
-
-  if (cacheDir) flags.cacheDir = cacheDir
-  else flags.noCacheDir = true
-
-  if (proxy) flags.proxy = proxy.toString()
-
-  return flags
+const DEFAULT_FLAGS = {
+  dumpSingleJson: true,
+  noCheckCertificates: true,
+  noWarnings: true,
+  preferFreeFormats: true
 }
 
 module.exports = ({
-  cacheDir,
-  getProxy = constant(false),
   timeout = 30000,
   retry = 2,
-  gotOpts,
+  flags: getFlags = ({ flags }) => flags,
   ...props
 }) =>
   asyncMemoizeOne(async url => {
-    let retryCount = 0
+    const retryCount = 0
     let isTimeout = false
     let isSupportedURL = true
     let data
 
     const condition = () =>
       isSupportedURL && !isTimeout && data === undefined && retryCount <= retry
 
-    const userAgent = get(gotOpts, 'headers.user-agent')
-
     const task = async () => {
       do {
         try {
-          const proxy = getProxy({ url, retryCount: retryCount++ })
-          const flags = getFlags({ url, proxy, userAgent, cacheDir })
+          const flags = getFlags({ url, retryCount, flags: DEFAULT_FLAGS })
           data = await youtubedl(url, flags, { timeout, ...props })
         } catch (error) {
           if (condition()) {
@@ -76,4 +56,4 @@ module.exports = ({
     return pTimeout(task(), timeout, fallback).then(data => data ?? {})
   })
 
-module.exports.getFlags = getFlags
+module.exports.DEFAULT_FLAGS = DEFAULT_FLAGS

packages/metascraper-media-provider/test/fixtures/generate.js

@@ -4,16 +4,15 @@ const youtubedl = require('youtube-dl-exec')
 const path = require('path')
 const fs = require('fs/promises')
 
-const { getFlags } = require('../../src/get-media')
+const { DEFAULT_FLAGS } = require('../../src/get-media')
 
 let [, , url, filename] = process.argv
 
 if (!url) throw new TypeError('process.argv[2] should be an url')
 if (!filename) throw new TypeError('process.argv[3] should be a filename')
 if (!filename.endsWith('.json')) filename += '.json'
 ;(async () => {
-  const flags = getFlags({ url })
-  const payload = await youtubedl(url, flags)
+  const payload = await youtubedl(url, DEFAULT_FLAGS)
   const filepath = path.resolve(__dirname, 'provider', filename)
   await fs.writeFile(filepath, JSON.stringify(payload, null, 2))
   console.log('Done at', filepath, '✨')