mini_program_gizwits_sdk 3.6.4 → 3.6.5

package/src/handler/socket.ts

@@ -1,686 +0,0 @@
-import errorCode from "../errorCode";
-import GizLog from "../GizLog";
-import request from "../openApiRequest";
-import { IDevice, IError, IOnDeviceStatusChanged, 
-  IDeviceStatusChangedProps, IDeviceRawStatusChangedProps,
-  IOnSocketStatusChanged, IEmptyFn, ICommonObj } from "../types";
-import { compareWXSDKVersion, isError } from '../utils';
-
-// commType = 'custom' | 'attrs_v4'
-// socketType = 'socket' | 'ssl_socket'
-
-
-interface IRespError {
-  err?: IError;
-}
-
-interface IWriteRes {
-  success: boolean;
-  message: string;
-}
-
-interface ICommonProps {
-  appID: string;
-  token: string;
-  uid: string;
-}
-
-interface IGWSProps extends ICommonProps {
-  limitSocketNum?: boolean;
-}
-
-export default class GizwitsWS {
-
-  public appID: string;
-  public token: string;
-  public uid: string;
-  _maxSocketNum: number;
-  _bindingDevices: { [did: string]: IDevice } | null = null;
-  _connections: { [wsInfo: string]: Connection } = {};
-  _onDeviceStatusChanged?: IOnDeviceStatusChanged;
-  _onSocketStatusChanged?: IOnSocketStatusChanged;
-  _onBindingChanged?: IEmptyFn;
-
-  /**
-   * @param limitSocketNum 是否限制 socket 连接数，如果限制则按照小程序sdk限制最大连接数，否则如果超过小程序限制连接数，微信可能会关闭之前的连接，也可以会有异常。
-   */
-  constructor({
-    appID,
-    token,
-    uid,
-    limitSocketNum = true,
-  }: IGWSProps) {
-    this.appID = appID;
-    this.token = token;
-    this.uid = uid;
-    const wxSDKVersion = wx.getSystemInfoSync().SDKVersion
-    this._maxSocketNum = limitSocketNum
-      ? compareWXSDKVersion(wxSDKVersion || '1.0.0', '1.7.0') === -1 ? 1 : 5
-      : 0;
-  }
-
-  async init() {
-    try {
-      const result = await this._getBindingList();
-      if ((result as IRespError).err?.errorCode) {
-        return { errorCode: (result as IRespError).err?.errorCode, errorMessage: 'getting binding list failed' };
-      } else {
-        this._bindingDevices = (result as IDevice[]).reduce((map, device) => ({ ...map, [device.did]: device }), {});
-        return null;
-      }
-    } catch (error) {
-      return errorCode.GIZ_SDK_OTHERWISE
-    }
-  }
-
-  updateToken = ({ token, uid }) => {
-    this.token = token;
-    this.uid = uid;
-  }
-
-  _getDevice = (did: string): IDevice | IError => {
-    if (this._bindingDevices === null) {
-      return errorCode.GIZ_SDK_SDK_NOT_INITIALIZED
-    }
-
-    const device = this._bindingDevices[did];
-    if (device == null) {
-      return errorCode.GIZ_OPENAPI_DEVICE_NOT_BOUND;
-    }
-    return device;
-  }
-
-  _getConnect = (device: IDevice): Connection => {
-    const wsInfo = this._getWebsocketConnInfo(device);
-    return this._connections[wsInfo];
-  }
-
-  _getDeviceAndConnect = (did: string): [IDevice, Connection] | IError => {
-    const device = this._getDevice(did)
-    if (isError(device)) {
-      return device;
-    }
-    const conn = this._getConnect(device);
-    if (conn == null) {
-      return errorCode.GIZ_SDK_DEVICE_NOT_SUBSCRIBED;
-    }
-    return [device, conn]
-  }
-
-  connectDevice = (device: IDevice) => {
-    const wsInfo = this._getWebsocketConnInfo(device);
-    let conn = this._connections[wsInfo];
-    if (conn == null) {
-      const connNum = Object.keys(this._connections).length;
-      if (this._maxSocketNum !== 0 && connNum >= this._maxSocketNum) {
-        return { success: false, errorCode: errorCode.MAX_CONNECT };
-      }
-      conn = new Connection({
-        appID: this.appID,
-        token: this.token,
-        uid: this.uid,
-        wsInfo,
-        onDeviceStatusChanged: this._handleDeviceStatusChanged,
-        onBindingChanged: this._handleBindingChanged,
-        onSocketStatusChanged: this._handleSocketStatusChanged,
-      });
-      this._connections[wsInfo] = conn;
-    }
-    conn._addSubDid(device.did);
-    if (conn._websocket == null) {
-      conn._connectWS();
-    } else if (conn.ready) {
-      conn._subDevices([device.did]);
-    }
-    return { success: true };
-  }
-
-  connectDevices = (devices: IDevice[]) => {
-    const wsInfoMap: Record<string, string[]> = {};
-    devices.forEach(device => {
-      const wsInfo = this._getWebsocketConnInfo(device);
-      if (!wsInfoMap[wsInfo]) {
-        wsInfoMap[wsInfo] = [];
-      }
-      wsInfoMap[wsInfo].push(device.did);
-    });
-
-    const notConnNum = Object.keys(wsInfoMap).filter(wsInfo => this._connections[wsInfo] == null).length;
-    const connNum = Object.keys(this._connections).length;
-    if (this._maxSocketNum !== 0 && connNum + notConnNum > this._maxSocketNum) {
-      return { success: false, errorCode: errorCode.MAX_CONNECT };
-    }
-
-    Object.entries(wsInfoMap).forEach(([wsInfo, dids]) => {
-      let conn = this._connections[wsInfo];
-      if (conn == null) {
-        conn = new Connection({
-          appID: this.appID,
-          token: this.token,
-          uid: this.uid,
-          wsInfo,
-          onDeviceStatusChanged: this._handleDeviceStatusChanged,
-          onBindingChanged: this._handleBindingChanged,
-          onSocketStatusChanged: this._handleSocketStatusChanged,
-        });
-        this._connections[wsInfo] = conn;
-      }
-      conn._addSubDid(...dids);
-      if (conn._websocket == null) {
-        conn._connectWS();
-      } else if (conn.ready) {
-        conn._subDevices(dids);
-      }
-    })
-    return { success: true };
-  }
-
-
-  disConnectDevice = (device: IDevice) => {
-    const wsInfo = this._getWebsocketConnInfo(device);
-    let conn = this._connections[wsInfo];
-    if (conn) {
-      conn._unSubDevices([device.did])
-    }
-    return { success: true }
-  }
-
-  disConnectDevices = (devices: IDevice[]) => {
-    const wsInfoMap: Record<string, string[]> = {};
-    devices.forEach(device => {
-      const wsInfo = this._getWebsocketConnInfo(device);
-      if (!wsInfoMap[wsInfo]) {
-        wsInfoMap[wsInfo] = [];
-      }
-      wsInfoMap[wsInfo].push(device.did);
-    });
-    Object.entries(wsInfoMap).forEach(([wsInfo, dids]) => {
-      const conn = this._connections[wsInfo];
-      if (conn) {
-        conn._unSubDevices(dids)
-      }
-    })
-    return { success: true }
-  }
-
-  connect = (did: string) => {
-    const device = this._getDevice(did)
-    if (isError(device)) {
-      return device;
-    }
-    const res = this.connectDevice(device);
-    return res.success ? null : res.errorCode;
-  }
-
-  send = (did: string, raw: number[]) => {
-    const res = this._getDeviceAndConnect(did);
-    if (isError(res)) {
-      return res;
-    }
-    return res[1]._send({
-      cmd: "c2s_raw",
-      data: {
-        did: did,
-        raw
-      }
-    });
-  }
-
-  writeData = (device: IDevice, attrs: ICommonObj) => {
-    const conn = this._getConnect(device);
-    const success = conn != null;
-    if (success) {
-      return conn._send({
-        cmd: "c2s_write",
-        data: {
-          did: device.did,
-          attrs
-        }
-      });
-    }
-    return { success: false };
-  }
-
-  write = (did: string, attrs: ICommonObj) => {
-    const res = this._getDeviceAndConnect(did);
-    if (isError(res)) {
-      return res;
-    }
-    return res[1]._send({
-      cmd: "c2s_write",
-      data: {
-        did: did,
-        attrs: attrs
-      }
-    });
-  }
-
-  readStatus = (device: IDevice, names?: string[]) => {
-    const conn = this._getConnect(device);
-    const success = conn != null;
-    if (success) {
-      conn._send({
-        cmd: "c2s_read",
-        data: {
-          did: device.did,
-          names,
-        }
-      });
-    }
-    return { success };
-  }
-
-  read = (did: string, names?: string[]) => {
-    const res = this._getDeviceAndConnect(did);
-    if (isError(res)) {
-      return res;
-    }
-    return res[1]._send({
-      cmd: "c2s_read",
-      data: {
-        did: did,
-        names: names
-      }
-    });
-  }
-
-  destory = () => {
-    Object.values(this._connections).forEach(conn => conn.destory());
-  }
-
-  subscribeDeviceStatus = (cb: IOnDeviceStatusChanged) => {
-    this._onDeviceStatusChanged = cb;
-  }
-
-  subscribeBindingChanged = (cb: IEmptyFn) => {
-    this._onBindingChanged = cb;
-  }
-
-  subscribeSocketStatus = (cb: IOnSocketStatusChanged) => {
-    this._onSocketStatusChanged = cb;
-  }
-
-  _handleDeviceStatusChanged: IOnDeviceStatusChanged = (data) => {
-    // const device = this._getDevice(data.did);
-    // if (!isError(device)) {
-    //   this._onDeviceStatusChanged && this._onDeviceStatusChanged(data);
-    // }
-    this._onDeviceStatusChanged && this._onDeviceStatusChanged(data);
-  }
-
-  _handleBindingChanged = () => {
-    this._onBindingChanged && this._onBindingChanged();
-  }
-
-  _handleSocketStatusChanged: IOnSocketStatusChanged = (...params) => {
-    this._onSocketStatusChanged && this._onSocketStatusChanged(...params);
-  }
-
-  _getBindingList = async (limit: number = 20, skip: number = 0, cacheList: IDevice[] = []): Promise<IDevice[] | IRespError> => {
-    const url = `/app/bindings?show_disabled=0&limit=${limit}&skip=${skip}`;
-    const { err, data } = await request<{ devices: IDevice[] }>(`${url}`, { method: 'GET' });
-    if (err) {
-      return { err };
-    }
-    const devices = [...cacheList, ...data?.devices || []]
-    if (data && data.devices.length === limit) {
-      return await this._getBindingList(limit, limit + skip, devices);
-    }
-    return devices;
-  }
-
-  _getWebsocketConnInfo = (device) => {
-    if (device.host) {
-      return `wss://wx${device.host}`
-    }
-    return 'wss://wxstage.gizwits.com';
-  }
-
-
-}
-
-interface IConnectProps extends ICommonProps {
-  wsInfo: string;
-  onDeviceStatusChanged?: IOnDeviceStatusChanged;
-  onBindingChanged?: IEmptyFn;
-  onSocketStatusChanged?: IOnSocketStatusChanged;
-}
-
-export class Connection {
-  ready: boolean = false;
-  appID: string;
-  token: string;
-  uid: string;
-  commType: string = 'attrs_v4';
-  _heartbeatInterval = 60;
-  _keepaliveTime = 180;
-  _loginIntveral = 5000;
-  autoSubscribe = false;
-  _wsUrl: string;
-  _websocket: WechatMiniprogram.SocketTask | null = null;
-  _heartbeatTimerId?: any;
-  _loginFailedTimes: number = 0;
-  _subDids: Set<string> = new Set();
-  _socketRespHandleMap: { [cmd: string]: (resp?: any) => void } = {};
-  _onDeviceStatusChanged?: IOnDeviceStatusChanged;
-  _onBindingChanged?: IEmptyFn;
-  _onSocketStatusChanged?: IOnSocketStatusChanged;
-  _waitSends: object[] = [];
-  _checkConnectTimerId?: any;
-
-  constructor({
-    appID,
-    token,
-    uid,
-    wsInfo,
-    onDeviceStatusChanged,
-    onBindingChanged,
-    onSocketStatusChanged,
-  }: IConnectProps) {
-    this.appID = appID;
-    this.token = token;
-    this.uid = uid;
-    this._wsUrl = `${wsInfo}/ws/app/v1`;
-    this._heartbeatTimerId = undefined;
-    this._loginFailedTimes = 0;
-    this._onDeviceStatusChanged = onDeviceStatusChanged;
-    this._onBindingChanged = onBindingChanged;
-    this._onSocketStatusChanged = onSocketStatusChanged;
-    this._socketRespHandleMap = {
-      pong: this.pongResp,
-      login_res: this._loginResp,
-      subscribe_res: this._subscribeResp,
-      s2c_online_status: this._onlineResp,
-      s2c_raw: this._rawChangedResp,
-      s2c_noti: this._statusChangedResp,
-      s2c_invalid_msg: this._invalidMsgResp,
-      s2c_binding_changed: this._bindingChangedResp,
-    }
-    wx.onNetworkStatusChange(this._networkChange);
-    wx.onAppShow(this._appShow)
-  }
-
-  destory = () => {
-    if (this._heartbeatTimerId) {
-      clearInterval(this._heartbeatTimerId)
-    }
-    if (this._checkConnectTimerId) {
-      clearInterval(this._checkConnectTimerId)
-    }
-    this.close();
-  }
-
-  _networkChange = async (res: WechatMiniprogram.OnNetworkStatusChangeListenerResult) => {
-    GizLog.log('network change', res);
-    // if (res.isConnected && !this._websocket) {
-    //   // 网络断开重连
-    //   await sleep(100);
-    //   this._connectWS();
-    // }
-  }
-
-  _appShow = async () => {
-    GizLog.log('app show');
-    // if (!this._websocket) {
-    //   // 从后台切回如果断开连接重新连
-    //   this._connectWS();
-    // }
-  }
-
-  _addSubDid = (...dids) => {
-    dids.forEach(did => this._subDids.add(did));
-  }
-
-  _removeSubDid = (...dids) => {
-    dids.forEach(did => this._subDids.delete(did));
-  }
-
-  _connectWS = () => {
-    GizLog.log('GIZ_SDK: start connect ws')
-    this._websocket = wx.connectSocket({
-      url: this._wsUrl,
-      fail: (res) => {
-        GizLog.error('GIZ_SDK: connectSocket error', new Error(JSON.stringify(res)));
-      }
-    });
-    this._websocket.onClose(this.handleClose);
-    this._websocket.onOpen(this.handleOpen);
-    this._websocket.onError(this.handleError);
-    this._websocket.onMessage(this.handleMessage);
-
-    //  维持连接
-    if (!this._checkConnectTimerId) {
-      this._checkConnectTimerId = setInterval(() => {
-        if (!this._websocket) {
-          this._connectWS();
-        }
-      }, 1000);
-    }
-
-  }
-
-  _subDevices = (dids: string[]) => {
-    const json = {
-      cmd: "subscribe_req",
-      data: dids.map(did => ({ did }))
-    };
-    this._send(json);
-  }
-
-  _unSubDevices = (dids: string[]) => {
-    dids.map(item => this._removeSubDid(item))
-  }
-
-  _send = (data: object, forced: boolean = false) => {
-    GizLog.log('GIZ_SDK: Socket send', data, forced);
-    return new Promise<IWriteRes>((resolve) => {
-      if (!this._websocket) {
-        resolve({
-          success: false,
-          message: 'Socket not init'
-        })
-        return;
-      }
-      if (!forced && !this.ready) {
-        resolve({
-          success: false,
-          message: 'Socket not ready'
-        })
-        return;
-      }
-      if (this._websocket && (forced || this.ready)) {
-        this._websocket.send({
-          data: JSON.stringify(data),
-          complete: (res) => {
-            GizLog.log('GIZ_SDK: socket send res', res);
-            // if ([
-            //   'sendSocketMessage:fail debug invoke no active session',
-            //   'sendSocketMessage:fail wcwss taskID not exist'
-            // ].includes(res && res.errMsg)) {
-            //   // 重新connect
-            //   this._websocket && this._websocket.close({});
-            //   this._connectWS();
-            // }
-            GizLog.log('resres', res)
-            let success = false;
-            if (res.errMsg === "sendSocketMessage:ok") {
-              success = true
-            }
-            resolve({
-              success,
-              message: res.errMsg
-            })
-
-          },
-          fail: (e) => {
-            GizLog.error('GIZ_SDK: Socket send error', new Error(JSON.stringify(e)));
-            resolve({
-              success: false,
-              message: e.errMsg
-            })
-          }
-        })
-      }
-    })
-  }
-
-  close = () => {
-    this.ready = false;
-    if (this._heartbeatTimerId) {
-      clearInterval(this._heartbeatTimerId);
-    }
-    if (this._websocket) {
-      this._websocket.close({});
-      this._websocket = null;
-    }
-    if (this._currentSocketStatus) {
-      this._currentSocketStatus = false;
-      this._handleSocketStatusChanged(false);
-    }
-  }
-
-  handleClose = (res: { code: number, reason: string }) => {
-    GizLog.error('GIZ_SDK: socket close', new Error(JSON.stringify(res)));
-    this.close();
-    this._stopPing();
-  }
-
-  handleOpen = () => {
-    // socket 打开后执行登录
-    GizLog.log(' socket open')
-    this._login();
-  }
-
-  handleMessage = ({ data }: { data: string | ArrayBuffer }) => {
-    GizLog.log('GIZ_SDK: message', data);
-    const res = JSON.parse(data as string);
-    const handle = this._socketRespHandleMap[res.cmd];
-    handle && handle(res.data);
-  }
-
-  handleError = (err: { errMsg: string }) => {
-    GizLog.error('GIZ_SDK: socket error', new Error(JSON.stringify(err)));
-    this.close();
-    this._stopPing();
-  }
-
-  _login = () => {
-    const data = {
-      cmd: 'login_req',
-      data: {
-        appid: this.appID,
-        uid: this.uid,
-        token: this.token,
-        p0_type: this.commType,
-        heartbeat_interval: this._keepaliveTime,
-        auto_subscribe: this.autoSubscribe
-      }
-    }
-    this._send(data, true);
-  }
-
-  _tryLoginAgain = () => {
-    this._loginFailedTimes += 1;
-    setTimeout(() => {
-      this._login();
-    }, this._loginFailedTimes * this._loginIntveral);
-  }
-
-  _startPing = () => {
-    this._heartbeatTimerId = setInterval(() => {
-      this._send({ cmd: 'ping' });
-
-    }, this._heartbeatInterval * 1000);
-  }
-
-  _stopPing = () => {
-    this._heartbeatTimerId && clearInterval(this._heartbeatTimerId);
-  }
-
-  pongResp = () => {
-    // 不处理
-  }
-
-  _currentSocketStatus = false;
-
-  _loginResp = (data) => {
-    if (data.success == true) {
-      this._loginFailedTimes = 0;
-      this.ready = true;
-      this._startPing();
-      this._subDevices([...this._subDids]);
-      this._currentSocketStatus = true;
-      this._handleSocketStatusChanged(this._currentSocketStatus);
-      this._consumeWaitSends();
-    } else if (this._loginFailedTimes < 3) {
-      GizLog.log('GIZ_SDK: Login failed, will try again, please wait...');
-      this._tryLoginAgain();
-    } else {
-      GizLog.error('GIZ_SDK: Login failed', new Error('m2m socket login failed'));
-      this.close();
-    }
-  }
-
-  _consumeWaitSends = () => {
-    let data = this._waitSends.pop()
-    while (data) {
-      this._send(data);
-      data = this._waitSends.pop()
-    }
-  }
-
-  _handleSocketStatusChanged = (enabled: boolean) => {
-    this._onSocketStatusChanged && this._onSocketStatusChanged([...this._subDids], enabled);
-  }
-
-  _subscribeResp = (data) => {
-    GizLog.log('GIZ_SDK: subscribe_res', data);
-    if (data && data.success) {
-      // 订阅成功设备获取设备状态
-      data.success.forEach(d => this._send({
-        cmd: "c2s_read",
-        data: {
-          did: d.did,
-        }
-      }))
-    }
-    GizLog.debug('GIZ_SDK: subscribe_res', data);
-  }
-
-  _onlineResp = (data: { did: string, online: boolean }) => {
-    if (!this._isSub(data.did)) return;
-    this._onDeviceStatusChanged && this._onDeviceStatusChanged({
-      did: data.did, attrs: { is_online: data.online, ...data }
-    });
-  }
-
-  _rawChangedResp = (data: IDeviceRawStatusChangedProps) => {
-    if (!this._isSub(data.did)) return;
-    this._onDeviceStatusChanged && this._onDeviceStatusChanged(data);
-  }
-
-  _statusChangedResp = (data: IDeviceStatusChangedProps) => {
-    if (!this._isSub(data.did)) return;
-    this._onDeviceStatusChanged && this._onDeviceStatusChanged(data);
-  }
-
-  // 检查设备是否订阅
-  _isSub = (did: string) => {
-    return this._subDids.has(did);
-  }
-
-  _invalidMsgResp = (data) => {
-    if (data.error_code === 1003) {
-      // 重新登录
-      this._login();
-    }
-    GizLog.error('GIZ_SDK: s2c_invalid_msg', new Error(JSON.stringify(data)));
-  }
-
-  _bindingChangedResp = (data) => {
-    if (!data.bind && data.did) {
-      this._removeSubDid(data.did)
-    }
-    this._onBindingChanged && this._onBindingChanged();
-  }
-}