ChallengeService.js

/**
 * This service provides operations of challenge.
 */

const { GRPC_CHALLENGE_SERVER_HOST, GRPC_CHALLENGE_SERVER_PORT } = process.env;

const {
  DomainHelper: { getLookupCriteria, getScanCriteria },
} = require("@topcoder-framework/lib-common");

const _ = require("lodash");
const Joi = require("joi");
const uuid = require("uuid/v4");
const config = require("config");
const xss = require("xss");
const helper = require("../common/helper");
const logger = require("../common/logger");
const errors = require("../common/errors");
const constants = require("../../app-constants");
const HttpStatus = require("http-status-codes");
const ChallengeTypeService = require("./ChallengeTypeService");
const ChallengeTrackService = require("./ChallengeTrackService");
const ChallengeTimelineTemplateService = require("./ChallengeTimelineTemplateService");
const { BadRequestError } = require("../common/errors");

const phaseHelper = require("../common/phase-helper");
const projectHelper = require("../common/project-helper");
const challengeHelper = require("../common/challenge-helper");

const { Metadata: GrpcMetadata } = require("@grpc/grpc-js");

const esClient = helper.getESClient();

const { ChallengeDomain } = require("@topcoder-framework/domain-challenge");
const { hasAdminRole } = require("../common/role-helper");
const {
  validateChallengeUpdateRequest,
  enrichChallengeForResponse,
  sanitizeRepeatedFieldsInUpdateRequest,
  convertPrizeSetValuesToCents,
  convertPrizeSetValuesToDollars,
  convertToISOString,
} = require("../common/challenge-helper");
const deepEqual = require("deep-equal");

const challengeDomain = new ChallengeDomain(GRPC_CHALLENGE_SERVER_HOST, GRPC_CHALLENGE_SERVER_PORT);

/**
 * Check if user can perform modification/deletion to a challenge
 *
 * @param {Object} user the JwT user object
 * @param {Object} challenge the challenge object
 * @returns {undefined}
 */
async function ensureAccessibleForChallenge(user, challenge) {
  const userHasFullAccess = await helper.userHasFullAccess(challenge.id, user.userId);
  if (
    !user.isMachine &&
    !hasAdminRole(user) &&
    challenge.createdBy.toLowerCase() !== user.handle.toLowerCase() &&
    !userHasFullAccess
  ) {
    throw new errors.ForbiddenError(
      `Only M2M, admin, challenge's copilot or users with full access can perform modification.`
    );
  }
}

/**
 * Search challenges by legacyId
 * @param {Object} currentUser the user who perform operation
 * @param {Number} legacyId the legacyId
 * @param {Number} page the page
 * @param {Number} perPage the perPage
 * @returns {Array} the search result
 */
async function searchByLegacyId(currentUser, legacyId, page, perPage) {
  const esQuery = {
    index: config.get("ES.ES_INDEX"),
    type: config.get("ES.OPENSEARCH") == "false" ? config.get("ES.ES_TYPE") : undefined,
    size: perPage,
    from: (page - 1) * perPage,
    body: {
      query: {
        term: {
          legacyId,
        },
      },
    },
  };
  let docs;
  try {
    docs =
      config.get("ES.OPENSEARCH") == "false"
        ? await esClient.search(esQuery)
        : (await esClient.search(esQuery)).body;
  } catch (e) {
    logger.error(`Query Error from ES ${JSON.stringify(e)}`);
    docs = {
      hits: {
        hits: [],
      },
    };
  }
  const ids = _.map(docs.hits.hits, (item) => item._source.id);
  const result = [];
  for (const id of ids) {
    try {
      const challenge = await getChallenge(currentUser, id);
      result.push(challenge);
    } catch (e) {}
  }
  return result;
}

/**
 * Search challenges
 * @param {Object} currentUser the user who perform operation
 * @param {Object} criteria the search criteria
 * @returns {Object} the search result
 */
async function searchChallenges(currentUser, criteria) {
  // construct ES query

  const page = criteria.page || 1;
  const perPage = criteria.perPage || 20;
  if (!_.isUndefined(criteria.legacyId)) {
    const result = await searchByLegacyId(currentUser, criteria.legacyId, page, perPage);
    return { total: result.length, page, perPage, result };
  }
  const boolQuery = [];
  let sortByScore = false;
  const matchPhraseKeys = [
    "id",
    "timelineTemplateId",
    "projectId",
    "legacyId",
    "status",
    "createdBy",
    "updatedBy",
  ];

  const _hasAdminRole = hasAdminRole(currentUser);

  const includeSelfService =
    currentUser &&
    (currentUser.isMachine ||
      _hasAdminRole ||
      _.includes(config.SELF_SERVICE_WHITELIST_HANDLES, currentUser.handle.toLowerCase()));

  const includedTrackIds = _.isArray(criteria.trackIds) ? criteria.trackIds : [];
  const includedTypeIds = _.isArray(criteria.typeIds) ? criteria.typeIds : [];

  if (criteria.type) {
    const typeSearchRes = await ChallengeTypeService.searchChallengeTypes({
      abbreviation: criteria.type,
    });
    if (typeSearchRes.total > 0) {
      criteria.typeId = _.get(typeSearchRes, "result[0].id");
    }
  }
  if (criteria.track) {
    const trackSearchRes = await ChallengeTrackService.searchChallengeTracks({
      abbreviation: criteria.track,
    });
    if (trackSearchRes.total > 0) {
      criteria.trackId = _.get(trackSearchRes, "result[0].id");
    }
  }
  if (criteria.types) {
    for (const t of criteria.types) {
      const typeSearchRes = await ChallengeTypeService.searchChallengeTypes({ abbreviation: t });
      if (typeSearchRes.total > 0 || criteria.types.length === 1) {
        includedTypeIds.push(_.get(typeSearchRes, "result[0].id"));
      }
    }
  }
  if (criteria.tracks) {
    for (const t of criteria.tracks) {
      const trackSearchRes = await ChallengeTrackService.searchChallengeTracks({
        abbreviation: t,
      });
      if (trackSearchRes.total > 0) {
        includedTrackIds.push(_.get(trackSearchRes, "result[0].id"));
      }
    }
  }
  if (criteria.typeId) {
    includedTypeIds.push(criteria.typeId);
  }
  if (criteria.trackId) {
    includedTrackIds.push(criteria.trackId);
  }

  _.forIn(_.pick(criteria, matchPhraseKeys), (value, key) => {
    if (!_.isUndefined(value)) {
      const filter = { match_phrase: {} };
      filter.match_phrase[key] = value;
      boolQuery.push(filter);
    }
  });

  _.forEach(_.keys(criteria), (key) => {
    if (_.toString(key).indexOf("meta.") > -1) {
      // Parse and use metadata key
      if (!_.isUndefined(criteria[key])) {
        const metaKey = key.split("meta.")[1];
        boolQuery.push({
          bool: {
            must: [
              { match_phrase: { "metadata.name": metaKey } },
              { match_phrase: { "metadata.value": _.toString(criteria[key]) } },
            ],
          },
        });
      }
    }
  });

  if (includedTypeIds.length > 0) {
    boolQuery.push({
      bool: {
        should: _.map(includedTypeIds, (t) => ({
          match_phrase: { typeId: t },
        })),
      },
    });
  }

  if (includedTrackIds.length > 0) {
    boolQuery.push({
      bool: {
        should: _.map(includedTrackIds, (t) => ({
          match_phrase: { trackId: t },
        })),
      },
    });
  }

  const multiMatchQuery = [];
  if (criteria.search) {
    multiMatchQuery.push({
      // exact match
      multi_match: {
        query: criteria.search,
        fields: ["name.text^7", "tags^3", "description^2"],
        type: "phrase_prefix",
        boost: 5,
      },
    });
    multiMatchQuery.push({
      // match 100% words
      multi_match: {
        query: criteria.search,
        fields: ["name.text^3.0", "tags^2.5", "description^1.0"],
        type: "most_fields",
        minimum_should_match: "100%",
        boost: 2.5,
      },
    });
    multiMatchQuery.push({
      // fuzzy match
      multi_match: {
        query: criteria.search,
        fields: ["name.text^2.5", "tags^1.5", "description^1.0"],
        type: "most_fields",
        minimum_should_match: "50%",
        fuzziness: "AUTO",
        boost: 1,
      },
    });
    boolQuery.push({
      bool: {
        should: [
          { wildcard: { name: `*${criteria.search}*` } },
          { wildcard: { name: `${criteria.search}*` } },
          { wildcard: { name: `*${criteria.search}` } },
          { match_phrase: { tags: criteria.search } },
        ],
      },
    });
  } else {
    if (criteria.name) {
      boolQuery.push({
        bool: {
          should: [
            { wildcard: { name: `*${criteria.name}*` } },
            { wildcard: { name: `${criteria.name}*` } },
            { wildcard: { name: `*${criteria.name}` } },
          ],
        },
      });
    }

    if (criteria.description) {
      boolQuery.push({
        match_phrase_prefix: { description: criteria.description },
      });
    }
  }

  // 'search', 'name', 'description' fields should be sorted by function score unless sortBy param provided.
  if (!criteria.sortBy && (criteria.search || criteria.name || criteria.description)) {
    sortByScore = true;
  }

  if (criteria.tag) {
    boolQuery.push({ match_phrase: { tags: criteria.tag } });
  }

  if (criteria.tags) {
    boolQuery.push({
      bool: {
        [criteria.includeAllTags ? "must" : "should"]: _.map(criteria.tags, (t) => ({
          match_phrase: { tags: t },
        })),
      },
    });
  }

  if (criteria.totalPrizesFrom || criteria.totalPrizesTo) {
    const prizeRangeQuery = {};
    if (criteria.totalPrizesFrom) {
      prizeRangeQuery.gte = criteria.totalPrizesFrom;
    }
    if (criteria.totalPrizesTo) {
      prizeRangeQuery.lte = criteria.totalPrizesTo;
    }
    boolQuery.push({ range: { "overview.totalPrizes": prizeRangeQuery } });
  }

  if (criteria.useSchedulingAPI) {
    boolQuery.push({
      match_phrase: { "legacy.useSchedulingAPI": criteria.useSchedulingAPI },
    });
  }
  if (criteria.selfService) {
    boolQuery.push({
      match_phrase: { "legacy.selfService": criteria.selfService },
    });
  }
  if (criteria.selfServiceCopilot) {
    boolQuery.push({
      match_phrase: {
        "legacy.selfServiceCopilot": criteria.selfServiceCopilot,
      },
    });
  }
  if (criteria.forumId) {
    boolQuery.push({ match_phrase: { "legacy.forumId": criteria.forumId } });
  }
  if (criteria.reviewType) {
    boolQuery.push({
      match_phrase: { "legacy.reviewType": criteria.reviewType },
    });
  }
  if (criteria.confidentialityType) {
    boolQuery.push({
      match_phrase: {
        "legacy.confidentialityType": criteria.confidentialityType,
      },
    });
  }
  if (criteria.directProjectId) {
    boolQuery.push({
      match_phrase: { "legacy.directProjectId": criteria.directProjectId },
    });
  }
  if (criteria.currentPhaseName) {
    boolQuery.push({
      match_phrase: { currentPhaseNames: criteria.currentPhaseName },
    });
  }
  if (criteria.createdDateStart) {
    boolQuery.push({ range: { created: { gte: criteria.createdDateStart } } });
  }
  if (criteria.createdDateEnd) {
    boolQuery.push({ range: { created: { lte: criteria.createdDateEnd } } });
  }
  if (criteria.registrationStartDateStart) {
    boolQuery.push({
      range: {
        registrationStartDate: { gte: criteria.registrationStartDateStart },
      },
    });
  }
  if (criteria.registrationStartDateEnd) {
    boolQuery.push({
      range: {
        registrationStartDate: { lte: criteria.registrationStartDateEnd },
      },
    });
  }
  if (criteria.registrationEndDateStart) {
    boolQuery.push({
      range: {
        registrationEndDate: { gte: criteria.registrationEndDateStart },
      },
    });
  }
  if (criteria.registrationEndDateEnd) {
    boolQuery.push({
      range: { registrationEndDate: { lte: criteria.registrationEndDateEnd } },
    });
  }
  if (criteria.submissionStartDateStart) {
    boolQuery.push({
      range: {
        submissionStartDate: { gte: criteria.submissionStartDateStart },
      },
    });
  }
  if (criteria.submissionStartDateEnd) {
    boolQuery.push({
      range: { submissionStartDate: { lte: criteria.submissionStartDateEnd } },
    });
  }
  if (criteria.submissionEndDateStart) {
    boolQuery.push({
      range: { submissionEndDate: { gte: criteria.submissionEndDateStart } },
    });
  }
  if (criteria.submissionEndDateEnd) {
    boolQuery.push({
      range: { submissionEndDate: { lte: criteria.submissionEndDateEnd } },
    });
  }
  if (criteria.updatedDateStart) {
    boolQuery.push({ range: { updated: { gte: criteria.updatedDateStart } } });
  }
  if (criteria.updatedDateEnd) {
    boolQuery.push({ range: { updated: { lte: criteria.updatedDateEnd } } });
  }
  if (criteria.startDateStart) {
    boolQuery.push({ range: { startDate: { gte: criteria.startDateStart } } });
  }
  if (criteria.startDateEnd) {
    boolQuery.push({ range: { startDate: { lte: criteria.startDateEnd } } });
  }
  if (criteria.endDateStart) {
    boolQuery.push({ range: { endDate: { gte: criteria.endDateStart } } });
  }
  if (criteria.endDateEnd) {
    boolQuery.push({ range: { endDate: { lte: criteria.endDateEnd } } });
  }

  let sortByProp = criteria.sortBy ? criteria.sortBy : "created";
  const sortOrderProp = criteria.sortOrder ? criteria.sortOrder : "desc";

  const mustQuery = [];

  const groupsQuery = [];

  if (criteria.tco) {
    boolQuery.push({ match_phrase_prefix: { "events.key": "tco" } });
  }

  if (criteria.events) {
    boolQuery.push({
      bool: {
        [criteria.includeAllEvents ? "must" : "should"]: _.map(criteria.events, (e) => ({
          match_phrase: { "events.key": e },
        })),
      },
    });
  }

  const mustNotQuery = [];

  let groupsToFilter = [];
  let accessibleGroups = [];

  if (currentUser && !currentUser.isMachine && !_hasAdminRole) {
    accessibleGroups = await helper.getCompleteUserGroupTreeIds(currentUser.userId);
  }

  // Filter all groups from the criteria to make sure the user can access those
  if (!_.isUndefined(criteria.group) || !_.isUndefined(criteria.groups)) {
    // check group access
    if (_.isUndefined(currentUser)) {
      if (criteria.group) {
        const group = await helper.getGroupById(criteria.group);
        if (group && !group.privateGroup) {
          groupsToFilter.push(criteria.group);
        }
      }
      if (criteria.groups && criteria.groups.length > 0) {
        const promises = [];
        _.each(criteria.groups, (g) => {
          promises.push(
            (async () => {
              const group = await helper.getGroupById(g);
              if (group && !group.privateGroup) {
                groupsToFilter.push(g);
              }
            })()
          );
        });
        await Promise.all(promises);
      }
    } else if (!currentUser.isMachine && !_hasAdminRole) {
      if (accessibleGroups.includes(criteria.group)) {
        groupsToFilter.push(criteria.group);
      }
      if (criteria.groups && criteria.groups.length > 0) {
        _.each(criteria.groups, (g) => {
          if (accessibleGroups.includes(g)) {
            groupsToFilter.push(g);
          }
        });
      }
    } else {
      groupsToFilter = [...(criteria.groups ? criteria.groups : [])];
      if (criteria.group) {
        groupsToFilter.push(criteria.group);
      }
    }
    groupsToFilter = _.uniq(groupsToFilter);

    if (groupsToFilter.length === 0) {
      // User can't access any of the groups from the filters
      // We return an empty array as the result
      return { total: 0, page, perPage, result: [] };
    }
  }

  if (groupsToFilter.length === 0) {
    // Return public challenges + challenges from groups that the user has access to
    if (_.isUndefined(currentUser)) {
      // If the user is not authenticated, only query challenges that don't have a group
      mustNotQuery.push({ exists: { field: "groups" } });
    } else if (!currentUser.isMachine && !_hasAdminRole) {
      // If the user is not M2M and is not an admin, return public + challenges from groups the user can access
      _.each(accessibleGroups, (g) => {
        groupsQuery.push({ match_phrase: { groups: g } });
      });
      // include public challenges
      groupsQuery.push({ bool: { must_not: { exists: { field: "groups" } } } });
    }
  } else {
    _.each(groupsToFilter, (g) => {
      groupsQuery.push({ match_phrase: { groups: g } });
    });
  }

  if (criteria.ids) {
    boolQuery.push({
      bool: {
        should: _.map(criteria.ids, (id) => ({ match_phrase: { _id: id } })),
      },
    });
  }

  const accessQuery = [];
  let memberChallengeIds;

  // FIXME: This is wrong!
  // if (!_.isUndefined(currentUser) && currentUser.handle) {
  //   accessQuery.push({ match_phrase: { createdBy: currentUser.handle } })
  // }

  if (criteria.memberId) {
    // logger.error(`memberId ${criteria.memberId}`)
    memberChallengeIds = await helper.listChallengesByMember(criteria.memberId);
    // logger.error(`response ${JSON.stringify(ids)}`)
    accessQuery.push({ terms: { _id: memberChallengeIds } });
  } else if (currentUser && !_hasAdminRole && !_.get(currentUser, "isMachine", false)) {
    memberChallengeIds = await helper.listChallengesByMember(currentUser.userId);
  }

  if (accessQuery.length > 0) {
    mustQuery.push({
      bool: {
        should: accessQuery,
      },
    });
  }

  // FIXME: Tech Debt
  let excludeTasks = true;
  // if you're an admin or m2m, security rules wont be applied
  if (currentUser && (_hasAdminRole || _.get(currentUser, "isMachine", false))) {
    excludeTasks = false;
  }

  /**
   * For non-authenticated users:
   * - Only unassigned tasks will be returned
   * For authenticated users (non-admin):
   * - Only unassigned tasks and tasks assigned to the logged in user will be returned
   * For admins/m2m:
   * - All tasks will be returned
   */
  if (currentUser && (_hasAdminRole || _.get(currentUser, "isMachine", false))) {
    // For admins/m2m, allow filtering based on task properties
    if (criteria.isTask) {
      boolQuery.push({ match_phrase: { "task.isTask": criteria.isTask } });
    }
    if (criteria.taskIsAssigned) {
      boolQuery.push({
        match_phrase: { "task.isAssigned": criteria.taskIsAssigned },
      });
    }
    if (criteria.taskMemberId) {
      boolQuery.push({
        match_phrase: {
          "task.memberId": criteria.taskMemberId,
        },
      });
    }
  } else if (excludeTasks) {
    mustQuery.push({
      bool: {
        should: [
          ...(_.get(memberChallengeIds, "length", 0) > 0
            ? [{ bool: { should: [{ terms: { _id: memberChallengeIds } }] } }]
            : []),
          { bool: { must_not: { exists: { field: "task.isTask" } } } },
          { match_phrase: { "task.isTask": false } },
          {
            bool: {
              must: [
                { match_phrase: { "task.isTask": true } },
                { match_phrase: { "task.isAssigned": false } },
              ],
            },
          },
          ...(currentUser && !_hasAdminRole && !_.get(currentUser, "isMachine", false)
            ? [{ match_phrase: { "task.memberId": currentUser.userId } }]
            : []),
        ],
      },
    });
  }

  if (!includeSelfService) {
    mustQuery.push({
      bool: {
        should: [
          { bool: { must_not: { exists: { field: "legacy.selfService" } } } },
          ...(currentUser
            ? [
                {
                  bool: {
                    must: [
                      {
                        bool: {
                          must_not: {
                            match_phrase: {
                              status: constants.challengeStatuses.New,
                            },
                          },
                        },
                      },
                      {
                        bool: {
                          must_not: {
                            match_phrase: {
                              status: constants.challengeStatuses.Draft,
                            },
                          },
                        },
                      },
                      {
                        bool: {
                          must_not: {
                            match_phrase: {
                              status: constants.challengeStatuses.Approved,
                            },
                          },
                        },
                      },
                    ],
                  },
                },
                {
                  bool: {
                    must: { match_phrase: { createdBy: currentUser.handle } },
                  },
                },
              ]
            : [
                {
                  bool: {
                    should: [
                      {
                        bool: {
                          must: {
                            match_phrase: {
                              status: constants.challengeStatuses.Active,
                            },
                          },
                        },
                      },
                      {
                        bool: {
                          must: {
                            match_phrase: {
                              status: constants.challengeStatuses.Completed,
                            },
                          },
                        },
                      },
                    ],
                  },
                },
              ]),
        ],
      },
    });
  }

  if (groupsQuery.length > 0) {
    mustQuery.push({
      bool: {
        should: groupsQuery,
      },
    });
  }

  if (multiMatchQuery) {
    mustQuery.push({
      bool: {
        should: multiMatchQuery,
      },
    });
  }

  if (boolQuery.length > 0) {
    mustQuery.push({
      bool: {
        filter: boolQuery,
      },
    });
  }

  let finalQuery = {
    bool: {},
  };

  if (mustQuery.length > 0) {
    finalQuery.bool.must = mustQuery;
  }
  if (mustNotQuery.length > 0) {
    finalQuery.bool.must_not = mustNotQuery;
    if (!finalQuery.bool.must) {
      finalQuery.bool.must = mustQuery;
    }
  }
  // if none of the above were set, match all
  if (!finalQuery.bool.must) {
    finalQuery = {
      match_all: {},
    };
  }

  const esQuery = {
    index: config.get("ES.ES_INDEX"),
    size: perPage,
    from: (page - 1) * perPage, // Es Index starts from 0
    body: {
      query: finalQuery,
      sort: [
        sortByScore
          ? { _score: { order: "desc" } }
          : {
              [sortByProp]: {
                order: sortOrderProp,
                missing: "_last",
                unmapped_type: "String",
              },
            },
      ],
    },
  };
  // Search with constructed query
  let docs;
  try {
    docs =
      config.get("ES.OPENSEARCH") == "false"
        ? await esClient.search(esQuery)
        : (await esClient.search(esQuery)).body;
  } catch (e) {
    // Catch error when the ES is fresh and has no data
    docs = {
      hits: {
        total: 0,
        hits: [],
      },
    };
  }
  // Extract data from hits
  const total = docs.hits.total;
  let result = _.map(docs.hits.hits, (item) => item._source);

  // Hide privateDescription for non-register challenges
  if (currentUser) {
    if (!currentUser.isMachine && !_hasAdminRole) {
      result = _.each(result, (val) => _.unset(val, "billing"));
      const ids = await helper.listChallengesByMember(currentUser.userId);
      result = _.each(result, (val) => {
        if (!_.includes(ids, val.id)) {
          _.unset(val, "privateDescription");
        }
      });
    }
  } else {
    result = _.each(result, (val) => {
      _.unset(val, "billing");
      _.unset(val, "privateDescription");
      return val;
    });
  }

  if (criteria.isLightweight === "true") {
    result = _.each(result, (val) => {
      // _.unset(val, 'terms')
      _.unset(val, "description");
      _.unset(val, "privateDescription");
      return val;
    });
  }

  const challengeTypeList = await ChallengeTypeService.searchChallengeTypes({});
  const typeMap = new Map();
  _.each(challengeTypeList.result, (e) => {
    typeMap.set(e.id, e.name);
  });

  _.each(result, (element) => {
    element.type = typeMap.get(element.typeId) || "Code";
  });
  _.each(result, async (element) => {
    await getPhasesAndPopulate(element);
    if (element.status !== constants.challengeStatuses.Completed) {
      _.unset(element, "winners");
    }
  });

  return { total, page, perPage, result };
}
searchChallenges.schema = {
  currentUser: Joi.any(),
  criteria: Joi.object()
    .keys({
      page: Joi.page(),
      perPage: Joi.perPage(),
      id: Joi.optionalId(),
      selfService: Joi.boolean(),
      selfServiceCopilot: Joi.string(),
      confidentialityType: Joi.string(),
      directProjectId: Joi.number(),
      typeIds: Joi.array().items(Joi.optionalId()),
      trackIds: Joi.array().items(Joi.optionalId()),
      types: Joi.array().items(Joi.string()),
      tracks: Joi.array().items(Joi.string()),
      typeId: Joi.optionalId(),
      trackId: Joi.optionalId(),
      type: Joi.string(),
      track: Joi.string(),
      name: Joi.string(),
      search: Joi.string(),
      description: Joi.string(),
      timelineTemplateId: Joi.string(), // Joi.optionalId(),
      reviewType: Joi.string(),
      tag: Joi.string(),
      tags: Joi.array().items(Joi.string()),
      includeAllTags: Joi.boolean().default(true),
      projectId: Joi.number().integer().positive(),
      forumId: Joi.number().integer(),
      legacyId: Joi.number().integer().positive(),
      status: Joi.string().valid(_.values(constants.challengeStatuses)),
      group: Joi.string(),
      startDateStart: Joi.date(),
      startDateEnd: Joi.date(),
      endDateStart: Joi.date(),
      endDateEnd: Joi.date(),
      currentPhaseName: Joi.string(),
      createdDateStart: Joi.date(),
      createdDateEnd: Joi.date(),
      updatedDateStart: Joi.date(),
      updatedDateEnd: Joi.date(),
      registrationStartDateStart: Joi.date(),
      registrationStartDateEnd: Joi.date(),
      registrationEndDateStart: Joi.date(),
      registrationEndDateEnd: Joi.date(),
      submissionStartDateStart: Joi.date(),
      submissionStartDateEnd: Joi.date(),
      submissionEndDateStart: Joi.date(),
      submissionEndDateEnd: Joi.date(),
      createdBy: Joi.string(),
      updatedBy: Joi.string(),
      isLightweight: Joi.boolean().default(false),
      memberId: Joi.string(),
      sortBy: Joi.string().valid(_.values(constants.validChallengeParams)),
      sortOrder: Joi.string().valid(["asc", "desc"]),
      groups: Joi.array().items(Joi.optionalId()).unique().min(1),
      ids: Joi.array().items(Joi.optionalId()).unique().min(1),
      isTask: Joi.boolean(),
      taskIsAssigned: Joi.boolean(),
      taskMemberId: Joi.string(),
      events: Joi.array().items(Joi.string()),
      includeAllEvents: Joi.boolean().default(true),
      useSchedulingAPI: Joi.boolean(),
      totalPrizesFrom: Joi.number().min(0),
      totalPrizesTo: Joi.number().min(0),
      tco: Joi.boolean().default(false),
    })
    .unknown(true),
};

/**
 * Create challenge.
 * @param {Object} currentUser the user who perform operation
 * @param {Object} challenge the challenge to created
 * @param {String} userToken the user token
 * @returns {Object} the created challenge
 */
async function createChallenge(currentUser, challenge, userToken) {
  await challengeHelper.validateCreateChallengeRequest(currentUser, challenge);

  if (challenge.legacy.selfService) {
    // if self-service, create a new project (what about if projectId is provided in the payload? confirm with business!)
    if (!challenge.projectId) {
      const selfServiceProjectName = `Self service - ${currentUser.handle} - ${challenge.name}`;
      challenge.projectId = await helper.createSelfServiceProject(
        selfServiceProjectName,
        "N/A",
        config.NEW_SELF_SERVICE_PROJECT_TYPE,
        userToken
      );
    }

    if (challenge.metadata && challenge.metadata.length > 0) {
      for (const entry of challenge.metadata) {
        if (challenge.description.includes(`{{${entry.name}}}`)) {
          challenge.description = challenge.description
            .split(`{{${entry.name}}}`)
            .join(entry.value);
        }
      }
    }
  }

  /** Ensure project exists, and set direct project id, billing account id & markup */
  const { projectId } = challenge;

  const { directProjectId } = await projectHelper.getProject(projectId, currentUser);
  const { billingAccountId, markup } = await projectHelper.getProjectBillingInformation(projectId);

  _.set(challenge, "legacy.directProjectId", directProjectId);
  _.set(challenge, "billing.billingAccountId", billingAccountId);
  _.set(challenge, "billing.markup", markup || 0);

  if (!_.isUndefined(_.get(challenge, "legacy.reviewType"))) {
    _.set(challenge, "legacy.reviewType", _.toUpper(_.get(challenge, "legacy.reviewType")));
  }

  if (!challenge.status) {
    challenge.status = constants.challengeStatuses.New;
  }

  if (!challenge.startDate) {
    challenge.startDate = new Date().toISOString();
  } else {
    challenge.startDate = convertToISOString(challenge.startDate);
  }

  const { track, type } = await challengeHelper.validateAndGetChallengeTypeAndTrack(challenge);

  if (_.get(type, "isTask")) {
    _.set(challenge, "task.isTask", true);
    if (_.isUndefined(_.get(challenge, "task.isAssigned"))) {
      _.set(challenge, "task.isAssigned", false);
    }
    if (_.isUndefined(_.get(challenge, "task.memberId"))) {
      _.set(challenge, "task.memberId", null);
    } else {
      throw new errors.BadRequestError(`Cannot assign a member before the challenge gets created.`);
    }
  }

  if (challenge.phases && challenge.phases.length > 0) {
    await phaseHelper.validatePhases(challenge.phases);
  }

  // populate phases
  if (!challenge.timelineTemplateId) {
    if (challenge.typeId && challenge.trackId) {
      const supportedTemplates =
        await ChallengeTimelineTemplateService.searchChallengeTimelineTemplates({
          typeId: challenge.typeId,
          trackId: challenge.trackId,
          isDefault: true,
        });
      const challengeTimelineTemplate = supportedTemplates.result[0];
      if (!challengeTimelineTemplate) {
        throw new errors.BadRequestError(
          `The selected trackId ${challenge.trackId} and typeId: ${challenge.typeId} does not have a default timeline template. Please provide a timelineTemplateId`
        );
      }
      challenge.timelineTemplateId = challengeTimelineTemplate.timelineTemplateId;
    } else {
      throw new errors.BadRequestError(`trackId and typeId are required to create a challenge`);
    }
  }
  challenge.phases = await phaseHelper.populatePhasesForChallengeCreation(
    challenge.phases,
    challenge.startDate,
    challenge.timelineTemplateId
  );

  // populate challenge terms
  // const projectTerms = await helper.getProjectDefaultTerms(challenge.projectId)
  // challenge.terms = await helper.validateChallengeTerms(_.union(projectTerms, challenge.terms))
  // TODO - challenge terms returned from projects api don't have a role associated
  // this will need to be updated to associate project terms with a roleId
  challenge.terms = await helper.validateChallengeTerms(challenge.terms || []);

  // default the descriptionFormat
  if (!challenge.descriptionFormat) {
    challenge.descriptionFormat = "markdown";
  }

  if (challenge.phases && challenge.phases.length > 0) {
    challenge.endDate = helper.calculateChallengeEndDate(challenge);
  }

  if (challenge.events == null) challenge.events = [];
  if (challenge.attachments == null) challenge.attachments = [];
  if (challenge.prizeSets == null) challenge.prizeSets = [];
  if (challenge.metadata == null) challenge.metadata = [];
  if (challenge.groups == null) challenge.groups = [];
  if (challenge.tags == null) challenge.tags = [];
  if (challenge.startDate != null) challenge.startDate = challenge.startDate;
  if (challenge.endDate != null) challenge.endDate = challenge.endDate;
  if (challenge.discussions == null) challenge.discussions = [];

  challenge.metadata = challenge.metadata.map((m) => ({
    name: m.name,
    value: typeof m.value === "string" ? m.value : JSON.stringify(m.value),
  }));

  const grpcMetadata = new GrpcMetadata();

  grpcMetadata.set("handle", currentUser.handle);
  grpcMetadata.set("userId", currentUser.userId);

  convertPrizeSetValuesToCents(challenge.prizeSets);
  const ret = await challengeDomain.create(challenge, grpcMetadata);
  convertPrizeSetValuesToDollars(ret.prizeSets, ret.overview);

  ret.numOfSubmissions = 0;
  ret.numOfRegistrants = 0;

  enrichChallengeForResponse(ret, track, type);

  // Create in ES
  await esClient.create({
    index: config.get("ES.ES_INDEX"),
    type: config.get("ES.OPENSEARCH") == "false" ? config.get("ES.ES_TYPE") : undefined,
    refresh: config.get("ES.ES_REFRESH"),
    id: ret.id,
    body: ret,
  });

  // If the challenge is self-service, add the creating user as the "client manager", *not* the manager
  // This is necessary for proper handling of the vanilla embed on the self-service work item dashboard

  if (challenge.legacy.selfService) {
    if (currentUser.handle) {
      await helper.createResource(ret.id, ret.createdBy, config.CLIENT_MANAGER_ROLE_ID);
    }
  } else {
    if (currentUser.handle) {
      await helper.createResource(ret.id, ret.createdBy, config.MANAGER_ROLE_ID);
    }
  }

  // post bus event
  await helper.postBusEvent(constants.Topics.ChallengeCreated, ret);

  return ret;
}
createChallenge.schema = {
  currentUser: Joi.any(),
  challenge: Joi.object()
    .keys({
      typeId: Joi.id(),
      trackId: Joi.id(),
      legacy: Joi.object().keys({
        reviewType: Joi.string()
          .valid(_.values(constants.reviewTypes))
          .insensitive()
          .default(constants.reviewTypes.Internal),
        confidentialityType: Joi.string().default(config.DEFAULT_CONFIDENTIALITY_TYPE),
        forumId: Joi.number().integer(),
        directProjectId: Joi.number().integer(),
        screeningScorecardId: Joi.number().integer(),
        reviewScorecardId: Joi.number().integer(),
        isTask: Joi.boolean(),
        useSchedulingAPI: Joi.boolean(),
        pureV5Task: Joi.boolean(),
        pureV5: Joi.boolean(),
        selfService: Joi.boolean(),
        selfServiceCopilot: Joi.string(),
      }),
      billing: Joi.object()
        .keys({
          billingAccountId: Joi.string(),
          markup: Joi.number().min(0).max(100),
        })
        .unknown(true),
      task: Joi.object().keys({
        isTask: Joi.boolean().default(false),
        isAssigned: Joi.boolean().default(false),
        memberId: Joi.string().allow(null),
      }),
      name: Joi.string().required(),
      description: Joi.string(),
      privateDescription: Joi.string(),
      descriptionFormat: Joi.string(),
      metadata: Joi.array()
        .items(
          Joi.object().keys({
            name: Joi.string().required(),
            value: Joi.required(),
          })
        )
        .unique((a, b) => a.name === b.name),
      timelineTemplateId: Joi.string(), // Joi.optionalId(),
      phases: Joi.array().items(
        Joi.object().keys({
          phaseId: Joi.id(),
          duration: Joi.number().integer().min(0),
          constraints: Joi.array()
            .items(
              Joi.object()
                .keys({
                  name: Joi.string(),
                  value: Joi.number().integer().min(0),
                })
                .optional()
            )
            .optional(),
        })
      ),
      events: Joi.array().items(
        Joi.object().keys({
          id: Joi.number().required(),
          name: Joi.string(),
          key: Joi.string(),
        })
      ),
      discussions: Joi.array().items(
        Joi.object().keys({
          id: Joi.optionalId(),
          name: Joi.string().required(),
          type: Joi.string().required().valid(_.values(constants.DiscussionTypes)),
          provider: Joi.string().required(),
          url: Joi.string(),
          options: Joi.array().items(Joi.object()),
        })
      ),
      prizeSets: Joi.array().items(
        Joi.object().keys({
          type: Joi.string().valid(_.values(constants.prizeSetTypes)).required(),
          description: Joi.string(),
          prizes: Joi.array()
            .items(
              Joi.object().keys({
                description: Joi.string(),
                type: Joi.string().required(),
                value: Joi.number().min(0).required(),
              })
            )
            .min(1)
            .required(),
        })
      ),
      tags: Joi.array().items(Joi.string()), // tag names
      projectId: Joi.number().integer().positive(),
      legacyId: Joi.number().integer().positive(),
      startDate: Joi.date().iso(),
      status: Joi.string().valid([
        constants.challengeStatuses.Active,
        constants.challengeStatuses.New,
        constants.challengeStatuses.Draft,
        constants.challengeStatuses.Approved,
      ]),
      groups: Joi.array().items(Joi.optionalId()).unique(),
      // gitRepoURLs: Joi.array().items(Joi.string().uri()),
      terms: Joi.array().items(
        Joi.object().keys({
          id: Joi.id(),
          roleId: Joi.id(),
        })
      ),
    })
    .required(),
  userToken: Joi.string().required(),
};
/**
 * Populate phase data from phase API.
 * @param {Object} the challenge entity
 */
async function getPhasesAndPopulate(data) {
  _.each(data.phases, async (p) => {
    const phase = await phaseHelper.getPhase(p.phaseId);
    p.name = phase.name;
    if (phase.description) {
      p.description = phase.description;
    }
  });
}

/**
 * Get challenge.
 * @param {Object} currentUser the user who perform operation
 * @param {String} id the challenge id
 * @param {Boolean} checkIfExists flag to check if challenge exists
 * @returns {Object} the challenge with given id
 */
async function getChallenge(currentUser, id, checkIfExists) {
  // get challenge from Elasticsearch
  let challenge;
  // logger.warn(JSON.stringify({
  //   index: config.get('ES.ES_INDEX'),
  //   _id: id
  // }))
  try {
    if (config.get("ES.OPENSEARCH") == "true") {
      challenge = (
        await esClient.getSource({
          index: config.get("ES.ES_INDEX"),
          id,
        })
      ).body;
    } else {
      challenge = await esClient.getSource({
        index: config.get("ES.ES_INDEX"),
        type: config.get("ES.ES_TYPE"),
        id,
      });
    }
  } catch (e) {
    if (e.statusCode === HttpStatus.NOT_FOUND) {
      throw new errors.NotFoundError(`Challenge of id ${id} is not found.`);
    } else {
      throw e;
    }
  }
  if (checkIfExists) {
    return _.pick(challenge, ["id", "legacyId"]);
  }
  await helper.ensureUserCanViewChallenge(currentUser, challenge);

  // Remove privateDescription for unregistered users
  if (currentUser) {
    if (!currentUser.isMachine && !hasAdminRole(currentUser)) {
      _.unset(challenge, "billing");
      if (_.isEmpty(challenge.privateDescription)) {
        _.unset(challenge, "privateDescription");
      } else if (
        !_.get(challenge, "task.isTask", false) ||
        !_.get(challenge, "task.isAssigned", false)
      ) {
        const memberResources = await helper.listResourcesByMemberAndChallenge(
          currentUser.userId,
          challenge.id
        );
        if (_.isEmpty(memberResources)) {
          _.unset(challenge, "privateDescription");
        }
      }
    }
  } else {
    _.unset(challenge, "billing");
    _.unset(challenge, "privateDescription");
  }

  if (challenge.phases && challenge.phases.length > 0) {
    await getPhasesAndPopulate(challenge);
  }

  if (challenge.status !== constants.challengeStatuses.Completed) {
    _.unset(challenge, "winners");
  }

  return challenge;
}
getChallenge.schema = {
  currentUser: Joi.any(),
  id: Joi.id(),
  checkIfExists: Joi.boolean(),
};

/**
 * Get challenge statistics
 * @param {Object} currentUser the user who perform operation
 * @param {String} id the challenge id
 * @returns {Object} the challenge with given id
 */
async function getChallengeStatistics(currentUser, id) {
  const challenge = await getChallenge(currentUser, id);
  // for now, only Data Science challenges are supported
  if (challenge.type !== "Challenge" && challenge.track !== "Data Science") {
    throw new errors.BadRequestError(
      `Challenge of type ${challenge.type} and track ${challenge.track} does not support statistics`
    );
  }
  // get submissions
  const submissions = await helper.getChallengeSubmissions(challenge.id);
  // for each submission, load member profile
  const map = {};
  for (const submission of submissions) {
    if (!map[submission.memberId]) {
      // Load member profile and cache
      const member = await helper.getMemberById(submission.memberId);
      map[submission.memberId] = {
        photoUrl: member.photoURL,
        rating: _.get(member, "maxRating.rating", 0),
        ratingColor: _.get(member, "maxRating.ratingColor", "#9D9FA0"),
        homeCountryCode: member.homeCountryCode,
        handle: member.handle,
        submissions: [],
      };
    }
    // add submission
    map[submission.memberId].submissions.push({
      created: submission.created,
      score: _.get(
        _.find(submission.review || [], (r) => r.metadata),
        "score",
        0
      ),
    });
  }
  return _.map(_.keys(map), (userId) => map[userId]);
}
getChallengeStatistics.schema = {
  currentUser: Joi.any(),
  id: Joi.id(),
};

/**
 * Check whether given two PrizeSet Array are different.
 * @param {Array} prizeSets the first PrizeSet Array
 * @param {Array} otherPrizeSets the second PrizeSet Array
 * @returns {Boolean} true if different, false otherwise
 */
function isDifferentPrizeSets(prizeSets = [], otherPrizeSets = []) {
  return !_.isEqual(_.sortBy(prizeSets, "type"), _.sortBy(otherPrizeSets, "type"));
}

/**
 * Validate the winners array.
 * @param {Array} winners the Winner Array
 * @param {String} winchallengeIdners the challenge ID
 */
async function validateWinners(winners, challengeId) {
  const challengeResources = await helper.getChallengeResources(challengeId);
  const registrants = _.filter(challengeResources, (r) => r.roleId === config.SUBMITTER_ROLE_ID);
  for (const prizeType of _.values(constants.prizeSetTypes)) {
    const filteredWinners = _.filter(winners, (w) => w.type === prizeType);
    for (const winner of filteredWinners) {
      if (!_.find(registrants, (r) => _.toString(r.memberId) === _.toString(winner.userId))) {
        throw new errors.BadRequestError(
          `Member with userId: ${winner.userId} is not registered on the challenge`
        );
      }
      const diffWinners = _.differenceWith(filteredWinners, [winner], _.isEqual);
      if (diffWinners.length + 1 !== filteredWinners.length) {
        throw new errors.BadRequestError(
          `Duplicate member with placement: ${helper.toString(winner)}`
        );
      }

      // find another member with the placement
      const placementExists = _.find(diffWinners, function (w) {
        return w.placement === winner.placement;
      });
      if (
        placementExists &&
        (placementExists.userId !== winner.userId || placementExists.handle !== winner.handle)
      ) {
        throw new errors.BadRequestError(
          `Only one member can have a placement: ${winner.placement}`
        );
      }

      // find another placement for a member
      const memberExists = _.find(diffWinners, function (w) {
        return w.userId === winner.userId && w.type === winner.type;
      });
      if (memberExists && memberExists.placement !== winner.placement) {
        throw new errors.BadRequestError(
          `The same member ${winner.userId} cannot have multiple placements`
        );
      }
    }
  }
}

/**
 * Update challenge.
 * @param {Object} currentUser the user who perform operation
 * @param {String} challengeId the challenge id
 * @param {Object} data the challenge data to be updated
 * @param {Boolean} isFull the flag indicate it is a fully update operation.
 * @returns {Object} the updated challenge
 */
async function updateChallenge(currentUser, challengeId, data) {
  const challenge = await challengeDomain.lookup(getLookupCriteria("id", challengeId));
  convertPrizeSetValuesToDollars(challenge.prizeSets, challenge.overview);

  const projectId = _.get(challenge, "projectId");

  const { billingAccountId, markup } = await projectHelper.getProjectBillingInformation(projectId);

  if (billingAccountId && _.isUndefined(_.get(challenge, "billing.billingAccountId"))) {
    _.set(data, "billing.billingAccountId", billingAccountId);
    _.set(data, "billing.markup", markup || 0);
  }

  // Make sure the user cannot change the direct project ID
  if (data.legacy) {
    data.legacy = _.assign({}, challenge.legacy, data.legacy);
    _.set(data, "legacy.directProjectId", challenge.legacy.directProjectId);
  }

  // Remove fields from data that are not allowed to be updated and that match the existing challenge
  data = sanitizeData(sanitizeChallenge(data), challenge);
  console.debug("Sanitized Data:", data);

  await validateChallengeUpdateRequest(currentUser, challenge, data);

  let sendActivationEmail = false;
  let sendSubmittedEmail = false;
  let sendCompletedEmail = false;
  let sendRejectedEmail = false;

  /* BEGIN self-service stuffs */

  // TODO: At some point in the future this should be moved to a Self-Service Challenge Helper

  if (challenge.legacy.selfService) {
    // prettier-ignore
    sendSubmittedEmail = data.status === constants.challengeStatuses.Draft && challenge.status !== constants.challengeStatuses.Draft;

    if (data.metadata && data.metadata.length > 0) {
      let dynamicDescription = _.cloneDeep(data.description || challenge.description);
      for (const entry of data.metadata) {
        const regexp = new RegExp(`{{${entry.name}}}`, "g");
        dynamicDescription = dynamicDescription.replace(regexp, entry.value);
      }
      data.description = dynamicDescription;
    }

    // check if it's a self service challenge and project needs to be activated first
    if (
      (data.status === constants.challengeStatuses.Approved ||
        data.status === constants.challengeStatuses.Active) &&
      challenge.status !== constants.challengeStatuses.Active
    ) {
      try {
        const selfServiceProjectName = `Self service - ${challenge.createdBy} - ${challenge.name}`;
        const workItemSummary = _.get(
          _.find(_.get(challenge, "metadata", []), (m) => m.name === "websitePurpose.description"),
          "value",
          "N/A"
        );
        await helper.activateProject(
          projectId,
          currentUser,
          selfServiceProjectName,
          workItemSummary
        );

        sendActivationEmail = data.status === constants.challengeStatuses.Active;
      } catch (e) {
        await updateChallenge(
          currentUser,
          challengeId,
          {
            ...data,
            status: constants.challengeStatuses.CancelledPaymentFailed,
            cancelReason: `Failed to activate project. Error: ${e.message}. JSON: ${JSON.stringify(
              e
            )}`,
          },
          false
        );
        throw new errors.BadRequestError(
          "Failed to activate the challenge! The challenge has been canceled!"
        );
      }
    }

    if (data.status === constants.challengeStatuses.Draft) {
      try {
        await helper.updateSelfServiceProjectInfo(
          projectId,
          data.endDate || challenge.endDate,
          currentUser
        );
      } catch (e) {
        logger.debug(`There was an error trying to update the project: ${e.message}`);
      }
    }

    if (
      data.status === constants.challengeStatuses.CancelledRequirementsInfeasible ||
      data.status === constants.challengeStatuses.CancelledPaymentFailed
    ) {
      try {
        await helper.cancelProject(challenge.projectId, data.cancelReason, currentUser);
      } catch (e) {
        logger.debug(`There was an error trying to cancel the project: ${e.message}`);
      }
      sendRejectedEmail = true;
    }
  }

  /* END self-service stuffs */

  let isChallengeBeingActivated = false;
  let isChallengeBeingCancelled = false;
  if (data.status) {
    if (data.status === constants.challengeStatuses.Active) {
      if (
        !_.get(challenge, "legacy.pureV5Task") &&
        !_.get(challenge, "legacy.pureV5") &&
        _.isUndefined(_.get(challenge, "legacyId"))
      ) {
        throw new errors.BadRequestError(
          "You cannot activate the challenge as it has not been created on legacy yet. Please try again later or contact support."
        );
      }
      // if activating a challenge, the challenge must have a billing account id
      if (
        (!billingAccountId || billingAccountId === null) &&
        challenge.status === constants.challengeStatuses.Draft
      ) {
        throw new errors.BadRequestError(
          "Cannot Activate this project, it has no active billing account."
        );
      }
      if (challenge.status === constants.challengeStatuses.Draft) {
        isChallengeBeingActivated = true;
      }
    }

    if (
      _.includes(
        [
          constants.challengeStatuses.Cancelled,
          constants.challengeStatuses.CancelledRequirementsInfeasible,
          constants.challengeStatuses.CancelledPaymentFailed,
          constants.challengeStatuses.CancelledFailedReview,
          constants.challengeStatuses.CancelledFailedScreening,
          constants.challengeStatuses.CancelledZeroSubmissions,
          constants.challengeStatuses.CancelledWinnerUnresponsive,
          constants.challengeStatuses.CancelledClientRequest,
          constants.challengeStatuses.CancelledZeroRegistrations,
        ],
        data.status
      )
    ) {
      isChallengeBeingCancelled = true;
    }

    if (data.status === constants.challengeStatuses.Completed) {
      if (
        !_.get(challenge, "legacy.pureV5Task") &&
        !_.get(challenge, "legacy.pureV5") &&
        challenge.status !== constants.challengeStatuses.Active
      ) {
        throw new errors.BadRequestError("You cannot mark a Draft challenge as Completed");
      }
      sendCompletedEmail = true;
    }
  }

  // Only M2M can update url and options of discussions
  if (data.discussions && data.discussions.length > 0) {
    if (challenge.discussions && challenge.discussions.length > 0) {
      for (let i = 0; i < data.discussions.length; i += 1) {
        if (_.isUndefined(data.discussions[i].id)) {
          data.discussions[i].id = uuid();
          if (!currentUser.isMachine) {
            _.unset(data.discussions, "url");
            _.unset(data.discussions, "options");
          }
        } else if (!currentUser.isMachine) {
          const existingDiscussion = _.find(
            _.get(challenge, "discussions", []),
            (d) => d.id === data.discussions[i].id
          );
          if (existingDiscussion) {
            _.assign(data.discussions[i], _.pick(existingDiscussion, ["url", "options"]));
          } else {
            _.unset(data.discussions, "url");
            _.unset(data.discussions, "options");
          }
        }
      }
    } else {
      for (let i = 0; i < data.discussions.length; i += 1) {
        data.discussions[i].id = uuid();
        data.discussions[i].name = data.discussions[i].name.substring(
          0,
          config.FORUM_TITLE_LENGTH_LIMIT
        );
      }
    }
  }

  // TODO: Fix this Tech Debt once legacy is turned off
  const finalStatus = data.status || challenge.status;
  const finalTimelineTemplateId = data.timelineTemplateId || challenge.timelineTemplateId;
  let timelineTemplateChanged = false;
  if (
    !currentUser.isMachine &&
    !hasAdminRole(currentUser) &&
    !_.get(data, "legacy.pureV5") &&
    !_.get(challenge, "legacy.pureV5")
  ) {
    if (
      finalStatus !== constants.challengeStatuses.New &&
      finalTimelineTemplateId !== challenge.timelineTemplateId
    ) {
      throw new errors.BadRequestError(
        `Cannot change the timelineTemplateId for challenges with status: ${finalStatus}`
      );
    }
  } else if (finalTimelineTemplateId !== challenge.timelineTemplateId) {
    // make sure there are no previous phases if the timeline template has changed
    challenge.phases = [];
    timelineTemplateChanged = true;
  }

  if (data.prizeSets) {
    if (
      isDifferentPrizeSets(data.prizeSets, challenge.prizeSets) &&
      finalStatus === constants.challengeStatuses.Completed
    ) {
      throw new errors.BadRequestError(
        `Cannot update prizeSets for challenges with status: ${finalStatus}!`
      );
    }
    const prizeSetsGroup = _.groupBy(data.prizeSets, "type");
    if (prizeSetsGroup[constants.prizeSetTypes.ChallengePrizes]) {
      const totalPrizes = helper.sumOfPrizes(
        prizeSetsGroup[constants.prizeSetTypes.ChallengePrizes][0].prizes
      );
      _.assign(data, { overview: { totalPrizes } });
    }
  }

  let phasesUpdated = false;
  if (
    ((data.phases && data.phases.length > 0) ||
      isChallengeBeingActivated ||
      timelineTemplateChanged) &&
    !isChallengeBeingCancelled
  ) {
    if (
      challenge.status === constants.challengeStatuses.Completed ||
      challenge.status.indexOf(constants.challengeStatuses.Cancelled) > -1
    ) {
      throw new BadRequestError(
        `Challenge phase/start date can not be modified for Completed or Cancelled challenges.`
      );
    }
    const newStartDate = data.startDate || challenge.startDate;
    let newPhases;
    if (timelineTemplateChanged) {
      newPhases = await phaseHelper.populatePhasesForChallengeCreation(
        data.phases,
        newStartDate,
        finalTimelineTemplateId
      );
    } else {
      newPhases = await phaseHelper.populatePhasesForChallengeUpdate(
        challenge.phases,
        data.phases,
        challenge.timelineTemplateId,
        isChallengeBeingActivated
      );
    }
    phasesUpdated = true;
    data.phases = newPhases;
  }
  if (isChallengeBeingCancelled && challenge.phases && challenge.phases.length > 0) {
    data.phases = phaseHelper.handlePhasesAfterCancelling(challenge.phases);
    phasesUpdated = true;
  }
  if (phasesUpdated || data.startDate) {
    data.startDate = convertToISOString(_.min(_.map(data.phases, "scheduledStartDate")));
  }
  if (phasesUpdated || data.endDate) {
    data.endDate = convertToISOString(_.max(_.map(data.phases, "scheduledEndDate")));
  }

  if (data.winners && data.winners.length && data.winners.length > 0) {
    await validateWinners(data.winners, challengeId);
  }

  // Only m2m tokens are allowed to modify the `task.*` information on a challenge
  if (!_.isUndefined(_.get(data, "task")) && !currentUser.isMachine) {
    if (!_.isUndefined(_.get(challenge, "task"))) {
      logger.info(
        `User ${
          currentUser.handle || currentUser.sub
        } is not allowed to modify the task information on challenge ${challengeId}`
      );
      data.task = challenge.task;
      logger.info(
        `Task information on challenge ${challengeId} is reset to ${JSON.stringify(
          challenge.task
        )}. Original data: ${JSON.stringify(data.task)}`
      );
    } else {
      delete data.task;
    }
  }

  // task.memberId goes out of sync due to another processor setting "task.memberId" but subsequent immediate update to the task
  // will not have the memberId set. So we need to set it using winners to ensure it is always in sync. The proper fix is to correct
  // the sync issue in the processor. However this is quick fix that works since winner.userId is task.memberId.
  if (_.get(challenge, "legacy.pureV5Task") && !_.isUndefined(data.winners)) {
    const winnerMemberId = _.get(data.winners, "[0].userId");
    logger.info(
      `Setting task.memberId to ${winnerMemberId} for challenge ${challengeId}. Task ${_.get(
        data,
        "task"
      )} - ${_.get(challenge, "task")}`
    );

    if (winnerMemberId != null && _.get(data, "task.memberId") !== winnerMemberId) {
      logger.info(`Task ${challengeId} has a winner ${winnerMemberId}`);
      data.task = {
        isTask: true,
        isAssigned: true,
        memberId: winnerMemberId,
      };
      logger.warn(
        `task.memberId mismatched with winner memberId. task.memberId is updated to ${winnerMemberId}`
      );
    } else {
      logger.info(`task ${challengeId} has no winner set yet.`);
    }
  } else {
    logger.info(`${challengeId} is not a pureV5 challenge or has no winners set yet.`);
  }

  const { track, type } = await challengeHelper.validateAndGetChallengeTypeAndTrack({
    typeId: challenge.typeId,
    trackId: challenge.trackId,
    timelineTemplateId: timelineTemplateChanged
      ? finalTimelineTemplateId
      : challenge.timelineTemplateId,
  });

  if (_.get(type, "isTask")) {
    if (!_.isEmpty(_.get(data, "task.memberId"))) {
      const challengeResources = await helper.getChallengeResources(challengeId);
      const registrants = _.filter(
        challengeResources,
        (r) => r.roleId === config.SUBMITTER_ROLE_ID
      );
      if (
        !_.find(
          registrants,
          (r) => _.toString(r.memberId) === _.toString(_.get(data, "task.memberId"))
        )
      ) {
        throw new errors.BadRequestError(
          `Member ${_.get(
            data,
            "task.memberId"
          )} is not a submitter resource of challenge ${challengeId}`
        );
      }
    }
  }

  if (!_.isUndefined(data.terms)) {
    await helper.validateChallengeTerms(data.terms);
  }

  if (data.phases && data.phases.length > 0) {
    await getPhasesAndPopulate(data);

    if (deepEqual(data.phases, challenge.phases)) {
      delete data.phases;
    }
  }

  try {
    const updateInput = sanitizeRepeatedFieldsInUpdateRequest(_.omit(data, ["cancelReason"]));
    if (!_.isEmpty(updateInput)) {
      const grpcMetadata = new GrpcMetadata();

      grpcMetadata.set("handle", currentUser.handle);
      grpcMetadata.set("userId", currentUser.userId);

      if (updateInput.prizeSetUpdate != null) {
        convertPrizeSetValuesToCents(updateInput.prizeSetUpdate.prizeSets);
      }
      await challengeDomain.update(
        {
          filterCriteria: getScanCriteria({ id: challengeId }),
          updateInput,
        },
        grpcMetadata
      );
    }
  } catch (e) {
    throw e;
  }

  const updatedChallenge = await challengeDomain.lookup(getLookupCriteria("id", challengeId));
  convertPrizeSetValuesToDollars(updatedChallenge.prizeSets, updatedChallenge.overview);

  // post bus event
  logger.debug(
    `Post Bus Event: ${constants.Topics.ChallengeUpdated} ${JSON.stringify(updatedChallenge)}`
  );

  enrichChallengeForResponse(updatedChallenge, track, type);

  await helper.postBusEvent(constants.Topics.ChallengeUpdated, updatedChallenge, {
    key:
      updatedChallenge.status === "Completed"
        ? `${updatedChallenge.id}:${updatedChallenge.status}`
        : undefined,
  });

  // Update ES
  await esClient.update({
    index: config.get("ES.ES_INDEX"),
    type: config.get("ES.OPENSEARCH") == "false" ? config.get("ES.ES_TYPE") : undefined,
    refresh: config.get("ES.ES_REFRESH"),
    id: challengeId,
    body: {
      doc: updatedChallenge,
    },
  });

  if (updatedChallenge.legacy.selfService) {
    const creator = await helper.getMemberByHandle(updatedChallenge.createdBy);
    if (sendSubmittedEmail) {
      await helper.sendSelfServiceNotification(
        constants.SelfServiceNotificationTypes.WORK_REQUEST_SUBMITTED,
        [{ email: creator.email }],
        {
          handle: creator.handle,
          workItemName: updatedChallenge.name,
        }
      );
    }
    if (sendActivationEmail) {
      await helper.sendSelfServiceNotification(
        constants.SelfServiceNotificationTypes.WORK_REQUEST_STARTED,
        [{ email: creator.email }],
        {
          handle: creator.handle,
          workItemName: updatedChallenge.name,
          workItemUrl: `${config.SELF_SERVICE_APP_URL}/work-items/${updatedChallenge.id}`,
        }
      );
    }
    if (sendCompletedEmail) {
      await helper.sendSelfServiceNotification(
        constants.SelfServiceNotificationTypes.WORK_COMPLETED,
        [{ email: creator.email }],
        {
          handle: creator.handle,
          workItemName: updatedChallenge.name,
          workItemUrl: `${config.SELF_SERVICE_APP_URL}/work-items/${updatedChallenge.id}?tab=solutions`,
        }
      );
    }
    if (sendRejectedEmail || data.cancelReason) {
      logger.debug("Should send redirected email");
      await helper.sendSelfServiceNotification(
        constants.SelfServiceNotificationTypes.WORK_REQUEST_REDIRECTED,
        [{ email: creator.email }],
        {
          handle: creator.handle,
          workItemName: updatedChallenge.name,
        }
      );
    }
  }

  return updatedChallenge;
}

updateChallenge.schema = {
  currentUser: Joi.any(),
  challengeId: Joi.id(),
  data: Joi.object()
    .keys({
      legacy: Joi.object()
        .keys({
          track: Joi.string(),
          subTrack: Joi.string(),
          reviewType: Joi.string()
            .valid(_.values(constants.reviewTypes))
            .insensitive()
            .default(constants.reviewTypes.Internal),
          confidentialityType: Joi.string()
            .allow(null, "")
            .empty(null, "")
            .default(config.DEFAULT_CONFIDENTIALITY_TYPE),
          directProjectId: Joi.number(),
          forumId: Joi.number().integer(),
          isTask: Joi.boolean(),
          useSchedulingAPI: Joi.boolean(),
          pureV5Task: Joi.boolean(),
          pureV5: Joi.boolean(),
          selfService: Joi.boolean(),
          selfServiceCopilot: Joi.string().allow(null),
        })
        .unknown(true),
      cancelReason: Joi.string().optional(),
      task: Joi.object()
        .keys({
          isTask: Joi.boolean().default(false),
          isAssigned: Joi.boolean().default(false),
          memberId: Joi.alternatives().try(Joi.string().allow(null), Joi.number().allow(null)),
        })
        .optional(),
      billing: Joi.object()
        .keys({
          billingAccountId: Joi.string(),
          markup: Joi.number().min(0).max(100),
        })
        .unknown(true),
      trackId: Joi.optionalId(),
      typeId: Joi.optionalId(),
      name: Joi.string().optional(),
      description: Joi.string().optional(),
      privateDescription: Joi.string().allow("").optional(),
      descriptionFormat: Joi.string().optional(),
      metadata: Joi.array()
        .items(
          Joi.object()
            .keys({
              name: Joi.string().required(),
              value: Joi.required(),
            })
            .unknown(true)
        )
        .unique((a, b) => a.name === b.name),
      timelineTemplateId: Joi.string().optional(), // changing this to update migrated challenges
      phases: Joi.array()
        .items(
          Joi.object()
            .keys({
              phaseId: Joi.id(),
              duration: Joi.number().integer().min(0),
              isOpen: Joi.boolean(),
              actualEndDate: Joi.date().allow(null),
              scheduledStartDate: Joi.date().allow(null),
              constraints: Joi.array()
                .items(
                  Joi.object()
                    .keys({
                      name: Joi.string(),
                      value: Joi.number().integer().min(0),
                    })
                    .optional()
                )
                .optional(),
            })
            .unknown(true)
        )
        .min(1)
        .optional(),
      events: Joi.array().items(
        Joi.object()
          .keys({
            id: Joi.number().required(),
            name: Joi.string(),
            key: Joi.string(),
          })
          .unknown(true)
          .optional()
      ),
      discussions: Joi.array()
        .items(
          Joi.object().keys({
            id: Joi.optionalId(),
            name: Joi.string().required(),
            type: Joi.string().required().valid(_.values(constants.DiscussionTypes)),
            provider: Joi.string().required(),
            url: Joi.string(),
            options: Joi.array().items(Joi.object()),
          })
        )
        .optional(),
      startDate: Joi.date().iso(),
      prizeSets: Joi.array()
        .items(
          Joi.object()
            .keys({
              type: Joi.string().valid(_.values(constants.prizeSetTypes)).required(),
              description: Joi.string(),
              prizes: Joi.array()
                .items(
                  Joi.object().keys({
                    description: Joi.string(),
                    type: Joi.string().required(),
                    value: Joi.number().min(0).required(),
                  })
                )
                .min(1)
                .required(),
            })
            .unknown(true)
        )
        .min(1),
      tags: Joi.array().items(Joi.string().required()).min(1), // tag names
      projectId: Joi.number().integer().positive(),
      legacyId: Joi.number().integer().positive(),
      status: Joi.string().valid(_.values(constants.challengeStatuses)),
      attachments: Joi.array().items(
        Joi.object().keys({
          id: Joi.id(),
          challengeId: Joi.id(),
          name: Joi.string().required(),
          url: Joi.string().uri().required(),
          fileSize: Joi.fileSize(),
          description: Joi.string(),
        })
      ),
      groups: Joi.array().items(Joi.optionalId()).unique(),
      // gitRepoURLs: Joi.array().items(Joi.string().uri()),
      winners: Joi.array()
        .items(
          Joi.object()
            .keys({
              userId: Joi.number().integer().positive().required(),
              handle: Joi.string().required(),
              placement: Joi.number().integer().positive().required(),
              type: Joi.string()
                .valid(_.values(constants.prizeSetTypes))
                .default(constants.prizeSetTypes.ChallengePrizes),
            })
            .unknown(true)
        )
        .optional(),
      terms: Joi.array().items(
        Joi.object().keys({
          id: Joi.id(),
          roleId: Joi.id(),
        })
      ),
      overview: Joi.any().forbidden(),
    })
    .unknown(true)
    .required(),
};

/**
 * Send notifications
 * @param {Object} currentUser the current use
 * @param {String} challengeId the challenge id
 */
async function sendNotifications(currentUser, challengeId) {
  const challenge = await getChallenge(currentUser, challengeId);
  const creator = await helper.getMemberByHandle(challenge.createdBy);
  if (challenge.status === constants.challengeStatuses.Completed) {
    await helper.sendSelfServiceNotification(
      constants.SelfServiceNotificationTypes.WORK_COMPLETED,
      [{ email: creator.email }],
      {
        handle: creator.handle,
        workItemName: challenge.name,
        workItemUrl: `${config.SELF_SERVICE_APP_URL}/work-items/${challenge.id}?tab=solutions`,
      }
    );
    return { type: constants.SelfServiceNotificationTypes.WORK_COMPLETED };
  }
}

sendNotifications.schema = {
  currentUser: Joi.any(),
  challengeId: Joi.id(),
};

/**
 * Remove unwanted properties from the challenge object
 * @param {Object} challenge the challenge object
 */
function sanitizeChallenge(challenge) {
  const sanitized = _.pick(challenge, [
    "trackId",
    "typeId",
    "name",
    "description",
    "privateDescription",
    "descriptionFormat",
    "timelineTemplateId",
    "tags",
    "projectId",
    "legacyId",
    "startDate",
    "status",
    "task",
    "groups",
    "cancelReason",
  ]);
  if (!_.isUndefined(sanitized.name)) {
    sanitized.name = xss(sanitized.name);
  }
  if (!_.isUndefined(sanitized.description)) {
    sanitized.description = xss(sanitized.description);
  }
  if (challenge.legacy) {
    sanitized.legacy = _.pick(challenge.legacy, [
      "track",
      "subTrack",
      "reviewType",
      "confidentialityType",
      "forumId",
      "directProjectId",
      "screeningScorecardId",
      "reviewScorecardId",
      "isTask",
      "useSchedulingAPI",
      "pureV5Task",
      "pureV5",
      "selfService",
      "selfServiceCopilot",
    ]);
  }
  if (challenge.billing) {
    sanitized.billing = _.pick(challenge.billing, ["billingAccountId", "markup"]);
  }
  if (challenge.metadata) {
    sanitized.metadata = _.map(challenge.metadata, (meta) => _.pick(meta, ["name", "value"]));
  }
  if (challenge.phases) {
    sanitized.phases = _.map(challenge.phases, (phase) =>
      _.pick(phase, ["phaseId", "duration", "scheduledStartDate", "constraints"])
    );
  }
  if (challenge.prizeSets) {
    sanitized.prizeSets = _.map(challenge.prizeSets, (prizeSet) => ({
      ..._.pick(prizeSet, ["type", "description"]),
      prizes: _.map(prizeSet.prizes, (prize) => _.pick(prize, ["description", "type", "value"])),
    }));
  }
  if (challenge.events) {
    sanitized.events = _.map(challenge.events, (event) => _.pick(event, ["id", "name", "key"]));
  }
  if (challenge.winners) {
    sanitized.winners = _.map(challenge.winners, (winner) =>
      _.pick(winner, ["userId", "handle", "placement", "type"])
    );
  }
  if (challenge.discussions) {
    sanitized.discussions = _.map(challenge.discussions, (discussion) => ({
      ..._.pick(discussion, ["id", "provider", "name", "type", "url", "options"]),
      name: _.get(discussion, "name", "").substring(0, config.FORUM_TITLE_LENGTH_LIMIT),
    }));
  }
  if (challenge.terms) {
    sanitized.terms = _.map(challenge.terms, (term) => _.pick(term, ["id", "roleId"]));
  }
  if (challenge.attachments) {
    sanitized.attachments = _.map(challenge.attachments, (attachment) =>
      _.pick(attachment, ["id", "name", "url", "fileSize", "description", "challengeId"])
    );
  }

  return sanitized;
}

function sanitizeData(data, challenge) {
  for (const key in data) {
    if (key === "phases") continue;

    if (challenge.hasOwnProperty(key)) {
      if (
        (typeof data[key] === "object" || Array.isArray(data[key])) &&
        deepEqual(data[key], challenge[key])
      ) {
        delete data[key];
      } else if (
        typeof data[key] !== "object" &&
        !Array.isArray(data[key]) &&
        data[key] === challenge[key]
      ) {
        delete data[key];
      }
    }
  }
  return data;
}

/**
 * Delete challenge.
 * @param {Object} currentUser the user who perform operation
 * @param {String} challengeId the challenge id
 * @returns {Object} the deleted challenge
 */
async function deleteChallenge(currentUser, challengeId) {
  const { items } = await challengeDomain.scan({
    criteria: getScanCriteria({ id: challengeId, status: constants.challengeStatuses.New }),
  });
  const challenge = _.first(items);
  if (!challenge) {
    throw new errors.NotFoundError(
      `Challenge with id: ${challengeId} doesn't exist or is not in New status`
    );
  }
  // ensure user can modify challenge
  await helper.ensureUserCanModifyChallenge(currentUser, challenge);
  // delete DB record
  const { items: deletedItems } = await challengeDomain.delete(
    getLookupCriteria("id", challengeId)
  );
  if (!_.find(deletedItems, { id: challengeId })) {
    throw new errors.Internal(`There was an error deleting the challenge with id: ${challengeId}`);
  }
  // delete ES document
  await esClient.delete({
    index: config.get("ES.ES_INDEX"),
    refresh: config.get("ES.ES_REFRESH"),
    type: config.get("ES.OPENSEARCH") == "false" ? config.get("ES.ES_TYPE") : undefined,
    id: challengeId,
  });
  await helper.postBusEvent(constants.Topics.ChallengeDeleted, {
    id: challengeId,
  });
  return challenge;
}

deleteChallenge.schema = {
  currentUser: Joi.any(),
  challengeId: Joi.id(),
};

module.exports = {
  searchChallenges,
  createChallenge,
  getChallenge,
  updateChallenge,
  deleteChallenge,
  getChallengeStatistics,
  sendNotifications,
};

logger.buildService(module.exports);