OnlyOffice Version History — changesUrl Incompatibility Issue

Docs
1

Environment

  • OnlyOffice Document Server: 9.2.0
  • Frontend component: @onlyoffice/document-editor-vue 1.6.1
  • File format: xlsx

Problem Description

We implemented the document version history feature using onRequestHistory + onRequestHistoryData + setHistoryData. When a document has 3 or more versions, switching to certain versions triggers the following error:

Received changes that are incompatible with the file version

What We Have Verified

  1. File integrity: Each version’s .xlsx file has a unique MD5 hash — the file contents are correct.
  2. changes.zip validity: The zip file exists and has a valid structure (contains changes0.json).
  3. Key uniqueness: Each version uses a unique key (we previously fixed a key reuse issue).

Questions

  1. How can we ensure that the changesUrl (changes.zip) returned by Callback status=2 is fully compatible with the corresponding document version? Even with correct file contents and unique keys, some versions’ changesUrl is still incompatible with the document.
  2. Is there an event callback for changesUrl compatibility errors in setHistoryData? Currently the error is only logged in the browser console via app.js. Neither the onError nor onWarning events are triggered, making it impossible for the frontend to catch this error.
  3. Is there a recommended way to validate whether a changesUrl is compatible with a document version before calling setHistoryData?

Related Community Issue

2

Hey @Adam11, :wave:

Thanks for the detailed report and for sharing all the verification steps — it’s very helpful!

A few quick notes first:

  • You’re currently on Document Server 9.2.0. The latest stable version is 9.3.1, and 9.4 is scheduled for the end of April. So we recommend updating first and re-testing.

Since this is an integration issue (involving onRequestHistory, onRequestHistoryData, setHistoryData, and changesUrl), it will take time to investigate. :writing_hand:

To move forward faster, could you please provide:

  1. Server logs (and extended logs if possible) from the moment the error occurs.
  2. A short video showing the reproduction steps (loading version history → switching versions → error appearing).
  3. Confirmation that you implemented version history exactly as described in the official docs:
    Document history | ONLYOFFICE

If this is time-critical for your project, I’d also recommend considering a paid license with dedicated professional support — they can dive into your specific integration much faster: