fix: enlarge client 'live' time to prevent inproper connection close

leeyeh · leeyeh · commit ecbcb1c3e345 · 2018-04-11T15:27:34.000+08:00
diff --git a/plugins/live-query/src/index.js b/plugins/live-query/src/index.js
@@ -8,35 +8,47 @@ const onRealtimeCreate = realtime => {
     if (realtime._liveQueryClients[subscriptionId] !== undefined) {
       return _Promise.resolve(realtime._liveQueryClients[subscriptionId]);
     }
-    const promise = realtime._open().then(connection => {
-      const client = new LiveQueryClient(
-        realtime._options.appId,
-        subscriptionId,
-        connection
-      );
-      connection.on('reconnect', () =>
-        client
-          ._open()
-          .then(
-            () => client.emit('reconnect'),
-            error => client.emit('reconnecterror', error)
-          )
-      );
-      client._eventemitter.on(
-        'close',
-        () => {
-          delete realtime._liveQueryClients[client.id];
-          realtime._deregister(client);
-        },
-        realtime
-      );
-      return client._open().then(() => {
-        realtime._liveQueryClients[client.id] = client;
-        realtime._register(client);
-        return client;
+    const promise = realtime
+      ._open()
+      .then(connection => {
+        const client = new LiveQueryClient(
+          realtime._options.appId,
+          subscriptionId,
+          connection
+        );
+        connection.on('reconnect', () =>
+          client
+            ._open()
+            .then(
+              () => client.emit('reconnect'),
+              error => client.emit('reconnecterror', error)
+            )
+        );
+        client._eventemitter.on(
+          'beforeclose',
+          () => {
+            delete realtime._liveQueryClients[client.id];
+          },
+          realtime
+        );
+        client._eventemitter.on(
+          'close',
+          () => {
+            realtime._deregister(client);
+          },
+          realtime
+        );
+        return client._open().then(() => {
+          realtime._liveQueryClients[client.id] = client;
+          realtime._register(client);
+          return client;
+        });
+      })
+      .finally(() => {
+        if (realtime._deregisterPending) realtime._deregisterPending(promise);
       });
-    });
     realtime._liveQueryClients[subscriptionId] = promise;
+    if (realtime._registerPending) realtime._registerPending(promise);
     return promise;
   };
   /* eslint-enable no-param-reassign */
diff --git a/plugins/live-query/src/live-query-client.js b/plugins/live-query/src/live-query-client.js
@@ -31,18 +31,22 @@ export default class LiveQueryClient extends EventEmitter {
     );
   }
   close() {
+    const _ee = this._eventemitter;
+    _ee.emit('beforeclose');
     return this._send(
       new GenericCommand({
         cmd: CommandType.logout,
       })
-    ).then(() => this._eventemitter.emit('close'));
+    ).then(() => _ee.emit('close'));
   }
   register(liveQuery) {
     this._querys.add(liveQuery);
   }
   deregister(liveQuery) {
     this._querys.delete(liveQuery);
-    if (!this._querys.size) this.close().catch(warn);
+    setTimeout(() => {
+      if (!this._querys.size) this.close().catch(warn);
+    }, 0);
   }
   _dispatchCommand(command) {
     if (command.cmd !== CommandType.data) {
diff --git a/src/im-client.js b/src/im-client.js
@@ -1037,14 +1037,16 @@ export default class IMClient extends EventEmitter {
    */
   async close() {
     this._debug('close session');
+    const _ee = internal(this)._eventemitter;
+    _ee.emit('beforeclose');
     if (this._connection.is('connected')) {
       const command = new GenericCommand({
         cmd: 'session',
         op: 'close',
       });
       await this._send(command);
     }
-    internal(this)._eventemitter.emit('close');
+    _ee.emit('close');
     this.emit(CLOSE, {
       code: 0,
     });
diff --git a/src/plugin-im.js b/src/plugin-im.js
@@ -222,70 +222,85 @@ const onRealtimeCreate = realtime => {
       );
     }
     const _tag = tag || lagecyTag;
-    const promise = realtime._open().then(connection => {
-      const client = new IMClient(
-        id,
-        { ...buildinOptions, ...clientOptions },
-        {
-          _connection: connection,
-          _request: realtime._request.bind(realtime),
-          _messageParser: messageParser,
-          _plugins: realtime._plugins,
-          _identity: identity,
-        }
-      );
-      connection.on(RECONNECT, () =>
-        client
-          ._open(realtime._options.appId, _tag, deviceId, true)
-          /**
-           * 客户端连接恢复正常，该事件通常在 {@link Realtime#event:RECONNECT} 之后发生
-           * @event IMClient#RECONNECT
-           * @see Realtime#event:RECONNECT
-           * @since 3.2.0
-           */
-          /**
-           * 客户端重新登录发生错误（网络连接已恢复，但重新登录错误）
-           * @event IMClient#RECONNECT_ERROR
-           * @since 3.2.0
-           */
-          .then(
-            () => client.emit(RECONNECT),
-            error => client.emit(RECONNECT_ERROR, error)
-          )
-      );
-      internal(client)._eventemitter.on(
-        'close',
-        () => {
-          delete realtime._IMClients[client.id];
-          realtime._deregister(client);
-        },
-        realtime
-      );
-      return client
-        ._open(realtime._options.appId, _tag, deviceId, isReconnect)
-        .then(() => {
-          realtime._IMClients[client.id] = client;
-          realtime._IMClientsCreationCount += 1;
-          if (realtime._IMClientsCreationCount === 1) {
-            client._omitPeerId(true);
-            realtime._firstIMClient = client;
-          } else if (
-            realtime._IMClientsCreationCount > 1 &&
-            realtime._firstIMClient
-          ) {
-            realtime._firstIMClient._omitPeerId(false);
+    const promise = realtime
+      ._open()
+      .then(connection => {
+        const client = new IMClient(
+          id,
+          { ...buildinOptions, ...clientOptions },
+          {
+            _connection: connection,
+            _request: realtime._request.bind(realtime),
+            _messageParser: messageParser,
+            _plugins: realtime._plugins,
+            _identity: identity,
           }
-          realtime._register(client);
-          return client;
-        })
-        .catch(error => {
-          delete realtime._IMClients[client.id];
-          throw error;
-        });
-    });
+        );
+        connection.on(RECONNECT, () =>
+          client
+            ._open(realtime._options.appId, _tag, deviceId, true)
+            /**
+             * 客户端连接恢复正常，该事件通常在 {@link Realtime#event:RECONNECT} 之后发生
+             * @event IMClient#RECONNECT
+             * @see Realtime#event:RECONNECT
+             * @since 3.2.0
+             */
+            /**
+             * 客户端重新登录发生错误（网络连接已恢复，但重新登录错误）
+             * @event IMClient#RECONNECT_ERROR
+             * @since 3.2.0
+             */
+            .then(
+              () => client.emit(RECONNECT),
+              error => client.emit(RECONNECT_ERROR, error)
+            )
+        );
+        internal(client)._eventemitter.on(
+          'beforeclose',
+          () => {
+            delete realtime._IMClients[client.id];
+            if (realtime._firstIMClient === client) {
+              delete realtime._firstIMClient;
+            }
+          },
+          realtime
+        );
+        internal(client)._eventemitter.on(
+          'close',
+          () => {
+            realtime._deregister(client);
+          },
+          realtime
+        );
+        return client
+          ._open(realtime._options.appId, _tag, deviceId, isReconnect)
+          .then(() => {
+            realtime._IMClients[client.id] = client;
+            realtime._IMClientsCreationCount += 1;
+            if (realtime._IMClientsCreationCount === 1) {
+              client._omitPeerId(true);
+              realtime._firstIMClient = client;
+            } else if (
+              realtime._IMClientsCreationCount > 1 &&
+              realtime._firstIMClient
+            ) {
+              realtime._firstIMClient._omitPeerId(false);
+            }
+            realtime._register(client);
+            return client;
+          })
+          .catch(error => {
+            delete realtime._IMClients[client.id];
+            throw error;
+          });
+      })
+      .finally(() => {
+        realtime._deregisterPending(promise);
+      });
     if (identity) {
       realtime._IMClients[id] = promise;
     }
+    realtime._registerPending(promise);
     return promise;
   };
   Object.assign(realtime, {
diff --git a/src/realtime.js b/src/realtime.js
@@ -60,7 +60,9 @@ export default class Realtime extends EventEmitter {
       options
     );
     this._cache = new Cache('endpoints');
-    internal(this).clients = new Set();
+    const _this = internal(this);
+    _this.clients = new Set();
+    _this.pendingClients = new Set();
     const mergedPlugins = [
       ...ensureArray(Realtime.__preRegisteredPlugins),
       ...ensureArray(plugins),
@@ -391,13 +393,22 @@ export default class Realtime extends EventEmitter {
     if (connection.can('resume')) connection.resume();
   }
 
+  _registerPending(value) {
+    internal(this).pendingClients.add(value);
+  }
+
+  _deregisterPending(client) {
+    internal(this).pendingClients.delete(client);
+  }
+
   _register(client) {
     internal(this).clients.add(client);
   }
 
   _deregister(client) {
-    internal(this).clients.delete(client);
-    if (internal(this).clients.size === 0) {
+    const _this = internal(this);
+    _this.clients.delete(client);
+    if (_this.clients.size + _this.pendingClients.size === 0) {
       this._close();
     }
   }
