gfw-api/gfw-subscription-api

View on GitHub
app/src/services/subscriptionService.js

Summary

Maintainability
A
35 mins
Test Coverage
A
93%
const _ = require('lodash');
const logger = require('logger');
const mongoose = require('mongoose');
const Subscription = require('models/subscription');
const SubscriptionSerializer = require('serializers/subscriptionSerializer');

const mailService = require('services/mailService');
const UrlService = require('services/urlService');

class SubscriptionService {

    static getSupportedLanguages() {
        return ['en', 'fr', 'es_MX', 'pt_BR', 'zh', 'id'];
    }

    static formatSubscription(subscription) {
        if (!subscription) {
            return {};
        }

        return {
            name: subscription.name,
            createdAt: subscription.created_at,
            updatedAt: subscription.updated_at,
            userId: subscription.userId,
            params: subscription.params,
            resource: subscription.resource,
            datasets: subscription.datasets,
            datasetsQuery: subscription.datasetsQuery,
            application: subscription.application || 'gfw',
            language: subscription.language,
            confirmed: subscription.confirmed,
            env: subscription.env || 'production'
        };
    }

    static async createSubscription(data) {
        logger.info('Creating subscription with data ', data);
        data.userId = (data.loggedUser.id === 'microservice') ? data.userId : data.loggedUser.id;

        // Sanitize subscription language
        if (!SubscriptionService.getSupportedLanguages().includes(data.language)) {
            data.language = 'en';
        }

        const subscriptionFormatted = SubscriptionService.formatSubscription(data);
        logger.debug('Creating subscription ', subscriptionFormatted);
        delete subscriptionFormatted.createdAt;
        delete subscriptionFormatted.updatedAt;
        if (subscriptionFormatted.resource.type === 'URL') {
            subscriptionFormatted.confirmed = true;
        }
        const subscription = await new Subscription(subscriptionFormatted).save();
        if (subscriptionFormatted.resource.type !== 'URL') {
            SubscriptionService.sendConfirmation(subscription);
        }

        return SubscriptionSerializer.serialize(subscription);
    }

    static sendConfirmation(subscription) {
        logger.info('Sending confirmation email', subscription.toJSON());
        if (subscription.resource.type === 'EMAIL') {
            const language = subscription.language.toLowerCase().replace(/_/g, '-');
            const application = subscription.application || 'gfw';
            let template = `subscription-confirmation-${language}`;
            if (application !== 'gfw') {
                template = `subscription-confirmation-${application}-${language}`;
            }
            mailService.sendMail(template, {
                confirmation_url: UrlService.confirmationUrl(subscription)
            }, [{
                address: subscription.resource.content
            }]);

            return SubscriptionSerializer.serialize(
                SubscriptionService.formatSubscription(subscription)
            );
        }

        return null;
    }

    static async confirmSubscription(id) {
        const subscription = await Subscription.where({
            _id: id,
        }).findOne();

        subscription.confirmed = true;
        subscription.save();

        return SubscriptionSerializer.serialize(
            SubscriptionService.formatSubscription(subscription)
        );
    }

    static async updateSubscription(id, data) {
        const subscription = await Subscription.findById(id);
        let attributes = _.omitBy(data, _.isNil);
        attributes = _.omit(attributes, 'loggedUser');
        _.each(attributes, (value, attribute) => {
            subscription[attribute] = value;
        });

        // Sanitize subscription language
        if (!SubscriptionService.getSupportedLanguages().includes(subscription.language)) {
            subscription.language = 'en';
        }

        await subscription.save();

        return SubscriptionSerializer.serialize(subscription);
    }

    static async deleteSubscriptionById(id) {
        const subscription = await Subscription.where({
            _id: id,
        }).findOneAndRemove();

        return SubscriptionSerializer.serialize(subscription);
    }

    static async getSubscriptionForUser(id, userId) {
        const subscription = await Subscription.where({
            _id: id,
            userId
        }).findOne();

        return SubscriptionSerializer.serialize(subscription);
    }

    static async getSubscriptionById(id) {
        return Subscription.findById(id.toString());
    }

    static async getSubscriptionsByLayer(layerSlug) {
        return Subscription.find({
            datasets: {
                $in: [layerSlug]
            },
            confirmed: true
        }).exec();
    }

    static async getAllSubscriptions(
        link,
        application = undefined,
        env = undefined,
        page = 1,
        limit = 10,
        updatedAtSince = null,
        updatedAtUntil = null,
    ) {
        const filter = {};
        if (application) filter.application = application;
        if (env) filter.env = env;

        if (updatedAtSince || updatedAtUntil) {
            filter.updateAt = {};
            if (updatedAtSince) filter.updateAt.$gte = new Date(updatedAtSince).toISOString();
            if (updatedAtUntil) filter.updateAt.$lte = new Date(updatedAtUntil).toISOString();
        }

        const subscriptions = await Subscription.paginate(filter, { page, limit, sort: 'id' });
        return SubscriptionSerializer.serializeList(subscriptions, link);
    }

    static async getSubscriptionsForUser(userId, application = undefined, env = undefined) {
        const filter = { userId };
        if (application) filter.application = application;
        if (env) filter.env = env;

        logger.debug(`[SubscriptionService - getSubscriptionsForUser] - loading subscriptions for filter ${JSON.stringify(filter)}`);
        const subscriptions = await Subscription.find(filter).exec();
        return SubscriptionSerializer.serialize(subscriptions);
    }

    static async getSubscriptionsByIds(ids) {
        const idsToFind = ids
            .filter(mongoose.Types.ObjectId.isValid)
            .map((id) => mongoose.Types.ObjectId(id));

        const subscriptions = await Subscription.find({ _id: { $in: idsToFind } });
        return SubscriptionSerializer.serialize(subscriptions);
    }

}

module.exports = SubscriptionService;