[DLT-1110] Mapped Collection Endpoint Browse (1/4) #1208
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
Reviewer's Guide by SourceryThis PR refactors the data transfer dialog to use a new component-based architecture. It introduces a new Sequence diagram for the transfer dialog initialization flowsequenceDiagram
participant App
participant TD as TransferDialog
participant TC as TransferDialogController
participant TM as TransferModel
participant TEM as TransferEndpointManager
participant TUM as TransferUIManager
App->>TD: show(mode, records, callback)
activate TD
TD->>TC: new TransferDialogController(mode, records, callback)
activate TC
TC->>TM: new TransferModel(mode, records)
TC->>TEM: new TransferEndpointManager()
TC->>TUM: new TransferUIManager()
TC->>TUM: initializeComponents()
TUM->>TUM: createDialog()
TUM->>TUM: initializeButtons()
TUM->>TUM: initializeRecordDisplay()
TUM->>TUM: initializeEndpointInput()
TC->>TEM: initialized = true
TC->>TUM: showDialog()
deactivate TC
deactivate TD
Class diagram for the new TransferDialog componentclassDiagram
class TransferDialog {
-currentDialog: TransferDialogController
+show(mode, records, callback)
}
class TransferDialogController {
-model: TransferModel
-endpointManager: TransferEndpointManager
-uiManager: TransferUIManager
-ids: Array
-callback: Function
-services: Object
+show()
}
class TransferModel {
-mode: TransferMode
-records: Array
-selectedIds: Set
-transferConfig: Object
-stats: Object
+isRecordValid(record)
+getRecordInfo(item)
}
class TransferEndpointManager {
-initialized: boolean
-currentEndpoint: Object
-endpointManagerList: Array
-currentSearchToken: string
-searchTokenIterator: number
+searchEndpoint(endpoint, searchToken)
+handlePathInput(searchToken)
}
class TransferUIManager {
-state: Object
-inputTimer: number
+initializeComponents()
+showDialog()
+handleTransfer()
}
TransferDialog --> TransferDialogController
TransferDialogController --> TransferModel
TransferDialogController --> TransferEndpointManager
TransferDialogController --> TransferUIManager
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
AronPerez
force-pushed
the
feat/DLT-1110/mapped-collection-endpoint-browse
branch
from
d0215b7 to
db9280d
Compare
AronPerez
changed the title
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @AronPerez - I've reviewed your changes and they look great!
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @AronPerez - I've reviewed your changes and they look great!
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
All comments from AI are about if statement styling |
t-ramz
reviewed
Jan 8, 2025
6 tasks
JoshuaSBrown
reviewed
Jan 9, 2025
JoshuaSBrown
reviewed
Jan 9, 2025
JoshuaSBrown
reviewed
Jan 9, 2025
JoshuaSBrown
reviewed
Jan 9, 2025
JoshuaSBrown
reviewed
Jan 9, 2025
JoshuaSBrown
reviewed
Jan 9, 2025
Comment on lines
164
to
210
| const titleText = `${item.id}   <span style='display:inline-block;width:9ch'>${info.info}</span> ${item.title}`; | ||
| return info.selectable ? titleText : `<span style='color:#808080'>${titleText}</span>`; |
There was a problem hiding this comment.
please run the escapeHTML function on these to prevent injection attacks. title titleText are controlled by the user.
JoshuaSBrown
requested changes
Jan 9, 2025
t-ramz
reviewed
Jan 9, 2025
There was a problem hiding this comment.
I think it would be helpful to have some visual demonstration such as screenshots or a brief gif to show that the changes are equivalent.
There was a problem hiding this comment.
Here's the original uses https://confluence.ccs.ornl.gov/display/DATAFED/OVERVIEW+-+Use+Cases
Will add artifacts soon
There was a problem hiding this comment.
AronPerez
commented
Jan 9, 2025
AronPerez
force-pushed
the
feat/DLT-1110/mapped-collection-endpoint-browse
branch
5 times, most recently
from
db75bd9 to
5a57e0d
Compare
[DLT-1110] Add controller unit tests [DLT-1110] Remove debug [DLT-1110] Correct import statements, endpoint list [DLT-1110] Refactor out into MVC [DLT-1110] Add debug [DLT-1110] Functioning modal, needs refactoring [DLT-1110] Refactor dlg start transfer using OOO programming. Should be MVC cased on what I'm seeing but we'll see
…ransfer request when update or get
AronPerez
force-pushed
the
feat/DLT-1110/mapped-collection-endpoint-browse
branch
from
dbe7432 to
3679a4f
Compare
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @AronPerez - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding unit tests for the new transfer components to ensure the complex transfer logic remains stable as the codebase evolves
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
ArtifactsNew Data RecordScreen.Recording.2025-01-14.at.2.46.19.PM.movUpload/Update Data RecordScreen.Recording.2025-01-14.at.2.48.27.PM.movDownload/Get Data RecordUpdatedScreen.Recording.2025-01-14.at.1.27.00.PM.mov |
JoshuaSBrown
approved these changes
Jan 14, 2025
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.
PR Description
This PR refactors out
web/static/dlg_start_xfer.jsTasks
Summary by Sourcery
Refactor the file transfer dialog into a reusable component.
New Features:
TransferDialogclass to manage the transfer dialog.Enhancements:
Tests:
TransferDialogcomponent.