refactor: use tegg v3 (#370)

BREAKING CHANGE: use SingletonProto instead of ContextProto

Co-authored-by: killagu <killa123@126.com>

.github/workflows/nodejs.yml

@@ -45,7 +45,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Install Dependencies
-      run: npm i
+      run: npm i -g npminstall && npminstall
 
     - name: Continuous Integration
       run: npm run ci

.gitignore

@@ -117,4 +117,6 @@ dist
 .tern-port
 
 .idea
+.DS_Store
 run
+!test/ctx_register.js

DEVELOPER.md

@@ -8,31 +8,30 @@
 
 ```bash
 # 启动本地依赖服务
-$ docker-compose up -d
+docker-compose up -d
 
 # 关闭本地依赖服务
-$ docker-compose down
+docker-compose down
 ```
 
 > 手动初始化依赖服务参见[文档](./docs/setup.md)
 
-
 ## 本地开发
 
 ### 安装依赖
 
 ```bash
-$ npm install
+npm install
 ```
 
 ### 开发运行
 
 ```bash
 # 初始化数据库
-$ MYSQL_DATABASE=cnpmcore npm run prepare-database
+MYSQL_DATABASE=cnpmcore npm run prepare-database
 
 # 启动 Web 服务
-$ npm run dev
+npm run dev
 
 # 访问
 curl -v http://127.0.0.1:7001
@@ -41,22 +40,9 @@ curl -v http://127.0.0.1:7001
 ### 单元测试
 
 ```bash
-$ npm run test
+npm run test
 ```
 
-编写单测规范：
-
-- assert 断言库必须使用 require 引入
-
-```ts
-import assert = require('assert');
-```
-
-> CAUTION: don't use `import assert from 'assert'`
-> Just use old style import assert = require('assert') for assert module. This is limitation.
-> See https://github.com/power-assert-js/espower-typescript#caution-dont-use-import-assert-from-assert
-
-
 ## 项目结构
 
 ```
@@ -80,29 +66,32 @@ app
 ```
 
 common：
+
 - util：全局工具类
 - adapter：外部服务调用
 
 core：
+
 - entity：核心模型，实现业务行为
 - event：异步事件定义，以及消费，串联业务
 - service：核心业务
 - util：服务 core 内部，不对外暴露
 
 repository：
+
 - model：ORM 模型，数据定义
 - XXXRepository: 仓储接口，存储、查询过程
 
 port：
-- controller：HTTP controller
 
+- controller：HTTP controller
 
 ## Controller 开发指南
 
 目前只支持 HTTP 协议的 Controller，代码在 `app/port/controller` 目录下。
 基于类继承的模式来实现，类关系大致如下：
 
-```
+```txt
 +----------------------+   +----------------------+   +---------------+
 | PackageController.ts |   | PackageTagController |   | XxxController |
 +---------------+------+   +---+------------------+   +--+------------+
@@ -130,15 +119,15 @@ port：
 例如会封装 PackageEntity、PackageVersionEntity 等查询方法。
 
 ```ts
-  // try to get package entity, throw NotFoundError when package not exists
-  private async getPackageEntity(scope: string, name: string) {
-    const packageEntity = await this.packageRepository.findPackage(scope, name);
-    if (!packageEntity) {
-      const fullname = getFullname(scope, name);
-      throw new NotFoundError(`${fullname} not found`);
-    }
-    return packageEntity;
+// try to get package entity, throw NotFoundError when package not exists
+private async getPackageEntity(scope: string, name: string) {
+  const packageEntity = await this.packageRepository.findPackage(scope, name);
+  if (!packageEntity) {
+    const fullname = getFullname(scope, name);
+    throw new NotFoundError(`${fullname} not found`);
   }
+  return packageEntity;
+}
 ```
 
 ### 请求合法性校验三部曲

app/common/FileUtil.ts

@@ -4,7 +4,7 @@ import { setTimeout } from 'timers/promises';
 import path from 'path';
 import url from 'url';
 import { randomBytes } from 'crypto';
-import { EggContextHttpClient } from 'egg';
+import { EggContextHttpClient, HttpClientResponse } from 'egg';
 import dayjs from './dayjs';
 
 export async function createTempfile(dataDir: string, filename: string) {
@@ -37,9 +37,13 @@ export async function downloadToTempfile(httpclient: EggContextHttpClient,
   }
   throw lastError;
 }
-
+export interface Tempfile {
+  tmpfile: string;
+  headers: HttpClientResponse['res']['headers'];
+  timing: HttpClientResponse['res']['timing'];
+}
 async function _downloadToTempfile(httpclient: EggContextHttpClient,
-  dataDir: string, url: string, ignoreDownloadStatuses?: number[]) {
+  dataDir: string, url: string, ignoreDownloadStatuses?: number[]): Promise<Tempfile> {
   const tmpfile = await createTempfile(dataDir, url);
   const writeStream = createWriteStream(tmpfile);
   try {
@@ -50,7 +54,7 @@ async function _downloadToTempfile(httpclient: EggContextHttpClient,
       writeStream,
       timing: true,
       followRedirect: true,
-    });
+    }) as HttpClientResponse;
     if (status === 404 || (ignoreDownloadStatuses && ignoreDownloadStatuses.includes(status))) {
       const err = new Error(`Not found, status(${status})`);
       err.name = 'DownloadNotFoundError';

app/common/adapter/CacheAdapter.ts

@@ -1,13 +1,13 @@
 import {
-  ContextProto,
+  SingletonProto,
   AccessLevel,
   Inject,
 } from '@eggjs/tegg';
 import { Redis } from 'ioredis';
 
 const ONE_DAY = 3600 * 24;
 
-@ContextProto({
+@SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })
 export class CacheAdapter {

app/common/adapter/NFSAdapter.ts

@@ -1,6 +1,6 @@
 import { Readable } from 'stream';
 import {
-  ContextProto,
+  SingletonProto,
   AccessLevel,
   Inject,
 } from '@eggjs/tegg';
@@ -12,7 +12,7 @@ import { IncomingHttpHeaders } from 'http';
 
 const INSTANCE_NAME = 'nfsAdapter';
 
-@ContextProto({
+@SingletonProto({
   name: INSTANCE_NAME,
   accessLevel: AccessLevel.PUBLIC,
 })

app/common/adapter/NPMRegistry.ts

@@ -8,11 +8,16 @@ import {
   EggLogger,
   EggContextHttpClient,
   EggAppConfig,
+  HttpClientRequestOptions,
+  HttpClientResponse,
 } from 'egg';
-import { HttpMethod } from 'urllib/src/Request';
+
+type HttpMethod = HttpClientRequestOptions['method'];
 
 const INSTANCE_NAME = 'npmRegistry';
 
+export type RegistryResponse = { method: HttpMethod } & HttpClientResponse;
+
 @ContextProto({
   name: INSTANCE_NAME,
   accessLevel: AccessLevel.PUBLIC,
@@ -35,7 +40,7 @@ export class NPMRegistry {
     this.registryHost = registryHost;
   }
 
-  public async getFullManifests(fullname: string, retries = 3) {
+  public async getFullManifests(fullname: string, retries = 3): Promise<RegistryResponse> {
     // set query t=timestamp, make sure CDN cache disable
     // cache=0 is sync worker request flag
     const url = `${this.registry}/${encodeURIComponent(fullname)}?t=${Date.now()}&cache=0`;
@@ -60,7 +65,7 @@ export class NPMRegistry {
   }
 
   // app.put('/:name/sync', sync.sync);
-  public async createSyncTask(fullname: string) {
+  public async createSyncTask(fullname: string): Promise<RegistryResponse> {
     const url = `${this.registry}/${encodeURIComponent(fullname)}/sync?sync_upstream=true&nodeps=true`;
     // {
     //   ok: true,
@@ -70,18 +75,18 @@ export class NPMRegistry {
   }
 
   // app.get('/:name/sync/log/:id', sync.getSyncLog);
-  public async getSyncTask(fullname: string, id: string, offset: number) {
+  public async getSyncTask(fullname: string, id: string, offset: number): Promise<RegistryResponse> {
     const url = `${this.registry}/${encodeURIComponent(fullname)}/sync/log/${id}?offset=${offset}`;
     // { ok: true, syncDone: syncDone, log: log }
     return await this.request('GET', url);
   }
 
-  public async getDownloadRanges(registry: string, fullname: string, start: string, end: string) {
+  public async getDownloadRanges(registry: string, fullname: string, start: string, end: string): Promise<RegistryResponse> {
     const url = `${registry}/downloads/range/${start}:${end}/${encodeURIComponent(fullname)}`;
     return await this.request('GET', url);
   }
 
-  private async request(method: HttpMethod, url: string, params?: object, options?: object) {
+  private async request(method: HttpMethod, url: string, params?: object, options?: object): Promise<RegistryResponse> {
     const res = await this.httpclient.request(url, {
       method,
       data: params,
@@ -91,11 +96,10 @@ export class NPMRegistry {
       followRedirect: true,
       gzip: true,
       ...options,
-    });
+    }) as HttpClientResponse;
     this.logger.info('[NPMRegistry:request] %s %s, status: %s', method, url, res.status);
     return {
       method,
-      url,
       ...res,
     };
   }

app/common/adapter/changesStream/CnpmcoreChangesStream.ts

@@ -1,10 +1,10 @@
-import { ContextProto } from '@eggjs/tegg';
+import { SingletonProto } from '@eggjs/tegg';
 import { RegistryType } from '../../../common/enum/Registry';
 import { Registry } from '../../../core/entity/Registry';
 import { E500 } from 'egg-errors';
 import { AbstractChangeStream, RegistryChangesStream } from './AbstractChangesStream';
 
-@ContextProto()
+@SingletonProto()
 @RegistryChangesStream(RegistryType.Cnpmcore)
 export class CnpmcoreChangesStream extends AbstractChangeStream {
 

app/common/adapter/changesStream/CnpmjsorgChangesStream.ts

@@ -1,12 +1,12 @@
-import { ContextProto } from '@eggjs/tegg';
+import { SingletonProto } from '@eggjs/tegg';
 import { RegistryType } from '../../../common/enum/Registry';
 import { Registry } from '../../../core/entity/Registry';
 import { E500 } from 'egg-errors';
 import { AbstractChangeStream, RegistryChangesStream } from './AbstractChangesStream';
 
 const MAX_LIMIT = 10000;
 
-@ContextProto()
+@SingletonProto()
 @RegistryChangesStream(RegistryType.Cnpmjsorg)
 export class CnpmjsorgChangesStream extends AbstractChangeStream {
 

app/common/adapter/changesStream/NpmChangesStream.ts

@@ -1,10 +1,10 @@
-import { ContextProto } from '@eggjs/tegg';
+import { SingletonProto } from '@eggjs/tegg';
 import { E500 } from 'egg-errors';
 import { RegistryType } from '../../../common/enum/Registry';
 import { Registry } from '../../../core/entity/Registry';
 import { AbstractChangeStream, ChangesStreamChange, RegistryChangesStream } from './AbstractChangesStream';
 
-@ContextProto()
+@SingletonProto()
 @RegistryChangesStream(RegistryType.Npm)
 export class NpmChangesStream extends AbstractChangeStream {
 

app/core/service/BinarySyncerService.ts

@@ -1,7 +1,7 @@
 import { rm } from 'fs/promises';
 import {
   AccessLevel,
-  ContextProto,
+  SingletonProto,
   Inject,
 } from '@eggjs/tegg';
 import {
@@ -50,7 +50,7 @@ function isoNow() {
   return new Date().toISOString();
 }
 
-@ContextProto({
+@SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })
 export class BinarySyncerService extends AbstractService {

app/core/service/BugVersionService.ts

@@ -1,4 +1,4 @@
-import { AccessLevel, ContextProto, Inject } from '@eggjs/tegg';
+import { AccessLevel, SingletonProto, Inject } from '@eggjs/tegg';
 import { EggLogger } from 'egg';
 import pMap from 'p-map';
 import { BugVersion } from '../entity/BugVersion';
@@ -7,7 +7,7 @@ import { DistRepository } from '../../repository/DistRepository';
 import { getScopeAndName } from '../../common/PackageUtil';
 import { CacheService } from './CacheService';
 
-@ContextProto({
+@SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })
 export class BugVersionService {

app/core/service/CacheService.ts

@@ -1,6 +1,6 @@
 import {
   AccessLevel,
-  ContextProto,
+  SingletonProto,
   Inject,
 } from '@eggjs/tegg';
 import { CacheAdapter } from '../../common/adapter/CacheAdapter';
@@ -30,7 +30,7 @@ type TotalData = {
 };
 const TOTAL_DATA_KEY = '__TOTAL_DATA__';
 
-@ContextProto({
+@SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })
 export class CacheService extends AbstractService {

app/core/service/ChangesStreamService.ts

@@ -2,7 +2,7 @@ import os from 'os';
 import { setTimeout } from 'timers/promises';
 import {
   AccessLevel,
-  ContextProto,
+  SingletonProto,
   EggObjectFactory,
   Inject,
 } from '@eggjs/tegg';
@@ -21,7 +21,7 @@ import { getScopeAndName } from '../../common/PackageUtil';
 import { ScopeManagerService } from './ScopeManagerService';
 import { PackageRepository } from '../../repository/PackageRepository';
 
-@ContextProto({
+@SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })
 export class ChangesStreamService extends AbstractService {

app/core/service/CreateHookTriggerService.ts

@@ -1,4 +1,4 @@
-import { AccessLevel, ContextProto, Inject } from '@eggjs/tegg';
+import { AccessLevel, SingletonProto, Inject } from '@eggjs/tegg';
 import { AbstractService } from '../../common/AbstractService';
 import { HookType } from '../../common/enum/Hook';
 import { TaskState } from '../../common/enum/Task';
@@ -12,7 +12,7 @@ import { TaskService } from './TaskService';
 import { isoNow } from '../../common/LogUtil';
 import { getScopeAndName } from '../../common/PackageUtil';
 
-@ContextProto({
+@SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })
 export class CreateHookTriggerService extends AbstractService {