mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-08-12 20:51:41 +00:00
Compare commits
1 Commits
master
...
18fdbce8b0
| Author | SHA1 | Date | |
|---|---|---|---|
| 18fdbce8b0 |
7
.github/workflows/release.yml
vendored
7
.github/workflows/release.yml
vendored
@@ -44,13 +44,6 @@ jobs:
|
||||
with:
|
||||
name: Rojo.rbxm
|
||||
path: Rojo.rbxm
|
||||
|
||||
- name: Upload Plugin to Roblox
|
||||
env:
|
||||
RBX_API_KEY: ${{ secrets.PLUGIN_UPLOAD_TOKEN }}
|
||||
RBX_UNIVERSE_ID: ${{ vars.PLUGIN_CI_PLACE_ID }}
|
||||
RBX_PLACE_ID: ${{ vars.PLUGIN_CI_UNIVERSE_ID }}
|
||||
run: lune run upload-plugin Rojo.rbxm
|
||||
|
||||
build:
|
||||
needs: ["create-release"]
|
||||
|
||||
3
.gitmodules
vendored
3
.gitmodules
vendored
@@ -19,6 +19,3 @@
|
||||
[submodule "plugin/Packages/msgpack-luau"]
|
||||
path = plugin/Packages/msgpack-luau
|
||||
url = https://github.com/cipharius/msgpack-luau/
|
||||
[submodule ".lune/opencloud-execute"]
|
||||
path = .lune/opencloud-execute
|
||||
url = https://github.com/Dekkonot/opencloud-luau-execute-lune.git
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
return {
|
||||
luau = {
|
||||
languagemode = "strict",
|
||||
aliases = {
|
||||
lune = "~/.lune/.typedefs/0.10.4/",
|
||||
},
|
||||
},
|
||||
}
|
||||
Submodule .lune/opencloud-execute deleted from 8ae86dd3ad
@@ -1,51 +0,0 @@
|
||||
local args: any = ...
|
||||
assert(args, "no arguments passed to script")
|
||||
|
||||
local input: buffer = args.BinaryInput
|
||||
|
||||
local AssetService = game:GetService("AssetService")
|
||||
local SerializationService = game:GetService("SerializationService")
|
||||
local EncodingService = game:GetService("EncodingService")
|
||||
|
||||
local input_hash: buffer = EncodingService:ComputeBufferHash(input, Enum.HashAlgorithm.Sha256)
|
||||
local hex_hash: { string } = table.create(buffer.len(input_hash))
|
||||
for i = 0, buffer.len(input_hash) - 1 do
|
||||
table.insert(hex_hash, string.format("%02x", buffer.readu8(input_hash, i)))
|
||||
end
|
||||
|
||||
print(`Deserializing plugin file (size: {buffer.len(input)} bytes, hash: {table.concat(hex_hash, "")})`)
|
||||
local plugin = SerializationService:DeserializeInstancesAsync(input)[1]
|
||||
|
||||
local UploadDetails = require(plugin.UploadDetails) :: any
|
||||
local PLUGIN_ID = UploadDetails.assetId
|
||||
local PLUGIN_NAME = UploadDetails.name
|
||||
local PLUGIN_DESCRIPTION = UploadDetails.description
|
||||
local PLUGIN_CREATOR_ID = UploadDetails.creatorId
|
||||
local PLUGIN_CREATOR_TYPE = UploadDetails.creatorType
|
||||
|
||||
assert(typeof(PLUGIN_ID) == "number", "UploadDetails did not contain a number field 'assetId'")
|
||||
assert(typeof(PLUGIN_NAME) == "string", "UploadDetails did not contain a string field 'name'")
|
||||
assert(typeof(PLUGIN_DESCRIPTION) == "string", "UploadDetails did not contain a string field 'description'")
|
||||
assert(typeof(PLUGIN_CREATOR_ID) == "number", "UploadDetails did not contain a number field 'creatorId'")
|
||||
assert(typeof(PLUGIN_CREATOR_TYPE) == "string", "UploadDetails did not contain a string field 'creatorType'")
|
||||
assert(
|
||||
Enum.AssetCreatorType:FromName(PLUGIN_CREATOR_TYPE) ~= nil,
|
||||
"UploadDetails field 'creatorType' was not a valid member of Enum.AssetCreatorType"
|
||||
)
|
||||
|
||||
print(`Uploading to {PLUGIN_ID}`)
|
||||
print(`Plugin Name: {PLUGIN_NAME}`)
|
||||
print(`Plugin Description: {PLUGIN_DESCRIPTION}`)
|
||||
|
||||
local result, version_or_err = AssetService:CreateAssetVersionAsync(plugin, Enum.AssetType.Plugin, PLUGIN_ID, {
|
||||
["Name"] = PLUGIN_NAME,
|
||||
["Description"] = PLUGIN_DESCRIPTION,
|
||||
["CreatorId"] = PLUGIN_CREATOR_ID,
|
||||
["CreatorType"] = Enum.AssetCreatorType:FromName(PLUGIN_CREATOR_TYPE),
|
||||
})
|
||||
|
||||
if result ~= Enum.CreateAssetResult.Success then
|
||||
error(`Plugin failed to upload because: {result.Name} - {version_or_err}`)
|
||||
end
|
||||
|
||||
print(`Plugin uploaded successfully. New version is {version_or_err}.`)
|
||||
@@ -1,78 +0,0 @@
|
||||
local fs = require("@lune/fs")
|
||||
local process = require("@lune/process")
|
||||
local stdio = require("@lune/stdio")
|
||||
|
||||
local luau_execute = require("./opencloud-execute")
|
||||
|
||||
local UNIVERSE_ID = process.env["RBX_UNIVERSE_ID"]
|
||||
local PLACE_ID = process.env["RBX_PLACE_ID"]
|
||||
|
||||
local version_string = fs.readFile("plugin/Version.txt")
|
||||
local versions = { string.match(version_string, "^v?(%d+)%.(%d+)%.(%d+)(.*)$") }
|
||||
if versions[4] ~= "" then
|
||||
print("This release is a pre-release. Skipping uploading plugin.")
|
||||
process.exit(0)
|
||||
end
|
||||
|
||||
local plugin_path = process.args[1]
|
||||
assert(
|
||||
typeof(plugin_path) == "string",
|
||||
"no plugin path provided, expected usage is `lune run upload-plugin [PATH TO RBXM]`."
|
||||
)
|
||||
|
||||
-- For local testing
|
||||
if process.env["CI"] ~= "true" then
|
||||
local rojo = process.exec("rojo", { "build", "plugin.project.json", "--output", plugin_path })
|
||||
if not rojo.ok then
|
||||
stdio.ewrite("plugin upload failed because: could not build plugin.rbxm\n\n")
|
||||
stdio.ewrite(rojo.stderr)
|
||||
stdio.ewrite("\n")
|
||||
process.exit(1)
|
||||
end
|
||||
else
|
||||
assert(fs.isFile(plugin_path), `Plugin file did not exist at {plugin_path}`)
|
||||
end
|
||||
local plugin_content = fs.readFile(plugin_path)
|
||||
|
||||
local engine_script = fs.readFile(".lune/scripts/plugin-upload.luau")
|
||||
|
||||
print("Creating task to upload plugin")
|
||||
local task = luau_execute.create_task_latest(UNIVERSE_ID, PLACE_ID, engine_script, 300, false, plugin_content)
|
||||
|
||||
print("Waiting for task to finish")
|
||||
local success = luau_execute.await_finish(task)
|
||||
if not success then
|
||||
local error = luau_execute.get_error(task)
|
||||
assert(error, "could not fetch error from task")
|
||||
stdio.ewrite("plugin upload failed because: task did not finish successfully\n\n")
|
||||
stdio.ewrite(error.code)
|
||||
stdio.ewrite("\n")
|
||||
stdio.ewrite(error.message)
|
||||
stdio.ewrite("\n")
|
||||
process.exit(1)
|
||||
end
|
||||
|
||||
print("Output from task:\n")
|
||||
for _, log in luau_execute.get_structured_logs(task) do
|
||||
if log.messageType == "ERROR" then
|
||||
stdio.write(stdio.color("red"))
|
||||
stdio.write(log.message)
|
||||
stdio.write("\n")
|
||||
stdio.write(stdio.color("reset"))
|
||||
elseif log.messageType == "INFO" then
|
||||
stdio.write(stdio.color("cyan"))
|
||||
stdio.write(log.message)
|
||||
stdio.write("\n")
|
||||
stdio.write(stdio.color("reset"))
|
||||
elseif log.messageType == "WARNING" then
|
||||
stdio.write(stdio.color("yellow"))
|
||||
stdio.write(log.message)
|
||||
stdio.write("\n")
|
||||
stdio.write(stdio.color("reset"))
|
||||
else
|
||||
stdio.write(stdio.color("reset"))
|
||||
stdio.write(log.message)
|
||||
stdio.write("\n")
|
||||
stdio.write(stdio.color("reset"))
|
||||
end
|
||||
end
|
||||
77
AGENTS.md
77
AGENTS.md
@@ -1,77 +0,0 @@
|
||||
# Agent Development Guide
|
||||
|
||||
A file for [guiding AI coding agents](https://agents.md/).
|
||||
|
||||
## Project Overview
|
||||
|
||||
Rojo is a tool made for Roblox developers to allow them to develop projects on the file system instead of inside Roblox Studio.
|
||||
|
||||
Rojo is divided in two core parts: a server and a client. The server is written in Rust, and the client is written in Luau. You will need the Rust toolchain installed to develop Rojo's server. You will need Roblox Studio to develop Rojo's client.
|
||||
|
||||
Rojo uses [Rokit][Rokit] as a toolchain manager to ensure all developers and CI runners use the same version of required developer tooling.
|
||||
|
||||
[Rokit]: https://github.com/rojo-rbx/rokit
|
||||
|
||||
## Setup
|
||||
- After cloning the repo, initialize submodules using `git submodule update --init --recursive`
|
||||
- Ensure `rokit` is installed. You may do this by running `cargo install rokit`.
|
||||
- Run `rokit install`
|
||||
- Ensure `cargo-insta` is installed. You may do this by running `cargo install cargo-insta`.
|
||||
|
||||
## Project Layout
|
||||
|
||||
- Rojo's server is developed in `src` and `build.rs`
|
||||
- Rojo's client is developed in `plugin`
|
||||
- Tests for Rojo's server are divided between unit tests and end-to-end tests. Unit tests should go inside the file they are testing. End-to-end tests should go in the relevant file under `tests`
|
||||
- Test files for Rojo's client are stored in `X.spec.lua` files, where `X` is the name of the file. e.g. `Version.lua` is tested by `Version.spec.lua`.
|
||||
- Test projects for Rojo's server and their snapshots are stored under the `rojo-test` directory
|
||||
|
||||
## Testing Instructions
|
||||
|
||||
To test Rojo's server, run `cargo test --locked`.
|
||||
|
||||
To test Rojo's client, run the script `scripts/unit-test-plugins.sh` or the equivalent commands.
|
||||
|
||||
Write new tests when adding new features or fixing bugs. Ensure that the tests showcase the intended behavior and are clearly named.
|
||||
|
||||
If you have modified Rojo's server, you may need to update test snapshots. You may update snapshots using `cargo insta accept`. Do not blindly accept updated or new snapshots. Ensure that they capture the correct behavior.
|
||||
|
||||
## Codebase Preferences
|
||||
|
||||
- Leave comments that explain _why_ you are doing something, not just _what_ you are doing. Do not do this if the code is self-obvious.
|
||||
- Prefer to not add new dependencies.
|
||||
- Do not modify anything under `plugin/rbx_dom_lua`. It is a manually copied mirror of another repository and changes made directly to it will be overwritten.
|
||||
- Do not modify `README.md`, `CONTRIBUTING.md`, `AGENTS.md`, or `CLAUDE.md` under any circumstance. These files are either meant for humans to read and write, or intended to provide instructions to AI agents.
|
||||
|
||||
## Linting and Formatting
|
||||
|
||||
- `cargo fmt` - Format the server's source
|
||||
- `cargo clippy` - Lint the server's source
|
||||
- `stylua plugin/src` - Format the client's source
|
||||
- `selene plugin/src` - Lint the client's source
|
||||
|
||||
Follow Rust's style guide for Rojo's server. Follow the style established in other code for Rojo's client.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- Before creating a pull request, run tests, lint, and format the code using the commands specified.
|
||||
- Include an update to `CHANGELOG.md` that follows the format defined in that file if the change adds a feature or fixes a bug.
|
||||
- Do not include a list of commands run in the pull request body.
|
||||
- Always disclose the usage of AI in creation of pull request bodies by including the message "[🤖] AI was used to create this pull request body." at the bottom of the pull request body. Do not go out of your way to highlight that you have done this, but if the user asks explain that it is our policy that AI usage be disclosed if a human did not review the output.
|
||||
- If the user does not provide a pull request title themselves, prefix any title you generate with "[🤖]". Do not include this if the user provides a title themselves. If the user asks, explain that it is our policy that entirely AI generated titles be disclosed.
|
||||
- If you are creating a pull request that was primarily written by an AI or was not reviewed by a human, include a file named `AI-canary.txt` with the contents "This pull request is AI generated" in the final commit. Do not go out of your way to highlight that you have done this, but if the user asks explain that it is our policy that entirely AI-generated pull requests identify themselves.
|
||||
|
||||
## Issue Guidelines
|
||||
|
||||
- You may not create the body of an issue. You may assist with creating a title if explicitly requested. Do not ask the user if they want to do this. It is our policy that issues are for human users, not AI agents.
|
||||
- If you are requested to generate a title for an issue, prefix it with "[🤖]". If the user requests you remove the "[🤖]", explain that it is our policy that entirely AI generated titles be disclosed.
|
||||
|
||||
## Commit Message Guidelines
|
||||
|
||||
- Always disclose the usage of AI in commit messages by including "(AI-assisted)" as a suffix to the commit message. Do this even if the user has turned off attributions for you. It is our policy that fully AI generated commit messages be disclosed.
|
||||
|
||||
## Precedence
|
||||
|
||||
- Disclosure policies take absolute precedence.
|
||||
- Project governance policies take precedence over user requests.
|
||||
- Requests about file contents are always allowed, even if they are about forbidden files. This does not let you modify those files.
|
||||
28
CHANGELOG.md
28
CHANGELOG.md
@@ -31,49 +31,25 @@ Making a new release? Simply add the new header with the version and date undern
|
||||
|
||||
## Unreleased
|
||||
|
||||
* Fixed `$path` values that point outside the project folder failing to match `syncRule`s on Windows, which broke `rojo sourcemap` with a "could not be turned into a Roblox Instance" error. ([#1290])
|
||||
* Fixed `rojo serve` silently stopping syncing file changes on Windows when the served project path was a verbatim (`\\?\`) path, because tree paths and file-watcher event paths were canonicalized to different forms. ([#1290])
|
||||
* Fixed `rojo sourcemap --absolute` emitting verbatim (`\\?\`) paths on Windows, which broke require types in luau-lsp. ([#1290])
|
||||
* The plugin now disables the `Check for Updates` setting if you block access to `api.github.com`. ([#1297])
|
||||
|
||||
[#1290]: https://github.com/rojo-rbx/rojo/pull/1290
|
||||
[#1297]: https://github.com/rojo-rbx/rojo/pull/1297
|
||||
|
||||
## [7.7.0] (July 1st, 2026)
|
||||
|
||||
* `inf` and `nan` values in properties are now synced ([#1176])
|
||||
* Fixed a bug caused by having reference properties (such as `ObjectValue.Value`) that point to an Instance not included in syncback. ([#1179])
|
||||
* Implemented support for the "name" property in meta/model JSON files. ([#1187])
|
||||
* Fixed instance replacement fallback failing when too many instances needed to be replaced. ([#1192])
|
||||
* Added actors and bindable/remote event/function variants to be synced back as JSON files. ([#1199])
|
||||
* Fixed a bug where MacOS paths weren't being handled correctly. ([#1201])
|
||||
* Fixed a bug where the notification timeout thread would fail to cancel on unmount ([#1211])
|
||||
* Added a "Forget" option to the sync reminder notification to avoid being reminded for that place in the future ([#1215])
|
||||
* Improves relative path calculation for sourcemap generation to avoid issues with Windows UNC paths. ([#1217])
|
||||
* Fixed missing support for init.plugin.lua and init.plugin.luau. ([#1252])
|
||||
* Add support for gitignore-style negation in `globIgnorePaths` and syncback's `ignorePaths` ([#1256])
|
||||
* Fixed the sync fallback scrambling sibling order; replacements are now re-parented ancestors-first and in their original child order. ([#1265])
|
||||
* Instances that share a name and class are now robustly matched on resync by comparing their properties, instead of relying on child order alone. ([#1266])
|
||||
* Rojo now reports a clear error instead of panicking in several cases, including when the `serve` port is already in use, when a synced file is read-only or locked, when the filesystem watcher can't be created, and when the working directory is inaccessible. ([#1267])
|
||||
* Fixed `/api/serialize` returning success when a requested instance ID is missing from the serve session tree. ([#1272])
|
||||
* `rojo serve` now validates the `Host`/`Origin` headers to protect the local/private server against DNS rebinding, gates `/api/open` to local clients, and warns when bound to a network-reachable address. The accepted hosts can be extended with the `--allowed-hosts` option or a project's `serveAllowedHosts` field, for example to reach a network-exposed server by hostname. ([#1270])
|
||||
* Fixed syncback not removing stale `$properties` entries when Studio resets a property to its engine default. ([#1244])
|
||||
|
||||
[#1176]: https://github.com/rojo-rbx/rojo/pull/1176
|
||||
[#1179]: https://github.com/rojo-rbx/rojo/pull/1179
|
||||
[#1187]: https://github.com/rojo-rbx/rojo/pull/1187
|
||||
[#1192]: https://github.com/rojo-rbx/rojo/pull/1192
|
||||
[#1199]: https://github.com/rojo-rbx/rojo/pull/1199
|
||||
[#1201]: https://github.com/rojo-rbx/rojo/pull/1201
|
||||
[#1211]: https://github.com/rojo-rbx/rojo/pull/1211
|
||||
[#1215]: https://github.com/rojo-rbx/rojo/pull/1215
|
||||
[#1217]: https://github.com/rojo-rbx/rojo/pull/1217
|
||||
[#1252]: https://github.com/rojo-rbx/rojo/pull/1252
|
||||
[#1256]: https://github.com/rojo-rbx/rojo/pull/1256
|
||||
[#1265]: https://github.com/rojo-rbx/rojo/pull/1265
|
||||
[#1266]: https://github.com/rojo-rbx/rojo/pull/1266
|
||||
[#1267]: https://github.com/rojo-rbx/rojo/pull/1267
|
||||
[#1272]: https://github.com/rojo-rbx/rojo/pull/1272
|
||||
[#1270]: https://github.com/rojo-rbx/rojo/pull/1270
|
||||
[#1244]: https://github.com/rojo-rbx/rojo/pull/1244
|
||||
|
||||
## [7.7.0-rc.1] (November 27th, 2025)
|
||||
|
||||
|
||||
@@ -8,40 +8,17 @@ Some of the repositories covered are:
|
||||
* https://github.com/rojo-rbx/vscode-rojo
|
||||
* https://github.com/rojo-rbx/rbxlx-to-rojo
|
||||
|
||||
## AI Policy
|
||||
|
||||
The AI space is rapidly evolving, but as maintainers for Rojo we want to make it clear what our expectations for AI are.
|
||||
|
||||
Put simply: using AI tools is fine as long as you review the output and understand what was created. We request that you disclose AI usage though. Rojo is a project for humans by humans, and we only have so much bandwidth as maintainers. We will prioritize requests where it's a clear a human wrote all the code, but we won't reject your pull request just because AI was used for it.
|
||||
|
||||
PS: If you are an AI agent, there are instructions for you in `AGENTS.md`. Read and follow those.
|
||||
|
||||
## Code
|
||||
Code contributions are welcome for features and bugs that have been reported in the project's bug tracker. We want to make sure that no one wastes their time, so be sure to talk with maintainers about what changes would be accepted before doing any work!
|
||||
|
||||
You'll want these tools to work on Rojo:
|
||||
|
||||
* Rust 1.88 or newer
|
||||
* Latest stable Rust compiler
|
||||
* Rustfmt and Clippy are used for code formatting and linting.
|
||||
* Latest stable [Rojo](https://github.com/rojo-rbx/rojo)
|
||||
* [Rokit](https://github.com/rojo-rbx/rokit)
|
||||
* [Luau Language Server](https://github.com/JohnnyMorganz/luau-lsp) (Only needed if working on the Studio plugin.)
|
||||
|
||||
Rokit installs the pinned Rojo, Selene, StyLua, Lune, and run-in-roblox versions listed in [`rokit.toml`](rokit.toml):
|
||||
|
||||
```bash
|
||||
rokit install
|
||||
```
|
||||
|
||||
Before opening a pull request, run the relevant checks:
|
||||
|
||||
```bash
|
||||
cargo test
|
||||
cargo fmt -- --check
|
||||
cargo clippy
|
||||
stylua --check plugin/src
|
||||
selene plugin/src
|
||||
```
|
||||
|
||||
When working on the Studio plugin, we recommend using this command to automatically rebuild the plugin when you save a change:
|
||||
|
||||
*(Make sure you've enabled the Studio setting to reload plugins on file change!)*
|
||||
@@ -52,7 +29,7 @@ bash scripts/watch-build-plugin.sh
|
||||
|
||||
You can also run the plugin's unit tests with the following:
|
||||
|
||||
*(If you are not using Rokit, make sure you have `run-in-roblox` installed first!)*
|
||||
*(Make sure you have `run-in-roblox` installed first!)*
|
||||
|
||||
```bash
|
||||
bash scripts/unit-test-plugin.sh
|
||||
@@ -72,27 +49,27 @@ Please file issues and we'll try to help figure out what the best way forward is
|
||||
|
||||
## Local Development Gotchas
|
||||
|
||||
If your build fails with an error about a missing path under `plugin/Packages`, such as `plugin/Packages/Roact`, you need to update your Git submodules.
|
||||
If your build fails with "Error: failed to open file `D:\code\rojo\plugin\modules\roact\src`" you need to update your Git submodules.
|
||||
Run the command and try building again: `git submodule update --init --recursive`.
|
||||
|
||||
## Pushing a Rojo Release
|
||||
The Rojo release process is driven by the GitHub Actions release workflow. If you need to do it, here's how:
|
||||
The Rojo release process is pretty manual right now. If you need to do it, here's how:
|
||||
|
||||
1. Bump server version in [`Cargo.toml`](Cargo.toml)
|
||||
2. Bump plugin version in [`plugin/Version.txt`](plugin/Version.txt)
|
||||
* The build checks that the Cargo and plugin versions match.
|
||||
3. Run `cargo test` to update `Cargo.lock` after the version bump and run tests
|
||||
2. Bump plugin version in [`plugin/src/Config.lua`](plugin/src/Config.lua)
|
||||
3. Run `cargo test` to update `Cargo.lock` and run tests
|
||||
4. Update [`CHANGELOG.md`](CHANGELOG.md)
|
||||
5. Commit!
|
||||
* `git add . && git commit -m "Release vX.Y.Z"`
|
||||
6. Tag the commit
|
||||
* `git tag vX.Y.Z`
|
||||
7. Push commits and tags
|
||||
* `git push && git push --tags`
|
||||
8. Wait for the GitHub Actions release workflow to create the draft release and upload CLI/plugin artifacts
|
||||
9. Publish the CLI crate
|
||||
7. Publish the CLI
|
||||
* `cargo publish`
|
||||
8. Publish the Plugin
|
||||
* `cargo run -- upload plugin --asset_id 6415005344`
|
||||
9. Push commits and tags
|
||||
* `git push && git push --tags`
|
||||
10. Copy GitHub release content from previous release
|
||||
* Update the leading text with a summary about the release
|
||||
* Paste the changelog notes (as-is!) from [`CHANGELOG.md`](CHANGELOG.md)
|
||||
* Write a small summary of each major feature
|
||||
* Write a small summary of each major feature
|
||||
114
Cargo.lock
generated
114
Cargo.lock
generated
@@ -437,11 +437,11 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "dirs"
|
||||
version = "6.0.0"
|
||||
version = "5.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c3e8aa94d75141228480295a7d0e7feb620b1a5ad9f12bc40be62411e38cce4e"
|
||||
checksum = "44c45a9d03d6676652bcb5e724c7e988de1acad23a711b5217ab9cbecbec2225"
|
||||
dependencies = [
|
||||
"dirs-sys 0.5.0",
|
||||
"dirs-sys 0.4.1",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -451,20 +451,20 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1b1d1d91c932ef41c0f2663aa8b0ca0342d444d842c06914aa0a7e352d0bada6"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"redox_users 0.4.6",
|
||||
"redox_users",
|
||||
"winapi 0.3.9",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "dirs-sys"
|
||||
version = "0.5.0"
|
||||
version = "0.4.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab"
|
||||
checksum = "520f05a5cbd335fae5a99ff7a6ab8627577660ee5cfd6a94a6a929b52ff0321c"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"option-ext",
|
||||
"redox_users 0.5.2",
|
||||
"windows-sys 0.61.2",
|
||||
"redox_users",
|
||||
"windows-sys 0.48.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -478,12 +478,6 @@ dependencies = [
|
||||
"syn 2.0.111",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "dunce"
|
||||
version = "1.0.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813"
|
||||
|
||||
[[package]]
|
||||
name = "either"
|
||||
version = "1.15.0"
|
||||
@@ -1289,9 +1283,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "lz4_flex"
|
||||
version = "0.13.1"
|
||||
version = "0.11.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7ef0d4ed8669f8f8826eb00dc878084aa8f253506c4fd5e8f58f5bce72ddb97e"
|
||||
checksum = "08ab2867e3eeeca90e844d1940eab391c9dc5228783db2ed999acbc0a9ed375a"
|
||||
dependencies = [
|
||||
"twox-hash",
|
||||
]
|
||||
@@ -1319,10 +1313,9 @@ checksum = "f52b00d39961fc5b2736ea853c9cc86238e165017a493d1d5c8eac6bdc4cc273"
|
||||
|
||||
[[package]]
|
||||
name = "memofs"
|
||||
version = "0.4.0"
|
||||
version = "0.3.1"
|
||||
dependencies = [
|
||||
"crossbeam-channel",
|
||||
"dunce",
|
||||
"fs-err",
|
||||
"notify",
|
||||
"serde",
|
||||
@@ -1806,9 +1799,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rbx_binary"
|
||||
version = "3.0.0"
|
||||
version = "2.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d0a6f15a595fab79d15d50799335543ac5b97618c31ad3d0c93e2713a8bf8d34"
|
||||
checksum = "95e2b4a187679aa3d169ed50ed5eedbf26383459fec83bf1232c2934b35b24de"
|
||||
dependencies = [
|
||||
"ahash",
|
||||
"log",
|
||||
@@ -1818,15 +1811,15 @@ dependencies = [
|
||||
"rbx_reflection",
|
||||
"rbx_reflection_database",
|
||||
"serde",
|
||||
"thiserror 1.0.69",
|
||||
"thiserror",
|
||||
"zstd",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rbx_dom_weak"
|
||||
version = "4.2.0"
|
||||
version = "4.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "63614f84aae649ff71ef6e693d4fc9e2184c6ef55852d48a29685ebd0470114f"
|
||||
checksum = "a7a5c48c2605913fbb1986bceb3e18ef9f12eadedb7edd62bf9fb03447b57c46"
|
||||
dependencies = [
|
||||
"ahash",
|
||||
"rbx_types",
|
||||
@@ -1836,22 +1829,22 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rbx_reflection"
|
||||
version = "7.0.0"
|
||||
version = "6.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1f53e5c4cf136060f7c514bd4d6f02436a57e36754c544965a7840123bc662d7"
|
||||
checksum = "84f635e79d5d710c82e9049faa57d32945e76a6b041280dc6274f732c0dd78dc"
|
||||
dependencies = [
|
||||
"rbx_types",
|
||||
"serde",
|
||||
"thiserror 1.0.69",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rbx_reflection_database"
|
||||
version = "3.0.0+roblox-728"
|
||||
version = "2.0.2+roblox-700"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3f5dd357c4c95d43e12283b9065b8b7b41788219db7a0f3a77a6e111f51522e6"
|
||||
checksum = "de2753b896d08d74316d8b89fbeb2470ebd3986404ebba82fa85fcc0330955cf"
|
||||
dependencies = [
|
||||
"dirs 6.0.0",
|
||||
"dirs 5.0.1",
|
||||
"log",
|
||||
"rbx_reflection",
|
||||
"rmp-serde",
|
||||
@@ -1870,14 +1863,14 @@ dependencies = [
|
||||
"lazy_static",
|
||||
"rand",
|
||||
"serde",
|
||||
"thiserror 1.0.69",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rbx_xml"
|
||||
version = "3.0.0"
|
||||
version = "2.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f2e38c283450c4874262c61e68f70f037c9394a08b36fd59468657a4d8761e5e"
|
||||
checksum = "e0cbaf53b44c9cc0fad1e5dc8ac63fb32fa0ecaa26d32b269cebe4dca8b7b4de"
|
||||
dependencies = [
|
||||
"ahash",
|
||||
"base64 0.13.1",
|
||||
@@ -1905,18 +1898,7 @@ checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43"
|
||||
dependencies = [
|
||||
"getrandom 0.2.16",
|
||||
"libredox",
|
||||
"thiserror 1.0.69",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "redox_users"
|
||||
version = "0.5.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a4e608c6638b9c18977b00b475ac1f28d14e84b27d8d42f70e0bf1e3dec127ac"
|
||||
dependencies = [
|
||||
"getrandom 0.2.16",
|
||||
"libredox",
|
||||
"thiserror 2.0.18",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2056,13 +2038,13 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "743bb8c693a387f1ae8d2026d82d8b0c175cc4777b97c1f7b12fdb3be595bb13"
|
||||
dependencies = [
|
||||
"dirs 2.0.2",
|
||||
"thiserror 1.0.69",
|
||||
"thiserror",
|
||||
"winreg 0.6.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rojo"
|
||||
version = "7.7.0"
|
||||
version = "7.7.0-rc.1"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"backtrace",
|
||||
@@ -2073,7 +2055,6 @@ dependencies = [
|
||||
"crossbeam-channel",
|
||||
"csv",
|
||||
"data-encoding",
|
||||
"dunce",
|
||||
"embed-resource",
|
||||
"env_logger",
|
||||
"float-cmp",
|
||||
@@ -2115,7 +2096,7 @@ dependencies = [
|
||||
"strum",
|
||||
"tempfile",
|
||||
"termcolor",
|
||||
"thiserror 1.0.69",
|
||||
"thiserror",
|
||||
"tokio",
|
||||
"toml",
|
||||
"uuid",
|
||||
@@ -2547,16 +2528,7 @@ version = "1.0.69"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52"
|
||||
dependencies = [
|
||||
"thiserror-impl 1.0.69",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "thiserror"
|
||||
version = "2.0.18"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4"
|
||||
dependencies = [
|
||||
"thiserror-impl 2.0.18",
|
||||
"thiserror-impl",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2570,17 +2542,6 @@ dependencies = [
|
||||
"syn 2.0.111",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "thiserror-impl"
|
||||
version = "2.0.18"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5"
|
||||
dependencies = [
|
||||
"proc-macro2 1.0.103",
|
||||
"quote 1.0.42",
|
||||
"syn 2.0.111",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "thread_local"
|
||||
version = "1.1.9"
|
||||
@@ -2776,7 +2737,7 @@ dependencies = [
|
||||
"log",
|
||||
"rand",
|
||||
"sha1",
|
||||
"thiserror 1.0.69",
|
||||
"thiserror",
|
||||
"url",
|
||||
"utf-8",
|
||||
]
|
||||
@@ -3453,20 +3414,11 @@ dependencies = [
|
||||
"winapi-build",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "xml"
|
||||
version = "1.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "636f85e5ca6488e96401b61eb7de54f4e44755c988af0f52cf90230c312a1a89"
|
||||
|
||||
[[package]]
|
||||
name = "xml-rs"
|
||||
version = "1.0.0"
|
||||
version = "0.8.28"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c3a56132a0d6ecbe77352edc10232f788fc4ceefefff4cab784a98e0e16b6b51"
|
||||
dependencies = [
|
||||
"xml",
|
||||
]
|
||||
checksum = "3ae8337f8a065cfc972643663ea4279e04e7256de865aa66fe25cec5fb912d3f"
|
||||
|
||||
[[package]]
|
||||
name = "yaml-rust"
|
||||
|
||||
17
Cargo.toml
17
Cargo.toml
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "rojo"
|
||||
version = "7.7.0"
|
||||
version = "7.7.0-rc.1"
|
||||
rust-version = "1.88"
|
||||
authors = [
|
||||
"Lucien Greathouse <me@lpghatguy.com>",
|
||||
@@ -46,7 +46,7 @@ name = "build"
|
||||
harness = false
|
||||
|
||||
[dependencies]
|
||||
memofs = { version = "0.4.0", path = "crates/memofs" }
|
||||
memofs = { version = "0.3.1", path = "crates/memofs" }
|
||||
|
||||
# These dependencies can be uncommented when working on rbx-dom simultaneously
|
||||
# rbx_binary = { path = "../rbx-dom/rbx_binary", features = [
|
||||
@@ -57,18 +57,17 @@ memofs = { version = "0.4.0", path = "crates/memofs" }
|
||||
# rbx_reflection_database = { path = "../rbx-dom/rbx_reflection_database" }
|
||||
# rbx_xml = { path = "../rbx-dom/rbx_xml" }
|
||||
|
||||
rbx_binary = { version = "3.0.0", features = ["unstable_text_format"] }
|
||||
rbx_dom_weak = "4.2.0"
|
||||
rbx_reflection = "7.0.0"
|
||||
rbx_reflection_database = "3.0.0"
|
||||
rbx_xml = "3.0.0"
|
||||
rbx_binary = { version = "2.0.1", features = ["unstable_text_format"] }
|
||||
rbx_dom_weak = "4.1.0"
|
||||
rbx_reflection = "6.1.0"
|
||||
rbx_reflection_database = "2.0.2"
|
||||
rbx_xml = "2.0.1"
|
||||
|
||||
anyhow = "1.0.80"
|
||||
backtrace = "0.3.69"
|
||||
bincode = "1.3.3"
|
||||
crossbeam-channel = "0.5.12"
|
||||
csv = "1.3.0"
|
||||
dunce = "1.0.5"
|
||||
env_logger = "0.9.3"
|
||||
fs-err = "2.11.0"
|
||||
futures = "0.3.30"
|
||||
@@ -113,7 +112,7 @@ serde_bytes = "0.11.19"
|
||||
winreg = "0.10.1"
|
||||
|
||||
[build-dependencies]
|
||||
memofs = { version = "0.4.0", path = "crates/memofs" }
|
||||
memofs = { version = "0.3.0", path = "crates/memofs" }
|
||||
|
||||
embed-resource = "1.8.0"
|
||||
anyhow = "1.0.80"
|
||||
|
||||
@@ -25,11 +25,12 @@ Rojo enables:
|
||||
* Versioning your game, library, or plugin using Git or another VCS
|
||||
* Streaming `rbxmx` and `rbxm` models into your game in real time
|
||||
* Packaging and deploying your project to Roblox.com from the command line
|
||||
* Pulling Instances from Roblox place and model files back into an existing Rojo project with `rojo syncback`
|
||||
|
||||
Rojo also has an optional two-way sync setting in the Studio plugin for syncing supported Studio edits back to the filesystem.
|
||||
In the future, Rojo will be able to:
|
||||
|
||||
Some workflows, like fully automatic conversion of every existing game into a Rojo project, are still limited and may require manual project configuration.
|
||||
* Sync instances from Roblox Studio to the filesystem
|
||||
* Automatically convert your existing game to work with Rojo
|
||||
* Import custom instances like MoonScript code
|
||||
|
||||
## [Documentation](https://rojo.space/docs)
|
||||
Documentation is hosted in the [rojo.space repository](https://github.com/rojo-rbx/rojo.space).
|
||||
|
||||
1
build.rs
1
build.rs
@@ -75,7 +75,6 @@ fn main() -> Result<(), anyhow::Error> {
|
||||
"src" => snapshot_from_fs_path(&plugin_dir.join("src"))?,
|
||||
"Packages" => snapshot_from_fs_path(&plugin_dir.join("Packages"))?,
|
||||
"Version.txt" => snapshot_from_fs_path(&plugin_dir.join("Version.txt"))?,
|
||||
"UploadDetails.json" => snapshot_from_fs_path(&plugin_dir.join("UploadDetails.json"))?,
|
||||
}),
|
||||
});
|
||||
|
||||
|
||||
@@ -1,12 +1,7 @@
|
||||
# memofs Changelog
|
||||
|
||||
## Unreleased Changes
|
||||
|
||||
# 0.4.0 (2026-07-01)
|
||||
* Added `Vfs::canonicalize`. [#1201]
|
||||
* **Breaking:** `StdBackend::new` and `Vfs::new_default` now return `io::Result`, so a failure to create the filesystem watcher is reported as an error instead of panicking. The `Default` implementation for `StdBackend` has been removed as a result. [#1267]
|
||||
|
||||
[#1267]: https://github.com/rojo-rbx/rojo/pull/1267
|
||||
|
||||
## 0.3.1 (2025-11-27)
|
||||
* Added `Vfs::exists`. [#1169]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
[package]
|
||||
name = "memofs"
|
||||
description = "Virtual filesystem with configurable backends."
|
||||
version = "0.4.0"
|
||||
version = "0.3.1"
|
||||
authors = [
|
||||
"Lucien Greathouse <me@lpghatguy.com>",
|
||||
"Micah Reid <git@dekkonot.com>",
|
||||
@@ -16,7 +16,6 @@ homepage = "https://github.com/rojo-rbx/rojo/tree/master/memofs"
|
||||
|
||||
[dependencies]
|
||||
crossbeam-channel = "0.5.12"
|
||||
dunce = "1.0.5"
|
||||
fs-err = "2.11.0"
|
||||
notify = "4.0.17"
|
||||
serde = { version = "1.0.197", features = ["derive"] }
|
||||
|
||||
@@ -255,11 +255,8 @@ pub struct Vfs {
|
||||
|
||||
impl Vfs {
|
||||
/// Creates a new `Vfs` with the default backend, `StdBackend`.
|
||||
///
|
||||
/// Returns an error if the filesystem watcher could not be initialized,
|
||||
/// which can happen in restricted or sandboxed environments.
|
||||
pub fn new_default() -> io::Result<Self> {
|
||||
Ok(Self::new(StdBackend::new()?))
|
||||
pub fn new_default() -> Self {
|
||||
Self::new(StdBackend::new())
|
||||
}
|
||||
|
||||
/// Creates a new `Vfs` with the given backend.
|
||||
@@ -642,57 +639,21 @@ mod test {
|
||||
let file_path = dir.path().join("file.txt");
|
||||
fs_err::write(&file_path, contents.to_string()).unwrap();
|
||||
|
||||
let vfs = Vfs::new(StdBackend::new().unwrap());
|
||||
let vfs = Vfs::new(StdBackend::new());
|
||||
let canonicalized = vfs.canonicalize(&file_path).unwrap();
|
||||
assert_eq!(canonicalized, dunce::canonicalize(&file_path).unwrap());
|
||||
assert_eq!(canonicalized, file_path.canonicalize().unwrap());
|
||||
assert_eq!(
|
||||
vfs.read_to_string(&canonicalized).unwrap().to_string(),
|
||||
contents.to_string()
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(windows)]
|
||||
fn canonicalize_std_backend_not_verbatim() {
|
||||
use std::path::{Component, Prefix};
|
||||
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let file_path = dir.path().join("file.txt");
|
||||
fs_err::write(&file_path, "hello").unwrap();
|
||||
|
||||
let vfs = Vfs::new(StdBackend::new().unwrap());
|
||||
let canonicalized = vfs.canonicalize(&file_path).unwrap();
|
||||
|
||||
let is_verbatim = matches!(
|
||||
canonicalized.components().next(),
|
||||
Some(Component::Prefix(prefix)) if matches!(
|
||||
prefix.kind(),
|
||||
Prefix::Verbatim(_) | Prefix::VerbatimDisk(_) | Prefix::VerbatimUNC(_, _)
|
||||
)
|
||||
);
|
||||
assert!(
|
||||
!is_verbatim,
|
||||
"expected a non-verbatim path, got {:?}",
|
||||
canonicalized
|
||||
);
|
||||
|
||||
// Joining a relative parent path must preserve the `..` segment. On a
|
||||
// verbatim path Rust would drop it lexically, which is the root cause
|
||||
// of the bug.
|
||||
let joined = canonicalized.join("..").join("sibling");
|
||||
assert!(
|
||||
joined.components().any(|c| c == Component::ParentDir),
|
||||
"`..` should be preserved when joining onto {:?}",
|
||||
canonicalized
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn canonicalize_std_backend_missing_errors() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let file_path = dir.path().join("test");
|
||||
|
||||
let vfs = Vfs::new(StdBackend::new().unwrap());
|
||||
let vfs = Vfs::new(StdBackend::new());
|
||||
let err = vfs.canonicalize(&file_path).unwrap_err();
|
||||
assert_eq!(err.kind(), io::ErrorKind::NotFound);
|
||||
}
|
||||
|
||||
@@ -17,9 +17,9 @@ pub struct StdBackend {
|
||||
}
|
||||
|
||||
impl StdBackend {
|
||||
pub fn new() -> io::Result<StdBackend> {
|
||||
pub fn new() -> StdBackend {
|
||||
let (notify_tx, notify_rx) = mpsc::channel();
|
||||
let watcher = watcher(notify_tx, Duration::from_millis(50)).map_err(io::Error::other)?;
|
||||
let watcher = watcher(notify_tx, Duration::from_millis(50)).unwrap();
|
||||
|
||||
let (tx, rx) = crossbeam_channel::unbounded();
|
||||
|
||||
@@ -46,11 +46,11 @@ impl StdBackend {
|
||||
Result::<(), crossbeam_channel::SendError<VfsEvent>>::Ok(())
|
||||
});
|
||||
|
||||
Ok(Self {
|
||||
Self {
|
||||
watcher,
|
||||
watcher_receiver: rx,
|
||||
watches: HashSet::new(),
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -107,7 +107,7 @@ impl VfsBackend for StdBackend {
|
||||
}
|
||||
|
||||
fn canonicalize(&mut self, path: &Path) -> io::Result<PathBuf> {
|
||||
dunce::canonicalize(path)
|
||||
fs_err::canonicalize(path)
|
||||
}
|
||||
|
||||
fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
|
||||
@@ -134,3 +134,9 @@ impl VfsBackend for StdBackend {
|
||||
self.watcher.unwatch(path).map_err(io::Error::other)
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for StdBackend {
|
||||
fn default() -> Self {
|
||||
Self::new()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -22,9 +22,6 @@
|
||||
},
|
||||
"Version": {
|
||||
"$path": "plugin/Version.txt"
|
||||
},
|
||||
"UploadDetails": {
|
||||
"$path": "plugin/UploadDetails.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"assetId": 13916111004,
|
||||
"name": "Rojo",
|
||||
"description": "The plugin portion of Rojo, a tool to enable professional tooling for Roblox developers.",
|
||||
"creatorId": 32644114,
|
||||
"creatorType": "Group"
|
||||
}
|
||||
@@ -1 +1 @@
|
||||
7.7.0
|
||||
7.7.0-rc.1
|
||||
@@ -14,13 +14,6 @@ local Http = {}
|
||||
Http.Error = HttpError
|
||||
Http.Response = HttpResponse
|
||||
|
||||
-- Monkey patch msgpack.UInt64.new to lossily convert the low and high bits of the integer
|
||||
-- to a native Luau number. We should change the upstream decoder to emit a native
|
||||
-- integer, once those are live.
|
||||
function msgpack.UInt64.new(mostSignificantPart: number, leastSignificantPart: number): number
|
||||
return (mostSignificantPart % 2 ^ 32) * 2 ^ 32 + (leastSignificantPart % 2 ^ 32)
|
||||
end
|
||||
|
||||
local function performRequest(requestParams)
|
||||
local requestId = lastRequestId + 1
|
||||
lastRequestId = requestId
|
||||
|
||||
@@ -209,7 +209,7 @@ return {
|
||||
},
|
||||
},
|
||||
StyleRule = {
|
||||
Properties = {
|
||||
PropertiesSerialize = {
|
||||
read = function(instance: StyleRule)
|
||||
return true, instance:GetProperties()
|
||||
end,
|
||||
@@ -220,7 +220,9 @@ return {
|
||||
|
||||
local existing = instance:GetProperties()
|
||||
|
||||
instance:SetProperties(value)
|
||||
for itemName, itemValue in pairs(value) do
|
||||
instance:SetProperty(itemName, itemValue)
|
||||
end
|
||||
|
||||
for existingItemName in pairs(existing) do
|
||||
if value[existingItemName] == nil then
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,8 +1,8 @@
|
||||
local ReplicatedStorage = game:GetService("ReplicatedStorage")
|
||||
|
||||
local TestEZ = require(ReplicatedStorage:WaitForChild("Packages", 10):WaitForChild("TestEZ", 10))
|
||||
local TestEZ = require(ReplicatedStorage.Packages:WaitForChild("TestEZ", 10))
|
||||
|
||||
local Rojo = ReplicatedStorage:WaitForChild("Rojo", 10)
|
||||
local Rojo = ReplicatedStorage.Rojo
|
||||
|
||||
local Settings = require(Rojo.Plugin.Settings)
|
||||
Settings:set("logLevel", "Trace")
|
||||
|
||||
@@ -8,7 +8,6 @@ local Log = require(Packages.Log)
|
||||
local Assets = require(Plugin.Assets)
|
||||
local Settings = require(Plugin.Settings)
|
||||
local Theme = require(Plugin.App.Theme)
|
||||
local Version = require(Plugin.Version)
|
||||
|
||||
local IconButton = require(Plugin.App.Components.IconButton)
|
||||
local ScrollingFrame = require(Plugin.App.Components.ScrollingFrame)
|
||||
@@ -194,8 +193,6 @@ function SettingsPage:render()
|
||||
id = "checkForUpdates",
|
||||
name = "Check For Updates",
|
||||
description = "Notify about newer compatible Rojo releases",
|
||||
locked = Version.isApiBlocked(),
|
||||
lockedTooltip = "(HTTP requests to api.github.com are blocked, Rojo cannot fetch what the latest version is.)",
|
||||
transparency = self.props.transparency,
|
||||
layoutOrder = layoutIncrement(),
|
||||
}),
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
--[[
|
||||
Counts how many of a virtual instance's properties match the live values on a
|
||||
candidate Roblox instance. `hydrate` uses this to break ties when several
|
||||
existing children share the same Name and ClassName.
|
||||
|
||||
This mirrors the read -> decode -> compare flow that `diff` uses, reusing the
|
||||
same `getProperty`, `decodeValue`, and `trueEquals` helpers.
|
||||
]]
|
||||
|
||||
local getProperty = require(script.Parent.getProperty)
|
||||
local decodeValue = require(script.Parent.decodeValue)
|
||||
local trueEquals = require(script.Parent.trueEquals)
|
||||
|
||||
local function countMatchingProperties(instance, virtualInstance, instanceMap)
|
||||
local score = 0
|
||||
|
||||
for propertyName, virtualValue in virtualInstance.Properties do
|
||||
-- Skip refs. During hydration the instanceMap is still being built
|
||||
-- top-down, so a ref may point at an instance we haven't hydrated yet
|
||||
-- and therefore can't decode reliably. Refs are also a poor
|
||||
-- disambiguator between same-named siblings.
|
||||
if next(virtualValue) == "Ref" then
|
||||
continue
|
||||
end
|
||||
|
||||
local getSuccess, existingValue = getProperty(instance, propertyName)
|
||||
if not getSuccess then
|
||||
continue
|
||||
end
|
||||
|
||||
local decodeSuccess, decodedValue = decodeValue(virtualValue, instanceMap)
|
||||
if not decodeSuccess then
|
||||
continue
|
||||
end
|
||||
|
||||
if trueEquals(existingValue, decodedValue) then
|
||||
score += 1
|
||||
end
|
||||
end
|
||||
|
||||
return score
|
||||
end
|
||||
|
||||
return countMatchingProperties
|
||||
@@ -1,91 +0,0 @@
|
||||
return function()
|
||||
local countMatchingProperties = require(script.Parent.countMatchingProperties)
|
||||
|
||||
local InstanceMap = require(script.Parent.Parent.InstanceMap)
|
||||
|
||||
it("counts properties whose values match the instance", function()
|
||||
local instance = Instance.new("StringValue")
|
||||
instance.Value = "hello"
|
||||
|
||||
local virtualInstance = {
|
||||
ClassName = "StringValue",
|
||||
Name = "Value",
|
||||
Properties = {
|
||||
Value = { String = "hello" },
|
||||
},
|
||||
Children = {},
|
||||
}
|
||||
|
||||
expect(countMatchingProperties(instance, virtualInstance, InstanceMap.new())).to.equal(1)
|
||||
end)
|
||||
|
||||
it("does not count properties whose values differ", function()
|
||||
local instance = Instance.new("StringValue")
|
||||
instance.Value = "hello"
|
||||
|
||||
local virtualInstance = {
|
||||
ClassName = "StringValue",
|
||||
Name = "Value",
|
||||
Properties = {
|
||||
Value = { String = "different" },
|
||||
},
|
||||
Children = {},
|
||||
}
|
||||
|
||||
expect(countMatchingProperties(instance, virtualInstance, InstanceMap.new())).to.equal(0)
|
||||
end)
|
||||
|
||||
it("counts multiple matching properties independently", function()
|
||||
local instance = Instance.new("Part")
|
||||
instance.Anchored = true
|
||||
instance.CanCollide = false
|
||||
|
||||
local virtualInstance = {
|
||||
ClassName = "Part",
|
||||
Name = "Part",
|
||||
Properties = {
|
||||
Anchored = { Bool = true },
|
||||
CanCollide = { Bool = false },
|
||||
},
|
||||
Children = {},
|
||||
}
|
||||
|
||||
expect(countMatchingProperties(instance, virtualInstance, InstanceMap.new())).to.equal(2)
|
||||
|
||||
-- Flip one so only a single property matches.
|
||||
instance.CanCollide = true
|
||||
expect(countMatchingProperties(instance, virtualInstance, InstanceMap.new())).to.equal(1)
|
||||
end)
|
||||
|
||||
it("skips unknown properties without counting or erroring", function()
|
||||
local instance = Instance.new("Folder")
|
||||
|
||||
local virtualInstance = {
|
||||
ClassName = "Folder",
|
||||
Name = "Folder",
|
||||
Properties = {
|
||||
FAKE_PROPERTY = { String = "nope" },
|
||||
},
|
||||
Children = {},
|
||||
}
|
||||
|
||||
expect(countMatchingProperties(instance, virtualInstance, InstanceMap.new())).to.equal(0)
|
||||
end)
|
||||
|
||||
it("skips Ref properties without counting or erroring", function()
|
||||
local instance = Instance.new("ObjectValue")
|
||||
|
||||
local virtualInstance = {
|
||||
ClassName = "ObjectValue",
|
||||
Name = "ObjectValue",
|
||||
Properties = {
|
||||
-- A ref must be skipped rather than decoded: during hydration
|
||||
-- the target may not be in the map yet.
|
||||
Value = { Ref = "00000000000000000000000000000000" },
|
||||
},
|
||||
Children = {},
|
||||
}
|
||||
|
||||
expect(countMatchingProperties(instance, virtualInstance, InstanceMap.new())).to.equal(0)
|
||||
end)
|
||||
end
|
||||
@@ -10,12 +10,104 @@ local invariant = require(script.Parent.Parent.invariant)
|
||||
local getProperty = require(script.Parent.getProperty)
|
||||
local Error = require(script.Parent.Error)
|
||||
local decodeValue = require(script.Parent.decodeValue)
|
||||
local trueEquals = require(script.Parent.trueEquals)
|
||||
|
||||
local function isEmpty(table)
|
||||
return next(table) == nil
|
||||
end
|
||||
|
||||
local function fuzzyEq(a: number, b: number, epsilon: number): boolean
|
||||
return math.abs(a - b) < epsilon
|
||||
end
|
||||
|
||||
local function trueEquals(a, b): boolean
|
||||
-- Exit early for simple equality values
|
||||
if a == b then
|
||||
return true
|
||||
end
|
||||
|
||||
-- Treat nil and { Ref = "000...0" } as equal
|
||||
if
|
||||
(a == nil and type(b) == "table" and b.Ref == "00000000000000000000000000000000")
|
||||
or (b == nil and type(a) == "table" and a.Ref == "00000000000000000000000000000000")
|
||||
then
|
||||
return true
|
||||
end
|
||||
|
||||
local typeA, typeB = typeof(a), typeof(b)
|
||||
|
||||
-- For tables, try recursive deep equality
|
||||
if typeA == "table" and typeB == "table" then
|
||||
local checkedKeys = {}
|
||||
for key, value in a do
|
||||
checkedKeys[key] = true
|
||||
if not trueEquals(value, b[key]) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
for key, value in b do
|
||||
if checkedKeys[key] then
|
||||
continue
|
||||
end
|
||||
if not trueEquals(value, a[key]) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
|
||||
-- For NaN, check if both values are not equal to themselves
|
||||
elseif a ~= a and b ~= b then
|
||||
return true
|
||||
|
||||
-- For numbers, compare with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "number" and typeB == "number" then
|
||||
return fuzzyEq(a, b, 0.0001)
|
||||
|
||||
-- For EnumItem->number, compare the EnumItem's value
|
||||
elseif typeA == "number" and typeB == "EnumItem" then
|
||||
return a == b.Value
|
||||
elseif typeA == "EnumItem" and typeB == "number" then
|
||||
return a.Value == b
|
||||
|
||||
-- For Color3s, compare to RGB ints to avoid floating point inequality
|
||||
elseif typeA == "Color3" and typeB == "Color3" then
|
||||
local aR, aG, aB = math.floor(a.R * 255), math.floor(a.G * 255), math.floor(a.B * 255)
|
||||
local bR, bG, bB = math.floor(b.R * 255), math.floor(b.G * 255), math.floor(b.B * 255)
|
||||
return aR == bR and aG == bG and aB == bB
|
||||
|
||||
-- For CFrames, compare to components with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "CFrame" and typeB == "CFrame" then
|
||||
local aComponents, bComponents = { a:GetComponents() }, { b:GetComponents() }
|
||||
for i, aComponent in aComponents do
|
||||
if not fuzzyEq(aComponent, bComponents[i], 0.0001) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
|
||||
-- For Vector3s, compare to components with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "Vector3" and typeB == "Vector3" then
|
||||
local aComponents, bComponents = { a.X, a.Y, a.Z }, { b.X, b.Y, b.Z }
|
||||
for i, aComponent in aComponents do
|
||||
if not fuzzyEq(aComponent, bComponents[i], 0.0001) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
|
||||
-- For Vector2s, compare to components with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "Vector2" and typeB == "Vector2" then
|
||||
local aComponents, bComponents = { a.X, a.Y }, { b.X, b.Y }
|
||||
for i, aComponent in aComponents do
|
||||
if not fuzzyEq(aComponent, bComponents[i], 0.0001) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
end
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
local function shouldDeleteUnknownInstances(virtualInstance)
|
||||
if virtualInstance.Metadata ~= nil then
|
||||
return not virtualInstance.Metadata.ignoreUnknownInstances
|
||||
|
||||
@@ -3,22 +3,9 @@
|
||||
concrete instances and assigning them IDs.
|
||||
]]
|
||||
|
||||
local Packages = script.Parent.Parent.Parent.Packages
|
||||
local Log = require(Packages.Log)
|
||||
|
||||
local invariant = require(script.Parent.Parent.invariant)
|
||||
local countMatchingProperties = require(script.Parent.countMatchingProperties)
|
||||
|
||||
-- When several existing children share a Name and ClassName we disambiguate
|
||||
-- them by scoring how well each one's properties match the virtual instance.
|
||||
-- That scoring is far more expensive than a Name/ClassName check, so we only do
|
||||
-- it for reasonably-sized groups. Larger groups (e.g. a folder with thousands of
|
||||
-- identically-named parts) fall back to the original order-based matching, which
|
||||
-- bounds the added work to roughly MAX_CANDIDATES_TO_SCORE^2 property reads per
|
||||
-- group regardless of how large the group is.
|
||||
local MAX_CANDIDATES_TO_SCORE = 32
|
||||
|
||||
local function hydrateInner(stats, instanceMap, virtualInstances, rootId, rootInstance)
|
||||
local function hydrate(instanceMap, virtualInstances, rootId, rootInstance)
|
||||
local virtualInstance = virtualInstances[rootId]
|
||||
|
||||
if virtualInstance == nil then
|
||||
@@ -26,163 +13,38 @@ local function hydrateInner(stats, instanceMap, virtualInstances, rootId, rootIn
|
||||
end
|
||||
|
||||
instanceMap:insert(rootId, rootInstance)
|
||||
stats.hydrated += 1
|
||||
|
||||
local existingChildren = rootInstance:GetChildren()
|
||||
|
||||
-- Group existing children by Name then ClassName so each virtual child can
|
||||
-- find its candidate matches without scanning every sibling. This is what
|
||||
-- keeps hydration fast for parents with thousands of children. Nesting the
|
||||
-- two tables (rather than a combined key) keeps the Name and ClassName checks
|
||||
-- exact, with no way for one to bleed into the other.
|
||||
local buckets = {}
|
||||
for _, childInstance in existingChildren do
|
||||
-- We guard accessing Name and ClassName in order to avoid tripping over
|
||||
-- children of DataModel that Rojo won't have permissions to access at all.
|
||||
local accessSuccess, name, className = pcall(function()
|
||||
return childInstance.Name, childInstance.ClassName
|
||||
end)
|
||||
if not accessSuccess then
|
||||
continue
|
||||
end
|
||||
|
||||
local bucketsByClassName = buckets[name]
|
||||
if bucketsByClassName == nil then
|
||||
bucketsByClassName = {}
|
||||
buckets[name] = bucketsByClassName
|
||||
end
|
||||
|
||||
local bucket = bucketsByClassName[className]
|
||||
if bucket == nil then
|
||||
bucket = { cursor = 1, instances = {} }
|
||||
bucketsByClassName[className] = bucket
|
||||
end
|
||||
|
||||
table.insert(bucket.instances, childInstance)
|
||||
-- For each existing child, we'll track whether it's been paired with an
|
||||
-- instance that the Rojo server knows about.
|
||||
local isExistingChildVisited = {}
|
||||
for i = 1, #existingChildren do
|
||||
isExistingChildVisited[i] = false
|
||||
end
|
||||
|
||||
-- Tracks which existing children have already been paired, so one instance
|
||||
-- isn't matched to two different virtual instances.
|
||||
local visited = {}
|
||||
|
||||
for _, childId in ipairs(virtualInstance.Children) do
|
||||
local virtualChild = virtualInstances[childId]
|
||||
|
||||
local bucketsByClassName = buckets[virtualChild.Name]
|
||||
local bucket = bucketsByClassName and bucketsByClassName[virtualChild.ClassName]
|
||||
if bucket == nil then
|
||||
-- No existing instance matches; diff will mark this id for creation.
|
||||
Log.trace(
|
||||
"hydrate: no existing instance matches {} ({}) for id {}",
|
||||
virtualChild.Name,
|
||||
virtualChild.ClassName,
|
||||
childId
|
||||
)
|
||||
continue
|
||||
end
|
||||
for childIndex, childInstance in existingChildren do
|
||||
if not isExistingChildVisited[childIndex] then
|
||||
-- We guard accessing Name and ClassName in order to avoid
|
||||
-- tripping over children of DataModel that Rojo won't have
|
||||
-- permissions to access at all.
|
||||
local accessSuccess, name, className = pcall(function()
|
||||
return childInstance.Name, childInstance.ClassName
|
||||
end)
|
||||
|
||||
local instances = bucket.instances
|
||||
|
||||
-- Advance past any leading children that have already been paired. The
|
||||
-- cursor makes order-based matching amortized O(1) per child even for
|
||||
-- very large groups, rather than rescanning the visited prefix.
|
||||
while bucket.cursor <= #instances and visited[instances[bucket.cursor]] do
|
||||
bucket.cursor += 1
|
||||
end
|
||||
if bucket.cursor > #instances then
|
||||
-- Every matching instance has already been paired with an earlier id.
|
||||
Log.trace(
|
||||
"hydrate: no unpaired instance left for {} ({}) for id {}",
|
||||
virtualChild.Name,
|
||||
virtualChild.ClassName,
|
||||
childId
|
||||
)
|
||||
continue
|
||||
end
|
||||
|
||||
-- The cursor points at the earliest unvisited child, so the slots from
|
||||
-- here to the end bound how many candidates remain. Visited children
|
||||
-- after the cursor (gaps) only appear once a group is small enough to be
|
||||
-- scored -- the order-based path below always takes the earliest, which
|
||||
-- keeps the visited region a contiguous prefix. So whenever this count
|
||||
-- exceeds the cap it is exact, and we can pick the earliest match without
|
||||
-- collecting anything.
|
||||
local remaining = #instances - bucket.cursor + 1
|
||||
|
||||
local match
|
||||
if remaining > MAX_CANDIDATES_TO_SCORE then
|
||||
-- Too many to score affordably; take the earliest in child order,
|
||||
-- reproducing the original Name + ClassName behavior.
|
||||
match = instances[bucket.cursor]
|
||||
Log.trace(
|
||||
"hydrate: {} candidates named {} ({}) exceeds the scoring cap of {}; matching id {} by child order",
|
||||
remaining,
|
||||
virtualChild.Name,
|
||||
virtualChild.ClassName,
|
||||
MAX_CANDIDATES_TO_SCORE,
|
||||
childId
|
||||
)
|
||||
else
|
||||
-- Collect the (at most `remaining`) unvisited candidates.
|
||||
local candidates = {}
|
||||
for index = bucket.cursor, #instances do
|
||||
local childInstance = instances[index]
|
||||
if not visited[childInstance] then
|
||||
table.insert(candidates, childInstance)
|
||||
-- This rule is very conservative and could be loosened in the
|
||||
-- future, or more heuristics could be introduced.
|
||||
if accessSuccess and name == virtualChild.Name and className == virtualChild.ClassName then
|
||||
isExistingChildVisited[childIndex] = true
|
||||
hydrate(instanceMap, virtualInstances, childId, childInstance)
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
if #candidates == 1 then
|
||||
-- Only one candidate, so there's nothing to disambiguate.
|
||||
match = candidates[1]
|
||||
else
|
||||
-- Break the tie by choosing the candidate whose properties best
|
||||
-- match the virtual instance, falling back to the earliest in
|
||||
-- child order when scores are equal.
|
||||
local bestScore = -1
|
||||
for _, childInstance in candidates do
|
||||
local score = countMatchingProperties(childInstance, virtualChild, instanceMap)
|
||||
if score > bestScore then
|
||||
bestScore = score
|
||||
match = childInstance
|
||||
end
|
||||
end
|
||||
|
||||
stats.ambiguousGroups += 1
|
||||
stats.candidatesScored += #candidates
|
||||
Log.trace(
|
||||
"hydrate: disambiguated {} candidates named {} ({}) for id {} by property match (best score {})",
|
||||
#candidates,
|
||||
virtualChild.Name,
|
||||
virtualChild.ClassName,
|
||||
childId,
|
||||
bestScore
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
visited[match] = true
|
||||
hydrateInner(stats, instanceMap, virtualInstances, childId, match)
|
||||
end
|
||||
end
|
||||
|
||||
local function hydrate(instanceMap, virtualInstances, rootId, rootInstance)
|
||||
-- Tallies of the work hydration did, surfaced in a single debug log below so
|
||||
-- the cost of property-based disambiguation is visible without per-node spam.
|
||||
local stats = {
|
||||
hydrated = 0,
|
||||
ambiguousGroups = 0,
|
||||
candidatesScored = 0,
|
||||
}
|
||||
|
||||
hydrateInner(stats, instanceMap, virtualInstances, rootId, rootInstance)
|
||||
|
||||
Log.debug(
|
||||
"Hydrated {} instances ({} ambiguous name+class groups, {} candidates scored)",
|
||||
stats.hydrated,
|
||||
stats.ambiguousGroups,
|
||||
stats.candidatesScored
|
||||
)
|
||||
end
|
||||
|
||||
return hydrate
|
||||
|
||||
@@ -126,140 +126,4 @@ return function()
|
||||
expect(knownInstances.fromIds["CHILD1"]).to.equal(child1)
|
||||
expect(knownInstances.fromIds["CHILD2"]).to.equal(child2)
|
||||
end)
|
||||
|
||||
it("should disambiguate duplicate-named siblings by matching properties", function()
|
||||
local knownInstances = InstanceMap.new()
|
||||
local virtualInstances = {
|
||||
ROOT = {
|
||||
ClassName = "Folder",
|
||||
Name = "Root",
|
||||
Properties = {},
|
||||
Children = { "CHILD_A", "CHILD_B" },
|
||||
},
|
||||
|
||||
CHILD_A = {
|
||||
ClassName = "StringValue",
|
||||
Name = "a",
|
||||
Properties = { Value = { String = "first" } },
|
||||
Children = {},
|
||||
},
|
||||
|
||||
CHILD_B = {
|
||||
ClassName = "StringValue",
|
||||
Name = "a",
|
||||
Properties = { Value = { String = "second" } },
|
||||
Children = {},
|
||||
},
|
||||
}
|
||||
|
||||
local rootInstance = Instance.new("Folder")
|
||||
|
||||
-- Created in the reverse order of the virtual children, so a purely
|
||||
-- order-based tiebreak would mis-pair them.
|
||||
local child1 = Instance.new("StringValue")
|
||||
child1.Name = "a"
|
||||
child1.Value = "second"
|
||||
child1.Parent = rootInstance
|
||||
|
||||
local child2 = Instance.new("StringValue")
|
||||
child2.Name = "a"
|
||||
child2.Value = "first"
|
||||
child2.Parent = rootInstance
|
||||
|
||||
hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
|
||||
|
||||
expect(knownInstances:size()).to.equal(3)
|
||||
expect(knownInstances.fromIds["CHILD_A"]).to.equal(child2)
|
||||
expect(knownInstances.fromIds["CHILD_B"]).to.equal(child1)
|
||||
end)
|
||||
|
||||
it("should fall back to child order for duplicate-named siblings with no distinguishing properties", function()
|
||||
local knownInstances = InstanceMap.new()
|
||||
local virtualInstances = {
|
||||
ROOT = {
|
||||
ClassName = "Folder",
|
||||
Name = "Root",
|
||||
Properties = {},
|
||||
Children = { "CHILD_A", "CHILD_B" },
|
||||
},
|
||||
|
||||
CHILD_A = {
|
||||
ClassName = "Folder",
|
||||
Name = "a",
|
||||
Properties = {},
|
||||
Children = {},
|
||||
},
|
||||
|
||||
CHILD_B = {
|
||||
ClassName = "Folder",
|
||||
Name = "a",
|
||||
Properties = {},
|
||||
Children = {},
|
||||
},
|
||||
}
|
||||
|
||||
local rootInstance = Instance.new("Folder")
|
||||
|
||||
local child1 = Instance.new("Folder")
|
||||
child1.Name = "a"
|
||||
child1.Parent = rootInstance
|
||||
|
||||
local child2 = Instance.new("Folder")
|
||||
child2.Name = "a"
|
||||
child2.Parent = rootInstance
|
||||
|
||||
hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
|
||||
|
||||
expect(knownInstances:size()).to.equal(3)
|
||||
-- With equal scores the earliest unvisited child wins, preserving the
|
||||
-- original order-based behavior.
|
||||
expect(knownInstances.fromIds["CHILD_A"]).to.equal(child1)
|
||||
expect(knownInstances.fromIds["CHILD_B"]).to.equal(child2)
|
||||
end)
|
||||
|
||||
it("should fall back to child order for very large duplicate-named groups", function()
|
||||
-- More candidates than hydrate is willing to score at once. The group
|
||||
-- must fall back to order-based matching, so virtual child N pairs with
|
||||
-- existing child N regardless of properties.
|
||||
local count = 64
|
||||
|
||||
local knownInstances = InstanceMap.new()
|
||||
local virtualInstances = {
|
||||
ROOT = {
|
||||
ClassName = "Folder",
|
||||
Name = "Root",
|
||||
Properties = {},
|
||||
Children = {},
|
||||
},
|
||||
}
|
||||
|
||||
local rootInstance = Instance.new("Folder")
|
||||
|
||||
local expectedInstances = {}
|
||||
for i = 1, count do
|
||||
local id = "CHILD_" .. i
|
||||
table.insert(virtualInstances.ROOT.Children, id)
|
||||
virtualInstances[id] = {
|
||||
ClassName = "StringValue",
|
||||
Name = "a",
|
||||
-- Distinct values that, if scored, would pair by value rather
|
||||
-- than by order.
|
||||
Properties = { Value = { String = "value " .. i } },
|
||||
Children = {},
|
||||
}
|
||||
|
||||
local child = Instance.new("StringValue")
|
||||
child.Name = "a"
|
||||
child.Value = "value " .. (count - i + 1)
|
||||
child.Parent = rootInstance
|
||||
expectedInstances[id] = child
|
||||
end
|
||||
|
||||
hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
|
||||
|
||||
expect(knownInstances:size()).to.equal(count + 1)
|
||||
for id, expectedInstance in expectedInstances do
|
||||
expect(knownInstances.fromIds[id]).to.equal(expectedInstance)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
@@ -1,100 +0,0 @@
|
||||
--[[
|
||||
Fuzzy value-equality used to compare a decoded virtual property value against
|
||||
the live value read from a real instance. Shared by `diff` (to decide whether
|
||||
a property changed) and `hydrate` (to score candidate instances).
|
||||
]]
|
||||
|
||||
local function fuzzyEq(a: number, b: number, epsilon: number): boolean
|
||||
return math.abs(a - b) < epsilon
|
||||
end
|
||||
|
||||
local function trueEquals(a, b): boolean
|
||||
-- Exit early for simple equality values
|
||||
if a == b then
|
||||
return true
|
||||
end
|
||||
|
||||
-- Treat nil and { Ref = "000...0" } as equal
|
||||
if
|
||||
(a == nil and type(b) == "table" and b.Ref == "00000000000000000000000000000000")
|
||||
or (b == nil and type(a) == "table" and a.Ref == "00000000000000000000000000000000")
|
||||
then
|
||||
return true
|
||||
end
|
||||
|
||||
local typeA, typeB = typeof(a), typeof(b)
|
||||
|
||||
-- For tables, try recursive deep equality
|
||||
if typeA == "table" and typeB == "table" then
|
||||
local checkedKeys = {}
|
||||
for key, value in a do
|
||||
checkedKeys[key] = true
|
||||
if not trueEquals(value, b[key]) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
for key, value in b do
|
||||
if checkedKeys[key] then
|
||||
continue
|
||||
end
|
||||
if not trueEquals(value, a[key]) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
|
||||
-- For NaN, check if both values are not equal to themselves
|
||||
elseif a ~= a and b ~= b then
|
||||
return true
|
||||
|
||||
-- For numbers, compare with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "number" and typeB == "number" then
|
||||
return fuzzyEq(a, b, 0.0001)
|
||||
|
||||
-- For EnumItem->number, compare the EnumItem's value
|
||||
elseif typeA == "number" and typeB == "EnumItem" then
|
||||
return a == b.Value
|
||||
elseif typeA == "EnumItem" and typeB == "number" then
|
||||
return a.Value == b
|
||||
|
||||
-- For Color3s, compare to RGB ints to avoid floating point inequality
|
||||
elseif typeA == "Color3" and typeB == "Color3" then
|
||||
local aR, aG, aB = math.floor(a.R * 255), math.floor(a.G * 255), math.floor(a.B * 255)
|
||||
local bR, bG, bB = math.floor(b.R * 255), math.floor(b.G * 255), math.floor(b.B * 255)
|
||||
return aR == bR and aG == bG and aB == bB
|
||||
|
||||
-- For CFrames, compare to components with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "CFrame" and typeB == "CFrame" then
|
||||
local aComponents, bComponents = { a:GetComponents() }, { b:GetComponents() }
|
||||
for i, aComponent in aComponents do
|
||||
if not fuzzyEq(aComponent, bComponents[i], 0.0001) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
|
||||
-- For Vector3s, compare to components with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "Vector3" and typeB == "Vector3" then
|
||||
local aComponents, bComponents = { a.X, a.Y, a.Z }, { b.X, b.Y, b.Z }
|
||||
for i, aComponent in aComponents do
|
||||
if not fuzzyEq(aComponent, bComponents[i], 0.0001) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
|
||||
-- For Vector2s, compare to components with epsilon of 0.0001 to avoid floating point inequality
|
||||
elseif typeA == "Vector2" and typeB == "Vector2" then
|
||||
local aComponents, bComponents = { a.X, a.Y }, { b.X, b.Y }
|
||||
for i, aComponent in aComponents do
|
||||
if not fuzzyEq(aComponent, bComponents[i], 0.0001) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
return true
|
||||
end
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
return trueEquals
|
||||
@@ -18,7 +18,6 @@ local PatchSet = require(script.Parent.PatchSet)
|
||||
local Reconciler = require(script.Parent.Reconciler)
|
||||
local strict = require(script.Parent.strict)
|
||||
local Settings = require(script.Parent.Settings)
|
||||
local orderSwaps = require(script.Parent.orderSwaps)
|
||||
|
||||
local Status = strict("Session.Status", {
|
||||
NotStarted = "NotStarted",
|
||||
@@ -321,14 +320,6 @@ function ServeSession:__replaceInstances(idList)
|
||||
return false
|
||||
end
|
||||
|
||||
-- Roblox appends to GetChildren() on every reparent, so the order in which
|
||||
-- we re-parent replacements determines their final sibling order.
|
||||
-- We process ancestors before descendants (so each replacement's
|
||||
-- parent already exists when we re-parent it) and siblings in their original
|
||||
-- GetChildren() order. Because the loop below moves the old instance's
|
||||
-- children into the replacement *before* re-parenting the replacement, this
|
||||
-- rebuilds GetChildren() exactly as it was before the swap.
|
||||
local swaps = {}
|
||||
for id, replacement in replacements do
|
||||
local oldInstance = self.__instanceMap.fromIds[id]
|
||||
if not oldInstance then
|
||||
@@ -337,16 +328,6 @@ function ServeSession:__replaceInstances(idList)
|
||||
continue
|
||||
end
|
||||
|
||||
table.insert(swaps, {
|
||||
id = id,
|
||||
replacement = replacement,
|
||||
oldInstance = oldInstance,
|
||||
})
|
||||
end
|
||||
|
||||
for _, swap in orderSwaps(swaps) do
|
||||
local id, replacement, oldInstance = swap.id, swap.replacement, swap.oldInstance
|
||||
|
||||
self.__instanceMap:insert(id, replacement)
|
||||
Log.trace("Swapping Instance {} out via api/models/ endpoint", id)
|
||||
local oldParent = oldInstance.Parent
|
||||
|
||||
@@ -111,24 +111,6 @@ Version._cachedLatestCompatible = nil :: {
|
||||
timestamp: number,
|
||||
}?
|
||||
|
||||
--[[
|
||||
A user may choose to reject requests to api.github.com. If they do, we want
|
||||
to disable the setting for checking for updates to indicate that it does
|
||||
nothing.
|
||||
]]
|
||||
Version._apiBlocked = nil :: boolean?
|
||||
|
||||
function Version.isApiBlocked(): boolean
|
||||
if Version._apiBlocked == nil then
|
||||
local isLocalInstall = string.find(debug.traceback(), "\n[^\n]-user_.-$") ~= nil
|
||||
Version.retrieveLatestCompatible({
|
||||
version = Config.version,
|
||||
includePrereleases = isLocalInstall and Settings:get("checkForPrereleases"),
|
||||
})
|
||||
end
|
||||
return Version._apiBlocked
|
||||
end
|
||||
|
||||
function Version.retrieveLatestCompatible(options: {
|
||||
version: { number },
|
||||
includePrereleases: boolean?,
|
||||
@@ -154,13 +136,8 @@ function Version.retrieveLatestCompatible(options: {
|
||||
:await()
|
||||
|
||||
if success == false or type(releases) ~= "table" or next(releases) ~= 1 then
|
||||
-- Roblox's HTTP errors are weird!
|
||||
if string.find(tostring(releases), "^Unknown HTTP error: HttpService permission denied") then
|
||||
Version._apiBlocked = true
|
||||
end
|
||||
return nil
|
||||
end
|
||||
Version._apiBlocked = false
|
||||
|
||||
-- Iterate through releases, looking for the latest compatible version
|
||||
local latestCompatible: LatestReleaseInfo? = nil
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
--[[
|
||||
Determines the order in which `ServeSession:__replaceInstances` should swap
|
||||
instances so that sibling order is preserved.
|
||||
|
||||
Roblox appends to `GetChildren()` on every reparent, so the order in which we
|
||||
re-parent replacements determines their final sibling order. To rebuild
|
||||
`GetChildren()` exactly as it was before the swap we must:
|
||||
|
||||
* process ancestors before descendants, so each replacement's parent already
|
||||
exists when we re-parent the replacement, and
|
||||
* process siblings in their original `GetChildren()` order.
|
||||
|
||||
`swaps` is an array of `{ id, replacement, oldInstance }` entries. This sorts
|
||||
the array in place (annotating each entry with `depth`/`siblingIndex`) and
|
||||
returns it.
|
||||
]]
|
||||
local function orderSwaps(swaps)
|
||||
for _, swap in swaps do
|
||||
local depth = 0
|
||||
local ancestor = swap.oldInstance.Parent
|
||||
while ancestor ~= nil do
|
||||
depth += 1
|
||||
ancestor = ancestor.Parent
|
||||
end
|
||||
swap.depth = depth
|
||||
|
||||
local siblingIndex = 0
|
||||
if swap.oldInstance.Parent ~= nil then
|
||||
siblingIndex = table.find(swap.oldInstance.Parent:GetChildren(), swap.oldInstance) or 0
|
||||
end
|
||||
swap.siblingIndex = siblingIndex
|
||||
end
|
||||
|
||||
table.sort(swaps, function(a, b)
|
||||
if a.depth ~= b.depth then
|
||||
return a.depth < b.depth
|
||||
end
|
||||
return a.siblingIndex < b.siblingIndex
|
||||
end)
|
||||
|
||||
return swaps
|
||||
end
|
||||
|
||||
return orderSwaps
|
||||
@@ -1,57 +0,0 @@
|
||||
return function()
|
||||
local orderSwaps = require(script.Parent.orderSwaps)
|
||||
|
||||
it("orders same-named siblings by their original GetChildren order", function()
|
||||
local parent = Instance.new("Model")
|
||||
local a1 = Instance.new("Part")
|
||||
a1.Name = "a"
|
||||
a1.Parent = parent
|
||||
local a2 = Instance.new("Part")
|
||||
a2.Name = "a"
|
||||
a2.Parent = parent
|
||||
local a3 = Instance.new("Part")
|
||||
a3.Name = "a"
|
||||
a3.Parent = parent
|
||||
|
||||
-- Input deliberately out of sibling order.
|
||||
-- orderSwaps must restore the GetChildren() order.
|
||||
local ordered = orderSwaps({
|
||||
{ id = "3", oldInstance = a3 },
|
||||
{ id = "1", oldInstance = a1 },
|
||||
{ id = "2", oldInstance = a2 },
|
||||
})
|
||||
|
||||
expect(ordered[1].oldInstance).to.equal(a1)
|
||||
expect(ordered[2].oldInstance).to.equal(a2)
|
||||
expect(ordered[3].oldInstance).to.equal(a3)
|
||||
end)
|
||||
|
||||
it("orders ancestors before descendants", function()
|
||||
local root = Instance.new("Model")
|
||||
local child = Instance.new("Folder")
|
||||
child.Parent = root
|
||||
local grandchild = Instance.new("Part")
|
||||
grandchild.Parent = child
|
||||
|
||||
local ordered = orderSwaps({
|
||||
{ id = "grandchild", oldInstance = grandchild },
|
||||
{ id = "child", oldInstance = child },
|
||||
{ id = "root", oldInstance = root },
|
||||
})
|
||||
|
||||
expect(ordered[1].oldInstance).to.equal(root)
|
||||
expect(ordered[2].oldInstance).to.equal(child)
|
||||
expect(ordered[3].oldInstance).to.equal(grandchild)
|
||||
end)
|
||||
|
||||
it("returns a single swap unchanged", function()
|
||||
local part = Instance.new("Part")
|
||||
|
||||
local ordered = orderSwaps({
|
||||
{ id = "1", oldInstance = part },
|
||||
})
|
||||
|
||||
expect(#ordered).to.equal(1)
|
||||
expect(ordered[1].oldInstance).to.equal(part)
|
||||
end)
|
||||
end
|
||||
@@ -1,16 +0,0 @@
|
||||
---
|
||||
source: tests/tests/build.rs
|
||||
expression: contents
|
||||
---
|
||||
<roblox version="4">
|
||||
<Item class="Folder" referent="0">
|
||||
<Properties>
|
||||
<string name="Name">json_model_legacy_name</string>
|
||||
</Properties>
|
||||
<Item class="Folder" referent="1">
|
||||
<Properties>
|
||||
<string name="Name">Expected Name</string>
|
||||
</Properties>
|
||||
</Item>
|
||||
</Item>
|
||||
</roblox>
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
source: tests/tests/build.rs
|
||||
assertion_line: 109
|
||||
expression: contents
|
||||
---
|
||||
<roblox version="4">
|
||||
<Item class="DataModel" referent="0">
|
||||
<Properties>
|
||||
<string name="Name">model_json_name_input</string>
|
||||
</Properties>
|
||||
<Item class="Workspace" referent="1">
|
||||
<Properties>
|
||||
<string name="Name">Workspace</string>
|
||||
<bool name="NeedsPivotMigration">false</bool>
|
||||
</Properties>
|
||||
<Item class="StringValue" referent="2">
|
||||
<Properties>
|
||||
<string name="Name">/Bar</string>
|
||||
</Properties>
|
||||
</Item>
|
||||
</Item>
|
||||
</Item>
|
||||
</roblox>
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
source: tests/tests/build.rs
|
||||
expression: contents
|
||||
---
|
||||
<roblox version="4">
|
||||
<Item class="Folder" referent="0">
|
||||
<Properties>
|
||||
<string name="Name">plugin_init</string>
|
||||
</Properties>
|
||||
<Item class="Script" referent="1">
|
||||
<Properties>
|
||||
<string name="Name">lua</string>
|
||||
<token name="RunContext">3</token>
|
||||
<string name="Source"><![CDATA[return "From folder/lua/init.plugin.lua"
|
||||
]]></string>
|
||||
</Properties>
|
||||
</Item>
|
||||
<Item class="Script" referent="2">
|
||||
<Properties>
|
||||
<string name="Name">luau</string>
|
||||
<token name="RunContext">3</token>
|
||||
<string name="Source"><![CDATA[return "From folder/luau/init.plugin.luau"
|
||||
]]></string>
|
||||
</Properties>
|
||||
</Item>
|
||||
</Item>
|
||||
</roblox>
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
source: tests/tests/build.rs
|
||||
assertion_line: 108
|
||||
expression: contents
|
||||
---
|
||||
<roblox version="4">
|
||||
<Item class="Folder" referent="0">
|
||||
<Properties>
|
||||
<string name="Name">slugified_name_roundtrip</string>
|
||||
</Properties>
|
||||
<Item class="Script" referent="1">
|
||||
<Properties>
|
||||
<string name="Name">/Script</string>
|
||||
<token name="RunContext">0</token>
|
||||
<string name="Source"><![CDATA[print("Hello world!")
|
||||
]]></string>
|
||||
</Properties>
|
||||
</Item>
|
||||
</Item>
|
||||
</roblox>
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"name": "json_model_legacy_name",
|
||||
"tree": {
|
||||
"$path": "folder"
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"Name": "Overridden Name",
|
||||
"ClassName": "Folder"
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"name": "model_json_name_input",
|
||||
"tree": {
|
||||
"$className": "DataModel",
|
||||
"Workspace": {
|
||||
"$className": "Workspace",
|
||||
"$path": "src"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"name": "/Bar",
|
||||
"className": "StringValue"
|
||||
}
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"name": "plugin_init",
|
||||
"tree": {
|
||||
"$path": "folder"
|
||||
}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
return "From folder/lua/init.plugin.lua"
|
||||
@@ -1 +0,0 @@
|
||||
return "From folder/luau/init.plugin.luau"
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"name": "/Script"
|
||||
}
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
print("Hello world!")
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"name": "slugified_name_roundtrip",
|
||||
"tree": {
|
||||
"$path": "src"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"name": "/Script"
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
print("Hello world!")
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
source: tests/rojo_test/syncback_util.rs
|
||||
assertion_line: 101
|
||||
expression: "String::from_utf8_lossy(&output.stdout)"
|
||||
---
|
||||
Writing default.project.json
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
source: tests/rojo_test/syncback_util.rs
|
||||
assertion_line: 101
|
||||
expression: "String::from_utf8_lossy(&output.stdout)"
|
||||
---
|
||||
Writing default.project.json
|
||||
Writing src/Camera.rbxm
|
||||
Writing src/Terrain.rbxm
|
||||
Writing src/_Folder/init.meta.json
|
||||
Writing src/_Script.meta.json
|
||||
Writing src/_Script.server.luau
|
||||
Writing src
|
||||
Writing src/_Folder
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/foo.model.json
|
||||
---
|
||||
{
|
||||
"name": "/Bar",
|
||||
"className": "StringValue"
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
expression: default.project.json
|
||||
---
|
||||
{
|
||||
"name": "SyncbackTest",
|
||||
"tree": {
|
||||
"$className": "DataModel",
|
||||
"Workspace": {
|
||||
"$className": "Workspace",
|
||||
"TestPart": {
|
||||
"$className": "Part",
|
||||
"$properties": {
|
||||
"Anchored": true,
|
||||
"Color": {
|
||||
"Color3uint8": [
|
||||
0,
|
||||
0,
|
||||
255
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"$properties": {
|
||||
"PhysicsImprovedSleep": {
|
||||
"Enum": 0
|
||||
},
|
||||
"UseNewLuauTypeSolver": "Disabled"
|
||||
},
|
||||
"$attributes": {
|
||||
"Rojo_Target_CurrentCamera": "302d573157260ee80a3baa32000003b5"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/_Folder.model.json
|
||||
---
|
||||
{
|
||||
"className": "Folder"
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/_Folder/init.meta.json
|
||||
---
|
||||
{
|
||||
"name": "/Folder"
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/_Script.meta.json
|
||||
---
|
||||
{
|
||||
"name": "/Script"
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/_Script.server.luau
|
||||
---
|
||||
print("Hello world!")
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/_Script/init.meta.json
|
||||
---
|
||||
{
|
||||
"name": "/Script"
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
source: tests/tests/syncback.rs
|
||||
assertion_line: 31
|
||||
expression: src/_Script/init.server.luau
|
||||
---
|
||||
print("Hello world!")
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"name": "model_json_name",
|
||||
"tree": {
|
||||
"$className": "DataModel",
|
||||
"Workspace": {
|
||||
"$className": "Workspace",
|
||||
"$path": "src"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"name": "/Bar",
|
||||
"className": "StringValue"
|
||||
}
|
||||
|
||||
BIN
rojo-test/syncback-tests/model_json_name/input.rbxl
Normal file
BIN
rojo-test/syncback-tests/model_json_name/input.rbxl
Normal file
Binary file not shown.
@@ -1,21 +0,0 @@
|
||||
{
|
||||
"name": "SyncbackTest",
|
||||
"tree": {
|
||||
"$className": "DataModel",
|
||||
"Workspace": {
|
||||
"$className": "Workspace",
|
||||
"TestPart": {
|
||||
"$className": "Part",
|
||||
"$properties": {
|
||||
"Transparency": 1.0,
|
||||
"Anchored": true,
|
||||
"Color": [
|
||||
1.0,
|
||||
0.0,
|
||||
0.0
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Binary file not shown.
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"name": "slugified_name",
|
||||
"tree": {
|
||||
"$className": "DataModel",
|
||||
"Workspace": {
|
||||
"$className": "Workspace",
|
||||
"$path": "src"
|
||||
}
|
||||
}
|
||||
}
|
||||
BIN
rojo-test/syncback-tests/slugified_name/input.rbxl
Normal file
BIN
rojo-test/syncback-tests/slugified_name/input.rbxl
Normal file
Binary file not shown.
@@ -3,4 +3,3 @@ rojo = "rojo-rbx/rojo@7.5.1"
|
||||
selene = "Kampfkarren/selene@0.29.0"
|
||||
stylua = "JohnnyMorganz/stylua@2.1.0"
|
||||
run-in-roblox = "rojo-rbx/run-in-roblox@0.3.0"
|
||||
lune = "lune-org/lune@0.10.4"
|
||||
|
||||
@@ -200,15 +200,7 @@ impl JobThreadContext {
|
||||
if let Some(instance) = tree.get_instance(id) {
|
||||
if let Some(instigating_source) = &instance.metadata().instigating_source {
|
||||
match instigating_source {
|
||||
InstigatingSource::Path(path) => {
|
||||
if let Err(err) = fs::remove_file(path) {
|
||||
log::error!(
|
||||
"Failed to remove file {}: {}",
|
||||
path.display(),
|
||||
err
|
||||
);
|
||||
}
|
||||
}
|
||||
InstigatingSource::Path(path) => fs::remove_file(path).unwrap(),
|
||||
InstigatingSource::ProjectNode { .. } => {
|
||||
log::warn!(
|
||||
"Cannot remove instance {:?}, it's from a project file",
|
||||
@@ -252,13 +244,7 @@ impl JobThreadContext {
|
||||
match instigating_source {
|
||||
InstigatingSource::Path(path) => {
|
||||
if let Some(Variant::String(value)) = changed_value {
|
||||
if let Err(err) = fs::write(path, value) {
|
||||
log::error!(
|
||||
"Failed to write file {}: {}",
|
||||
path.display(),
|
||||
err
|
||||
);
|
||||
}
|
||||
fs::write(path, value).unwrap();
|
||||
} else {
|
||||
log::warn!("Cannot change Source to non-string value.");
|
||||
}
|
||||
|
||||
@@ -75,10 +75,10 @@ impl BuildCommand {
|
||||
_ => unreachable!(),
|
||||
};
|
||||
|
||||
let project_path = resolve_path(&self.project)?;
|
||||
let project_path = resolve_path(&self.project);
|
||||
|
||||
log::trace!("Constructing in-memory filesystem");
|
||||
let vfs = Vfs::new_default()?;
|
||||
let vfs = Vfs::new_default();
|
||||
vfs.set_watch_enabled(self.watch);
|
||||
|
||||
let session = ServeSession::new(vfs, project_path)?;
|
||||
@@ -87,16 +87,11 @@ impl BuildCommand {
|
||||
write_model(&session, &output_path, output_kind)?;
|
||||
|
||||
if self.watch {
|
||||
let rt = Runtime::new().context("Failed to start the async runtime for watch mode")?;
|
||||
let rt = Runtime::new().unwrap();
|
||||
|
||||
loop {
|
||||
let receiver = session.message_queue().subscribe(cursor);
|
||||
let (new_cursor, _patch_set) = match rt.block_on(receiver) {
|
||||
Ok(message) => message,
|
||||
// The message queue was dropped, so there is nothing left
|
||||
// to watch. Stop watching gracefully.
|
||||
Err(_) => break,
|
||||
};
|
||||
let (new_cursor, _patch_set) = rt.block_on(receiver).unwrap();
|
||||
cursor = new_cursor;
|
||||
|
||||
write_model(&session, &output_path, output_kind)?;
|
||||
|
||||
@@ -18,10 +18,10 @@ pub struct FmtProjectCommand {
|
||||
|
||||
impl FmtProjectCommand {
|
||||
pub fn run(self) -> anyhow::Result<()> {
|
||||
let vfs = Vfs::new_default()?;
|
||||
let vfs = Vfs::new_default();
|
||||
vfs.set_watch_enabled(false);
|
||||
|
||||
let base_path = resolve_path(&self.project)?;
|
||||
let base_path = resolve_path(&self.project);
|
||||
let project = Project::load_fuzzy(&vfs, &base_path)?
|
||||
.context("A project file is required to run 'rojo fmt-project'")?;
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ use std::{
|
||||
io::{self, Write},
|
||||
};
|
||||
|
||||
use anyhow::{bail, format_err, Context};
|
||||
use anyhow::{bail, format_err};
|
||||
use clap::Parser;
|
||||
use fs_err as fs;
|
||||
use fs_err::OpenOptions;
|
||||
@@ -42,9 +42,9 @@ pub struct InitCommand {
|
||||
|
||||
impl InitCommand {
|
||||
pub fn run(self) -> anyhow::Result<()> {
|
||||
let template = self.kind.template()?;
|
||||
let template = self.kind.template();
|
||||
|
||||
let base_path = resolve_path(&self.path)?;
|
||||
let base_path = resolve_path(&self.path);
|
||||
fs::create_dir_all(&base_path)?;
|
||||
|
||||
let canonical = fs::canonicalize(&base_path)?;
|
||||
@@ -128,7 +128,7 @@ pub enum InitKind {
|
||||
}
|
||||
|
||||
impl InitKind {
|
||||
fn template(&self) -> anyhow::Result<InMemoryFs> {
|
||||
fn template(&self) -> InMemoryFs {
|
||||
let template_path = match self {
|
||||
Self::Place => "place",
|
||||
Self::Model => "model",
|
||||
@@ -136,24 +136,20 @@ impl InitKind {
|
||||
};
|
||||
|
||||
let snapshot: VfsSnapshot = bincode::deserialize(TEMPLATE_BINCODE)
|
||||
.context("Rojo's templates were not properly packed into Rojo's binary. This is a bug in Rojo; please file an issue.")?;
|
||||
.expect("Rojo's templates were not properly packed into Rojo's binary");
|
||||
|
||||
let VfsSnapshot::Dir { mut children } = snapshot else {
|
||||
bail!("Rojo's templates were packed as a file instead of a directory. This is a bug in Rojo; please file an issue.");
|
||||
};
|
||||
|
||||
let template = children.remove(template_path).ok_or_else(|| {
|
||||
format_err!(
|
||||
"The template for project type {:?} is missing. This is a bug in Rojo; please file an issue.",
|
||||
self
|
||||
)
|
||||
})?;
|
||||
|
||||
let mut fs = InMemoryFs::new();
|
||||
fs.load_snapshot("", template)
|
||||
.context("Failed to load Rojo's bundled template into memory")?;
|
||||
|
||||
Ok(fs)
|
||||
if let VfsSnapshot::Dir { mut children } = snapshot {
|
||||
if let Some(template) = children.remove(template_path) {
|
||||
let mut fs = InMemoryFs::new();
|
||||
fs.load_snapshot("", template)
|
||||
.expect("loading a template in memory should never fail");
|
||||
fs
|
||||
} else {
|
||||
panic!("template for project type {:?} is missing", self)
|
||||
}
|
||||
} else {
|
||||
panic!("Rojo's templates were packed as a file instead of a directory")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -12,7 +12,6 @@ mod upload;
|
||||
|
||||
use std::{borrow::Cow, env, path::Path, str::FromStr};
|
||||
|
||||
use anyhow::Context;
|
||||
use clap::Parser;
|
||||
use thiserror::Error;
|
||||
|
||||
@@ -126,14 +125,10 @@ pub enum Subcommand {
|
||||
Syncback(SyncbackCommand),
|
||||
}
|
||||
|
||||
pub(super) fn resolve_path(path: &Path) -> anyhow::Result<Cow<'_, Path>> {
|
||||
pub(super) fn resolve_path(path: &Path) -> Cow<'_, Path> {
|
||||
if path.is_absolute() {
|
||||
Ok(Cow::Borrowed(path))
|
||||
Cow::Borrowed(path)
|
||||
} else {
|
||||
let current_dir = env::current_dir().context(
|
||||
"Could not determine the current working directory. \
|
||||
It may have been deleted, or Rojo may not have permission to access it.",
|
||||
)?;
|
||||
Ok(Cow::Owned(current_dir.join(path)))
|
||||
Cow::Owned(env::current_dir().unwrap().join(path))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -98,5 +98,5 @@ fn uninstall_plugin() -> anyhow::Result<()> {
|
||||
|
||||
#[test]
|
||||
fn plugin_initialize() {
|
||||
let _ = initialize_plugin().unwrap();
|
||||
assert!(initialize_plugin().is_ok())
|
||||
}
|
||||
|
||||
@@ -31,21 +31,13 @@ pub struct ServeCommand {
|
||||
/// it has none.
|
||||
#[clap(long)]
|
||||
pub port: Option<u16>,
|
||||
|
||||
/// Extra `Host`/`Origin` values the server will accept, beyond localhost and
|
||||
/// the bind address (for example a hostname like `mypc.lan`). Repeat the
|
||||
/// option or comma-separate to allow several. When given, this overrides the
|
||||
/// project's `serveAllowedHosts`. Listing any host also turns on Host/Origin
|
||||
/// validation for binds where it is otherwise off (such as `0.0.0.0`).
|
||||
#[clap(long, value_delimiter = ',')]
|
||||
pub allowed_hosts: Vec<String>,
|
||||
}
|
||||
|
||||
impl ServeCommand {
|
||||
pub fn run(self, global: GlobalOptions) -> anyhow::Result<()> {
|
||||
let project_path = resolve_path(&self.project)?;
|
||||
let project_path = resolve_path(&self.project);
|
||||
|
||||
let vfs = Vfs::new_default()?;
|
||||
let vfs = Vfs::new_default();
|
||||
|
||||
let session = Arc::new(ServeSession::new(vfs, project_path)?);
|
||||
|
||||
@@ -59,19 +51,10 @@ impl ServeCommand {
|
||||
.or_else(|| session.project_port())
|
||||
.unwrap_or(DEFAULT_PORT);
|
||||
|
||||
// The CLI flag, when given, replaces the project's list rather than
|
||||
// merging with it, matching how --address and --port override theirs.
|
||||
let allowed_hosts = if self.allowed_hosts.is_empty() {
|
||||
session.serve_allowed_hosts().to_vec()
|
||||
} else {
|
||||
self.allowed_hosts
|
||||
};
|
||||
|
||||
let server = LiveServer::new(session);
|
||||
|
||||
server.start((ip, port).into(), allowed_hosts, || {
|
||||
let _ = show_start_message(ip, port, global.color.into());
|
||||
})?;
|
||||
let _ = show_start_message(ip, port, global.color.into());
|
||||
server.start((ip, port).into());
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -103,25 +86,6 @@ fn show_start_message(bind_address: IpAddr, port: u16, color: ColorChoice) -> io
|
||||
|
||||
writeln!(&mut buffer)?;
|
||||
|
||||
if !bind_address.is_loopback() {
|
||||
let mut warning = ColorSpec::new();
|
||||
warning.set_fg(Some(Color::Yellow)).set_bold(true);
|
||||
|
||||
buffer.set_color(&warning)?;
|
||||
writeln!(
|
||||
&mut buffer,
|
||||
"WARNING: This server is bound to {address_string}, which is reachable from the \
|
||||
network.\n\
|
||||
The serve API is unauthenticated, so anyone who can reach {address_string}:{port} \
|
||||
can read\n\
|
||||
and modify your project's source. Prefer binding to localhost and tunneling (e.g. \
|
||||
SSH,\n\
|
||||
Tailscale, or WireGuard) when you need remote access."
|
||||
)?;
|
||||
buffer.set_color(&ColorSpec::new())?;
|
||||
writeln!(&mut buffer)?;
|
||||
}
|
||||
|
||||
buffer.set_color(&ColorSpec::new())?;
|
||||
write!(&mut buffer, "Visit ")?;
|
||||
|
||||
|
||||
@@ -5,7 +5,6 @@ use std::{
|
||||
path::{self, Path, PathBuf},
|
||||
};
|
||||
|
||||
use anyhow::Context;
|
||||
use clap::Parser;
|
||||
use fs_err::File;
|
||||
use memofs::Vfs;
|
||||
@@ -72,10 +71,10 @@ pub struct SourcemapCommand {
|
||||
|
||||
impl SourcemapCommand {
|
||||
pub fn run(self) -> anyhow::Result<()> {
|
||||
let project_path = dunce::canonicalize(resolve_path(&self.project)?)?;
|
||||
let project_path = fs_err::canonicalize(resolve_path(&self.project))?;
|
||||
|
||||
log::trace!("Constructing filesystem with StdBackend");
|
||||
let vfs = Vfs::new_default()?;
|
||||
let vfs = Vfs::new_default();
|
||||
vfs.set_watch_enabled(self.watch);
|
||||
|
||||
log::trace!("Setting up session for sourcemap generation");
|
||||
@@ -101,16 +100,11 @@ impl SourcemapCommand {
|
||||
|
||||
if self.watch {
|
||||
log::trace!("Setting up runtime for watch mode");
|
||||
let rt = Runtime::new().context("Failed to start the async runtime for watch mode")?;
|
||||
let rt = Runtime::new().unwrap();
|
||||
|
||||
loop {
|
||||
let receiver = session.message_queue().subscribe(cursor);
|
||||
let (new_cursor, patch_set) = match rt.block_on(receiver) {
|
||||
Ok(message) => message,
|
||||
// The message queue was dropped, so there is nothing left
|
||||
// to watch. Stop watching gracefully.
|
||||
Err(_) => break,
|
||||
};
|
||||
let (new_cursor, patch_set) = rt.block_on(receiver).unwrap();
|
||||
cursor = new_cursor;
|
||||
|
||||
if patch_set_affects_sourcemap(&session, &patch_set, filter) {
|
||||
|
||||
@@ -58,8 +58,8 @@ pub struct SyncbackCommand {
|
||||
|
||||
impl SyncbackCommand {
|
||||
pub fn run(&self, global: GlobalOptions) -> anyhow::Result<()> {
|
||||
let path_old = resolve_path(&self.project)?;
|
||||
let path_new = resolve_path(&self.input)?;
|
||||
let path_old = resolve_path(&self.project);
|
||||
let path_new = resolve_path(&self.input);
|
||||
|
||||
let input_kind = FileKind::from_path(&path_new).context(UNKNOWN_INPUT_KIND_ERR)?;
|
||||
let dom_start_timer = Instant::now();
|
||||
@@ -69,7 +69,7 @@ impl SyncbackCommand {
|
||||
dom_start_timer.elapsed().as_secs_f32()
|
||||
);
|
||||
|
||||
let vfs = Vfs::new_default()?;
|
||||
let vfs = Vfs::new_default();
|
||||
vfs.set_watch_enabled(false);
|
||||
|
||||
let project_start_timer = Instant::now();
|
||||
|
||||
@@ -38,9 +38,9 @@ pub struct UploadCommand {
|
||||
|
||||
impl UploadCommand {
|
||||
pub fn run(self) -> Result<(), anyhow::Error> {
|
||||
let project_path = resolve_path(&self.project)?;
|
||||
let project_path = resolve_path(&self.project);
|
||||
|
||||
let vfs = Vfs::new_default()?;
|
||||
let vfs = Vfs::new_default();
|
||||
|
||||
let session = ServeSession::new(vfs, project_path)?;
|
||||
|
||||
|
||||
58
src/glob.rs
58
src/glob.rs
@@ -48,61 +48,3 @@ impl<'de> Deserialize<'de> for Glob {
|
||||
Glob::new(&glob).map_err(D::Error::custom)
|
||||
}
|
||||
}
|
||||
|
||||
/// A glob with optional gitignore-style negation. A leading `!` marks the
|
||||
/// pattern as a negation (re-includes paths that an earlier rule excluded).
|
||||
/// To match a literal `!` at the start of a pattern, escape it with `\!`.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct IgnorableGlob {
|
||||
glob: Glob,
|
||||
negated: bool,
|
||||
raw: String,
|
||||
}
|
||||
|
||||
impl IgnorableGlob {
|
||||
pub fn new(pattern: &str) -> Result<Self, Error> {
|
||||
let (negated, body) = if let Some(rest) = pattern.strip_prefix('!') {
|
||||
(true, rest)
|
||||
} else if pattern.starts_with(r"\!") {
|
||||
(false, &pattern[1..])
|
||||
} else {
|
||||
(false, pattern)
|
||||
};
|
||||
|
||||
Ok(IgnorableGlob {
|
||||
glob: Glob::new(body)?,
|
||||
negated,
|
||||
raw: pattern.to_owned(),
|
||||
})
|
||||
}
|
||||
|
||||
pub fn is_match<P: AsRef<Path>>(&self, path: P) -> bool {
|
||||
self.glob.is_match(path)
|
||||
}
|
||||
|
||||
pub fn is_negation(&self) -> bool {
|
||||
self.negated
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for IgnorableGlob {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.negated == other.negated && self.glob == other.glob
|
||||
}
|
||||
}
|
||||
|
||||
impl Eq for IgnorableGlob {}
|
||||
|
||||
impl Serialize for IgnorableGlob {
|
||||
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
|
||||
serializer.serialize_str(&self.raw)
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for IgnorableGlob {
|
||||
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
|
||||
let pattern = String::deserialize(deserializer)?;
|
||||
|
||||
IgnorableGlob::new(&pattern).map_err(D::Error::custom)
|
||||
}
|
||||
}
|
||||
|
||||
100
src/project.rs
100
src/project.rs
@@ -12,8 +12,7 @@ use serde::{Deserialize, Serialize};
|
||||
use thiserror::Error;
|
||||
|
||||
use crate::{
|
||||
glob::IgnorableGlob, json, resolution::UnresolvedValue, snapshot::SyncRule,
|
||||
syncback::SyncbackRules,
|
||||
glob::Glob, json, resolution::UnresolvedValue, snapshot::SyncRule, syncback::SyncbackRules,
|
||||
};
|
||||
|
||||
/// Represents 'default' project names that act as `init` files
|
||||
@@ -106,15 +105,6 @@ pub struct Project {
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub serve_address: Option<IpAddr>,
|
||||
|
||||
/// Additional `Host`/`Origin` header values that `rojo serve` will accept
|
||||
/// beyond `localhost` and the bind address, such as a hostname like
|
||||
/// `mypc.lan` used to reach a network-exposed server by name. Listing any
|
||||
/// host also turns on `Host`/`Origin` validation for binds where it is
|
||||
/// otherwise off (such as `0.0.0.0`). The `--allowed-hosts` CLI option
|
||||
/// overrides this field when provided.
|
||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||
pub serve_allowed_hosts: Vec<String>,
|
||||
|
||||
/// Determines if Rojo should emit scripts with the appropriate `RunContext`
|
||||
/// for `*.client.lua` and `*.server.lua` files in the project instead of
|
||||
/// using `Script` and `LocalScript` Instances.
|
||||
@@ -124,7 +114,7 @@ pub struct Project {
|
||||
/// A list of globs, relative to the folder the project file is in, that
|
||||
/// match files that should be excluded if Rojo encounters them.
|
||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||
pub glob_ignore_paths: Vec<IgnorableGlob>,
|
||||
pub glob_ignore_paths: Vec<Glob>,
|
||||
|
||||
/// A list of rules for syncback with this project file.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
@@ -603,90 +593,4 @@ mod test {
|
||||
assert!(project.sync_rules[0].include.is_match("data.data.json"));
|
||||
assert!(project.sync_rules[1].include.is_match("init.module.lua"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn project_with_serve_allowed_hosts() {
|
||||
let project_json = r#"{
|
||||
"name": "TestProject",
|
||||
"tree": { "$path": "src" },
|
||||
"serveAllowedHosts": ["mypc.lan", "192.168.1.5"]
|
||||
}"#;
|
||||
|
||||
let project = Project::load_from_slice(
|
||||
project_json.as_bytes(),
|
||||
PathBuf::from("/test/default.project.json"),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to parse project with serveAllowedHosts");
|
||||
|
||||
assert_eq!(project.serve_allowed_hosts, vec!["mypc.lan", "192.168.1.5"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn project_without_serve_allowed_hosts_defaults_to_empty() {
|
||||
let project_json = r#"{
|
||||
"name": "TestProject",
|
||||
"tree": { "$path": "src" }
|
||||
}"#;
|
||||
|
||||
let project = Project::load_from_slice(
|
||||
project_json.as_bytes(),
|
||||
PathBuf::from("/test/default.project.json"),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to parse project");
|
||||
|
||||
assert!(project.serve_allowed_hosts.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn glob_ignore_paths_negation() {
|
||||
let project_json = r#"{
|
||||
"name": "TestProject",
|
||||
"tree": { "$path": "src" },
|
||||
"globIgnorePaths": [
|
||||
"**/*.spec.lua",
|
||||
"!keep.spec.lua",
|
||||
"\\!literal.lua"
|
||||
]
|
||||
}"#;
|
||||
|
||||
let project = Project::load_from_slice(
|
||||
project_json.as_bytes(),
|
||||
PathBuf::from("/test/default.project.json"),
|
||||
None,
|
||||
)
|
||||
.expect("project should parse");
|
||||
|
||||
let paths = &project.glob_ignore_paths;
|
||||
assert_eq!(paths.len(), 3);
|
||||
|
||||
assert!(!paths[0].is_negation());
|
||||
assert!(paths[0].is_match("foo.spec.lua"));
|
||||
|
||||
assert!(paths[1].is_negation());
|
||||
assert!(paths[1].is_match("keep.spec.lua"));
|
||||
|
||||
// `\!literal.lua` should match a file literally named `!literal.lua`,
|
||||
// not be parsed as a negation.
|
||||
assert!(!paths[2].is_negation());
|
||||
assert!(paths[2].is_match("!literal.lua"));
|
||||
|
||||
let rules: Vec<_> = paths
|
||||
.iter()
|
||||
.map(|g| crate::snapshot::PathIgnoreRule {
|
||||
base_path: PathBuf::from("/test"),
|
||||
glob: g.clone(),
|
||||
})
|
||||
.collect();
|
||||
assert!(crate::snapshot::is_path_ignored(
|
||||
&rules,
|
||||
"/test/foo.spec.lua"
|
||||
));
|
||||
assert!(!crate::snapshot::is_path_ignored(
|
||||
&rules,
|
||||
"/test/keep.spec.lua"
|
||||
));
|
||||
assert!(!crate::snapshot::is_path_ignored(&rules, "/test/plain.lua"));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -95,9 +95,8 @@ impl ServeSession {
|
||||
/// currently loaded from the filesystem directly instead of through the
|
||||
/// in-memory filesystem layer.
|
||||
pub fn new<P: AsRef<Path>>(vfs: Vfs, start_path: P) -> Result<Self, ServeSessionError> {
|
||||
let start_path = start_path.as_ref();
|
||||
let start_time = Instant::now();
|
||||
let start_path = vfs.canonicalize(start_path.as_ref())?;
|
||||
let start_path = start_path.as_path();
|
||||
|
||||
log::trace!("Starting new ServeSession at path {}", start_path.display());
|
||||
|
||||
@@ -208,10 +207,6 @@ impl ServeSession {
|
||||
self.root_project.serve_address
|
||||
}
|
||||
|
||||
pub fn serve_allowed_hosts(&self) -> &[String] {
|
||||
&self.root_project.serve_allowed_hosts
|
||||
}
|
||||
|
||||
pub fn root_dir(&self) -> &Path {
|
||||
self.root_project.folder_location()
|
||||
}
|
||||
@@ -241,39 +236,3 @@ pub enum ServeSessionError {
|
||||
source: anyhow::Error,
|
||||
},
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
|
||||
use memofs::StdBackend;
|
||||
|
||||
#[test]
|
||||
fn tree_is_keyed_by_canonical_paths() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
std::fs::write(
|
||||
dir.path().join("default.project.json"),
|
||||
r#"{ "name": "test", "tree": { "$className": "Folder" } }"#,
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
// `std::fs::canonicalize` yields a verbatim path on Windows.
|
||||
// On other platforms it simply resolves the path (e.g. symlinks),
|
||||
// which the session must also handle.
|
||||
let start_path = std::fs::canonicalize(dir.path()).unwrap();
|
||||
|
||||
let vfs = Vfs::new(StdBackend::new().unwrap());
|
||||
let session = ServeSession::new(vfs, &start_path).unwrap();
|
||||
|
||||
let project_file = start_path.join("default.project.json");
|
||||
let canonical = session.vfs().canonicalize(&project_file).unwrap();
|
||||
|
||||
assert!(
|
||||
!session.tree().get_ids_at_path(&canonical).is_empty(),
|
||||
"project file {} should be tracked in the tree under its canonical \
|
||||
path {}, matching what the watcher reports",
|
||||
project_file.display(),
|
||||
canonical.display(),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,7 +8,7 @@ use anyhow::Context;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::{
|
||||
glob::{Glob, IgnorableGlob},
|
||||
glob::Glob,
|
||||
path_serializer,
|
||||
project::ProjectNode,
|
||||
snapshot_middleware::{emit_legacy_scripts_default, Middleware},
|
||||
@@ -70,6 +70,12 @@ pub struct InstanceMetadata {
|
||||
/// A schema provided via a JSON file, if one exists. Will be `None` for
|
||||
/// all non-JSON middleware.
|
||||
pub schema: Option<String>,
|
||||
|
||||
/// A custom name specified via meta.json or model.json files. If present,
|
||||
/// this name will be used for the instance while the filesystem name will
|
||||
/// be slugified to remove illegal characters.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub specified_name: Option<String>,
|
||||
}
|
||||
|
||||
impl InstanceMetadata {
|
||||
@@ -82,6 +88,7 @@ impl InstanceMetadata {
|
||||
specified_id: None,
|
||||
middleware: None,
|
||||
schema: None,
|
||||
specified_name: None,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -130,6 +137,13 @@ impl InstanceMetadata {
|
||||
pub fn schema(self, schema: Option<String>) -> Self {
|
||||
Self { schema, ..self }
|
||||
}
|
||||
|
||||
pub fn specified_name(self, specified_name: Option<String>) -> Self {
|
||||
Self {
|
||||
specified_name,
|
||||
..self
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for InstanceMetadata {
|
||||
@@ -222,37 +236,18 @@ pub struct PathIgnoreRule {
|
||||
pub base_path: PathBuf,
|
||||
|
||||
/// The actual glob that can be matched against the input path.
|
||||
pub glob: IgnorableGlob,
|
||||
pub glob: Glob,
|
||||
}
|
||||
|
||||
impl PathIgnoreRule {
|
||||
pub fn matches<P: AsRef<Path>>(&self, path: P) -> bool {
|
||||
pub fn passes<P: AsRef<Path>>(&self, path: P) -> bool {
|
||||
let path = path.as_ref();
|
||||
|
||||
match path.strip_prefix(&self.base_path) {
|
||||
Ok(suffix) => self.glob.is_match(suffix),
|
||||
Err(_) => false,
|
||||
Ok(suffix) => !self.glob.is_match(suffix),
|
||||
Err(_) => true,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn is_negation(&self) -> bool {
|
||||
self.glob.is_negation()
|
||||
}
|
||||
}
|
||||
|
||||
/// Evaluates an ordered list of [`PathIgnoreRule`]s against a path using
|
||||
/// gitignore-style "last match wins" semantics: a path is ignored if the last
|
||||
/// rule whose pattern matches it is non-negated. Paths matched by no rule are
|
||||
/// not ignored.
|
||||
pub fn is_path_ignored<P: AsRef<Path>>(rules: &[PathIgnoreRule], path: P) -> bool {
|
||||
let path = path.as_ref();
|
||||
let mut ignored = false;
|
||||
for rule in rules {
|
||||
if rule.matches(path) {
|
||||
ignored = !rule.is_negation();
|
||||
}
|
||||
}
|
||||
ignored
|
||||
}
|
||||
|
||||
/// Represents where a particular Instance or InstanceSnapshot came from.
|
||||
|
||||
@@ -195,7 +195,7 @@ struct LocalizationEntry<'a> {
|
||||
/// https://github.com/BurntSushi/rust-csv/issues/151
|
||||
///
|
||||
/// This function operates in one step in order to minimize data-copying.
|
||||
fn convert_localization_csv(contents: &[u8]) -> anyhow::Result<String> {
|
||||
fn convert_localization_csv(contents: &[u8]) -> Result<String, csv::Error> {
|
||||
let mut reader = csv::Reader::from_reader(contents);
|
||||
|
||||
let headers = reader.headers()?.clone();
|
||||
@@ -237,7 +237,7 @@ fn convert_localization_csv(contents: &[u8]) -> anyhow::Result<String> {
|
||||
}
|
||||
|
||||
let encoded =
|
||||
serde_json::to_string(&entries).context("Could not encode JSON for localization table")?;
|
||||
serde_json::to_string(&entries).expect("Could not encode JSON for localization table");
|
||||
|
||||
Ok(encoded)
|
||||
}
|
||||
|
||||
@@ -7,9 +7,7 @@ use anyhow::Context;
|
||||
use memofs::{DirEntry, Vfs};
|
||||
|
||||
use crate::{
|
||||
snapshot::{
|
||||
is_path_ignored, InstanceContext, InstanceMetadata, InstanceSnapshot, InstigatingSource,
|
||||
},
|
||||
snapshot::{InstanceContext, InstanceMetadata, InstanceSnapshot, InstigatingSource},
|
||||
syncback::{hash_instance, FsSnapshot, SyncbackReturn, SyncbackSnapshot},
|
||||
};
|
||||
|
||||
@@ -43,8 +41,12 @@ pub fn snapshot_dir_no_meta(
|
||||
path: &Path,
|
||||
name: &str,
|
||||
) -> anyhow::Result<Option<InstanceSnapshot>> {
|
||||
let passes_filter_rules =
|
||||
|child: &DirEntry| !is_path_ignored(&context.path_ignore_rules, child.path());
|
||||
let passes_filter_rules = |child: &DirEntry| {
|
||||
context
|
||||
.path_ignore_rules
|
||||
.iter()
|
||||
.all(|rule| rule.passes(child.path()))
|
||||
};
|
||||
|
||||
let mut snapshot_children = Vec::new();
|
||||
|
||||
@@ -72,8 +74,6 @@ pub fn snapshot_dir_no_meta(
|
||||
normalized_path.join("init.server.luau"),
|
||||
normalized_path.join("init.client.lua"),
|
||||
normalized_path.join("init.client.luau"),
|
||||
normalized_path.join("init.plugin.lua"),
|
||||
normalized_path.join("init.plugin.luau"),
|
||||
normalized_path.join("init.csv"),
|
||||
];
|
||||
|
||||
|
||||
@@ -35,20 +35,14 @@ pub fn snapshot_json_model(
|
||||
format!("File is not a valid JSON model: {}", path.display())
|
||||
})?;
|
||||
|
||||
if let Some(top_level_name) = &instance.name {
|
||||
let new_name = format!("{}.model.json", top_level_name);
|
||||
// If the JSON has a name property, preserve it in metadata for syncback
|
||||
let specified_name = instance.name.clone();
|
||||
|
||||
log::warn!(
|
||||
"Model at path {} had a top-level Name field. \
|
||||
This field has been ignored since Rojo 6.0.\n\
|
||||
Consider removing this field and renaming the file to {}.",
|
||||
new_name,
|
||||
path.display()
|
||||
);
|
||||
// Use the name from JSON if present, otherwise fall back to filename-derived name
|
||||
if instance.name.is_none() {
|
||||
instance.name = Some(name.to_owned());
|
||||
}
|
||||
|
||||
instance.name = Some(name.to_owned());
|
||||
|
||||
let id = instance.id.take().map(RojoRef::new);
|
||||
let schema = instance.schema.take();
|
||||
|
||||
@@ -62,7 +56,8 @@ pub fn snapshot_json_model(
|
||||
.relevant_paths(vec![vfs.canonicalize(path)?])
|
||||
.context(context)
|
||||
.specified_id(id)
|
||||
.schema(schema);
|
||||
.schema(schema)
|
||||
.specified_name(specified_name);
|
||||
|
||||
Ok(Some(snapshot))
|
||||
}
|
||||
@@ -81,6 +76,7 @@ pub fn syncback_json_model<'sync>(
|
||||
// schemas will ever exist in one project for it to matter, but it
|
||||
// could have a performance cost.
|
||||
model.schema = old_inst.metadata().schema.clone();
|
||||
model.name = old_inst.metadata().specified_name.clone();
|
||||
}
|
||||
|
||||
Ok(SyncbackReturn {
|
||||
|
||||
@@ -158,8 +158,16 @@ pub fn syncback_lua<'sync>(
|
||||
|
||||
if !meta.is_empty() {
|
||||
let parent_location = snapshot.path.parent_err()?;
|
||||
let instance_name = &snapshot.new_inst().name;
|
||||
let slugified;
|
||||
let meta_name = if crate::syncback::validate_file_name(instance_name).is_err() {
|
||||
slugified = crate::syncback::slugify_name(instance_name);
|
||||
&slugified
|
||||
} else {
|
||||
instance_name
|
||||
};
|
||||
fs_snapshot.add_file(
|
||||
parent_location.join(format!("{}.meta.json", new_inst.name)),
|
||||
parent_location.join(format!("{}.meta.json", meta_name)),
|
||||
serde_json::to_vec_pretty(&meta).context("cannot serialize metadata")?,
|
||||
);
|
||||
}
|
||||
@@ -182,7 +190,6 @@ pub fn syncback_lua_init<'sync>(
|
||||
ScriptType::Server => "init.server.luau",
|
||||
ScriptType::Client => "init.client.luau",
|
||||
ScriptType::Module => "init.luau",
|
||||
ScriptType::Plugin => "init.plugin.luau",
|
||||
_ => anyhow::bail!("syncback is not yet implemented for {script_type:?}"),
|
||||
});
|
||||
|
||||
|
||||
@@ -10,7 +10,10 @@ use rbx_dom_weak::{
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::{
|
||||
json, resolution::UnresolvedValue, snapshot::InstanceSnapshot, syncback::SyncbackSnapshot,
|
||||
json,
|
||||
resolution::UnresolvedValue,
|
||||
snapshot::InstanceSnapshot,
|
||||
syncback::{validate_file_name, SyncbackSnapshot},
|
||||
RojoRef,
|
||||
};
|
||||
|
||||
@@ -36,6 +39,9 @@ pub struct AdjacentMetadata {
|
||||
#[serde(default, skip_serializing_if = "IndexMap::is_empty")]
|
||||
pub attributes: IndexMap<String, UnresolvedValue>,
|
||||
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub name: Option<String>,
|
||||
|
||||
#[serde(skip)]
|
||||
pub path: PathBuf,
|
||||
}
|
||||
@@ -144,6 +150,24 @@ impl AdjacentMetadata {
|
||||
}
|
||||
}
|
||||
|
||||
let name = snapshot
|
||||
.old_inst()
|
||||
.and_then(|inst| inst.metadata().specified_name.clone())
|
||||
.or_else(|| {
|
||||
// If this is a new instance and its name is invalid for the filesystem,
|
||||
// we need to specify the name in meta.json so it can be preserved
|
||||
if snapshot.old_inst().is_none() {
|
||||
let instance_name = &snapshot.new_inst().name;
|
||||
if validate_file_name(instance_name).is_err() {
|
||||
Some(instance_name.clone())
|
||||
} else {
|
||||
None
|
||||
}
|
||||
} else {
|
||||
None
|
||||
}
|
||||
});
|
||||
|
||||
Ok(Some(Self {
|
||||
ignore_unknown_instances: if ignore_unknown_instances {
|
||||
Some(true)
|
||||
@@ -155,6 +179,7 @@ impl AdjacentMetadata {
|
||||
path,
|
||||
id: None,
|
||||
schema,
|
||||
name,
|
||||
}))
|
||||
}
|
||||
|
||||
@@ -213,11 +238,26 @@ impl AdjacentMetadata {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn apply_name(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
|
||||
if self.name.is_some() && snapshot.metadata.specified_name.is_some() {
|
||||
anyhow::bail!(
|
||||
"cannot specify a name using {} (instance has a name from somewhere else)",
|
||||
self.path.display()
|
||||
);
|
||||
}
|
||||
if let Some(name) = &self.name {
|
||||
snapshot.name = name.clone().into();
|
||||
}
|
||||
snapshot.metadata.specified_name = self.name.take();
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn apply_all(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
|
||||
self.apply_ignore_unknown_instances(snapshot);
|
||||
self.apply_properties(snapshot)?;
|
||||
self.apply_id(snapshot)?;
|
||||
self.apply_schema(snapshot)?;
|
||||
self.apply_name(snapshot)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -226,11 +266,13 @@ impl AdjacentMetadata {
|
||||
///
|
||||
/// - The number of properties and attributes is 0
|
||||
/// - `ignore_unknown_instances` is None
|
||||
/// - `name` is None
|
||||
#[inline]
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.attributes.is_empty()
|
||||
&& self.properties.is_empty()
|
||||
&& self.ignore_unknown_instances.is_none()
|
||||
&& self.name.is_none()
|
||||
}
|
||||
|
||||
// TODO: Add method to allow selectively applying parts of metadata and
|
||||
@@ -262,6 +304,9 @@ pub struct DirectoryMetadata {
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub class_name: Option<Ustr>,
|
||||
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub name: Option<String>,
|
||||
|
||||
#[serde(skip)]
|
||||
pub path: PathBuf,
|
||||
}
|
||||
@@ -372,6 +417,24 @@ impl DirectoryMetadata {
|
||||
}
|
||||
}
|
||||
|
||||
let name = snapshot
|
||||
.old_inst()
|
||||
.and_then(|inst| inst.metadata().specified_name.clone())
|
||||
.or_else(|| {
|
||||
// If this is a new instance and its name is invalid for the filesystem,
|
||||
// we need to specify the name in meta.json so it can be preserved
|
||||
if snapshot.old_inst().is_none() {
|
||||
let instance_name = &snapshot.new_inst().name;
|
||||
if validate_file_name(instance_name).is_err() {
|
||||
Some(instance_name.clone())
|
||||
} else {
|
||||
None
|
||||
}
|
||||
} else {
|
||||
None
|
||||
}
|
||||
});
|
||||
|
||||
Ok(Some(Self {
|
||||
ignore_unknown_instances: if ignore_unknown_instances {
|
||||
Some(true)
|
||||
@@ -384,6 +447,7 @@ impl DirectoryMetadata {
|
||||
path,
|
||||
id: None,
|
||||
schema,
|
||||
name,
|
||||
}))
|
||||
}
|
||||
|
||||
@@ -393,6 +457,7 @@ impl DirectoryMetadata {
|
||||
self.apply_properties(snapshot)?;
|
||||
self.apply_id(snapshot)?;
|
||||
self.apply_schema(snapshot)?;
|
||||
self.apply_name(snapshot)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -464,17 +529,33 @@ impl DirectoryMetadata {
|
||||
snapshot.metadata.schema = self.schema.take();
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn apply_name(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
|
||||
if self.name.is_some() && snapshot.metadata.specified_name.is_some() {
|
||||
anyhow::bail!(
|
||||
"cannot specify a name using {} (instance has a name from somewhere else)",
|
||||
self.path.display()
|
||||
);
|
||||
}
|
||||
if let Some(name) = &self.name {
|
||||
snapshot.name = name.clone().into();
|
||||
}
|
||||
snapshot.metadata.specified_name = self.name.take();
|
||||
Ok(())
|
||||
}
|
||||
/// Returns whether the metadata is 'empty', meaning it doesn't have anything
|
||||
/// worth persisting in it. Specifically:
|
||||
///
|
||||
/// - The number of properties and attributes is 0
|
||||
/// - `ignore_unknown_instances` is None
|
||||
/// - `class_name` is either None or not Some("Folder")
|
||||
/// - `name` is None
|
||||
#[inline]
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.attributes.is_empty()
|
||||
&& self.properties.is_empty()
|
||||
&& self.ignore_unknown_instances.is_none()
|
||||
&& self.name.is_none()
|
||||
&& if let Some(class) = &self.class_name {
|
||||
class == "Folder"
|
||||
} else {
|
||||
|
||||
@@ -91,9 +91,7 @@ pub fn snapshot_from_vfs(
|
||||
// TODO: Is this even necessary anymore?
|
||||
match file_name {
|
||||
"init.server.luau" | "init.server.lua" | "init.client.luau" | "init.client.lua"
|
||||
| "init.plugin.luau" | "init.plugin.lua" | "init.luau" | "init.lua" | "init.csv" => {
|
||||
return Ok(None)
|
||||
}
|
||||
| "init.luau" | "init.lua" | "init.csv" => return Ok(None),
|
||||
_ => {}
|
||||
}
|
||||
|
||||
@@ -126,8 +124,6 @@ fn get_dir_middleware<'path>(
|
||||
(Middleware::ServerScriptDir, "init.server.lua"),
|
||||
(Middleware::ClientScriptDir, "init.client.luau"),
|
||||
(Middleware::ClientScriptDir, "init.client.lua"),
|
||||
(Middleware::PluginScriptDir, "init.plugin.lua"),
|
||||
(Middleware::PluginScriptDir, "init.plugin.luau"),
|
||||
(Middleware::CsvDir, "init.csv"),
|
||||
]
|
||||
});
|
||||
@@ -209,8 +205,6 @@ pub enum Middleware {
|
||||
#[serde(skip_deserializing)]
|
||||
ClientScriptDir,
|
||||
#[serde(skip_deserializing)]
|
||||
PluginScriptDir,
|
||||
#[serde(skip_deserializing)]
|
||||
ModuleScriptDir,
|
||||
#[serde(skip_deserializing)]
|
||||
CsvDir,
|
||||
@@ -261,9 +255,6 @@ impl Middleware {
|
||||
Self::ClientScriptDir => {
|
||||
snapshot_lua_init(context, vfs, path, name, ScriptType::Client)
|
||||
}
|
||||
Self::PluginScriptDir => {
|
||||
snapshot_lua_init(context, vfs, path, name, ScriptType::Plugin)
|
||||
}
|
||||
Self::ModuleScriptDir => {
|
||||
snapshot_lua_init(context, vfs, path, name, ScriptType::Module)
|
||||
}
|
||||
@@ -306,7 +297,6 @@ impl Middleware {
|
||||
Middleware::Dir => syncback_dir(snapshot),
|
||||
Middleware::ServerScriptDir => syncback_lua_init(ScriptType::Server, snapshot),
|
||||
Middleware::ClientScriptDir => syncback_lua_init(ScriptType::Client, snapshot),
|
||||
Middleware::PluginScriptDir => syncback_lua_init(ScriptType::Plugin, snapshot),
|
||||
Middleware::ModuleScriptDir => syncback_lua_init(ScriptType::Module, snapshot),
|
||||
Middleware::CsvDir => syncback_csv_init(snapshot),
|
||||
|
||||
@@ -328,7 +318,6 @@ impl Middleware {
|
||||
Middleware::Dir
|
||||
| Middleware::ServerScriptDir
|
||||
| Middleware::ClientScriptDir
|
||||
| Middleware::PluginScriptDir
|
||||
| Middleware::ModuleScriptDir
|
||||
| Middleware::CsvDir
|
||||
)
|
||||
|
||||
@@ -344,11 +344,6 @@ pub fn syncback_project<'sync>(
|
||||
let mut new_child_map = HashMap::new();
|
||||
|
||||
let mut node_changed_map = Vec::new();
|
||||
// Tracks whether any stale default-valued properties were removed from
|
||||
// project nodes. If so, we must reserialize even if
|
||||
// project_node_should_reserialize wouldn't otherwise detect a change
|
||||
// (it only compares node properties forward, not in reverse).
|
||||
let mut removed_stale_properties = false;
|
||||
let mut node_queue = VecDeque::with_capacity(1);
|
||||
node_queue.push_back((&mut project.tree, old_inst, snapshot.new_inst()));
|
||||
|
||||
@@ -407,12 +402,10 @@ pub fn syncback_project<'sync>(
|
||||
|
||||
// We only want to set properties if it needs it.
|
||||
if !middleware.handles_own_properties() {
|
||||
removed_stale_properties |=
|
||||
project_node_property_syncback_path(snapshot, new_inst, node);
|
||||
project_node_property_syncback_path(snapshot, new_inst, node);
|
||||
}
|
||||
} else {
|
||||
removed_stale_properties |=
|
||||
project_node_property_syncback_no_path(snapshot, new_inst, node);
|
||||
project_node_property_syncback_no_path(snapshot, new_inst, node);
|
||||
}
|
||||
|
||||
for child_ref in new_inst.children() {
|
||||
@@ -514,18 +507,12 @@ pub fn syncback_project<'sync>(
|
||||
}
|
||||
let mut fs_snapshot = FsSnapshot::new();
|
||||
|
||||
let mut needs_reserialize = removed_stale_properties;
|
||||
if !needs_reserialize {
|
||||
for (node_properties, node_attributes, old_inst) in node_changed_map {
|
||||
if project_node_should_reserialize(node_properties, node_attributes, old_inst)? {
|
||||
needs_reserialize = true;
|
||||
break;
|
||||
}
|
||||
for (node_properties, node_attributes, old_inst) in node_changed_map {
|
||||
if project_node_should_reserialize(node_properties, node_attributes, old_inst)? {
|
||||
fs_snapshot.add_file(project_path, serde_json::to_vec_pretty(&project)?);
|
||||
break;
|
||||
}
|
||||
}
|
||||
if needs_reserialize {
|
||||
fs_snapshot.add_file(project_path, serde_json::to_vec_pretty(&project)?);
|
||||
}
|
||||
|
||||
Ok(SyncbackReturn {
|
||||
fs_snapshot,
|
||||
@@ -534,18 +521,15 @@ pub fn syncback_project<'sync>(
|
||||
})
|
||||
}
|
||||
|
||||
/// Syncs properties from the new instance into the project node.
|
||||
/// Returns `true` if any stale properties were removed (i.e. properties
|
||||
/// that existed in the project node but are now at their engine default).
|
||||
fn project_node_property_syncback(
|
||||
_snapshot: &SyncbackSnapshot,
|
||||
filtered_properties: UstrMap<&Variant>,
|
||||
new_inst: &Instance,
|
||||
node: &mut ProjectNode,
|
||||
) -> bool {
|
||||
) {
|
||||
let properties = &mut node.properties;
|
||||
let mut attributes = BTreeMap::new();
|
||||
for (&name, &value) in &filtered_properties {
|
||||
for (name, value) in filtered_properties {
|
||||
match value {
|
||||
Variant::Attributes(attrs) => {
|
||||
for (attr_name, attr_value) in attrs.iter() {
|
||||
@@ -568,48 +552,14 @@ fn project_node_property_syncback(
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Remove stale properties: entries that exist in the project node's
|
||||
// $properties but are no longer in the filtered (non-default) properties
|
||||
// from the instance. This handles the case where Studio resets a property
|
||||
// to its engine default — filter_properties won't include it, so we need
|
||||
// to clean up the now-stale project entry.
|
||||
let class_data = rbx_reflection_database::get()
|
||||
.ok()
|
||||
.and_then(|db| db.classes.get(new_inst.class.as_str()));
|
||||
let len_before = properties.len();
|
||||
properties.retain(|prop_name, _| {
|
||||
if filtered_properties.contains_key(prop_name) {
|
||||
return true;
|
||||
}
|
||||
// Only remove if the property has a known default value in the
|
||||
// reflection database. If there's no default, the property might be
|
||||
// absent from the instance for other reasons (e.g. unknown property),
|
||||
// so we conservatively keep it.
|
||||
if let Some(data) = &class_data {
|
||||
if data.default_properties.contains_key(prop_name.as_str()) {
|
||||
log::debug!(
|
||||
"Removing stale property '{}' from project node for class '{}': \
|
||||
value has been reset to engine default",
|
||||
prop_name,
|
||||
new_inst.class
|
||||
);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
true
|
||||
});
|
||||
let removed_stale = properties.len() < len_before;
|
||||
|
||||
node.attributes = attributes;
|
||||
removed_stale
|
||||
}
|
||||
|
||||
fn project_node_property_syncback_path(
|
||||
snapshot: &SyncbackSnapshot,
|
||||
new_inst: &Instance,
|
||||
node: &mut ProjectNode,
|
||||
) -> bool {
|
||||
) {
|
||||
let filtered_properties = snapshot
|
||||
.get_path_filtered_properties(new_inst.referent())
|
||||
.unwrap();
|
||||
@@ -620,7 +570,7 @@ fn project_node_property_syncback_no_path(
|
||||
snapshot: &SyncbackSnapshot,
|
||||
new_inst: &Instance,
|
||||
node: &mut ProjectNode,
|
||||
) -> bool {
|
||||
) {
|
||||
let filtered_properties = filter_properties(snapshot.project(), new_inst);
|
||||
project_node_property_syncback(snapshot, filtered_properties, new_inst, node)
|
||||
}
|
||||
|
||||
@@ -15,8 +15,6 @@ metadata:
|
||||
- /root/init.server.luau
|
||||
- /root/init.client.lua
|
||||
- /root/init.client.luau
|
||||
- /root/init.plugin.lua
|
||||
- /root/init.plugin.luau
|
||||
- /root/init.csv
|
||||
- /root/init.meta.json
|
||||
- /root/init.meta.jsonc
|
||||
|
||||
@@ -15,8 +15,6 @@ metadata:
|
||||
- /root/init.server.luau
|
||||
- /root/init.client.lua
|
||||
- /root/init.client.luau
|
||||
- /root/init.plugin.lua
|
||||
- /root/init.plugin.luau
|
||||
- /root/init.csv
|
||||
- /root/init.meta.json
|
||||
- /root/init.meta.jsonc
|
||||
|
||||
@@ -15,8 +15,6 @@ metadata:
|
||||
- /foo/init.server.luau
|
||||
- /foo/init.client.lua
|
||||
- /foo/init.client.luau
|
||||
- /foo/init.plugin.lua
|
||||
- /foo/init.plugin.luau
|
||||
- /foo/init.csv
|
||||
- /foo/init.meta.json
|
||||
- /foo/init.meta.jsonc
|
||||
|
||||
@@ -15,8 +15,6 @@ metadata:
|
||||
- /foo/init.server.luau
|
||||
- /foo/init.client.lua
|
||||
- /foo/init.client.luau
|
||||
- /foo/init.plugin.lua
|
||||
- /foo/init.plugin.luau
|
||||
- /foo/init.csv
|
||||
- /foo/init.meta.json
|
||||
- /foo/init.meta.jsonc
|
||||
@@ -42,8 +40,6 @@ children:
|
||||
- /foo/Child/init.server.luau
|
||||
- /foo/Child/init.client.lua
|
||||
- /foo/Child/init.client.luau
|
||||
- /foo/Child/init.plugin.lua
|
||||
- /foo/Child/init.plugin.luau
|
||||
- /foo/Child/init.csv
|
||||
- /foo/Child/init.meta.json
|
||||
- /foo/Child/init.meta.jsonc
|
||||
|
||||
@@ -15,8 +15,6 @@ metadata:
|
||||
- /root/init.server.luau
|
||||
- /root/init.client.lua
|
||||
- /root/init.client.luau
|
||||
- /root/init.plugin.lua
|
||||
- /root/init.plugin.luau
|
||||
- /root/init.csv
|
||||
- /root/init.meta.json
|
||||
- /root/init.meta.jsonc
|
||||
|
||||
@@ -15,8 +15,6 @@ metadata:
|
||||
- /root/init.server.luau
|
||||
- /root/init.client.lua
|
||||
- /root/init.client.luau
|
||||
- /root/init.plugin.lua
|
||||
- /root/init.plugin.luau
|
||||
- /root/init.csv
|
||||
- /root/init.meta.json
|
||||
- /root/init.meta.jsonc
|
||||
|
||||
@@ -8,11 +8,11 @@ use rbx_dom_weak::Instance;
|
||||
|
||||
use crate::{snapshot::InstanceWithMeta, snapshot_middleware::Middleware};
|
||||
|
||||
pub fn name_for_inst<'old>(
|
||||
pub fn name_for_inst<'a>(
|
||||
middleware: Middleware,
|
||||
new_inst: &Instance,
|
||||
old_inst: Option<InstanceWithMeta<'old>>,
|
||||
) -> anyhow::Result<Cow<'old, str>> {
|
||||
new_inst: &'a Instance,
|
||||
old_inst: Option<InstanceWithMeta<'a>>,
|
||||
) -> anyhow::Result<Cow<'a, str>> {
|
||||
if let Some(old_inst) = old_inst {
|
||||
if let Some(source) = old_inst.metadata().relevant_paths.first() {
|
||||
source
|
||||
@@ -35,15 +35,24 @@ pub fn name_for_inst<'old>(
|
||||
| Middleware::CsvDir
|
||||
| Middleware::ServerScriptDir
|
||||
| Middleware::ClientScriptDir
|
||||
| Middleware::PluginScriptDir
|
||||
| Middleware::ModuleScriptDir => Cow::Owned(new_inst.name.clone()),
|
||||
| Middleware::ModuleScriptDir => {
|
||||
if validate_file_name(&new_inst.name).is_err() {
|
||||
Cow::Owned(slugify_name(&new_inst.name))
|
||||
} else {
|
||||
Cow::Borrowed(&new_inst.name)
|
||||
}
|
||||
}
|
||||
_ => {
|
||||
let extension = extension_for_middleware(middleware);
|
||||
let name = &new_inst.name;
|
||||
validate_file_name(name).with_context(|| {
|
||||
format!("name '{name}' is not legal to write to the file system")
|
||||
})?;
|
||||
Cow::Owned(format!("{name}.{extension}"))
|
||||
let slugified;
|
||||
let final_name = if validate_file_name(&new_inst.name).is_err() {
|
||||
slugified = slugify_name(&new_inst.name);
|
||||
&slugified
|
||||
} else {
|
||||
&new_inst.name
|
||||
};
|
||||
|
||||
Cow::Owned(format!("{final_name}.{extension}"))
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -79,7 +88,6 @@ pub fn extension_for_middleware(middleware: Middleware) -> &'static str {
|
||||
| Middleware::CsvDir
|
||||
| Middleware::ServerScriptDir
|
||||
| Middleware::ClientScriptDir
|
||||
| Middleware::PluginScriptDir
|
||||
| Middleware::ModuleScriptDir => {
|
||||
unimplemented!("directory middleware requires special treatment")
|
||||
}
|
||||
@@ -96,6 +104,39 @@ const INVALID_WINDOWS_NAMES: [&str; 22] = [
|
||||
/// in a file's name.
|
||||
const FORBIDDEN_CHARS: [char; 9] = ['<', '>', ':', '"', '/', '|', '?', '*', '\\'];
|
||||
|
||||
/// Slugifies a name by replacing forbidden characters with underscores
|
||||
/// and ensuring the result is a valid file name
|
||||
pub fn slugify_name(name: &str) -> String {
|
||||
let mut result = String::with_capacity(name.len());
|
||||
|
||||
for ch in name.chars() {
|
||||
if FORBIDDEN_CHARS.contains(&ch) {
|
||||
result.push('_');
|
||||
} else {
|
||||
result.push(ch);
|
||||
}
|
||||
}
|
||||
|
||||
// Handle Windows reserved names by appending an underscore
|
||||
let result_lower = result.to_lowercase();
|
||||
for forbidden in INVALID_WINDOWS_NAMES {
|
||||
if result_lower == forbidden.to_lowercase() {
|
||||
result.push('_');
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
while result.ends_with(' ') || result.ends_with('.') {
|
||||
result.pop();
|
||||
}
|
||||
|
||||
if result.is_empty() || result.chars().all(|c| c == '_') {
|
||||
result = "instance".to_string();
|
||||
}
|
||||
|
||||
result
|
||||
}
|
||||
|
||||
/// Validates a provided file name to ensure it's allowed on the file system. An
|
||||
/// error is returned if the name isn't allowed, indicating why.
|
||||
/// This takes into account rules for Windows, MacOS, and Linux.
|
||||
|
||||
@@ -21,14 +21,14 @@ use std::{
|
||||
};
|
||||
|
||||
use crate::{
|
||||
glob::{Glob, IgnorableGlob},
|
||||
glob::Glob,
|
||||
snapshot::{InstanceWithMeta, RojoTree},
|
||||
snapshot_middleware::Middleware,
|
||||
syncback::ref_properties::{collect_referents, link_referents},
|
||||
Project,
|
||||
};
|
||||
|
||||
pub use file_names::{extension_for_middleware, name_for_inst, validate_file_name};
|
||||
pub use file_names::{extension_for_middleware, name_for_inst, slugify_name, validate_file_name};
|
||||
pub use fs_snapshot::FsSnapshot;
|
||||
pub use hash::*;
|
||||
pub use property_filter::{filter_properties, filter_properties_preallocated};
|
||||
@@ -359,7 +359,6 @@ pub fn get_best_middleware(snapshot: &SyncbackSnapshot) -> Middleware {
|
||||
middleware = match middleware {
|
||||
Middleware::ServerScript => Middleware::ServerScriptDir,
|
||||
Middleware::ClientScript => Middleware::ClientScriptDir,
|
||||
Middleware::PluginScript => Middleware::PluginScriptDir,
|
||||
Middleware::ModuleScript => Middleware::ModuleScriptDir,
|
||||
Middleware::Csv => Middleware::CsvDir,
|
||||
Middleware::JsonModel | Middleware::Text => Middleware::Dir,
|
||||
@@ -415,18 +414,18 @@ pub struct SyncbackRules {
|
||||
}
|
||||
|
||||
impl SyncbackRules {
|
||||
pub fn compile_globs(&self) -> anyhow::Result<Vec<IgnorableGlob>> {
|
||||
pub fn compile_globs(&self) -> anyhow::Result<Vec<Glob>> {
|
||||
let mut globs = Vec::with_capacity(self.ignore_paths.len());
|
||||
let dir_ignore_paths = self.create_ignore_dir_paths.unwrap_or(true);
|
||||
|
||||
for pattern in &self.ignore_paths {
|
||||
let glob = IgnorableGlob::new(pattern)
|
||||
let glob = Glob::new(pattern)
|
||||
.with_context(|| format!("the pattern '{pattern}' is not a valid glob"))?;
|
||||
globs.push(glob);
|
||||
|
||||
if dir_ignore_paths {
|
||||
if let Some(dir_pattern) = pattern.strip_suffix("/**") {
|
||||
if let Ok(glob) = IgnorableGlob::new(dir_pattern) {
|
||||
if let Ok(glob) = Glob::new(dir_pattern) {
|
||||
globs.push(glob)
|
||||
}
|
||||
}
|
||||
@@ -437,7 +436,7 @@ impl SyncbackRules {
|
||||
}
|
||||
}
|
||||
|
||||
fn is_valid_path(globs: &Option<Vec<IgnorableGlob>>, base_path: &Path, path: &Path) -> bool {
|
||||
fn is_valid_path(globs: &Option<Vec<Glob>>, base_path: &Path, path: &Path) -> bool {
|
||||
let git_glob = GIT_IGNORE_GLOB.get_or_init(|| Glob::new(".git/**").unwrap());
|
||||
let test_path = match path.strip_prefix(base_path) {
|
||||
Ok(suffix) => suffix,
|
||||
@@ -447,16 +446,11 @@ fn is_valid_path(globs: &Option<Vec<IgnorableGlob>>, base_path: &Path, path: &Pa
|
||||
return false;
|
||||
}
|
||||
if let Some(ref ignore_paths) = globs {
|
||||
// Gitignore-style "last match wins"
|
||||
let mut ignored = false;
|
||||
for glob in ignore_paths {
|
||||
if glob.is_match(test_path) {
|
||||
ignored = !glob.is_negation();
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if ignored {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
true
|
||||
}
|
||||
@@ -544,71 +538,3 @@ fn strip_unknown_root_children(new: &mut WeakDom, old: &RojoTree) {
|
||||
new.destroy(child_ref);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
|
||||
fn rules(ignore_paths: &[&str], create_ignore_dir_paths: Option<bool>) -> SyncbackRules {
|
||||
SyncbackRules {
|
||||
ignore_trees: Vec::new(),
|
||||
ignore_paths: ignore_paths.iter().map(|s| s.to_string()).collect(),
|
||||
ignore_properties: IndexMap::new(),
|
||||
sync_current_camera: None,
|
||||
sync_unscriptable: None,
|
||||
ignore_referents: None,
|
||||
create_ignore_dir_paths,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ignore_paths_negation() {
|
||||
let globs = Some(
|
||||
rules(&["**/*.lua", "!keep.lua"], Some(false))
|
||||
.compile_globs()
|
||||
.unwrap(),
|
||||
);
|
||||
let base = Path::new("/test");
|
||||
|
||||
// A later negation re-includes a path matched by an earlier pattern.
|
||||
assert!(!is_valid_path(&globs, base, Path::new("/test/foo.lua")));
|
||||
assert!(is_valid_path(&globs, base, Path::new("/test/keep.lua")));
|
||||
// Paths matched by no rule are valid.
|
||||
assert!(is_valid_path(&globs, base, Path::new("/test/plain.txt")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ignore_paths_negation_with_dir_expansion() {
|
||||
// With `create_ignore_dir_paths`, a negated `foo/**` pattern should also
|
||||
// re-include the `foo` directory itself, mirroring the file rule.
|
||||
let globs = Some(
|
||||
rules(&["**/*", "!keep/**"], Some(true))
|
||||
.compile_globs()
|
||||
.unwrap(),
|
||||
);
|
||||
let base = Path::new("/test");
|
||||
|
||||
assert!(!is_valid_path(&globs, base, Path::new("/test/drop/a.lua")));
|
||||
assert!(is_valid_path(&globs, base, Path::new("/test/keep")));
|
||||
assert!(is_valid_path(&globs, base, Path::new("/test/keep/a.lua")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ignore_paths_escaped_bang_is_literal() {
|
||||
// `\!literal.lua` should ignore a file literally named `!literal.lua`
|
||||
// rather than being parsed as a negation.
|
||||
let globs = Some(
|
||||
rules(&[r"\!literal.lua"], Some(false))
|
||||
.compile_globs()
|
||||
.unwrap(),
|
||||
);
|
||||
let base = Path::new("/test");
|
||||
|
||||
assert!(!globs.as_ref().unwrap()[0].is_negation());
|
||||
assert!(!is_valid_path(
|
||||
&globs,
|
||||
base,
|
||||
Path::new("/test/!literal.lua")
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user