[Bug]: Campaign upgrade falls over on large campaigns

Open
#6,055 4 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
java, xml
Domain
desktop, game-dev

Research direction

Campaign load runs a version check that reads the whole embedded content.xml into memory and applies regexes. Start from the campaign-upgrade / content.xml load path (search for the OutOfMemoryError message and content.xml). Done means a campaign whose content.xml exceeds 2GiB can be upgraded without allocating a single huge array, using streaming or a real XML transform instead of regex on the full file.

Written by the indexing model from the issue text.

Description

bug
Describe the Bug

When loading a campaign, a version check is done to see whether any data in the campaign needs to be modified to work in the current version of MapTool. In particular, this is applied to the embedded content.xml file by loading the entire file into memory, then applying regular expressions to modify the XML.

In addition to the problem of regexes being insufficient for transforming general XML, this approach prevents upgrading campaigns whose content.xml is greater than ~2GiB.

To Reproduce
  1. Create a campaign in 1.14.3 or earlier.
  2. Populate the campaign with many maps containing many tokens, until the saved campaign has a content.xml over 2,147,483,647 bytes in size.
  3. Load the campaign in 1.15.0 or later.
  4. Notice this message get shown:
    Out of memory while reading campaign.
    java.lang.OutOfMemoryError: Required array length 2147483638 + 10 is too large
    
Expected Behaviour

Any campaign that can be saved and loaded in one version of MapTool can also be loaded in later versions (assuming system resources are available for the upgrade).

Screenshots

No response

MapTool Info

All versions

Desktop

Linux Mint 22.3

Additional Context

No response

Dominant language
Java
Stars
927
Forks
286
Avg merge
3d 17h
Merged PRs (30d)
94

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RPTools/maptool

All issues in RPTools/maptool

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.