Update config template string parsing and constructor options

Author: b-cho

CHANGELOG.md

@@ -39,7 +39,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 #### Changed
 
 - **[breaking]** Change the output of Data Dragon image and tarfile actions to a `Buffer` object.
-- Previous versions returned corrupted versions of the files which were unusable.
+  - Previous versions returned corrupted versions of the files which were unusable.
+- Riot API keys are no longer required in the `GaleforceModule()` constructor, and the `options` parameter is now optional.
+
+> ```typescript
+  > import GaleforceModule from 'galeforce';
+  > 
+  > const galeforce = new GaleforceModule(); // now OK, but requests requiring an API key will return a 401 Unauthorized error.
+  > ```
 
 ### [0.2.0]
 

package-lock.json

@@ -41,6 +41,7 @@
     "bluebird": "^3.7.2",
     "chalk": "^4.1.1",
     "debug": "^4.3.1",
+    "lodash": "^4.17.21",
     "node-cache": "^5.1.2",
     "redis": "^3.1.2",
     "support-color": "^7.1.0",
@@ -53,6 +54,7 @@
     "@types/bluebird": "^3.5.33",
     "@types/chai": "^4.2.17",
     "@types/debug": "^4.1.5",
+    "@types/lodash": "^4.14.168",
     "@types/mocha": "^8.2.2",
     "@types/node": "^15.0.1",
     "@types/redis": "^2.8.28",

package.json

@@ -121,8 +121,10 @@ export default class Action<TResult> {
         } catch (e) {
             if (e.response?.status) {
                 actionDebug(`${chalk.bold.magenta(this.payload._id)} | ${chalk.bold.yellow('return')} \u00AB ${chalk.bold.red(e.response.status)}`);
-                if (e.response.status === 403) {
-                    throw new Error('[galeforce]: The provided Riot API key is invalid or has expired. Please verify its authenticity. (sc-403)');
+                if (e.response.status === 401) {
+                    throw new Error('[galeforce]: No Riot API key was provided. Please ensure that your key is present in your configuration file or object. (401 Unauthorized)');
+                } else if (e.response.status === 403) {
+                    throw new Error('[galeforce]: The provided Riot API key is invalid or has expired. Please verify its authenticity. (403 Forbidden)');
                 } else {
                     throw new Error(`[galeforce]: Data fetch failed with status code ${e.response.status}`);
                 }

src/galeforce/actions/action.ts

@@ -6,6 +6,7 @@ import * as TJS from 'typescript-json-schema';
 import debug from 'debug';
 import chalk from 'chalk';
 import path from 'path';
+import _ from 'lodash';
 import { ConfigInterface } from '../interfaces/config';
 
 const initDebug = debug('galeforce:init');
@@ -18,52 +19,23 @@ const ConfigSchema = TJS.generateSchema(program, 'ConfigInterface', { required:
 const ajv = new Ajv();
 export const validate = ajv.compile(ConfigSchema);
 
-/**
- * @private
- *
- * @param {String} template A list of string templates that are filled in with environment variables.
- *
- * @return {[String]} Substituted version of template with parameter values from match.
- */
-function generateTemplateString(template: string): string {
-    return template.replace(/\$\{([\s]*[^;\s{]+[\s]*)\}/g, (mt: string) => {
-        const key = mt.substring(2, mt.length - 1);
-        if (!Object.keys(process.env).includes(key)) {
-            throw new Error(`[galeforce]: process.env.${key} is required in config file but is undefined.`);
-        }
-        return process.env[key] as string;
-    });
-}
-
-/**
- * @param {Record<string, unknown>} obj An object to substitute values from process.env for
- *
- * @return {Record<string, unknown>} Substituted version of template with process.env replaced values
- */
-function recursivelySubstitute(obj: Record<string, string | object>): Record<string, string | object> {
-    const newObj: Record<string, string | object> = JSON.parse(JSON.stringify(obj));
-
-    Object.keys(newObj).forEach((key) => {
-        if (typeof newObj[key] === 'string') {
-            newObj[key] = generateTemplateString(newObj[key] as string);
-        }
-
-        if (typeof newObj[key] === 'object') {
-            newObj[key] = recursivelySubstitute(newObj[key] as Record<string, string | object>);
-        }
-    });
-
-    return newObj as Record<string, string | object>;
-}
-
 /**
  *
  * @param {string} filename The filename of the config file.
  *
  * @return {ConfigInterface} The corresponding config object.
  */
 export function getConfig(filename: string): ConfigInterface {
-    const configObject = recursivelySubstitute(yaml.parse(fs.readFileSync(filename, 'utf8')));
+    const configObject = _.cloneDeepWith(yaml.parse(fs.readFileSync(filename, 'utf8')), (value: any) => {
+        if(typeof value === 'string') {
+            try {
+                return _.template(value)(process.env);
+            } catch (e) {
+                throw new Error(`[galeforce]: process.env.${e.message.split(' ')[0]} is required in config file but is undefined.`);
+            }
+        }
+    });
+    
     if (validate(configObject)) return configObject;
     throw new Error('Invalid config provided (config failed JSON schema validation).');
 }

src/galeforce/configs/default.ts

@@ -1,5 +1,5 @@
 export interface ConfigInterface {
-    'riot-api': {
+    'riot-api'?: {
         key: string;
     };
     cache?: {

src/galeforce/interfaces/config.ts

@@ -104,7 +104,7 @@ class Galeforce {
      * @param options A JSON configuration object or a path to a valid YAML file.
      * @throws Will throw an Error if provided an invalid configuration file or object.
      */
-    constructor(options: ConfigInterface | string) {
+    constructor(options: ConfigInterface | string = {}) {
         this.config = typeof options === 'string' ? getConfig(options) : options;
 
         if (this.config.debug) {
@@ -118,7 +118,7 @@ class Galeforce {
 
         let cache: Cache;
 
-        const RiotAPI = new RiotAPIModule(this.config['riot-api'].key);
+        const RiotAPI: RiotAPIModule = new RiotAPIModule(this.config['riot-api']?.key || '');
 
         if (this.config.cache) {
             if (this.config.cache.type === 'redis' && typeof this.config.cache.uri !== 'undefined') {

src/index.ts

@@ -6,11 +6,12 @@
 import axios, { AxiosRequestConfig } from 'axios';
 import debug from 'debug';
 import chalk from 'chalk';
+import _ from 'lodash';
 
 const requestDebug = debug('galeforce:riot-api');
 
 export default class Request {
-    protected targetURL: string;
+    public readonly targetURL: string;
 
     protected body: object;
 
@@ -32,13 +33,11 @@ export default class Request {
      * @return {[String]} Substituted version of template with parameter values from match.
      */
     protected static generateTemplateString(template: string, match: Record<string, unknown>): string {
-        return template.replace(/\$\{([\s]*[^;\s{]+[\s]*)\}/g, (mt: string): string => {
-            const key = mt.substring(2, mt.length - 1);
-            if (!Object.keys(match).includes(key)) {
-                throw new Error(`[galeforce]: Action payload ${key} is required but undefined.`);
-            }
-            return match[key] as string;
-        });
+        try {
+            return _.template(template)(match);
+        } catch (e) {
+            throw new Error(`[galeforce]: Action payload ${e.message.split(' ')[0]} is required but undefined.`);
+        }
     }
 
     /**

src/riot-api/requests/request.ts

@@ -149,6 +149,8 @@ const na1API = nock('https://na1.api.riotgames.com')
     .reply(404)
     .get('/lol/summoner/v4/summoners/by-name/403')
     .reply(403)
+    .get('/lol/summoner/v4/summoners/by-name/401')
+    .reply(401)
     .get('/lol/summoner/v4/summoners/l3ZbR4AKKKK47w170ZOqcu7kmSV2qb38RV7zK_4n1GucI0w')
     .reply(200, replyValues.v4.summoner)
     .get('/lol/summoner/v4/summoners/by-account/xG5uPpEaSFc8LvOmi4wIumQZHbTlI6WJqECcgsW-_qu_BG4')
@@ -398,7 +400,9 @@ describe('/galeforce/actions', () => {
                     it('should reject with correct error message when receiving a 404 status code', () => expect(Galeforce.lol.summoner().region(Galeforce.regions.lol.NORTH_AMERICA).name('404').exec())
                         .to.eventually.be.rejectedWith('[galeforce]: Data fetch failed with status code 404'));
                     it('should reject with correct error message when receiving a 403 status code', () => expect(Galeforce.lol.summoner().region(Galeforce.regions.lol.NORTH_AMERICA).name('403').exec())
-                        .to.eventually.be.rejectedWith('[galeforce]: The provided Riot API key is invalid or has expired. Please verify its authenticity. (sc-403)'));
+                        .to.eventually.be.rejectedWith('[galeforce]: The provided Riot API key is invalid or has expired. Please verify its authenticity. (403 Forbidden)'));
+                    it('should reject with correct error message when receiving a 403 status code', () => expect(Galeforce.lol.summoner().region(Galeforce.regions.lol.NORTH_AMERICA).name('401').exec())
+                        .to.eventually.be.rejectedWith('[galeforce]: No Riot API key was provided. Please ensure that your key is present in your configuration file or object. (401 Unauthorized)'));
                     it('should timeout when rate limit exceeded', () => new Promise((resolve, reject) => {
                         const GaleforceRL = new GaleforceModule('./test/test-configs/1.yaml');
                         const autoTimeout = setTimeout(resolve, 500);

test/actions.spec.js

@@ -90,20 +90,8 @@ describe('/galeforce', () => {
     it('should initialize properly from config file with environment variables', () => {
         expect(() => new GaleforceModule('./test/test-configs/2.yaml')).to.not.throw();
     });
-    it('should error when passed an invalid config (1)', () => {
-        expect(() => new GaleforceModule({
-            cache: {
-                type: 'redis',
-                uri: 'redis://127.0.0.1:6379',
-            },
-            'rate-limit': {
-                prefix: 'riotapi-ratelimit-',
-                intervals: {
-                    120: 100,
-                    1: 20,
-                },
-            },
-        })).to.throw();
+    it('should initialize properly without being passed a config', () => {
+        expect(() => new GaleforceModule()).to.not.throw();
     });
     it('should error when passed an invalid config (2)', () => {
         expect(() => new GaleforceModule({