Enforce naming rules on indexes and collections #1531
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## 2-dev #1531 +/- ##
==========================================
+ Coverage 93.49% 93.52% +0.03%
==========================================
Files 98 98
Lines 6729 6749 +20
==========================================
+ Hits 6291 6312 +21
+ Misses 438 437 -1
Continue to review full report at Codecov.
|
Aschen
approved these changes
Nov 26, 2019
lib/services/elasticsearch.js
Outdated
| } | ||
|
|
||
| let valid = true; | ||
| const forbiddenChars = `\\/*?"<>| \t\r\n,#:${NAME_SEPARATOR}${PUBLIC_PREFIX}${INTERNAL_PREFIX}`; |
There was a problem hiding this comment.
(Nit): Can't we declare the forbidden chars once time only?
alexandrebouthinon
approved these changes
Nov 27, 2019
|
SonarQube analysis reported 3 issues Note: The following issues were found on lines that were not modified in the pull request. Because these issues can't be reported as line comments, they are summarized here:
|
Merged
scottinet
added a commit
that referenced
this pull request
Dec 6, 2019
# [2.0.1](https://github.com/kuzzleio/kuzzle/releases/tag/2.0.1) (2019-12-06) #### Bug fixes - [ [#1534](#1534) ] Configured server limit were not applied to some m* and deleteByQuery routes ([scottinet](https://github.com/scottinet)) - [ [#1539](#1539) ] Fix URL parsing w/ trailing slash & querystring ([scottinet](https://github.com/scottinet)) - [ [#1531](#1531) ] Enforce naming rules on indexes and collections ([scottinet](https://github.com/scottinet)) - [ [#1530](#1530) ] Rejects new API requests during a shutdown sequence ([scottinet](https://github.com/scottinet)) - [ [#1504](#1504) ] Do not delete a profile still assigned to users ([Yoann-Abbes](https://github.com/Yoann-Abbes)) #### Enhancements - [ [#1533](#1533) ] Add plugin version to server info ([Aschen](https://github.com/Aschen)) - [ [#1536](#1536) ] Prevent overloads caused by pre-funnel pipes ([scottinet](https://github.com/scottinet)) - [ [#1543](#1543) ] Use [email protected] ([scottinet](https://github.com/scottinet)) ---
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Enforce strict naming rules on indexes and collections. This has the following effects:
index:createandcollection:create)The enforced rules are a stricter version of the Elasticsearch naming rules, as Kuzzle adds a few restrictions of its own.
The documentation has also been updated with these naming rules.
Architecture
Naming rules have been implemented directly in the ES service, and propagated through the ClientAdapter class. I've made that choice because, to me, naming rules depend on the implemented storage service and therefore might change depending on it.
That way, if we use another storage service, it simply needs to implement the new
isIndexNameValidandisCollectionNameValid.This choice also explains why we have 1 dedicated function per object type (index & collection) even if this is useless with ES since we emulate collections with indexes. This paves the way for other storage engines allowing different structures and maybe different naming rules for indexes and collections.