path: root/lib/vnlib.browser/src/helpers/apiCall.ts

// Copyright (c) 2023 Vaughn Nugent
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

import { type MaybeRef, type Ref } from 'vue' 
import { AxiosError, type Axios } from 'axios';
import { defaultTo, isArray, isNil, isEqual } from 'lodash-es';
import { get, useConfirmDialog } from '@vueuse/core';
import { useFormToaster, useToaster } from '../toast';
import { useWait } from './wait';
import { useAxiosInternal } from '../axios';
import type { IErrorNotifier, CombinedToaster } from '../toast';

export interface IApiHandle<T> {
    /**
     * Called to get the object to pass to apiCall is invoked
     */
    getCallbackObject(): T;

    /**
     * Called to get the notifier to use for the api call
     */
    getNotifier(): IErrorNotifier;

    /**
     * Called to set the waiting flag
     */
    setWaiting: (waiting: boolean) => void;
}

export interface IApiPassThrough {
    readonly axios: Axios;
    readonly toaster: CombinedToaster;
}

export interface IElevatedCallPassThrough extends IApiPassThrough {
    readonly password: string;
}

export interface ApiCall<T> {
    <TR>(callback: (data: T) => Promise<TR | undefined>): Promise<TR | undefined>;
}

export type CustomMessageHandler = (message: string) => void;

const useApiCallInternal = <T>(args: IApiHandle<T>): ApiCall<T> => {

    /**
     * Provides a wrapper method for making remote api calls to a server
     * while capturing context and errors and common api arguments.
     * @param {*} callback The method to call within api request context
     * @returns A promise that resolves to the result of the async function
     */
    return async <TR>(callback: (data: T) => Promise<TR | undefined>): Promise<TR | undefined> => {
        const notifier = args.getNotifier();

        // Set the waiting flag
        args.setWaiting(true);

        try {
            //Close the current toast value
            notifier.close();

            const obj = args.getCallbackObject();

            //Exec the async function
            return await callback(obj);

            // eslint-disable-next-line @typescript-eslint/no-explicit-any
        } catch (errMsg: any) {
            console.error(errMsg)
            // See if the error has an axios response
            if (isNil(errMsg.response)) {
                if (errMsg.message === 'Network Error') {
                    notifier.notifyError('Please check your internet connection')
                } else {
                    notifier.notifyError('An unknown error occured')
                }
                return
            }
            // Axios error message
            const response = errMsg.response
            const errors = response?.data?.errors
            const hasErrors = isArray(errors) && errors.length > 0

            const SetMessageWithDefault = (message: string) => {
                if (hasErrors) {
                    const title = 'Please verify your ' + defaultTo(errors[0].property, 'form')
                    notifier.notifyError(title, errors[0].message)
                } else {
                    notifier.notifyError(defaultTo(response?.data?.result, message))
                }
            }

            switch (response.status) {
                case 200:
                    SetMessageWithDefault('')
                    break
                case 400:
                    SetMessageWithDefault('Bad Request')
                    break
                case 422:
                    SetMessageWithDefault('The server did not accept the request')
                    break
                case 401:
                    SetMessageWithDefault('You are not logged in.')
                    break
                case 403:
                    SetMessageWithDefault('Please clear you cookies/cache and try again')
                    break
                case 404:
                    SetMessageWithDefault('The requested resource was not found')
                    break
                case 409:
                    SetMessageWithDefault('Please clear you cookies/cache and try again')
                    break
                case 410:
                    SetMessageWithDefault('The requested resource has expired')
                    break
                case 423:
                    SetMessageWithDefault('The requested resource is locked')
                    break
                case 429:
                    SetMessageWithDefault('You have made too many requests, please try again later')
                    break
                case 500:
                    SetMessageWithDefault('There was an error processing your request')
                    break
                default:
                    SetMessageWithDefault('An unknown error occured')
                    break
            }
        } finally {
            // Clear the waiting flag
            args.setWaiting(false);
        }
    }
}

const creatApiHandle = (notifier: MaybeRef<IErrorNotifier>, axios: Ref<Axios>): IApiHandle<IApiPassThrough> => {

    const toaster = useToaster();
    const { setWaiting } = useWait();

    const getCallbackObject = (): IApiPassThrough =>  ({ axios: get(axios), toaster })
    const getNotifier = (): IErrorNotifier => get(notifier);

    return { getCallbackObject, getNotifier, setWaiting }
}

/**
 * Provides a wrapper method for making remote api calls to a server
 * while capturing context and errors and common api arguments.
 * @param {*} asyncFunc The method to call within api request context
 * @returns A promise that resolves to the result of the async function
 */
export const apiCall = (() =>{

    const axios = useAxiosInternal(null);
    const errorNotifier = useFormToaster();

    //Create the api call handle
    const handle = creatApiHandle(errorNotifier, axios);
    //Confiugre the api call to use global configuration
    return useApiCallInternal(handle);
})();

/**
 * Customizes the api call to use a custom error message
 * @param msg The message to display when an error occurs
 * @returns {Object} The api call object {apiCall: Promise }
 */
export const configureApiCall = (msg: CustomMessageHandler): { apiCall: ApiCall<IApiPassThrough> } =>{
    
    const notifier = ((): IErrorNotifier => {
        return{
            notifyError: (t: string, m?: string) => {
                msg(t);
                return m;
            },
            close(id: string) {
                msg('')
                return id;
            },
        }
    })()

    const axios = useAxiosInternal(null);

    //Create custom api handle
    const handle = creatApiHandle(notifier, axios);

    //Confiugre the api call to use global configuration
    const apiCall = useApiCallInternal(handle);
    return { apiCall }
}

/**
 * Gets the shared password prompt object and the elevated api call method handler 
 * to allow for elevated api calls that require a password.
 * @returns {Object} The password prompt configuration object, and the elevated api call method
 */
export const usePassConfirm = (() => {

    //Shared confirm object
    const confirm = useConfirmDialog();

    /**
     * Displays the password prompt and executes the api call with the password
     * captured from the prompt. If the api call returns a 401 error, the password
     * prompt is re-displayed and the server error message is displayed in the form
     * error toaster.
     * @param callback The async callback method that invokes the elevated api call.
     * @returns A promise that resolves to the result of the async function
     */
    const elevatedApiCall = <T>(callback: (api: IElevatedCallPassThrough) => Promise<T>): Promise<T | undefined> => {
        //Invoke api call method but handle 401 errors by re-displaying the password prompt
        return apiCall<T>(async (api: IApiPassThrough) : Promise<T | undefined> => {
            // eslint-disable-next-line no-constant-condition
            while (1) {

                //Display the password prompt
                const { data, isCanceled } = await confirm.reveal()
                
                if (isCanceled) {
                    break;
                }

                try {
                    //Execute the api call with prompt response
                    return await callback({...api, ...data });
                }
                //Catch 401 errors and re-display the password prompt, otherwise throw the error
                catch (err) {
                    if(!(err instanceof AxiosError)){
                       throw err;
                    }

                    const { response } = err;

                    if(isNil(response)){
                        throw err;
                    }

                    //Check status code, if 401, re-display the password prompt
                    if (!isEqual(response?.status, 401)) {
                        throw err;
                    } 

                    //Display the error message
                    api.toaster.form.error({ title: response.data.result });

                    //Re-display the password prompt
                }
            }
        })
    }

    //Pass through confirm object and elevated api call
    return () => ({ ...confirm, elevatedApiCall })
})();