WIP: Open and save assemblies #165

Vectornaut · 2026-07-13T08:06:25Z

Vectornaut commented

2026-07-13 08:06:25 +00:00

Summary

This pull request enables dyna3 to open assemblies from and save assemblies to files, resolving to-do issue #164.

Changes

Primary

Add the following actions:
- Open an assembly from a local file.
- Open an assembly from a URL.
- Create a new assembly.
Add an open/save interface component that affords the following capabilities:
- Save an assembly to a local file.
- Open an assembly from a local file.
- Open an example assembly.
- Create a new assembly.
Open the example assemblies from files on the server instead of using hard-coded loading scripts. Keep the example assembly files in sync when packaging dyna3 for deployment.

Supporting

Encapsulate the code that clears the workspace in the new clear method of AppState.
Automatically generate loading scripts using the new export method of Assembly.
- Enable elements and regulators to generate their own loading script statements using the new declaration methods of Element and Regulator and the new representation_assignment method of Element. These methods' blanket implementations work for all the elements and regulators we have so far.
Upgrade js-sys to a version where js_sys::Promise implements IntoFuture, allowing the JavaScript promise system to be more seamlessly reflected in Rust code.
Revamp the sidebar
- Make the sidebar styling code simpler and more consistent, facilitating the addition of the open/save component.
- Take the hover highlighting from the new example chooser component and apply it to the existing outline component.

Notes

For readability, the example assembly files are hand-written rather than automatically generated. As a result, many of them don't match the files you get when you open and then save the example assemblies.
Since we're upgrading js-sys anyway, we might as well go to the latest version.

## Summary This pull request enables dyna3 to open assemblies from and save assemblies to files, resolving to-do issue #164. ## Changes ### Primary - Add the following actions: - Open an assembly from a local file. - Open an assembly from a URL. - Create a new assembly. - Add an open/save interface component that affords the following capabilities: - Save an assembly to a local file. - Open an assembly from a local file. - Open an example assembly. - Create a new assembly. - Open the example assemblies from files on the server instead of using hard-coded loading scripts. Keep the example assembly files in sync when packaging dyna3 for deployment. ### Supporting - Encapsulate the code that clears the workspace in the new `clear` method of `AppState`. - Automatically generate loading scripts using the new `export` method of `Assembly`. - Enable elements and regulators to generate their own loading script statements using the new `declaration` methods of `Element` and `Regulator` and the new `representation_assignment` method of `Element`. These methods' blanket implementations work for all the elements and regulators we have so far. - Upgrade `js-sys` to a version where `js_sys::Promise` implements `IntoFuture`, allowing the JavaScript promise system to be [more seamlessly reflected](https://wasm-bindgen.github.io/wasm-bindgen/reference/js-promises-and-rust-futures.html#awaiting-a-promise-directly) in Rust code. - Revamp the sidebar - Make the sidebar styling code simpler and more consistent, facilitating the addition of the open/save component. - Take the hover highlighting from the new example chooser component and apply it to the existing outline component. ## Notes - For readability, the example assembly files are hand-written rather than automatically generated. As a result, many of them don't match the files you get when you open and then save the example assemblies. - Since we're upgrading `js-sys` anyway, we might as well go to the latest version.

Vectornaut added 11 commits

2026-07-13 08:06:25 +00:00

Generalize toolbar styling f483f5ff97

Add an action for opening files 4e44bddb5f

To show that the action works, connect it to a file input on a new
open/save toolbar.

Sketch a file drop area a72341d3e5

We should be able to get similar behavior more easily by using the
file input as the drop area.

Use the file input as the file drop area f8a469e14b

Add an action for starting a new assembly 1d80ebf6b1

Add an action for opening URLs 91a97bc691

To show that the action works, connect it to an example chooser in the
open/save component.

Make the open/save component more modular b711020fd7

Add a way to save the assembly 4857ddcc9a

We should eventually turn this into an action, but that will take some
creative thinking about where to stash the download link. Giving the
save button ownership of the download link feels natural for now.

Make the example chooser more menu-like cf31bf73a1

Apply hover highlighting more consistently 8a6a4aea4e

Sync the examples when packaging for deployment

/ test (pull_request) Successful in 4m26s

Details

112777fca7

In the process, make the tests for the presence of old hash-named files
more robust. These tests should now work when the filename patterns
match multiple files.

Also, tell `git` to ignore the packaged examples.

Vectornaut added 1 commit

2026-07-13 08:33:20 +00:00

Bump js-sys to the latest version

/ test (pull_request) Successful in 4m23s

Details

97f9685d8d

A few new releases of `js-sys` have come out since we started working on
opening and saving assemblies!

Vectornaut referenced this pull request

2026-07-13 08:37:20 +00:00

Open and save assemblies #164

Vectornaut commented

2026-07-13 08:44:14 +00:00

This pull request is ready for @glen to review! I've marked it as a work in progress because it needs one last change before merging: removing the old example chooser. This component has been left in during review so we can more easily spot differences in behavior with the new example chooser, which opens the example assemblies from files on the server instead of from hard-coded loading scripts.

glen reviewed

2026-07-13 21:59:29 +00:00

app-proto/Cargo.toml Outdated

					
				@ -23,4 +22,3 @@

				# the derive macro for the `Named` trait is defined in this internal crate

				derive-named = { path = "derive-named" }

				# We use Charming to help display engine diagnostics

I personally don't think it's worth an additional line of diff just to chase the first letter of a comment from uppercase to lowercase, especially when uppercase looks perfectly normal in the existing comment.

Vectornaut referenced this pull request

2026-07-13 23:52:25 +00:00

Extend hover highlighting to outline items that are selected. #168

glen reviewed

2026-07-17 01:40:05 +00:00

app-proto/src/main.rs

					
				@ -80,0 +83,4 @@

				    fn clear(&self) {

				        // clear the assembly

				        let assembly = &self.assembly;

Isn't this code mis-modularized? In other words, shouldn't either (a) the assembly know how to clear itself, or (b) the state discard the current assembly and replace it with a fresh empty one? I would not expect to see code implementing how an assembly would clear itself in the implementation of a structure that contains an assembly...

Isn't this code mis-modularized? In other words, shouldn't either (a) the assembly know how to clear itself, or (b) the state discard the current assembly and replace it with a fresh empty one? I would not expect to see code implementing how an assembly would clear itself in the implementation of a structure that _contains_ an assembly...

Good call: refactored in commit 1a004ce. Right now, discarding and replacing the assembly would require mutating the app state, which is why I'm clearing the assembly instead. We should revisit the idea of discarding and replacing, though, If we ever redesign the app state to give the assembly field interior mutability—for example, by making it an assembly-valued signal.

Good call: refactored in commit 1a004ce. Right now, discarding and replacing the assembly would require mutating the app state, which is why I'm clearing the assembly instead. We should revisit the idea of discarding and replacing, though, If we ever redesign the app state to give the assembly field interior mutability—for example, by making it an assembly-valued signal.

glen commented

2026-07-17 01:43:38 +00:00

Feel free to also go ahead with finalizing the PR for merging. Thanks.

glen commented

2026-07-17 01:46:53 +00:00

It is also helpful (going forward) to put notations like

Resolves #164.

in the PR description, one issue that the PR will (purportedly) resolve per line. Then they show up in the suggested commit message when one does a squash commit; and if they are in the commit message, then Gitea autocloses the corresponding issue upon merge to main.

It is also helpful (going forward) to put notations like Resolves #164. in the PR description, one issue that the PR will (purportedly) resolve per line. Then they show up in the suggested commit message when one does a squash commit; and if they are in the commit message, then Gitea autocloses the corresponding issue upon merge to main.

👍 1

Vectornaut added 1 commit

2026-07-17 23:23:25 +00:00

Let the assembly clear itself

/ test (pull_request) Successful in 4m28s

Details

1a004cebd0