/*!
 * 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.
 */
import { useParams } from "react-router-dom";

import { useGridServiceGetGridRuns } from "openapi/queries";
import type { DagRunState, DagRunType } from "openapi/requests/types.gen";
import { SearchParamsKeys } from "src/constants/searchParams";
import { useAdvancedSearchArg } from "src/hooks/useAdvancedSearch";
import { isStatePending, useAutoRefresh } from "src/utils";

export const useGridRuns = ({
  dagRunState,
  limit,
  offset,
  runAfterGte,
  runAfterLte,
  runIdPattern,
  runType,
  triggeringUser,
}: {
  dagRunState?: DagRunState | undefined;
  limit: number;
  offset?: number;
  runAfterGte?: string;
  runAfterLte?: string;
  runIdPattern?: string | undefined;
  runType?: DagRunType | undefined;
  triggeringUser?: string | undefined;
}) => {
  const { dagId = "" } = useParams();

  const refetchInterval = useAutoRefresh({ dagId });

  // Advanced-search toggle picks between the substring ``runIdPattern`` and the
  // index-friendly ``runIdPrefixPattern`` variants of the Run ID filter.
  const runIdPatternArg = useAdvancedSearchArg({
    patternApiKey: "runIdPattern",
    prefixApiKey: "runIdPrefixPattern",
    storageKey: SearchParamsKeys.RUN_ID_PATTERN,
    value: runIdPattern,
  });

  // Advanced-search toggle picks between the substring ``triggeringUser`` and the
  // index-friendly ``triggeringUserPrefix`` variants of the Triggering User filter.
  const triggeringUserArg = useAdvancedSearchArg({
    patternApiKey: "triggeringUser",
    prefixApiKey: "triggeringUserPrefix",
    storageKey: SearchParamsKeys.TRIGGERING_USER_NAME_PATTERN,
    value: triggeringUser,
  });

  const { data: GridRuns, ...rest } = useGridServiceGetGridRuns(
    {
      dagId,
      limit,
      offset: offset ?? undefined,
      orderBy: ["-run_after"],
      runAfterGte: runAfterGte ?? undefined,
      runAfterLte: runAfterLte ?? undefined,
      ...runIdPatternArg,
      runType: runType ? [runType] : undefined,
      state: dagRunState ? [dagRunState] : undefined,
      ...triggeringUserArg,
    },
    undefined,
    {
      placeholderData: (prev) => prev,
      refetchInterval: (query) =>
        query.state.data?.some((run) => isStatePending(run.state)) && refetchInterval,
    },
  );

  return { data: GridRuns, ...rest };
};
