基于5G消息的 Wechaty Puppet 模块设计与实现

[su-chang]

背景信息

Wechaty 社区目前已经支持微信、Whatsapp、企业微信、飞书等常见流行即时通讯工具。

5G Chatbot (RCS) 是近期中国电信运营商基于 5G 的消息战略落地平台，未来的 5G 手机将会内置 RCS 消息的处理能力。

为了使 Wechaty 用户也能便捷的使用 5G 消息，需要开发对应的 puppet 接入模块。

项目目标

在句子互动实习期间，希望能将完成以下目标：

• 梳理 5G 消息所有功能模块
• 结合 wechaty-puppet 的接口分析 5G 消息并进行匹配
• 丰富 wechaty-puppet-walnut 功能
• 测试 wechaty-puppet-walnut 的稳定性

最终能够使其成为 Wechaty 可以使用的社区生态模块。

项目要求

• 每周一次视频会议
  • 介绍本周的工作进度
  • 梳理当前遇到问题难点（最好提前发好 issue，便于讨论）
• 工作期间的代码进展均需体现在 github 中
  • 开发功能的 commit，参见 Git提交规范
  • 问题点及解决方案的 issue

导师信息

• 姓名：苏畅
• 手机号：13126768525
• github：https://github.com/su-chang

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2021-11-21

本周完成的成果

1. 接口文档的梳理和分类
2. 支持富文本和CSS样式的消息
3. 地图消息的接收和发送

本周遇到的困难和需要配合的地方

1. 5g平台回调接口鉴权问题 👉 https://github.com/fabian4/puppet-5G/issues/1
2. 撤回的消息的显示问题 👉 https://github.com/fabian4/puppet-5G/issues/2

下周的开发计划和预计成果

1. 熟悉 wechaty 的接口api
2. 消息模块的拆分
3. 项目模块的开发

[su-chang]

• 5g平台回调接口鉴权问题
• 撤回的消息的显示问题

可以把相关的issue链接到这里

[Bibabo-BUPT]

日期：2021年11月21日 本周完成的成果：

• 学习了解部分Wechaty API接口

• 安装安卓模拟器和终端测试消息app

本周遇到的困难和需要配合的地方：

• 解决IOS系统无法进行API接口测试问题

下周的开发计划和预计成果：

• 继续学习Wechaty API接口

• 利用公用账号进行API接口测试，熟悉5G接口

其他需要说明和同步的事项： 无

[su-chang]

• 解决IOS系统无法进行API接口测试问题

针对具体问题，最好能发个 issue 详细描述下问题及对应的解决方案。方便大家共享。 5G相关的问题，先统一在 https://github.com/fabian4/puppet-5G 发 issue 吧。

BTW, 周报格式参考这个 markdown 模板，目前 markdown 的格式有问题。

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2021-11-28

本周完成的成果

1. 项目汇报和期初答辩
2. 期初答辩视频准备
3. wechaty api 的部分实现

本周遇到的困难和需要配合的地方

1. WechatyImpl.get puppet 拿不到 puppet，扒源码中......

下周的开发计划和预计成果

1. 完成 wechaty部分api的实现
2. 期初答辩视频

[Bibabo-BUPT]

[项目名称] 进度报告

日期：2021-11-28

本周完成的成果

1. 期初答辩与期初报告
2. 配置ts环境，重现一个简单的ding-dong样例
3. 准备初期视频

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. pr变绿（周三前）
2. 给初期博客添加视频（周三前）
3. 完成wechaty部分api实现

其他需要说明和同步的事项

无

[su-chang]

完成 wechaty部分api的实现

@Bibabo-BUPT @fabian4 最好能具体描述下，目前这个描述范围有点大。

[lijiarui]

接口文档的梳理和分类 支持富文本和CSS样式的消息 地图消息的接收和发送

@fabian4 我看到 11 月 21 号就说完成，但是我还是没有看到issue下关于格式的任何更新，只看到了说根据目前已知的功能没有符合Post类型的消息。

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2021-12-5

本周完成的成果

1. 期初报告和期初视频
2. 报告博客 pr
3. walnut 合并仓库 pr
4. messagePayLoad 的相关适配和修改

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 完善仓库的合并pr
2. 适配新版本的wechaty

[Bibabo-BUPT]

[项目名称] 进度报告

日期：2021-12-05

本周完成的成果

1. 给初期博客添加了视频并使pr变绿
2. 测试了消息模块中的from、to、room函数获取收发信息，text获取文本信息，say发送文本信息，self和mentionself的判断功能等

本周遇到的困难和需要配合的地方

Puppet的使用有亿、、问题，下周争取解决一下

下周的开发计划和预计成果

1. 需要测试发送除文本格式之外的其他信息
2. 测试转发、提取日期时间url等功能

其他需要说明和同步的事项

无

[su-chang]

Puppet的使用有亿、、问题，下周争取解决一下

@Bibabo-BUPT 最好能列出TOP 3, 这样方便逐个攻破。

BTW, @fabian4 @Bibabo-BUPT 对于回复的评论，需要有对应的响应哈。

[Bibabo-BUPT]

Puppet的使用有亿、、问题，下周争取解决一下

@Bibabo-BUPT 最好能列出TOP 3, 这样方便逐个攻破。

BTW, @fabian4 @Bibabo-BUPT 对于回复的评论，需要有对应的响应哈。

好的，其实也没有Top3，就是一个问题，现在已经解决了，是兼容性的问题

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2021-12-12

本周完成的成果

1. 完成flash-store的接入
2. 实现消息模块和联系人模块的本地缓存
3. 完善PR内容，调整代码使其符合规范

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 完成 pr 的 merge
2. 实现消息模块的多形式内容的封装

[Bibabo-BUPT]

[项目名称] 进度报告

日期：2021-12-12

本周完成的成果

1. 测试了发送除文本格式之外的其他信息，如富媒体、微信名片、链接等
2. 测试了转发、提取日期时间url等功能
3. 测试了艾特、撤回、转发等功能

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 解决本地缓存问题
2. 开始进行消息模块的封装

其他需要说明和同步的事项

无

[su-chang]

@Bibabo-BUPT 希望尽快将期初博客完成

https://github.com/wechaty/wechaty.js.org/pull/1406

[su-chang]

2. 开始进行消息模块的封装

@Bibabo-BUPT 关于消息模块的封装，建议根据 @fabian4 已完成的工作进行补充和完善（避免一些重复的工作），以PR的形式提交对应内容吧。

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2021-12-19

本周完成的成果

1. 完成地理位置消息的模块封装
2. 完成pr内容，merge到主仓库
3. 参与post的模块讨论，提出结构的设计建议

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 准备答辩材料
2. 继续完善消息的多种样式

[su-chang]

@Bibabo-BUPT Please update your weekly report ASAP.

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2021-12-26

本周完成的成果

1. 完成答辩内容、完善答辩报告答辩ppt
2. 继续完善 WeChat 的 post 相关讨论
3. 完善博客pr https://github.com/wechaty/wechaty.js.org/pull/1442

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 完善 walnut 的 README
2. 完善 walnut 的 getting-started

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-1-2

本周完成的成果

1. 完善答辩报告答辩ppt
2. 答辩博客pr
3. 完成 wanlut 的 README 和 getting-started

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 完善多种消息形式

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-1-9

本周完成的成果

1. 完善对于 wechaty contact 部分 api 的支持 https://github.com/fabian4/puppet-walnut/pull/3

Contact

• id
• say(text Or Contact Or File Or Url)
• name()
• alias(newAlias)
• friend()
• type()
• gender()
• avatar()
• sync()
• self()
• find(query)
• findAll(query)

本周遇到的困难和需要配合的地方

在 alias() 和 sync() 函数中，会多次触发Dirty事件，造成死循环

下周的开发计划和预计成果

1. 完成 contact 的 api 支持
2. 开始实现 message 的 api 支持

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-1-16

本周完成的成果

1. 完成对于 contact 部分 api 的支持 https://github.com/wechaty/puppet-walnut/pull/19
2. 完成对于 message 部分的支持，实现图片等文件消息的发送 https://github.com/fabian4/puppet-walnut/pull/4

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 完成答辩ppt、报告、视频等内容的准备
2. 实现对于地图消息的处理和发送
3. 完善 message 模块的支持

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-1-23

本周完成的成果

1. 完成本周的答辩内容，提交博客pr https://github.com/wechaty/wechaty.js.org/pull/1457
2. 完善对于 message 部分 api 的支持，对消息接口的json结构进行封装抽象 https://github.com/wechaty/puppet-walnut/pull/21

本周遇到的困难和需要配合的地方

• 关于 location 的位置消息发送 https://github.com/wechaty/wechaty/issues/2353

下周的开发计划和预计成果

1. 对接收消息时的 message 进行类别区分
2. 完善对于 toFilebox 的 api 支持

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-1-31

本周完成的成果

1. 扩展对于多种消息格式的收发支持 https://github.com/wechaty/puppet-walnut/pull/22

消息类型	从属(根据接口返回)	api	接收	发送	群聊
文本	text	message.text	✅	✅	❌
图片	image	message.toImage()	✅	✅	❌
视频	video	message.toFilebox()	✅	❌	❌
音频	audio	message.toFilebox()	✅	❌	❌
位置	location	message.toLocation()	❌	❌	❌
文件	other	message.toFilebox()	✅	❌	❌
联系人	other	message.toContact()	❌	❌	❌

本周遇到的困难和需要配合的地方

下周的开发计划和预计成果

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-2-13

本周完成的成果

1. 完成对应多种消息格式的收发支持 https://github.com/wechaty/puppet-walnut/pull/22
2. 调试平台的消息收发接口

本周遇到的困难和需要配合的地方

下周的开发计划和预计成果

[su-chang]

@fabian4 本周没有明确的任务目标么？目前通过 wechaty 对 puppet-walnut 的测试情况如何？

[fabian4]

@fabian4 本周没有明确的任务目标么？目前通过 wechaty 对 puppet-walnut 的测试情况如何？

目前基本上稳定 能支持的api大部分都已经支持了

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-2-20

本周完成的成果

1. 更新repo的README https://github.com/wechaty/puppet-walnut/pull/23
2. 完善答辩的博客和视频 https://github.com/wechaty/wechaty.js.org/pull/1487

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 完善walnut的自动化测试
2. 完成5G的开发环境搭建文档
3. 搭建Wechaty Developers Home 5G 群

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-2-27

本周完成的成果

1. 完善walnut的自动化测试 https://github.com/wechaty/puppet-walnut/pull/24
2. 完成5G的开发环境搭建文档 https://github.com/wechaty/puppet-walnut/pull/25

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 搭建Wechaty Developers Home 5G 群

[fabian4]

[基于5G消息的 Wechaty Puppet 模块设计与实现] 进度报告

日期：2022-3-7

本周完成的成果

1. 开始搭建Wechaty Developers Home 5G 群 https://github.com/fabian4/WalnutHome

本周遇到的困难和需要配合的地方

无

下周的开发计划和预计成果

1. 调试完善群聊逻辑