DataProvider: Create a common BaseDataProvider class

Author: mstokes-f5

lib/data_provider.js

@@ -20,20 +20,25 @@ const fs = require('fs');
 const ResourceCache = require('./resource_cache').ResourceCache;
 
 /**
- * DataProvider that fetches data from the file system
+ * Abstract base class for DataProvider classes
  */
-class FsDataProvider {
-    /**
-     * @param {string} dataRootPath - a path to a directory containing data files
-     */
-    constructor(dataRootPath) {
-        this.data_path = dataRootPath;
-        this.cache = new ResourceCache(dataName => new Promise((resolve, reject) => {
-            fs.readFile(`${dataRootPath}/${dataName}.data`, (err, data) => {
-                if (err) return reject(err);
-                return resolve(data.toString('utf8'));
-            });
-        }));
+class BaseDataProvider {
+    constructor() {
+        if (new.target === BaseDataProvider) {
+            throw new TypeError('Cannot instantiate Abstract BaseDataProvider');
+        }
+
+        const abstractMethods = [
+            '_loadData',
+            'list'
+        ];
+        abstractMethods.forEach((method) => {
+            if (this[method] === undefined) {
+                throw new TypeError(`Expected ${method} to be defined`);
+            }
+        });
+
+        this.cache = new ResourceCache(dataName => this._loadData(dataName));
     }
 
     /**
@@ -45,6 +50,29 @@ class FsDataProvider {
     fetch(key) {
         return this.cache.fetch(key);
     }
+}
+
+/**
+ * DataProvider that fetches data from the file system
+ */
+class FsDataProvider extends BaseDataProvider {
+    /**
+     * @param {string} dataRootPath - a path to a directory containing data files
+     */
+    constructor(dataRootPath) {
+        super();
+
+        this.data_path = dataRootPath;
+    }
+
+    _loadData(dataName) {
+        return new Promise((resolve, reject) => {
+            fs.readFile(`${this.data_path}/${dataName}.data`, (err, data) => {
+                if (err) return reject(err);
+                return resolve(data.toString('utf8'));
+            });
+        });
+    }
 
     /**
      * List all data files known to the provider
@@ -67,41 +95,34 @@ class FsDataProvider {
 /**
  * DataProvider that fetches data from an atg-storage DataStore
  */
-class DataStoreDataProvider {
+class DataStoreDataProvider extends BaseDataProvider {
     /**
      * @param {object} datastore - an atg-storage DataStore
      * @param {string} tsName - the key to use to access the data file contents in the provided DataStore
      */
     constructor(datastore, tsName) {
+        super();
+
         this.storage = datastore;
         this.tsName = tsName;
-        this.cache = new ResourceCache(
-            dataName => this.storage.hasItem(this.tsName)
-                .then((result) => {
-                    if (result) {
-                        return Promise.resolve();
-                    }
-                    return Promise.reject(new Error(`Could not find template set "${this.tsName}" in data store`));
-                })
-                .then(() => this.storage.getItem(this.tsName))
-                .then(ts => ts.dataFiles[dataName])
-                .then((data) => {
-                    if (typeof data === 'undefined') {
-                        return Promise.reject(new Error(`Failed to find data file named "${dataName}"`));
-                    }
-                    return Promise.resolve(data);
-                })
-        );
     }
 
-    /**
-     * Get the data file contents associated with the supplied key
-     *
-     * @param {string} key
-     * @returns {object}
-     */
-    fetch(key) {
-        return this.cache.fetch(key);
+    _loadData(dataName) {
+        return this.storage.hasItem(this.tsName)
+            .then((result) => {
+                if (result) {
+                    return Promise.resolve();
+                }
+                return Promise.reject(new Error(`Could not find template set "${this.tsName}" in data store`));
+            })
+            .then(() => this.storage.getItem(this.tsName))
+            .then(ts => ts.dataFiles[dataName])
+            .then((data) => {
+                if (typeof data === 'undefined') {
+                    return Promise.reject(new Error(`Failed to find data file named "${dataName}"`));
+                }
+                return Promise.resolve(data);
+            });
     }
 
     /**
@@ -123,6 +144,7 @@ class DataStoreDataProvider {
 }
 
 module.exports = {
+    BaseDataProvider,
     FsDataProvider,
     DataStoreDataProvider
 };

lib/github_provider.js

@@ -22,6 +22,7 @@ const axios = require('axios');
 const ResourceCache = require('./resource_cache').ResourceCache;
 const Template = require('./template').Template;
 const { BaseTemplateProvider } = require('./template_provider');
+const { BaseDataProvider } = require('./data_provider');
 const { stripExtension } = require('./utils');
 
 class GitHubContentsApi {
@@ -115,29 +116,23 @@ class GitHubSchemaProvider {
 /**
  * DataProvider that fetches data from a GitHub repository
  */
-class GitHubDataProvider {
+class GitHubDataProvider extends BaseDataProvider {
     /**
      * @param {string} dataRootPath - a path to a directory containing data files
      */
     constructor(repo, dataRootPath, options) {
+        super();
         options = options || {};
 
         this._rootDir = `/${dataRootPath}`;
         this._contentsApi = new GitHubContentsApi(repo, {
             apiToken: options.apiToken
         });
-        this.cache = new ResourceCache(dataName => Promise.resolve()
-            .then(() => this._contentsApi.getContentsData(`${this._rootDir}/${dataName}.data`)));
     }
 
-    /**
-     * Get the data file contents associated with the supplied key
-     *
-     * @param {string} key
-     * @returns {object}
-     */
-    fetch(key) {
-        return this.cache.fetch(key);
+    _loadData(dataName) {
+        return Promise.resolve()
+            .then(() => this._contentsApi.getContentsData(`${this._rootDir}/${dataName}.data`));
     }
 
     /**