test(*): add more model format checks & corresponding tests

references #63

Co-authored-by: Rachna <[email protected]>

Author: sanjayaksaxena

test/bm25-vectorizer-specs.js

@@ -297,9 +297,14 @@ describe( 'bm25-vectorizer', function () {
     } );
 
     it( 'should throw error if invalid model is used', function () {
+      // Incorrect JSON.
       expect( () => v3.loadModel('[]') ).to.throw( 'wink-nlp: invalid model format/version' );
+      // No fields.
       expect( () => v3.loadModel('{}') ).to.throw( 'wink-nlp: invalid model format/version' );
+      // Incorrect UID.
       expect( () => v3.loadModel( JSON.stringify( { uid: 'junk' } ) ) ).to.throw( 'wink-nlp: invalid model format/version' );
+      // Missing required fields.
+      expect( () => v3.loadModel( JSON.stringify( { uid: 'WinkNLP-BM25Vectorizer-Model/1.0.0', 0: 0, 1: 1, 2: 2, 3: 3, 4: 4 } ) ) ).to.throw( 'wink-nlp: invalid model format/version' );
     } );
   } );
 } );

utilities/bm25-vectorizer.js

@@ -316,6 +316,9 @@ var bm25Vectorizer = function ( config ) {
    * @return {void}         Nothing!
    */
   methods.loadModel = function ( json ) {
+    // Used to check presence of required fields; `uid` is checked separately.
+    const modelFields = [ 'docId', 'tf', 'idf', 'terms', 'sumOfAllDLs' ];
+
     let model;
 
     if ( docId > 0 ) throw Error( 'wink-nlp: can not load model after learning.' );
@@ -327,11 +330,19 @@ var bm25Vectorizer = function ( config ) {
     }
 
     if ( helper.isObject( model ) && ( Object.keys( model ).length === 6 ) && ( model.uid === 'WinkNLP-BM25Vectorizer-Model/1.0.0' ) ) {
+      // Check presence of all required fields.
+      modelFields.forEach( ( f ) => {
+        if ( model[ f ] === undefined ) throw Error( 'wink-nlp: invalid model format/version' );
+      } );
+
+      // All good, set fields.
       docId = model.docId;
       tf = model.tf;
       idf = model.idf;
       terms = model.terms;
       sumOfAllDLs = model.sumOfAllDLs;
+
+      // To prevent further learning.
       weightsComputed = true;
     } else {
       throw Error( 'wink-nlp: invalid model format/version' );