bump aragami

.dockerignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
+
+.git*
+Dockerfile
+.dockerignore

.eslintignore

+webpack.config.js
+dist/*
+build/*
\ No newline at end of file

.eslintrc.js

+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
\ No newline at end of file

.gitlab-ci.yml

+stages:
+  - install
+  - build
+  - deploy
+
+variables:
+  GIT_DEPTH: "1"
+
+npm_ci:
+  stage: install
+  tags:
+    - linux
+  script:
+    - npm ci
+  artifacts:
+    paths:
+      - node_modules
+
+.build_base:
+  stage: build
+  tags:
+    - linux
+  dependencies:
+    - npm_ci
+
+build:
+  extends: .build_base
+  script: npm run build
+  artifacts:
+    paths:
+      - dist/
+
+test:
+  extends: .build_base
+  script: npm run test
+
+upload_to_minio:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - aws s3 --endpoint=https://minio.mycard.moe:9000 sync --delete dist/full/ s3://nanahira/koishi-plugin/cache-aragami
+  only:
+    - master
+
+deploy_npm:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - apt update;apt -y install coreutils
+    - echo $NPMRC | base64 --decode > ~/.npmrc
+    - npm publish . --access public
+  only:
+    - master

.npmignore

+/install-npm.sh
+.git*
+/data
+/output
+/config.yaml
+.idea
+.dockerignore
+Dockerfile
+/src
+/dist/full
+/coverage
+/tests
+/dist/tests
+/dev
+/dist/dev
+/webpack.config.js
+/.eslint*
+.*ignore
+.prettierrc*

.prettierrc

+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
\ No newline at end of file

LICENSE

+The MIT License (MIT)
+
+Copyright (c) 2021 Nanahira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

dev/extras.ts

+import { Context } from 'koishi';
+
+export default class ExtrasInDev {
+  constructor(ctx: Context) {}
+}

dev/index.ts

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+import ConsolePlugin from '@koishijs/plugin-console';
+import SandboxPlugin from '@koishijs/plugin-sandbox';
+import DatabasePlugin from '@koishijs/plugin-database-memory';
+import * as Help from '@koishijs/plugin-help';
+import ExtrasInDev from './extras';
+
+const app = new App({
+  port: 14514,
+  host: 'localhost',
+  prefix: '.',
+});
+
+app.plugin(Help);
+
+// Console and sandbox
+app.plugin(SandboxPlugin);
+app.plugin(ConsolePlugin, {
+  open: false,
+});
+
+// Some services
+app.plugin(DatabasePlugin);
+
+// Some extras
+app.plugin(ExtrasInDev);
+
+// Target plugin
+app.plugin(TargetPlugin, {});
+
+app.start();

install-npm.sh

+#!/bin/bash
+npm install --save \
+	koishi-thirdeye
+
+npm install --save-peer \
+	koishi@latest
+
+npm install --save-dev \
+	@types/node \
+	typescript \
+	'@typescript-eslint/eslint-plugin@^4.28.2' \
+	'@typescript-eslint/parser@^4.28.2 '\
+	'eslint@^7.30.0' \
+	'eslint-config-prettier@^8.3.0' \
+	'eslint-plugin-prettier@^3.4.0' \
+	prettier \
+	raw-loader \
+	ts-loader \
+	webpack \
+	webpack-cli \
+	ws \
+	ts-node \
+	@koishijs/plugin-help@latest \
+	@koishijs/plugin-console@latest \
+	@koishijs/plugin-sandbox@latest \
+	@koishijs/plugin-database-memory \
+	jest \
+	ts-jest \
+	@types/jest

package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.2",
       "license": "MIT",
       "dependencies": {
-        "aragami": "^1.0.1",
+        "aragami": "^1.0.3",
         "koishi-thirdeye": "^11.0.6"
       },
       "devDependencies": {
@@ -2160,9 +2160,9 @@
       }
     },
     "node_modules/aragami": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/aragami/-/aragami-1.0.1.tgz",
-      "integrity": "sha512-oYJccBYoh4ki/er7+rJx0NJRZU3GOklROSdc1ZT/SZoPxYMYTZ70g1nrtPzPsL/P7z3SFYCJxQTprGGFL9l1bw==",
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/aragami/-/aragami-1.0.3.tgz",
+      "integrity": "sha512-R8v+Cj/lm+9iunI3BzulWYZFB0vyH5GCSB6oqWjynCdP+tMvQRNf6P1MHMdbAxNedb01QCyp/u04c4ZE6en3WQ==",
       "dependencies": {
         "better-lock": "^2.0.3",
         "class-transformer": "^0.5.1",
@@ -9746,9 +9746,9 @@
       }
     },
     "aragami": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/aragami/-/aragami-1.0.1.tgz",
-      "integrity": "sha512-oYJccBYoh4ki/er7+rJx0NJRZU3GOklROSdc1ZT/SZoPxYMYTZ70g1nrtPzPsL/P7z3SFYCJxQTprGGFL9l1bw==",
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/aragami/-/aragami-1.0.3.tgz",
+      "integrity": "sha512-R8v+Cj/lm+9iunI3BzulWYZFB0vyH5GCSB6oqWjynCdP+tMvQRNf6P1MHMdbAxNedb01QCyp/u04c4ZE6en3WQ==",
       "requires": {
         "better-lock": "^2.0.3",
         "class-transformer": "^0.5.1",

package.json

@@ -44,7 +44,7 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "aragami": "^1.0.1",
+    "aragami": "^1.0.3",
     "koishi-thirdeye": "^11.0.6"
   },
   "peerDependencies": {

src/config.ts

+// import 'source-map-support/register';
+import { SchemaProperty, RegisterSchema } from 'koishi-thirdeye';
+import { AragamiOptions, RedisDriverOptions } from 'aragami';
+
+@RegisterSchema()
+export class AragamiRedisConfig implements RedisDriverOptions {
+  @SchemaProperty({ description: 'Redis URI. ' })
+  uri?: string;
+}
+
+@RegisterSchema()
+export class AragamiConfig implements AragamiOptions {
+  constructor(config: AragamiConfigLike) {}
+
+  @SchemaProperty({ description: 'Redis 配置。' })
+  redis?: AragamiRedisConfig;
+
+  getConfig(): AragamiOptions {
+    const obj = { ...this };
+    if (!Object.getOwnPropertyNames(obj.redis || {}).length) {
+      delete obj.redis;
+    }
+    return obj;
+  }
+}
+
+export type AragamiConfigLike = AragamiOptions;

src/index.ts

+// import 'source-map-support/register';
+import { AragamiConfig } from './config';
+import {
+  DefinePlugin,
+  PartialDeep,
+  PluginSchema,
+  Provide,
+} from 'koishi-thirdeye';
+import { Context } from 'koishi';
+import { Aragami, AragamiOptions, WrapDecoratorBuilder } from 'aragami';
+export * from './config';
+export * from 'aragami';
+
+declare module 'koishi' {
+  interface Context {
+    aragami: AragamiPlugin;
+  }
+}
+
+@PluginSchema(AragamiConfig)
+@Provide('aragami', { immediate: true })
+@DefinePlugin({ name: 'cache-aragami' })
+export default class AragamiPlugin extends Aragami {
+  constructor(
+    ctx: Context,
+    _config: PartialDeep<AragamiConfig> & AragamiOptions,
+  ) {
+    super(_config.getConfig());
+  }
+}
+
+export const { UseCache, UseLock } = new WrapDecoratorBuilder(
+  (o) => o.__ctx.aragami,
+).build();

tests/sample.spec.ts

+import { App } from 'koishi';
+import TargetPlugin, { UseCache } from '../src';
+import { CacheKey, WithKey } from 'aragami';
+import { DefinePlugin, Provide, StarterPlugin } from 'koishi-thirdeye';
+
+describe('Test of plugin.', () => {
+  let app: App;
+
+  beforeEach(async () => {
+    app = new App();
+    app.plugin(TargetPlugin, {
+      // redis: { uri: 'redis://localhost:6379' },
+    });
+    await app.start();
+  });
+
+  class User {
+    @CacheKey()
+    name: string;
+    age: number;
+  }
+
+  it('should pass', async () => {
+    expect(app.aragami).toBeDefined();
+    const user = new User();
+    user.name = 'koishi';
+    user.age = 18;
+    await expect(app.aragami.set(user)).resolves.toBe(user);
+    const getUser = await app.aragami.get(User, 'koishi');
+    expect(getUser).toEqual(user);
+    expect(getUser).toBeInstanceOf(User);
+  });
+
+  it('should use wrapping decorator', async () => {
+    @Provide('test')
+    @DefinePlugin()
+    class MyPlugin extends StarterPlugin() {
+      @UseCache(User)
+      async getUser(@WithKey() name: string, age: number) {
+        const user = new User();
+        user.name = name;
+        user.age = age;
+        return user;
+      }
+    }
+    app.plugin(MyPlugin);
+    const instance: MyPlugin = app['test'];
+    expect(instance).toBeDefined();
+    await instance.getUser('Satori', 18);
+    await expect(app.aragami.has(User, 'Satori')).resolves.toBeTruthy();
+  });
+});

tsconfig.json

+{
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "commonjs",
+		"target": "es2021",
+		"esModuleInterop": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"declaration": true,
+		"sourceMap": true,
+		"skipLibCheck": true
+	},
+	"compileOnSave": true,
+	"allowJs": true,
+	"include": [
+		"*.ts",
+		"src/**/*.ts",
+		"tests/**/*.ts",
+		"dev/**/*.ts"
+	]
+}

webpack.config.js

+const path = require('path');
+const packgeInfo = require('./package.json');
+const { ESBuildMinifyPlugin } = require('esbuild-loader');
+
+function externalsFromDep() {
+  return Object.fromEntries(
+    [
+      ...Object.keys(packgeInfo.dependencies || {}),
+      ...Object.keys(packgeInfo.peerDependencies || {}),
+    ]
+      .filter((dep) => dep !== 'source-map-support')
+      .map((dep) => [dep, dep]),
+  );
+}
+
+const packAll = !!process.env.PACK_ALL;
+
+module.exports = {
+  entry: './src/index.ts',
+  mode: 'production',
+  target: 'node',
+  devtool: 'source-map',
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+      { test: /\.mustache$/, use: 'raw-loader' },
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+  output: {
+    filename: 'index.js',
+    library: {
+      type: 'commonjs',
+    },
+    path: path.resolve(__dirname, packAll ? 'dist/full' : 'dist'),
+  },
+  externals: {
+    koishi: 'koishi',
+    ...(packAll ? {} : externalsFromDep()),
+  },
+  optimization: {
+    minimizer: [
+      new ESBuildMinifyPlugin({
+        keepNames: true,
+      }),
+    ],
+  },
+};