[CCR] Edit follower index #28600

sebelga · 2019-01-11T17:56:33Z

This PR adds the possibility to edit a follower index. It adds an action in the context menu of the table list.

For now, ES does not provide an API to read the advanced settings of a follower index, but they are working on one and we'll be able to populate the fields with the values.

INFO The base branch will be changed to feature/ccr once #28267 is merged.

elasticmachine · 2019-01-11T17:56:46Z

Pinging @elastic/es-ui

elasticmachine · 2019-01-11T21:00:37Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-01-12T18:24:40Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-01-14T09:16:05Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-01-14T17:37:39Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

cjcenizal

Tested locally, and everything seems to work as expected!

I had some suggestions for ways I think we can make the code clearer, but nothing critical.

In terms of the UI, I think the "Not found" state could be improved:

Instead of using a callout, could we use the same pattern as Remote Clusters? I think the call out means that something went wrong, but in this case there wasn't a mistake or problem, we're just telling the user that the thing they expected to be there, wasn't.

Instead of using the primary button, could we use EuiButtonEmpty with an left-facing arrow icon, and align it to the left, and change the copy to indicate that we're going back in the nav hierarchy? "View" sounds like we're going to jump somewhere else, possibly to another app.

<EuiButtonEmpty
  {...routing.getRouterLinkProps('/follower_indices')}
  iconType="arrowLeft"
  flush="left"
>
  <FormattedMessage
    id="xpack.crossClusterReplication.followerIndexEditForm.viewFollowerIndicesButtonLabel"
    defaultMessage="Back to follower indices"
  />
</EuiButtonEmpty>

jen-huang · 2019-01-18T21:17:23Z

x-pack/plugins/cross_cluster_replication/public/app/components/follower_index_form.js

-          disabled: !isConnected,
-          'data-test-subj': `option-${name}`
-        }));
+        const remoteClustersOptions = this.props.remoteClusters


this style was placed back after merging

cjcenizal · 2019-01-16T00:42:06Z

...ins/cross_cluster_replication/public/app/sections/follower_index_edit/follower_index_edit.js

+    componentDidUpdate(prevProps, prevState) {
+      const { followerIndex, getFollowerIndex } = this.props;
+      if (!followerIndex && prevState.lastFollowerIndexId !== this.state.lastFollowerIndexId) {
+        // Fetch the auto-follow pattern on the server


Typo: auto-follow pattern -> follower index

cjcenizal · 2019-01-16T00:44:26Z

...ins/cross_cluster_replication/public/app/sections/follower_index_edit/follower_index_edit.js

+
+    componentDidUpdate(prevProps, prevState) {
+      const { followerIndex, getFollowerIndex } = this.props;
+      if (!followerIndex && prevState.lastFollowerIndexId !== this.state.lastFollowerIndexId) {


I understand that this code guards against reloading an index that's already been loaded, but when will this scenario occur? If we call getFollowerIndex(this.state.lastFollowerIndexId) within componentDidMount will that remove the need for this check and for state.lastFollowerId?

cjcenizal · 2019-01-16T00:48:19Z

...ins/cross_cluster_replication/public/app/sections/follower_index_edit/follower_index_edit.js

+    }
+
+    saveFollowerIndex = (name, followerIndex) => {
+      this.inflightPayload = { name, followerIndex };


inflightPayload seems like a misleading name, since the payload isn't in flight yet. How about changing this to stagedFollowerIndex, saveableFollowerIndex, or followerIndexToSave?

cjcenizal · 2019-01-16T00:52:07Z

...ins/cross_cluster_replication/public/app/sections/follower_index_edit/follower_index_edit.js

+      const { followerIndexId, intl } = this.props;
+      const title = intl.formatMessage({
+        id: 'xpack.crossClusterReplication.followerIndexEditForm.confirmModal.title',
+        defaultMessage: 'Update follower index \'{id}\'',


I think this should be phrased as a question, per the EUI docs.

cjcenizal · 2019-01-16T00:53:56Z

...ins/cross_cluster_replication/public/app/sections/follower_index_edit/follower_index_edit.js

+              <EuiIcon type="alert" color="danger" />{' '}
+              <FormattedMessage
+                id="xpack.crossClusterReplication.followerIndexEditForm.confirmModal.description"
+                defaultMessage="To update the follower index, it will first be paused and then resumed."


I think it makes sense to give the user information, but maybe we need to provide more so that the user feels in control of this situation.

Is there the potential for a problem, e.g. the resume request could fail, leaving the follower index in a paused state? In that case we could say something like, "To update the follower index, it will first be paused and then resumed. If the update fails, you may need to manually resume the follower index."

cjcenizal · 2019-01-16T01:22:25Z

x-pack/plugins/cross_cluster_replication/public/app/services/routing.js

@@ -84,8 +84,10 @@ class Routing {
    return encodeURI(`#${BASE_PATH}/auto_follow_patterns${section}/${encodeURIComponent(name)}`);
  };

-  getFollowerIndexPath = (name, section = '/edit') => {
-    return encodeURI(`#${BASE_PATH}/follower_indices${section}/${encodeURIComponent(name)}`);
+  getFollowerIndexPath = (name, section = '/edit', withBase = true) => {


How about rewriting this to be goToEditFollowerIndexPath to make it a bit more convenient?

goToEditFollowerIndex = (name) => { const uri = encodeURI(`#${BASE_PATH}/follower_indices/edit/${encodeURIComponent(name)}`); this.navigate(uri); };

just returning a string is more flexible for using the uri in other contexts, like href

cjcenizal · 2019-01-16T01:34:49Z

x-pack/plugins/cross_cluster_replication/public/app/store/actions/follower_index.js

    handler: async () => (
      await getFollowerIndexRequest(id)
    )
  });

-export const saveFollowerIndex = (name, followerIndex) => (
+export const saveFollowerIndex = (name, followerIndex, isUpdating) => (


I like how we're unifying the behavior of the create and update actions -- that's really nice for maintainability! I think there's a way we can simplify both the interface and implementation.

In the past I've found that conditional flags like isUpdating tend to bloat the function signature, make the call sites more difficult to follow, and also add complexity to the implementation in the form of with parallel branches split across multiple conditions.

I think we can simplify the code and make it clearer by exporting separate functions for create and update, and extracting the common logic into an internal function. Does this seem like an improvement to you?

const saveFollowerIndex = (name, followerIndex, handler, successMessage) => ( sendApiRequest({ label: t.FOLLOWER_INDEX_CREATE, status: API_STATUS.SAVING, scope: `${scope}-save`, handler, onSuccess() { toastNotifications.addSuccess(successMessage); routing.navigate(`/follower_indices`, undefined, { pattern: encodeURIComponent(name), }); }, }) ); export const createFollowerIndex = (name, followerIndex) => ( const handler = async () => { return await createFollowerIndexRequest({ name, ...followerIndex }); }; const successMessage = i18n.translate('xpack.crossClusterReplication.followerIndex.addAction.successNotificationTitle', { defaultMessage: `Added follower index '{name}'`, values: { name }, }); saveFollowerIndex(name, followerIndex, handler, successMessage); ); export const updateFollowerIndex = (name, followerIndex) => ( const handler = async () => { return await updateFollowerIndexRequest(name, followerIndex); }; const successMessage = i18n.translate('xpack.crossClusterReplication.followerIndex.updateAction.successNotificationTitle', { defaultMessage: `Follower index '{name}' updated successfully`, values: { name }, }); saveFollowerIndex(name, followerIndex, handler, successMessage); );

I am deferring this for now since both follower index and auto follow pattern actions perform create and update with one save method, and I don't want to introduce any regressions this late 😄

cjcenizal · 2019-01-16T01:37:59Z

x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index.js

+      try {
+        /**
+         * We need to first pause the follower and then resume it passing the advanced settings
+         */


Really minor nit, but my OCD kicks in when we mix our comment styles. 😅 Could we stick with // for inline comments?

cjcenizal · 2019-01-16T01:42:20Z

x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index.js

+         * We need to first pause the follower and then resume it passing the advanced settings
+         */
+        // Pause follower
+        await callWithRequest('ccr.pauseFollowerIndex', { id: _id });


Would it make sense to wrap the pause and resume requests in individual try/catches, and then respond with errors that provides more insight into what happened? For example, if the pause fails, we could add a special code that will allow the UI to explain "Your follower index could not be paused, so it wasn't updated" and then provide the underlying ES error.

I think this is a nice enhancement, but deferring since it's an edge case

jen-huang · 2019-01-18T21:16:49Z

...ins/cross_cluster_replication/public/app/sections/follower_index_edit/follower_index_edit.js

+                title={(
+                  <FormattedMessage
+                    id="xpack.crossClusterReplication.followerIndex.editTitle"
+                    defaultMessage="Edit follower index"


remote clusters has been updated to just say Edit remote cluster 😄

jen-huang · 2019-01-18T19:54:56Z

Closing this PR in favor of #28778, all PR feedback will be addressed there instead.

elasticmachine · 2019-01-18T22:38:18Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

sebelga added 10 commits January 8, 2019 19:25

[CCR] Advanced settings component

298803d

Remove preview active on toggle settings

5d81b44

Add client side validation of advanced settings form

0094099

Move form entry row to separate component

a2f6bea

Add title to panel

842f88a

Add i18n translation of advanced settings

5211cf5

Update Follower index form with toggle for advanced settings

dd9b8bf

Add server side serialisation for advanced settings

4530329

Make code review changes

72c266b

Merge branch 'feature/ccr' into feature/ccr_follower_advanced_settings

ae4762f

sebelga added Feature:CCR and Remote Clusters Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more labels Jan 11, 2019

Merge branch 'feature/ccr' into feature/ccr_follower_advanced_settings

cb1467d

sebelga force-pushed the feature/ccr_edit_follower_index branch from b37a51e to 5a0c7c0 Compare January 12, 2019 15:21

sebelga added 4 commits January 13, 2019 18:19

Fix test: mock constant dependency

f6360ea

Merge branch 'feature/ccr' into feature/ccr_follower_advanced_settings

5fdd053

Add section to edit follower index

9aaab0e

Show confirm modal before updating follower index

7c7eb75

sebelga force-pushed the feature/ccr_edit_follower_index branch from 5a0c7c0 to 7c7eb75 Compare January 14, 2019 06:12

Add edit icon in table + update server endpoint to pause / resume

958b77f

sebelga changed the title ~~[CCR] WIP Edit follower index~~ [CCR] Edit follower index Jan 14, 2019

sebelga changed the base branch from feature/ccr to feature/ccr_seb-temp-1 January 14, 2019 14:29

sebelga changed the base branch from feature/ccr_seb-temp-1 to feature/ccr January 14, 2019 14:33

sebelga changed the base branch from feature/ccr to feature/ccr_seb-temp-1 January 14, 2019 14:34

sebelga requested review from jen-huang and cjcenizal January 14, 2019 14:34

cjcenizal approved these changes Jan 16, 2019

View reviewed changes

cjcenizal reviewed Jan 16, 2019

View reviewed changes

jen-huang changed the base branch from feature/ccr_seb-temp-1 to feature/ccr January 18, 2019 19:34

jen-huang closed this Jan 18, 2019

jen-huang mentioned this pull request Jan 18, 2019

[CCR] Show remote cluster validation in CCR forms, and add edit follower index #28778

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CCR] Edit follower index #28600

[CCR] Edit follower index #28600

sebelga commented Jan 11, 2019 •

edited

Loading

elasticmachine commented Jan 11, 2019

elasticmachine commented Jan 11, 2019

elasticmachine commented Jan 12, 2019

elasticmachine commented Jan 14, 2019

elasticmachine commented Jan 14, 2019

cjcenizal left a comment •

edited

Loading

This comment was marked as resolved.

jen-huang Jan 18, 2019

cjcenizal Jan 16, 2019

cjcenizal Jan 16, 2019

cjcenizal Jan 16, 2019

cjcenizal Jan 16, 2019

cjcenizal Jan 16, 2019

cjcenizal Jan 16, 2019

jen-huang Jan 18, 2019

cjcenizal Jan 16, 2019

jen-huang Jan 18, 2019

cjcenizal Jan 16, 2019

cjcenizal Jan 16, 2019

jen-huang Jan 18, 2019

This comment was marked as resolved.

jen-huang Jan 18, 2019

jen-huang commented Jan 18, 2019

elasticmachine commented Jan 18, 2019

[CCR] Edit follower index #28600

[CCR] Edit follower index #28600

Conversation

sebelga commented Jan 11, 2019 • edited Loading

elasticmachine commented Jan 11, 2019

elasticmachine commented Jan 11, 2019

💔 Build Failed

elasticmachine commented Jan 12, 2019

💔 Build Failed

elasticmachine commented Jan 14, 2019

💔 Build Failed

elasticmachine commented Jan 14, 2019

💔 Build Failed

cjcenizal left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

jen-huang commented Jan 18, 2019

elasticmachine commented Jan 18, 2019

💔 Build Failed

sebelga commented Jan 11, 2019 •

edited

Loading

cjcenizal left a comment •

edited

Loading