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

consolidate and simplify passthroughs #1484

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

davidangb
Copy link
Contributor

@davidangb davidangb commented Nov 5, 2024

for discussion.

  • Consolidate multiple passthrough routes into streamingPassthrough
    • I'd like to mark passthrough as deprecated; perhaps wait until we remove some more usages of it
  • Consolidate multiple *ApiService route classes into a single passthrough-only class
    • Makes it easier to see routes at a glance.
    • Eventually, I suggest that all passthroughs exist in this single class, and the only routes left in other classes are non-passthroughs
  • Remove unit tests for passthrough-only routes. The streamingPassthrough directive has its own unit tests, so there's not much to test here.
    • this change feels a little squirrely. Should we add back in a unit test to confirm we are routing passthroughs to the correct underlying service?

Have you read CONTRIBUTING.md lately? If not, do that first.

I, the developer opening this PR, do solemnly pinky swear that:

  • I've followed the instructions if I've made any changes to the API, especially if they're breaking changes
  • I've updated the FISMA documentation if I've made any security-related changes, including auth, encryption, or auditing

In all cases:

  • Get two thumbsworth of review and PO signoff if necessary
  • Verify all tests go green
  • Squash and merge. Make sure your branch deletes; GitHub should do this for you.
  • Test this change deployed correctly and works on dev environment after deployment

@davidangb davidangb marked this pull request as ready for review November 13, 2024 15:53
@davidangb davidangb requested a review from a team as a code owner November 13, 2024 15:53
@davidangb davidangb requested review from calypsomatic and kevinmarete and removed request for a team November 13, 2024 15:53
Copy link
Contributor

@marctalbott marctalbott 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 a fan of this approach. Easier to add new downstream routes and non-passthrough routes are more obvious

Copy link

@kevinmarete kevinmarete left a comment

Choose a reason for hiding this comment

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

Nice, this simplifies things!

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.

4 participants