Skip to content

Release notes should contain index changes #6464

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

Closed
mtrezza opened this issue Mar 5, 2020 · 2 comments · Fixed by #6469
Closed

Release notes should contain index changes #6464

mtrezza opened this issue Mar 5, 2020 · 2 comments · Fixed by #6469

Comments

@mtrezza
Copy link
Member

mtrezza commented Mar 5, 2020

Is your feature request related to a problem? Please describe.
Parse Server 4.0.0 mentions this breaking change:

FIX: BREAKING CHANGE Prevent new usernames or emails that clash with existing users' email or username if it only differs by case. For example, don't allow a new user with the name 'Jane' if we already have a user 'jane'.

However, it is not clear that the fix creates a new index in the DB.

Creating indices in a mongoDB replica set is a delicate action, because:

  • Other DB queries can depend on existing indices
  • Index creation causes additional DB load (affects resources and oplog)
  • For large collections it can make sense to create an index in a rolling node fashion

Describe the solution you'd like
Any (future) DB index modifications should be clearly mentioned in Parse Server release notes, with the same importance as a breaking change.

Additional context

@mtrezza mtrezza changed the title Release notes / Unable to create case insensitive email index Release notes should contain index changes Mar 5, 2020
@TomWFox
Copy link
Contributor

TomWFox commented Mar 5, 2020

@mtrezza we've updated the changelog and release notes accordingly, hopefully its satisfactory.

It could be a good idea to have a clear release doc with all the steps, chagelog and release notes formatting and notes like this.

@mtrezza
Copy link
Member Author

mtrezza commented Mar 6, 2020

Great! I agree, a release template would make sure that for example index changes are mentioned.

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 a pull request may close this issue.

2 participants