RefugeRestrooms / refugerestrooms

REFUGE restrooms indexes and maps safe restroom locations for trans, intersex, and gender nonconforming individuals.
http://www.refugerestrooms.org
GNU Affero General Public License v3.0
891 stars 263 forks source link

Update some dependencies #597

Closed DeeDeeG closed 4 years ago

DeeDeeG commented 4 years ago

Context

Summary of Changes

Checklist

DeeDeeG commented 4 years ago

CI is borked for an unrelated reason.

Manually tested locally in Docker. Looked fine to me.

DeeDeeG commented 4 years ago

The npm swagger package is in a maintenance lull, so it has gotten a bit out of date since the latest release.

Our options for updating swagger are to use an updated version from the project's git tree (master branch is much more up-to-date in terms of its dependencies when compared to the latest release, 0.7.5)... Or to use a more up-to-date fork. I have made some pull requests at the following fork in particular, to make its dependencies more up-to-date: multivacplatform/swagger-node.

Likewise, I made a pull request (https://github.com/swagger-api/swagger-node/pull/591) against the upstream swagger repo to improve its dependency situation, and because of the way GitHub works, that commit is technically available as part of the upstream repo's git tree... And we can use the commit from my pull request in our package.json if we want to. (I mention this somewhat odd option, since it was the apparent best option when I opened this Pull request, and it's what I have put in the commits at the moment for this PR.)

In plain English: It might be neater just to depend on (an exact version of) the fork I mentioned above, multivacplatform/swagger-node. Its only purpose so far has been to make the repo's CI tests reliably pass, and then bump the dependencies so they stay up-to-date. It's fairly purpose-built for what I'd look for in updating swagger. I might want to switch to that in the future, since it's less janky (in my view) than depending on a git commit. Only going with the git commit from my PR as it seems the less-radical departure, and seeing as I haven't gotten any feedback on this PR yet.

DeeDeeG commented 4 years ago

Planning to merge today if there are no conflicts with the other two PRs.