/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.dolphinscheduler.api.exceptions;

import org.apache.dolphinscheduler.api.enums.Status;
import org.apache.dolphinscheduler.api.utils.Result;

import lombok.extern.slf4j.Slf4j;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.HandlerMethod;

/**
 * Exception Handler
 */
@RestControllerAdvice
@ResponseBody
@Slf4j
public class ApiExceptionHandler {

    @ExceptionHandler(ServiceException.class)
    public ResponseEntity<Result<Object>> exceptionHandler(ServiceException e, HandlerMethod hm) {
        log.error("{} Meet a ServiceException: {}", hm.getShortLogMessage(), e.getMessage());
        return ResponseEntity.status(resolveResponseStatus(hm))
                .body(new Result<>(e.getCode(), e.getMessage()));
    }

    @ExceptionHandler(Throwable.class)
    public ResponseEntity<Result<Object>> exceptionHandler(Throwable e, HandlerMethod hm) {
        ApiException ce = hm.getMethodAnnotation(ApiException.class);
        log.error("Meet an unknown exception: ", e);
        Result<Object> body;
        if (ce == null) {
            body = Result.errorWithArgs(Status.INTERNAL_SERVER_ERROR_ARGS, e.getMessage());
        } else {
            Status st = ce.value();
            body = new Result<>(st.getCode(), st.getMsg() + ":" + e.getMessage());
        }
        return ResponseEntity.status(resolveResponseStatus(hm)).body(body);
    }

    /**
     * Honour the {@link ResponseStatus} declared on the controller method so that error responses
     * keep the same HTTP status code as success responses on the same endpoint. Falls back to 200
     * OK when the handler method does not declare one.
     */
    private static HttpStatus resolveResponseStatus(HandlerMethod hm) {
        ResponseStatus status = hm.getMethodAnnotation(ResponseStatus.class);
        if (status == null) {
            status = hm.getBeanType().getAnnotation(ResponseStatus.class);
        }
        return status == null ? HttpStatus.OK : status.value();
    }

}
