Peacock/components/candle/challengeService.ts

/*
 *     The Peacock Project - a HITMAN server replacement.
 *     Copyright (C) 2021-2022 The Peacock Project Team
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Affero General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Affero General Public License for more details.
 *
 *     You should have received a copy of the GNU Affero General Public License
 *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import type {
    ChallengeProgressionData,
    ClientToServerEvent,
    CompiledChallengeTreeCategory,
    CompiledChallengeTreeData,
    ContractSession,
    GameVersion,
    PeacockLocationsData,
    RegistryChallenge,
} from "../types/types"
import { getUserData, writeUserData } from "../databaseHandler"

import { Controller } from "../controller"
import {
    generateCompletionData,
    generateUserCentric,
    getSubLocationFromContract,
} from "../contracts/dataGen"
import { log, LogLevel } from "../loggingInterop"
import {
    parseContextListeners,
    ParsedContextListenerInfo,
} from "../statemachines/contextListeners"
import {
    handleEvent,
    HandleEventOptions,
    Timer,
} from "@peacockproject/statemachine-parser"
import { SavedChallengeGroup } from "../types/challenges"
import { fastClone } from "../utils"
import {
    ChallengeFilterOptions,
    ChallengeFilterType,
    filterChallenge,
} from "./challengeHelpers"
import assert from "assert"
import { getVersionedConfig } from "../configSwizzleManager"
import { SyncHook } from "../hooksImpl"

/**
 * The structure for a pending write to a user's challenge progression data.
 */
type PendingProgressionWrite = {
    userId: string
    challengeId: string
    gameVersion: GameVersion
    progression: ChallengeProgressionData
}

type ChallengeDefinitionLike = {
    Context?: Record<string, unknown>
}

type GroupIndexedChallengeLists = {
    [groupId: string]: RegistryChallenge[]
}

/**
 * A base class providing challenge registration support.
 */
export abstract class ChallengeRegistry {
    protected challenges: Map<string, RegistryChallenge> = new Map()
    protected groups: Map<string, SavedChallengeGroup> = new Map()
    protected groupContents: Map<string, Set<string>> = new Map()
    /**
     * A map of a challenge ID to a list of challenge IDs that it depends on.
     */
    protected readonly _dependencyTree: Map<string, readonly string[]> =
        new Map()

    protected constructor(protected readonly controller: Controller) {}

    registerChallenge(challenge: RegistryChallenge, groupId: string): void {
        challenge.inGroup = groupId
        this.challenges.set(challenge.Id, challenge)

        if (!this.groupContents.has(groupId)) {
            this.groupContents.set(groupId, new Set())
        }

        const set = this.groupContents.get(groupId)!
        set.add(challenge.Id)
        this.groupContents.set(groupId, set)

        this.checkHeuristics(challenge)
    }

    registerGroup(group: SavedChallengeGroup): void {
        this.groups.set(group.CategoryId, group)
    }

    getChallengeById(challengeId: string): RegistryChallenge | undefined {
        return this.challenges.get(challengeId)
    }

    getGroupById(groupId: string): SavedChallengeGroup | undefined {
        return this.groups.get(groupId)
    }

    getDependenciesForChallenge(challengeId: string): readonly string[] {
        return this._dependencyTree.get(challengeId) || []
    }

    protected checkHeuristics(challenge: RegistryChallenge): void {
        const ctxListeners = ChallengeRegistry._parseContextListeners(challenge)

        if (ctxListeners.challengeTreeIds.length > 0) {
            this._dependencyTree.set(
                challenge.Id,
                ctxListeners.challengeTreeIds,
            )
        }
    }

    /**
     * Parse a challenge's context listeners into the format used internally.
     *
     * @param challenge The challenge.
     * @returns The context listener details.
     */
    protected static _parseContextListeners(
        challenge: RegistryChallenge,
    ): ParsedContextListenerInfo {
        return parseContextListeners(
            challenge.Definition?.ContextListeners || {},
            {
                ...(challenge.Definition?.Context || {}),
                ...(challenge.Definition?.Constants || {}),
            },
        )
    }
}

export class ChallengeService extends ChallengeRegistry {
    private readonly _challengeContexts: {
        [sessionId: string]: {
            [challengeId: string]: {
                context: unknown
                state: string
                timers: Timer[]
            }
        }
    }
    // we'll use this after writing details to the user's profile
    private _justCompletedChallengeIds: string[] = []
    public hooks: {
        /**
         * A hook that is called when a challenge is completed.
         *
         * Params:
         * - userId: The user's ID.
         * - challenge: The challenge.
         * - gameVersion: The game version.
         */
        onChallengeCompleted: SyncHook<[string, RegistryChallenge, GameVersion]>
    }

    constructor(controller: Controller) {
        super(controller)
        this._challengeContexts = {}
        this.hooks = {
            onChallengeCompleted: new SyncHook(),
        }
    }

    getBatchChallengeProgression(
        userId: string,
        gameVersion: GameVersion,
    ): Record<string, ChallengeProgressionData> {
        const userData = getUserData(userId, gameVersion)

        userData.Extensions.PeacockChallengeProgression ??= {}

        return userData.Extensions.PeacockChallengeProgression
    }

    getChallengeProgression(
        userId: string,
        challengeId: string,
        gameVersion: GameVersion,
        batchedData?: Record<string, ChallengeProgressionData>,
    ): ChallengeProgressionData {
        const data =
            batchedData ||
            this.getBatchChallengeProgression(userId, gameVersion)

        const challenge = this.getChallengeById(challengeId)

        if (this._justCompletedChallengeIds.includes(challengeId)) {
            return {
                ChallengeId: challengeId,
                ProfileId: userId,
                Completed: true,
                State: {
                    CurrentState: "Success",
                },
                ETag: "",
                CompletedAt: null,
                MustBeSaved: true,
            }
        }

        // prevent game crash
        if (data[challengeId]?.Completed) {
            data[challengeId].State = {
                CurrentState: "Success",
            }
        }

        return (
            data[challengeId] || {
                ChallengeId: challengeId,
                ProfileId: userId,
                Completed: false,
                State: (<ChallengeDefinitionLike>challenge?.Definition)
                    ?.Context,
                ETag: "",
                CompletedAt: null,
                MustBeSaved: true,
            }
        )
    }

    /**
     * Get challenge lists sorted into groups.
     *
     * @param locationId The parent location's ID.
     * @param filter The filter to use.
     */
    getGroupedChallengeLists(
        locationId: string,
        filter: ChallengeFilterOptions,
    ): GroupIndexedChallengeLists {
        let challenges: [string, RegistryChallenge[]][] = []

        for (const groupId of this.groups.keys()) {
            const groupContents = this.groupContents.get(groupId)

            if (groupContents) {
                let groupChallenges: RegistryChallenge[] | string[] = [
                    ...groupContents,
                ]

                groupChallenges = groupChallenges
                    .map((challengeId) => {
                        const challenge = this.getChallengeById(challengeId)

                        // early return if the challenge is falsy
                        if (!challenge) {
                            return challenge
                        }

                        return filterChallenge(filter, challenge)
                            ? challenge
                            : undefined
                    })
                    .filter(Boolean) as RegistryChallenge[]

                challenges.push([groupId, [...groupChallenges]])
            }
        }

        // remove empty groups
        challenges = challenges.filter(
            ([, challenges]) => challenges.length > 0,
        )

        return Object.fromEntries(challenges)
    }

    getChallengesForContract(
        contractId: string,
        gameVersion: GameVersion,
    ): GroupIndexedChallengeLists {
        const contract = this.controller.resolveContract(contractId)

        assert.ok(contract)

        const contractParentLocation = getSubLocationFromContract(
            contract,
            gameVersion,
        )?.Properties.ParentLocation

        assert.ok(contractParentLocation)

        return this.getGroupedChallengeLists(contractParentLocation, {
            type: ChallengeFilterType.Contract,
            contractId: contractId,
            locationId: contract.Metadata.Location,
            locationParentId: contractParentLocation,
        })
    }

    startContract(
        userId: string,
        sessionId: string,
        session: ContractSession,
    ): void {
        this._challengeContexts[sessionId] = {}
        const { gameVersion, contractId } = session

        const challengeGroups = this.getChallengesForContract(
            contractId,
            session.gameVersion,
        )
        const batchChallengeProgression = this.getBatchChallengeProgression(
            userId,
            gameVersion,
        )

        const writeQueue: PendingProgressionWrite[] = []

        for (const group of Object.keys(challengeGroups)) {
            for (const challenge of challengeGroups[group]) {
                let progression = batchChallengeProgression[challenge.Id]

                if (!progression) {
                    const ctx = fastClone(
                        (<ChallengeDefinitionLike>challenge.Definition)
                            ?.Context,
                    )

                    progression = {
                        ChallengeId: challenge.Id,
                        ProfileId: userId,
                        Completed: false,
                        State: ctx,
                        ETag: "",
                        CompletedAt: null,
                        MustBeSaved: true,
                    }

                    writeQueue.push({
                        userId,
                        gameVersion,
                        progression,
                        challengeId: challenge.Id,
                    })
                }

                this._challengeContexts[sessionId][challenge.Id] = {
                    context:
                        fastClone(challenge.Definition?.Context || {}) || {},
                    state: progression.Completed ? "Success" : "Start",
                    timers: [],
                }
            }
        }

        this.writePendingProgression(writeQueue, userId, gameVersion)
    }

    onContractEvent(
        event: ClientToServerEvent,
        sessionId: string,
        session: ContractSession,
    ): void {
        const writeQueue: PendingProgressionWrite[] = []

        for (const challengeId of Object.keys(
            this._challengeContexts[sessionId],
        )) {
            const challenge = this.getChallengeById(challengeId)
            const data = this._challengeContexts[sessionId][challengeId]

            if (!challenge) {
                log(LogLevel.WARN, `Challenge ${challengeId} not found`)
                continue
            }

            try {
                const options: HandleEventOptions = {
                    eventName: event.Name,
                    currentState: data.state,
                    timers: data.timers,
                    timestamp: event.Timestamp,
                }

                const previousState = data.state

                const result = handleEvent(
                    // @ts-expect-error Needs to be fixed upstream.
                    challenge.Definition,
                    fastClone(data.context),
                    event.Value,
                    options,
                )

                this._challengeContexts[sessionId][challengeId].state =
                    result.state
                this._challengeContexts[sessionId][challengeId].context =
                    result.context || challenge.Definition?.Context || {}

                if (previousState !== "Success" && result.state === "Success") {
                    this.hooks.onChallengeCompleted.call(
                        session.userId,
                        challenge,
                        session.gameVersion,
                    )

                    this._justCompletedChallengeIds.push(challengeId)

                    writeQueue.push({
                        challengeId,
                        gameVersion: session.gameVersion,
                        userId: session.userId,
                        progression: {
                            ChallengeId: challenge.Id,
                            ProfileId: session.userId,
                            Completed: true,
                            State: (
                                challenge.Definition as ChallengeDefinitionLike
                            ).Context,
                            ETag: "",
                            CompletedAt: new Date().toISOString(),
                            MustBeSaved: true,
                        },
                    })

                    this.checkWaterfallCompletion(
                        writeQueue,
                        session,
                        challenge,
                    )
                }
            } catch (e) {
                log(LogLevel.ERROR, e)
            }
        }

        this.writePendingProgression(
            writeQueue,
            session.userId,
            session.gameVersion,
        )
    }

    // TODO: Rewrite this function out, as we can just modify the context!
    writePendingProgression(
        writeQueue: PendingProgressionWrite[],
        userId: string,
        gameVersion: GameVersion,
    ): void {
        if (writeQueue.length === 0) {
            return
        }

        const userData = getUserData(userId, gameVersion)

        userData.Extensions.PeacockChallengeProgression ??= {}

        for (const write of writeQueue) {
            userData.Extensions.PeacockChallengeProgression[write.challengeId] =
                write.progression
        }

        writeUserData(userId, gameVersion)
    }

    /**
     * Get the challenge tree for a contract.
     *
     * @param contractId The ID of the contract.
     * @param gameVersion The game version requesting the challenges.
     * @param userId The user requesting the challenges' ID.
     * @returns The challenge tree.
     */
    getChallengeTreeForContract(
        contractId: string,
        gameVersion: GameVersion,
        userId: string,
    ): CompiledChallengeTreeCategory[] {
        const contractData = this.controller.resolveContract(contractId)

        if (!contractData) {
            log(LogLevel.WARN, `Contract ${contractId} not found`)
            return []
        }

        const subLocation = getSubLocationFromContract(
            contractData,
            gameVersion,
        )

        if (!subLocation) {
            log(
                LogLevel.WARN,
                `Failed to get location data in CTREE [${contractData.Metadata.Location}]`,
            )
            return []
        }

        const forContract = this.getChallengesForContract(
            contractId,
            gameVersion,
        )

        return Object.entries(forContract).map(
            ([groupId, challenges], index) => {
                const groupData = this.getGroupById(groupId)
                const challengeProgressionData = challenges.map(
                    (challengeData) =>
                        this.getChallengeProgression(
                            userId,
                            challengeData.Id,
                            gameVersion,
                        ),
                )

                assert.ok(groupData, `Group ${groupId} not found`)

                const lastGroup = this.getGroupById(
                    Object.keys(forContract)[index - 1],
                )
                const nextGroup = this.getGroupById(
                    Object.keys(forContract)[index + 1],
                )

                return {
                    Name: groupData.Name,
                    Description: groupData.Description,
                    Image: groupData.Image,
                    CategoryId: groupData.CategoryId,
                    Icon: groupData.Icon,
                    CompletedChallengesCount: challengeProgressionData.filter(
                        (progressionData) => progressionData.Completed,
                    ).length,
                    ChallengesCount: challenges.length,
                    CompletionData: generateCompletionData(
                        contractData.Metadata.Location,
                        userId,
                        gameVersion,
                    ),
                    Location: subLocation,
                    IsLocked: subLocation.Properties.IsLocked || false,
                    ImageLocked: subLocation.Properties.LockedIcon || "",
                    RequiredResources:
                        subLocation.Properties.RequiredResources!,
                    SwitchData: {
                        Data: {
                            Challenges: this.mapSwitchChallenges(
                                challenges,
                                userId,
                                gameVersion,
                            ),
                            HasPrevious: index !== 0, // whether we are not at the first group
                            HasNext:
                                index !== Object.keys(forContract).length - 1, // whether we are not at the final group
                            PreviousCategoryIcon:
                                index !== 0 ? lastGroup?.Icon : "",
                            NextCategoryIcon:
                                index !== Object.keys(forContract).length - 1
                                    ? nextGroup?.Icon
                                    : "",
                            CategoryData: {
                                Name: groupData.Name,
                                Image: groupData.Image,
                                Icon: groupData.Icon,
                                ChallengesCount: challenges.length,
                                CompletedChallengesCount:
                                    challengeProgressionData.filter(
                                        (progressionData) =>
                                            progressionData.Completed,
                                    ).length,
                            },
                            CompletionData: generateCompletionData(
                                contractData.Metadata.Location,
                                userId,
                                gameVersion,
                            ),
                        },
                        IsLeaf: true,
                    },
                }
            },
        )
    }

    private mapSwitchChallenges(
        challenges: RegistryChallenge[],
        userId: string,
        gameVersion: GameVersion,
    ): CompiledChallengeTreeData[] {
        return challenges.map((challengeData) => {
            // Handle challenge dependencies
            const dependencies = this.getDependenciesForChallenge(
                challengeData.Id,
            )
            const completed: string[] = []
            const missing: string[] = []

            for (const dependency of dependencies) {
                if (
                    this.getChallengeProgression(
                        userId,
                        challengeData.Id,
                        gameVersion,
                    ).Completed
                ) {
                    completed.push(dependency)
                    continue
                }

                missing.push(dependency)
            }

            const compiled = this.compileRegistryChallengeTreeData(
                challengeData,
                this.getChallengeProgression(
                    userId,
                    challengeData.Id,
                    gameVersion,
                ),
                gameVersion,
                userId,
            )

            const { challengeCountData } =
                ChallengeService._parseContextListeners(challengeData)

            if (dependencies.length > 0) {
                compiled.ChallengeProgress = {
                    count: completed.length,
                    completed,
                    total: dependencies.length,
                    missing: missing.length,
                    all: dependencies,
                }
            } else if (challengeCountData.total > 0) {
                compiled.ChallengeProgress = {
                    count: challengeCountData.count,
                    total: challengeCountData.total,
                }
            } else {
                compiled.ChallengeProgress = null
            }

            return compiled
        })
    }

    getChallengePlanningDataForContract(
        contractId: string,
        gameVersion: GameVersion,
        userId: string,
    ): unknown[] {
        // TODO: fix return type signature

        const contractData = this.controller.resolveContract(contractId)

        if (!contractData) {
            log(LogLevel.WARN, `Contract ${contractId} not found`)
            return []
        }

        const locationData = getSubLocationFromContract(
            contractData,
            gameVersion,
        )

        if (!locationData) {
            log(
                LogLevel.WARN,
                `Failed to get location data in CSERV [${contractData.Metadata.Location}]`,
            )
            return []
        }

        const forContract = this.getChallengesForContract(
            contractId,
            gameVersion,
        )

        return this.reBatchIntoSwitchedData(forContract, userId, gameVersion)
    }

    getChallengeDataForDestination(
        locationParentId: string,
        gameVersion: GameVersion,
        userId: string,
    ): unknown[] {
        // TODO: fix return type signature

        const locationsData = getVersionedConfig<PeacockLocationsData>(
            "LocationsData",
            gameVersion,
            false,
        )

        const locationData = locationsData.parents[locationParentId]

        if (!locationData) {
            log(
                LogLevel.WARN,
                `Failed to get location data in CSERV [${locationParentId}]`,
            )
            return []
        }

        const forLocation = this.getGroupedChallengeLists(locationParentId, {
            type: ChallengeFilterType.ParentLocation,
            locationParentId,
        })

        return this.reBatchIntoSwitchedData(
            forLocation,
            userId,
            gameVersion,
            true,
        )
    }

    private reBatchIntoSwitchedData(
        challenges: GroupIndexedChallengeLists,
        userId: string,
        gameVersion: GameVersion,
        isDestination = false,
    ) {
        const entries = Object.entries(challenges)
        const compiler = isDestination
            ? this.compileRegistryDestinationChallengeData.bind(this)
            : this.compileRegistryChallengeTreeData.bind(this)

        return entries.map(([groupId, challenges]) => {
            const groupData = this.getGroupById(groupId)
            const challengeProgressionData = challenges.map((challengeData) =>
                this.getChallengeProgression(
                    userId,
                    challengeData.Id,
                    gameVersion,
                ),
            )

            return {
                Name: groupData?.Name,
                ChallengesCount: challenges.length,
                CompletedChallengesCount: challengeProgressionData.filter(
                    (progressionData) => progressionData.Completed,
                ).length,
                SwitchData: {
                    Data: {
                        Challenges: challenges.map((challengeData) =>
                            compiler(
                                challengeData,
                                this.getChallengeProgression(
                                    userId,
                                    challengeData.Id,
                                    gameVersion,
                                ),
                                gameVersion,
                                userId,
                            ),
                        ),
                    },
                },
            }
        })
    }

    compileRegistryChallengeTreeData(
        challenge: RegistryChallenge,
        progression: ChallengeProgressionData,
        gameVersion: GameVersion,
        userId: string,
    ): CompiledChallengeTreeData {
        return {
            // GetChallengeTreeFor
            Id: challenge.Id,
            Name: challenge.Name,
            ImageName: challenge.ImageName,
            Description: challenge.Description,
            Rewards: {
                MasteryXP: challenge.Rewards.MasteryXP,
            },
            Drops: [],
            Completed: progression.Completed,
            IsPlayable: challenge.IsPlayable || false,
            IsLocked: challenge.IsLocked || false,
            HideProgression: false,
            CategoryName:
                this.getGroupById(challenge.inGroup!)?.Name || "NOTFOUND",
            Icon: challenge.Icon,
            LocationId: challenge.LocationId,
            ParentLocationId: challenge.ParentLocationId,
            Type: challenge.Type || "contract",
            ChallengeProgress: null,
            DifficultyLevels: [],
            CompletionData: generateCompletionData(
                challenge.ParentLocationId,
                userId,
                gameVersion,
                true,
            ),
        }
    }

    compileRegistryDestinationChallengeData(
        challenge: RegistryChallenge,
        progression: ChallengeProgressionData,
        gameVersion: GameVersion,
        userId: string,
    ): CompiledChallengeTreeData {
        let contract
        // TODO: Properly get escalation groups for this
        if (challenge.Type === "contract") {
            contract = this.controller.resolveContract(
                challenge.InclusionData?.ContractIds?.[0] || "",
            )

            // This is so we can remove unused data and make it more like official - AF
            contract =
                contract === undefined
                    ? null
                    : {
                          // The null is for escalations as we cannot currently get groups
                          Data: {
                              Bricks: contract.Data.Bricks,
                              DevOnlyBricks: null,
                              GameChangerReferences:
                                  contract.Data.GameChangerReferences || [],
                              GameChangers: contract.Data.GameChangers || [],
                              GameDifficulties:
                                  contract.Data.GameDifficulties || [],
                          },
                          Metadata: {
                              CreationTimestamp: null,
                              CreatorUserId: contract.Metadata.CreatorUserId,
                              DebriefingVideo:
                                  contract.Metadata.DebriefingVideo || "",
                              Description: contract.Metadata.Description,
                              Drops: contract.Metadata.Drops || null,
                              Entitlements:
                                  contract.Metadata.Entitlements || [],
                              GroupTitle: contract.Metadata.GroupTitle || "",
                              Id: contract.Metadata.Id,
                              IsPublished:
                                  contract.Metadata.IsPublished || true,
                              LastUpdate: null,
                              Location: contract.Metadata.Location,
                              PublicId: contract.Metadata.PublicId || "",
                              ScenePath: contract.Metadata.ScenePath,
                              Subtype: contract.Metadata.Subtype || "",
                              TileImage: contract.Metadata.TileImage,
                              Title: contract.Metadata.Title,
                              Type: contract.Metadata.Type,
                          },
                      }
        }

        return {
            ...this.compileRegistryChallengeTreeData(
                challenge,
                progression,
                gameVersion,
                userId,
            ),
            UserCentricContract:
                challenge.Type === "contract"
                    ? generateUserCentric(contract, userId, gameVersion)
                    : (null as unknown as undefined),
        }
    }

    private checkWaterfallCompletion(
        writeQueue: PendingProgressionWrite[],
        session: ContractSession,
        challenge: RegistryChallenge,
    ): void {
        // find any dependency trees that depend on the challenge
        for (const depTreeId of this._dependencyTree.keys()) {
            const allDeps = this._dependencyTree.get(depTreeId)

            assert.ok(allDeps, `No dep tree for ${depTreeId}`)

            // check if the dependency tree is completed
            const completed = allDeps.every((depId) => {
                const depProgression = this.getChallengeProgression(
                    session.userId,
                    depId,
                    session.gameVersion,
                )

                return depProgression?.Completed
            })

            if (!completed) {
                continue
            }

            if (PEACOCK_DEV) {
                log(
                    LogLevel.DEBUG,
                    `${challenge.Id}'s completion caused all conditions to be met for ${depTreeId}`,
                )
            }

            writeQueue.push({
                challengeId: depTreeId,
                gameVersion: session.gameVersion,
                userId: session.userId,
                progression: {
                    ChallengeId: depTreeId,
                    ProfileId: session.userId,
                    Completed: true,
                    State: {
                        ...((challenge?.Definition as ChallengeDefinitionLike)
                            ?.Context || {}),
                        CurrentState: "Success",
                    },
                    ETag: "",
                    CompletedAt: new Date().toISOString(),
                    MustBeSaved: true,
                },
            })
        }
    }
}