:recycle: a bunch of random changes before we get started

backend/README.md

@@ -14,10 +14,10 @@ You will need...
 ## :package: Installation
 
 1. Install dependencies with `npm install`
-2. Copy the environments sample file from `./server/.env.sample` and rename it to `./server/.env`
-3. Fill out your database connection details in `./server/.env`
-4. A test database container is provided and can be started with `docker-compose --env-file ./backend/server/.env up -d`
-5. Populate some basic tables for your database using `npx knex migrate:latest`
+2. Copy the environments sample file from `./backend/.env.sample` and rename it to `./backend/.env`
+3. Fill out your database connection details in `./backend/.env`
+4. A test database container is provided and can be started with `docker-compose up -d`
+5. Populate some basic tables for your database using `npm run generate && npm run reseed`
 
 ## :package: Migrations
 
@@ -37,9 +37,8 @@ Since we can't unseed the database, it's best to destroy the `dev` database and
 
 1. Stop the database by navigating to the project root directory `cd ../` and running `docker-compose down`
 2. Destroy the database volume `docker volume rm siimee_siimee_db`. BE CAREFUL.
-3. Restart the database while still at the project root with `docker-compose --env-file ./backend/server/.env up -d`
-4. Recreate schemas and tables but navigating to `./backend` and running `npm run migrate`
-5. Reseed the dummy data with `npm run seed`
+3. Restart the database while still at the project root with `docker-compose up -d`
+4. Recreate schemas,tables and dummy data by navigating to `./backend` and running `npm run reseed`
 
 ## :electric_plug: Run
 

backend/db/data-generator/config.json

@@ -1,8 +1,8 @@
 {
     "mockOutputPath": "./db/generated",
     "magic": 10000,
-    "total": 5,
-    "batchSize": 5,
+    "total": 10,
+    "batchSize": 10,
     "percentageOfSeekers": 90,
     "scoreVals": [107, 414, 721, 1028, 1336, 1648, 2056],
     "header": "/**\n* GENERATED MOCK SIIMEE DATA\n*/",

backend/db/data-generator/index.js

@@ -111,7 +111,6 @@ const generateProfiles = jobPosterIds => {
 /**
  * Generate Responses
  */
-const _ZIPCODEKEY = 7
 const generateResponses = profiles => {
     // Generate responses first, before filling in details
     let responses = generate(
@@ -126,18 +125,18 @@ const generateResponses = profiles => {
             resToEdit.response_key_id = k + 1
             resToEdit.profile_id = profile.profile_id
 
-            if(resToEdit.response_key_id < _ZIPCODEKEY) {
+            if(resToEdit.response_key_id < config.zipcodeKey) {
                 resToEdit.val = random.valFrom(Object.values(possibleResponses))
             }
-            else if(resToEdit.response_key_id == _ZIPCODEKEY) {
+            else if(resToEdit.response_key_id == config.zipcodeKey) {
                 resToEdit.val = random.valFrom(config.possibleZipcodes)
             }
             else {
                 switch (resToEdit.response_key_id) {
-                case 8:
+                case config.mediaKey:
                     resToEdit.val = random.media()
                     break
-                case 9:
+                case config.langKey:
                     resToEdit.val = random.language()
                     break
                 case 10:
@@ -146,14 +145,14 @@ const generateResponses = profiles => {
                 case 11:
                     resToEdit.val = random.location()
                     break
-                case 12:
+                case config.blurbKey:
                     resToEdit.val = random.blurb()
                     break
                 }
             }
         }
     })
-    // generatedResponseCount = generatedResponseCount + responses.length
+    generatedResponseCount = generatedResponseCount + responses.length
     console.log('COMPLETED: Generated Responses...')
     return responses
 }

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

@@ -1,131 +1,10 @@
 const Schmervice = require('@hapipal/schmervice')
 const haversine = require('haversine')
-const config = require('../../db/data-generator/config.json')
-
-const _isScorableResponse = res_key_id => {
-    let isScorable = false
-    if(config.resKeys.includes(res_key_id)) {
-        isScorable = true
-    }
-    return isScorable
-}
-
-const scoreResponses = (seeker, potentialMatch, prescoreLookup) => {
-    if (seeker.responses.length != potentialMatch.responses.length)
-        return {
-            error: `complete responses for profile: ${seeker.profile_id} unqeual to profile: ${potentialMatch.profile_id} | ${seeker.responses.length}:${potentialMatch.responses.length}`,
-        }
-
-    const aRes = seeker.responses.filter(
-        res =>  _isScorableResponse(res.response_key_id)
-    )
-    const bRes = potentialMatch.responses.filter(
-        res =>  _isScorableResponse(res.response_key_id)
-    )
-
-    const composite = []
-    while (aRes.length + bRes.length > 0) {
-        const mKey = resList => {
-            let el = resList.shift()
-            let pair = el.val
-            el = resList.shift()
-            return `${pair}:${el.val}`
-        }
-        composite.push(prescoreLookup[mKey(aRes)][mKey(bRes)])
-    }
-    const scoreAvg = composite.reduce((a, b) => a + b) / composite.length
-    return {
-        total: Math.round(scoreAvg),
-        aspects: composite,
-    }
-}
-const filterByDistance = (profileList, max) => {
-    return profileList.filter(profile => {
-        const profileDistance = Math.floor(parseFloat(profile.distance) * 100)
-        const adjustedMaxDistance = Math.floor(parseFloat(max) * 100)
-        return profileDistance <= adjustedMaxDistance
-    })
-}
-const scoreAll = (profileList, userProfile, prescoreLookup) => {
-    return profileList.map(profile => {
-        return {
-            // Uncomment to return the whole profile
-            // ...profile,
-            profile_id: profile.profile_id,
-            score: scoreResponses(userProfile, profile, prescoreLookup),
-            distance: profile.distance,
-        }
-    })
-}
-/**
- * Grab the zip code string
- */
-const getZipCodeFromProfile = profile => {
-    // There should only be one zip code entry per profile
-    let zipRes = profile.responses.find(
-        res => res.response_key_id == 7
-    )
-    return zipRes.val
-}
-
-const makeScoreLookup = (aspects, labels) => {
-    const labelLookup = {}
-    labels.forEach(label => (labelLookup[label.aspect_id] = label))
-
-    const scoreLookup = {}
-    aspects.forEach(aspect => {
-        const key = labelLookup[aspect.aspect_id]
-        scoreLookup[`${key.a}:${key.b}`] = {}
-        Object.keys(aspect).forEach(aspect_id => {
-            if (!labelLookup[aspect_id]) return
-            const comp = labelLookup[aspect_id]
-            const score = aspect[aspect_id]
-            scoreLookup[`${key.a}:${key.b}`][`${comp.a}:${comp.b}`] = score
-        })
-    })
-    return scoreLookup
-}
-
-/**
- * Class to hold our retrieved profile information
- * in a convenient wrapper
- * !: This needs to match the responseSchema in profiles.js
- */
-class CompleteProfile {
-    constructor(profile, type) {
-        this.user_id = profile.user_id // int user_id
-        this.profile_id = profile.profile_id // int profile_id
-        this.user_name = profile.user.user_name // string user_name
-        this.user_email = profile.user.user_email
-        this.responses = []
-        this.user_type = type
-        this.tags = profile.tags.filter(t => t.category != 'reveal')
-        this.reveal = profile.tags.filter(t => t.category == 'reveal')
-
-        // TODO: generalize this for multiple images, and languages
-        this.profile_description = ''
-        this.profile_media = []
-        this.profile_languages = []
-        this.profile_prefs = {}
-
-        // TODO: filter these correctly
-        if (profile?.responses?.length) {
-            // [] of all "profile" responses
-            this.responses = profile.responses
-            // image, language, duration, presence, blurb, urgency, role, pronouns, distance
-            const prefs = ['zipcode', 'duration', 'presence', 'urgency', 'role', 'pronouns', 'distance']
-            const prefsKeys = config.prefKeys
-            prefs.forEach((pref, i) => {
-                this.profile_prefs[pref] = this.responses.filter(
-                    r => r.response_key_id === prefsKeys[i]
-                )[0]
-            })
-            this.profile_description = this.responses.filter(r => r.response_key_id === config.blurbKey).map(r => r.val)[0]
-            this.profile_media = this.responses.filter(r => r.response_key_id === config.mediaKey).map(r => r.val)
-            this.profile_languages = this.responses.filter(r => r.response_key_id === config.langKey).map(r => r.val)
-        }
-    }
-}
+const config = require('../../../db/data-generator/config.json')
+const profiler = require('./profiler')
+const scoring = require('./scorer')
+const zipcoder = require('./zipcoder')
+const tagger = require('./tagger')
 
 module.exports = class ProfileService extends Schmervice.Service {
     constructor(...args) {
@@ -141,7 +20,7 @@ module.exports = class ProfileService extends Schmervice.Service {
             const { Aspect, AspectLabel } = this.server.models()
             const aspects = await Aspect.query()
             const labels = await AspectLabel.query()
-            this.scoreLookup = makeScoreLookup(aspects, labels)
+            this.scoreLookup = scoring.makeScoreLookup(aspects, labels)
         }
     }
     async _setTagLookup() {
@@ -186,13 +65,8 @@ module.exports = class ProfileService extends Schmervice.Service {
             .withGraphFetched('responses')
             .withGraphFetched('user')
 
-        if(matchingProfile?.tags.length){
-            matchingProfile.tags = matchingProfile.tags.map(
-                tag => this.tagLookup[tag.tag_id],
-            )
-        }
-
-        return new CompleteProfile(matchingProfile)
+        tagger.setProfileTags(matchingProfile, matchingProfile, this.tagLookup)
+        return new profiler.CompleteProfile(matchingProfile)
     }
 
     async getCompleteProfilesFor(userId, type) {
@@ -208,15 +82,8 @@ module.exports = class ProfileService extends Schmervice.Service {
             // CHECKTHIS: Added this because we added user.user_name to CompleteProfile
             // so without this, we get undefined user_name
             .withGraphFetched('user')
-
-        profilesEntries.forEach(profile => {
-            profile.tags = profile.tags.map(tag => this.tagLookup[tag.tag_id])
-        })
-
-        //** Get responses asociated with each profile_id */
-        return profilesEntries.map(profile => {
-            return new CompleteProfile(profile, type)
-        })
+        
+        return profiler.makeCompleteProfilesFromProfile(profilesEntries, type, this.tagLookup)
     }
 
     async getProfilesFor(profileIdArray, type, includeResponses = true) {
@@ -234,24 +101,13 @@ module.exports = class ProfileService extends Schmervice.Service {
         // taking the info from profilesEntries
         // to repack into completeProfiles
         // in same order as profileIdArray
-        const completeProfiles = []
-        profileIdArray.forEach(pid => {
-            profilesEntries.forEach(entry => {
-                if (entry.profile_id == pid) {
-                    const complete = new CompleteProfile(entry, type)
-                    if (!includeResponses) {
-                        delete complete['responses']
-                    }
-                    if (entry?.tags?.length) {
-                        complete.tags = entry.tags.map(
-                            tag => this.tagLookup[tag.tag_id],
-                        )
-                    }
-                    completeProfiles.push(complete)
-                }
-            })
-        })
-        return completeProfiles
+        return profiler.makeCompleteProfiles(
+            profileIdArray,
+            profilesEntries,
+            type,
+            includeResponses,
+            this.tagLookup
+        )
     }
 
     /**
@@ -274,7 +130,7 @@ module.exports = class ProfileService extends Schmervice.Service {
              * DUPLICATE:See saveResponseForProfile() line 343
              */ 
             let convertedResponse = responseToSave
-            if(_isScorableResponse(responseToSave.response_key_id)) {
+            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 indexFromInput = parseInt(responseToSave.val) + offset
@@ -352,7 +208,7 @@ module.exports = class ProfileService extends Schmervice.Service {
          * of the generated possible prescore array in config
          */ 
         let convertedResponse = responseToSave
-        if(_isScorableResponse(responseToSave.response_key_id)) {
+        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 indexFromInput = parseInt(responseToSave.val) + offset
@@ -397,7 +253,7 @@ module.exports = class ProfileService extends Schmervice.Service {
             .withGraphFetched('user')
         
         // Move unneeded responses
-        const userZip = getZipCodeFromProfile(userProfile)
+        const userZip = zipcoder.getZipCodeFromProfile(userProfile)
 
         // Find all Profiles that are NOT of our userProfile.type
         // ie. If userProfile.type == seeker, then find: poster
@@ -411,12 +267,12 @@ module.exports = class ProfileService extends Schmervice.Service {
             return profile.user.is_poster == isPosterOpposite
         }).filter(profile => {
             // Only include profiles that included zipcode response
-            return getZipCodeFromProfile(profile) ? true : false
+            return zipcoder.getZipCodeFromProfile(profile) ? true : false
         })
         
         const profilePlusDistance = await Promise.all(
             profileIdsOfOppositeType.map(async profile => {
-                const targetZip = getZipCodeFromProfile(profile)
+                const targetZip = zipcoder.getZipCodeFromProfile(profile)
 
                 if (!userZip || !targetZip)
                     return { ...profile, distance: [9999, distanceUnit] }
@@ -432,11 +288,11 @@ module.exports = class ProfileService extends Schmervice.Service {
                 }
             }),
         )
-        const distanceFilteredProfiles = filterByDistance(
+        const distanceFilteredProfiles = zipcoder.filterByDistance(
             profilePlusDistance,
             maxDistance,
         )
-        const scoredProfilesWithDistance = scoreAll(
+        const scoredProfilesWithDistance = scoring.scoreAll(
             distanceFilteredProfiles,
             userProfile,
             this.scoreLookup,
@@ -455,15 +311,11 @@ module.exports = class ProfileService extends Schmervice.Service {
      */
     async _latLonForZip(zipCode) {
         const { ZipCode } = this.server.models()
-
         const zipInfo = await ZipCode.query().findOne(
             'zip_code_id',
             parseInt(zipCode),
         )
-        if (!zipInfo) {
-            console.error('zip:', zipCode)
-        }
-
+        if (!zipInfo) { console.error('zip:', zipCode) }
         return {
             latitude: parseFloat(zipInfo.latitude),
             longitude: parseFloat(zipInfo.longitude),
@@ -478,10 +330,8 @@ module.exports = class ProfileService extends Schmervice.Service {
      */
     async _compareDistance(start_zip, end_zip, distanceUnit) {
         if (!start_zip || !end_zip || isNaN(start_zip) || isNaN(end_zip)) return
-
         const start = await this._latLonForZip(start_zip)
         const end = await this._latLonForZip(end_zip)
-
         return haversine(start, end, { unit: distanceUnit })
     }
 }

backend/lib/services/profile/profiler.js

@@ -0,0 +1,78 @@
+const config = require('../../../db/data-generator/config.json')
+const tagger = require('./tagger')
+
+/**
+ * Class to hold our retrieved profile information
+ * in a convenient wrapper
+ * !: This needs to match the responseSchema in profiles.js
+ */
+class CompleteProfile {
+    constructor(profile, type, includeResponses = false) {
+        this.user_id = profile.user_id // int user_id
+        this.profile_id = profile.profile_id // int profile_id
+        this.user_name = profile.user.user_name // string user_name
+        this.user_email = profile.user.user_email
+        this.responses = []
+        this.user_type = type
+        this.tags = profile.tags.filter(t => t.category != 'reveal')
+
+        // TODO: generalize this for multiple images, and languages
+        this.profile_description = ''
+        this.profile_media = []
+        this.profile_languages = []
+        this.profile_prefs = {}
+
+        // TODO: Use reveal tags to add or remove information from profile!
+        // TODO: ---
+        // TODO: Use reveal tags to rebuild profile based on group/membership
+        // TODO: and include for certain profiles
+
+        this.reveal = profile.tags.filter(t => t.category == 'reveal')
+        // TODO: filter these correctly
+        if (profile?.responses?.length && includeResponses) {
+            // [] of all "profile" responses
+            this.responses = profile.responses
+            // image, language, duration, presence, blurb, urgency, role, pronouns, distance
+            const prefs = ['zipcode', 'duration', 'presence', 'urgency', 'role', 'pronouns', 'distance']
+            const prefsKeys = config.prefKeys
+            prefs.forEach((pref, i) => {
+                this.profile_prefs[pref] = this.responses.filter(
+                    r => r.response_key_id === prefsKeys[i]
+                )[0]
+            })
+            this.profile_description = this.responses.filter(r => r.response_key_id === config.blurbKey).map(r => r.val)[0]
+            this.profile_media = this.responses.filter(r => r.response_key_id === config.mediaKey).map(r => r.val)
+            this.profile_languages = this.responses.filter(r => r.response_key_id === config.langKey).map(r => r.val)
+        }
+    }
+}
+
+const makeCompleteProfiles = (profileIdArray, profilesEntries, type, includeResponses, tagLookup) => {
+    const completeProfiles = []
+    profileIdArray.forEach(pid => {
+        profilesEntries.forEach(entry => {
+            if (entry.profile_id == pid) {
+                const complete = new CompleteProfile(entry, type, includeResponses)
+                tagger.setProfileTags(entry, complete, tagLookup)
+                completeProfiles.push(complete)
+            }
+        })
+    })
+    return completeProfiles
+}
+const makeCompleteProfilesFromProfile = (profilesEntries, type, tagLookup)=> {
+    profilesEntries.forEach(profile => {
+        tagger.setProfileTags(profile, profile, tagLookup)
+    })
+
+    //** Get responses asociated with each profile_id */
+    return profilesEntries.map(profile => {
+        return new CompleteProfile(profile, type)
+    })
+}
+
+module.exports = {
+    CompleteProfile,
+    makeCompleteProfiles,
+    makeCompleteProfilesFromProfile
+}

backend/lib/services/profile/scorer.js

@@ -0,0 +1,76 @@
+const config = require('../../../db/data-generator/config.json')
+
+const makeScoreLookup = (aspects, labels) => {
+    const labelLookup = {}
+    labels.forEach(label => (labelLookup[label.aspect_id] = label))
+
+    const scoreLookup = {}
+    aspects.forEach(aspect => {
+        const key = labelLookup[aspect.aspect_id]
+        scoreLookup[`${key.a}:${key.b}`] = {}
+        Object.keys(aspect).forEach(aspect_id => {
+            if (!labelLookup[aspect_id]) return
+            const comp = labelLookup[aspect_id]
+            const score = aspect[aspect_id]
+            scoreLookup[`${key.a}:${key.b}`][`${comp.a}:${comp.b}`] = score
+        })
+    })
+    return scoreLookup
+}
+
+const _isScorableResponse = res_key_id => {
+    let isScorable = false
+    if(config.resKeys.includes(res_key_id)) {
+        isScorable = true
+    }
+    return isScorable
+}
+
+const scoreResponses = (seeker, potentialMatch, prescoreLookup) => {
+    if (seeker.responses.length != potentialMatch.responses.length)
+        return {
+            error: `complete responses for profile: ${seeker.profile_id} unqeual to profile: ${potentialMatch.profile_id} | ${seeker.responses.length}:${potentialMatch.responses.length}`,
+        }
+
+    const aRes = seeker.responses.filter(
+        res =>  _isScorableResponse(res.response_key_id)
+    )
+    const bRes = potentialMatch.responses.filter(
+        res =>  _isScorableResponse(res.response_key_id)
+    )
+
+    const composite = []
+    while (aRes.length + bRes.length > 0) {
+        const mKey = resList => {
+            let el = resList.shift()
+            let pair = el.val
+            el = resList.shift()
+            return `${pair}:${el.val}`
+        }
+        composite.push(prescoreLookup[mKey(aRes)][mKey(bRes)])
+    }
+    const scoreAvg = composite.reduce((a, b) => a + b) / composite.length
+    return {
+        total: Math.round(scoreAvg),
+        aspects: composite,
+    }
+}
+
+const scoreAll = (profileList, userProfile, prescoreLookup) => {
+    return profileList.map(profile => {
+        return {
+            // Uncomment to return the whole profile
+            // ...profile,
+            profile_id: profile.profile_id,
+            score: scoreResponses(userProfile, profile, prescoreLookup),
+            distance: profile.distance,
+        }
+    })
+}
+
+module.exports = {
+    _isScorableResponse,
+    scoreResponses,
+    makeScoreLookup,
+    scoreAll
+}

backend/lib/services/profile/tagger.js

@@ -0,0 +1,7 @@
+const setProfileTags = (inProfile, outProfile, tagLookup) => {
+    outProfile.tags = inProfile.tags.map(tag => tagLookup[tag.tag_id])
+}
+
+module.exports = {
+    setProfileTags
+}

backend/lib/services/profile/zipcoder.js

@@ -0,0 +1,25 @@
+const config = require('../../../db/data-generator/config.json')
+
+/**
+ * Grab the zip code string
+ */
+const getZipCodeFromProfile = profile => {
+    // There should only be one zip code entry per profile
+    let zipRes = profile.responses.find(
+        res => res.response_key_id == config.zipcodeKey
+    )
+    return zipRes.val
+}
+
+const filterByDistance = (profileList, max) => {
+    return profileList.filter(profile => {
+        const profileDistance = Math.floor(parseFloat(profile.distance) * 100)
+        const adjustedMaxDistance = Math.floor(parseFloat(max) * 100)
+        return profileDistance <= adjustedMaxDistance
+    })
+}
+
+module.exports = {
+    getZipCodeFromProfile,
+    filterByDistance
+}

frontend/src/entities/profile/profile.schema.js

@@ -28,7 +28,7 @@ const profileSchema = {
         user_id: Joi.number(),
         user_email: Joi.string(),
         profile_id: Joi.number(),
-        profile_description: Joi.string(),
+        profile_description: Joi.string().allow(null, ''),
         profile_media: Joi.array().items(Joi.string()),
         profile_languages: Joi.array().items(Joi.string()),
         profile_prefs: Joi.object(),

frontend/src/views/ProfileView.vue

@@ -5,17 +5,17 @@ main.view--profile.f-col.start.w-full
  
     article(v-if="!loading")
         h3 name: {{ profile.user_name }}
-            span(v-if="profile.profile_prefs.pronouns")  ({{ profile.profile_prefs.pronouns.val }})
+            span(v-if="profile.profile_prefs?.pronouns")  ({{ profile.profile_prefs?.pronouns.val }})
         p(v-if="profile.user_email") {{ profile.user_email }}
         
         p I am looking for a 
-            span {{ profile.profile_prefs.presence.val }} 
-            span {{ profile.profile_prefs.role.val }} 
+            span {{ profile.profile_prefs?.presence?.val }} 
+            span {{ profile.profile_prefs?.role?.val }} 
             span role 
-            span no further than {{ profile.profile_prefs.distance.val }} miles away 
-            span from {{ profile.profile_prefs.zipcode.val }}
+            span no further than {{ profile.profile_prefs?.distance?.val }} miles away 
+            span from {{ profile.profile_prefs?.zipcode?.val }}
 
-        p I am {{ profile.profile_prefs.urgency.val.split("_").join(" ") }}.
+        p I am {{ profile.profile_prefs?.urgency?.val.split("_").join(" ") }}.
         
         img(v-if="profile.reveal.map(t => t.description).includes('image')" :src="profile.profile_media[0]" alt="profile-avatar" style="max-height: 200px; width: auto;")
         h3(v-else) image not revealed

frontend/src/views/SurveyView.vue

@@ -203,7 +203,6 @@ export default {
         async onSave() {
             const [ user, survey] = this._separateUserInfoFromResponses(Object.values(this.responseLikes))
             const maxDistanceRes = survey.find(res => res.response_key_id == maxDistanceKey)
-
             /**
              * Creating a profile only returns the created
              * user id and profile id