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

Update VCR gem #3583

Merged
merged 8 commits into from
Dec 20, 2019
Merged

Update VCR gem #3583

merged 8 commits into from
Dec 20, 2019

Conversation

johnpaulashenfelter
Copy link
Contributor

@johnpaulashenfelter johnpaulashenfelter commented Nov 22, 2019

Description of change

We are pretty far behind (5 v 3.0.3) but the upgrade seemed pretty seemless. All the specs still work so cassettes are running properly.

Testing done

Testing planned

Acceptance Criteria (Definition of Done)

Unique to this PR

Applies to all PRs

  • Appropriate logging
  • Swagger docs have been updated, if applicable
  • Provide link to originating GitHub issue, or connected to it via ZenHub
  • Does not contain any sensitive information (i.e. PII/credentials/internal URLs/etc., in logging, hardcoded, or in specs)
  • Provide which alerts would indicate a problem with this functionality (if applicable)

@va-vfs-bot va-vfs-bot temporarily deployed to jp/update-vcr/master November 22, 2019 18:25 Inactive
@johnpaulashenfelter johnpaulashenfelter requested review from a team and annaswims and removed request for a team November 22, 2019 18:58
@johnpaulashenfelter johnpaulashenfelter marked this pull request as ready for review November 22, 2019 18:59
@johnpaulashenfelter johnpaulashenfelter requested review from a team as code owners November 22, 2019 18:59
@kfrz
Copy link
Contributor

kfrz commented Nov 22, 2019

Two major versions in one go? No version pinning in Gemfile?

Could you provide some additional context, given there's no logic/test changes?

This approach to dependency upgrade seems a bit dubious to me - how can we be certain there aren't any significant breakages?

What features do we gain? I'm in general supportive of getting up-to-date for our libraries, just curious 😸

Copy link
Contributor

@LindseySaari LindseySaari left a comment

Choose a reason for hiding this comment

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

I'm curious as well as to what we gain from the major version upgrades and what has changed. Possibly include a link in the PR description 😃

@omgitsbillryan
Copy link
Contributor

Link to changelog

Copy pasted here for the lazy:

5.0.0 (May 27, 2019)
Full Changelog

[breaking] disabling webmock excon adapter due to issues
[breaking] change the compressed extension from gz to zz
[breaking] don't eject cassettes on UnhandledHTTPRequestError
[breaking] when logging the before_playback placeholder replacement, VCR would state "replacing with " which does not correctly represent what is actually happening, it's now semantically correct
[breaking] removing more ruby 1.8 weirdness, re: ordered hashes quirk
[patch] VCR.use_cassettes raises no implicit conversion of nil into Hash https://github.com/vcr/vcr/pull/730#issuecomment-454049764
faster JSON comparison
recompress_response option+hook
unignore_hosts option: remove hosts added to @ignored_hosts Set with ignore_hosts
support ruby 2.6 in test matrix
support ruby 2.5 in test matrix
support Typhoeus 1.1 in test matrix
updating repository meta files

4.0.0
Full Changelog

[Feature] Output non-matched headers on error
[Fix] Allow non-latin charaters in cassette filenames
[Breaking] Remove deprecated VCR::RSpec::Macros
[Breaking] Remove support for ruby 1.9.3
[Breaking] Remove support for Fakeweb

@omgitsbillryan
Copy link
Contributor

Might I recommend that you record (or re-record) a new cassette just as a test for added assurance that all is well. Once that's done it LGTM.

@kfrz
Copy link
Contributor

kfrz commented Nov 22, 2019

Thanks for the changelog link - looks pretty minimal in terms of risk! +1 to the "record a cassette" smoke test, then I'm happy to ✔️

@LindseySaari LindseySaari self-requested a review December 17, 2019 16:09
Copy link
Contributor

@LindseySaari LindseySaari left a comment

Choose a reason for hiding this comment

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

+1 on a new cassette recording. Could you link to the changelog in the PR description too (looks like bill did in a comment). After that, ✔️

@va-vfs-bot va-vfs-bot temporarily deployed to jp/update-vcr/master December 17, 2019 16:21 Inactive
@kfrz
Copy link
Contributor

kfrz commented Dec 20, 2019

Updated this PR with a re-recorded search spec, works like a charm.

Yes, the body response is now ASCII-binary-encoded, but that's actually how it should be. The readable JSON string that did exist was manually entered, by me & Harry when this service was created. It was mostly for reference/FE use but we shouldn't need to be looking at cassette contents directly IMO. We could write a custom serializer but I don't see the point.

@johnpaulashenfelter will leave up to you if you want to merge or not w/ the binary-encoded string.

@kfrz kfrz requested a review from LindseySaari December 20, 2019 05:03
Copy link
Contributor

@kfrz kfrz left a comment

Choose a reason for hiding this comment

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

LGTM. See comment above.

@kfrz kfrz mentioned this pull request Dec 20, 2019
6 tasks
@va-vfs-bot va-vfs-bot temporarily deployed to jp/update-vcr/master December 20, 2019 05:11 Inactive
@kfrz kfrz dismissed LindseySaari’s stale review December 20, 2019 18:49

VCR cassette updated

@va-vfs-bot va-vfs-bot temporarily deployed to jp/update-vcr/master December 20, 2019 19:06 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to jp/update-vcr/master December 20, 2019 19:13 Inactive
@kfrz kfrz merged commit 8851d2b into master Dec 20, 2019
@kfrz kfrz deleted the jp/update-vcr branch December 20, 2019 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
VSP VSP Contract
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants