darukjs / daruk Goto Github PK

A good and proper README might help people understand the goal of the project well. It is not necessary to be a word-to-word translation of the Chinese document.

https://darukjs.com/tutorial/about.html

Daruk, a typescript web framework.

example:

@get(/\/(foo|goo)/)
async foo(ctx: Daruk.Context) {
  ctx.body = '';
}

ctx.request.body will built in the framework

增加新features，@JSON 装饰器，只对controllerClass 适用。

@himself65

https://github.com/daruk-framework/daruk/pulls

https://darukjs.com/ecological/performance.html

Daruk, a typescript web framework.

darukConfig.middlewareOrder 中添加 koa-session 依赖后，controller 中使用 this.ctx.session.xxx，提示缺少 cookie 的 keys

darukConfig.middlewareOrder = [
		'koa-handle-error',
		'koa-favicon',
		'koa-static',
		'koa2-cors',
		'koa-bodyparser',
		'koa-test-mid',
		'koa-art-template',
		'koa-session',
		'admin'
	];

this.ctx.session.admin = { username, password };

Error: .keys required for signed cookies
    at Cookies.set (/Users/apple/Desktop/study/daruk-demo/node_modules/cookies/index.js:109:27)
    at ContextSession.save (/Users/apple/Desktop/study/daruk-demo/node_modules/koa-session/lib/context.js:338:22)
    at ContextSession.commit (/Users/apple/Desktop/study/daruk-demo/node_modules/koa-session/lib/context.js:239:16)
    at session (/Users/apple/Desktop/study/daruk-demo/node_modules/koa-session/index.js:46:20)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at koa-session (/Users/apple/Desktop/study/daruk-demo/node_modules/daruk/src/core/wrap_middleware_use.ts:16:5)
    at koa-test-mid (/Users/apple/Desktop/study/daruk-demo/node_modules/daruk/src/core/wrap_middleware_use.ts:16:5)
    at bodyParser (/Users/apple/Desktop/study/daruk-demo/node_modules/koa-bodyparser/index.js:73:48)
    at koa-bodyparser (/Users/apple/Desktop/study/daruk-demo/node_modules/daruk/src/core/wrap_middleware_use.ts:16:5)
    at cors (/Users/apple/Desktop/study/daruk-demo/node_modules/koa2-cors/dist/index.js:91:9)

按照文档鼓捣了下，被配置卡住了，不知道什么含义，无法进行下一步。

能否完善一下文档。

Is it possible to add a uniform public version to the router, or use V1ContactList directly?

// src/controllers/contact/list.ts
import { BaseController, get, Context } from "daruk";

export default class V1ContactList extends BaseController {
  @get("/")
  public async getContactList(ctx: Context, next: Function) {
    ctx.body = "contact list";
    return next();
  }
}

Is there any other way to achieve it? such as

// src/controllers/contact/list.ts
import { BaseController, get, Context, version } from "daruk";

@version('/v1')
export default class ContactList extends BaseController {
  @get("/")
  public async getContactList(ctx: Context, next: Function) {
    ctx.body = "contact list";
    return next();
  }
}

Is your feature request related to a problem? Please describe.
按着默认配置是没法有上传文件的。

Describe the solution you'd like
需要在配置中加入 multipart true 才能开启

Describe alternatives you've considered
如果文档有说明就好了

Additional context
Add any other context or screenshots about the feature request here.

as build output, the build folder should not push to git repo

我是在win10下，使用vscode运行你的代码的。

Describe the bug
npm run dev 之后无法运行啊。

错误如下：

HuangGang@PC-20181118AWSO MINGW64 /d/DarukWorkSpace/daruk-example
$ npm run dev

[email protected] dev D:\DarukWorkSpace\daruk-example
cross-env NODE_ENV=dev nodemon --exec ts-node --files ./src/app.ts

[nodemon] 1.19.0
[nodemon] to restart at any time, enter rs
[nodemon] watching: .
[nodemon] starting ts-node --files ./src/app.ts
[2019-5-5 17:25:22] [debug] [init] [config]
[2019-5-5 17:25:22] [debug] [init] [util] ["testUtil","sort"]
[2019-5-5 17:25:22] [debug] [init] [glue] ["mysql"]
[2019-5-5 17:25:22] [debug] [init] [middleware] ["koa-handle-error","koa-favicon","koa-static","koa-bodyparser","koa-test-mid","koa-ejs"]
[2019-5-5 17:25:22] [debug] AssertionError [ERR_ASSERTION]: controller class name should be
'\contact\index' ( CamelCase style and match route path ) in path: D:\DarukWorkSpace\daruk-example\src\controllers\contact\index.ts
at routers.forEach (D:\DarukWorkSpace\daruk-example\node_modules\daruk\src\core\daruk_loader.ts:112:7)
at Array.forEach ()
at DarukLoader.loadController (D:\DarukWorkSpace\daruk-example\node_modules\daruk\src\core\daruk_loader.ts:92:13)
at DarukCore.initEnv (D:\DarukWorkSpace\daruk-example\node_modules\daruk\src\core\daruk_init_module.ts:73:12)
at new DarukCore (D:\DarukWorkSpace\daruk-example\node_modules\daruk\src\core\daruk_core.ts:96:10)
at Object. (D:\DarukWorkSpace\daruk-example\src\daruk.init.ts:11:16)
at Module._compile (internal/modules/cjs/loader.js:701:30)
at Module.m._compile (D:\DarukWorkSpace\daruk-example\node_modules\ts-node\src\index.ts:439:23)
at Module._extensions..js (internal/modules/cjs/loader.js:712:10)
at Object.require.extensions.(anonymous function) [as .ts] (D:\DarukWorkSpace\daruk-example\node_modules\ts-node\src\index.ts:442:12)
logType: daruk-example
env: dev
fileinfo: \node_modules\daruk\src\core\daruk_core.ts:239:21
msg: process is exiting
os_hostname: PC-20181118AWSO
level: info
timestamp: 1557048322594

logType: daruk-example
env: dev
fileinfo: \node_modules\daruk\src\core\daruk_core.ts:243:21
msg: process exited: 1
os_hostname: PC-20181118AWSO
level: info
timestamp: 1557048322598

[nodemon] app crashed - waiting for file changes before starting...

https://darukjs.com/tutorial/starup.html

Daruk, a typescript web framework.

https://darukjs.com/tutorial/decorator.html

Daruk, a typescript web framework.

No.

Describe the solution you'd like

Aspect Oriented Programming, like:

1. https://github.com/nestjs/nest
2. https://github.com/midwayjs/midway
3. https://github.com/strongloop/loopback-next

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context

I think nest.js has more places to learn than koa.

Additional context
How to get url params like

@get('/:id')

// and then

ctx.params.id

utils support export default an object or function

@all-contributors please add @xiaojue for design

https://darukjs.com/tutorial/deploy.html

Daruk, a typescript web framework.

add feature:

@reDIrect with controller class method decorator.

Describe the bug
i want to kow how to develop this framework, by the way, there is only build script and i don't konw it works

Please enable all strict type-checking options.

基本上看了一遍文档，总体上感觉不错。但是有几个点我需要问下。

AOP模型

基于AOP的controller模式是否真的适用在架构中的问题其实一直以来都是有争论的。最早起源于java，Spring一整套都是基于AOP设计的路由。那么问题来了

1. java的路由不是compose模型，可以根据特征识别路由优先级，那么在daruk中，如何通过KOA2保证路由顺序？
2. 之前我有测试过通过fastify与koa+koa-router的QPS数据，请看这里 ，那么在上述请看下，daruk能保证多少qps？(建议：find-my-way)

变量污染

我看到文档中有一些写法，我举个例子：

this.ctx.service.xxxxx

我知道这种模式来源于eggjs，但是这是eggjs的弊病之一。如果过多的模块中适用，会产生如下情况：

1. 容易重复覆盖（当然我不知道有没有做override）
2. 找不到service.xxxx的来源，只有本模块开发者知道，对于团队合作不利。
3. 无法定义自有service等对象，因为被系统占用。

至于glue等，一样的道理。

容错机制

容错对于一套架构来做很重要，在nodejs的服务架构中特别重要，因为在child_process中错误捕获方式很多，我不清楚贵架构有没有做处理。我例举一些情况：

1. 断网
2. 语法错误
3. 进程奔溃
4. 请求丢失
5. ......等等

特别强调下请求丢失，有没有做请求的trace_id，在全局容错中捕获请求错误同时让请求能够response。

特殊业务模型

比如说，daruk开启了多进程(cluster)模式，那么我现在有这样一个需求：我要编写一套基于进程隔离的自动打包前端代码的程序

1. 我开启一个新进程，独立处理当前打包任务。
2. 打包时候调用npm run build
3. 需要将编译信息通过socket打出到前端页面（通过cluster的websocket输出）
4. 打包结束关闭进程。

特点是每次打包开启一个新的进程进行隔离，那么在daruk中是否可以做到。因为在我看来，daruk没有涉及到自定义子进程模型，而仅仅是cluster模型。

最后

以上是我的愚见。

in the official website

the only one example is:

// src/glues/mysql/index.ts
import { Daruk } from "daruk";
import mysql from "./connect";

export default function(daruk: Daruk) {
  return mysql;
}

but in real production, my code is:

export default async function (daruk: Daruk) {
  const mongodb = await mongoose.connect(dbUrl, {
    useCreateIndex: true,
    useNewUrlParser: true
  })
  const db = mongodb.connection
  db.on('connected', () => {
    debug(`Mongoose connection open to ${dbUrl}.`)
  })
  db.on('error', (err) => {
    debug('Mongoose connection error: ' + err)
    throw err
  })
  db.on('disconnected', () => {
    debug('Mongoose connection disconnected')
  })
  return db
}

but I read the source code, I think this will run error

如何在DbTimer里面读取使用provide注册的Db

import { CronJob, Daruk, DarukServer, provide, inject, timer, TimerClass } from "daruk";

const main = async function () {
	try {
		const app = DarukServer();

		@provide("Db")
		class Db { }

		@timer()
		class DbTimer implements TimerClass {

			@inject("Db") private Db!: Db;

			public cronTime!: string;

			public initTimer(daruk: Daruk) {
				this.cronTime = '* * * * * *';
			}

			public onTick(cron: CronJob, daruk: Daruk) {
				console.log(this.Db);
			}
		}

		app.binding();
		app.listen(8899);

	} catch (error) {
		console.log(error);
	}
};

main(); // Error: No matching bindings found for serviceIdentifier: Db

as we all know, React.js have setState to change states. and in our Daruk, how about when user code Daruk.itils.function1 = () => {} and function1 have assigned

https://darukjs.com/tutorial/lifecycle.html

Daruk, a typescript web framework.

To Reproduce

1. use a windows PC
2. clone this repo
3. run npm install or yarn install

In the docs, i find that the controllers are routers. Daruk will recursively read the files in the controllers directory, using the file name as the routing path.

If i want to deprecate or temporarily deprecate some routers, i must delete the routes in the corresponding controllers, even the whole controllers.

Is there any other elegant way to control routers or controller？Such as an ignore file, exclude flag or any other way.

提示：
'yarn' 不是内部或外部命令，也不是可运行的程序
或批处理文件。

这个必须要用yarn吗？

是否有后续的迭代计划和 TODO

想贡献代码，有没有什么途径

I don't know if the vscode setting has other uses. At least we should remove the icon config because I have not installed the extension.

we can reference from
https://github.com/vuetifyjs/vuetify/blob/master/.travis.yml

Describe the bug
A clear and concise description of what the bug is.

koa-router is NOT actively maintained. It may have bugs.
@koa/router is a fork of it and has the same APIs. And it's developed by the official Koa team.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Who is using Daruk in production?

// middleware/index.ts
export default function (daruk: Daruk) {
  daruk.config.staticPath
}

// config.index.ts
import { Daruk } from 'daruk'
export default function (daruk: Daruk) {
  return {
    staticPath: 'xxx'
  }
}

but display:

TS2339: Property 'staticPath' does not exist on type 'Config'

问题

源码

https://darukjs.com/tutorial/install.html#%E7%BC%96%E5%86%99-tsconfig-json-%E6%96%87%E4%BB%B6

Daruk, a typescript web framework.