Merge remote-tracking branch 'bp/main'

waitingsong · Feb 26, 2024 · 11088cc · 11088cc
2 parents ba06acd + 411d4f9
commit 11088cc
Show file tree

Hide file tree

Showing 21 changed files with 148 additions and 56 deletions.
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -11,5 +11,6 @@ rules:
   "@typescript-eslint/no-unused-vars": 0
   "node/no-unpublished-import": 0
   "@typescript-eslint/prefer-ts-expect-error": 0
+  "@typescript-eslint/no-extraneous-class": 0
   "unicorn/filename-case": 0
 
diff --git a/.githooks/commit-msg b/.githooks/commit-msg
@@ -6,8 +6,10 @@
 # Date: 2023.07.21
 #
 
-if [[ -f $HOME/.nvm/nvm.sh ]]; then
-  . $HOME/.nvm/nvm.sh
+if [[ -z $NVM_DIR ]]; then
+  if [[ -f $HOME/.nvm/nvm.sh ]]; then
+    . $HOME/.nvm/nvm.sh
+  fi
 fi
 
 branch=$( git branch | grep \* | cut -d ' ' -f2 )

diff --git a/.githooks/pre-commit.sample b/.githooks/pre-commit.sample
@@ -8,8 +8,10 @@
 # Date: 2017.02.09
 #
 
-if [[ -f $HOME/.nvm/nvm.sh ]]; then
-  . $HOME/.nvm/nvm.sh
+if [[ -z $NVM_DIR ]]; then
+  if [[ -f $HOME/.nvm/nvm.sh ]]; then
+    . $HOME/.nvm/nvm.sh
+  fi
 fi
 
 if git rev-parse --verify HEAD >/dev/null 2>&1
@@ -28,7 +30,7 @@ fi
 # ------------- parse ts
 files=$(git diff --cached --name-only --diff-filter=ACMR $against|grep '\.ts$')
 if [[ $files != "" ]] ; then
-  # echo $files | xargs eslint --fix 
+  # echo $files | xargs eslint --fix
   npm run lint
   rc=$?
   if [[ $rc != 0 ]] ; then

diff --git a/.githooks/pre-push.sample b/.githooks/pre-push.sample
@@ -10,9 +10,10 @@
 remote="$1"
 url="$2"
 
-
-if [[ -f $HOME/.nvm/nvm.sh ]]; then
-  . $HOME/.nvm/nvm.sh
+if [[ -z $NVM_DIR ]]; then
+  if [[ -f $HOME/.nvm/nvm.sh ]]; then
+    . $HOME/.nvm/nvm.sh
+  fi
 fi
 
 z40=0000000000000000000000000000000000000000

diff --git a/.github/workflows/benchmark.yml.example b/.github/workflows/benchmark.yml.example
@@ -20,14 +20,14 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 
       - name: Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-lerna
         env:
           cache-name: cache-lerna

diff --git a/.github/workflows/nodejs-win.yml.example b/.github/workflows/nodejs-win.yml.example
@@ -17,14 +17,14 @@ jobs:
         os: [windows-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 
       - name: Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-lerna-win
         env:
           cache-name: cache-lerna-win

diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -17,14 +17,14 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 
       - name: Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-lerna
         env:
           cache-name: cache-lerna

diff --git a/.github/workflows/npm-manual-publish.yml b/.github/workflows/npm-manual-publish.yml
@@ -22,7 +22,7 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # pulls all commits (needed for lerna / semantic release to correctly version)
           fetch-depth: "0"
@@ -34,13 +34,13 @@ jobs:
           git config --global --add safe.directory $cwd
           git fetch --depth=1 origin +refs/tags/*:refs/tags/*
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           registry-url: 'https://registry.npmjs.org'
 
       - name: Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-lerna
         env:
           cache-name: cache-lerna

diff --git a/.github/workflows/npm-publish-wo-test.yml b/.github/workflows/npm-publish-wo-test.yml
@@ -22,7 +22,7 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # pulls all commits (needed for lerna / semantic release to correctly version)
           fetch-depth: "0"
@@ -34,13 +34,13 @@ jobs:
           git config --global --add safe.directory $cwd
           git fetch --depth=1 origin +refs/tags/*:refs/tags/*
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           registry-url: 'https://registry.npmjs.org'
 
       - name: Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-lerna
         env:
           cache-name: cache-lerna

diff --git a/.scripts/set-env-local.sh.example b/.scripts/set-env-local.sh.example
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+
+export MIDWAY_SERVER_ENV=local
+export NODE_ENV=local
+export OTEL_EXPORTER_OTLP_ENDPOINT="http://127.0.0.1:4317"
+export TS_NODE_PROJECT="test/tsconfig.json"
+export POSTGRES_HOST="127.0.0.1"
+export POSTGRES_PORT="5432"
+export POSTGRES_DB=""
+export POSTGRES_USER="postgres"
+export POSTGRES_PASSWORD="postgres"
+export ALI_ALB_IPS="120.55"
+export ALI_ALB_GROUPID="sgp-7z"
+export ALI_ECS_AID="LTAI5"
+export ALI_ECS_ASECRET="Dr"
+export ALI_ECS_IDS=""
+export ALI_ECS_IPS=""
+export ALI_OSS_AID="LTAI4"
+export ALI_OSS_ASECRET="FRK"
+export ALI_OSS_ENDPOINT="https://oss-cn-hangzhou.aliyuncs.com"
+export ALI_OSS_BUCKET=""
+
diff --git a/.scripts/set-env-test.sh.example b/.scripts/set-env-test.sh.example
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+
+export MIDWAY_SERVER_ENV=unittest
+export NODE_ENV=unittest
+export OTEL_EXPORTER_OTLP_ENDPOINT="http://127.0.0.1:4317"
+export TS_NODE_PROJECT="test/tsconfig.json"
+export POSTGRES_HOST="127.0.0.1"
+export POSTGRES_PORT="5432"
+export POSTGRES_DB=""
+export POSTGRES_USER="postgres"
+export POSTGRES_PASSWORD="postgres"
+export ALI_ALB_IPS="120.55"
+export ALI_ALB_GROUPID="sgp-7z"
+export ALI_ECS_AID="LTAI5"
+export ALI_ECS_ASECRET="Dr"
+export ALI_ECS_IDS=""
+export ALI_ECS_IPS=""
+export ALI_OSS_AID="LTAI4"
+export ALI_OSS_ASECRET="FRK"
+export ALI_OSS_ENDPOINT="https://oss-cn-hangzhou.aliyuncs.com"
+export ALI_OSS_BUCKET=""
+
diff --git a/.vscode/launch.json.example b/.vscode/launch.json.example
@@ -83,7 +83,6 @@
       ],
       "runtimeExecutable": "npm",
       "skipFiles": [
-        "**/node_modules/**",
         "**/node_modules/rxjs/**",
         "<node_internals>/**",
         "<node_internals>/**/*.js"

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -7,7 +7,7 @@
   "editor.tabSize": 2,
   "editor.wordWrap": "on",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "eslint.run": "onSave",
   "eslint.validate": [

diff --git a/package.json b/package.json
@@ -7,12 +7,13 @@
   "devDependencies": {
     "@commitlint/cli": "18",
     "@commitlint/config-conventional": "18",
-    "@midwayjs/mock": "^3.14.0",
-    "@midwayjs/swagger": "^3.14.0",
+    "@midwayjs/mock": "^3.15.0",
+    "@midwayjs/swagger": "^3.15.0",
+    "@midwayjs/validate": "^3.15.0",
     "@types/koa": "2",
     "@types/koa": "2",
     "@types/mocha": "10",
-    "@types/node": "20",
+    "@types/node": "20.11",
     "@waiting/eslint-config": "^9.1.1",
     "@waiting/shared-core": "^23.0.0",
     "@waiting/shared-types": "^23.0.0",
@@ -25,8 +26,9 @@
     "madge": "^6.1.0",
     "mocha": "10",
     "mocha-lcov-reporter": "1",
-    "mwtsc": "^1.4.0",
-    "nx": "17",
+    "mwtsc": "^1.7.0",
+    "nx": "18",
+    "swagger-ui-dist": "^5.11.0",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.8",
     "tsconfig-paths": "4",
@@ -44,6 +46,7 @@
     "add:pkg": "sh .scripts/add-pkg.sh",
     "bp:add": "git remote add bp https://github.com/waitingsong/npm-mono-base",
     "bp:sync": "git fetch --all -v && git pull origin && git merge bp/main -m \"Merge remote-tracking branch 'bp/main'\" ",
+    "bp:sync-force": "git fetch --all -v && git pull origin && git merge bp/main --allow-unrelated-histories -m \"Merge remote-tracking branch 'bp/main'\" ",
     "bp:syncxo": "git fetch --all -v && git pull origin && git merge bp/main -m \"Merge remote-tracking branch 'bp/main'\" -Xours",
     "bootstrap": "npm i --loglevel info --disturl=https://npmmirror.com/dist/",
     "build": "sh .scripts/build.sh",

diff --git a/packages/mw-demo/.eslintrc.yml b/packages/mw-demo/.eslintrc.yml
@@ -5,6 +5,7 @@ parserOptions:
 rules:
   "@typescript-eslint/no-unused-vars": 0
   "@typescript-eslint/prefer-ts-expect-error": 0
+  "@typescript-eslint/no-extraneous-class": 0
   "import/no-extraneous-dependencies":
     - 2
     - packageDir:

diff --git a/packages/mw-demo/README.md b/packages/mw-demo/README.md
@@ -20,18 +20,31 @@ import { ILifeCycle } from '@midwayjs/core'
 import { Configuration } from '@midwayjs/decorator'
 import * as demo from '@mw-components/demo'
 
+import * as DefaultConfig from './config/config.default.js'
+import * as LocalConfig from './config/config.local.js'
+import * as UnittestConfig from './config/config.unittest.js'
+
 @Configuration({
+  importConfigs: [
+    {
+      default: DefaultConfig,
+      local: LocalConfig,
+      unittest: UnittestConfig,
+    },
+  ],
   imports: [
     demo,
   ],
-  importConfigs: [join(__dirname, 'config')],
 })
 export class ContainerConfiguration implements ILifeCycle { }
 
 ```
 
 ### Add Configurations
 
+### Swagger API
+- start `npm run build && npm run dev`
+- open `http://localhost:7001/swagger-ui/index.html` in browser
 
 ## License
 [MIT](LICENSE)

diff --git a/packages/mw-demo/package.json b/packages/mw-demo/package.json
@@ -32,8 +32,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@midwayjs/info": "^3.14.0",
-    "@mwcp/share": "*"
+    "@mwcp/otel": "20 - 22",
+    "@mwcp/share": "20 - 22"
   },
   "devDependencies": {
   },
@@ -51,6 +51,7 @@
     "bin",
     "database",
     "dist",
+    "src",
     "!**/*.spec.*",
     "!**/*.tsbuildinfo"
   ],

diff --git a/packages/mw-demo/src/app/default.controller.ts b/packages/mw-demo/src/app/default.controller.ts
@@ -3,26 +3,27 @@ import {
   Controller,
   Get,
 } from '@midwayjs/core'
+import { ApiResponse } from '@midwayjs/swagger'
+
+import { DefaultApi } from './default.types.js'
 
 import { Config, ConfigKey, Msg } from '##/lib/types.js'
 
 
-@Controller(`/_${ConfigKey.namespace}`)
+@Controller(DefaultApi.base)
 export class DefaultComponentController {
 
-  @_Config(ConfigKey.config) readonly config: Config
+  @_Config(ConfigKey.config) private readonly config: Config
 
-  @Get('/hello')
-  hello(): string {
-    this.valiateRoute()
+  @Get(DefaultApi.hello)
+  @ApiResponse({
+    type: 'string',
+    description: Msg.hello,
+  })
+  async hello(): Promise<string > {
+    void this.config
     return Msg.hello
   }
 
-  valiateRoute(): void {
-    if (! this.config.enableDefaultRoute) {
-      throw new Error('route is not enabled')
-    }
-  }
-
 }
 
diff --git a/packages/mw-demo/src/app/default.types.ts b/packages/mw-demo/src/app/default.types.ts
@@ -0,0 +1,7 @@
+import { ConfigKey } from '##/lib/types.js'
+
+
+export class DefaultApi {
+  static readonly base = `/_${ConfigKey.namespace}`
+  static readonly hello = '/hello'
+}