Feature/scope validator (#2)

* init scope validator

* 코드 스타일 수정 / Create scope-validator-factory.ts

* clean style

* setup pattern

* add pattern

* add more test

* fix request

* reinforce pattern matching
add test

* fix regular expression

* fix some style and make ScopeValidatorContext template

* add return type

* rename package scope-validator-core to scope-validator

Co-authored-by: jellybrick <[email protected]>

Author: Su-Yong

.eslintignore

@@ -2,3 +2,4 @@ script
 node_modules
 dist
 gulpfile.js
+jest.config.js

.eslintrc.json

@@ -11,14 +11,6 @@
     "plugin:prettier/recommended",
     "prettier/@typescript-eslint"
   ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module",
-    "project": [
-      "tsconfig.json"
-    ]
-  },
   "plugins": [
     "@typescript-eslint"
   ],

packages/scope-validator/.eslintignore

@@ -0,0 +1,5 @@
+script
+node_modules
+dist
+gulpfile.js
+jest.config.js

packages/scope-validator/.eslintrc.json

@@ -0,0 +1,13 @@
+{
+  "extends": [
+    "../../.eslintrc.json"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "project": [
+      "tsconfig.json"
+    ]
+  }
+}

packages/scope-validator/.gitignore

@@ -0,0 +1,121 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# intelliJ
+.idea/
+
+package-lock.json

packages/scope-validator/.npmignore

@@ -0,0 +1,3 @@
+*
+!dist/*
+!dist/**/*

packages/scope-validator/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

packages/scope-validator/gulpfile.js

@@ -0,0 +1,14 @@
+const gulp = require('gulp');
+const ts = require('gulp-typescript');
+
+const tsProject = ts.createProject(
+  process.env.NODE_ENV ? `tsconfig.${process.env.NODE_ENV.toLowerCase()}.json` : 'tsconfig.json'
+);
+
+gulp.task('default', () => {
+  return tsProject.src()
+    .pipe(tsProject())
+    .pipe(gulp.dest('dist')
+    );
+});
+

packages/scope-validator/jest.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  verbose: true,
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  testRegex: '\\.spec\\.ts$',
+  moduleFileExtensions: [
+    'ts',
+    'js'
+  ],
+  globals: {
+    'ts-jest': {
+      'diagnostics': true
+    }
+  }
+};

packages/scope-validator/lib/index.ts

@@ -0,0 +1,5 @@
+export { default as Pattern } from './pattern';
+export { default as ScopeValidator } from './scope-validator';
+export { default as ScopeValidatorContext } from './scope-validator-context';
+export { default as ScopeValidatorFactory } from './scope-validator-factory';
+export { default as ScopeValidatorManager } from './scope-validator-manager';

packages/scope-validator/lib/pattern.ts

@@ -0,0 +1,46 @@
+export default class Pattern {
+  str: string;
+
+  get regex(): RegExp {
+    const regex = this.str
+      .replace(/(\${\w+})/g, '*')
+      .replace(/[$^.+?]/g, '\\$&')
+      .replace(/\*/g, '(\\w+)');
+
+    return new RegExp(`^${regex}$`);
+  }
+
+  constructor(str: string) {
+    this.str = str;
+  }
+
+  test(compare: string): boolean {
+    return this.regex.test(compare);
+  }
+
+  getParameters(compare: string): Record<string, unknown> {
+    const result: Record<string, unknown> = {};
+
+    let parameterNames = this.str.split(/(?:\${|})/g);
+    parameterNames = parameterNames.filter((value, index) => index % 2);
+
+    const regexStr = this.str
+      .replace(/(\${\w+})/g, '*')
+      .replace(/[$^.+?]/g, '\\$&')
+      .replace(/\*/g, '(\\w+)')
+      .replace(/(\*)/g, ')(.+)(?:')
+      .replace(/^(.*)/, '(?:$&')
+      .replace(/(.*)$/, '$&)');
+
+    const regex = new RegExp(`^${regexStr}$`);
+
+    const parameterValues = compare.match(regex);
+    parameterValues?.shift();
+
+    parameterNames.forEach((name, index) => {
+      result[name] = parameterValues?.[index];
+    });
+
+    return result;
+  }
+}

packages/scope-validator/lib/scope-validator-context.ts

@@ -0,0 +1,5 @@
+export default interface ScopeValidatorContext<T> {
+  parameters?: Record<string, unknown>;
+
+  received?: T;
+}

packages/scope-validator/lib/scope-validator-factory.ts

@@ -0,0 +1,28 @@
+// eslint-disable-next-line max-classes-per-file
+import ScopeValidator from './scope-validator';
+import ScopeValidatorContext from './scope-validator-context';
+
+type ScopeValidatorFunction<T> = (
+  name: string,
+  context: ScopeValidatorContext<T>
+) => boolean;
+
+export default class ScopeValidatorFactory<T> {
+  static create<T = Record<string, unknown>>(
+    pattern: string,
+    func: ScopeValidatorFunction<T>
+  ): ScopeValidator<T> {
+    const CustomScopeValidator = class extends ScopeValidator<T> {
+      constructor() {
+        super(pattern);
+      }
+
+      // eslint-disable-next-line class-methods-use-this
+      validate(name: string, context: ScopeValidatorContext<T>): boolean {
+        return func(name, context);
+      }
+    };
+
+    return new CustomScopeValidator();
+  }
+}

packages/scope-validator/lib/scope-validator-manager.ts

@@ -0,0 +1,45 @@
+import ScopeValidator from './scope-validator';
+
+export default class ScopeValidatorManager<T> {
+  private readonly scopeValidators: ScopeValidator<T>[] = [];
+
+  private context?: T;
+
+  constructor(...scopeValidators: ScopeValidator<T>[]) {
+    this.use(...scopeValidators);
+  }
+
+  use(...scopeValidators: ScopeValidator<T>[]): void {
+    this.scopeValidators.push(...scopeValidators);
+  }
+
+  validateOne(scope: string): boolean {
+    const matchValidators = this.scopeValidators.filter((validator) =>
+      validator.test(scope)
+    );
+
+    return (
+      matchValidators.length >= 1 &&
+      matchValidators.every((validator) =>
+        validator.validate(scope, {
+          received: this.context,
+          parameters: validator.pattern.getParameters(scope),
+        })
+      )
+    );
+  }
+
+  validateMany(...scopes: string[]): boolean[] {
+    return scopes.map((scope) => this.validateOne(scope));
+  }
+
+  validate(scope: string[], context?: T): boolean[] {
+    this.setContext(context);
+
+    return this.validateMany(...scope);
+  }
+
+  setContext(context?: T): void {
+    this.context = context;
+  }
+}

packages/scope-validator/lib/scope-validator.ts

@@ -0,0 +1,17 @@
+import ScopeValidatorContext from './scope-validator-context';
+import Pattern from './pattern';
+
+export default abstract class ScopeValidator<T> {
+  pattern: Pattern;
+
+  protected constructor(pattern: string | Pattern) {
+    if (pattern instanceof Pattern) this.pattern = pattern;
+    else this.pattern = new Pattern(pattern);
+  }
+
+  test(str: string): boolean {
+    return this.pattern.test(str);
+  }
+
+  abstract validate(name: string, context: ScopeValidatorContext<T>): boolean;
+}

packages/scope-validator/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "scope-validator",
+  "version": "1.0.0",
+  "description": "Pattern matching based Oauth2.0 scope validation library",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "jest",
+    "build": "npm run clean && npm run compile",
+    "clean": "rm -rf ./dist",
+    "compile": "tsc",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "prepublishOnly": "cross-env NODE_ENV=production npm run build"
+  },
+  "author": "Su-Yong",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^14.10.1",
+    "cross-env": "^7.0.2",
+    "eslint": "^7.9.0",
+    "gulp": "^4.0.2",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "jest": "^26.4.2",
+    "ts-jest": "^26.3.0",
+    "typescript": "^4.0.2"
+  },
+  "types": "dist/index.d.ts"
+}