openobserve/web/src/services/backfill.ts

// Copyright 2026 OpenObserve Inc.
//
// 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 <http://www.gnu.org/licenses/>.

import http from "./http";
import analytics from "./product_analytics";

export interface CreateBackfillJobRequest {
  start_time: string | number; // ISO 8601 string or microseconds
  end_time: string | number;
  chunk_period_minutes?: number;
  delay_between_chunks_secs?: number;
  delete_before_backfill?: boolean;
}

export interface CreateBackfillJobResponse {
  job_id: string;
  message: string;
}

export type DeletionStatus =
  "not_required" | "pending" | "in_progress" | "completed" | { failed: string };

export interface BackfillJob {
  job_id: string;
  pipeline_id: string;
  pipeline_name: string | null;
  start_time: number; // microseconds
  end_time: number; // microseconds
  current_position: number; // microseconds
  progress_percent: number; // 0-100
  status: "running" | "completed" | "failed" | "pending" | "canceled" | "paused" | "waiting";
  enabled: boolean;
  deletion_status?: DeletionStatus;
  deletion_job_ids?: string[]; // Multiple deletion job IDs for tracking
  created_at?: number; // microseconds
  last_triggered_at?: number; // microseconds
  chunks_completed?: number;
  chunks_total?: number;
  chunk_period_minutes?: number;
  delay_between_chunks_secs?: number;
  delete_before_backfill?: boolean;
  error?: string; // Error message if job encountered an error
}

export interface BackfillJobActionResponse {
  message: string;
}

const backfill = {
  /**
   * Create a new backfill job for a pipeline
   */
  createBackfillJob: async ({
    org_id,
    pipeline_id,
    data,
  }: {
    org_id: string;
    pipeline_id: string;
    data: CreateBackfillJobRequest;
  }): Promise<CreateBackfillJobResponse> => {
    const url = `/api/${org_id}/pipelines/${pipeline_id}/backfill`;
    const response = await http().post(url, data);
    analytics.track("pipeline_backfill_started", {
      delete_before_backfill: !!data.delete_before_backfill,
    });
    return response.data;
  },

  /**
   * List all backfill jobs for an organization
   */
  listBackfillJobs: async ({ org_id }: { org_id: string }): Promise<BackfillJob[]> => {
    const url = `/api/${org_id}/pipelines/backfill`;
    const response = await http().get(url);
    return response.data;
  },

  /**
   * Get details of a specific backfill job
   */
  getBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
  }): Promise<BackfillJob> => {
    const url = `/api/${org_id}/pipelines/${pipeline_id}/backfill/${job_id}`;
    const response = await http().get(url);
    return response.data;
  },

  /**
   * Enable or disable a backfill job
   * @param enable - true to enable/resume, false to disable/pause
   */
  enableBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
    enable,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
    enable: boolean;
  }): Promise<BackfillJobActionResponse> => {
    const url = `/api/${org_id}/pipelines/${pipeline_id}/backfill/${job_id}/enable?value=${enable}`;
    const response = await http().put(url);
    return response.data;
  },

  /**
   * Pause a running backfill job
   * @deprecated Use enableBackfillJob with enable=false instead
   */
  pauseBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
  }): Promise<BackfillJobActionResponse> => {
    return backfill.enableBackfillJob({ org_id, pipeline_id, job_id, enable: false });
  },

  /**
   * Resume a paused backfill job
   * @deprecated Use enableBackfillJob with enable=true instead
   */
  resumeBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
  }): Promise<BackfillJobActionResponse> => {
    return backfill.enableBackfillJob({ org_id, pipeline_id, job_id, enable: true });
  },

  /**
   * Update an existing backfill job
   */
  updateBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
    data,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
    data: CreateBackfillJobRequest;
  }): Promise<BackfillJobActionResponse> => {
    const url = `/api/${org_id}/pipelines/${pipeline_id}/backfill/${job_id}`;
    const response = await http().put(url, data);
    return response.data;
  },

  /**
   * Cancel a running backfill job
   * Note: This is an alias for pauseBackfillJob (enableBackfillJob with enable=false)
   */
  cancelBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
  }): Promise<BackfillJobActionResponse> => {
    return backfill.enableBackfillJob({ org_id, pipeline_id, job_id, enable: false });
  },

  /**
   * Delete a backfill job permanently
   */
  deleteBackfillJob: async ({
    org_id,
    pipeline_id,
    job_id,
  }: {
    org_id: string;
    pipeline_id: string;
    job_id: string;
  }): Promise<BackfillJobActionResponse> => {
    const url = `/api/${org_id}/pipelines/${pipeline_id}/backfill/${job_id}`;
    const response = await http().delete(url);
    return response.data;
  },
};

export default backfill;