Open seeflood opened 3 years ago
chinese:
作为技术同学,你是否有过“想参与某个开源项目的开发、但是不知道从何下手”的感觉? 为了帮助大家更好的参与开源项目,MOSN社区会定期发布适合新手的新手开发任务,帮助大家learning by doing!
任务分为不同难度:
[ ] 为go-sdk添加使用文档。见http://mosn.io/layotto/#/zh/sdk_reference/go/start
[x] 为State API添加接口文档.See https://mosn.io/layotto/#/en/api_reference/state/reference
[x] 为 Pub/Sub API添加接口文档.See https://mosn.io/layotto/#/en/api_reference/pubsub/reference
[x] 为Distributed Lock API添加接口文档.See https://mosn.io/layotto/#/en/api_reference/lock/reference
[x] 为RPC API添加接口文档.See https://mosn.io/layotto/#/en/api_reference/rpc/reference 已assign #185
[x] 把 MinIO 的 demo 改成默认使用 docker 部署 MinIO、Layotto 调用本地 MinIO. 目前,该 demo 默认调用 MinIO 的官方演示服务,但该服务不稳定,时常出现磁盘满了之类的情况。 见 https://github.com/mosn/layotto/issues/450
优化demo.见 https://github.com/mosn/layotto/issues/455
[ ] 修复 rpc 相关代码的单元测试报错问题 https://github.com/mosn/layotto/issues/550
[ ] 为actuator模块添加单测,代码路径在 pkg/filter/stream/actuator/http
[x] 看明白wasm模块的实现原理&补充单测:见 #105
[ ] 对你感兴趣的模块添加单元测试,提高Layotto的总体测试覆盖率(目前仅有46%)
[x] 为runtime/runtime.go和grpc/api.go添加单元测试。这两个文件是layotto的核心引擎代码,各自负责组件生命周期管理(启动、注册、初始化)和grpc请求处理,完成此任务可以很好的了解Layotto架构 已assign给@tianjipeng 见 #138
[x] 为某类你感兴趣的API添加集成测试用例。见 #107 已assign给 @seeflood
[x] 看明白rpc模块的实现原理&补充单测。见 #106 已assign给 @tianjipeng
[ ] 补充集成测试组件跟用例。见 #415
见 https://github.com/mosn/layotto/issues/67#issuecomment-975134341 我们想让用户和sdk开发者不用装go,docker和存储系统(比如redis)就能跑起来layotto,减少上手门槛。 为了实现这个目标,我们需要添加in-memory 组件,在内存里增删改查。包括:
You can take the in-memory state store component as an example,see #327
我们想让 Layotto 既支持 Layotto API,又支持Dapr API。这样用户如果担心厂商绑定,可以使用Dapr SDK,在Layotto和Dapr之间自由切换。 您可以参考: https://github.com/mosn/layotto/issues/361 https://github.com/mosn/layotto/pull/362
laytto现在添加了file接口的抽象,默认支持了aliyun的oss的能力,现在需要增加其它的后端文件存储组件。可以参照https://github.com/mosn/layotto/issues/98 , https://github.com/mosn/layotto/issues/236
组件开发:选择一个你喜欢的开源组件或云服务(比如zookeeper,leaf等)实现分布式自增id生成 。
[x] 实现Sequencer API的号段缓存功能. assigned to @ZLBer ,see #158 可以参考Leaf,做双buffer优化 待实现的函数在https://github.com/mosn/layotto/blob/main/pkg/runtime/sequencer/cache.go 参考资料: quick start: https://mosn.io/layotto/#/zh/start/sequencer/start design doc: https://mosn.io/layotto/#/zh/design/sequencer/design
注意在实现分布式锁之前需要谨慎评估一下这个存储组件是否适合实现分布式锁,会不会很容易出现丢锁、死锁等问题?分布式锁没法保证100%的正确性,但我们也要尽量保证正确,尽量为用户屏蔽复杂的问题~
Mongo的ttl是分钟级可能会太久、异步复制可能丢锁,但是好像能改服务端配置改成同步复制?(我刚查到一篇博客 说能),Cassandra组件我还没有细看,看ShedLock 实现了Cassandra于是就加进来了。总之需要开发者在设计时仔细评估哈~
类型(scope): 主题
的格式,以便让commit history 可读性更好。
见 https://github.com/mosn/layotto/issues/243 assignedgo lint
自动检查代码风格,检查的细节比如:
代码里不能有中文;
用go xxx()
起新协程的地方,必须有recover;
当然这几个例子实现不了也不要紧,只要有有价值的自动化检查就行目前ci/cd使用github actions,配置文件在这里 可以参考一些github actions优质教程:
https://www.ruanyifeng.com/blog/2019/09/getting-started-with-github-actions.html http://www.ruanyifeng.com/blog/2019/12/github_actions.html
[x] 发布新版本时自动化构建: 修改 workflow,每次发布新版本时自动交叉编译出多平台的二进制文件(linux/mac下的二进制文件)、压缩(把二进制文件压缩),以便在发版报告中提供二进制文件或压缩文件 需要调研一下方案,看看是自己写一个构建脚本、用go的交叉编译功能,还是有现成的平台帮忙做构建
[x] 自动化构建 Docker 镜像: 每次有PR 合并、发布新版本时,自动构建docker镜像 WIP. See #392
[ ] 设计实现 Redis API
[ ] 设计实现 Kafka API 有了这个API后,我们可以用阿里云 SLS 组件来实现这个 API
[ ] 设计实现事务消息 API
[ ] 设计实现延迟消息 API
[ ] 让Layotto 支持 Dapr Config API 自今年3月以来,我们一直在和阿里巴巴、Dapr社区讨论共建 ,希望为Dapr添加一套Config API。最近这个API终于被Dapr合并了 。 现在,是时候让Layotto也支持Dapr这套Config API了。(Dapr Config API还在alpha版本,和Layotto已有的Config API相似但缺少一些字段,开发时可以参考Layotto已有的实现) Dapr的API定义见 https://github.com/dapr/dapr/blob/master/dapr/proto/runtime/v1/dapr.proto
[x] 让Layotto支持secret API。 Layotto的目标是和Dapr等社区共建Runtime API标准(把Dapr API推广成行业标准,Layotto作为该API的一个实现),需要支持Dapr的secret API。因此本任务需要将Dapr的secret API移植进Layotto。Dapr 的secret management相关文档见https://docs.dapr.io/developing-applications/building-blocks/secrets/ assigned.see #212
[ ] 让Layotto支持Binding API。同上,将Dapr的binding API移植进Layotto
I want to add unit tests for rpc related code, please assign to me
I want to add unit tests for rpc related code, please assign to me
Cool. Feel free to ask for help, and welcome to the community! If you find github conversation inconvenient to communicate,we can chat on dingtalk (in chinese,haha) Our dingtalk group is 31912621
Hello, I am interested in adding unit tests for WASM related code. Could you please let me try to do it?
Hello, I am interested in adding unit tests for WASM related code. Could you please let me try to do it?
Welcome! You can reply the issue #105 so that I can assign it to you. If you encounter any problems,feel free to ask for help in github conversation or dingtalk. Webassembly is a cool new tech.I like it too :)
I want to impl etcd lock, please assign to me
@stulzq Cool! I added a issue #127. You can reply there and then we can assign it to you
New tasks added
I want to add java client base on protobuf , assign to me?
I want to add java client base on protobuf , assign to me?
Ok, I will assign it to you! @MoonShining is developing a rpc method for java client, I think you can add any other features for java sdk
New tasks added:
Sequencer API impl: mongo & Leaf, pls assign to me
Sequencer API impl: mongo & Leaf, pls assign to me
Cool!
Sequencer API impl: zk & standalone redis, pls assign to me
Sequencer API impl: zk & standalone redis, pls assign to me
Cool!
segment caching assign to me , pls
segment caching assign to me , pls
Ok. @ZLBer is so good!
Added some engineering related tasks:
New tasks added:
Easy
Medium
New tasks added:
Hi, Sequencer API related: snowflake algorithm (need to avoid clock rollback problems) could this refer https://github.com/baidu/uid-generator? uid-generator can avoid clock rollback problems but it depends on db if can be done, we just need to implement the go version uid-generator
为RPC API添加接口文档.See https://mosn.io/layotto/#/en/api_reference/rpc/reference, assign to me , pls
@byene0923 I haven't used that library before,but I think any existing system which is suitable for id generation can be integrated as a component.So welcome to implement it !
if can be done, we just need to implement the go version uid-generator
Yep,but I am worried that will there be too much work to do? Will the workload be too great? I am not familiar with this library
为RPC API添加接口文档.See https://mosn.io/layotto/#/en/api_reference/rpc/reference, assign to me , pls
@keleqnma Cool! Thanks for your passion and welcome to the Layotto community! I opened a new issue https://github.com/mosn/layotto/issues/185 ,you can reply there so that I can assign it to you.
New task added:
I want to implement the snowflake algorithm, assign to me pls
@keleqnma Thanks for your passion! I add a new issue https://github.com/mosn/layotto/issues/193 You can reply there so that I can assign to you. If you are not confident about how to implement it,you can write your design before coding Feel free to talk with us in github or dingtalk. I'm on vacation this week but @zhenjunMa is willing to help 😄
WASM Function access cache through state API, assign to me pls
@zach030 Cool,you can reply in the issue #192 so that we can assign it to u. If you are not confident about how to implement it,you can write your design before coding. Feel free to ask us for help
New tasks added:
recover
for all codes that create new goroutines. See #197 hi,i wanna translate, pls assign me, thx a lot.
将文档贡献指南翻译成英文 将组件开发指南翻译成英文 将新增API时的开发规范翻译成英文
将文档贡献指南翻译成英文 将组件开发指南翻译成英文 将新增API时的开发规范翻译成英文
@x-shadow-man OK,I add a new issue #202 You can reply there and then we can assign it to you Welcome to the Layotto community!
New tasks added:
Easy
Hard
- Hard
I can take hard, assign to me PLS
@MentosL Cool ! I submitted a issue and assigned it to u,see #212 Since this issue is a little bit complicated,u can write your design before coding to avoid rework. You can take sequencer API proposal https://github.com/mosn/layotto/issues/139 or pubsub API design doc https://mosn.io/layotto/#/zh/design/pubsub/pubsub-api-and-compability-with-dapr-component as examples
@MentosL Cool ! I submitted a issue and assigned it to u,see #212 Since this issue is a little bit complicated,u can write your design before coding to avoid rework. You can take sequencer API proposal #139 or pubsub API design doc https://mosn.io/layotto/#/zh/design/pubsub/pubsub-api-and-compability-with-dapr-component as examples
Ok, I'll refer to the design and then put it into development
New tasks added:
New tasks added:
hello,I want to impl redis cluster lock, please assign to me
@whalesongAndLittleFish Cool! I opened a new issue #249 and listed the docs you can refer to. You can reply there so that I can assign it to you
Node.js SDK 我可以尝试领一下,时间不一定保证,未来几个周末我会至少保证每周2小时投入。
Node.js SDK 我可以尝试领一下,时间不一定保证,未来几个周末我会至少保证每周2小时投入。
@fengmk2 欢迎大佬加入!!我建了个issue,assign 给您 https://github.com/mosn/layotto/issues/258 时间比较随意,毕竟开源不是上班~ 现在go sdk和java sdk没文档,我们尽快补充文档,如果您在实现过程中遇到啥问题可以在github或者群里和我们讨论
New tasks added:
type(scope): subject
in order to make the commit history more readable.
See #243 go lint
in ci/cd pipeline.New tasks added:
New tasks added:
New tasks added:
New tasks added:
@seeflood Integrate with skywalking assign to me ,pls
@ZLBer Cool ! I added an issue and already assigned to you. See https://github.com/mosn/layotto/issues/310
New tasks added:
Community tasks
As a programming enthusiast , have you ever felt that you want to participate in the development of an open source project, but don't know where to start? In order to help everyone better participate in open source projects, the MOSN community will regularly publish community tasks to help everyone learn by doing!
Task List
Tasks of different difficulty are released:
Easy
Layotto runtime
recover
for all codes that create new goroutines. See #197Bug fix
Write a Feature
Comment related
SDK related
Document related
[ ] add go-sdk usage documents.See http://mosn.io/layotto/#/en/sdk_reference/go/start
[x] add document for State API.See https://mosn.io/layotto/#/en/api_reference/state/reference
[x] add document for Pub/Sub API.See https://mosn.io/layotto/#/en/api_reference/pubsub/reference
[x] add document for Distributed Lock API.See https://mosn.io/layotto/#/en/api_reference/lock/reference
[x] add document for RPC API.See https://mosn.io/layotto/#/en/api_reference/rpc/reference already assigned #185
[ ] Change MinIO's demo to use docker to deploy MinIO by default, and Layotto to invoke local MinIO. Currently, the demo uses the MinIO official demo service by default, but the service is unstable, so we want to use docker to deploy MinIO and make the demo more stable. See https://github.com/mosn/layotto/issues/450
[ ] Delete redundent demos. See https://github.com/mosn/layotto/issues
Translation
[x] Translate Skywalking quickstart documentation into English
[ ] Translate How to deploy and upgrade Layotto into English
[x] Translate "Explain Layotto's github workflow" into Chinese
[x] 将“介绍 layotto CI” 的文档翻译成英文 https://github.com/mosn/layotto/issues/545
[ ] 将“介绍如何自动测试 quickstart” 的文档翻译成英文 https://mosn.io/layotto/#/zh/development/test-quickstart
Tests related
[ ] Add unit tests for
actuator
module. The code is underpkg/filter/stream/actuator/http
[x] Understand the implementation of wasm module & add unit tests: see #105
[ ] add more unit test whereever you like to make layotto's unit test coverage higher(currently it's only 46%)
[x] Add unit tests for runtime/runtime.go and grpc/api.go. These two files are the core engine code of layotto, responsible for component lifecycle management and grpc request processing respectively Already assigned to @tianjipeng See #138
[x] Add integration test cases for a certain type of API. See #107 assigned to @seeflood
[x] Understand the implementation of the rpc module & add unit tests: see #106 Already done by @tianjipeng
[ ] Add integrate test. see #415
Components
in-memory components
See https://github.com/mosn/layotto/issues/67#issuecomment-975134341 We want to let users and sdk developers run our demo without go , docker and back-end storage (e.g. redis) pre-installed. To achieve this goal, we need to add in-memory components,including:
You can take the in-memory state store component as an example,see #327
Medium
Add support for Dapr API
We want Layotto to support both Layotto API and Dapr API. In this way, if users are worried about vendor lock-in, they can use Dapr SDK to switch between Layotto and Dapr freely. You can refer to: https://github.com/mosn/layotto/issues/361 https://github.com/mosn/layotto/pull/362
SDK
[x] Improve .net sdk. Make it have the same capabilities and api as go sdk assigned.see #130
[ ] Develop python sdk Because we want to reduce the cost of maintaining multi-language SDKs, we want to reuse Dapr SDKs as much as possible. Therefore, this task suggests to fork the Dapr python SDKs for modification (because the package path of the proto interface is different, so the code compiled by proto is different, so we need to do some modification).
[x] Develop the spring-boot-layotto package. See https://github.com/layotto/java-sdk/pull/8 Let layotto integrate spring boot so that users can use annotations to register pubsub subscription callback
Actuator
WASM
File api implementation
Add components for file api. File api have been supported in layotto, need add other components for file api. https://github.com/mosn/layotto/issues/236 , https://github.com/mosn/layotto/issues/98
Sequencer API related
Sequencer API Component:Choose an open source component or cloud service you like (such as zookeeper, leaf, etc.) to implement distributed auto-increment id generation service.
[x] Etcd
[x] Stand-alone redis assigned
[x] Zookeeper assigned
[ ] Leaf
[x] Mongo
[ ] Consul
[ ] snowflake algorithm (need to avoid clock rollback problems) assigned.see https://github.com/mosn/layotto/issues/193
[ ] Mysql
[ ] PostgreSQL
[ ] Any other storage
[x] Implement the segment caching feature of Sequencer API. assigned to @ZLBer ,see #158 You can refer to Leaf to do double buffer optimization The function to be implemented is at https://github.com/mosn/layotto/blob/main/pkg/runtime/sequencer/cache.go
Distributed Lock API
Engineering
type(scope): subject
in order to make the commit history more readable. See https://github.com/mosn/layotto/issues/243go lint
in ci/cd pipeline. For example:recover
It doesn't matter if these examples can't be realized. As long as we can do valuable automated inspectionsCurrently we use github actions as ci/cd pipeline, and the configuration file is here You can refer to some github actions high-quality tutorials:
https://www.ruanyifeng.com/blog/2019/09/getting-started-with-github-actions.html
http://www.ruanyifeng.com/blog/2019/12/github_actions.html
Hard
Observability
Runtime API Lab
Hard
530
[ ] Redis API.
[ ] Kafka API. Alicloud SLS component can implement Kafka-like API too.
[ ] Design transaction message API (like RocketMQ's) for pubsub
[ ] Delay message API for pubsub
[ ] Let Layotto support Dapr's Config API (alpha version) We have been discussing and working with Alibaba and Dapr community to contribute a Config API for Dapr since March of this year,and recently it was finally merged into Dapr . Now it's time to can make Layotto support Dapr's Config API. Dapr Config API is still in the alpha version, which is similar to Layotto's existing Config API but lacks some fields. You can refer to Layotto's existing implementation during development. See Dapr's API definition
[x] Let Layotto support secret API. Layotto's goal is to build a Runtime API standard with Dapr and other communities (promote Dapr API as an industry standard, and Layotto as an implementation of this API), so it needs to support Dapr's secret API. Therefore, this task needs to port Dapr's secret API into Layotto. For Dapr's secret management related documents, see https://docs.dapr.io/developing-applications/building-blocks/secrets/ assigned. see #212
[ ] Layotto support Binding API. Same as above, porting Dapr's binding API into Layotto
WASM Lab
If you are interested, you can reply and we will assign the task to you
Kubernetes Lab
Istio