EAGLE-1431: Stop EAGLE overwriting modelData when loading palettes

[james-strauss-uwa]

Also stop EAGLE re-sorting the nodes in a palette after adding nodes from a graph.

Re-named fields in modelData modal from eagleVersion to generatorVersion, add generatorName.

Fixed bug where modelData.downloadUrl was not displayed.

Summary by Sourcery

Improve model data handling and display in EAGLE by updating metadata fields, preventing unintended overwrites, and fixing display issues

Bug Fixes:

• Fixed an issue where modelData.downloadUrl was not being displayed correctly
• Stopped EAGLE from overwriting modelData when loading palettes

Enhancements:

• Renamed metadata fields from Eagle-specific terms to more generic generator-related terms
• Improved tooltips for model data modal to provide clearer descriptions

Chores:

• Removed automatic re-sorting of nodes in a palette after adding nodes from a graph

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request addresses issues related to palette loading and model data display. It prevents EAGLE from overwriting modelData and re-sorting nodes when loading palettes. Additionally, it updates the modelData modal to include generator information and fixes a bug where the download URL was not displayed.

Sequence diagram for loading palettes

sequenceDiagram
    participant Eagle
    participant Palette

    Eagle->>Palette: loadPalette(paletteData)
    activate Palette
    Palette->>Palette: fileInfo().modified = true
    deactivate Palette

Loading

Updated class diagram for FileInfo

classDiagram
    class FileInfo {
        -_generatorName: string
        -_generatorVersion: string
        -_generatorCommitHash: string
        -_downloadUrl: string
    }

    note for FileInfo "Renamed eagleVersion to generatorVersion, added generatorName, fixed bug where downloadUrl was not displayed"

Loading

File-Level Changes

Change	Details	Files
Stopped EAGLE from overwriting modelData and re-sorting nodes when loading palettes.	Prevented overwriting of modelData when loading palettes. Stopped re-sorting of nodes in a palette after adding nodes from a graph.	src/Eagle.ts src/Utils.ts
Updated fields in the modelData modal to include generator information and fixed a bug where the download URL was not displayed.	Renamed 'eagleVersion' to 'generatorVersion' in the modelData modal. Added 'generatorName' field to the modelData modal. Fixed a bug where 'modelData.downloadUrl' was not displayed. Updated tooltips for fields in the model data modal.	templates/modals/model_data.html eagleServer/eagleServer.py src/tutorials/graphBuilding.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @james-strauss-uwa - I've reviewed your changes - here's some feedback:

Overall Comments:

• The changes to eagleServer.py look like they could be simplified by using dict.update() to overwrite the model data.
• Consider adding a unit test for the bug fix related to modelData.downloadUrl.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[M-Wicenec]

nice, I assume that means were treating the sort function as a conscious decision of wanting to to alter the real order of the nodes in the palette?