@juzi/wechaty-puppet-service 1.0.0

package/dist/esm/tests/performance.spec.d.ts

@@ -0,0 +1,14 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+/**
+ * Software performance testing
+ *  https://en.wikipedia.org/wiki/Software_performance_testing#Testing_types
+ *
+ * 负载测试，并发测试和压力测试，这三者之前的区别和联系？
+ *  https://www.zhihu.com/question/269215477/answer/350162604
+ *
+ * NodeJS: How Is Logging Enabled for the @grpc/grpc.js Package
+ *  https://stackoverflow.com/a/60935367/1123955
+ *    GRPC_VERBOSITY=DEBUG GRPC_TRACE=all
+ */
+export {};
+//# sourceMappingURL=performance.spec.d.ts.map

package/dist/esm/tests/performance.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.spec.d.ts","sourceRoot":"","sources":["../../../tests/performance.spec.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;GAUG"}

package/dist/esm/tests/performance.spec.js

@@ -0,0 +1,104 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+/**
+ * Software performance testing
+ *  https://en.wikipedia.org/wiki/Software_performance_testing#Testing_types
+ *
+ * 负载测试，并发测试和压力测试，这三者之前的区别和联系？
+ *  https://www.zhihu.com/question/269215477/answer/350162604
+ *
+ * NodeJS: How Is Logging Enabled for the @grpc/grpc.js Package
+ *  https://stackoverflow.com/a/60935367/1123955
+ *    GRPC_VERBOSITY=DEBUG GRPC_TRACE=all
+ */
+import { test, sinon, } from 'tstest';
+import * as PUPPET from '@juzi/wechaty-puppet';
+import { PuppetMock, } from 'wechaty-puppet-mock';
+import { PuppetService, PuppetServer, } from '../src/mod.js';
+import { log } from '../src/config.js';
+const idToName = (id) => {
+    return `name of ${id}`;
+};
+class PuppetTest extends PuppetMock {
+    constructor(...args) {
+        super(...args);
+    }
+    async contactRawPayload(id) {
+        log.verbose('PuppetTest', 'contactRawPayload(%s)', id);
+        const rawPayload = {
+            avatar: '',
+            gender: PUPPET.types.ContactGender.Male,
+            id,
+            name: idToName(id),
+            phone: [],
+            type: PUPPET.types.Contact.Individual,
+        };
+        await new Promise(resolve => {
+            process.stdout.write(',');
+            setTimeout(() => {
+                process.stdout.write('.');
+                resolve();
+            }, 1000);
+        });
+        return rawPayload;
+    }
+}
+test.skip('stress testing', async (t) => {
+    const TOKEN = 'test_token';
+    const ENDPOINT = '0.0.0.0:8788';
+    // const DING     = 'ding_data'
+    /**
+     * Puppet in Service
+     */
+    const puppet = new PuppetTest();
+    const spy = sinon.spy(puppet, 'contactRawPayload');
+    /**
+     * Puppet Server
+     */
+    const serverOptions = {
+        endpoint: ENDPOINT,
+        puppet: puppet,
+        token: TOKEN,
+    };
+    const puppetServer = new PuppetServer(serverOptions);
+    await puppetServer.start();
+    /**
+     * Puppet Service Client
+     */
+    const puppetOptions = {
+        endpoint: ENDPOINT,
+        token: TOKEN,
+    };
+    const puppetService = new PuppetService(puppetOptions);
+    await puppetService.start();
+    let COUNTER = 0;
+    const dongList = [];
+    puppetService.on('dong', payload => {
+        dongList.push(payload.data || '');
+    });
+    const timer = setInterval(() => {
+        puppetService.ding(`interval ${COUNTER++}`);
+    }, 10);
+    const CONCURRENCY = 1000;
+    const concurrencyList = [
+        ...Array(CONCURRENCY).keys(),
+    ].map(String);
+    const resultList = await Promise.all(concurrencyList.map(id => puppetService.contactPayload(id)));
+    console.info();
+    clearInterval(timer);
+    const actualNameList = resultList.map(payload => payload.name);
+    const EXPECTED_RESULT_LIST = concurrencyList.map(idToName);
+    t.equal(spy.callCount, CONCURRENCY, `should be called ${CONCURRENCY} times`);
+    t.same(actualNameList, EXPECTED_RESULT_LIST, `should get the right result with a huge concurrency ${CONCURRENCY}`);
+    t.ok(dongList.length > 10, `dongList should receive many dong data (actual: ${dongList.length})`);
+    t.equal(dongList[0], 'interval 0', 'dongList should get the first response from counter 0');
+    /**
+     * Stop
+     *  1. Puppet in Service
+     *  2. Puppet Service Server
+     *  3. Puppet Service Client
+     *
+     */
+    await puppetService.stop();
+    await puppetServer.stop();
+});
+//# sourceMappingURL=performance.spec.js.map

package/dist/esm/tests/performance.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.spec.js","sourceRoot":"","sources":["../../../tests/performance.spec.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,IAAI,EACJ,KAAK,GACN,MAAkB,QAAQ,CAAA;AAE3B,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAA;AAE9C,OAAO,EACL,UAAU,GACX,MAA8B,qBAAqB,CAAA;AAEpD,OAAO,EACL,aAAa,EACb,YAAY,GAEb,MAAoC,eAAe,CAAA;AAEpD,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAE;IAC9B,OAAO,WAAW,EAAE,EAAE,CAAA;AACxB,CAAC,CAAA;AAED,MAAM,UAAW,SAAQ,UAAU;IAEjC,YAAa,GAAG,IAAW;QACzB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;IAChB,CAAC;IAEQ,KAAK,CAAC,iBAAiB,CAAE,EAAU;QAC1C,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,uBAAuB,EAAE,EAAE,CAAC,CAAA;QACtD,MAAM,UAAU,GAA4B;YAC1C,MAAM,EAAG,EAAE;YACX,MAAM,EAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI;YACxC,EAAE;YACF,IAAI,EAAG,QAAQ,CAAC,EAAE,CAAC;YACnB,KAAK,EAAE,EAAE;YACT,IAAI,EAAK,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU;SACzC,CAAA;QAED,MAAM,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;YAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACzB,UAAU,CAAC,GAAG,EAAE;gBACd,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACzB,OAAO,EAAE,CAAA;YACX,CAAC,EAAE,IAAI,CAAC,CAAA;QACV,CAAC,CAAC,CAAA;QAEF,OAAO,UAAU,CAAA;IACnB,CAAC;CAEF;AAED,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpC,MAAM,KAAK,GAAM,YAAY,CAAA;IAC7B,MAAM,QAAQ,GAAG,cAAc,CAAA;IAC/B,+BAA+B;IAE/B;;OAEG;IACH,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;IAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;IAElD;;OAEG;IACH,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAG,QAAQ;QACnB,MAAM,EAAK,MAAa;QACxB,KAAK,EAAM,KAAK;KACM,CAAA;IAExB,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAA;IACpD,MAAM,YAAY,CAAC,KAAK,EAAE,CAAA;IAE1B;;OAEG;IACH,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAG,QAAQ;QACnB,KAAK,EAAM,KAAK;KACO,CAAA;IAEzB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,aAAa,CAAC,CAAA;IACtD,MAAM,aAAa,CAAC,KAAK,EAAE,CAAA;IAE3B,IAAI,OAAO,GAAG,CAAC,CAAA;IACf,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACjC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;QAC7B,aAAa,CAAC,IAAI,CAAC,YAAY,OAAO,EAAE,EAAE,CAAC,CAAA;IAC7C,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,MAAM,WAAW,GAAG,IAAI,CAAA;IACxB,MAAM,eAAe,GAAG;QACtB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE;KAC7B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAEb,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,eAAe,CAAC,GAAG,CACjB,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC,CACvC,CACF,CAAA;IACD,OAAO,CAAC,IAAI,EAAE,CAAA;IAEd,aAAa,CAAC,KAAK,CAAC,CAAA;IAEpB,MAAM,cAAc,GAAS,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,oBAAoB,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAE1D,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,oBAAoB,WAAW,QAAQ,CAAC,CAAA;IAC5E,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,oBAAoB,EAAE,uDAAuD,WAAW,EAAE,CAAC,CAAA;IAElH,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,GAAG,EAAE,EAAE,mDAAmD,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAA;IACjG,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,uDAAuD,CAAC,CAAA;IAE3F;;;;;;OAMG;IACH,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAC1B,MAAM,YAAY,CAAC,IAAI,EAAE,CAAA;AAC3B,CAAC,CAAC,CAAA"}

package/dist/esm/tests/ready-event.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=ready-event.spec.d.ts.map

package/dist/esm/tests/ready-event.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ready-event.spec.d.ts","sourceRoot":"","sources":["../../../tests/ready-event.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/ready-event.spec.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest';
+import PuppetMock from 'wechaty-puppet-mock';
+import getPort from 'get-port';
+import PuppetService, { PuppetServer, } from '../src/mod.js';
+const NIL_UUID_V4 = '00000000-0000-0000-0000-000000000000';
+test('ready event test', async (t) => {
+    const PORT = await getPort();
+    const TOKEN = `insecure_${NIL_UUID_V4}`;
+    const ENDPOINT = `0.0.0.0:${PORT}`;
+    /**
+     * Puppet Server
+     */
+    const puppet = new PuppetMock();
+    // set ready to true before service starts
+    puppet.readyIndicator.value(true);
+    puppet.__currentUserId = 'logged in';
+    const serverOptions = {
+        endpoint: ENDPOINT,
+        puppet: puppet,
+        token: TOKEN,
+    };
+    const puppetServer = new PuppetServer(serverOptions);
+    await puppetServer.start();
+    /**
+     * Puppet Service Client
+     */
+    const puppetOptions = {
+        endpoint: ENDPOINT,
+        token: TOKEN,
+    };
+    // check if ready event is emited on this ready-ed puppet
+    const puppetService = new PuppetService(puppetOptions);
+    const eventList = [];
+    const loginFuture = new Promise(resolve => puppetService.once('login', () => {
+        eventList.push('login');
+        resolve();
+    }));
+    const readyFuture = new Promise(resolve => puppetService.once('ready', () => {
+        eventList.push('ready');
+        resolve();
+    }));
+    await Promise.all([
+        puppetService.start(),
+        loginFuture,
+        readyFuture,
+    ]);
+    t.same(eventList, ['login', 'ready'], 'should have `login` event first then `ready`');
+    await puppetService.stop();
+    await puppetServer.stop();
+});
+//# sourceMappingURL=ready-event.spec.js.map

package/dist/esm/tests/ready-event.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ready-event.spec.js","sourceRoot":"","sources":["../../../tests/ready-event.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAI7B,OAAO,UAAU,MAAM,qBAAqB,CAAA;AAC5C,OAAO,OAAO,MAAM,UAAU,CAAA;AAE9B,OAAO,aAAa,EAAE,EACpB,YAAY,GAEb,MAAM,eAAe,CAAA;AAEtB,MAAM,WAAW,GAAG,sCAAsC,CAAA;AAE1D,IAAI,CAAC,kBAAkB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjC,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAA;IAC5B,MAAM,KAAK,GAAG,YAAY,WAAW,EAAE,CAAA;IACvC,MAAM,QAAQ,GAAG,WAAW,IAAI,EAAE,CAAA;IAElC;;OAEG;IACH,MAAM,MAAM,GAAG,IAAI,UAAU,EAAS,CAAA;IAEtC,0CAA0C;IAC1C,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAChC;IAAC,MAAc,CAAC,eAAe,GAAG,WAAW,CAAA;IAC9C,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;KACU,CAAA;IAExB,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAA;IAEpD,MAAM,YAAY,CAAC,KAAK,EAAE,CAAA;IAE1B;;OAEG;IACH,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,KAAK;KACI,CAAA;IAElB,yDAAyD;IACzD,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,aAAa,CAAC,CAAA;IACtD,MAAM,SAAS,GAAU,EAAE,CAAA;IAE3B,MAAM,WAAW,GAAG,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;QAChF,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,EAAE,CAAA;IACX,CAAC,CAAC,CAAC,CAAA;IACH,MAAM,WAAW,GAAG,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;QAChF,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,EAAE,CAAA;IACX,CAAC,CAAC,CAAC,CAAA;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,aAAa,CAAC,KAAK,EAAE;QACrB,WAAW;QACX,WAAW;KACZ,CAAC,CAAA;IAEF,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,8CAA8C,CAAC,CAAA;IAErF,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAC1B,MAAM,YAAY,CAAC,IAAI,EAAE,CAAA;AAC3B,CAAC,CAAC,CAAA"}

package/dist/esm/tests/uuid-file-box.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=uuid-file-box.spec.d.ts.map

package/dist/esm/tests/uuid-file-box.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid-file-box.spec.d.ts","sourceRoot":"","sources":["../../../tests/uuid-file-box.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/uuid-file-box.spec.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest';
+import * as path from 'path';
+import * as fs from 'fs';
+import PuppetMock from 'wechaty-puppet-mock';
+import getPort from 'get-port';
+import temp from 'temp';
+import { FileBox } from 'file-box';
+import PuppetService, { PuppetServer } from '../src/mod.js';
+const NIL_UUID_V4 = '00000000-0000-0000-0000-000000000000';
+const __dirname = path.resolve();
+test('message file test', async (t) => {
+    const PORT = await getPort();
+    const TOKEN = `insecure_${NIL_UUID_V4}`;
+    const ENDPOINT = `0.0.0.0:${PORT}`;
+    const FILE = path.join(__dirname, 'tests', 'fixtures', 'smoke-testing.ts');
+    const EXPECTED_SIZE = fs.statSync(FILE).size;
+    /**
+     * Puppet Server
+     */
+    const puppet = new PuppetMock();
+    puppet.messageFile = async () => FileBox.fromFile(FILE);
+    const serverOptions = {
+        endpoint: ENDPOINT,
+        puppet: puppet,
+        token: TOKEN,
+    };
+    const puppetServer = new PuppetServer(serverOptions);
+    await puppetServer.start();
+    /**
+     * Puppet Service Client
+     */
+    const puppetOptions = {
+        endpoint: ENDPOINT,
+        token: TOKEN,
+    };
+    const puppetService = new PuppetService(puppetOptions);
+    await puppetService.start();
+    const file = await puppetService.messageFile('sb');
+    const tmpFolder = temp.mkdirSync('test');
+    const tmpFile = path.join(tmpFolder, 'uuid-file.dat');
+    await file.toFile(tmpFile);
+    const fileSize = fs.statSync(tmpFile).size;
+    t.equal(fileSize, EXPECTED_SIZE, 'should save file with the correct size');
+    fs.rmSync(tmpFile);
+    await puppetService.stop();
+    await puppetServer.stop();
+});
+//# sourceMappingURL=uuid-file-box.spec.js.map

package/dist/esm/tests/uuid-file-box.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid-file-box.spec.js","sourceRoot":"","sources":["../../../tests/uuid-file-box.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,IAAI,EAAE,MAAsB,QAAQ,CAAA;AAC7C,OAAO,KAAK,IAAI,MAAqB,MAAM,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAuB,IAAI,CAAA;AAEzC,OAAO,UAAU,MAAoB,qBAAqB,CAAA;AAC1D,OAAO,OAAO,MAAuB,UAAU,CAAA;AAC/C,OAAO,IAAI,MAA0B,MAAM,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAmB,UAAU,CAAA;AAE/C,OAAO,aAAa,EAAE,EAAE,YAAY,EAAuB,MAAM,eAAe,CAAA;AAEhF,MAAM,WAAW,GAAG,sCAAsC,CAAA;AAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;AAEhC,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAClC,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAA;IAC5B,MAAM,KAAK,GAAG,YAAY,WAAW,EAAE,CAAA;IACvC,MAAM,QAAQ,GAAG,WAAW,IAAI,EAAE,CAAA;IAElC,MAAM,IAAI,GAAY,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAA;IACnF,MAAM,aAAa,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAA;IAE5C;;OAEG;IACH,MAAM,MAAM,GAAG,IAAI,UAAU,EAAS,CAAA;IACtC,MAAM,CAAC,WAAW,GAAG,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAEvD,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;KACU,CAAA;IAExB,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAA;IACpD,MAAM,YAAY,CAAC,KAAK,EAAE,CAAA;IAE1B;;OAEG;IACH,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,KAAK;KACI,CAAA;IAElB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,aAAa,CAAC,CAAA;IACtD,MAAM,aAAa,CAAC,KAAK,EAAE,CAAA;IAE3B,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAElD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IACxC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAAA;IAErD,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC1B,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAA;IAE1C,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,EAAE,wCAAwC,CAAC,CAAA;IAE1E,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAClB,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAC1B,MAAM,YAAY,CAAC,IAAI,EAAE,CAAA;AAC3B,CAAC,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@juzi/wechaty-puppet-service",
+  "version": "1.0.0",
+  "description": "Puppet Service for Wechaty",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "typings": "./dist/esm/src/mod.d.ts",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=7"
+  },
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "clean": "shx rm -fr dist/*",
+    "dist": "npm-run-all clean build dist:commonjs",
+    "dist:commonjs": "jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json",
+    "lint": "npm-run-all lint:es lint:ts lint:md",
+    "lint:md": "markdownlint README.md",
+    "lint:ts": "tsc --isolatedModules --noEmit",
+    "start": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/ding-dong-bot.ts",
+    "test": "npm run lint && npm run test:unit",
+    "test:pack": "bash -x scripts/npm-pack-testing.sh",
+    "test:unit": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" TAP_TIMEOUT=60 tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
+    "lint:es": "eslint --ignore-pattern fixtures/ \"src/**/*.ts\" \"tests/**/*.ts\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/juzibot/wechaty-puppet-service.git"
+  },
+  "keywords": [
+    "chatie",
+    "wechaty",
+    "chatbot",
+    "bot",
+    "grpc",
+    "wechat",
+    "sdk"
+  ],
+  "author": "Huan LI <zixia@zixia.net>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/juzibot/wechaty-puppet-service/issues"
+  },
+  "homepage": "https://github.com/juzibot/wechaty-puppet-service#readme",
+  "devDependencies": {
+    "@chatie/eslint-config": "^1.0.4",
+    "@chatie/semver": "^0.4.7",
+    "@chatie/tsconfig": "^4.6.3",
+    "@types/google-protobuf": "^3.15.5",
+    "@types/lru-cache": "^7.5.0",
+    "@types/semver": "^7.3.9",
+    "@types/temp": "^0.9.1",
+    "@types/uuid": "^8.3.4",
+    "@types/ws": "^8.5.3",
+    "get-port": "^6.1.2",
+    "temp": "^0.9.4",
+    "typed-emitter": "^1.5.0-from-event",
+    "utility-types": "^3.10.0",
+    "wechaty-puppet-mock": "^1.18.2",
+    "why-is-node-running": "^2.2.1"
+  },
+  "peerDependencies": {
+    "@juzi/wechaty-puppet": "1.0.0"
+  },
+  "dependencies": {
+    "clone-class": "^1.1.1",
+    "ducks": "^1.0.2",
+    "file-box": "^1.5.5",
+    "flash-store": "^1.3.4",
+    "gerror": "^1.0.16",
+    "redux-observable": "^2.0.0",
+    "rxjs": "^7.5.5",
+    "semver": "^7.3.5",
+    "stronger-typed-streams": "^0.2.0",
+    "uuid": "^8.3.2",
+    "@juzi/wechaty-grpc": "1.0.0",
+    "wechaty-redux": "^1.20.2",
+    "wechaty-token": "^1.0.6"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "src/"
+  ],
+  "tap": {
+    "check-coverage": false
+  }
+}

package/src/auth/README.md

@@ -0,0 +1,10 @@
+# Auth for Wechaty Puppet Service gRPC
+
+1. OpenSSL CA generation script: <https://github.com/wechaty/dotenv/blob/main/ca/generate.sh>
+1. Common Name (CN) is very important because it will be used as Server Name Indication (SNI) in TLS handshake.
+
+## Monkey Patch
+
+We need to copy http2 header `:authority` to metadata.
+
+See: <monkey-patch-header-authorization.ts>

package/src/auth/auth-impl-token.spec.ts

@@ -0,0 +1,81 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import {
+  test,
+  sinon,
+}         from 'tstest'
+
+import {
+  GrpcStatus,
+  Metadata,
+  UntypedServiceImplementation,
+}                                   from './grpc-js.js'
+
+import { authImplToken } from './auth-impl-token.js'
+
+test('authImplToken()', async t => {
+  const sandbox = sinon.createSandbox()
+  const spy = sandbox.spy()
+
+  const TOKEN = 'UUIDv4'
+  const IMPL: UntypedServiceImplementation = {
+    spy,
+  }
+
+  const implWithAuth = authImplToken(TOKEN)(IMPL)
+  const validMetadata = new Metadata()
+  validMetadata.add('Authorization', 'Wechaty ' + TOKEN)
+
+  const TEST_LIST = [
+    { // Valid Token Request
+      call: {
+        metadata: validMetadata,
+      } as any,
+      callback: sandbox.spy(),
+      ok: true,
+    },
+    { // Invalid request for Callback
+      call: {
+        metadata: new Metadata(),
+      } as any,
+      callback: sandbox.spy(),
+      ok: false,
+    },
+    { // Invalid request for Stream
+      call: {
+        emit: sandbox.spy(),
+        metadata: new Metadata(),
+      } as any,
+      callback: undefined,
+      ok: false,
+    },
+  ] as const
+
+  const method = implWithAuth['spy']!
+
+  for (const { call, callback, ok } of TEST_LIST) {
+    spy.resetHistory()
+
+    method(call, callback as any)
+
+    if (ok) {
+      t.ok(spy.calledOnce, 'should call IMPL handler')
+      continue
+    }
+
+    /**
+      * not ok
+      */
+    t.ok(spy.notCalled, 'should not call IMPL handler')
+    if (callback) {
+      t.equal(callback.args[0]![0].code, GrpcStatus.UNAUTHENTICATED, 'should return UNAUTHENTICATED')
+    } else {
+      t.equal(call.emit.args[0][0], 'error', 'should emit error')
+      t.equal(call.emit.args[0][1].code, GrpcStatus.UNAUTHENTICATED, 'should emit UNAUTHENTICATED')
+    }
+
+    // console.info(spy.args)
+    // console.info(callback?.args)
+  }
+  sandbox.restore()
+})

package/src/auth/auth-impl-token.ts

@@ -0,0 +1,108 @@
+import { log } from '@juzi/wechaty-puppet'
+
+import {
+  StatusBuilder,
+  UntypedHandleCall,
+  sendUnaryData,
+  Metadata,
+  ServerUnaryCall,
+  GrpcStatus,
+  UntypedServiceImplementation,
+}                                 from './grpc-js.js'
+
+import { monkeyPatchMetadataFromHttp2Headers }  from './mokey-patch-header-authorization.js'
+
+/**
+ * Huan(202108): Monkey patch to support
+ *  copy `:authority` from header to metadata
+ */
+monkeyPatchMetadataFromHttp2Headers(Metadata)
+
+/**
+ * Huan(202108): wrap handle calls with authorization
+ *
+ * See:
+ *  https://grpc.io/docs/guides/auth/#with-server-authentication-ssltls-and-a-custom-header-with-token
+ */
+const authWrapHandlerToken = (validToken: string) => (handler: UntypedHandleCall) => {
+  log.verbose('wechaty-puppet-service',
+    'auth/auth-impl-token.ts authWrapHandlerToken(%s)(%s)',
+    validToken,
+    handler.name,
+  )
+
+  return function (
+    call: ServerUnaryCall<any, any>,
+    cb?: sendUnaryData<any>,
+  ) {
+    // console.info('wrapAuthHandler internal')
+
+    const authorization = call.metadata.get('authorization')[0]
+    // console.info('authorization', authorization)
+
+    let errMsg = ''
+    if (typeof authorization === 'string') {
+      if (authorization.startsWith('Wechaty ')) {
+        const token = authorization.substring(8 /* 'Wechaty '.length */)
+        if (token === validToken) {
+
+          return handler(
+            call as any,
+            cb as any,
+          )
+
+        } else {
+          errMsg = `Invalid Wechaty TOKEN "${token}"`
+        }
+      } else {
+        const type = authorization.split(/\s+/)[0]
+        errMsg = `Invalid authorization type: "${type}"`
+      }
+    } else {
+      errMsg = 'No Authorization found.'
+    }
+
+    /**
+     * Not authorized
+     */
+    const error = new StatusBuilder()
+      .withCode(GrpcStatus.UNAUTHENTICATED)
+      .withDetails(errMsg)
+      .withMetadata(call.metadata)
+      .build()
+
+    if (cb) {
+      /**
+        * Callback:
+        *  handleUnaryCall
+        *  handleClientStreamingCall
+        */
+      cb(error)
+    } else if ('emit' in call) {
+      /**
+        * Stream:
+        *  handleServerStreamingCall
+        *  handleBidiStreamingCall
+        */
+      call.emit('error', error)
+    } else {
+      throw new Error('no callback and call is not emit-able')
+    }
+  }
+}
+
+const authImplToken = <T extends UntypedServiceImplementation>(validToken: string) => (
+  serviceImpl: T,
+) => {
+  log.verbose('wechaty-puppet-service', 'authImplToken()')
+
+  for (const [key, val] of Object.entries(serviceImpl)) {
+    // any: https://stackoverflow.com/q/59572522/1123955
+    (serviceImpl as any)[key] = authWrapHandlerToken(validToken)(val)
+  }
+  return serviceImpl
+}
+
+export {
+  authImplToken,
+}

package/src/auth/ca.spec.ts

@@ -0,0 +1,116 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import {
+  test,
+}         from 'tstest'
+
+import https from 'https'
+
+import * as envVar  from './env-vars.js'
+import type { AddressInfo } from 'ws'
+
+import {
+  TLS_CA_CERT,
+  TLS_INSECURE_SERVER_CERT_COMMON_NAME,
+  TLS_INSECURE_SERVER_CERT,
+  TLS_INSECURE_SERVER_KEY,
+}                                         from './ca.js'
+
+test('CA smoke testing', async t => {
+
+  const ca   = envVar.WECHATY_PUPPET_SERVICE_TLS_CA_CERT() || TLS_CA_CERT
+  const cert = envVar.WECHATY_PUPPET_SERVICE_TLS_SERVER_CERT() || TLS_INSECURE_SERVER_CERT
+  const key  = envVar.WECHATY_PUPPET_SERVICE_TLS_SERVER_KEY() || TLS_INSECURE_SERVER_KEY
+
+  const server = https.createServer({
+    cert,
+    key,
+  })
+
+  const ALIVE = 'Alive!\n'
+
+  server.on('request', (_req, res) => {
+    res.writeHead(200)
+    res.end(ALIVE)
+  })
+
+  server.listen()
+  const port = (server.address() as AddressInfo).port
+
+  const reply = await new Promise((resolve, reject) => {
+    https.request({
+      ca,
+      hostname: '127.0.0.1',
+      method: 'GET',
+      path: '/',
+      port,
+      servername: TLS_INSECURE_SERVER_CERT_COMMON_NAME,
+    }, res => {
+      res.on('data', chunk => resolve(chunk.toString()))
+      res.on('error', reject)
+    }).end()
+  })
+  server.close()
+
+  t.equal(reply, ALIVE, 'should get https server reply')
+})
+
+test('CA SNI tests', async t => {
+
+  const ca   = envVar.WECHATY_PUPPET_SERVICE_TLS_CA_CERT()      || TLS_CA_CERT
+  const cert = envVar.WECHATY_PUPPET_SERVICE_TLS_SERVER_CERT()  || TLS_INSECURE_SERVER_CERT
+  const key  = envVar.WECHATY_PUPPET_SERVICE_TLS_SERVER_KEY()   || TLS_INSECURE_SERVER_KEY
+
+  const server = https.createServer({
+    cert,
+    key,
+  })
+
+  server.on('request', (_req, res) => {
+    res.writeHead(200)
+    res.end(ALIVE)
+  })
+
+  server.listen()
+  const port = (server.address() as AddressInfo).port
+
+  const ALIVE = 'Alive!\n'
+  const SNI_TEST_LIST = [
+    [
+      TLS_INSECURE_SERVER_CERT_COMMON_NAME,
+      true,
+    ],
+    [
+      'invalid-sni',
+      false,
+      "Hostname/IP does not match certificate's altnames: Host: invalid-sni. is not cert's CN: insecure",
+    ],
+  ] as const
+
+  for (const [SNI, EXPECT, MSG] of SNI_TEST_LIST) {
+    const result = await new Promise((resolve, reject) => {
+      https.request({
+        ca,
+        hostname: '127.0.0.1',
+        method: 'GET',
+        path: '/',
+        port,
+        servername: SNI,
+      }, res => {
+        res.on('data', chunk => resolve(chunk.toString() === ALIVE))
+        res.on('error', reject)
+      })
+        .on('error', e => {
+          // console.info(e.message)
+          t.equal(e.message, MSG, 'should get the error for invalid SNI: ' + SNI)
+          resolve(false)
+        })
+        .end()
+
+    })
+
+    t.equal(result, EXPECT, 'should check the SNI: ' + SNI)
+  }
+
+  server.close()
+})