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

Allow symbols in breadcrumb meta data #563

Merged
merged 2 commits into from
Aug 27, 2019

Conversation

tomlongridge
Copy link
Contributor

@tomlongridge tomlongridge commented Aug 23, 2019

Goal

Complex types are currently disallowed as values of metadata on breadcrumbs, however Symbols can be allowed as they will serialise to string without issue.

Changeset

Changed

  • validator.rb - add Symbol type to list of allowed types

Tests

  • Added symbol as part of existing validator_spec.rb test

Review

For the submitter, initial self-review:

  • Commented on code changes inline explain the reasoning behind the approach
  • Reviewed the test cases added for completeness and possible points for discussion
  • A changelog entry was added for the goal of this pull request
  • Check the scope of the changeset - is everything in the diff required for the pull request?
  • This pull request is ready for:
    • Initial review of the intended approach, not yet feature complete
    • Structural review of the classes, functions, and properties modified
    • Final review

For the pull request reviewer(s), this changeset has been reviewed for:

  • Consistency across platforms for structures or concepts added or modified
  • Consistency between the changeset and the goal stated above
  • Internal consistency with the rest of the library - is there any overlap between existing interfaces and any which have been added?
  • Usage friction - is the proposed change in usage cumbersome or complicated?
  • Performance and complexity - are there any cases of unexpected O(n^3) when iterating, recursing, flat mapping, etc?
  • Concurrency concerns - if components are accessed asynchronously, what issues will arise
  • Thoroughness of added tests and any missing edge cases
  • Idiomatic use of the language

@tomlongridge tomlongridge marked this pull request as ready for review August 23, 2019 15:30
@tomlongridge
Copy link
Contributor Author

Reimplemented the change from #561 with tests and changelog.

@directionless
Copy link
Contributor

This would fix #539

Copy link
Contributor

@tobyhs tobyhs left a comment

Choose a reason for hiding this comment

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

lgtm

@directionless
Copy link
Contributor

Hi @tomlongridge! I wanted to thank you for picking up my patch and adding in tests and a changelog. But, I did want to mention that it felt a bit off in etiquette. By closing my PR and pulling the diff here, I don't get credit for the work. It's a small thing, but it's one of the things that keeps me involved with open source.

I find that a better process is to ask the PR author to do those things (or ask for write permissions on their branch and do it for them with their permission).

There are additional technical solutions, like cherry-picking and co-authored PRs.

directionless and others added 2 commits August 27, 2019 09:42
Validate Symbol as an allowed type to breadcrumbs. I can't tell if this will have break something else, I can't trace everywhere it's used. 

Fixes #539
@tomlongridge tomlongridge force-pushed the tom/allow-symbols-in-breadcrumbs branch from 4cf5aa9 to c1fde6c Compare August 27, 2019 08:55
@tomlongridge
Copy link
Contributor Author

@directionless - my apologies, you're right. I've now cherry-picked your commit into this PR.

@tomlongridge tomlongridge merged commit 05f5571 into next Aug 27, 2019
@tomlongridge tomlongridge deleted the tom/allow-symbols-in-breadcrumbs branch August 27, 2019 09:34
@directionless
Copy link
Contributor

@tomlongridge Thank you! I appreciate it

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.

3 participants