Import export by Soham2020sam · Pull Request #124 · Modular-Robotics-Group/modular-robotics

Soham2020sam · 2026-02-13T14:33:05Z

New Import Export options

Soham2020sam · 2026-02-13T14:35:37Z

Copilot · 2026-02-13T14:35:46Z

@Soham2020sam I've opened a new pull request, #125, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot

Pull request overview

Adds new Import/Export options to WebVis for downloading scenarios and exporting/importing configurations, integrating the controls into the GUI and tracking the currently loaded scenario for export.

Changes:

Track the currently loaded scenario content/name for later download.
Add Import/Export GUI panel: import config JSON, download current config, import scenario, download scenario, and view saved initial/final configs.
Update index.html to include hidden file inputs for scenario/config uploads.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
`WebVis/src/utils.js`	Adds scenario/config download helpers and config JSON parsing for GUI-driven imports.
`WebVis/src/Scenario.js`	Stores loaded scenario content/name into shared state for export.
`WebVis/src/GUI.js`	Introduces Import/Export GUI and config-loading-from-JSON flow (replacing worker-based view).
`WebVis/index.html`	Adds hidden file inputs used by the new Import/Export GUI actions.
`.DS_Store`	Adds a macOS filesystem artifact (should not be committed).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-13T14:41:39Z

WebVis/src/GUI.js

+    gwUser.camera.position.x = centroid.x;
+    gwUser.camera.position.y = centroid.y;
+    gwUser.camera.position.z = centroid.z + radius + 3.0;
+    gwUser.controls.target.set(centroid.x, centroid.y, centroid.z);
+
+    gwUser.miniCamera.position.x = centroid.x;
+    gwUser.miniCamera.position.y = centroid.y;
+    gwUser.miniCamera.position.z = centroid.z + radius + 3.0;
+    gwUser.miniControls.target.set(centroid.x, centroid.y, centroid.z);


loadConfigurationFromJSON updates camera/controls via gwUser, but gwUser is not defined in this ES module scope (only window.gwUser exists). This will throw a ReferenceError when importing/viewing a config. Use window.gwUser (or import gUser from main.js) consistently within this function.

Suggested change

gwUser.camera.position.x = centroid.x;

gwUser.camera.position.y = centroid.y;

gwUser.camera.position.z = centroid.z + radius + 3.0;

gwUser.controls.target.set(centroid.x, centroid.y, centroid.z);

gwUser.miniCamera.position.x = centroid.x;

gwUser.miniCamera.position.y = centroid.y;

gwUser.miniCamera.position.z = centroid.z + radius + 3.0;

gwUser.miniControls.target.set(centroid.x, centroid.y, centroid.z);

window.gwUser.camera.position.x = centroid.x;

window.gwUser.camera.position.y = centroid.y;

window.gwUser.camera.position.z = centroid.z + radius + 3.0;

window.gwUser.controls.target.set(centroid.x, centroid.y, centroid.z);

window.gwUser.miniCamera.position.x = centroid.x;

window.gwUser.miniCamera.position.y = centroid.y;

window.gwUser.miniCamera.position.z = centroid.z + radius + 3.0;

window.gwUser.miniControls.target.set(centroid.x, centroid.y, centroid.z);

Copilot · 2026-02-13T14:41:40Z

WebVis/src/GUI.js

+    // Invalidate move sequence
+    window.gwMoveSetSequence.invalidate();


window.gwMoveSetSequence.invalidate() does not reset currentCheckpoint/currentMoveSet (see MoveSetSequence.invalidate()), so importing/viewing a config after stepping through moves can leave the overlay showing something like "Move #X / #0". Consider resetting the sequence state (e.g., reset() then invalidate, or replace window.gwMoveSetSequence with a fresh MoveSetSequence) when loading a configuration.

Suggested change

// Invalidate move sequence

window.gwMoveSetSequence.invalidate();

// Reset and invalidate move sequence state

if (window.gwMoveSetSequence) {

window.gwMoveSetSequence.reset();

window.gwMoveSetSequence.invalidate();

}

Copilot · 2026-02-13T14:41:40Z

WebVis/src/GUI.js

 import { moduleBrush, pathfinderData, WorkerType, MessageType, ContentType, VisConfigData, ModuleType, getModuleAtPosition } from './utils.js';
 import { CameraType } from "./utils.js";
-import { saveConfiguration, downloadConfiguration } from './utils.js';
+import { saveConfiguration, downloadConfiguration, downloadScenario, downloadCurrentConfiguration, parseConfigurationJSON } from './utils.js';


downloadConfiguration is imported here but no longer used in this file after the Import/Export refactor. Removing unused imports will avoid dead code and potential lint/build warnings.

Suggested change

import { saveConfiguration, downloadConfiguration, downloadScenario, downloadCurrentConfiguration, parseConfigurationJSON } from './utils.js';

import { saveConfiguration, downloadScenario, downloadCurrentConfiguration, parseConfigurationJSON } from './utils.js';

Copilot · 2026-02-13T14:41:41Z

WebVis/src/utils.js

+export function parseConfigurationJSON(configJSON) {
+    try {
+        const config = JSON.parse(configJSON);
+
+        if (!config.exists) {
+            console.warn("Configuration does not exist");
+            return null;
+        }
+
+        // Determine module type
+        let moduleType;
+        switch (config.moduleType) {
+            case 'CUBE': moduleType = ModuleType.CUBE; break;
+            case 'RHOMBIC_DODECAHEDRON': moduleType = ModuleType.RHOMBIC_DODECAHEDRON; break;
+            case 'CATOM': moduleType = ModuleType.CATOM; break;
+            default:
+                console.log("Unknown module type ", config.moduleType, " -- defaulting to CUBE");
+                moduleType = ModuleType.CUBE;
+                break;
+        }
+
+        return {
+            moduleType: moduleType,
+            modules: config.modules,
+            name: config.name,
+            description: config.description
+        };


parseConfigurationJSON returns config.modules without validating its shape. loadConfigurationFromJSON immediately does configData.modules.forEach(...), which will throw if modules is missing or not an array. Validate that config.modules is an array (and that each entry has a position array) before returning parsed data, and return null with a clear error when invalid.

Copilot · 2026-02-13T14:41:41Z

WebVis/src/GUI.js

+    // Update reference module to match the loaded configuration type
+    gReferenceModule.swapType(configData.moduleType);
+    gHighlightModule.swapType(configData.moduleType);
+


After loading a configuration, moduleBrush.type is not updated to match configData.moduleType. Since createPathfinderConfiguration() (and module placement) rely on moduleBrush.type, subsequent save/download/pathfinder runs can produce a config with the wrong moduleType/adjacency settings. Set moduleBrush.type (and update the corresponding GUI controller) when a config is loaded.

Suggested change

// Ensure module brush type matches the loaded configuration's module type

moduleBrush.type = configData.moduleType;

Copilot · 2026-02-13T14:41:42Z

WebVis/src/Scenario.js

+
+        // Store the scenario content for export
+        pathfinderData.currentScenario = rawString;
+        console.log("Stored scenario content, length:", rawString ? rawString.length : 0);

        // remove '\r' characters
        rawString = rawString.replace(/\r/g, '');


pathfinderData.currentScenario is captured before normalizing line endings (rawString.replace(/\r/g, '')). If a Windows-style .scen is loaded, downloading it later will re-export the un-normalized content even though the app parsed the normalized version. Consider storing the sanitized rawString (after removing \r) so export matches what was actually loaded/parsed.

Suggested change

// Store the scenario content for export

pathfinderData.currentScenario = rawString;

console.log("Stored scenario content, length:", rawString ? rawString.length : 0);

// remove '\r' characters

rawString = rawString.replace(/\r/g, '');

// remove '\r' characters so parsing and export use the same normalized content

rawString = (rawString || '').replace(/\r/g, '');

// Store the scenario content for export

pathfinderData.currentScenario = rawString;

console.log("Stored scenario content, length:", rawString.length);

Copilot · 2026-02-13T14:41:42Z

WebVis/src/GUI.js

+    // Reset Data
+    VisConfigData.nextModID = 0;
+    VisConfigData.clearBounds();
+


Loading a configuration does not clear pathfinderData.currentScenario / currentScenarioName, so the new "Download Scenario" action can still export an older scenario after a config import/view. Consider explicitly clearing the current scenario fields when switching to a pure-configuration view to avoid exporting stale data.

Suggested change

// Clear any loaded scenario, since we're switching to a pure configuration view

if (pathfinderData) {

pathfinderData.currentScenario = null;

pathfinderData.currentScenarioName = null;

}

Copilot · 2026-02-13T14:41:42Z

WebVis/src/GUI.js

 import { GUI } from 'three/addons/libs/lil-gui.module.min.js';
 import { Scenario } from './Scenario.js';
-import { gScene, gLights, gRenderer, gModules, gReferenceModule, gModulePositions, gCanvas, gHighlightModule } from './main.js';
+import { gScene, gLights, gRenderer, gModules, gReferenceModule, gModulePositions, gCanvas, gHighlightModule, cancelActiveMove } from './main.js';


Unused import gModulePositions.

Suggested change

import { gScene, gLights, gRenderer, gModules, gReferenceModule, gModulePositions, gCanvas, gHighlightModule, cancelActiveMove } from './main.js';

import { gScene, gLights, gRenderer, gModules, gReferenceModule, gCanvas, gHighlightModule, cancelActiveMove } from './main.js';

Copilot · 2026-02-13T14:41:42Z

WebVis/src/utils.js

+export function downloadCurrentConfiguration() {
+    const config = createPathfinderConfiguration();
+
+    if (!config || !config.exists) {


This guard always evaluates to false.

Suggested change

if (!config || !config.exists) {

if (!config) {

Copilot · 2026-02-13T14:41:43Z

WebVis/src/GUI.js

+        reader.readAsText(file);
+        // Reset the input so the same file can be selected again
+        configUploadElement.value = '';
+    }


Avoid automated semicolon insertion (97% of all statements in the enclosing function have an explicit semicolon).

Soham2020sam added 3 commits December 12, 2025 15:45

new export :)

6cd590e

import export

9b8aa6f

fixed

f577191

Soham2020sam requested a review from Copilot February 13, 2026 14:35

Copilot AI mentioned this pull request Feb 13, 2026

Code review response: identify critical issues in import/export implementation #125

Draft

Copilot started reviewing on behalf of Soham2020sam February 13, 2026 14:36 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

copilot

c1c6b83

		// Invalidate move sequence
		window.gwMoveSetSequence.invalidate();

	import { saveConfiguration, downloadConfiguration, downloadScenario, downloadCurrentConfiguration, parseConfigurationJSON } from './utils.js';
	import { saveConfiguration, downloadScenario, downloadCurrentConfiguration, parseConfigurationJSON } from './utils.js';



	// Ensure module brush type matches the loaded configuration's module type
	moduleBrush.type = configData.moduleType;

+    // Clear any loaded scenario, since we're switching to a pure configuration view
+    if (pathfinderData) {
+        pathfinderData.currentScenario = null;
+        pathfinderData.currentScenarioName = null;
+    }

	import { gScene, gLights, gRenderer, gModules, gReferenceModule, gModulePositions, gCanvas, gHighlightModule, cancelActiveMove } from './main.js';
	import { gScene, gLights, gRenderer, gModules, gReferenceModule, gCanvas, gHighlightModule, cancelActiveMove } from './main.js';

Comments

Conversation

Soham2020sam commented Feb 13, 2026

Uh oh!

Soham2020sam commented Feb 13, 2026

Uh oh!

Copilot AI commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants