feat(mcm): add methods for multi cluster management #643
Conversation
This file contains hidden or 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
Also have added the option to add `headers` to `_jsonRequest` and changed it into an object-accepting function for "future-proofing" it
vvo
suggested changes
Dec 13, 2017
src/AlgoliaSearch.js
Outdated
| * @example | ||
| * client.getTopUserID(); | ||
| */ | ||
| AlgoliaSearch.prototype.getTopUserID = function(_, callback) { |
There was a problem hiding this comment.
why not just func(callback)? why force to do func(null, cb)?
src/AlgoliaSearch.js
Outdated
| return this._jsonRequest({ | ||
| method: 'GET', | ||
| url: '/1/clusters/mapping/top', | ||
| hostType: 'write', |
src/AlgoliaSearch.js
Outdated
| return this._jsonRequest({ | ||
| method: 'GET', | ||
| url: '/1/clusters/mapping/' + data.userID, | ||
| hostType: 'write', |
src/AlgoliaSearch.js
Outdated
| * @example | ||
| * client.listClusters(); | ||
| */ | ||
| AlgoliaSearch.prototype.listClusters = function(_, callback) { |
There was a problem hiding this comment.
because this way there's no surprise if this method will later need options 🤔
There was a problem hiding this comment.
Given the state of this JS client I think it's best to then do a non-breaking change evolution (from no params to params).
So we must support:
listClusters() => promise
listClusters(callback)
Calling listClusters(null, callback) only in case we add new features is too magic/uncommon
src/AlgoliaSearch.js
Outdated
| method: 'GET', | ||
| url: '/1/clusters/mapping', | ||
| body: data, | ||
| hostType: 'write', |
src/AlgoliaSearch.js
Outdated
| return this._jsonRequest({ | ||
| method: 'GET', | ||
| url: '/1/clusters', | ||
| hostType: 'write', |
There was a problem hiding this comment.
What decides which is read and which is write?
There was a problem hiding this comment.
read is anything that is not modifying the index
Closed
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.
Summary
Adding the MCM methods
Result
Also have added the option to add
headersto_jsonRequestand changed it into an object-accepting function for "future-proofing" it