Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-3609

ConnectWebSocket should be able to reconnect automatically

    Details

    • Type: Bug
    • Status: Patch Available
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.1.0
    • Fix Version/s: None
    • Component/s: Extensions
    • Labels:
      None

      Description

      WebSocket connection can be extended by trigger PutWebSocket periodically (typically with empty message), but it doesn't help when server goes down.

      Currently if a server restarted, ConnectWebSocket has to be restarted manually to establish new connection.

      Ideally, this situation should be recovered automatically. If existing session ids can be reused, it'd be even better as it recovers transparently.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user ijokarumawak opened a pull request:

          https://github.com/apache/nifi/pull/1597

          NIFI-3609: ConnectWebSocket auto session recovery

          Before this fix, ConnectWebSocket has to be restarted manually if its target WebSocket server restarted, or session expiration if there's no communication more than certain period of time (looks 3 min). This PR adds automatic session maintenance logic so that ConnectWebSocket keeps its session alive as long as it's running.

          • Removed unused disconnect method from WebSocketService interface.
          • Added session maintenance background thread at JettyWebSocketClient
            which reconnects sessions those are still referred by ConnectWebSocket
            processor but no longer active.
          • Added Session Maintenance Interval property to JettyWebSocketClient.
          • Allowed specifying existing session id so that it can be recovered
            transparently.
          • Moved test classes to appropriate package.
          • Added test cases that verify the same session id can be used after
            WebSocket server restarts.

          Thank you for submitting a contribution to Apache NiFi.

          In order to streamline the review of the contribution we ask you
          to ensure the following steps have been taken:

              1. For all changes:
          • [x] Is there a JIRA ticket associated with this PR? Is it referenced
            in the commit message?
          • [x] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
          • [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
          • [x] Is your initial contribution a single, squashed commit?
              1. For code changes:
          • [x] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
          • [x] Have you written or updated unit tests to verify your changes?
          • [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
          • [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
          • [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
          • [ ] If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?
              1. For documentation related changes:
          • [x] Have you ensured that format looks appropriate for the output in which it is rendered?
              1. Note:
                Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/ijokarumawak/nifi nifi-3609

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/nifi/pull/1597.patch

          To close this pull request, make a commit to your master/trunk branch
          with (at least) the following in the commit message:

          This closes #1597


          commit 0da822fb52c698d04726b9b6bd060480dc21ed1b
          Author: Koji Kawamura <ijokarumawak@apache.org>
          Date: 2017-03-16T08:10:38Z

          NIFI-3609: ConnectWebSocket auto session recovery

          • Removed unused disconnect method from WebSocketService interface.
          • Added session maintenance background thread at JettyWebSocketClient
            which reconnects sessions those are still referred by ConnectWebSocket
            processor but no longer active.
          • Added Session Maintenance Interval property to JettyWebSocketClient.
          • Allowed specifying existing session id so that it can be recovered
            transparently.
          • Moved test classes to appropriate package.
          • Added test cases that verify the same session id can be used after
            WebSocket server restarts.

          Show
          githubbot ASF GitHub Bot added a comment - GitHub user ijokarumawak opened a pull request: https://github.com/apache/nifi/pull/1597 NIFI-3609 : ConnectWebSocket auto session recovery Before this fix, ConnectWebSocket has to be restarted manually if its target WebSocket server restarted, or session expiration if there's no communication more than certain period of time (looks 3 min). This PR adds automatic session maintenance logic so that ConnectWebSocket keeps its session alive as long as it's running. Removed unused disconnect method from WebSocketService interface. Added session maintenance background thread at JettyWebSocketClient which reconnects sessions those are still referred by ConnectWebSocket processor but no longer active. Added Session Maintenance Interval property to JettyWebSocketClient. Allowed specifying existing session id so that it can be recovered transparently. Moved test classes to appropriate package. Added test cases that verify the same session id can be used after WebSocket server restarts. Thank you for submitting a contribution to Apache NiFi. In order to streamline the review of the contribution we ask you to ensure the following steps have been taken: For all changes: [x] Is there a JIRA ticket associated with this PR? Is it referenced in the commit message? [x] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character. [x] Has your PR been rebased against the latest commit within the target branch (typically master)? [x] Is your initial contribution a single, squashed commit? For code changes: [x] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder? [x] Have you written or updated unit tests to verify your changes? [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0] ( http://www.apache.org/legal/resolved.html#category-a)? [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly? [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly? [ ] If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties? For documentation related changes: [x] Have you ensured that format looks appropriate for the output in which it is rendered? Note: Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible. You can merge this pull request into a Git repository by running: $ git pull https://github.com/ijokarumawak/nifi nifi-3609 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/nifi/pull/1597.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #1597 commit 0da822fb52c698d04726b9b6bd060480dc21ed1b Author: Koji Kawamura <ijokarumawak@apache.org> Date: 2017-03-16T08:10:38Z NIFI-3609 : ConnectWebSocket auto session recovery Removed unused disconnect method from WebSocketService interface. Added session maintenance background thread at JettyWebSocketClient which reconnects sessions those are still referred by ConnectWebSocket processor but no longer active. Added Session Maintenance Interval property to JettyWebSocketClient. Allowed specifying existing session id so that it can be recovered transparently. Moved test classes to appropriate package. Added test cases that verify the same session id can be used after WebSocket server restarts.

            People

            • Assignee:
              ijokarumawak Koji Kawamura
              Reporter:
              ijokarumawak Koji Kawamura
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Development