Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improves thread-safety and ensures that FileConfigs reload properly #152

Merged
merged 18 commits into from
Jan 28, 2024
Merged

Improves thread-safety and ensures that FileConfigs reload properly #152

merged 18 commits into from
Jan 28, 2024

Conversation

TheElectronWill
Copy link
Owner

@TheElectronWill TheElectronWill commented Jan 3, 2024 •
edited
Loading

The goal is to resolve #147 by doing multiple things:

  • add thread-safe config types and make FileConfig use them
  • add a throttling to FileConfig autosave (autoreload has been taken care of in Optimize the FileWatcher with only one WatchService #145)
  • avoid reloading a FileConfig if the file is empty, wait a little bit for the editor to write the file (there might be a way to detect that the file is in use)

Hopefully this work can also provide #64 😉

@TheElectronWill TheElectronWill self-assigned this Jan 3, 2024
@TheElectronWill TheElectronWill changed the title [WIP] Implement thread-safe configurations and rework FileConfig [WIP] Improves thread-safety and ensures that FileConfigs reload properly Jan 3, 2024
@TheElectronWill TheElectronWill mentioned this pull request Jan 3, 2024
Merged
@TheElectronWill
Implement thread-safe configurations
d600a1f
@TheElectronWill
Rewrite FileConfig implementations
eceb86b 
- add bulkUpdate methods to FileConfig and ConcurrentConfig
- add bulkRead methods to ConcurrentConfig
- add replaceContentBy to concurrent configs
- and more :)
@TheElectronWill
Test thread-safe configurations and FileConfig debouncing
36ddd8d
@TheElectronWill
Remove useless AutosaveFileConfig
5d2e88d
@TheElectronWill
Add code coverage with jacoco
02590bc
@TheElectronWill
Write more tests and comments
0473c0c
@TheElectronWill
Even more tests + bug fixes for concurrent configurations
e85a79c
@TheElectronWill
Make FileWatcherTest less flaky
d11311f
@TheElectronWill
Override bulkUpdate on autosave FileConfig
5045bbf
@TheElectronWill
Add a way to listen for load, save, autoload, autosave
1205d99
@TheElectronWill
Deprecate Config.getDefaultMapCreator(boolean concurrent)
af05b62
@TheElectronWill
Allow no save/load listener
ed81991
@TheElectronWill
Fix spacing of toml tables and arrays of tables, in a robust way
048677c
@TheElectronWill TheElectronWill marked this pull request as ready for review January 27, 2024 21:27
@TheElectronWill TheElectronWill merged commit 949be42 into master Jan 28, 2024
1 check passed
@TheElectronWill TheElectronWill changed the title [WIP] Improves thread-safety and ensures that FileConfigs reload properly Improves thread-safety and ensures that FileConfigs reload properly Jan 28, 2024
This was referenced Jan 28, 2024
Closed
Closed
Closed
@TheElectronWill
Copy link
Owner Author

Here is an example of the new capabilities of FileConfigs: #147 (comment)

This was referenced Jan 28, 2024
Closed
Closed
0utplay referenced this pull request in CloudNetService/CloudNet May 16, 2024
@renovate
chore: update nightConfig to v3.7.1 (#1404)
06abf33 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[com.electronwill.night-config:json](https://github.com/TheElectronWill/night-config)
| `3.6.7` -> `3.7.1` |
[![age](https://developer.mend.io/api/mc/badges/age/maven/com.electronwill.night-config:json/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.electronwill.night-config:json/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.electronwill.night-config:json/3.6.7/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.electronwill.night-config:json/3.6.7/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[com.electronwill.night-config:yaml](https://github.com/TheElectronWill/night-config)
| `3.6.7` -> `3.7.1` |
[![age](https://developer.mend.io/api/mc/badges/age/maven/com.electronwill.night-config:yaml/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.electronwill.night-config:yaml/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.electronwill.night-config:yaml/3.6.7/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.electronwill.night-config:yaml/3.6.7/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[com.electronwill.night-config:toml](https://github.com/TheElectronWill/night-config)
| `3.6.7` -> `3.7.1` |
[![age](https://developer.mend.io/api/mc/badges/age/maven/com.electronwill.night-config:toml/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.electronwill.night-config:toml/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.electronwill.night-config:toml/3.6.7/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.electronwill.night-config:toml/3.6.7/3.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>TheElectronWill/night-config
(com.electronwill.night-config:json)</summary>

###
[`v3.7.1`](https://github.com/TheElectronWill/night-config/releases/tag/v3.7.1):
3.7.1 Gradle fix

##### Fixes

- Resolve a misconfiguration of the Gradle build, see
[https://github.com/TheElectronWill/night-config/issues/173](https://github.com/TheElectronWill/night-config/issues/173)
for more details
-   Fix a minor issue with the new options of `JsonParser`

You should use v3.7.1 instead of v3.7.0.
Please [read the release notes of
v3.7.0](https://github.com/TheElectronWill/night-config/issues/173)
:sparkles: to learn what has changed since v3.6.x.

**Full Changelog**:
TheElectronWill/night-config@v3.7.0...v3.7.1

###
[`v3.7.0`](https://github.com/TheElectronWill/night-config/releases/tag/v3.7.0):
3.7.0: NightConfig rejuvenated ✨

##### Major changes

- **`FileWatcher` now comes with out-of-the-box debouncing**, which
improves the performance of autoreloading and autosaving configurations
:zap:, see
[https://github.com/TheElectronWill/night-config/pull/148](https://github.com/TheElectronWill/night-config/pull/148)
- **`FileConfig` instances are now actually thread-safe** and work
better with autoreload, which should prevent most of the corruption
issues 🛡️, see
[https://github.com/TheElectronWill/night-config/pull/152](https://github.com/TheElectronWill/night-config/pull/152)
- **A new Serialization/Deserialization framework** is available in the
`serde` package 🚀, see
[https://github.com/TheElectronWill/night-config/pull/163](https://github.com/TheElectronWill/night-config/pull/163).
Unlike the old `ObjectConverter`, the new `ObjectSerializer` and
`ObjectDeserializer` are modular and extensible: you can register your
own serializers and deserializers. Deserializers (config -> object) are
chosen based on the generic type of the field to set and the type of the
config value to deserialize. This allows for fine-grained
deserialization. The old `ObjectConverter` still works but is now
deprecated. The goal is to remove the old `conversion` package in
version 4.0.0.

##### Enhancements

- Allow multiple spec conditions to be checked by
[@&#8203;vaperion](https://github.com/vaperion) in
[https://github.com/TheElectronWill/night-config/pull/151](https://github.com/TheElectronWill/night-config/pull/151)
(Note: this fix applies to the deprecated `conversion` package; the new
`serde` package supports multiple `@SerdeAssert` conditions out of the
box)
- Support UTF-16 and UTF-8 BOM by
[@&#8203;TheElectronWill](https://github.com/TheElectronWill) in
TheElectronWill/night-config@68502b9
- In ConfigSpec and in the new `serde` Deserializer, automatically apply
some "risky" conversions (e.g. long -> int) when it is not lossy, close
[https://github.com/TheElectronWill/night-config/issues/119](https://github.com/TheElectronWill/night-config/issues/119)
- Allow custom `Config` storage in `ConfigSpec`, by
[@&#8203;PaintNinja](https://github.com/PaintNinja) in
[https://github.com/TheElectronWill/night-config/pull/168](https://github.com/TheElectronWill/night-config/pull/168)
- More unit tests, on Java 8, Java 11 and Java 17, by
[@&#8203;TheElectronWill](https://github.com/TheElectronWill)

##### Bug fixes

- toml: Fix squeezed Files by
[@&#8203;Stein-N](https://github.com/Stein-N) in
[https://github.com/TheElectronWill/night-config/pull/154](https://github.com/TheElectronWill/night-config/pull/154)
- toml: Align List ending when in a "group" by
[@&#8203;Stein-N](https://github.com/Stein-N) in
[https://github.com/TheElectronWill/night-config/pull/160](https://github.com/TheElectronWill/night-config/pull/160)
- toml: Allow header comments by
[@&#8203;Stein-N](https://github.com/Stein-N) in
[https://github.com/TheElectronWill/night-config/pull/162](https://github.com/TheElectronWill/night-config/pull/162)
- json: Disallow trailing data (configurable) by
[@&#8203;TheElectronWill](https://github.com/TheElectronWill), close
[https://github.com/TheElectronWill/night-config/issues/167](https://github.com/TheElectronWill/night-config/issues/167)
- Multiple bugs have been fixed in `ObjectConverter` by
[@&#8203;TheElectronWill](https://github.com/TheElectronWill) in
[https://github.com/TheElectronWill/night-config/pull/163](https://github.com/TheElectronWill/night-config/pull/163)

##### Compatibility Note

NightConfig 3.7.0 is backward-compatible with previous releases,
therefore I encourage you to upgrade your dependency on NightConfig in
order to benefit from the new version.

Binary-wise, the backward-compatibility has been checked with `japicmp`.
Source-wise, there is one small incompatible change:
`FileWatcher#addWatch` no longers throws an `IOException`, which can
result in a compiler error `unreachable code` on the associated
try/catch ([example in
forge](https://github.com/MinecraftForge/MinecraftForge/blob/640c206117864085e3c25889bcabeaddd555e9fb/fmlcore/src/main/java/net/minecraftforge/fml/config/ConfigFileTypeHandler.java#L50-L55)).

##### New Contributors

- [@&#8203;vaperion](https://github.com/vaperion) made their first
contribution in
[https://github.com/TheElectronWill/night-config/pull/151](https://github.com/TheElectronWill/night-config/pull/151)
- [@&#8203;Stein-N](https://github.com/Stein-N) made their first
contribution in
[https://github.com/TheElectronWill/night-config/pull/154](https://github.com/TheElectronWill/night-config/pull/154)
- [@&#8203;PaintNinja](https://github.com/PaintNinja) made their first
contribution in
[https://github.com/TheElectronWill/night-config/pull/168](https://github.com/TheElectronWill/night-config/pull/168)

Thank you everyone!

**Full Changelog**:
TheElectronWill/night-config@v3.6.7...v3.7.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6:00am" in timezone
Europe/Berlin, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/CloudNetService/CloudNet).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjMuNSIsInVwZGF0ZWRJblZlciI6IjM3LjM2My41IiwidGFyZ2V0QnJhbmNoIjoibmlnaHRseSIsImxhYmVscyI6WyJ0OiBkZXBlbmRlbmNpZXMiXX0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@TheElectronWill TheElectronWill deleted the fix-config-multithreading branch July 7, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@TheElectronWill TheElectronWill

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Data race when saving and loading a FileConfig at the same time?
1 participant
@TheElectronWill