Uploaded image for project: 'Xray for Jira'
  1. Xray for Jira
  2. XRAY-11681

Add an Xray Attachment Integrity Checker for DC to detect invalid/unreachable Xray attachments

    XporterXMLWordPrintable

Details

    • Suggestion
    • Status: New
    • Resolution: Unresolved
    • None
    • None
    • Attachments
    • None
    • UNCOVERED

    Description

      Description
      Introduce an Xray integrity validation mechanism for Jira Data Center that verifies whether all Xray-related attachments are valid, accessible, and correctly linked before Cloud migration or Attachment preload operations.

      The feature would work similarly to the existing Integrity Checker, but focused specifically on Xray attachments. It should identify issues such as:

      • Missing attachment files
      • Broken attachment references
      • Invalid paths
      • Corrupted attachment metadata
      • Attachments inaccessible

      This would help administrators proactively detect and resolve attachment-related inconsistencies before they cause failures during migrations, imports, exports, attachment preload operations, or runtime usage.

      The checker could provide:

      • A detailed report of invalid/unreachable attachments
      • Affected Test Executions/Test Runs/Test entities
      • Suggested remediation actions
      • Optional repair or cleanup capabilities

      User friction

      Customers currently have no direct way to validate the integrity and accessibility of Xray attachments in Jira Data Center environments before migration or preload activities.

      When attachment inconsistencies exist, they are usually only discovered during:

      • Migration execution
      • Xray attachment preload
      • Background jobs or indexing operations

      This creates:

      • Unexpected migration failures
      • Long troubleshooting cycles
      • Delays during migrations
      • Increased support involvement
      • Risk of incomplete or inconsistent migrated data

      Steps to reproduce / Actual Result:

      1. Have a Jira Data Center instance with Xray attachments.
      2. Introduce attachment inconsistencies (missing files, broken references, inaccessible storage paths, corrupted metadata, etc.).
      3. Run a migration, preload operation, or access affected Xray entities.
      4. Xray encounters attachment-related errors during processing.

      Actual Result:
      There is currently no dedicated validation tool to proactively identify invalid or unreachable Xray attachments before operations.

      IMPACT

      • Migration errors
      • Delayed migrations
      • Increased downtime during migration window
      • High support effort to identify problematic attachments manually
      • Risk of incomplete migration/preload execution
      • Poor customer experience during large-scale Data Center migrations

      What would improve if solved:

      • Customers could validate attachment integrity before migrations or preload operations
      • Faster and safer migration planning
      • Reduced migration downtime and risk
      • Fewer support escalations related to attachment corruption/inconsistency
      • Easier root-cause identification
      • Improved reliability of Xray attachment handling in Data Center environments

      Impact on stakeholders:

      Customers/Admins

      • Improved confidence during migrations and upgrades
      • Reduced operational risk
      • Less manual investigation effort

      Support Teams

      • Reduced number of migration/preload incidents
      • Faster troubleshooting
      • Better diagnostics

      Engineering

      • Lower number of attachment-related defects/escalations
      • More predictable migration behavior

      Current workaround:

      We need to manually investigate logs, storage paths, and attachment behavior to identify problematic attachments.

      This often involves:

      • Reviewing migration/preload logs
      • Comparing filesystem objects against database entries
      • Running custom SQL queries
      • Performing manual validation scripts

      CONTEXT & EXAMPLES:

      This feature would be particularly valuable for:

      • Large Jira Data Center instances
      • Customers migrating between environments
      • Attachment-heavy instances
      • Pre-migration validation activities

      It would align well with the concept of the existing Integrity Checker by extending integrity validation into Xray attachment consistency.

      Concrete example:

      A customer performs an Xray attachment preload before migration. During processing, Xray encounters multiple attachment references whose files no longer exist in shared storage.

      The preload operation fails partially, requiring:

      • Log analysis
      • Manual identification of affected entities
      • Storage investigation
      • Re-execution after cleanup

      With an Attachment Integrity Checker, these issues could have been detected and resolved proactively before the preload started.

      Workaround risk:

      • Manual investigation is time-consuming and error-prone
      • Customers may miss problematic attachments
      • Hidden inconsistencies can still cause failures later
      • Increased risk during critical migration windows
      • Potential data integrity issues after migration/preload completion

      Attachments

        Activity

          People

            joana.fonseca Joana Fonseca
            mrap Mario Peixoto
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated: