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.

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

HPCC-32982 Add alternative span scopes & OwnedSpanScope refactoring #19342

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

jpmcmu
Copy link
Contributor

@jpmcmu jpmcmu commented Dec 5, 2024

  • Added ActiveSpanScope to track only current active span
  • Renamed existing OwnedSpanScope to OwnedActiveSpanScope
  • Added OwnedSpanScope to control only span lifetime

Signed-off-by: James McMullan [email protected]

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:

Copy link

github-actions bot commented Dec 5, 2024

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32982

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

@jpmcmu jpmcmu closed this Dec 5, 2024
@jpmcmu jpmcmu reopened this Dec 5, 2024
Copy link

github-actions bot commented Dec 5, 2024

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32982

Jirabot Action Result:
Workflow Transition To: Merge Pending

@jpmcmu jpmcmu requested a review from ghalliday December 5, 2024 19:53
@@ -159,11 +159,70 @@ interface ISpan : extends IInterface
virtual const char* queryLocalId() const = 0;
};

//------------------------------------------------------------------------------
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I felt ActiveSpanScope and OwnedActiveSpanScope better explained what these classes are doing but I am certainly open to changing the names.

Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@jpmcmu looks good. A few minor comments.

// involving multiple threads, time sliced work, etc ActiveSpanScope should be used.
//------------------------------------------------------------------------------

class ActiveSpanScope
Copy link
Member

Choose a reason for hiding this comment

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

Add a comment that the span must be guaranteed to be owned by another class while this executes.

// involving multiple threads, time sliced work, etc ActiveSpanScope should be used.
//------------------------------------------------------------------------------

class ActiveSpanScope
Copy link
Member

Choose a reason for hiding this comment

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

needs class jlib_decl, otherwise you will get link failures when symbols are not exported.

Owned<ISpan> span;
ISpan * prevSpan = nullptr;
};

class jlib_decl OwnedSpanScope
Copy link
Member

Choose a reason for hiding this comment

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

Suggest reordering this before OwnedActiveSpanScope, so there is a logical progression of functionality within the classes.

Copy link
Member

Choose a reason for hiding this comment

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

I almost wonder if OwnedSpanLifetime would be a better name - since it isn't really associated with a scope.

ISpan* current = queryThreadedActiveSpan();
if (current != span)
{
const char* currSpanID = current != nullptr ? current->querySpanId() : "null";
Copy link
Member

Choose a reason for hiding this comment

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

minor: queryThreadedActiveSpan() can never be null, but CNullSpan::querySpanId() should be changed to return "null".

// OwnedActiveSpanScope controls the lifetime of its ISpan while ActiveSpanScope
// does not. In cases where the ISpan will be used from a single thread and within
// a single scope OwnedActiveSpanScope should be used. For more complicated scenarios,
// involving multiple threads, time sliced work, etc ActiveSpanScope should be used.
Copy link
Member

Choose a reason for hiding this comment

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

Add an extra comment? (Do you agree with it?)

involving multiple threads, time sliced work, ...

a OwnedSpanScope should be stored as a member in a class, and an ActiveSpanScope used to associate that span with each processing thread.

@jpmcmu jpmcmu requested a review from ghalliday December 11, 2024 20:22
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@jpmcmu that looks good. This will be a really helpful distinction. I think there is one place in esp that should be revisited now these classes exist - I'll create a jira to cover that.
Please squash and I will merge.

…toring

- Added ActiveSpanScope to track only current active span
- Renamed existing OwnedSpanScope to OwnedActiveSpanScope
- Added OwnedSpanScope to control only span lifetime

Signed-off-by: James McMullan [email protected]
@jpmcmu
Copy link
Contributor Author

jpmcmu commented Dec 12, 2024

@ghalliday squashed

@jpmcmu jpmcmu requested a review from ghalliday December 13, 2024 14:13
@ghalliday ghalliday merged commit 0bb5480 into hpcc-systems:candidate-9.8.x Dec 16, 2024
48 of 49 checks passed
Copy link

Jirabot Action Result:
Added fix version: 9.8.46
Workflow Transition: 'Resolve issue'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants