siimee/backend/lib/services/profile/index.js

const Schmervice = require('@hapipal/schmervice')
const haversine = require('haversine')
const config = require('../../../db/data-generator/config.json')
const profiler = require('./profiler')
const scoring = require('./scorer')
const zipcoder = require('./zipcoder')
const Filter = require('../filter')
const filter = new Filter()

module.exports = class ProfileService extends Schmervice.Service {
    constructor(...args) {
        super(...args)
        /** Scores available in the db to map against score indices*/
        this.scoreLookup = {}
        /** Tags available in the db to map against tag_associations*/
        this.tagLookup = {}
        // this.responseKeyLookup = ResponseKey.query()
    }
    async _setScoreLookup() {
        if (!Object.keys(this.scoreLookup).length) {
            const { Aspect, AspectLabel } = this.server.models()
            const aspects = await Aspect.query()
            const labels = await AspectLabel.query()
            this.scoreLookup = scoring.makeScoreLookup(aspects, labels)
        }
    }
    async _setTagLookup() {
        /** Grab tag descriptions if they do NOT exist: Needed once per app load */
        if (Object.keys(this.tagLookup).length) return
        const { Tag } = this.server.models()
        const allTagDescriptions = await Tag.query()
        if (allTagDescriptions.length) {
            allTagDescriptions.forEach(desc => {
                if (!desc.is_active) return
                this.tagLookup[desc.tag_id] = desc
            })
            /* EXAMPLE:
             * this.tagLookup : {
             * '1' : {
             * tag_id: 1,
             * tag_category: 'reveal',
             * tag_description: 'verified',
             * is_active: 1
             * }
             * }
             * */
        } else return
    }
    /**
     * Internal method to get list of profile_ids for this user
     * @param {number} userId
     * @returns {Array} List of all profile_ids for user
     */
    async _getProfileIdsForUserId(userId) {
        const { Profile } = this.server.models()
        /** Grab every Profile associated with this id */
        const allProfiles = await Profile.query().where('user_id', userId)
        /** Copy a list of the just the Profiles */
        return typeof allProfiles === 'object' && allProfiles !== null
            ? [...new Set(allProfiles.map(profile => profile.profile_id))]
            : [allProfiles]
    }

    /**
     * Convert indexes to actual score values
     * Using using the input and converting to index
     * of the generated possible prescore array in config
     */
    _convertResponse(responseToSave) {
        if (scoring._isScorableResponse(responseToSave.response_key_id)) {
            // Convert -3 to 0, 0 to 3, 3 to 6
            const offset = (config.scoreVals.length - 1) / 2
            const scoreFromInput = parseInt(responseToSave.val) + offset
            const scoreFromConfig = config.scoreVals.indexOf(scoreFromInput)
            if (scoreFromConfig < 0) {
                console.error('score not found in possible config responses')
            }
            responseToSave.val = scoreFromConfig.toString()
        }
        return responseToSave
    }

    async getProfile(profileId) {
        const { Profile } = this.server.models()
        await this._setTagLookup()
        const matchingProfile = await Profile.query()
            .where('profile_id', profileId)
            .first()
            .withGraphFetched('tags')
            .withGraphFetched('responses')
            .withGraphFetched('user')
        matchingProfile.tags = matchingProfile.tags.map(
            tag => this.tagLookup[tag.tag_id],
        )
        return new profiler.CompleteProfile(matchingProfile)
    }

    async getCompleteProfilesFor(userId, type) {
        const { Profile } = this.server.models()
        await this._setTagLookup()

        const dedupedProfileIds = await this._getProfileIdsForUserId(userId)

        const profilesEntries = await Profile.query()
            .whereIn('profile_id', dedupedProfileIds)
            .withGraphFetched('tags')
            .withGraphFetched('responses')
            .withGraphFetched('user')

        return profiler.makeCompleteFromProfileEntries(
            profilesEntries,
            type,
            this.tagLookup,
        )
    }

    async getProfilesFor(profileIdArray, type) {
        const { Profile } = this.server.models()
        await this._setScoreLookup()
        await this._setTagLookup()

        // profilesEntries is profiles in database row order
        const profilesEntries = await Profile.query()
            .whereIn('profile_id', profileIdArray)
            .withGraphFetched('tags')
            .withGraphFetched('responses')
            .withGraphFetched('user')

        // taking the info from profilesEntries
        // to repack into completeProfiles
        // in same order as profileIdArray
        return profiler.makeOrderedCompleteProfiles(
            profileIdArray,
            profilesEntries,
            type,
            this.tagLookup,
        )
    }

    /**
     * Save responses in a profile
     * @param {number} userId
     * @param {Array} responses
     * @returns {object}
     */
    async saveResponsesCreateProfileFor(userId, responses, txn) {
        const { Profile, Response } = this.server.models()
        try {
            const profile = await Profile.query(txn).insert({
                user_id: userId,
            })
            for (const responseToSave of responses) {
                const convertedResponse = this._convertResponse(responseToSave)
                const responseInfo = {
                    profile_id: profile.id,
                    response_key_id: convertedResponse.response_key_id,
                    val: convertedResponse.val,
                }
                await Response.query(txn).insert(responseInfo)
            }
            //** Work around for HAPI returning profile_id as id */
            return { user_id: profile.user_id, profile_id: profile.id }
        } catch (err) {
            throw new Error(err)
        }
    }

    /** Update responses in place
     * @param {number} profileId
     * @param {Array} responses
     * @returns {Array} updated responses
     */
    async updateResponsesInProfile(profileId, responses, txn) {
        const { Response } = this.server.models()
        for (const responseToSave of responses) {
            await Response.query(txn)
                .update({
                    response_id: responseToSave.response_id,
                    profile_id: responseToSave.profile_id,
                    response_key_id: responseToSave.response_key_id,
                    val: responseToSave.val,
                })
                .where({
                    profile_id: profileId,
                })
                .where({
                    response_id: responseToSave.response_id,
                })
        }
        return await Response.query(txn).where({
            profile_id: profileId,
        })
    }

    async insertSingleResponseForProfile(responseToSave) {
        const { Response } = this.server.models()
        const convertedResponse = this._convertResponse(responseToSave)
        const savedResponse = await Response.query().insert(convertedResponse)
        delete savedResponse.id
        return savedResponse
    }

    /** Add response
     * @param {Object} response to save
     * @returns {null} updated responses
     * @returns {Array} updated responses
     */
    async saveResponseForProfile(profileId, responseToSave) {
        const { Response } = this.server.models()
        let allResponses = await Response.query().where({
            profile_id: profileId,
        })

        // Delete matches
        // ?:Maybe bad idea
        const matchingResponses = allResponses.filter(
            response =>
                response.response_key_id == responseToSave.response_key_id,
        )
        if (matchingResponses.length > 0) {
            const alreadyAnswered = matchingResponses.map(
                matchingRes => matchingRes.response_key_id,
            )
            await Response.query()
                .where({ profile_id: profileId })
                .delete()
                .whereIn('response_key_id', alreadyAnswered)
        }
        const convertedResponse = this._convertResponse(responseToSave)
        await Response.query().insert(convertedResponse)
        return allResponses
    }

    /**
     * Delete a profile
     * @param {number} userId
     * @param {number} profileId
     * @returns
     */
    async deleteProfile(userId, profileId) {
        const { Profile } = this.server.models()

        const dedupedGroupings = await this._getProfileIdsForUserId(userId)

        /** Do NOTHING if NOT in Grouping */
        if (!dedupedGroupings.includes(profileId)) return

        return await Profile.query().delete().where('profile_id', profileId)
    }

    /**
     * Score a profile
     * @param {number} profileId
     * @returns {Array} Ordered and scored Profiles
     */
    async scoreProfilesFor(
        profileId,
        maxDistance,
        distanceUnit,
        duration,
        presence,
        certifications,
    ) {
        const { Profile } = this.server.models()
        await this._setScoreLookup()

        // Our User Profile to score for
        const userProfile = await Profile.query()
            .findOne('profile_id', profileId)
            .withGraphFetched('responses')
            .withGraphFetched('user')

        const userZip = zipcoder.getZipCodeFromProfile(userProfile)

        // preprocess potential match pool with filter service methods
        let matchPool = await Profile.query()
            .withGraphFetched('responses')
            .withGraphFetched('user')

        matchPool = filter.byProfileType(matchPool, userProfile.user)
        matchPool = filter.byNullZip(matchPool)
        // attach distance to pool profiles for max distance filter
        matchPool = await this.calcProfileDistances(
            matchPool,
            distanceUnit,
            userZip,
        )

        matchPool = filter.byDistance(matchPool, maxDistance)
        matchPool = filter.byDuration(matchPool, duration)
        matchPool = filter.byPresence(matchPool, presence)
        // TODO: Incorporate filtering by certifications (see filter.js)
        // matchPool = filter.byCertifications(matchPool, certifications)

        const scoredProfilesWithDistance = scoring.scoreAll(
            matchPool,
            userProfile,
            this.scoreLookup,
        )
        // Order by score
        return scoredProfilesWithDistance.sort(
            (a, b) => b.score.total - a.score.total,
        )
    }

    async calcProfileDistances(matchPool, distanceUnit, userZip) {
        const returnVal = await Promise.all(
            matchPool.map(async profile => {
                const targetZip = zipcoder.getZipCodeFromProfile(profile)
                if (!userZip || !targetZip)
                    return { ...profile, distance: [9999, distanceUnit] }
                const distance = await this._compareDistance(
                    userZip,
                    targetZip,
                    distanceUnit,
                )
                return {
                    ...profile,
                    distance: [distance.toFixed(2), distanceUnit],
                }
            }),
        )
        return returnVal
    }

    /**
     * Use the db for zipcode info
     * @param {string} zipCode
     * @param {object}
     */
    async _latLonForZip(zipCode) {
        const { ZipCode } = this.server.models()
        const zipInfo = await ZipCode.query().findOne(
            'zip_code_id',
            parseInt(zipCode),
        )
        if (!zipInfo) {
            throw new Error(
                `ERROR :=> no zipInfo found for zipCode: ${zipCode}`,
            )
        } else {
            return {
                latitude: parseFloat(zipInfo.latitude),
                longitude: parseFloat(zipInfo.longitude),
            }
        }
    }
    /**
     * Get the distance between two zipcodes
     * using the haversine formula
     * @param {string} start_zip
     * @param {string} end_zip
     * @param {number} distance in miles
     */
    async _compareDistance(start_zip, end_zip, distanceUnit) {
        if (
            !start_zip ||
            !end_zip ||
            Number.isNaN(start_zip) ||
            Number.isNaN(end_zip)
        )
            return
        const start = await this._latLonForZip(start_zip)
        const end = await this._latLonForZip(end_zip)
        return haversine(start, end, { unit: distanceUnit })
    }

    /**
     * Use the db to grab tag associations
     * by profile and match them to tag types
     * @param {number} profileId
     * @param {object}
     */
    async getTagsFor(profileId, groupingId, category) {
        const { TagAssociation } = this.server.models()
        await this._setTagLookup()
        let associations = []
        if (!profileId.length || !groupingId.length) {
            return associations
        } else {
            // NOTE: all queries do not fire in Swagger API (whereIn clauses??)
            associations = groupingId
                ? await TagAssociation.query()
                      .where('grouping_id', groupingId)
                      .andWhere('profile_id', profileId)
                : await TagAssociation.query().andWhere('profile_id', profileId)
            return associations
                .map(assoc => ({
                    ...assoc,
                    tag: !this.tagLookup[assoc.tag_id]
                        ? {}
                        : this.tagLookup[assoc.tag_id],
                }))
                .filter(tagWithAssoc => {
                    return category
                        ? tagWithAssoc.tag.tag_category == category
                        : true
                })
        }
    }

    /**
     * Use the db to grab tag associations
     * by profile, grouping, tag, and insert
     * it if it already exists
     * @param {object} association
     */
    async revealProfileInfo(association) {
        const { TagAssociation } = this.server.models()

        const existingAssociations = await TagAssociation.query()
            .where('profile_id', `${association.profile_id}`)
            .where('grouping_id', `${association.grouping_id}`)
            .where('tag_id', `${association.tag_id}`)
            .where('is_deleted', 0)
        if (!existingAssociations.length) {
            await TagAssociation.query().insert(association)
            return await this.getTagsFor(association.profile_id)
        } else {
            return console.error('ERROR =>: tag association already exists')
        }
    }
}