Refactored the control panel and workspace reload #489

JensHouses · 2024-08-01T16:07:53Z

should fix the issues:
QoL improvement: submit/next/prev buttons on navbar #105
and
Better reconnection for nonvnc on challenge restart #478

I Used BroadcastChannel to trigger an event through browser tabs and/or windows if a challenge (re)started.
VSCode reloads the page.
noVNC changes the iframe src.
I added a description to the control panel and moved the notifications to the bottom of the control panel. I Limited the max-size to 50vh and made it scrollable. Therefor I changed the scrollbar to be more visible.
I added the description to the test of active_module.

dojo_plugin/pages/workspace.py

dojo_theme/static/css/custom.css

ConnorNelson

This looks super awesome! Just 1 more small change: let's support async for all workspace services, not just the desktop. Then it will be ready to merge. Thanks for all your work!

ConnorNelson · 2024-08-08T16:30:37Z

dojo_plugin/pages/workspace.py


 @workspace.route("/workspace/<service>")
 @authed_only
 def view_workspace(service):
    user = get_current_user()
    active = bool(get_current_dojo_challenge())
+    iframe_src = "" if service=="desktop" else f"/workspace/{service}/"
+    loadUrlAsync = service == "desktop"


Let's get rid of the decision to loadUrlAsync. All /workspace/* should be loaded async; the desktop is not special :)

code just seams to have the iframe src /workspace/code/
what other workspaces are there ? :)

ConnorNelson · 2024-08-08T16:33:21Z

dojo_theme/templates/iframe.html

@@ -45,6 +45,16 @@ <h1 class="inactive">No active challenge session; start a challenge!<h1>

 {% block scripts %}
 {{ super() }}
+{% if active and loadUrlAsync %}
+<script>
+    let response =  fetch("/pwncollege_api/v1/workspace").then(response => response.json()).then(data => {


Somehow we should pass to the workspace endpoint what url we're looking for. You can pass this all the way through with a jina {{ service }}.

Tangentially, it might also make sense to rename this from iframe.html => workspace.html. If there is someone else using iframe.html besides a workspace-related feature (I don't think so?) then we'd want to make a copy.

ConnorNelson · 2024-08-08T16:48:51Z

dojo_plugin/api/v1/workspace.py

+@workspace_namespace.route("")
+class view_desktop(Resource):
+    @authed_only
+    def get(self):


Probably add a service = request.args.get("service") or something like that.

JensHouses · 2024-08-09T06:44:28Z

Final changes: 🤣

Added service parameter to view_desktop endpoint in workspace.py.
Updated iframe source handling based on service parameter in workspace.py.
Simplified view_workspace route in pages/workspace.py.
Removed async URL loading and share URLs script from iframe.html.
Created new workspace.html template for dynamic iframe loading.

ConnorNelson · 2024-08-09T17:46:52Z

Great! Looks like testcases aren't passing though?

JensHouses · 2024-08-10T09:32:51Z

Spent 3 hours debugging an issue where Firefox refused to open WebSockets, which led me to believe there was a problem with my code. After exhausting all possible code-related issues, I finally tested it in Chrome, where it worked perfectly fine. Turns out, the problem was with Firefox all along, not my code. Once I realized this, the actual task—changing a '2' to a '3'—took just a few minutes. 3 hours of work to change a single number!

zardus · 2024-08-14T08:36:17Z

DEFCON's over, so we'll get back to getting this merged in shortly :-)

Looks like we'll need to squash, cause rebasing will have conflicts.

I Used BroadcastChannel to trigger an event through browser tabs and/or windows if a challenge (re)started. VSCode reloads the page. noVNC changes the iframe src. I added a description to the control panel and moved the notifications to the bottom of the control panel. I Limited the max-size to 50vh and made it scrollable. Therefor I changed the scrollbar to be more visible. I added the description to the test of active_module.

increased the wait time as we now fetch the iframe url async via api. Refactor workspace API and update templates - Added `service` parameter to `view_desktop` endpoint in `workspace.py`. - Updated iframe source handling based on `service` parameter in `workspace.py`. - Simplified `view_workspace` route in `pages/workspace.py`. - Removed async URL loading and share URLs script from `iframe.html`. - Created new `workspace.html` template for dynamic iframe loading. Refactor workspace API and update templates - Added `service` parameter to `view_desktop` endpoint in `workspace.py`. - Updated iframe source handling based on `service` parameter in `workspace.py`. - Simplified `view_workspace` route in `pages/workspace.py`. - Removed async URL loading and share URLs script from `iframe.html`. - Created new `workspace.html` template for dynamic iframe loading. Improve reconnection on challenge (re)start - Added API endpoint to retrieve the current iframe URL. - Moved `container_password` to `utils`. - Relocated `start_on_demand_service` to `utils/workspace`. - Removed special route for workspace desktop. - Added edge-case handling to the workspace `<service>` route. - Updated `iframe.html` to support new functionality. - Modified `navbar.js` to use the new API endpoint.

…p-reload' into feature/control-panel-and-desktop-reload # Conflicts: # dojo_theme/static/js/dojo/navbar.js

JensHouses · 2024-08-17T09:54:52Z

Finally... =)

zardus · 2024-08-18T06:58:54Z

Thanks, @JensHouses!! @ConnorNelson thoughts on the API/page split? If you're happy, then we yolo?

ConnorNelson · 2024-08-19T18:10:07Z

dojo_theme/static/js/dojo/navbar.js

+broadcast.onmessage = (event) => {
+    if (event.data.msg === 'New challenge started') {
+        if (window.location.pathname === '/workspace/code') {
+            window.location.reload();


Is there a reason code uses a window reload, while the desktop gets/sets the iframe url?

i cant figure out why reloading the iframe does not work. as the iframe url seams to be the same.
reloading the page seam to solve the problem. But i currently don't know why.
Any advice would be welcome.

zardus · 2024-08-27T04:37:45Z

zardus · 2024-08-27T04:37:52Z

thanks!!!!

ConnorNelson reviewed Aug 1, 2024

View reviewed changes

dojo_plugin/pages/workspace.py Outdated Show resolved Hide resolved

dojo_theme/static/css/custom.css Outdated Show resolved Hide resolved

JensHouses requested a review from ConnorNelson August 8, 2024 13:14

ConnorNelson reviewed Aug 8, 2024

View reviewed changes

JensHouses requested a review from ConnorNelson August 9, 2024 06:44

JensHouses force-pushed the feature/control-panel-and-desktop-reload branch from 07a99e6 to 8057559 Compare August 17, 2024 09:14

JensHouses marked this pull request as draft August 17, 2024 09:18

JensHouses added 2 commits August 17, 2024 11:22

JensHouses force-pushed the feature/control-panel-and-desktop-reload branch from 8057559 to 3bbd272 Compare August 17, 2024 09:29

JensHouses added 2 commits August 17, 2024 11:39

Merge remote-tracking branch 'origin/feature/control-panel-and-deskto…

0be1542

…p-reload' into feature/control-panel-and-desktop-reload # Conflicts: # dojo_theme/static/js/dojo/navbar.js

JensHouses marked this pull request as ready for review August 17, 2024 09:54

ConnorNelson reviewed Aug 19, 2024

View reviewed changes

zardus merged commit 9009948 into pwncollege:master Aug 27, 2024
1 check passed

JensHouses deleted the feature/control-panel-and-desktop-reload branch August 30, 2024 11:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactored the control panel and workspace reload #489

Refactored the control panel and workspace reload #489

JensHouses commented Aug 1, 2024

ConnorNelson left a comment

ConnorNelson Aug 8, 2024

JensHouses Aug 8, 2024

ConnorNelson Aug 8, 2024

ConnorNelson Aug 8, 2024

JensHouses commented Aug 9, 2024

ConnorNelson commented Aug 9, 2024

JensHouses commented Aug 10, 2024

zardus commented Aug 14, 2024

JensHouses commented Aug 17, 2024

zardus commented Aug 18, 2024

ConnorNelson Aug 19, 2024

JensHouses Aug 26, 2024

zardus commented Aug 27, 2024

zardus commented Aug 27, 2024

Refactored the control panel and workspace reload #489

Refactored the control panel and workspace reload #489

Conversation

JensHouses commented Aug 1, 2024

ConnorNelson left a comment

Choose a reason for hiding this comment

ConnorNelson Aug 8, 2024

Choose a reason for hiding this comment

JensHouses Aug 8, 2024

Choose a reason for hiding this comment

ConnorNelson Aug 8, 2024

Choose a reason for hiding this comment

ConnorNelson Aug 8, 2024

Choose a reason for hiding this comment

JensHouses commented Aug 9, 2024

ConnorNelson commented Aug 9, 2024

JensHouses commented Aug 10, 2024

zardus commented Aug 14, 2024

JensHouses commented Aug 17, 2024

zardus commented Aug 18, 2024

ConnorNelson Aug 19, 2024

Choose a reason for hiding this comment

JensHouses Aug 26, 2024

Choose a reason for hiding this comment

zardus commented Aug 27, 2024

zardus commented Aug 27, 2024