Geo: Replicate Achievements::Achievement uploads

What does this MR do and why?

This code change adds support for replicating and verifying achievement 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 avatar images uploaded for achievements. 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 achievement uploads have been successfully synchronized, failed, or are pending verification across their GitLab instances. Additionally, it updates the API documentation to include these new achievement upload statistics in the Geo status reports.

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

References

Closes #589902 (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_achievement_upload_replication)
Feature.enable(:geo_achievement_upload_force_primary_checksumming)

3. Create test data on the primary

Create an achievement with an avatar via the UI (Groups > your group > Manage > Achievements > New achievement, and attach an image), or use the Rails console:

# In Rails console on the primary
user = User.admins.first
namespace = Group.first

avatar_file = ActionDispatch::Http::UploadedFile.new(
  tempfile: File.open(Rails.root.join('spec/fixtures/dk.png')),
  filename: 'dk.png',
  content_type: 'image/png'
)

Feature.enable(:achievements, namespace)

Achievements::CreateService.new(namespace: namespace, current_user: user, params: { name: 'Test Achievement', avatar: avatar_file }).execute

Verify the upload exists in the achievement_uploads partition:

Geo::AchievementUpload.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::AchievementUpload.first.replicator.verify
Geo::AchievementUpload.first.achievement_upload_state.reload
Geo::AchievementUpload.first.achievement_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::AchievementUploadRegistry.count
# Should be > 0

registry = Geo::AchievementUploadRegistry.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::AchievementUploadReplicator.new(model_record_id: Geo::AchievementUpload.first.id).sync

6. Verify verification on the secondary

# In Rails console on the secondary
registry = Geo::AchievementUploadRegistry.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
    achievementUploadRegistries {
      nodes {
        id
        state
        verificationState
        achievementUploadId
        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 achievement upload statistics:

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

Look for the new fields in the response:

  • achievement_uploads_count
  • achievement_uploads_checksummed_count
  • achievement_uploads_checksum_failed_count
  • achievement_uploads_synced_count
  • achievement_uploads_failed_count
  • achievement_uploads_registry_count
  • achievement_uploads_synced_in_percentage
  • achievement_uploads_verified_in_percentage

9. Verify Geo admin page

Visit /admin/geo/sites on the secondary and confirm that "Achievement 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.

Edited by Douglas Barbosa Alexandre

Merge request reports

Loading