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-29544 Remove configuration of the global-id header field name #17790

Merged
merged 1 commit into from
Sep 27, 2023
Merged

HPCC-29544 Remove configuration of the global-id header field name #17790

merged 1 commit into from
Sep 27, 2023

Conversation

ghalliday
Copy link
Member

@ghalliday ghalliday commented Sep 19, 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:

@ghalliday ghalliday requested a review from afishbeck September 19, 2023 16:22
@ghalliday
Copy link
Member Author

@afishbeck for discussion. The idea is to recognise hpcc-global-id and global-id, but only ever forward it as global-id. It would definitely be a red book item.

@ghalliday
Copy link
Member Author

@afishbeck the second commit makes me think that this is never overridden - since the soapcall did not support hpcc-global-id or any other user defined header name.

@github-actions
Copy link

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

@ghalliday ghalliday requested a review from rpastrana September 22, 2023 09:04
@ghalliday
Copy link
Member Author

@rpastrana I fixed a couple of issues with the unit tests and jtrace

  • createProperties needs to be case-insensitive
  • using strcmp in the unit tests mean they core if the pointer is null

Other change is to add legacy header support to jtrace.

afishbeck
afishbeck reviewed Sep 26, 2023
View reviewed changes
Copy link
Member

@afishbeck afishbeck left a comment

Choose a reason for hiding this comment

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

@ghalliday one comment, but once acknowledged I'm happy to approve as is.

common/thorhelper/thorsoapcall.cpp Show resolved Hide resolved
rpastrana
rpastrana reviewed Sep 26, 2023
View reviewed changes
Copy link
Member

@rpastrana rpastrana left a comment

Choose a reason for hiding this comment

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

@ghalliday a few minor comments/questions.

esp/services/ws_ecl/ws_ecl_service.hpp Outdated
if (!getHttpIdHeader(request, "Global-Id", value, nameused))
getHttpIdHeader(request, "HPCC-Global-Id", value, nameused);
}
if (!getHttpIdHeader(request, "Global-Id", value))
Copy link
Member

Choose a reason for hiding this comment

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

why not kGlobalIdHttpHeaderName and/or kLegacyGlobalIdHttpHeaderName?

Copy link
Member Author

Choose a reason for hiding this comment

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

Because they didn't exist when this code was written. I will update to use them

esp/services/ws_ecl/ws_ecl_service.hpp Outdated
if (!getHttpIdHeader(request, "Caller-Id", value, nameused))
getHttpIdHeader(request, "HPCC-Caller-Id", value, nameused);
}
if (!getHttpIdHeader(request, "Caller-Id", value))
Copy link
Member

Choose a reason for hiding this comment

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

same as above

helm/hpcc/values.schema.json Outdated
@@ -1708,12 +1708,12 @@
"httpCallerIdHeader": {
"type": "string",
"default": "HPCC-Caller-Id",
"description": "HTTP Header field to use for sending and receiving CallerId"
"description": "HTTP Header field to use for sending and receiving CallerId (deprecated and ignored)"
Copy link
Member

Choose a reason for hiding this comment

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

If removed from the schema, it will alert users it has been deprecated, as-is, it will pass through and will be silently ignored.

roxie/ccd/ccdprotocol.cpp Outdated
{
const char *id = queryRequestIdHeader(httpHelper, logctx.queryGlobalIdHttpHeaderName(), headerused);
const char *id = httpHelper.queryRequestHeader("Global-Id");
Copy link
Member

Choose a reason for hiding this comment

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

kGlobalIdHttpHeaderName

roxie/ccd/ccdprotocol.cpp Outdated
if (!id || !*id)
id = queryRequestIdHeader(httpHelper, "HPCC-Global-Id", headerused);
}
id = httpHelper.queryRequestHeader("HPCC-Global-Id"); // Backward compatibility - passed on as global-id
Copy link
Member

Choose a reason for hiding this comment

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

kLegacyGlobalIdHttpHeaderName

roxie/ccd/ccdprotocol.cpp Outdated
{
const char *id = queryRequestIdHeader(httpHelper, logctx.queryCallerIdHttpHeaderName(), headerused);
const char *id = httpHelper.queryRequestHeader("Caller-Id");
Copy link
Member

Choose a reason for hiding this comment

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

I'm sure there's a good reason we're not using the definition from jtrace.hpp, but pointing it out in case we want/can avoid all these literals.

Copy link
Member Author

Choose a reason for hiding this comment

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

as above - the reason was those definitions didn't exist.

@ghalliday
Copy link
Member Author

@afishbeck @rpastrana rebased and changes from previous review squashed into a single commit. New commit contains changes following review.

afishbeck
afishbeck approved these changes Sep 27, 2023
View reviewed changes
Copy link
Member

@afishbeck afishbeck left a comment

Choose a reason for hiding this comment

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

@ghalliday looks good.

rpastrana
rpastrana approved these changes Sep 27, 2023
View reviewed changes
Copy link
Member

@rpastrana rpastrana left a comment

Choose a reason for hiding this comment

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

@ghalliday looks good.

@ghalliday ghalliday merged commit 7800de0 into hpcc-systems:candidate-9.4.x Sep 27, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpastrana rpastrana rpastrana approved these changes

@afishbeck afishbeck afishbeck 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
@ghalliday @afishbeck @rpastrana