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

Show segment hash in segmenteditor.getAll output to aid debugging. #16989

Closed
wants to merge 3 commits into from

Conversation

diosmosis
Copy link
Member

Description:

In case a user does not want to reveal a segment due to it having sensitive information, it can be hard to figure out exactly what the hash for a segment is (especially when there is an encoding or related problem). So adding it to the API output can be useful for debugging.

Review

  • Functional review done
  • Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
  • Security review done see checklist
  • Code review done
  • Tests were added if useful/possible
  • Reviewed for breaking changes
  • Developer changelog updated if needed
  • Documentation added if needed
  • Existing documentation updated if needed

Copy link
Member

@sgiehl sgiehl left a comment

Choose a reason for hiding this comment

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

Guess won't hurt to have that. Seems no tests are failing. Maybe might make sense to have a test for that API. Otherwise LGTM

@diosmosis
Copy link
Member Author

Added the test. also added the extra urlencode for the definition. Will wait until the other pr is merged before merging this one.

@@ -42,6 +42,27 @@ public function setUp(): void

}

public function test_getll_returnsCorrectHashes()
Copy link
Contributor

Choose a reason for hiding this comment

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

It has a typo

@flamisz
Copy link
Contributor

flamisz commented May 4, 2021

which is the other pr you are waiting for? maybe it's merged already now?

@sgiehl
Copy link
Member

sgiehl commented May 5, 2021

I guess this one might meanwhile be obsolete. The hash should already be included in the API response. ping @diosmosis

@diosmosis
Copy link
Member Author

Yes, unnecessary, closing this

@diosmosis diosmosis closed this May 5, 2021
@diosmosis diosmosis deleted the segment-hash-api-output branch May 5, 2021 16:11
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.

None yet

3 participants