index.js

/* eslint-disable no-use-before-define */
/* eslint-disable no-await-in-loop */
/* eslint-disable guard-for-in */
/* eslint-disable no-restricted-syntax */

let v4;
try {
    // eslint-disable-next-line global-require
    const crypto = require('crypto');
    v4 = crypto.randomUUID;
    if (!v4) {
        // node v12 doesnt have randomUUID
        throw new Error();
    }
} catch (err) {
    console.log('Node lacks crypto support!');
    // eslint-disable-next-line global-require
    ({ v4 } = require('uuid'));
}

const moment = require('moment');
const knex = require('./connection');
const { TABLES } = require('./constants');
const emailConstants = require('../lib/email/constants');
const { fundingActivityCategoriesByCode } = require('../lib/fieldConfigs/fundingActivityCategories');
const helpers = require('./helpers');

async function getUsers(tenantId) {
    const users = await knex('users')
        .select(
            'users.*',
            'roles.name as role_name',
            'roles.rules as role_rules',
            'agencies.name as agency_name',
            'agencies.abbreviation as agency_abbreviation',
            'agencies.parent as agency_parent_id_id',
        )
        .leftJoin('roles', 'roles.id', 'users.role_id')
        .leftJoin('agencies', 'agencies.id', 'users.agency_id')
        .where('users.tenant_id', tenantId);

    return users.map((user) => {
        const u = { ...user };
        if (user.role_id) {
            u.role = {
                id: user.role_id,
                name: user.role_name,
                rules: user.role_rules,
            };
        }
        if (user.agency_id !== null) {
            u.agency = {
                id: user.agency_id,
                name: user.agency_name,
                abbreviation: user.agency_abbreviation,
                agency_parent_id: user.agency_parent_id,
            };
        }
        return u;
    });
}

async function deleteUser(id) {
    await knex('email_subscriptions').where('user_id', id).del();
    return knex('users')
        .where('id', id)
        .del();
}

async function createUser(user) {
    const response = await knex
        .insert(user)
        .into('users')
        .returning(['id', 'created_at']);

    const emailUnsubscribePreference = Object.assign(
        ...Object.values(emailConstants.notificationType).map(
            (k) => ({ [k]: emailConstants.emailSubscriptionStatus.subscribed }),
        ),
    );
    module.exports.setUserEmailSubscriptionPreference(response[0].id, user.agency_id, emailUnsubscribePreference);

    return {
        ...user,
        id: response[0].id,
        created_at: response[0].created_at,
    };
}

async function updateUser(user) {
    const { id, name, avatar_color } = user;

    await knex('users')
        .where('id', id)
        .update({ name, avatar_color });

    return getUser(id);
}

async function getUsersByAgency(agencyId) {
    const users = await knex('users').where('users.agency_id', agencyId);

    return users;
}

async function getSubscribersForNotification(agencyId, notificationType) {
    const subscribers = await knex('users')
        .select(
            'users.id',
            'users.email',
            'email_subscriptions.status',
        )
        .leftJoin('email_subscriptions', function () {
            this
                .on('users.id', '=', 'email_subscriptions.user_id')
                .andOn('users.agency_id', '=', 'email_subscriptions.agency_id')
                .andOn('email_subscriptions.notification_type', '=', knex.raw('?', [notificationType]));
        })
        .where('users.agency_id', agencyId);

    return subscribers.filter((s) => s.status !== emailConstants.emailSubscriptionStatus.unsubscribed);
}

async function getUsersEmailAndName(ids) {
    return knex.select('id', 'name', 'email').from('users').whereIn('id', ids);
}

async function getUser(id) {
    const [user] = await knex('users')
        .select(
            'users.id',
            'users.email',
            'users.name',
            'users.role_id',
            'users.avatar_color',
            'roles.name as role_name',
            'roles.rules as role_rules',
            'users.agency_id',
            'agencies.name as agency_name',
            'agencies.abbreviation as agency_abbreviation',
            'agencies.parent as agency_parent_id_id',
            'agencies.warning_threshold as agency_warning_threshold',
            'agencies.danger_threshold as agency_danger_threshold',
            'tenants.id as tenant_id',
            'tenants.display_name as tenant_display_name',
            'tenants.main_agency_id as tenant_main_agency_id',
            'users.tags',
            'users.tenant_id',
        )
        .leftJoin('roles', 'roles.id', 'users.role_id')
        .leftJoin('agencies', 'agencies.id', 'users.agency_id')
        .leftJoin('tenants', 'tenants.id', 'users.tenant_id')
        .where('users.id', id);

    if (!user) return null;

    if (user.role_id != null) {
        user.role = {
            id: user.role_id,
            name: user.role_name,
            rules: user.role_rules,
        };
    }
    if (user.agency_id != null) {
        user.agency = {
            id: user.agency_id,
            name: user.agency_name,
            abbreviation: user.agency_abbreviation,
            agency_parent_id: user.agency_parent_id,
            warning_threshold: user.agency_warning_threshold,
            danger_threshold: user.agency_danger_threshold,
            main_agency_id: user.agency_main_agency_id,
        };
        user.tenant = {
            id: user.tenant_id,
            display_name: user.tenant_display_name,
            main_agency_id: user.tenant_main_agency_id,
        };
        let subagencies = [];
        if (user.role.name === 'admin') {
            subagencies = await getAgencyTree(user.agency_id);
        } else {
            subagencies.push({ ...user.agency });
        }
        user.agency.subagencies = subagencies;
    }
    user.emailPreferences = await getUserEmailSubscriptionPreference(user.id, user.agency_id);
    return user;
}

async function getUserIdForEmail(email) {
    const [user] = await knex('users')
        .select('users.id')
        .where('email', email);
    return user ? user.id : null;
}

async function getAgencyCriteriaForAgency(agencyId) {
    const eligibilityCodes = await getAgencyEligibilityCodes(agencyId);
    const enabledECodes = eligibilityCodes.filter((e) => e.enabled);
    const keywords = await getAgencyKeywords(agencyId);

    return {
        eligibilityCodes: enabledECodes.map((c) => c.code),
        includeKeywords: keywords.reduce((filtered, c) => {
            if (!c.type || c.type === 'include') {
                filtered.push(c.search_term);
            }
            return filtered;
        }, []),
        excludeKeywords: keywords.reduce((filtered, c) => {
            if (c.type === 'exclude') {
                filtered.push(c.search_term);
            }
            return filtered;
        }, []),
    };
}

/*  isSubOrganization(parent, candidateChild) returns true if
    candidateChild is a child of parent.
    Normally parent will be the agency_id of the logged in user, and
    candidateChild will be the agency_id in the request header.
*/
async function isSubOrganization(parent, candidateChild) {
    const query = `
    with recursive hierarchy as (
      select id, parent from agencies
      where id = ?
      union all
      select agencies.id, agencies.parent from agencies
      inner join hierarchy
      on agencies.id = hierarchy.parent
    )
    select id from hierarchy;
    `;

    const result = await knex.raw(query, candidateChild);
    // console.dir(result.rows.map((rec) => rec.id));
    return result.rows.map((rec) => rec.id).indexOf(parent) !== -1;
}

function getRoles() {
    return knex('roles')
        .select('*')
        .orderBy('name');
}

async function getAccessToken(passcode) {
    const result = await knex('access_tokens')
        .select('*')
        .where('passcode', passcode);
    return result[0];
}

async function incrementAccessTokenUses(passcode) {
    const result = await knex('access_tokens')
        .update({ uses: knex.raw('uses + 1') })
        .where('passcode', passcode)
        .then(() => knex('access_tokens')
            .select('uses')
            .where('passcode', passcode));
    return result[0].uses;
}

function markAccessTokenUsed(passcode) {
    return knex('access_tokens')
        .where('passcode', passcode)
        .update({ used: true });
}

async function generatePasscode(email) {
    console.log('generatePasscode for :', email);
    const users = await knex('users')
        .select('*')
        .where('email', email);
    if (users.length === 0) {
        throw new Error(`User '${email}' not found`);
    }
    const passcode = v4();
    const used = false;
    const expiryMinutes = 30;
    const expires = new Date();
    expires.setMinutes(expires.getMinutes() + expiryMinutes);
    await knex('access_tokens').insert({
        user_id: users[0].id,
        passcode,
        expires,
        used,
    });
    return passcode;
}

function createAccessToken(email) {
    return generatePasscode(email);
}

function getEligibilityCodes() {
    return knex(TABLES.eligibility_codes)
        .select('*');
}

function setAgencyEligibilityCodeEnabled(code, agencyId, enabled) {
    return knex(TABLES.agency_eligibility_codes)
        .insert({
            agency_id: agencyId,
            code,
            enabled,
            updated_at: new Date(),
        })
        .onConflict(['agency_id', 'code'])
        .merge();
}

async function getKeyword(keywordId) {
    const response = await knex(TABLES.keywords)
        .select('*')
        .where('id', keywordId);
    return response[0];
}

function getKeywords() {
    return knex(TABLES.keywords)
        .select('*');
}

async function createKeyword(keyword) {
    const response = await knex
        .insert(keyword)
        .into(TABLES.keywords)
        .returning(['id', 'created_at']);
    return {
        ...keyword,
        id: response[0].id,
        created_at: response[0].created_at,
    };
}

function deleteKeyword(id) {
    return knex(TABLES.keywords)
        .where('id', id)
        .del();
}

async function getNewGrantsForAgency(agency) {
    const agencyCriteria = await getAgencyCriteriaForAgency(agency.id);

    const rows = await knex(TABLES.grants)
        .select(knex.raw(`${TABLES.grants}.*, count(*) OVER() AS total_grants`))
        .modify(helpers.whereAgencyCriteriaMatch, agencyCriteria)
        .modify((qb) => {
            qb.where({ open_date: moment().subtract(1, 'day').format('YYYY-MM-DD') });
        })
        .limit(3);

    return rows;
}
async function buildOrderingParams(args) {
    // default order by the most recently opened grant
    const orderingParams = { orderBy: 'open_date', orderDesc: 'true' };

    if (args) {
        if (args.orderBy) {
            const orderArgs = args.orderBy.split('|');
            if (orderArgs.length !== 1) {
                throw new Error('The number of orderBy arguments must be 1');
            } else if (!/^(rank|award_ceiling|open_date|close_date)$/.test(orderArgs[0])) {
                console.error('Wat', orderArgs[0]);
                throw new Error('orderBy must be one of rank|award_ceiling|open_date|close_date');
            }
        }
        // we treat undefined order direction as descending === true
        const orderDesc = args.orderDesc || 'true';
        if (!/^(true|false)$/.test(orderDesc)) {
            throw new Error('orderDesc must be true or false');
        }
        orderingParams.orderBy = args.orderBy;
        orderingParams.orderDesc = args.orderDesc;
    }

    return orderingParams;
}
async function buildPaginationParams(args) {
    const { currentPage, perPage } = args;
    let { isLengthAware } = args;

    if (!currentPage || currentPage < 1) {
        throw Error('Invalid page');
    }

    if (!perPage || perPage < 1) {
        throw Error('Invalid per page');
    }

    if (isLengthAware === undefined || isLengthAware === null) {
        isLengthAware = true;
    }

    return { currentPage, perPage, isLengthAware };
}

function isValidArray(value) {
    return Array.isArray(value) && value.length > 0;
}

function buildTsqExpression(includeKeywords, excludeKeywords) {
    if (!isValidArray(includeKeywords) && !isValidArray(excludeKeywords)) {
        return null;
    }

    const signedKeywords = { include: [], exclude: [] };

    // wrap phrases in double quotes and ensure keywords have the correct operator
    if (isValidArray(includeKeywords)) {
        includeKeywords.forEach((ik) => { if (ik.indexOf(' ') > 0) { signedKeywords.include.push(`"${ik}"`); } else { signedKeywords.include.push(ik); } });
    }
    if (isValidArray(excludeKeywords)) {
        excludeKeywords.forEach((ek) => { if (ek.indexOf(' ') > 0) { signedKeywords.exclude.push(`-"${ek}"`); } else { signedKeywords.exclude.push(`-${ek}`); } });
    }

    const includeExpression = signedKeywords.include.join(' or ');
    const excludeExpression = signedKeywords.exclude.join(' ');

    return { includeExpression, excludeExpression };
}

function buildKeywordQuery(queryBuilder, includeKeywords, excludeKeywords, orderingParams) {
    const expression = buildTsqExpression(includeKeywords, excludeKeywords);
    const includeExpression = expression?.includeExpression;
    const excludeExpression = expression?.excludeExpression;
    if (!includeExpression && !excludeExpression) {
        return false;
    }
    if (includeExpression) {
        queryBuilder.joinRaw(`cross join websearch_to_tsquery('english', ?) as tsqp`, includeExpression);
    }
    if (excludeExpression) {
        queryBuilder.joinRaw(`cross join websearch_to_tsquery('english', ?) as ntsqp`, excludeExpression);
    }
    if (includeExpression) {
        queryBuilder.andWhere((q) => {
            q.where('tsqp', '@@', knex.raw('title_ts'))
                .orWhere('tsqp', '@@', knex.raw('description_ts'));
            return q;
        });
    }
    if (excludeExpression) {
        queryBuilder.andWhere((q) => {
            q.where('ntsqp', '@@', knex.raw('title_ts'))
                .andWhere('ntsqp', '@@', knex.raw('description_ts'));
        });
    }
    if (includeExpression && orderingParams.orderBy !== undefined) {
        queryBuilder.select(
            knex.raw(`ts_rank(title_ts, tsqp) as rank_title`),
            knex.raw(`ts_rank(grants.description_ts, tsqp) as rank_description`),
        );
        queryBuilder.groupBy('rank_title', 'rank_description');
    }
    return Boolean(includeExpression);
}

function matchAsWordRegex(word) {
    return `\\m${word}\\M`;
}

function buildFiltersQuery(queryBuilder, filters, agencyId) {
    const statusMap = {
        Applied: 'Result',
        'Not Applying': 'Rejected',
        Interested: 'Interested',
    };
    queryBuilder.andWhere(
        (qb) => {
            if (filters.eligibilityCodes?.length) {
                qb.where('eligibility_codes', '~', filters.eligibilityCodes.join('|'));
            }
            if (filters.opportunityNumber) {
                qb.where(`${TABLES.grants}.grant_number`, '=', filters.opportunityNumber);
            }
            if (filters.fundingTypes?.length) {
                qb.where('funding_instrument_codes', '~', filters.fundingTypes.join('|'));
            }
            if (filters.reviewStatuses?.length) {
                const statuses = filters.reviewStatuses.map((status) => statusMap[status]);
                qb.whereIn(`${TABLES.interested_codes}.status_code`, statuses);
                qb.where(`${TABLES.grants_interested}.agency_id`, '=', agencyId);
            }
            if (parseInt(filters.assignedToAgencyId, 10) >= 0) {
                qb.where(`${TABLES.assigned_grants_agency}.agency_id`, '=', filters.assignedToAgencyId);
            }
            if (filters.opportunityCategories?.length) {
                qb.whereIn(`${TABLES.grants}.opportunity_category`, filters.opportunityCategories);
            }
            if (filters.costSharing) {
                qb.where(`${TABLES.grants}.cost_sharing`, '=', filters.costSharing);
            }
            if (filters.agencyCode) {
                qb.where(`${TABLES.grants}.agency_code`, '~*', filters.agencyCode);
            }
            if (filters.bill) {
                qb.where(`${TABLES.grants}.bill`, '~*', filters.bill);
            }
            if (filters.openDate) {
                qb.where(`${TABLES.grants}.open_date`, '=', filters.openDate);
            } else if (filters.postedWithinDays > 0) {
                const date = moment().subtract(filters.postedWithinDays, 'days').startOf('day').format('YYYY-MM-DD');
                qb.where(`${TABLES.grants}.open_date`, '>=', date);
            }
            if (filters.fundingActivityCategories?.length) {
                qb.where('funding_activity_category_codes', '~*',
                    filters.fundingActivityCategories.map(matchAsWordRegex).join('|'));
            }
        },
    );
}

function grantsQuery(queryBuilder, filters, agencyId, orderingParams, paginationParams) {
    let hasRankColumns = false;
    if (filters) {
        if (filters.reviewStatuses?.length) {
            queryBuilder.join(TABLES.grants_interested, `${TABLES.grants}.grant_id`, `${TABLES.grants_interested}.grant_id`)
                .join(TABLES.interested_codes, `${TABLES.interested_codes}.id`, `${TABLES.grants_interested}.interested_code_id`);
        }
        if (parseInt(filters.assignedToAgencyId, 10) >= 0) {
            queryBuilder.join(TABLES.assigned_grants_agency, `${TABLES.grants}.grant_id`, `${TABLES.assigned_grants_agency}.grant_id`);
        }
        hasRankColumns = buildKeywordQuery(queryBuilder, filters.includeKeywords, filters.excludeKeywords, orderingParams);
        buildFiltersQuery(queryBuilder, filters, agencyId);
    }
    if (orderingParams.orderBy && orderingParams.orderBy !== 'undefined') {
        // we assume orderingParams is a valid construction of buildOrderingParams
        if (orderingParams.orderBy.includes('rank')) {
            if (hasRankColumns) {
                queryBuilder.orderBy([
                    { column: 'rank_title', order: 'desc' },
                    { column: 'rank_description', order: 'desc' },
                ]);
            }
        } else {
            const orderDirection = ((orderingParams.orderDesc === 'true') ? 'desc' : 'asc');
            queryBuilder.orderBy(orderingParams.orderBy, knex.raw(`${orderDirection} NULLS LAST`));
        }
    }

    if (filters.opportunityStatuses?.length) {
        queryBuilder.havingRaw(`
            CASE
            WHEN grants.archive_date <= now() THEN 'archived'
            WHEN grants.close_date <= now() THEN 'closed'
            ELSE 'posted'
            END IN (${Array(filters.opportunityStatuses.length).fill('?').join(',')})`, filters.opportunityStatuses);
    }
    if (paginationParams) {
        queryBuilder.limit(paginationParams.perPage);
        queryBuilder.offset((paginationParams.currentPage - 1) * paginationParams.perPage);
    }
}

// Convert saved search criteria to db query filters
function formatSearchCriteriaToQueryFilters(criteria) {
    const parsedCriteria = JSON.parse(criteria);
    const postedWithinOptions = {
        'All Time': 0, 'One Week': 7, '30 Days': 30, '60 Days': 60,
    };
    let filters = {};
    if (parsedCriteria.includeKeywords) {
        filters.includeKeywords = parsedCriteria.includeKeywords.split(',').map((s) => s.trim());
        delete parsedCriteria.includeKeywords;
    }
    if (parsedCriteria.excludeKeywords) {
        filters.excludeKeywords = parsedCriteria.excludeKeywords.split(',').map((s) => s.trim());
        delete parsedCriteria.excludeKeywords;
    }
    if (parsedCriteria.fundingTypes) {
        filters.fundingTypes = parsedCriteria.fundingTypes.map((ft) => ft.code);
        delete parsedCriteria.fundingTypes;
    }
    if (parsedCriteria.agency) {
        filters.agencyCode = filters.agency;
        delete parsedCriteria.agency;
    }
    if (parsedCriteria.postedWithin) {
        filters.postedWithinDays = postedWithinOptions[parsedCriteria.postedWithin] || 0;
        delete parsedCriteria.postedWithin;
    }
    if (parsedCriteria.eligibility) {
        filters.eligibilityCodes = parsedCriteria.eligibility.map((e) => e.code);
        delete parsedCriteria.eligibility;
    }
    if (parsedCriteria.fundingActivityCategories) {
        filters.fundingActivityCategories = parsedCriteria.fundingActivityCategories.map((c) => c.code);
        delete parsedCriteria.fundingActivityCategories;
    }
    filters = { ...filters, ...parsedCriteria };

    return filters;
}

function validateSearchFilters(filters) {
    const filterOptionsByType = {
        reviewStatuses: { type: 'List', valueType: 'Enum', values: ['Applied', 'Not Applying', 'Interested'] },
        eligibilityCodes: { type: 'List', valueType: 'String' },
        fundingActivityCategories: { type: 'List', valueType: 'String' },
        includeKeywords: { type: 'List', valueType: 'String' },
        excludeKeywords: { type: 'List', valueType: 'String' },
        opportunityNumber: { type: 'String', valueType: 'Any' },
        fundingTypes: { type: 'List', valueType: 'Enum', values: ['CA', 'G', 'PC', 'O'] },
        opportunityStatuses: { type: 'List', valueType: 'Enum', values: ['posted', 'forecasted', 'closed', 'archived'] },
        opportunityCategories: { type: 'List', valueType: 'Enum', values: ['Other', 'Discretionary', 'Mandatory', 'Continuation', 'Earmark'] },
        costSharing: { type: 'String', valueType: 'Enum', values: ['Yes', 'No'] },
        agencyCode: { type: 'String', valueType: 'Any' },
        postedWithinDays: { type: 'number', valueType: 'Any' },
        assignedToAgencyId: { type: 'number', valueType: 'Any' },
        bill: { type: 'String', valueType: 'Any' },
        openDate: { type: 'Date', valueType: 'YYYY-MM-DD' },
    };

    const errors = [];
    for (const [option, value] of Object.entries(filters)) {
        if (!value || value.length === 0) {
            // eslint-disable-next-line no-continue
            continue;
        }

        if (!filterOptionsByType[option]) {
            errors.push(`Received invalid filter ${option}, does not exist`);
        } else if (filterOptionsByType[option].type === 'List') {
            if (!Array.isArray(value)) {
                errors.push(`Received invalid filter ${option}, expected List`);
            } else if (filterOptionsByType[option].valueType && value.length > 0) {
                if (filterOptionsByType[option].valueType === 'Enum') {
                    for (const v of value) {
                        if (!filterOptionsByType[option].values.includes(v)) {
                            errors.push(`Received invalid filter ${option}, expected List of Enum, found value ${v} that is not in ${filterOptionsByType[option].values}`);
                        }
                    }
                } else if (filterOptionsByType[option].valueType === 'String') {
                    for (const v of value) {
                        if (typeof v !== 'string') {
                            errors.push(`Received invalid filter ${option}, expected List of String`);
                        }
                    }
                }
            }
        } else if (filterOptionsByType[option].type === 'String') {
            if (filterOptionsByType[option].valueType === 'Enum') {
                if (!filterOptionsByType[option].values.includes(value)) {
                    errors.push(`Received invalid filter ${option}, expected Enum, found value ${value} that is not in ${filterOptionsByType[option].values}`);
                }
            } else if (filterOptionsByType[option].valueType === 'Any') {
                if (typeof value !== 'string') {
                    errors.push(`Received invalid filter ${option}, expected String, received ${value}`);
                }
            }
        } else if (filterOptionsByType[option].type === 'number') {
            if (filterOptionsByType[option].valueType === 'Any') {
                if (typeof value !== 'number') {
                    errors.push(`Received invalid filter ${option}, expected number, received ${value}`);
                }
            } else {
                errors.push(`Numbers with specific value types is not implemented`);
            }
        } else if (filterOptionsByType[option].type === 'Date') {
            if (filterOptionsByType[option].valueType === 'YYYY-MM-DD') {
                if (!moment(value, 'YYYY-MM-DD', true).isValid()) {
                    errors.push(`Received invalid filter ${option}, expected YYYY-MM-DD, received ${value}`);
                }
            } else {
                errors.push(`Dates without specific value-types/date-format is not implemented`);
            }
        }
    }

    return errors;
}

function addCsvData(qb) {
    qb
        .select(knex.raw(`
            CASE
            WHEN grants.funding_instrument_codes = 'G' THEN 'Grant'
            WHEN grants.funding_instrument_codes = 'CA' THEN 'Cooperative Agreement'
            WHEN grants.funding_instrument_codes = 'PC' THEN 'Procurement Contract'
            ELSE 'Other'
            END as funding_type
        `))
        .select(knex.raw(`array_to_string(array_agg(${TABLES.eligibility_codes}.label), '|') AS eligibility`))
        .leftJoin(
            `${TABLES.eligibility_codes}`,
            `${TABLES.eligibility_codes}.code`, '=', knex.raw(`ANY(string_to_array(${TABLES.grants}.eligibility_codes, ' '))`),
        );
}

/*
   filters: {
        reviewStatuses: List[Enum['Applied', 'Not Applying', 'Interested']],
        eligibilityCodes: List[String],
        includeKeywords: List[String],
        excludeKeywords: List[String],
        opportunityNumber: String,
        fundingTypes: List[Enum['CA, 'G', 'PC' ,'O']]
        opportunityStatuses: List[Enum['posted', 'forecasted', 'closed']],
        opportunityCategories: List[Enum['Other', 'Discretionary', 'Mandatory', 'Continuation']],
        costSharing: Enum['Yes', 'No'],
        agencyCode: String,
        postedWithinDays: number,
        assignedToAgencyId: Optional[number],
        bill: String,
    },
    paginationParams: { currentPage: number, perPage: number, isLengthAware: boolean },
    orderingParams: { orderBy: List[string], orderDesc: boolean},
    tenantId: number
    agencyId: number
*/
async function getGrantsNew(filters, paginationParams, orderingParams, tenantId, agencyId, toCsv) {
    const errors = validateSearchFilters(filters);
    if (errors.length > 0) {
        throw new Error(`Invalid filters: ${errors.join(', ')}`);
    }

    const query = knex(TABLES.grants)
        .select([
            'grants.grant_id',
            'grants.grant_number',
            'grants.title',
            'grants.status',
            'grants.agency_code',
            'grants.cost_sharing',
            'grants.cfda_list',
            'grants.open_date',
            'grants.close_date',
            'grants.archive_date',
            'grants.reviewer_name',
            'grants.opportunity_category',
            'grants.search_terms',
            'grants.notes',
            'grants.created_at',
            'grants.updated_at',
            'grants.description',
            'grants.eligibility_codes',
            'grants.award_floor',
            'grants.revision_id',
            'grants.title_ts',
            'grants.description_ts',
            'grants.funding_instrument_codes',
            'grants.bill',
            'grants.funding_activity_category_codes',
        ])
        .select(knex.raw(`
            CASE
            WHEN grants.archive_date <= now() THEN 'archived'
            WHEN grants.close_date <= now() THEN 'closed'
            ELSE 'posted'
            END as opportunity_status
        `))
        .select(knex.raw(`
            NULLIF(grants.award_ceiling, 0) as award_ceiling
        `))
        .modify((qb) => grantsQuery(qb, filters, agencyId, orderingParams, paginationParams))
        .select(knex.raw(`
            count(*) OVER() AS full_count
        `))
        .groupBy(
            'grants.grant_id',
            'grants.grant_number',
            'grants.title',
            'grants.status',
            'grants.agency_code',
            'award_ceiling',
            'grants.cost_sharing',
            'grants.cfda_list',
            'grants.open_date',
            'grants.close_date',
            'grants.archive_date',
            'grants.reviewer_name',
            'grants.opportunity_category',
            'grants.search_terms',
            'grants.notes',
            'grants.created_at',
            'grants.updated_at',
            'grants.description',
            'grants.eligibility_codes',
            'grants.award_floor',
            'grants.revision_id',
            'grants.title_ts',
            'grants.description_ts',
            'grants.funding_instrument_codes',
            'grants.bill',
            'grants.funding_activity_category_codes',
        );
    if (toCsv) {
        query.modify(addCsvData);
    }
    const data = await query;

    const fullCount = data.length > 0 ? data[0].full_count : 0;

    const pagination = {
        total: parseInt(fullCount, 10),
        lastPage: Math.ceil(parseInt(fullCount, 10) / parseInt(paginationParams.perPage, 10)),
    };

    const enhancedData = await enhanceGrantData(tenantId, data);

    return { data: enhancedData, pagination };
}

async function enhanceGrantData(tenantId, data) {
    if (!data.length) return [];

    const viewedByQuery = knex(TABLES.agencies)
        .join(TABLES.grants_viewed, `${TABLES.agencies}.id`, '=', `${TABLES.grants_viewed}.agency_id`)
        .whereIn('grant_id', data.map((grant) => grant.grant_id))
        .andWhere('agencies.tenant_id', tenantId);

    const viewedBy = await viewedByQuery.distinct(
        `${TABLES.grants_viewed}.grant_id`,
        `${TABLES.grants_viewed}.agency_id`,
        `${TABLES.agencies}.name as agency_name`,
        `${TABLES.agencies}.abbreviation as agency_abbreviation`,
    );
    const interestedBy = await getInterestedAgencies({ grantIds: data.map((grant) => grant.grant_id), tenantId });

    const enhancedData = data.map((grant) => {
        const viewedByAgencies = viewedBy.filter((viewed) => viewed.grant_id === grant.grant_id);
        const agenciesInterested = interestedBy.filter((interested) => interested.grant_id === grant.grant_id);
        return {
            ...grant,
            etitle: decodeURIComponent(escape(grant.title)),
            viewed_by_agencies: viewedByAgencies,
            interested_agencies: agenciesInterested,
            funding_activity_categories: (grant.funding_activity_category_codes || '')
                .split(' ')
                .map((code) => fundingActivityCategoriesByCode[code]?.name)
                .filter(Boolean),
        };
    });

    return enhancedData;
}

async function getGrants({
    currentPage, perPage, tenantId, filters, orderBy, searchTerm, orderDesc,
} = {}) {
    const data = await knex(TABLES.grants)
        .modify((queryBuilder) => {
            if (searchTerm && searchTerm !== 'null') {
                queryBuilder.andWhere(
                    (qb) => qb.where(`${TABLES.grants}.grant_id`, '~*', searchTerm)
                        .orWhere(`${TABLES.grants}.grant_number`, '~*', searchTerm)
                        .orWhere(`${TABLES.grants}.title`, '~*', searchTerm),
                );
            }
            if (filters) {
                if (filters.interestedByUser || filters.positiveInterest || filters.result || filters.rejected || filters.interestedByAgency) {
                    queryBuilder.join(TABLES.grants_interested, `${TABLES.grants}.grant_id`, `${TABLES.grants_interested}.grant_id`)
                        .join(TABLES.interested_codes, `${TABLES.interested_codes}.id`, `${TABLES.grants_interested}.interested_code_id`);
                }
                if (filters.assignedToAgency) {
                    queryBuilder.join(TABLES.assigned_grants_agency, `${TABLES.grants}.grant_id`, `${TABLES.assigned_grants_agency}.grant_id`);
                }
                queryBuilder.andWhere(
                    (qb) => {
                        const isMyGrantsQuery = filters.interestedByAgency !== null
                                                || filters.assignedToAgency !== null
                                                || filters.rejected !== null
                                                || filters.result !== null;
                        if (!isMyGrantsQuery) {
                            helpers.whereAgencyCriteriaMatch(qb, filters.agencyCriteria);
                        }

                        if (filters.interestedByAgency != null) {
                            qb.where('grants_interested.agency_id', filters.interestedByAgency);
                        }
                        if (filters.interestedByUser) {
                            qb.where(`${TABLES.grants_interested}.user_id`, '=', filters.interestedByUser);
                        }
                        if (filters.assignedToAgency) {
                            qb.where(`${TABLES.assigned_grants_agency}.agency_id`, '=', filters.assignedToAgency);
                        }
                        if (!(filters.positiveInterest && filters.result && filters.rejected)) {
                            if (filters.positiveInterest) {
                                qb.where(`${TABLES.interested_codes}.status_code`, '=', 'Interested');
                            }
                            if (filters.result) {
                                qb.where(`${TABLES.interested_codes}.status_code`, '=', 'Result');
                            }
                            if (filters.rejected) {
                                qb.where(`${TABLES.interested_codes}.status_code`, '=', 'Rejected');
                            }
                        }
                        if (filters.opportunityStatuses?.length) {
                            qb.whereIn(`${TABLES.grants}.opportunity_status`, filters.opportunityStatuses);
                        }
                        if (filters.opportunityCategories?.length) {
                            qb.whereIn(`${TABLES.grants}.opportunity_category`, filters.opportunityCategories);
                        }
                        if (filters.costSharing) {
                            qb.where(`${TABLES.grants}.cost_sharing`, '=', filters.costSharing);
                        }
                    },
                );
            }
            if (orderBy && orderBy !== 'undefined') {
                // we assume orderBy is a valid construction of buildOrderingParams
                const orderDirection = ((orderDesc === 'true') ? 'desc' : 'asc');
                queryBuilder.orderBy(orderBy, knex.raw(`${orderDirection} NULLS LAST`));
            }
            queryBuilder.limit(perPage);
            queryBuilder.offset((currentPage - 1) * perPage);
        });

    const counts = await knex(TABLES.grants)
        .modify((queryBuilder) => {
            if (searchTerm && searchTerm !== 'null') {
                queryBuilder.andWhere(
                    (qb) => qb.where(`${TABLES.grants}.grant_id`, '~*', searchTerm)
                        .orWhere(`${TABLES.grants}.grant_number`, '~*', searchTerm)
                        .orWhere(`${TABLES.grants}.title`, '~*', searchTerm),
                );
            }
            if (filters) {
                if (filters.interestedByUser || filters.positiveInterest || filters.result || filters.rejected || filters.interestedByAgency) {
                    queryBuilder.join(TABLES.grants_interested, `${TABLES.grants}.grant_id`, `${TABLES.grants_interested}.grant_id`)
                        .join(TABLES.interested_codes, `${TABLES.interested_codes}.id`, `${TABLES.grants_interested}.interested_code_id`);
                }
                if (filters.assignedToAgency) {
                    queryBuilder.join(TABLES.assigned_grants_agency, `${TABLES.grants}.grant_id`, `${TABLES.assigned_grants_agency}.grant_id`);
                }
                queryBuilder.andWhere(
                    (qb) => {
                        const isMyGrantsQuery = filters.interestedByAgency !== null
                                                || filters.assignedToAgency !== null
                                                || filters.rejected !== null
                                                || filters.result !== null;
                        if (!isMyGrantsQuery) {
                            helpers.whereAgencyCriteriaMatch(qb, filters.agencyCriteria);
                        }

                        if (filters.interestedByAgency != null) {
                            qb.where('grants_interested.agency_id', filters.interestedByAgency);
                        }
                        if (filters.interestedByUser) {
                            qb.where(`${TABLES.grants_interested}.user_id`, '=', filters.interestedByUser);
                        }
                        if (filters.assignedToAgency) {
                            qb.where(`${TABLES.assigned_grants_agency}.agency_id`, '=', filters.assignedToAgency);
                        }
                        if (!(filters.positiveInterest && filters.result && filters.rejected)) {
                            if (filters.positiveInterest) {
                                qb.where(`${TABLES.interested_codes}.status_code`, '=', 'Interested');
                            }
                            if (filters.result) {
                                qb.where(`${TABLES.interested_codes}.status_code`, '=', 'Result');
                            }
                            if (filters.rejected) {
                                qb.where(`${TABLES.interested_codes}.status_code`, '=', 'Rejected');
                            }
                        }
                        if (filters.opportunityStatuses?.length) {
                            qb.whereIn(`${TABLES.grants}.opportunity_status`, filters.opportunityStatuses);
                        }
                        if (filters.opportunityCategories?.length) {
                            qb.whereIn(`${TABLES.grants}.opportunity_category`, filters.opportunityCategories);
                        }
                        if (filters.costSharing) {
                            qb.where(`${TABLES.grants}.cost_sharing`, '=', filters.costSharing);
                        }
                    },
                );
            }
        })
        .countDistinct('grants.grant_id as total_grants');

    const pagination = {
        total: counts[0].total_grants,
        lastPage: Math.ceil(parseInt(counts[0].total_grants, 10) / parseInt(perPage, 10)),
    };
    const viewedByQuery = knex(TABLES.agencies)
        .join(TABLES.grants_viewed, `${TABLES.agencies}.id`, '=', `${TABLES.grants_viewed}.agency_id`)
        .whereIn('grant_id', data.map((grant) => grant.grant_id))
        .andWhere('agencies.tenant_id', tenantId);

    const viewedBy = await viewedByQuery.distinct(
        `${TABLES.grants_viewed}.grant_id`,
        `${TABLES.grants_viewed}.agency_id`,
        `${TABLES.agencies}.name as agency_name`,
        `${TABLES.agencies}.abbreviation as agency_abbreviation`,
    );
    const interestedBy = await getInterestedAgencies({ grantIds: data.map((grant) => grant.grant_id), tenantId });

    const dataWithAgency = data.map((grant) => {
        const viewedByAgencies = viewedBy.filter((viewed) => viewed.grant_id === grant.grant_id);
        const agenciesInterested = interestedBy.filter((interested) => interested.grant_id === grant.grant_id);
        return {
            ...grant,
            viewed_by_agencies: viewedByAgencies,
            interested_agencies: agenciesInterested,
        };
    });
    return { data: dataWithAgency, pagination };
}

async function getGrant({ grantId }) {
    const results = await knex.table(TABLES.grants)
        .select('*')
        .where({ grant_id: grantId });
    return results[0];
}

async function getSingleGrantDetails({ grantId, tenantId }) {
    const results = await knex.table(TABLES.grants)
        .select('*')
        .where({ grant_id: grantId });
    const enhancedResults = await enhanceGrantData(tenantId, results);
    return enhancedResults.length ? enhancedResults[0] : null;
}

async function markGrantAsViewed({ grantId, agencyId, userId }) {
    return knex(TABLES.grants_viewed)
        .insert({
            agency_id: agencyId,
            grant_id: grantId,
            user_id: userId,
            updated_at: new Date(),
        })
        .onConflict(['grant_id', 'agency_id', 'user_id'])
        .merge(); // upsert the new updated timestamp if user has already viewed
}

function getGrantAssignedAgencies({ grantId, tenantId }) {
    return knex(TABLES.assigned_grants_agency)
        .join(TABLES.agencies, `${TABLES.agencies}.id`, '=', `${TABLES.assigned_grants_agency}.agency_id`)
        .join(TABLES.users, `${TABLES.users}.id`, '=', `${TABLES.assigned_grants_agency}.assigned_by`)
        .where({ grant_id: grantId })
        .andWhere(`${TABLES.agencies}.tenant_id`, tenantId)
        .select(`${TABLES.agencies}.*`)
        .select(`${TABLES.assigned_grants_agency}.*`)
        .select(`${TABLES.users}.name as assigned_by_name`, `${TABLES.users}.email as assigned_by_email`, `${TABLES.users}.avatar_color as assigned_by_avatar_color`);
}

function assignGrantsToAgencies({ grantId, agencyIds, userId }) {
    const insertPayload = agencyIds.map((aId) => ({
        agency_id: aId,
        grant_id: grantId,
        assigned_by: userId,
    }));
    return knex(TABLES.assigned_grants_agency)
        .insert(insertPayload)
        .onConflict(['agency_id', 'grant_id'])
        .ignore();
}

function unassignAgenciesToGrant({ grantId, agencyIds }) {
    const deleteWhere = agencyIds.map((aId) => ([aId, grantId]));
    return knex(TABLES.assigned_grants_agency)
        .whereIn(['agency_id', 'grant_id'], deleteWhere)
        .delete();
}

async function getInterestedAgencies({ grantIds, tenantId }) {
    const query = knex(TABLES.agencies)
        .join(TABLES.grants_interested, `${TABLES.agencies}.id`, '=', `${TABLES.grants_interested}.agency_id`)
        .join(TABLES.users, `${TABLES.users}.id`, '=', `${TABLES.grants_interested}.user_id`)
        .leftJoin(TABLES.interested_codes, `${TABLES.interested_codes}.id`, '=', `${TABLES.grants_interested}.interested_code_id`)
        .whereIn('grant_id', grantIds)
        .andWhere('agencies.tenant_id', tenantId);

    const result = await query.select(`${TABLES.grants_interested}.grant_id`, `${TABLES.grants_interested}.agency_id`,
        `${TABLES.agencies}.name as agency_name`, `${TABLES.agencies}.abbreviation as agency_abbreviation`,
        `${TABLES.users}.id as user_id`, `${TABLES.users}.email as user_email`, `${TABLES.users}.name as user_name`, `${TABLES.users}.avatar_color as user_avatar_color`,
        `${TABLES.interested_codes}.id as interested_code_id`, `${TABLES.interested_codes}.name as interested_code_name`, `${TABLES.interested_codes}.status_code as interested_status_code`);

    return result;
}

async function markGrantAsInterested({
    grantId, agencyId, userId, interestedCode,
}) {
    const results = await knex(TABLES.grants_interested)
        .insert({
            agency_id: agencyId,
            grant_id: grantId,
            user_id: userId,
            interested_code_id: +interestedCode,
        });
    return results;
}

async function getGrantsInterested({ agencyId, perPage, currentPage }) {
    const agencies = await getAgencyTree(agencyId);
    return knex('grants_interested')
        .select(knex.raw(`grants_interested.created_at,
                          agencies.name,
                          interested_codes.status_code,
                          interested_codes.name AS interested_name,
                          grants_interested.agency_id,
                          grants.title,
                          grants.grant_id,
                          NULL AS assigned_by,
                          NULL AS assigned_by_user_name`))
        .innerJoin('agencies', 'agencies.id', 'grants_interested.agency_id')
        .innerJoin('interested_codes', 'interested_codes.id', 'grants_interested.interested_code_id')
        .innerJoin('grants', 'grants.grant_id', 'grants_interested.grant_id')
        .whereIn('agencies.id', agencies.map((subAgency) => subAgency.id))
        .unionAll((qb) => {
            qb.select(knex.raw(`assigned_grants_agency.created_at,
                                agencies.name,
                                NULL AS status_code,
                                NULL AS interested_name,
                                assigned_grants_agency.agency_id,
                                grants.title,
                                grants.grant_id,
                                assigned_grants_agency.assigned_by,
                                users.name AS assigned_by_user_name`))
                .from('assigned_grants_agency')
                .innerJoin('users', 'users.id', 'assigned_grants_agency.assigned_by')
                .innerJoin('agencies', 'agencies.id', 'assigned_grants_agency.agency_id')
                .innerJoin('grants', 'grants.grant_id', 'assigned_grants_agency.grant_id')
                .whereIn('agencies.id', agencies.map((subAgency) => subAgency.id))
                .andWhereNot('assigned_by', null);
        })
        .orderBy('created_at', 'DESC')
        .paginate({ currentPage, perPage, isLengthAware: true });
}

async function unmarkGrantAsInterested({ grantId, agencyIds }) {
    const result = await knex(TABLES.grants_interested)
        .where({
            grant_id: grantId,
        })
        .andWhere('agency_id', 'IN', agencyIds)
        .del();
    return result;
}

function getInterestedCodes() {
    return knex(TABLES.interested_codes)
        .select('*')
        .orderBy('name');
}

async function getAgency(agencyId) {
    const result = await getAgenciesByIds([agencyId]);

    return result;
}

async function getAgenciesByIds(agencyIds) {
    const query = knex.select('agencies.*')
        .from(TABLES.agencies)
        .whereIn('agencies.id', agencyIds)
        .leftJoin('tenants', 'tenants.id', '=', `${TABLES.agencies}.tenant_id`);
    const result = await query;

    return result;
}

async function getTenantAgencies(tenantId) {
    return knex(TABLES.agencies)
        .select('*')
        .where('tenant_id', tenantId)
        .orderBy('name');
}

async function getAgencyTree(rootAgency) {
    const query = `WITH RECURSIVE subagencies AS (
    SELECT a.id, name, abbreviation, parent, warning_threshold, danger_threshold, tenant_id
    FROM agencies a
    JOIN tenants t ON a.tenant_id = t.id
    WHERE a.id = ?
    UNION
        SELECT a.id, a.name, a.abbreviation, a.parent, a.warning_threshold, a.danger_threshold, a.tenant_id
        FROM agencies a INNER JOIN subagencies s
            ON s.id = a.parent AND s.tenant_id = a.tenant_id
    ) SELECT * FROM subagencies ORDER BY name; `;
    const result = await knex.raw(query, rootAgency);

    return result.rows;
}

async function getTenant(tenantId) {
    return knex('tenants').select('*').where('id', tenantId).then((rows) => rows[0]);
}

async function getTenants() {
    return knex('tenants').select('*');
}

async function getAgencyEligibilityCodes(agencyId) {
    const eligibilityCodes = await knex(TABLES.eligibility_codes).orderBy('code');
    const agencyEligibilityCodes = await knex(TABLES.agency_eligibility_codes)
        .where('agency_eligibility_codes.agency_id', agencyId)
        .orderBy('code');
    return eligibilityCodes.map((ec) => {
        const agencyEcEnabled = agencyEligibilityCodes.find((aEc) => ec.code === aEc.code);
        if (!agencyEcEnabled) {
            return {
                ...ec,
                created_at: null,
                updated_at: null,
                enabled: true,
            };
        }
        return {
            ...ec,
            ...agencyEcEnabled,
        };
    });
}

function getAgencyKeywords(agencyId) {
    return knex(TABLES.keywords)
        .select('*')
        .where('agency_id', agencyId);
}

async function createAgency(agency, creatorId) {
    const update = { ...agency, creator_id: creatorId };
    // seeded agencies with hardcoded ids will make autoicrement fail since it doesnt
    // know which is the next id
    await knex.raw('select setval(\'agencies_id_seq\', max(id)) from agencies');

    // Enforce tenant isolation by using the tenant_id from the user
    // and the main_agency_id from the tenant.
    const result = await knex.raw(`
        WITH upd AS (
            SELECT
              :parent::integer,
              :name,
              :abbreviation,
              :warning_threshold::integer,
              :danger_threshold::integer,
              :code,
              u.tenant_id
            FROM users u
            JOIN tenants t ON u.tenant_id = t.id
            WHERE u.id = :creator_id
        ) INSERT INTO agencies (
            parent,
            name,
            abbreviation,
            warning_threshold,
            danger_threshold,
            code,
            tenant_id
        ) (SELECT * FROM upd) RETURNING *`, update);

    return result.rows[0];
}

async function deleteAgency(
    id, parent, name, abbreviation, warning_threshold, danger_threshold,
) {
    // seeded agencies with hardcoded ids will make autoicrement fail since it doesnt
    // know which is the next id
    await knex.raw('select setval(\'agencies_id_seq\', max(id)) from agencies');
    return knex(TABLES.agencies)
        .where({
            id,
            parent,
            name,
            abbreviation,
            warning_threshold,
            danger_threshold,
        })
        .del();
}

function setAgencyThresholds(id, warning_threshold, danger_threshold) {
    return knex(TABLES.agencies)
        .where({
            id,
        })
        .update({ warning_threshold, danger_threshold });
}

function setAgencyName(id, agen_name) {
    // console.log('agen name === ' + agen_name);
    return knex(TABLES.agencies)
        .where({
            id,
        })
        .update({ name: agen_name });
}

function setAgencyAbbr(id, agen_abbr) {
    return knex(TABLES.agencies)
        .where({
            id,
        })
        .update({ abbreviation: agen_abbr });
}

function setAgencyCode(id, agencyCode) {
    return knex(TABLES.agencies)
        .where({
            id,
        })
        .update({ code: agencyCode });
}

function setAgencyParent(id, agen_parent) {
    // console.log('agen id in index.js ' + id);
    return knex(TABLES.agencies)
        .where({
            id,
        })
        .update({ parent: agen_parent });
}

async function setUserEmailSubscriptionPreference(userId, agencyId, preferences) {
    const updatedPreferences = { ...emailConstants.defaultSubscriptionPreference, ...preferences };

    const insertValues = [];
    for (const [notification_type, status] of Object.entries(updatedPreferences)) {
        insertValues.push({
            user_id: userId,
            agency_id: agencyId,
            updated_at: knex.fn.now(),
            notification_type,
            status,
        });
    }

    await knex('email_subscriptions')
        .insert(insertValues)
        .onConflict(['user_id', 'agency_id', 'notification_type'])
        .merge(['user_id', 'agency_id', 'status', 'updated_at']);

    return getUser(userId);
}

async function getUserEmailSubscriptionPreference(userId, agencyId) {
    const result = await knex('email_subscriptions')
        .where({ user_id: userId, agency_id: agencyId });

    if (result.length === 0) {
        return emailConstants.defaultSubscriptionPreference;
    }

    const preferences = Object.assign(...result.map((r) => ({ [r.notification_type]: r.status })));
    return { ...emailConstants.defaultSubscriptionPreference, ...preferences };
}

function setTenantDisplayName(id, display_name) {
    return knex(TABLES.tenants)
        .where({
            id,
        })
        .update({ display_name });
}

async function createRecord(tableName, row) {
    return knex(tableName).insert(row);
}

async function updateRecord(tableName, syncKey, key, row) {
    return knex(tableName)
        .where({ [syncKey]: key })
        .update({
            ...row,
            updated_at: new Date(),
        });
}

async function getAllRows(tableName, syncKey, fetchCols) {
    const fields = fetchCols.slice(0);
    fields.push(syncKey);

    const rows = {};
    const records = await knex.select('*').from(tableName);
    records.forEach((record) => {
        rows[record[syncKey]] = record;
    });
    return rows;
}

async function sync(tableName, syncKey, updateCols, newRows) {
    const oldRows = await getAllRows(tableName, syncKey, updateCols);
    const alreadyUpdated = {};
    for (const i in newRows) {
        const newRow = newRows[i];
        const syncKeyValue = newRow[syncKey];
        if (alreadyUpdated[syncKeyValue]) {
            // already creating an item with this syncKey; do nothing
        } else if (oldRows[syncKeyValue]) {
            // already inserted, check if updates are necessary
            alreadyUpdated[syncKeyValue] = true;

            const updatedFields = {};
            updateCols.forEach((col) => {
                if (oldRows[syncKeyValue][col] !== newRow[col]) {
                    updatedFields[col] = newRow[col];
                }
            });

            if (Object.values(updatedFields).length > 0) {
                try {
                    await updateRecord(tableName, syncKey, oldRows[syncKeyValue][syncKey], updatedFields);
                    console.log(`updated ${oldRows[syncKeyValue][syncKey]} in ${tableName}`);
                } catch (err) {
                    console.error(`knex error when updating ${oldRows[syncKeyValue][syncKey]} in ${tableName} with ${JSON.stringify(updatedFields)}: ${err}`);
                }
            }
        } else {
            // does not exist, insert!
            alreadyUpdated[syncKeyValue] = true;
            try {
                await createRecord(tableName, newRow);
                console.log(`created ${newRow[syncKey]} in ${tableName}`);
            } catch (err) {
                console.error(`knex error when creating a new row with key ${newRow[syncKey]} in ${tableName}: ${err}`);
            }
        }
    }
}

/**
 * Determines if all given agencies belong to the same given tenant
 * @param  int        tenantId
 * @parm   Array[int] agencyIds
 * @return boolean
 * */
async function inTenant(tenantId, agencyIds) {
    const uniqueAgencyIds = Array.from(new Set(agencyIds));

    const result = await knex(
        knex('agencies')
            .select('id as agency_id')
            .where('tenant_id', tenantId)
            .whereIn('id', uniqueAgencyIds)
            .as('agencies_in_tenant'),
    ).select(
        // Aggregate the results of the subquery into an array, and check that
        // all our expected agencyIds member values are contained by the aggregation.
        // Coalesce the result of the check so that it always returns boolean.
        knex.raw(
            'coalesce(? <@ array_agg(agencies_in_tenant.agency_id), false) as same_tenant',
            [uniqueAgencyIds],
        ),
    ).first();

    return result.same_tenant === true;
}

/**
 * Creates and saves a new saved search, given a name, agency ID, user ID, and criteria
 *  interface SavedSearch {
    id?: number
    name: string
    createdBy: number
    criteria: string
    createdAt?: string
   }
 * @param  SavedSearch           searchItem
 * @return Promise<SavedSearch>
 * */
async function createSavedSearch(searchItem) {
    const response = await knex('grants_saved_searches')
        .insert({
            name: searchItem.name,
            created_by: searchItem.userId,
            criteria: searchItem.criteria,
        })
        .returning('*');

    return {
        id: response[0].id,
        name: response[0].name,
        createdBy: response[0].created_by,
        criteria: response[0].criteria,
        createdAt: new Date(response[0].created_at).toISOString(),
        updatedAt: new Date(response[0].updated_at).toISOString(),
    };
}

async function updateSavedSearch(searchItem) {
    const response = await knex('grants_saved_searches')
        .where({ id: searchItem.id, created_by: searchItem.userId })
        .update({
            name: searchItem.name,
            criteria: searchItem.criteria,
            updated_at: new Date(),
        })
        .returning('*');

    return {
        id: response[0].id,
        name: response[0].name,
        createdBy: response[0].created_by,
        criteria: response[0].criteria,
        createdAt: new Date(response[0].created_at).toISOString(),
        updatedAt: new Date(response[0].updated_at).toISOString(),
    };
}

/**
 * Retrieves saved searches
 * @param  int              userId
 * @param  IPaginateParams  paginationParams
 * @return Promise<boolean>
 * */
async function getSavedSearches(userId, paginationParams) {
    const response = await knex('grants_saved_searches')
        .where('created_by', userId)
        .orderBy('updated_at', 'desc')
        .paginate(paginationParams);

    response.data = response.data.map((r) => ({
        id: r.id,
        name: r.name,
        createdBy: r.created_by,
        criteria: r.criteria,
        createdAt: new Date(r.created_at).toISOString(),
    }));

    return response;
}

/**
 * Retrieves all saved searches joined with user and digest subscription information
 * @param int                   userId (optional)
 * @return Promise<boolean>
 * */
async function getAllUserSavedSearches(userId) {
    const query = knex.select(
        `${TABLES.grants_saved_searches}.id as id`,
        `${TABLES.grants_saved_searches}.created_by as created_by`,
        `${TABLES.grants_saved_searches}.criteria as criteria`,
        `${TABLES.grants_saved_searches}.name as name`,
        `${TABLES.email_subscriptions}.status as status`,
        `${TABLES.email_subscriptions}.notification_type as notification_type`,
        `${TABLES.users}.tenant_id as tenant_id`,
        `${TABLES.users}.email as email`,
    )
        .from(`${TABLES.grants_saved_searches}`)
        .join(TABLES.users, `${TABLES.grants_saved_searches}.created_by`, '=', `${TABLES.users}.id`)
        .leftJoin(
            TABLES.email_subscriptions, (builder) => {
                builder
                    .on(`${TABLES.grants_saved_searches}.created_by`, '=', `${TABLES.email_subscriptions}.user_id`)
                    .andOn(`${TABLES.email_subscriptions}.notification_type`, '=', knex.raw('?', [emailConstants.notificationType.grantDigest]));
            },
        )
        .where((q) => {
            q
                .where(`${TABLES.email_subscriptions}.status`, `${emailConstants.emailSubscriptionStatus.subscribed}`)
                .orWhereNull(`${TABLES.email_subscriptions}.status`);
        });
    if (userId) {
        query.andWhere(`${TABLES.grants_saved_searches}.created_by`, '=', userId);
    }
    const response = await query;

    const data = response.map((r) => ({
        id: r.id,
        tenantId: r.tenant_id,
        userId: r.created_by,
        email: r.email,
        status: r.status,
        name: r.name,
        criteria: r.criteria,
    }));

    return data;
}

/**
 * Get Saved Search by ID
 * @param  int   id
 * @return any   row | null
 * */
async function getSavedSearch(searchId) {
    const response = await knex('grants_saved_searches')
        .where('id', searchId)
        .first();

    return response;
}

/**
 * Deletes a saved search
 * @param  int               searchId
 * @return Promise<boolean>
 * */
async function deleteSavedSearch(searchId, userId) {
    let rowsDeleted = 0;

    try {
        rowsDeleted = await knex('grants_saved_searches')
            .where({ id: searchId, created_by: userId })
            .del();
    } catch (e) {
        console.error(`Unable to delete ${searchId}. Error: ${e}`);
        throw e;
    }

    return rowsDeleted === 1;
}

function close() {
    return knex.destroy();
}

module.exports = {
    knex,
    createSavedSearch,
    getSavedSearch,
    getSavedSearches,
    deleteSavedSearch,
    updateSavedSearch,
    getAllUserSavedSearches,
    formatSearchCriteriaToQueryFilters,
    getUsers,
    createUser,
    updateUser,
    deleteUser,
    getUsersByAgency,
    getSubscribersForNotification,
    getUsersEmailAndName,
    getUser,
    getUserIdForEmail,
    getAgencyCriteriaForAgency,
    isSubOrganization,
    getRoles,
    createAccessToken,
    getAccessToken,
    incrementAccessTokenUses,
    inTenant,
    markAccessTokenUsed,
    getAgency,
    getAgenciesByIds,
    getAgencyTree,
    getTenantAgencies,
    getTenant,
    getTenants,
    getAgencyEligibilityCodes,
    setAgencyEligibilityCodeEnabled,
    getKeyword,
    getKeywords,
    getAgencyKeywords,
    getGrantsInterested,
    getUserEmailSubscriptionPreference,
    setAgencyThresholds,
    setAgencyName,
    setAgencyAbbr,
    setAgencyCode,
    setAgencyParent,
    setUserEmailSubscriptionPreference,
    setTenantDisplayName,
    createKeyword,
    deleteKeyword,
    getGrants,
    getGrantsNew,
    buildPaginationParams,
    buildOrderingParams,
    getNewGrantsForAgency,
    getSingleGrantDetails,
    getGrant,
    markGrantAsViewed,
    getInterestedAgencies,
    getInterestedCodes,
    markGrantAsInterested,
    unmarkGrantAsInterested,
    getGrantAssignedAgencies,
    assignGrantsToAgencies,
    createAgency,
    deleteAgency,
    unassignAgenciesToGrant,
    getEligibilityCodes,
    sync,
    getAllRows,
    close,
    validateSearchFilters,
};