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

fix(w3c trace context): consider traceparent format version ff invalid #426

Merged
merged 1 commit into from
May 20, 2023

Conversation

basti1302
Copy link
Contributor

This is a follow up to commit
f283a4b
which added some tests for parsing newer versions. One of the tests used format version "ff", which the W3C trace context specification explicitly defines as invalid. This commit fixes that test and also the regex used for parsing the traceparent header, so that a header with version ff will be rejected as invalid.

@github-actions
Copy link

@basti1302 the signed-off-by was not found in the following 1 commits:

  • 8a6c335: fix(w3c trace context): consider traceparent format version ff invalid

📝 What should I do to fix it?

All proposed commits should include a sign-off in their messages, ideally at the end.

❔ Why it is required

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:

By making a contribution to this project, I certify that:

a. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

b. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

c. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

d. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

This is my commit message

Signed-off-by: Random Developer <randomdeveloper@example.com>

Git even has a -s command line option to append this automatically to your commit message:

$ git commit -s -m 'This is my commit message'

@basti1302
Copy link
Contributor Author

basti1302 commented May 19, 2023

Sorry @instana/eng-python to bug you again with W3C trace context stuff. I temporarily had forgotten that version ff is explicitly forbidden by the spec and unfortunately used exactly that invalid version in the test I added a few days ago :-/

Side note: I think this particular change is somewhat academic, there is no need to create a release just for this.

@basti1302 basti1302 requested a review from a team May 19, 2023 15:22
This is a follow up to commit
f283a4b
which added some tests for parsing newer versions. One of the tests used
format version "ff", which the W3C trace context specification
explicitly defines as invalid. This commit fixes that test and also the
regex used for parsing the traceparent header, so that a header with
version ff will be rejected as invalid.

Signed-off-by: Bastian Krol <bastian.krol@ibm.com>
@basti1302 basti1302 force-pushed the fix-invalid-version-ff branch from 8a6c335 to 75492ee Compare May 19, 2023 15:22
Copy link
Collaborator

@Ferenc- Ferenc- left a comment

Choose a reason for hiding this comment

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

Approved

@Ferenc- Ferenc- merged commit b8c5179 into master May 20, 2023
@Ferenc- Ferenc- deleted the fix-invalid-version-ff branch May 20, 2023 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants