Wechaty v1.x API #125

huan · 2022-01-18T18:39:49Z

@padlocal I have upgraded the code base with the ES Module & Wechaty v1.x, please review and let me know what you think.

Thank you very much!

Related to:

huan · 2022-02-06T03:42:31Z

Have removed the ESM from this PR with the latest commits.

I hope we can upgrade to Wechaty v1 soon!

leochen-g · 2022-02-22T03:29:18Z

我把esm分支拉到本地跑了一下，发现安装依赖并没有问题，action 跑的时候可能是超时导致的失败。不过安装完依赖在运行npm run test 的时候，出现了一下报错，似乎是wechaty-puppet/types的引用存在问题，按照正常情况应该引用的是esm里的types，但是在运行test的时候查找的是cjs中的types

node环境：16.13.0
Mac

nvm use v16
Now using node v16.13.0 (npm v8.1.0)
➜  puppet-padlocal git:(esm) npm i
npm WARN deprecated @types/[email protected]: This is a stub types definition. quick-lru provides its own type definitions, so you do not need this installed.
npm WARN deprecated @hapi/[email protected]: Moved to 'npm install @sideway/pinpoint'
npm WARN deprecated @hapi/[email protected]: This version has been deprecated and is no longer supported or maintained
npm WARN deprecated [email protected]: this library is no longer supported
npm WARN deprecated @hapi/[email protected]: Moved to 'npm install @sideway/formula'
npm WARN deprecated @hapi/[email protected]: Moved to 'npm install @sideway/address'
npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
npm WARN deprecated @hapi/[email protected]: This version has been deprecated and is no longer supported or maintained
npm WARN deprecated [email protected]: Critical security vulnerability fixed in v0.21.1. For more information, see https://github.com/axios/axios/pull/3410
npm WARN deprecated @hapi/[email protected]: Switch to 'npm install joi'

added 1175 packages, and audited 1337 packages in 2m

7 packages are looking for funding
  run `npm fund` for details

13 vulnerabilities (8 moderate, 5 high)

To address all issues (including breaking changes), run:
  npm audit fix --force

Run `npm audit` for details.
➜  puppet-padlocal git:(esm) npm run test

> [email protected] test
> npm-run-all lint test:unit


> [email protected] lint
> npm-run-all lint:es lint:ts lint:md


> [email protected] lint:es
> eslint "src/**/*.ts" "tests/**/*.test.ts" --ignore-pattern tests/fixtures/

=============

WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.

You may find that it works just fine, or you may not.

SUPPORTED TYPESCRIPT VERSIONS: >=3.3.1 <4.5.0

YOUR TYPESCRIPT VERSION: 4.5.5

Please only submit bug reports when using the officially supported version.

=============

> [email protected] lint:ts
> tsc --isolatedModules --noEmit


> [email protected] lint:md
> markdownlint README.md


> [email protected] test:unit
> jest

WARNING: NODE_ENV value of 'test' did not match any deployment config file names.
WARNING: See https://github.com/lorenwest/node-config/wiki/Strict-Mode
WARNING: NODE_ENV value of 'test' did not match any deployment config file names.
WARNING: See https://github.com/lorenwest/node-config/wiki/Strict-Mode
 FAIL  tests/wechaty-api.test.ts
  ● Test suite failed to run

    Cannot find module 'wechaty-puppet/types' from 'node_modules/wechaty/dist/cjs/src/mods/mod.js'

    Require stack:
      node_modules/wechaty/dist/cjs/src/mods/mod.js
      tests/wechaty-api.test.ts

      at Resolver.resolveModule (node_modules/jest-resolve/build/resolver.js:324:11)
      at Object.<anonymous> (node_modules/wechaty/src/mods/mod.ts:39:1)

 FAIL  tests/wechaty-login.test.ts
  ● Test suite failed to run

    Cannot find module 'wechaty-puppet/types' from 'node_modules/wechaty/dist/cjs/src/mods/mod.js'

    Require stack:
      node_modules/wechaty/dist/cjs/src/mods/mod.js
      tests/wechaty-common.ts
      tests/wechaty-login.test.ts

      at Resolver.resolveModule (node_modules/jest-resolve/build/resolver.js:324:11)
      at Object.<anonymous> (node_modules/wechaty/src/mods/mod.ts:39:1)

 FAIL  tests/wechaty-push.test.ts
  ● Test suite failed to run

    Cannot find module 'wechaty-puppet/types' from 'node_modules/wechaty/dist/cjs/src/mods/mod.js'

    Require stack:
      node_modules/wechaty/dist/cjs/src/mods/mod.js
      tests/wechaty-push.test.ts

      at Resolver.resolveModule (node_modules/jest-resolve/build/resolver.js:324:11)
      at Object.<anonymous> (node_modules/wechaty/src/mods/mod.ts:39:1)


ReferenceError: You are trying to `import` a file after the Jest environment has been torn down. From tests/wechaty-api.test.ts.

      at node_modules/gifwrap/src/gifcodec.js:7:15

ReferenceError: You are trying to `import` a file after the Jest environment has been torn down. From tests/wechaty-push.test.ts.

      at node_modules/gifwrap/src/gifcodec.js:7:15

ReferenceError: You are trying to `import` a file after the Jest environment has been torn down. From tests/wechaty-login.test.ts.

      at node_modules/gifwrap/src/gifcodec.js:7:15
Test Suites: 3 failed, 3 total
Tests:       0 total
Snapshots:   0 total
Time:        5.557 s
Ran all test suites.
ERROR: "test:unit" exited with 1.

huan · 2022-02-22T04:11:33Z

Hi @leochen-g

Thank you very much for taking look at this PR!

The error messages you have posted is very wired because we can require wechaty without any problem with CLI:

$ node
Welcome to Node.js v16.13.2.
Type ".help" for more information.
> require('wechaty-puppet/types')
{
  ContactGender: [Getter],
  Contact: [Getter],
  FriendshipScene: [Getter],
  Friendship: [Getter],
  Image: [Getter],
  Message: [Getter],
  Post: [Getter],
  Tap: [Getter],
  Sayable: [Getter],
  Payload: [Getter],
  Dirty: [Getter],
  ScanStatus: [Getter],
  YOU: [Getter],
  CHAT_EVENT_DICT: [Getter],
  PUPPET_EVENT_DICT: [Getter]
}

So I added another minimum unit test that loads the wechaty and found that it can work without any problem, with tap runner:

$ ./tests/wechaty-login.spec.ts 
TAP version 13
# Subtest: smoke testing
    ok 1 - bot has created
    1..1
ok 1 - smoke testing # time=6.318ms

1..1
# time=17.664ms

Tap source code:

puppet-padlocal/tests/tap.spec.ts

Lines 1 to 10 in 593c615

    
           #!/usr/bin/env -S node -r ts-node/register 
        
           import { test } from "tstest"; 
        
           import * as WECHATY from "wechaty"; 
        
           test("smoke testing", async t => { 
        
             const bot = WECHATY.WechatyBuilder.build(); 
        
             t.ok(bot, "bot has created"); 
        
           });

So I guess the problem might relate to the jest test runner?

Not sure about it but hope the above information could be helpful for the future investigating.

leochen-g · 2022-02-22T06:33:03Z

@huan 有点不太明白哈，就是现在1.x版本使用的应该是esm的导入方式引入包，但是我看报错，引入的wechaty是cjs的，这个是不是不太对，packages.json 里我看并没有type: 'module' ,其他puppet里我看是有这个配置的，会和这个有关系吗

huan · 2022-02-22T06:40:55Z

现在1.x版本使用的应该是esm的导入方式引入包

This is partially correct.

The 1.x version of Wechaty is built with a Dual-ESM-CJS pattern, which means that when it is loaded by an ESM module then it will be an ESM module, otherwise when it is loaded by a CJS module then it will be a CJS module.

When the Wechaty is loading by the correct version of the wechaty-puppet-padlocal (which is a CJS module), then it will act as a CJS module and be loaded as CJS.

但是我看报错，引入的wechaty是cjs的，这个是不是不太对

This is expected.

According to my above explanation: when the CJS wechaty-puppet-padlocal load the wechaty, the wechaty will be in CJS mode.

packages.json 里我看并没有type: 'module'

If the package.json specifies a type: 'module', then it means that the current module is ESM.

wechaty-puppet-padlocal has no type: 'module' so it's a CJS

其他puppet里我看是有这个配置的

wechaty, wechaty-puppet, and other Wechaty ecosystem modules have 'type: 'module' by default, which means that they are ESM modules.

And we have enabled the Dual-ESM-CJS for them when they have been built, so they can be used either by ESM or CJS.

I hope my explanations help you understand the situation, please feel free to let me know if you have more questions.

leochen-g · 2022-02-22T06:43:25Z

好的谢谢解惑我再研究一下

huan · 2022-02-22T06:44:36Z

@leochen-g You are welcome!

wechaty/puppet#160

whyour · 2022-05-11T04:58:48Z

any progress?

huan · 2022-05-11T16:18:38Z

Finally! Congratulations! 🎉

huan added 8 commits January 19, 2022 02:38

ES Module & Wechaty v1.x API

83aa331

clean

2597f27

0.4.3

53b8463

code clean

1c1cbde

0.4.4

c667c53

v1.11

e75733e

1.11.2

89082a9

fix typo

892dfd4

huan requested a review from padlocal January 18, 2022 18:46

1.11.3

9a10bbe

huan mentioned this pull request Jan 19, 2022

Support ESM module (Dual-ESM-CJS-module) Chatie/tsconfig#16

Open

49 tasks

willin mentioned this pull request Jan 19, 2022

Is there a plan to support latest wechaty version? #129

Closed

huan mentioned this pull request Jan 21, 2022

Upgrade to Wechaty v1.x API chatrbot/wechaty-puppet-simplepad#8

Open

huan added 7 commits January 23, 2022 22:12

fix some esm for running dmeo

bf32dd5

fix linting

d38445a

1.11.4

d1874bd

disable ESM

c7a8be5

1.11.5

beb8a48

add resolver and fix tsconfig

9e89549

1.11.6

81a87a4

huan changed the title ~~ES Module & Wechaty v1.x API~~ Wechaty v1.x API Feb 6, 2022

huan added 2 commits February 22, 2022 12:08

add a runnable tap unit test (#125)

94ede06

1.11.7

593c615

huan mentioned this pull request Apr 8, 2022

Add a CLI: wechaty wechaty/wechaty#2349

Closed

padlocal added 15 commits April 28, 2022 23:58

adapt to new Wechaty api changes

285ef67

update jest version, to make test works

ea90997

Fix issue #115

2190ddf

fix bug #112

0c0770b

fix bug #91

2900d0e

fix bug #102

0e8456c

fix bug #99

2b54aee

Adapt to Wechaty puppet API V1.x.

9e2ce61

wechaty/puppet#160

fix bug #101

740706b

upgrade to esm and cjs dual module

7fa2839

use package version as puppet padlocal version

8c94c14

fix lint issue

d08f5b1

1.11.8

154b49c

add smoke test scripts for github actions

6a6a6ca

1.11.9

ce77749

padlocal added 8 commits May 11, 2022 22:35

update demo code

06ab87f

update emoticon message FileBox data structure.

1dbe549

1.11.10

10842a8

fix exception raised by url message without thumb

4588008

fix github action error caused by eslint

e2e4f0f

1.11.11

bdc8c0b

set timeout up to 60 secs for smoke test

d287740

1.11.12

f43b369

padlocal approved these changes May 11, 2022

View reviewed changes

padlocal merged commit 13fe8ba into main May 11, 2022

padlocal deleted the esm branch May 11, 2022 16:17

huan mentioned this pull request May 18, 2022

Upgrade Wechaty Puppet PadLocal to v1.x kaiyuanshe/osschat#209

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wechaty v1.x API #125

Wechaty v1.x API #125

huan commented Jan 18, 2022 •

edited

Loading

huan commented Feb 6, 2022

leochen-g commented Feb 22, 2022 •

edited

Loading

huan commented Feb 22, 2022 •

edited

Loading

leochen-g commented Feb 22, 2022

huan commented Feb 22, 2022 •

edited

Loading

leochen-g commented Feb 22, 2022

huan commented Feb 22, 2022

whyour commented May 11, 2022

huan commented May 11, 2022

Wechaty v1.x API #125

Wechaty v1.x API #125

Conversation

huan commented Jan 18, 2022 • edited Loading

huan commented Feb 6, 2022

leochen-g commented Feb 22, 2022 • edited Loading

huan commented Feb 22, 2022 • edited Loading

leochen-g commented Feb 22, 2022

huan commented Feb 22, 2022 • edited Loading

leochen-g commented Feb 22, 2022

huan commented Feb 22, 2022

whyour commented May 11, 2022

huan commented May 11, 2022

huan commented Jan 18, 2022 •

edited

Loading

leochen-g commented Feb 22, 2022 •

edited

Loading

huan commented Feb 22, 2022 •

edited

Loading

huan commented Feb 22, 2022 •

edited

Loading