Pere Miquel Brull ba5f929f77
Add fine-grained health validation for Airflow APIs (#11792)
* Add fine-grained health validation for Airflow APIs

* Add ingestion version response

* Improve messaging

* Format

* Format

* Update response

* ui:update the hook to return airflow status based on response status field

* ui: add unit test for useAirflowStatus hook

* chore: only show test connection if airflow is available

* feat: add airflow message banner

* chore: update icon and background color

* chore: update typography to text

* test: add unit test

* address comments

* chore: show banner on service detail page

* fix: update test suite api workflow to reflect new implementation

---------

Co-authored-by: Sachin Chaurasiya <sachinchaurasiyachotey87@gmail.com>
Co-authored-by: Teddy Crepineau <teddy.crepineau@gmail.com>
2023-06-12 07:47:45 +02:00

62 lines
1.9 KiB
TypeScript

/*
* Copyright 2023 Collate.
* Licensed 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.
*/
import { AxiosError } from 'axios';
import {
AirflowResponse,
AirflowStatus,
} from 'interface/AirflowStatus.interface';
import { useEffect, useState } from 'react';
import { getAirflowStatus } from 'rest/ingestionPipelineAPI';
interface UseAirflowStatusProps {
isFetchingStatus: boolean;
isAirflowAvailable: boolean;
error: AxiosError | undefined;
reason: AirflowResponse['reason'];
fetchAirflowStatus: () => Promise<void>;
}
export const useAirflowStatus = (): UseAirflowStatusProps => {
const [isLoading, setIsLoading] = useState<boolean>(false);
const [isAirflowAvailable, setIsAirflowAvailable] = useState<boolean>(false);
const [error, setError] = useState<AxiosError>();
const [reason, setReason] = useState<AirflowResponse['reason']>();
const fetchAirflowStatus = async () => {
setIsLoading(true);
try {
const response = await getAirflowStatus();
setIsAirflowAvailable(response.status === AirflowStatus.HEALTHY);
setReason(response.reason);
} catch (error) {
setError(error as AxiosError);
setIsAirflowAvailable(false);
} finally {
setIsLoading(false);
}
};
useEffect(() => {
fetchAirflowStatus();
}, []);
return {
isFetchingStatus: isLoading,
isAirflowAvailable,
error,
fetchAirflowStatus,
reason,
};
};