dochub tests and refactor

Author: skerschb

worker/jobTypes/publishDochubJob.js

@@ -1,6 +1,5 @@
 const workerUtils = require('../utils/utils');
 const validator = require('validator');
-const mongo = require('../utils/mongo');
 const invalidJobDef = new Error('job not valid');
 const invalidEnvironment = new Error(
   'environment variables missing for jobtype'
@@ -14,22 +13,6 @@ function safeString(stringToCheck) {
   return validator.isAscii(stringToCheck);
 }
 
-// retrieve the target map to upload to fastly
-async function getTargetMap() {
-  return mongo.getDochubArray();
-}
-
-async function filtermap(map) {
-  let filteredMap = [];
-  map.forEach(element => {
-    let page = 'https://dochub.mongodb.org/core/' + element.name;
-    if (workerUtils.validateUrl(page)) {
-      filteredMap.push(element);
-    }
-  });
-  return filteredMap;
-}
-
 function safePublishDochub(currentJob) {
   if (
     !currentJob ||
@@ -67,7 +50,7 @@ async function runPublishDochub(currentJob) {
     !currentJob.payload ||
     !currentJob.payload.source ||
     !currentJob.payload.target ||
-    !currentJob.payload.email
+    !currentJob.email
   ) {
     workerUtils.logInMongo(
       currentJob,
@@ -76,35 +59,27 @@ async function runPublishDochub(currentJob) {
     throw invalidJobDef;
   }
 
-  let map = await getTargetMap();
-  if (map === undefined) {
-    console.log('no docs in map');
-    workerUtils.logInMongo(
-      currentJob,
-      `${'(DOCHUB)'.padEnd(15)}failed due to no targets defined`
-    );
-    throw invalidJobDef;
-  }
+  let map = {
+    'source': currentJob.payload.source,
+    'target': currentJob.payload.target
+  };
 
-  map = await filtermap(map);
   if (map === undefined) {
     workerUtils.logInMongo(
       currentJob,
-      `${'(DOCHUB)'.padEnd(15)}failed due to no valid targets`
+      `${'(DOCHUB)'.padEnd(15)}failed due to no targets defined`
     );
     throw invalidJobDef;
   }
-
-  const job = new FastlyJob(currentJob);
-  await job.connectAndUpsert(map).catch(err => {
-    console.log('could not complete map');
+  
+  const initFastly = new FastlyJob(currentJob);
+  await initFastly.connectAndUpsert(map).then().catch (err => {
     workerUtils.logInMongo(currentJob, `could not complete map ${err}`);
+    throw invalidEnvironment;
   });
 }
 
 module.exports = {
   runPublishDochub,
-  safePublishDochub,
-  filtermap,
-  getTargetMap
+  safePublishDochub
 };

worker/tests/unit/environment.test.js

@@ -0,0 +1,26 @@
+/** ******************************************************************
+ *                  Sample Class for Testing                       *
+ ******************************************************************* */
+
+const env = require('../../utils/environment');
+
+describe('Test Class', () => {
+  beforeAll(() => {});
+
+  afterAll(() => {});
+
+  beforeEach(() => {});
+
+  afterEach(() => {});
+
+  it('test env defaults', async () => {
+      expect(env.EnvironmentClass.getAtlasPassword()).toEqual('passwordTest');
+      expect(env.EnvironmentClass.getAtlasUsername()).toEqual('usernameTest');
+      expect(env.EnvironmentClass.getDB()).toEqual('pool_test');
+      expect(env.EnvironmentClass.getDochubMap()).toEqual('dochubMap');
+      expect(env.EnvironmentClass.getFastlyServiceId()).toEqual('testId');
+      expect(env.EnvironmentClass.getFastlyToken()).toBeUndefined();
+      expect(env.EnvironmentClass.getXlarge()).toEqual(false);
+
+  });
+});

worker/tests/unit/fastlyJob.test.js

@@ -7,7 +7,6 @@ const FastlyJob = require('../../utils/fastlyJob').FastlyJobClass;
 const payloadObj = {
   source: 'someSource',
   target: 'someTarget',
-  email: '[email protected]'
 };
 
 const goodDochuhJob = {
@@ -20,6 +19,11 @@ const doc = {
   name: 'collections'
 };
 
+const map = {
+  'source': 'source',
+  'target': 'target'
+};
+
 describe('Fastly Job Test Class', () => {
   beforeAll(() => {});
 
@@ -29,16 +33,10 @@ describe('Fastly Job Test Class', () => {
 
   afterEach(() => {});
 
-  it('Fastly Job Class Test', async () => {
-    const fastlyJob = new FastlyJob(goodDochuhJob);
-    fastlyJob.connectAndUpsert = jest.fn().mockImplementation(() => {
-      return { success: true };
-    });
-    expect(fastlyJob.connectAndUpsert([doc])).toEqual({ success: true });
-  });
-
   it('FastlyJob test connect and upsert', async () => {
-    const fastlyJob = new FastlyJob(goodDochuhJob);
-    expect(fastlyJob.connectAndUpsert([doc])).toBeDefined();
+    const fastly = new FastlyJob(this.goodDochuhJob);
+    return fastly.connectAndUpsert(map).catch(error => {
+      expect(error).toBeDefined();
+    });
   });
 });

worker/tests/unit/mongo.test.js

@@ -1,8 +1,8 @@
 const { MongoClient } = require('mongodb');
 const mongo = require('../../utils/mongo');
+const env = require('../../utils/environment');
 
-const runXlarge =
-  process.env.XLARGE === undefined ? false : Boolean(process.env.XLARGE);
+const runXlarge = env.EnvironmentClass.getXlarge();
 const Monitor = require('../../utils/monitor').Monitor;
 
 // Helper function to add n days to the current date

worker/tests/unit/publishDochubJob.unit.test.js

@@ -1,21 +1,19 @@
 const job = require('../../jobTypes/publishDochubJob');
 const workerUtils = require('../../utils/utils');
-const mongo = require('../../utils/mongo');
 
 const payloadObj = {
   source: 'someSource',
   target: 'someTarget',
-  email: '[email protected]'
 };
 
 const payloadObjBadSource = {
-  source: 'some source',
+  sourcebad: 'some source',
   target: 'someTarget'
 };
 
 const payloadObjBadTarget = {
   source: 'someSource',
-  target: 'some target'
+  targetbad: 'some target'
 };
 
 const payloadNoEmail = {
@@ -24,29 +22,24 @@ const payloadNoEmail = {
 };
 
 const testPayloadGood = {
-  payload: payloadObj
+  payload: payloadObj,
+  email: 'testemail'
 };
 
 const testPayloadWithoutEmail = {
   payload: payloadNoEmail
 };
 
 const testPayloadBadSource = {
-  payload: payloadObjBadSource
+  payload: payloadObjBadSource,
+  email: 'testemail'
 };
 
 const testPayloadBadTarget = {
-  payload: payloadObjBadTarget
+  payload: payloadObjBadTarget,
+  email: 'testemail'
 };
 
-const doc = [
-  {
-    _id: { $oid: '4db32eacdbd1ff5a7a24ff17' },
-    url: 'http://www.mongodb.org/display/DOCS/Collections',
-    name: 'collections'
-  }
-];
-
 const error = new Error('job not valid');
 
 describe('Test Class', () => {
@@ -60,29 +53,18 @@ describe('Test Class', () => {
   // Tests for dochubpublish() function
 
   it('runPublishDochub() rejects properly killed', async () => {
-    mongo.getDochubArray = jest.fn().mockResolvedValue(doc);
     expect(await job.runPublishDochub(testPayloadGood)).toBeUndefined();
   });
   // Tests for RunPublishDochub Function
 
   it('runPublishDochub() rejects lack of map', async () => {
-    mongo.getDochubArray = jest.fn().mockResolvedValue(undefined);
-    let thrownError;
-    try {
-      job.safePublishDochub(testPayloadGood).toBeCalled();
-    } catch (e) {
-      thrownError = e;
-    }
-    expect(thrownError).toEqual(error);
+    expect(job.safePublishDochub(testPayloadGood)).toBeTruthy();
   });
 
   it('runPublishDochub(): no email --> should fail to run', async () => {
-    job.build = jest.fn().mockRejectedValue(error);
     await expect(job.runPublishDochub(testPayloadWithoutEmail)).rejects.toEqual(
       error
     );
-    jest.runAllTimers();
-    expect(job.build).toHaveBeenCalledTimes(0);
   });
 
   // Sanitize

worker/utils/environment.js

@@ -1,7 +1,6 @@
 const fastlyToken = process.env.FASTLY_TOKEN;
 const fastlyServiceId = process.env.FASTLY_SERVICE_ID;
 const dochubMap = process.env.FASTLY_DOCHUB_MAP;
-const dochubDB = process.env.DOCHUB_DB;
 const atlasUsername = process.env.MONGO_ATLAS_USERNAME;
 const atlasPassword = process.env.MONGO_ATLAS_PASSWORD;
 const xlarge = process.env.XLARGE;
@@ -19,13 +18,13 @@ class EnvironmentClass {
     if (xlarge === undefined) {
       return false;
     }
-    return Boolean(xlarge);
+    if (xlarge === 'true') {
+      return true;
+    }
+    return false;
   }
 
   static getFastlyToken() {
-    if (fastlyToken === undefined) {
-      return 'testToken';
-    }
     return fastlyToken;
   }
 
@@ -36,13 +35,6 @@ class EnvironmentClass {
     return dochubMap;
   }
 
-  static getDochubDB() {
-    if (dochubDB === undefined) {
-      return 'dochub';
-    }
-    return dochubDB;
-  }
-
   static getAtlasUsername() {
     if (atlasUsername === undefined) {
       return 'usernameTest';

worker/utils/fastlyJob.js

@@ -1,52 +1,33 @@
 const utils = require('../utils/utils');
 const environment = require('../utils/environment').EnvironmentClass;
-
 const fastly = require('fastly')(environment.getFastlyToken());
 
+
 class FastlyJobClass {
   // pass in a job payload to setup class
   constructor(currentJob) {
     this.currentJob = currentJob;
-    if (fastly == undefined) {
+    if (fastly === undefined) {
       utils.logInMongo(currentJob, 'fastly connectivity not found');
     }
   }
 
   // upserts {source: target} mappings
   // to the fastly edge dictionary
   async connectAndUpsert(map) {
-    for (let doc in map) {
-      console.log(`iterating ${map[doc].url}`);
-      const options = {
-        item_value: map[doc].url
-      };
-      await this.runFastlyMapCall(map[doc], options)
-        .catch(err => {
-          return err;
-        })
-        .then();
-    }
-  }
-
-  async runFastlyMapCall(doc, options) {
-    const connectString = `/service/${environment.getFastlyServiceId()}/dictionary/${environment.getDochubMap()}/item/${
-      doc.name
-    }`;
-
-    let promise1 = (method, url, options) => {
-      return new Promise((resolve, reject) => {
-        fastly.request(method, url, options, function(err, obj) {
-          if (err) return reject(err);
-          resolve(obj);
-        });
-      });
+    const options = {
+      item_value: map.target
     };
+    const connectString = `/service/${environment.getFastlyServiceId()}/dictionary/${environment.getDochubMap()}/item/${
+      map.source
+      }`;
 
-    promise1('POST', connectString, options)
-      .then()
-      .catch(error => {
-        throw error;
+    return new Promise((resolve, reject) => {
+      fastly.request('PUT', connectString, options, function (err, obj) {
+        if (err) reject(err);
+        resolve(obj);
       });
+    })
   }
 }
 

worker/utils/mongo.js

@@ -13,8 +13,6 @@ const DB_NAME = EnvironmentClass.getDB(); // Database name of the queue in Mongo
 const COLL_NAME = 'queue'; // Collection name of the queue in MongoDB Atlas
 const META_NAME = 'meta';
 const MONITOR_NAME = 'monitor';
-const FASTLY_NAME = 'keys';
-const DOCHUB_NAME = EnvironmentClass.getDochubDB();
 
 // Hold onto the client
 let client;
@@ -50,19 +48,6 @@ module.exports = {
     return null;
   },
 
-  getDochubCollection() {
-    if (client) {
-      return client.db(DOCHUB_NAME).collection(FASTLY_NAME);
-    }
-    return null;
-  },
-
-  async getDochubArray() {
-    return await this.getDochubCollection()
-      .find({})
-      .toArray();
-  },
-
   async reportStatus(monitor) {
     monitor.setXlarge(runXlarge);
     monitor.setEnvType(DB_NAME);