https://github.com/wechaty/ha

High Available (HA) Wechaty is a Load Balance for providing High Availability for Wechaty Chatbot by spreading requests across multiple WeChat individual accounts.
https://github.com/wechaty/ha

chatbot high-availability wechaty

Last synced: about 1 year ago
JSON representation

High Available (HA) Wechaty is a Load Balance for providing High Availability for Wechaty Chatbot by spreading requests across multiple WeChat individual accounts.

Host: GitHub
URL: https://github.com/wechaty/ha
Owner: wechaty
License: apache-2.0
Created: 2020-04-06T06:44:15.000Z (about 6 years ago)
Default Branch: main
Last Pushed: 2021-11-19T13:33:49.000Z (over 4 years ago)
Last Synced: 2025-06-04T04:01:34.967Z (about 1 year ago)
Topics: chatbot, high-availability, wechaty
Language: TypeScript
Homepage: https://npmjs.com/package/ha-wechaty
Size: 397 KB
Stars: 4
Watchers: 3
Forks: 1
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

          # High Available (HA) Wechaty

[![NPM Version](https://img.shields.io/npm/v/ha-wechaty?color=brightgreen)](https://www.npmjs.com/package/ha-wechaty)

[![NPM](https://github.com/wechaty/ha-wechaty/workflows/NPM/badge.svg)](https://github.com/wechaty/ha-wechaty/actions?query=workflow%3ANPM)

[![ES Modules](https://img.shields.io/badge/ES-Modules-brightgreen)](https://github.com/Chatie/tsconfig/issues/16)

![HAWechaty](https://wechaty.github.io/ha-wechaty/images/ha-wechaty.png)

HA Wechaty is a Load Balance for providing High Availability for Wechaty Chatbot by spreading requests across multiple WeChat individual accounts.

[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)

[![Powered by Ducks](https://img.shields.io/badge/Powered%20by-Ducks-yellowgreen)](https://github.com/huan/ducks#3-ducksify-extension-currying--ducksify-interface)

One two three, chatbots team up!

## Background

How to delivering high levels of [SLA uptime](https://www.vxchnge.com/blog/uptime-statistics-impact-business)?

### The Problem of Single Point Of Failure (SPOF)

We have serval issues when we providing a Chatbot service, like:

1. Single Point Of Failure (SPOF)

1. Heartbeat & Keepalive

### 1 Single Point Of Failure (SPOF)

#### The Problem #1

Currently we have only one bot on WeChat, which means that if the bot was offline, then our service will be stopped.

#### The Solution #1

Use two (3 or even 4 will be better) WeChat bot at the same time, with the different wechaty-puppet providers (for example: padlocal + windows).

So when an issue event has come, we can use a RR (round robin) or other very easy to implementing algorithm to make our service both load-balancable and high-available.

### 2 Heartbeat and Keepalive

1. [Heartbeat](https://en.wikipedia.org/wiki/Heartbeat_(computing))

1. [Keepalive](https://en.wikipedia.org/wiki/Keepalive)

#### The Problem #2

When a Wechaty bot is started and logged in, it is mostly liked to be work as expected for sending/receiving messages.

However, sometimes it might run into trouble for some unknown reason, which caused it can not work anymore, but we have nothing to know about that.

In order to check whether a Wechaty bot is available, we need to take a test on it to see if it can send & receive the message successfully.

How can archive that? It is not a good idea if we send a message to another Wechaty bot because it is not stable enough for this kind of online service.

#### The Solution #2

We can set up an Official Account for WeChat, with an auto-responding strategy that will reply a `dong` when it receives a `ding`.

So we let our Chatie Official Account takes the responsibility to provide this service.

## HAProxy Requirement

![QR Code for ChatieIO WeChat Official Account](docs/images/qrcode_for_gh_051c89260e5d_258.jpg)

If you want to use HAProxy, please make sure every bot account has followed the `ChatieIO` WeChat Official Account by scanning the above QR Code.

## Usage

```ts

import { HAWechaty } from 'ha-wechaty'

import { Wechaty } from 'wechaty'

const wechaty1 = new Wechaty({

  puppet: 'wechaty-puppet-service',

  puppetOptions: {

    token: 'puppet-service-token'

  }

})

const wechaty2 = new Wechaty({

  puppet: 'wechaty-puppet-padlocal',

  puppetOptions: {

    token: 'padlocal-token'

  }

})

// 1. Configure HAWechaty

const haWechaty = configureHa()

// 2. Add Wechaty instances to HA

haWechaty.add(wechaty1, wechaty2)

// 3. Start HA

await haWechaty.start()

// 4. Find room by our bots

const room = await haWechaty.Room.find({ topic: 'ding room' })

if (room) {

  // 5. Send message to room with load balancing and high availabilities

  await room.say('ding')

}

```

## Environment Variables

### 1 `HA_WECHATY_PUPPET`

The wechaty puppet list, seprated by a colon (`:`).

Examples:

```sh

export HA_WECHATY_PUPPET=wechaty-puppet-service:wechaty-puppet-padlocal

```

### 2 `HA_WECHATY_PUPPET_TOKEN`

Wechaty Puppet Service Tokens that required by the puppets.

This is a token list, seprated by a colon (`:`), map to each puppet from `HA_WECHATY_PUPPET`.

> Leave it empty if a puppet does not require a token.

The token set to this environment variable will become the default value of `puppetOptions.token` when instantiating Wechaty.

To specify more tokens for a specific puppet, use a colon (`:`) to separate them, for example:

```sh

export HA_WECHATY_PUPPET_TOKEN=token_1:token_2

```

## Development

### Redux Remote DevTools

```sh

npm run redux-devtools

```

## Links

### Backoff Alghorithm

See issue: Backoff straitegy [#2](https://github.com/wechaty/ha-wechaty/issues/2)

1. [Googl Cloud - Truncated exponential backoff](https://cloud.google.com/storage/docs/exponential-backoff)

1. [Power of RxJS when using exponential backoff](https://medium.com/angular-in-depth/power-of-rxjs-when-using-exponential-backoff-a4b8bde276b0)

1. [GRPC Connection Backoff Protocol](https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md)

### Redux

1. [Redux Best Practices](https://medium.com/@kylpo/redux-best-practices-eef55a20cc72#.e8gil0ncl)

1. [Typesafe utilities for "action-creators" in Redux / Flux Architecture](https://github.com/piotrwitek/typesafe-actions)

1. [createAsyncEpic - Generic redux-observable factory handling async-actions - #162](https://github.com/piotrwitek/typesafe-actions/issues/162)

### RxJS Testing

1. [A better approach for testing your Redux code](https://blog.henriquebarcelos.dev/a-better-approach-for-testing-your-redux-code-ck3dnpqnu00uro4s178b8aw3e)

1. [Marble testing with RxJS testing utils - You don’t need a third-party library for marble testing](https://medium.com/@kevinkreuzer/marble-testing-with-rxjs-testing-utils-3ae36ac3346a)

1. [Testing RxJS Code with Marble Diagrams](https://github.com/ReactiveX/rxjs/blob/6.5.4/docs_app/content/guide/testing/marble-testing.md)

1. [Extensive introduction to why and how you might want to use and test redux-observable](https://9oelm.github.io/2020-01-24--Fundamental-yet-extensive-introduction-to-why-and-how-you-might-want-to-use-redux-observable-for-async-actions/)

1. [Writing Better Marble Tests for Redux Observable and TypeScript](https://itnext.io/better-marble-test-70c7676a1e2)

### RxJS Operators

1. [RxJS recipes: ‘forkJoin’ with the progress of completion for bulk network requests in Angular](https://indepth.dev/forkjoin-with-the-progress-of-completion-for-bulk-network-requests-in-angular/)

1. [Handle multiple API requests in Angular using mergeMap and forkJoin to avoid nested subscriptions](https://levelup.gitconnected.com/handle-multiple-api-requests-in-angular-using-mergemap-and-forkjoin-to-avoid-nested-subscriptions-a20fb5040d0c)

1. [Fun with RxJS's groupBy](dataquarium.io/blog/fun-with-rxjs-groupby/)

1. [Here is what I’ve learn about groupBy operator by reading RxJS sources](https://medium.com/angular-in-depth/those-hidden-gotchas-within-rxjs-7d5c57406041)

## History

### master v0.9 (Sep 12, 2021)

1. ES Modules supported

  

### v0.7 (Jun 4, 2021)

#### BREAKING CHANGE

1. Change `HA_WECHATY_PUPPET_`~~${PROTOCOL}_~~`TOKEN` to `HA_WECHATY_PUPPET_TOKEN` for easy understanding and prevent mis-configuration.

### v0.4 (Jun 7, 2020)

[![Ducksify Extension](https://img.shields.io/badge/Redux-Ducksify%202020-yellowgreen)](https://github.com/huan/ducks#3-ducksify-extension-currying--ducksify-interface)

1. Work with [Ducks](https://github.com/huan/ducks)

1. High-available logics managed by RxJS (redux-observable epics)

1. Redux example at [examples/redux-ducks-bot/](examples/redux-ducks-bot/)

1. Ding Dong Bot example at [examples/ding-dong-bot.ts](examples/ding-dong-bot.ts)

### v0.0.1 (Apr 2020)

This module was originally design for the project [OSSChat](https://github.com/kaiyuanshe/osschat) [#58](https://github.com/kaiyuanshe/osschat/issues/58)

1. Publish the NPM module [ha-wechaty](https://www.npmjs.com/package/ha-wechaty)

## Author

[Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia)) zixia@zixia.net

[![Profile of Huan LI (李卓桓) on StackOverflow](https://stackexchange.com/users/flair/265499.png)](https://stackexchange.com/users/265499)

## Copyright & License

* Code & Docs © 2020 Huan LI \

* Code released under the Apache-2.0 License

* Docs released under Creative Commons

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/wechaty/ha

Awesome Lists containing this project

README