eggjs / tegg Goto Github PK

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

octet-stream 怎么支持前端传输的octet-stream类型的数据，tegg怎么获取并保存

可复现问题的仓库地址（Reproduction Repo）

octet-stream 怎么支持前端传输的octet-stream类型的数据，tegg怎么获取并保存

Node 版本号：

18.0.0

TEgg 版本号：

3.12.0

相关插件名称与版本号：

3.12.0

操作平台与版本号：

3.12.0

A TODO comment in indicates that the 'diff' functionality is missing. This issue tracks the implementation of this functionality as discussed in PR #192 and the specific comment #192 (comment).

Please ensure to review the context of the PR and the discussion to understand the requirements and expectations for this implementation.

这样配置会报错，有大佬能帮忙看看吗

请详细告知你的新点子：

目前这个项目是什么状态？可用于生产环境了吗？

请详细告知你的新点子：

导致这个地方必须写成跟 app.xxx 一致

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

我这边的使用场景是：
redis地址需要动态获取，因此需要请求接口获取配置，于是自定义redis插件，初始化之前发起异步请求。

egg-redis的配置，我在demo上是瞎写的，不过不用关心，报此类错误可以忽略，关键是加了await后还走不到这一步。

演示步骤如下：
1.下方的demo仓库，我是稍微改造了官方的eggjs-redis插件：
改动点在： app/plugins/egg-redis/lib/redis.js

2.插件配置如下（通过path指向插件）：

3.Service层注入redis插件如下：

4.加了await后，npm run dev，报错如下：
ERROR 73152 framework.EggPrototypeNotFound: Object redis not found in LOAD_UNIT:foo [ https://eggjs.org/zh-cn/faq/TEGG_EGG_PROTO_NOT_FOUND ]
......................................................................
......................................................................
......................................................................
code: TEGG_EGG_PROTO_NOT_FOUND
serialNumber: EGG_PROTO_NOT_FOUND
errorContext: ""

奇怪：
1、加await处的代码报错捕获不到，感觉一加await就像跳过了当前的执行。
2、axios、app.curl试了都不行。
3、只要去掉await，非同步执行都ok。

麻烦大佬们帮看看，非常感谢~~

可复现问题的仓库地址（Reproduction Repo）

https://github.com/yinshanhu/eggjs-addSingleton-asyncFunction-error.git

Node 版本号：

v18.12.1

TEgg 版本号：

3.5.2

相关插件名称与版本号：

无

操作平台与版本号：

window11

请详细告知你的新点子：

https://github.com/saghul/txiki.js

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

tegg-orm-decorator 和 sequelize怎么一起使用

可复现问题的仓库地址（Reproduction Repo）

tegg-orm-decorator 和 sequelize怎么一起使用

Node 版本号：

v14.18.1

TEgg 版本号：

v3.5.2

相关插件名称与版本号：

3.6.3

操作平台与版本号：

windows10

What happens?

Middleware decorator cannot make case sensitive routing.

It seems that getEggObject will get wrong ObjectMap after Middleware decorator.

eggObjectMap Map(3) {
  'LOAD_UNIT:tegg-app-controller:PROTO:853:middlewareController' => Map(1) {  },
  'LOAD_UNIT:multiModuleService:PROTO:851:appService' => Map(1) {},
  'LOAD_UNIT:multi-module-repo:PROTO:850:appRepo' => Map(1) {}
}
proto.id: LOAD_UNIT:tegg-app-controller:PROTO:857:viewController

Mini Showcase Repository(REQUIRED)

Provide a mini GitHub repository which can reproduce the issue.
Use npm init egg --type=simple bug then upload to your GitHub

add following into plugin/controller/test/http/middleware.test.ts

  it('method Middleware should not work', async () => {
    app.mockCsrf();
    await app.httpRequest()
      .get('/Middleware/Method')
      .expect(200)
      .expect('hello, view');
  });

How To Reproduce

Steps to reproduce the behavior:

1. Use middleware with HttpController

@HTTPController({
  path: '/middleware',
})
@Middleware(countMw)
export class MiddlewareController {
  @Inject()
  appService: AppService;

  @HTTPMethod({
    method: HTTPMethodEnum.GET,
    path: '/global',
  })
  async global() {
    return {};
  }

  @HTTPMethod({
    method: HTTPMethodEnum.GET,
    path: '/method',
  })
  @Middleware(logMwFactory('use middleware'))
  async middleware() {
    return {};
  }
}

add a viewController to match other paths

@HTTPController()
export class ViewController {

  @HTTPMethod({
    method: HTTPMethodEnum.GET,
    path: '/*',
  })
  async get() {
    return 'hello, view';
  }
}

2. try to visit a Uppercase of router path : /Middleware/Method，response 500 server error

Expected behavior

1. router match with /* and response 'hello, view'

Context

• Node Version:
• Egg Version:
• Plugin Name:
• Plugin Version:
• Platform:

There's a TODO comment in the method of the class, indicating the need for implementing index left matching. This enhancement is related to the Data Access Layer (DAL) features introduced in PR #192.

The specific TODO can be found in the diff for .

This issue was requested to be opened by @fengmk2 in the PR discussion: #192 (comment)

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

使用 cnpmcore + tegg 开发，cnpmcore v3.38.2, tegg v3.12.0 版本，原本没有问题，升级到 v3.29.0 后启动报错 framework.EggPrototypeNotFound: Object searchAdapter not found in LOAD_UNIT:cnpmcoreRepository;

锁版本 tegg 相关包锁在 3.12.0，cnpmcore v3.38.2，报错 nodejs.ERR_PACKAGE_PATH_NOT_EXPORTEDError: [egg-core] load file: /Users/xxx/demo/node_modules/@eggjs/tegg-orm-plugin/app.js, error: Package subpath './src/setup_hooks' is not defined by "exports" in /Users/xxx/demo/node_modules/leoric/package.json；

查看 cnpmcore 依赖后，发现 "@eggjs/tegg": "^3.12.0"，所以会安装依赖 3.12.0 3.29.0，这两个版本不兼容吗？

可复现问题的仓库地址（Reproduction Repo）

无

Node 版本号：

18.19.0

TEgg 版本号：

3.29.0

相关插件名称与版本号：

cnpmcore, 3.38.2

操作平台与版本号：

macOS 13.5.2 (22G91)

哈喽，我想咨询一下在 tegg 里面如何使用 egg-redis 中间件

我使用这种方式可以 log 出值 redies.get('foo') 的值
但是会有两个问题

1. 使用 ctx.app.redis ts 会提示 类型“Application”上不存在属性“redis”
2. 使用这种方式接口请求会报404 ，也没有走到 ERR

还想咨询一下，除过readme 还有其他的tegg的文档吗

index.ts

async index(@Context() ctx: EggContext) {
    try {
      // @ts-ignore
      const data = await ctx.app.redis.get('foo');
      console.log(data);
      return 'hello word';
    } catch (err) {
      console.log(err);
      return 'hello word error';
    }
  }

config.default.ts

  config.redis = {
    client: {
      port: 6379, // Redis port
      host: '127.0.0.1', // Redis host
      password: 'my_react_admin_app',
      db: 0,
    },
  };

plugin.ts

 redis: {
    enable: true,
    package: 'egg-redis',
  },

What happens?

最小可复现仓库

请使用 npm init egg --type=simple bug 创建，并上传到你的 GitHub 仓库

复现步骤，错误日志以及相关配置

相关环境信息

• 操作系统：
• Node 版本：
• Egg 版本：

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

1.使用的是eggjs框架，egg-redis不符合我的使用场景，于是通过addSingleton注册了自己的插件，名称为：‘redis’。确认注册是成功的。

2.代码里使用时，注入的方式：
import type { Redis } from 'ioredis';
@Inject()
private readonly redis: Redis;

3、报错：
framework.EggPrototypeNotFound: Object redis not found in LOAD_UNIT:......................................非关键信息省略..........
code: TEGG_EGG_PROTO_NOT_FOUND
serialNumber: EGG_PROTO_NOT_FOUND

还请大佬帮忙解答。

可复现问题的仓库地址（Reproduction Repo）

无

Node 版本号：

v18.14.1

TEgg 版本号：

3.5.2

相关插件名称与版本号：

1

操作平台与版本号：

window11

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

使用 pkg 直接报错

ERROR 27855 nodejs.Error: unknown type of module reference config: {"pkg":"cnpmcore/common"}
    at Function.readModuleReferenceFromModuleJson (/Users/xxx/github/hello-tegg/node_modules/@eggjs/tegg-common-util/src/ModuleConfig.ts:85:15)
    at Function.readModuleReference (/Users/xxx/github/hello-tegg/node_modules/@eggjs/tegg-common-util/src/ModuleConfig.ts:62:19)

README 文档:

可复现问题的仓库地址（Reproduction Repo）

测试的是
https://github.com/eggjs/examples/blob/bed580fe053ae573f8b63f6788002ff9c6e7a142/hello-tegg/config/module.json

Node 版本号：

v18.16.0

TEgg 版本号：

3.7.0

相关插件名称与版本号：

cnpmcore, 3.20.2

操作平台与版本号：

macOS 13.3.1 (22E261)

1. 实现控制器拦截器注解。对类或者类方法的执行进行拦截。类似于nestjs中的守卫

2. 比如现在有些控制器接口有控制访问权限。我直接可以加上一个@Auth(AuthInterceptor) 注解。在AuthInterceptor里面实现自己的拦截逻辑

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

在中间件调用service 但是一直undefined，有没有什么方法注入到中间件里面

可复现问题的仓库地址（Reproduction Repo）

暂无

Node 版本号：

v14.17.0

TEgg 版本号：

3.5.2

相关插件名称与版本号：

egg:3.15.0 ， egg-bin:5.13.4

操作平台与版本号：

win10

请详细告知你的新解决思路：

https://github.com/apache/rocketmq-clients Node.js client is ready.

跟进类型：

• 这是某个任务
• 这是一个具体的 PR 的地址（URL）

请详细告知你的新点子：

能够看到官网的文档。

我用按照官网的教程，选择了TS版本示例，结果发送和官网的文档没有任何对应关系。。。

请详细告知你的新解决思路：

参考 https://github.com/xiekw2010/egg-typebox-validate

跟进类型：

• 这是某个任务
• 这是一个具体的 PR 的地址（URL）

请详细告知你的新解决思路：

目前是靠约定 init 函数名称来实现的，应用开发者会踩坑，也很难避免应用层会使用到 init 这个同名方法。

跟进类型：

• 这是某个任务
• 这是一个具体的 PR 的地址（URL）

如何在类属性上获取当前访问context上下文实例

想要在BaseController上注入context属性。封装统一的返回结构。
但是貌似像我下面的写法没调用context.body进行返回数据给前端

可复现问题的仓库地址（Reproduction Repo）

暂无地址

Node 版本号：

v16.19.1

TEgg 版本号：

3.5.2

相关插件名称与版本号：

无

操作平台与版本号：

windows10

根据这个例子获取service，但是module里是{}空对象

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

1. 我参考cnpmcore那边代码写的，想要注入后使用类的静态方法
2. 实际使用时候没有办法获取到注入对象的静态方法

想想可以直接import进来直接用，但是我看cnpmcore里可以导入 @model() 注解下的导入，我自己按下面代码测试就注入后对象的方法

controller代码如下：

import { Inject, HTTPController, HTTPMethod, HTTPMethodEnum } from '@eggjs/tegg';
import type { UserService } from '../service/UserService';

@HTTPController({
  path: '/',
})
export class HomeController {
  @Inject()
  private readonly userService: typeof UserService;

  @HTTPMethod({
    method: HTTPMethodEnum.GET,
    path: '/',
  })
  async index() {
    this.userService.find();
    return 'hello egg';
  }
}

service代码如下:

import { AccessLevel, SingletonProto } from '@eggjs/tegg';

@SingletonProto({
  accessLevel: AccessLevel.PUBLIC
})
export class UserService {
  static find() {
    console.log('find');
  }
}

可复现问题的仓库地址（Reproduction Repo）

tegg_learn.zip

Node 版本号：

16.17.0

TEgg 版本号：

^3.5.2

相关插件名称与版本号：

"@eggjs/tegg-aop-plugin": "^3.5.2",

操作平台与版本号：

macOs 14.2 (23C64)

请详细告知你的新点子：

• Locker interface
• 基于 redis 实现的 LockerOnRedis

现在的HTTPMethod 虽然足够满足业务需求，但是不够简练，是否能提供 常用的 Get，Post等方法的修饰器

@Controller('/')
export class HomeController {
  @Get('/')
  async home() {
    return 'Hello tegg!';
  }
}

顺带补充，能否提供修改全局route的前缀 ，类似于在配置文件提供

export default config={
  tegg:{
    root:"/hello"
  }
}

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

1、我在项目里面extend/context.ts里面,按照redmine文档,写了一个扩展属性
`
import { Session } from '@xx/eos'

const SESSION_HELPER = Symbol('context#sessionHelper');

export default {
/**
* sessionHelper
*/
get sessionHelper() {
if (!this[SESSION_HELPER]) {
this[SESSION_HELPER] = new Session(2)
}
return this[SESSION_HELPER];
},

};`

2、 在项目运行的时候会报如下错误:

`2023-12-13 20:52:43,219 ERROR 41983 nodejs.TypeError: Cannot read property 'protoImplType' of undefined
at Function.createProto (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-metadata/src/factory/EggPrototypeCreatorFactory.ts:39:57)
at AppLoadUnit.init (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-plugin/lib/AppLoadUnit.ts:53:55)
at processTicksAndRejections (internal/process/task_queues.js:95:5)
at async Function.createLoadUnit (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-metadata/src/factory/LoadUnitFactory.ts:33:7)
at async EggModuleLoader.loadApp (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-plugin/lib/EggModuleLoader.ts:15:22)
at async EggModuleLoader.load (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-plugin/lib/EggModuleLoader.ts:50:5)
at async ModuleHandler.init (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-plugin/lib/ModuleHandler.ts:31:7)
at async App.didLoad (/Users/xxx/Work/docker/bytehubs-eos/node_modules/.store/@eggjs[email protected]/node_modules/@eggjs/tegg-plugin/app.ts:50:5)

pid: 41983`

可复现问题的仓库地址（Reproduction Repo）

无

Node 版本号：

v14.19.1

TEgg 版本号：

3.28.2

相关插件名称与版本号：

"dependencies": { "@eggjs/tegg": "^3.28.1", "@eggjs/tegg-aop-plugin": "^3.5.2", "@eggjs/tegg-config": "^3.2.3", "@eggjs/tegg-controller-plugin": "^3.5.2", "@eggjs/tegg-eventbus-plugin": "^3.5.2", "@eggjs/tegg-plugin": "^3.5.2", "@eggjs/tegg-schedule-plugin": "^3.5.2", "egg": "^3.15.0", "egg-scripts": "^2.17.0", "egg-tracer": "^2.0.0", "glob": "^10.3.10", "lodash": "^4.17.21" },

操作平台与版本号：

mac

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

Nodejs的require.resolve不支持windows格式的路径地址

requier.resolve("cnpmcore\\common\\package.json")

会解析失败
需要统一转换成linux的路径格式，如：

requier.resolve("cnpmcore/common/package.json")

可复现问题的仓库地址（Reproduction Repo）

Node 版本号：

18.12.0

TEgg 版本号：

3.8.0

相关插件名称与版本号：

tegg-common-util

操作平台与版本号：

Windows11

是否可以引入 https://github.com/xiekw2010/egg-typebox-validate 成为默认的 validate 插件，之前的 egg-validate 在 ts 下其实不太满足。

cc @xiekw2010

请详细告知你的新点子：

我希望给出使用simple创建js项目再切换ts，和使用tegg的相同点和不同点。

为什么官网没有给出相关的说明？只看readme没看出个所以然来，希望有个与官网文档类似的指导。

我的困惑是，现在推荐使用tegg还是这个方式？
https://www.eggjs.org/zh-CN/tutorials/typescript#%E6%8E%A7%E5%88%B6%E5%99%A8controller

• 开始时间: 2021/12/16
• RFC PR:
• tegg Issue:

背景

参照： 提供更加简单化请求方法的修饰器的讨论

思路

所有Controller 类型会通过namespace进行区分

• 为了方便区分Controller，RestController，HttpController，RpcControlle需要单独划分命名空间以方便归类。 将HttpController和简化后的Controller将会被划分到
  http namespace, RestController 会被划分到rest namespace，RpcControlle会被划分到 rpc namespace。

• 以下将通过import的形式具体描述：

  import {Controller, HttpController} from '@eggjs/tegg/http';
  import {RestController} from '@eggjs/tegg/rest';
  import {RpcController} from '@eggjs/tegg/rpc';

新增baseRoot

• config新增baseRoot能力

  tegg:{
    baseRoot:string
  }

• 通过这个字段可以全局调整路由根路径

  //config.default.ts
  tegg:{
    baseRoot:'/tegg'
  }
  
  //controller/fruitController.ts
  
  @RestController('/api/v1')
  //or Controller('/api/v1')
  class Fruit {
      // GET /api/v1/
      @List
      home() {
      }
  }

  此时路径会被修正到‘/tegg/api/v1'’

新增Controller

• 所有的方法入参暂定为继承自HttpController：

  Controller(path?: string, protoName?: string, controllerName?: string);

新增Controller下Http Method修饰器

• 新的Http Method 会跟 HTTPMethodEnum 的枚举保持一致，包含 GET，POST，PUT，DELETE，PATCH，OPTIONS，HEAD

• 所有的方法入参暂时定为继承自HTTPMethod，以GET为例：

  Get(path?: string, priority?: number)

• 与HTTPMethod不同的是Get第一个入参为可选，如果Get的path入参为空时， 可以通过检索Handler Function 名称自动匹配路径。 下面以GET为例：

  @Controller('/api/v1')
  class Fruit {
      // GET /api/v1/hello
      @Get()
      hello() {
      }
  }

  以下方代码为例子，如果要处理当前Controller的跟路径，请使用Get('/')

  @Controller('/api/v1')
  class Fruit {
    // GET /api/v1/
    @Get('/')
    home() {
    }
  }

新增RestController修饰

1. 新增RestController修饰，这个修饰器为HttpController修饰器的子类，主要是HttpController的扩展
2. 基于RestController实现相关Restful 请求特性。

RESTful的独有特性

• 与常规HttpController不同，RestController将自动携带 Hypermedia,
  API，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
  比如访问 https://api.github.com/ 即可获得所有api 访问api.github.com/user，然后就得到了下面结果。

  {
    "message": "Requires authentication",
    "documentation_url": "https://docs.github.com/rest/reference/users#get-the-authenticated-user"
  }

具体能力

• 配置baseRoot对RestController的会产生影响，通过这个字段可以全局调整RESTful根路径。

  //config.default.ts
  tegg:{
    baseRoot:'/tegg'
  }

  此时会将rest默认的/api前缀覆盖为/tegg

    //config.default.ts
    tegg:{
      baseRoot:'/'
    }

  此时会将rest默认的/api前缀覆盖为/

• @RestController继承自HttpController，但是与Controller不同，如果path为缺省会根据当前的class name 并以复数的形式自动补全，会在当前根目录自动生成Hypermedia API。

  type RestControllerOptions {
     docURL?:string,
     version?:string,
     protoName?: string,
     controllerName?: string,
  }
  @RestController(path?: string, options?: RestControllerOptions)

  以下方代码为例子，我们没有填写任何参数并且没有配置baseRoot字段，那么就会指向/api/v1/fruits

  @RestController()
  class Fruit {
    // GET /api/v1/fruit/apple
    @List
     apple() {}
  }

  下面我们假设进行请求

  $ GET /api/v1/fruits
  # 我们会得到
  
  {
    "apple": "/api/v1/fruits/apple"
    "documentation_url": "/doc/v1/fruit"
  }

  $GET /api/v1 
  # 我们会得到
  
  {
    "fruit": "/api/v1/fruits"
    "documentation_url": "/doc/v1"
  }

  基于Get 请求增加，额外的业务能力

  @Query支持取出单条数据

   @Query()
   foo(id:string):Promise <Foo> {}

  @List 支持取出所有数据，默认遵从RESTful风格支持常见参数过滤（可能需要配合ORM的能力）

1.支持 ?limit=10：指定返回记录的数量

2.支持 ?offset=10：指定返回记录的开始位置。

3.支持 ?page=2&per_page=100：指定第几页，以及每页的记录数。 4.根据函数的入参可以进行横向扩展，比如需要支持搜索

@List()
listFoo(keyword:string):Promise<Array<Foo>> {}

剩余业务能力支持待补充

新增RpcController修饰

待调查： 主要调查方向GRPC， JSONRPC

其他资料与难点调研

英文单词复数化
hypermedia 实现调研

请详细告知你的新点子：

装饰器的文档有更全面的吗，目前的文档感觉好少，不知道怎么写啊...

官方的例子提示是 any

真实的应用中如果加上严格规则，会提示 any 调用可能会报错，是否可以让单测也能正确类型定义提示？

在此输入你需要反馈的 Bug 具体信息（Bug in Detail）：

当我下载完tegg相关插件后，运行项目，本地启动太慢，希望官方解决

可复现问题的仓库地址（Reproduction Repo）

无

Node 版本号：

18.0.0

TEgg 版本号：

3.12.0

相关插件名称与版本号：

3.12.0

操作平台与版本号：

3.12.0

Your detail info about the Bug:

What I did

1. 执行npm run tsc，清除缓存和执行tsc操作
2. 执行npm run dev，出现以下报错
   

Reproduction Repo

无

Node Version

18.14.0

TEgg Version

3.12.0

Plugin Name and its version

tegg-eventbus-plugin 3.12.0

Platform and its version

Windows 10