Skip to content

Remove SvgJSON data type#1720

Open
r-weng wants to merge 6 commits into
Courseography:masterfrom
r-weng:remove-svgjson-data-type
Open

Remove SvgJSON data type#1720
r-weng wants to merge 6 commits into
Courseography:masterfrom
r-weng:remove-svgjson-data-type

Conversation

@r-weng
Copy link
Copy Markdown
Contributor

@r-weng r-weng commented May 31, 2026

Proposed Changes

This pull request removes the SvgJSON data type, previously defined in app/Database/Tables.hs, and refactors any related code to use a tuple of texts, shapes, and paths instead of SvgJSON. This pull request also creates parseGraphJSON, a helper function used in saveGraphJSON of app/Controllers/Graph.hs and runGetGraphJSONTest of backend-test/Controllers/GraphControllerTests.hs.

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality) X
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.
  • I have updated the project Changelog (this is required for all changes).

After opening your pull request:

  • I have verified that the CircleCI checks have passed.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@r-weng r-weng requested a review from david-yz-liu May 31, 2026 19:56
@coveralls
Copy link
Copy Markdown

coveralls commented May 31, 2026

Coverage Report for CI Build 0

Coverage increased (+0.04%) to 58.298%

Details

  • Coverage increased (+0.04%) from the base build.
  • Patch coverage: 12 of 12 lines across 2 files are fully covered (100%).
  • 13 coverage regressions across 1 file.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

13 previously-covered lines in 1 file lost coverage.

File Lines Losing Coverage Coverage
app/Database/Tables.hs 13 72.64%

Coverage Stats

Coverage Status
Relevant Lines: 3947
Covered Lines: 2360
Line Coverage: 59.79%
Relevant Branches: 964
Covered Branches: 503
Branch Coverage: 52.18%
Branches in Coverage %: Yes
Coverage Strength: 163.54 hits per line

💛 - Coveralls

Comment thread app/Models/Graph.hs Outdated
deleteWhere, entityKey, entityVal, insert, insert_, insertMany_, keyToValues,
selectFirst, selectList, (<-.), (==.))
import Database.Tables hiding (paths, shapes, texts)
import Database.Tables
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the Database.Tables imports you changed so that they explicitly name what's being imported (this will help improve the code quality throughout)

Comment thread app/Database/Tables.hs Outdated
return (T.concat [firstName, ". ", lastName])
parseInstr _ = return ""

-- | Parse the JSON representation of a graph into its texts, shapes, and paths components.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename to parseGraphComponentsJSON and move this into the graph model file

Comment thread app/Controllers/Graph.hs Outdated
let jsonObj = parseGraphJSON jsonStr
case jsonObj of
Nothing -> return $ toResponse ("Error" :: String)
Just svg -> do
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename svg into components

@r-weng
Copy link
Copy Markdown
Contributor Author

r-weng commented Jun 2, 2026

I have made the requested changes. I'm not sure if there are any rules for structuring imports (indenting, new lines) I should adhere to though.

@r-weng r-weng requested a review from david-yz-liu June 2, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants