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

Make sure the resource system respects the liveupdate.enabled flag #8189

Merged
merged 1 commit into from Oct 30, 2023
Merged

Make sure the resource system respects the liveupdate.enabled flag #8189

merged 1 commit into from Oct 30, 2023

Conversation

JCash
Copy link
Contributor

@JCash JCash commented Oct 29, 2023 •
edited

This fixes an issue where the liveupdate system wasn't fully disabled when the project setting was set to false (liveupdate.enabled=0)

PR checklist

  • Code
    • Add engine and/or editor unit tests.
    • New and changed code follows the overall code style of existing code
    • Add comments where needed
  • Documentation
    • Make sure that API documentation is updated in code comments
    • Make sure that manuals are updated (in github.com/defold/doc)
  • Prepare pull request and affected issue for automatic release notes generator
    • Pull request - Write a message that explains what this pull request does. What was the problem? How was it solved? What are the changes to APIs or the new APIs introduced? This message will be used in the generated release notes. Make sure it is well written and understandable for a user of Defold.
    • Pull request - Write a pull request title that in a sentence summarises what the pull request does. Do not include "Issue-1234 ..." in the title. This text will be used in the generated release notes.
    • Pull request - Link the pull request to the issue(s) it is closing. Use on of the approved closing keywords.
    • Affected issue - Assign the issue to a project. Do not assign the pull request to a project if there is an issue which the pull request closes.
    • Affected issue - Assign the "breaking change" label to the issue if introducing a breaking change.
    • Affected issue - Assign the "skip release notes" is the issue should not be included in the generated release notes.

Example of a well written PR description:

  1. Start with the user facing changes. This will end up in the release notes.
  2. Add one of the GitHub approved closing keywords
  3. Optionally also add the technical changes made. This is information that might help the reviewer. It will not show up in the release notes. Technical changes are identified by a line starting with one of these:
    1. ### Technical changes
    2. Technical changes:
    3. Technical notes:
There was a anomaly in the carbon chroniton propeller, introduced in version 8.10.2. This fix will make sure to reset the phaser collector on application startup.

Fixes #1234

### Technical changes
* Pay special attention to line 23 of phaser_collector.clj as it contains some interesting optimizations
* The propeller code was not taking into account a negative phase.

@JCash JCash requested a review from britzl October 29, 2023 09:43
britzl
britzl reviewed Oct 29, 2023
View reviewed changes
engine/liveupdate/src/liveupdate.cpp
@@ -479,6 +487,9 @@ namespace dmLiveUpdate

Result StoreResourceAsync(const char* expected_digest, const uint32_t expected_digest_length, const dmResourceArchive::LiveUpdateResource* resource, void (*callback)(bool, void*), void* callback_data)
{
if (!IsLiveupdateEnabled())
Copy link
Contributor

Choose a reason for hiding this comment

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

Q: I know that we are mixing one-line conditionals with and without curly brackets, but which is the style to use in the Defold code base? I noticed that you removed curly brackets in the code you touched a bit further down?

Copy link
Contributor Author

@JCash JCash Oct 30, 2023 •
edited

Choose a reason for hiding this comment

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

I think it's depending on context.
In general, I want less "fluff" that makes it harder to read (for me)

I personally think that a scope (curly braces) isn't needed when all we do is return a value.

Assignments may be different.
And often I leave the braces if I for instance have debugged the scope using a printf or similar.

@JCash JCash merged commit 6e72765 into dev Oct 30, 2023
22 checks passed
@JCash JCash deleted the liveupdate-disable-fix branch October 30, 2023 08:19
ultimanidev pushed a commit to ultimanidev/defold that referenced this pull request Nov 8, 2023
@JCash @ultimanidev
Make sure the resource system respects the liveupdate.enabled flag (d…
ada1e3d 
…efold#8189)
ultimanidev pushed a commit to ultimanidev/defold that referenced this pull request Nov 8, 2023
@JCash @ultimanidev
Make sure the resource system respects the liveupdate.enabled flag (d…
3636089 
…efold#8189)
AGulev
AGulev reviewed Nov 18, 2023
View reviewed changes
engine/liveupdate/src/liveupdate.cpp
@@ -116,6 +117,7 @@ namespace dmLiveUpdate
dmResource::HFactory m_ResourceFactory; // Resource system factory
dmResourceProvider::HArchive m_LiveupdateArchive;
dmResource::HManifest m_LiveupdateArchiveManifest;
bool m_IsEnabled;
Copy link
Contributor

Choose a reason for hiding this comment

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

But we don't set it anywhere and it's false by default

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AGulev AGulev AGulev left review comments

@britzl britzl britzl approved these changes

Assignees
No one assigned
Labels
None yet
Projects
No open projects
1.6.2
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@JCash @britzl @AGulev