Story 233061: Clean up frontend #88
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…story/233061-clean-up-frontend
# Conflicts: # www/src/components/diagram/CenterLine.tsx # www/src/components/diagram/Equipment.tsx # www/src/components/diagram/LinesGraphicalDataExample.tsx # www/src/components/diagram/PandIdGraphicalDataExample.tsx # www/src/components/diagram/SymbolGraphicalDataExample.tsx # www/src/components/editor/Editor.tsx # www/src/components/editor/EditorSidebar.tsx
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) ✅ code/snyk check is complete. No issues have been found. (View Details) |
eoye
approved these changes
Feb 17, 2025
There was a problem hiding this comment.
Really great cleanup!🤩 Thanks for adding TODO's for code we can remove when we have the new graphical format implemented! I found two errors when building the project:
- In
NodeTable.tsx, the propertyactivePackagedoes not exist on the type - In
CommissioningPackageDispatchContext.ts, there is an error onPackageAction, asCommissioningPackageContextProvidedoes not exportPackageAction
I tried running the demo and clicked around testing a couple of thing, and it all worked with out any errors! So everything seems to work 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Aim of the PR
This PR fixes AB#233061
This PR aims to clean up the frontend code a bit.
Implementation
New context: The old commissioning package context has been replaced with a new context that uses a reducer. This is nice because a lot of the time, we want to make updates both to the active package and to the commissioning package list. The reducer is a function that takes in the current commissioning package state, and an action, and returns the new state. This way, instead of making sure we update the correct parts of the context everywhere in the app, the reducer takes care of it for us.
New context hook: We have a new hook, useCommissioningPackages, that returns the context and a dispatch. For read actions, we use the context, and for write actions, we use the dispatch.
CommissioningPackageActions: These are functions that both call the API and dispatch a reducer function. Use these in components when possible.
Helper functions: Some new helper functions are created to avoid duplicating so much code.
Type of change
If the changes impact any dependent services then provide details.
How Has This Been Tested?
Please describe the tests that you ran to verify that your changes works as expected.
Additional Changes