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

Let core.get_mod_storage be called multiple times #12572

Merged
merged 5 commits into from
Jul 23, 2022
Merged

Let core.get_mod_storage be called multiple times #12572

merged 5 commits into from
Jul 23, 2022

Conversation

TurkeyMcMac
Copy link
Contributor

This is a bug fix. If a single mod calls core.get_mod_storage multiple times, it should get the same reference every time, unless references are garbage-collected between calls. Without this PR, core.get_mod_storage cannot be called multiple times unless references are garbage-collected between calls.

This PR works by implementing core.get_mod_storage in Lua. The C++ version still exists, but it takes the desired mod name as an argument, and is only available internally.

To do

This PR is Ready for Review.

How to test

Have this code run at some mod's initialization time:

assert(core.get_mod_storage() == core.get_mod_storage())                        
collectgarbage()                                                                
assert(core.get_mod_storage())

sfan5
sfan5 reviewed Jul 22, 2022
View reviewed changes
builtin/common/storage.lua Outdated Show resolved Hide resolved
builtin/game/init.lua Outdated Show resolved Hide resolved
src/script/lua_api/l_storage.cpp Show resolved Hide resolved
@sfan5 sfan5 added the Bugfix 🐛 PRs that fix a bug label Jul 22, 2022
@TurkeyMcMac TurkeyMcMac requested a review from sfan5 July 22, 2022 12:20
@TurkeyMcMac TurkeyMcMac requested a review from sfan5 July 22, 2022 13:31
sfan5
sfan5 approved these changes Jul 22, 2022
View reviewed changes
Copy link
Member

@sfan5 sfan5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Jul 22, 2022
@TurkeyMcMac
Remove (un)registerModStorage
9345583 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
SmallJoker
SmallJoker approved these changes Jul 22, 2022
View reviewed changes
Copy link
Member

@SmallJoker SmallJoker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works as intended. Code looks good.

@sfan5 sfan5 added this to the 5.6.0 milestone Jul 23, 2022
@appgurueu
Copy link
Contributor

appgurueu commented Jul 23, 2022 •
edited 

assert(core.get_mod_storage() == core.get_mod_storage())                        
collectgarbage()                                                                
assert(core.get_mod_storage())

Perhaps add this to games/devtest/mods/unittests/misc.lua?

@sfan5 sfan5 merged commit d631f21 into minetest:master Jul 23, 2022
TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Jul 23, 2022
@TurkeyMcMac
Remove (un)registerModStorage
2b0adae 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
@TurkeyMcMac
Copy link
Contributor Author

@appgurueu I have now added a unit test as part of #12562.

TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Aug 14, 2022
@TurkeyMcMac
Remove (un)registerModStorage
7d98942 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Aug 25, 2022
@TurkeyMcMac
Remove (un)registerModStorage
7026b84 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Sep 13, 2022
@TurkeyMcMac
Remove (un)registerModStorage
ad07599 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Sep 13, 2022
@TurkeyMcMac
Remove (un)registerModStorage
48d5661 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Sep 19, 2022
@TurkeyMcMac
Remove (un)registerModStorage
b58e819 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
TurkeyMcMac added a commit to TurkeyMcMac/minetest that referenced this pull request Sep 26, 2022
@TurkeyMcMac
Remove (un)registerModStorage
54d5014 
It is no longer necessary to keep just one object per mod, since
data is no longer stored in these objects. Now one can obtain
multiple distinct references with core.get_mod_storage, but this
will be changed by PR minetest#12572.

One can test like so:

    local a = core.get_mod_storage()
    local b = core.get_mod_storage()
    a:set_string("!", "?")
    assert(b:get("!") == "?")
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sfan5 sfan5 sfan5 approved these changes

@SmallJoker SmallJoker SmallJoker approved these changes

Assignees
No one assigned
Labels
Bugfix 🐛 PRs that fix a bug >= Two approvals ✅ ✅
Projects
None yet
Milestone
5.6.0
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@TurkeyMcMac @appgurueu @sfan5 @SmallJoker