# all files / lib/RequestClient/ DDragonRequest.js

28.47% Statements 39/137
18.29% Branches 15/82
18.75% Functions 3/16
29.41% Lines 35/119
1 branch Ignored

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    2771×
    1×

    1×

    1×
    1×
    1×

    5×
    1×
    5×

    1×
    1×
    1×
    4×

    1×
    7×

    1×

    2×
    1×

    1×

    2×

    2×

    5×

    5×
    5×
    5×

    2×

    2×
    2×

    2×

    2×
    2×

    1×

    1×
    1×

    1×
     import request from 'request'
    import RegionHelper from '../Utils/RegionHelper'

    export const DDragonRequestTypes = {
        REALMS: 'realms',
        API: 'api',
        CDN: {
            BASE: 'cdn', // for just /cdn/endpoint
            TARBALL: 'tarball', // requires own case because the endpoint contains version information, which the Endpoint manager doesn't know of
            DATA: 'cdn_data',
            IMAGE: {
                WITH_VERSION: 'cdn_img_with_version',
                STATIC: 'cdn_img_static',
            },
        },
    }

    // Not sure how I should handle realms, versions, and a regular URL in an easy-to-code way...
    // As realm/version endpoints have different structures from cdn endpoints. We'll see!
    // Committing this to just show my thought process for now.
    const baseUrl = 'https://ddragon.leagueoflegends.com/'
    const createRealmsUrl = endpoint => `${baseUrl}realms/${endpoint}`
    const createApiUrl = endpoint => `${baseUrl}api/${endpoint}`
    // Note that this function has optional arguments. Be careful!
    const createBaseCdnUrl = endpoint => `${baseUrl}cdn/${endpoint}`
    const createCdnUrl = (type, version, locale, endpoint) =>
        createBaseCdnUrl(
            `${version ? version + '/' : ''}${type}/${
                locale ? locale + '/' : ''
            }${endpoint}`,
        )
    const createDataUrl = (version, locale, endpoint) =>
        createCdnUrl('data', version, locale, endpoint)
    const createImageUrl = (version, endpoint) =>
        createCdnUrl('img', version, null, endpoint)

    export const ddragonRequestTypeToUrl = (type, urlInformation) => {
        switch (type) {
            case DDragonRequestTypes.REALMS:
                return createRealmsUrl(urlInformation.endpoint)
            case DDragonRequestTypes.API:
                return createApiUrl(urlInformation.endpoint)
            case DDragonRequestTypes.CDN.BASE:
                return createBaseCdnUrl(urlInformation.endpoint)
            case DDragonRequestTypes.CDN.TARBALL:
                return createBaseCdnUrl(`dragontail-${urlInformation.version}.tgz`)
            case DDragonRequestTypes.CDN.DATA:
                if (!urlInformation.version) {
                    throw new Error(`
                    [kayn]: version() is required for DDragon data requests currently.
                    e.g. kayn.DDragon.Champion.list().version('8.15.1')
                    `)
                }
                return createDataUrl(
                    urlInformation.version,
                    urlInformation.locale,
                    urlInformation.endpoint,
                )
            case DDragonRequestTypes.CDN.IMAGE.WITH_VERSION:
                return createImageUrl(
                    urlInformation.version,
                    urlInformation.endpoint,
                )
            case DDragonRequestTypes.CDN.IMAGE.STATIC:
                return createImageUrl(null, urlInformation.endpoint)
            default:
                throw new Error('Invalid DDragonRequestType.')
        }
    }

    class DDragonRequest {
        constructor(config, endpoint, requestType, methodName, dataTransformer) {
            this.payload = {
                endpoint,
                version: '',
                locale: '',
                region: '',
                type: requestType,
            }
            this.config = config
            this.methodName = methodName
            this.dataTransformer = dataTransformer
        }
        version(version) {
            if (Itypeof version !== 'string')
                throw new Error('DDragonRequest.version takes in a string.')
            if (Eversion) this.payload.version = version
            return this
        }
        locale(locale) {
            if (Ithis.payload.locale)
                throw new Error('Do not call DDragonRequest.locale twice.')
            // Add locale checker
            if (Elocale) this.payload.locale = locale
            return this
        }
        region(region) {
            if (this.payload.region)
                throw new Error('Do not call Request.region twice.')
            if (!RegionHelper.isValidRegion(region))
                throw new Error('Bad region value in Request.region.')
            if (region) this.payload.region = region
            return this
        }
        async then(resolve, reject) {
            const self = this
            return new Promise((innerResolve, innerReject) =>
                self.callback(
                    (err, res) => (err ? innerReject(err) : innerResolve(res)),
                ),
            ).then(resolve, reject)
        }
        async catch(callback) {
            return this.then(null, callback)
        }
        async callback(cb) {
            if (!this.payload.locale) this.payload.locale = this.config.locale
            const { endpoint, version, locale, region, type } = this.payload
            // Hack for making `version` optional!
            // The way this works is that for the given default region,
            // there is a set of versions associated with that region.
            // If the version map for the region is already cached, we use that.
            // Otherwise, we call the endpoint manually, cache it, and then proceed.
            if (type === DDragonRequestTypes.CDN.DATA && !version) {
                const getVersionFromMap = (endpoint, versions) => {
                    if (endpoint.includes('item')) return versions.item
                    if (endpoint.includes('summoner')) return versions.summoner
                    if (endpoint.includes('champion')) return versions.champion
                    if (endpoint.includes('profileicon'))
                        return versions.profileicon
                    if (endpoint.includes('map')) return versions.map
                    if (endpoint.includes('language')) return versions.language
                }
                const executeWithVersion = (endpoint, versions) => {
                    const version = getVersionFromMap(endpoint, versions)
                    const url = ddragonRequestTypeToUrl(type, {
                        endpoint,
                        locale,
                        version,
                    })
                    this.execute(url, cb)
                }
                const realmArg = {
                    endpoint: (region || this.config.region) + '.json',
                }
                const self = this
                if (this.config.cacheOptions.cache) {
                    // Cache exists and version is unspecified
                    this.config.cacheOptions.cache.get(
                        {
                            key: ddragonRequestTypeToUrl(
                                DDragonRequestTypes.REALMS,
                                realmArg,
                            ),
                        },
                        function(err, data) {
                            if (data) {
                                executeWithVersion(endpoint, data.n)
                            } else {
                                const url = ddragonRequestTypeToUrl(
                                    DDragonRequestTypes.REALMS,
                                    realmArg,
                                )
                                self.execute(url, true, function(err, data) {
                                    const { n: versions } = data
                                    executeWithVersion(endpoint, versions)
                                })
                            }
                        },
                    )
                    return
                } else {
                    // Cache does not exist and version is unspecified
                    const url = ddragonRequestTypeToUrl(
                        DDragonRequestTypes.REALMS,
                        realmArg,
                    )
                    self.execute(url, true, function(err, data) {
                        const { n: versions } = data
                        executeWithVersion(endpoint, versions)
                    })
                    return
                }
            }
            // Cache does not exist and version is specified
            const url = ddragonRequestTypeToUrl(type, { endpoint, locale, version })
            this.execute(url, cb)
        }
        async execute(url, isRealmPreRequest, cb) {
            if (typeof isRealmPreRequest === 'function') {
                cb = isRealmPreRequest
                isRealmPreRequest = false
            }
            const { cacheOptions, debugOptions } = this.config
            const fn = async (err, data) => {
                const debugURL = url
                try {
                    if (data) {
                        if (debugOptions.isEnabled) {
                            debugOptions.loggers.cache.get(debugURL)
                        }
                        ok(data)(cb)
                    } else {
                        if (debugOptions.isEnabled) {
                            debugOptions.loggers.request.outgoing(url)
                        }
                        // TODO: Handle this in the future, of course.
                        const { body: res, statusCode } = await makeRequest(url)
                        try {
                            // `request` is making a JSON request, while this is an XML page,
                            // so it doesn't recognize this error within the `catch` block (I think).
                            if (statusCode >= 300) {
                                if (debugOptions.isEnabled) {
                                    debugOptions.loggers.request.incoming.failure(
                                        `[${statusCode}] ${url}`,
                                    )
                                }
                                error({ statusCode, url })(cb)
                                return
                            }
                            if (debugOptions.isEnabled) {
                                debugOptions.loggers.request.incoming.success(
                                    debugURL,
                                )
                            }
                            const blob = JSON.parse(res)
                            const transformedBlob =
                                this.dataTransformer && !isRealmPreRequest
                                    ? this.dataTransformer(blob)
                                    : blob
                            if (
                                cacheOptions.cache &&
                                cacheOptions.ttls[this.methodName] > 0
                            ) {
                                cacheOptions.cache.set(
                                    {
                                        key: url,
                                        ttl: cacheOptions.ttls[this.methodName],
                                    },
                                    transformedBlob,
                                )
                                if (debugOptions.isEnabled) {
                                    debugOptions.loggers.cache.set(`${url}`)
                                }
                            }
                            ok(transformedBlob)(cb)
                        } catch (ex) {
                            // Don't think this is useful?
                            error({ statusCode: ex.statusCode, url, error: ex })(cb)
                        }
                    }
                } catch (ex) {
                    // Don't think this is useful?
                    error({ statusCode: ex.statusCode, url, error: ex })(cb)
                }
            }
            if (cacheOptions.cache) {
                cacheOptions.cache.get({ key: url }, fn)
            } else {
                fn()
            }
        }
    }

    const makeRequest = (url, opts) =>
        new Promise((resolve, reject) => {
            request.get(url, (err, res) => {
                if (err) reject(err)
                else resolve(res)
            })
        })

    const ok = blob => cb => cb(null, blob)
    const error = blob => cb => cb(blob, null)

    export default DDragonRequest