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

feat: created pared-down version of User object #2499

Merged
merged 2 commits into from
Sep 27, 2024
Merged

Conversation

bryanoltman
Copy link
Contributor

@bryanoltman bryanoltman commented Sep 27, 2024

Description

Renames our current User object to "FullUser" and creates a new User object with only id, email, and display name.

This is to ensure we don't accidentally leak any sensitive information when returning user data to a different user (for example, if user A receives a response that references users B, C, etc.)

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore
  • 🧪 Tests

Copy link

codecov bot commented Sep 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@felangel felangel left a comment

Choose a reason for hiding this comment

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

What’s the goal of this change? Where is User used? Also this is a breaking change to the protocol so we should probably bump the version etc if we want to proceed.

@bryanoltman
Copy link
Contributor Author

@felangel this is addressing the concern expressed in https://github.com/shorebirdtech/_shorebird/pull/848#discussion_r1777771115. Updated the PR description to explain better.

@bryanoltman bryanoltman merged commit 9c6d652 into main Sep 27, 2024
17 checks passed
@bryanoltman bryanoltman deleted the bo/full-user branch September 27, 2024 17:14
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.

2 participants