Save rating data to another database field

This maintains the old behavior while also writing rating result to another
field in the database.

4 files changed, 470 insertions, 291 deletions

diff --git a/test/numeric-test.ts b/test/numeric-test.ts
new file mode 100644
index 0000000..8f07bb6
--- /dev/null
+++ b/test/numeric-test.ts
@@ -0,0 +1,59 @@
+/**
+ * Test numeric types
+ *
+ *  Copyright (C) 2010-2019 R-T Specialty, LLC.
+ *
+ *  This file is part of the Liza Data Collection Framework.
+ *
+ *  liza is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ *  published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { expect } from 'chai';
+import { PositiveInteger, isPositiveInteger } from "../src/numeric";
+
+
+describe( 'isPositiveInteger', () =>
+{
+    [
+        0,
+        5,
+    ].forEach( value => it( `accepts positive integers (${value})`, () =>
+    {
+        expect( isPositiveInteger( value ) ).to.be.true;
+    } ) );
+
+
+    [
+        -1,
+        -5,
+    ].forEach( value => it( `rejects negative integers (${value})`, () =>
+    {
+        expect( isPositiveInteger( value ) ).to.be.false;
+    } ) );
+
+
+    it( "asserts type PositiveInteger", () =>
+    {
+        const n = 5;
+
+        if ( isPositiveInteger( n ) )
+        {
+            // TS should recognize as PositiveInteger within this block
+            checkPositiveInteger( n );
+        }
+    } );
+} );
+
+
+const checkPositiveInteger = ( _n: PositiveInteger ): void => {};
diff --git a/test/server/service/RatingServiceSubmitNotifyTest.js b/test/server/service/RatingServiceSubmitNotifyTest.js
deleted file mode 100644
index 1333eaf..0000000
--- a/test/server/service/RatingServiceSubmitNotifyTest.js
+++ /dev/null
@@ -1,186 +0,0 @@
-/**
- * Tests RatingServiceSubmitNotify
- *
- *  Copyright (C) 2010-2019 R-T Specialty, LLC.
- *
- *  This file is part of the Liza Data Collection Framework.
- *
- *  liza is free software: you can redistribute it and/or modify
- *  it under the terms of the GNU Affero General Public License as
- *  published by the Free Software Foundation, either version 3 of the
- *  License, or (at your option) any later version.
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU Affero General Public License
- *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-'use strict'
-
-const { Class }  = require( 'easejs' );
-const { expect } = require( 'chai' );
-
-
-const {
-    dapi: {
-        DataApi,
-    },
-    server: {
-        service: {
-            RatingServiceSubmitNotify: Sut,
-            RatingService,
-        },
-    },
-    test: {
-        server: {
-            service: {
-                RatingServiceStub,
-            },
-        },
-    },
-} = require( '../../../' );
-
-
-describe( 'RatingServiceSubmitNotify', () =>
-{
-    [
-        // not available; make successful request and save flag
-        {
-            prem_avail_count: [ 0 ],
-            prev_called:      false,
-            expected_request: true,
-            request_err:      null,
-            save:             true,
-        },
-        // not available; make failing request, don't save flag
-        {
-            prem_avail_count: [ 0 ],
-            prev_called:      false,
-            expected_request: true,
-            request_err:      Error(),
-            save:             false,
-        },
-        // available
-        {
-            prem_avail_count: [ 2 ],
-            prev_called:      false,
-            expected_request: false,
-            request_err:      null,
-            save:             false,
-        },
-        // this shouldn't happen; ignore all but first index
-        {
-            prem_avail_count: [ 2, 2 ],
-            prev_called:      false,
-            expected_request: false,
-            request_err:      null,
-            save:             false,
-        },
-        // save as above, but already saved
-        {
-            prem_avail_count: [ 0 ],
-            prev_called:      true,
-            expected_request: false,
-            request_err:      null,
-            save:             false,
-        },
-        // available; don't make request
-        {
-            prem_avail_count: [ 2 ],
-            prev_called:      true,
-            expected_request: false,
-            request_err:      null,
-            save:             false,
-        },
-        // this shouldn't happen; ignore all but first index
-        {
-            prem_avail_count: [ 2, 2 ],
-            prev_called:      true,
-            expected_request: false,
-            request_err:      null,
-            save:             false,
-        },
-    ].forEach( ( expected, i ) =>
-        it( `sends request on post process if no premiums (#${i})`, done =>
-        {
-            const {
-                dao,
-                logger,
-                quote,
-                raters,
-                request,
-                response,
-                server,
-                stub_rate_data,
-            } = RatingServiceStub.getStubs();
-
-            const quote_id  = 1234;
-            let   requested = false;
-
-            const dapif = given_request =>
-                Class.implement( DataApi ).extend(
-                {
-                    // warning: if an expectation fails, because of how
-                    // RatingService handles errors, it will cause the test to
-                    // _hang_ rather than throw the assertion error
-                    request( data, callback, id )
-                    {
-                        expect( given_request ).to.equal( request );
-                        expect( data ).to.deep.equal( { quote_id: quote_id } );
-
-                        requested = true;
-
-                        callback( expected.request_err, null );
-                    },
-                } )();
-
-            const sut = RatingService.use( Sut( dapif, dao ) )(
-                logger, dao, server, raters
-            );
-
-            quote.getId = () => quote_id;
-
-            // one of the methods that is called by the supertype
-            let save_called = false;
-            dao.setWorksheets = () => save_called = true;
-
-            // whether the notify flag is actually set
-            let notify_saved = false;
-
-            // request for notification status
-            dao.getDocumentField = ( qid, key, callback ) =>
-            {
-                expect( qid ).to.equal( quote_id );
-                expect( key ).to.equal( 'submitNotified' );
-
-                callback( expected.flag_error, expected.prev_called );
-            };
-
-            dao.setDocumentField = ( qid, key, value, callback ) =>
-            {
-                expect( qid ).to.equal( quote_id );
-                expect( key ).to.equal( 'submitNotified' );
-                expect( value ).to.equal( true );
-
-                notify_saved = true;
-            };
-
-            stub_rate_data.__prem_avail_count = expected.prem_avail_count;
-
-            sut.request( request, response, quote, 'something', () =>
-            {
-                expect( requested ).to.equal( expected.expected_request );
-                expect( save_called ).to.be.true;
-
-                // only save notification status if we're notifying
-                expect( notify_saved ).to.equal( expected.save );
-
-                done();
-            } );
-        } )
-    );
-} );
diff --git a/test/server/service/RatingServiceTest.js b/test/server/service/RatingServiceTest.js
deleted file mode 100644
index b04c354..0000000
--- a/test/server/service/RatingServiceTest.js
+++ /dev/null
@@ -1,105 +0,0 @@
-/**
- * Tests RatingService
- *
- *  Copyright (C) 2010-2019 R-T Specialty, LLC.
- *
- *  This file is part of the Liza Data Collection Framework.
- *
- *  liza is free software: you can redistribute it and/or modify
- *  it under the terms of the GNU Affero General Public License as
- *  published by the Free Software Foundation, either version 3 of the
- *  License, or (at your option) any later version.
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU Affero General Public License
- *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-'use strict'
-
-const { expect }        = require( 'chai' );
-const Sut               = require( '../../../' ).server.service.RatingService;
-const RatingServiceStub = require( '../../../' ).test.server.service.RatingServiceStub;
-
-describe( 'RatingService', () =>
-{
-    describe( "protected API", () =>
-    {
-        it( "calls #postProcessRaterData after rating before save", done =>
-        {
-            let processed = false;
-
-            const {
-                logger,
-                server,
-                raters,
-                dao,
-                request,
-                response,
-                quote,
-            } = RatingServiceStub.getStubs();
-
-            dao.mergeBucket = () =>
-            {
-                expect( processed ).to.equal( true );
-                done();
-            };
-
-            const sut = Sut.extend(
-            {
-                'override postProcessRaterData'(
-                    request, data, actions, program, quote
-                )
-                {
-                    processed = true;
-                }
-            } )( logger, dao, server, raters );
-
-            sut.request( request, response, quote, 'something', () => {} );
-        } );
-
-        it( "calls getLastPremiumDate during #_performRating", done =>
-        {
-            let getLastPremiumDateCallCount = 0;
-
-            const last_date    = 1234;
-            const initial_date = 2345;
-
-            const {
-                logger,
-                server,
-                raters,
-                dao,
-                request,
-                response,
-                quote,
-            } = RatingServiceStub.getStubs();
-
-            quote.getLastPremiumDate = () =>
-            {
-                getLastPremiumDateCallCount++;
-                return last_date
-            };
-
-            quote.getRatedDate = () => initial_date;
-
-            const sut = Sut( logger, dao, server, raters );
-
-            server.sendResponse = ( request, quote, resp, actions ) =>
-            {
-                expect( getLastPremiumDateCallCount ).to.equal( 2 );
-                expect( resp.initialRatedDate ).to.equal( initial_date );
-                expect( resp.lastRatedDate ).to.equal( last_date );
-
-                done();
-            };
-
-            sut.request( request, response, quote, null, () => {} );
-        } );
-
-    } );
-} );
diff --git a/test/server/service/RatingServiceTest.ts b/test/server/service/RatingServiceTest.ts
new file mode 100644
index 0000000..fd659d6
--- /dev/null
+++ b/test/server/service/RatingServiceTest.ts
@@ -0,0 +1,411 @@
+/**
+ * Tests RatingService
+ *
+ *  Copyright (C) 2010-2019 R-T Specialty, LLC.
+ *
+ *  This file is part of the Liza Data Collection Framework.
+ *
+ *  liza is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ *  published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { RatingService as Sut } from "../../../src/server/service/RatingService";
+
+import { ClientActions } from "../../../src/client/action/ClientAction";
+import { PriorityLog } from "../../../src/server/log/PriorityLog";
+import { ProcessManager } from "../../../src/server/rater/ProcessManager";
+import { Program } from "../../../src/program/Program";
+import { QuoteId } from "../../../src/quote/Quote";
+import { Rater, RateResult } from "../../../src/server/rater/Rater";
+import { Server } from "../../../src/server/Server";
+import { ServerSideQuote } from "../../../src/server/quote/ServerSideQuote";
+import { UserRequest } from "../../../src/server/request/UserRequest";
+import { UserResponse } from "../../../src/server/request/UserResponse";
+import { UserSession } from "../../../src/server/request/UserSession";
+
+import {
+    ServerDao,
+    Callback as ServerDaoCallback
+} from "../../../src/server/db/ServerDao";
+
+import { expect, use as chai_use } from 'chai';
+chai_use( require( 'chai-as-promised' ) );
+
+
+describe( 'RatingService', () =>
+{
+    it( "returns rating results", () =>
+    {
+        const {
+            logger,
+            server,
+            raters,
+            dao,
+            request,
+            response,
+            quote,
+            stub_rate_data,
+        } = getStubs();
+
+        const sut = new Sut( logger, dao, server, raters );
+
+        const expected = {
+            data:             stub_rate_data,
+            initialRatedDate: quote.getRatedDate(),
+            lastRatedDate:    quote.getLastPremiumDate(),
+        };
+
+        return expect( sut.request( request, response, quote, "" ) )
+            .to.eventually.deep.equal( expected );
+    } );
+
+    it( "saves rate data to own field", () =>
+    {
+        const {
+            logger,
+            server,
+            raters,
+            dao,
+            request,
+            response,
+            quote,
+            stub_rate_data,
+        } = getStubs();
+
+        let saved_rates = false;
+
+        dao.saveQuote = (
+            quote:     ServerSideQuote,
+            success:   ServerDaoCallback,
+            _failure:  ServerDaoCallback,
+            save_data: Record<string, any>,
+        ) =>
+        {
+            expect( save_data ).to.deep.equal( {
+                ratedata: stub_rate_data,
+            } );
+
+            saved_rates = true;
+            success( quote );
+
+            return dao;
+        };
+
+        const sut = new Sut( logger, dao, server, raters );
+
+        return sut.request( request, response, quote, "" )
+            .then( () =>
+            {
+                expect( saved_rates ).to.be.true;
+            } );
+    } );
+
+
+    it( "rejects and responds with error", () =>
+    {
+        const {
+            dao,
+            logger,
+            program,
+            quote,
+            rater,
+            raters,
+            request,
+            response,
+            server,
+        } = getStubs();
+
+        const expected_error = new Error( "expected error" );
+
+        rater.rate = () => { throw expected_error; };
+
+        const sut = new Sut( logger, dao, server, raters );
+
+        let logged = false;
+
+        logger.log = function(
+            priority:   number,
+            _format:    string,
+            qid:        QuoteId,
+            program_id: string,
+            message:    string,
+        )
+        {
+            if ( typeof message === 'string' )
+            {
+                expect( priority ).to.equal( logger.PRIORITY_ERROR );
+                expect( qid ).to.equal( quote.getId() );
+                expect( program_id ).to.equal( program.getId() );
+                expect( message ).to.contain( expected_error.message );
+
+                logged = true;
+            }
+
+            return logger;
+        };
+
+        return expect( sut.request( request, response, quote, "" ) )
+            .to.eventually.rejectedWith( expected_error )
+            .then( () => expect( logged ).to.be.true );
+    } );
+
+
+    it( "returns error message from rater", () =>
+    {
+        const {
+            dao,
+            logger,
+            quote,
+            rater,
+            raters,
+            request,
+            response,
+            server,
+        } = getStubs();
+
+        const expected_message = 'expected foo';
+
+        const sut = new Sut( logger, dao, server, raters );
+
+        rater.rate = (
+            _quote:   ServerSideQuote,
+            _session: UserSession,
+            _indv:    string,
+            _success: ( data: RateResult, actions: ClientActions ) => void,
+            failure:  ( message: string ) => void,
+        ) =>
+        {
+            failure( expected_message );
+            return rater;
+        };
+
+        return expect( sut.request( request, response, quote, "" ) )
+            .to.eventually.rejectedWith( Error, expected_message );
+    } );
+
+
+    describe( "protected API", () =>
+    {
+        it( "calls #postProcessRaterData after rating before save", done =>
+        {
+            let processed = false;
+
+            const {
+                logger,
+                server,
+                raters,
+                dao,
+                request,
+                response,
+                quote,
+            } = getStubs();
+
+            dao.mergeBucket = () =>
+            {
+                expect( processed ).to.equal( true );
+                done();
+
+                return dao;
+            };
+
+            const sut = new class extends Sut
+            {
+                postProcessRaterData()
+                {
+                    processed = true;
+                }
+            }( logger, dao, server, raters );
+
+            sut.request( request, response, quote, 'something' );
+        } );
+
+        it( "calls getLastPremiumDate during #_performRating", done =>
+        {
+            let getLastPremiumDateCallCount = 0;
+
+            const last_date    = <UnixTimestamp>1234;
+            const initial_date = <UnixTimestamp>2345;
+
+            const {
+                logger,
+                server,
+                raters,
+                dao,
+                request,
+                response,
+                quote,
+            } = getStubs();
+
+            quote.getLastPremiumDate = () =>
+            {
+                getLastPremiumDateCallCount++;
+                return last_date
+            };
+
+            quote.getRatedDate = () => initial_date;
+
+            const sut = new Sut( logger, dao, server, raters );
+
+            server.sendResponse = ( _request: any, _quote: any, resp: any, _actions: any ) =>
+            {
+                expect( getLastPremiumDateCallCount ).to.equal( 2 );
+                expect( resp.initialRatedDate ).to.equal( initial_date );
+                expect( resp.lastRatedDate ).to.equal( last_date );
+
+                done();
+
+                return server;
+            };
+
+            sut.request( request, response, quote, "" );
+        } );
+    } );
+} );
+
+
+function getStubs()
+{
+    const program_id = 'foo';
+
+    const program = <Program>{
+        getId:               () => program_id,
+        ineligibleLockCount: 0,
+    };
+
+    // rate reply
+    const stub_rate_data: RateResult = {
+        _unavailable_all: '0',
+    };
+
+    const rater = new class implements Rater
+    {
+        rate(
+            _quote:   ServerSideQuote,
+            _session: UserSession,
+            _indv:    string,
+            success:  ( data: RateResult, actions: ClientActions ) => void,
+            _failure: ( message: string ) => void,
+        )
+        {
+            // force to be async so that the tests resemble how the code
+            // actually runs
+            process.nextTick( () => success( stub_rate_data, [] ) );
+
+            return this;
+        }
+    };
+
+    const raters = <ProcessManager>{
+        byId: () => rater,
+    };
+
+    const logger = new class implements PriorityLog
+    {
+        readonly PRIORITY_ERROR: number     = 0;
+        readonly PRIORITY_IMPORTANT: number = 1;
+        readonly PRIORITY_DB: number        = 2;
+        readonly PRIORITY_INFO: number      = 3;
+        readonly PRIORITY_SOCKET: number    = 4;
+
+        log( _priority: number, ..._args: Array<string|number> ): this
+        {
+            return this;
+        }
+    };
+
+    const server = <Server>{
+        sendResponse: () => server,
+        sendError:    () => server,
+    };
+
+    const dao = new class implements ServerDao
+    {
+        saveQuote(
+            quote:      ServerSideQuote,
+            success:    ServerDaoCallback,
+            _failure:   ServerDaoCallback,
+            _save_data: Record<string, any>,
+        ): this
+        {
+            success( quote );
+            return this;
+        }
+
+        mergeBucket(): this
+        {
+            return this;
+        }
+
+        saveQuoteClasses(): this
+        {
+            return this;
+        }
+
+        setWorksheets(): this
+        {
+            return this;
+        }
+
+        saveQuoteState(): this
+        {
+            throw new Error( "Unused method" );
+        }
+
+        saveQuoteLockState(): this
+        {
+            throw new Error( "Unused method" );
+        }
+
+        getWorksheet(): this
+        {
+            throw new Error( "Unused method" );
+        }
+    };
+
+    const session = <UserSession>{
+        isInternal: () => false,
+    };
+
+    const request = <UserRequest>{
+        getSession:       () => session,
+        getSessionIdName: () => {},
+    };
+
+    const response = <UserResponse>{};
+
+    const quote = <ServerSideQuote>{
+        getProgramId:       () => program_id,
+        getProgram:         () => program,
+        getId:              () => <QuoteId>0,
+        setLastPremiumDate: () => quote,
+        setRatedDate:       () => quote,
+        getRatedDate:       () => <UnixTimestamp>0,
+        getLastPremiumDate: () => <UnixTimestamp>0,
+        getCurrentStepId:   () => 0,
+        setExplicitLock:    () => quote,
+    };
+
+    return {
+        program:        program,
+        stub_rate_data: stub_rate_data,
+        rater:          rater,
+        raters:         raters,
+        logger:         logger,
+        server:         server,
+        dao:            dao,
+        session:        session,
+        request:        request,
+        response:       response,
+        quote:          quote,
+    };
+};