Geo: Replicate Ai::VectorizableFile uploads

Douglas Barbosa Alexandrerequested to merge
589903-geo-replicate-ai-vectorizable-file-uploads into master

What does this MR do and why?

This code change adds support for replicating and verifying Ai::VectorizableFile uploads in GitLab's Geo feature (which keeps multiple GitLab instances synchronized).

The changes create a new database table to track the synchronization status of AI vectorizable files uploaded for agent version attachments. This includes adding verification states to ensure files are properly copied between different GitLab servers, along with checksums to verify file integrity.

The update also adds new monitoring metrics so administrators can track how many Ai::VectorizableFile uploads have been successfully synchronized, failed, or are pending verification across their GitLab instances. Additionally, it updates the API documentation to include these new Ai::VectorizableFile upload statistics in the Geo status reports.

This enhancement ensures that AI vectorizable file uploads are properly backed up and synchronized across multiple GitLab installations for disaster recovery and performance purposes.

References

Closes #589903 (closed)

How to set up and validate locally

Prerequisites

1. Run database migrations

rails db:migrate # on the primary
rails db:migrate:geo # on the secondary

2. Enable the feature flags on the primary

# In Rails console on the primary
Feature.enable(:geo_ai_vectorizable_file_upload_replication)
Feature.enable(:geo_ai_vectorizable_file_upload_force_primary_checksumming)

3. Create test data on the primary

Create an AI vectorizable file via the Rails console:

# In Rails console on the primary
user = User.admins.first
project = Project.first

file = ActionDispatch::Http::UploadedFile.new(
  tempfile: File.open(Rails.root.join('ee/spec/fixtures/ai/vectorizable_file.txt')),
  filename: 'vectorizable_file.txt',
  content_type: 'application/octet-stream'
)

Ai::VectorizableFile.create!(project: project, name: 'test_file.txt', file: file)

Verify the upload exists in the ai_vectorizable_file_uploads partition:

Geo::AiVectorizableFileUpload.count
# Should be > 0

4. Verify checksumming on the primary

Wait for the verification worker to process, or trigger it manually:

# In Rails console on the primary
Geo::AiVectorizableFileUpload.first.replicator.verify
Geo::AiVectorizableFileUpload.first.ai_vectorizable_file_upload_state.reload
Geo::AiVectorizableFileUpload.first.ai_vectorizable_file_upload_state.verification_state
# Should be 2 (verification_succeeded)

5. Verify replication on the secondary

Once the upload is created on the primary, Geo will automatically replicate it to the secondary. Check the sync status in the secondary Rails console:

# In Rails console on the secondary
Geo::AiVectorizableFileUploadRegistry.count
# Should be > 0

registry = Geo::AiVectorizableFileUploadRegistry.last
registry.state
# Should be 2 (synced)

If the registry is empty or not yet synced, you can manually trigger sync:

# In Rails console on the secondary
Geo::AiVectorizableFileUploadReplicator.new(model_record_id: Geo::AiVectorizableFileUpload.first.id).sync

6. Verify verification on the secondary

# In Rails console on the secondary
registry = Geo::AiVectorizableFileUploadRegistry.last
registry.reload
registry.verification_state
# Should be 2 (verification_succeeded)

7. Test GraphQL API on the secondary

Note: You must be logged in as an admin user. Non-admin users will get null for Geo-related queries.

Note: When querying from the secondary's GraphQL explorer, add a custom header REQUEST_PATH with the value /api/v4/geo/node_proxy/{node_id}/graphql

Open the GraphQL explorer on the secondary instance (http://<secondary-url>/-/graphql-explorer) and run:

query {
  geoNode {
    name
    primary
    aiVectorizableFileUploadRegistries {
      nodes {
        id
        state
        verificationState
        aiVectorizableFileUploadId
        lastSyncedAt
        verifiedAt
      }
    }
  }
}

Expected result: you should see registry entries with state: "SYNCED" and verificationState: "VERIFIED".

8. Verify Geo Sites API

Check the Geo Sites API includes the new Ai::VectorizableFile upload statistics:

curl --header "PRIVATE-TOKEN: <your-token>" "http://<primary-url>/api/v4/geo_sites/status"

Look for the new fields in the response:

  • ai_vectorizable_file_uploads_count
  • ai_vectorizable_file_uploads_checksummed_count
  • ai_vectorizable_file_uploads_checksum_failed_count
  • ai_vectorizable_file_uploads_synced_count
  • ai_vectorizable_file_uploads_failed_count
  • ai_vectorizable_file_uploads_registry_count
  • ai_vectorizable_file_uploads_synced_in_percentage
  • ai_vectorizable_file_uploads_verified_in_percentage

9. Verify Geo admin page

Visit /admin/geo/sites on the secondary and confirm that "Ai Vectorizable File Uploads" appears as a new data type with replication and verification progress.

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports