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-31349 Change Path property for all cookies #18479

Closed
wants to merge 1 commit into from
Closed

HPCC-31349 Change Path property for all cookies #18479

wants to merge 1 commit into from

Conversation

jeclrsg
Copy link
Contributor

@jeclrsg jeclrsg commented Apr 2, 2024

Set Path for all cookies to "/" (the root of the domain) so that all cookies returned by ESP are scoped for the entire domain, rather than sometimes being "/" and sometimes being "/esp/files".

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:

@jeclrsg
HPCC-31349 Change Path property for all cookies
a77f8c6 
Set Path for all cookies to "/" (the root of the domain) so that all
cookies returned by ESP are scoped for the entire domain, rather than
sometimes being "/" and sometimes being "/esp/files".

Signed-off-by: Jeremy Clements <[email protected]>
@jeclrsg jeclrsg requested review from ghalliday and wangkx April 2, 2024 14:42
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 2, 2024

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

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

wangkx
wangkx reviewed Apr 3, 2024
View reviewed changes
Copy link
Member

@wangkx wangkx left a comment

Choose a reason for hiding this comment

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

@jeclrsg please see my comment.

esp/bindings/http/platform/httptransport.cpp
@@ -1565,11 +1565,10 @@ void CHttpRequest::parseCookieHeader(char* cookiestr)
if(name.charAt(0) != '$')
{
cookie = new CEspCookie(name.str(), value.str());
cookie->setPath("/");
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure whether this will change anything. The Path has been set to '/' when new a CEspCookie (

HPCC-Platform/esp/platform/espsession.ipp

Line 57 in e28c39e

m_path.set("/");
).

esp/bindings/http/platform/httptransport.cpp
cookie->setVersion(version);
m_cookies.append(*cookie);
}
else if(stricmp(name.str(), "$Path") == 0 && cookie != NULL)
cookie->setPath(value.str());
Copy link
Member

Choose a reason for hiding this comment

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

Not sure whether it is safe or not, The existing code uses the Path in the appendToRequestHeader() and appendToResponseHeader(). What if a third party ESP client needs it?

@jeclrsg jeclrsg requested a review from GordonSmith April 9, 2024 14:40
@ghalliday
Copy link
Member

@jeclrsg what is the status of this PR? It is still marked as a draft. Should it be closed?

@jeclrsg jeclrsg closed this Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wangkx wangkx wangkx left review comments

@ghalliday ghalliday Awaiting requested review from ghalliday

@GordonSmith GordonSmith Awaiting requested review from GordonSmith

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
@jeclrsg @ghalliday @wangkx