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

HPCC-31028 Use cost_type internally for consistency #18154

Merged
merged 1 commit into from
Jan 11, 2024
Merged

HPCC-31028 Use cost_type internally for consistency #18154

merged 1 commit into from
Jan 11, 2024

Conversation

shamser
Copy link
Contributor

@shamser shamser commented Dec 18, 2023 •
edited
Loading

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@shamser shamser requested a review from jakesmith December 18, 2023 16:41
@github-actions GitHub Actions
Copy link

https://track.hpccsystems.com/browse/HPCC-31028
Jira updated

jakesmith
jakesmith reviewed Dec 20, 2023
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@shamser - looks good, 1 issue with getFileAccessCost

esp/services/ws_fs/ws_fsService.cpp
@@ -353,7 +353,7 @@ static void DeepAssign(IEspContext &context, IConstDFUWorkUnit *src, IEspDFUWork
if(secs > 0)
dest.setSecsLeft(secs);
dest.setPercentDone(prog->getPercentDone());
dest.setFileAccessCost(prog->getFileAccessCost());
dest.setFileAccessCost(cost_type2money(prog->getFileAccessCost()));
Copy link
Member

Choose a reason for hiding this comment

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

IConstDFUprogress::getFileAccessCost is still returning a double.

dali/base/dadfs.cpp Outdated
@@ -13454,14 +13454,14 @@ IPropertyTreeIterator *deserializeFileAttrIterator(MemoryBuffer& mb, unsigned nu
else
sizeDiskSize = file->getPropInt64(getDFUQResultFieldName(DFUQRForigsize), 0);
double sizeGB = sizeDiskSize / ((double)1024 * 1024 * 1024);
cost_type atRestCost = money2cost_type(calcFileAtRestCost(nodeGroup, sizeGB, fileAgeDays));
file->setPropInt64(getDFUQResultFieldName(DFUQRFatRestCost), atRestCost);
cost_type atRestCostType = calcFileAtRestCost(nodeGroup, sizeGB, fileAgeDays);
Copy link
Member

Choose a reason for hiding this comment

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

trivial: don't think this variable name needs/is helped by having suffix "Type", and similar below.

dali/dfu/dfuwu.cpp
{
CriticalBlock block(parent->crit);
queryRoot()->setPropReal("@fileAccessCost", fileAccessCost);
queryRoot()->setPropInt64("@fileAccessCost", fileAccessCost);
Copy link
Member

Choose a reason for hiding this comment

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

Relaed to comment in ws_fsService.cpp.
The corresponding get function in this class is (unchanged):

    double getFileAccessCost() const
    {
        CriticalBlock block(parent->crit);
        return queryRoot()->getPropInt64("@fileAccessCost");
    }

that looks like a pre-existing bug. It was set as a real, but retrieved as an int (then cast to a double on return).

@shamser shamser requested a review from jakesmith December 21, 2023 13:34
@shamser shamser changed the base branch from master to candidate-9.4.x December 22, 2023 11:55
@shamser
HPCC-31028 Use cost_type internally for consistency
a18be04 
Costs have been represented as double in some places in the code
and cost_type in other places.  The use of both double and
cost_type internally for costs has made the code more difficult
to understand and maintain.  It has lead to some bugs.

This commit makes all internal representation of cost in the code
as cost_type.  The cost_type is only converted to double when
returning costs externally via ESP services.

Signed-off-by: Shamser Ahmed <[email protected]>
jakesmith
jakesmith reviewed Jan 9, 2024
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@shamser - 1 minor comment, but looks good, please fix and squash.

dali/base/dadfs.cpp Outdated
@@ -191,18 +191,18 @@ static IPropertyTree *getCostPropTree(const char *cluster)
}
}

extern da_decl double calcFileAtRestCost(const char * cluster, double sizeGB, double fileAgeDays)
extern da_decl cost_type calcFileAtRestCost(const char * cluster, double sizeGB, double fileAgeDays)
{
Owned<const IPropertyTree> costPT = getCostPropTree(cluster);

if (costPT==nullptr)
return 0.0;
Copy link
Member

Choose a reason for hiding this comment

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

should be changed from returning a floating point number to an integer - i.e. return 0;

Copy link
Member

Choose a reason for hiding this comment

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

also on line 210 in calcFileAccessCost

@shamser shamser requested a review from jakesmith January 10, 2024 09:48
jakesmith
jakesmith approved these changes Jan 10, 2024
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@shamser - looks good

@ghalliday ghalliday merged commit 80acb3a into hpcc-systems:candidate-9.4.x Jan 11, 2024
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakesmith jakesmith jakesmith approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shamser @jakesmith @ghalliday