feat: evaluation logic in typescript for nodejs sdk

.github/workflows/pr-evaluation-ts.yaml

@@ -0,0 +1,133 @@
+name: pr-evaluation-ts
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "evaluation/typescript/**"
+      - "!**/**.md"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+env:
+  NODE_VERSION: 20
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN || '' }}
+  EVALUATION_DIRECTORY: "evaluation/typescript"
+
+jobs:
+  install-dependencies:
+    name: Install dependencies
+    defaults:
+      run:
+        working-directory: ${{ env.EVALUATION_DIRECTORY }}
+    runs-on: ubuntu-latest
+    outputs:
+      YARN_CACHE_DIR: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Set yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        id: yarn-cache
+        with:
+          path: |
+            **/node_modules
+            **/.eslintcache
+            ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Init
+        run: make init
+
+  lint:
+    name: Lint
+    defaults:
+      run:
+        working-directory: ${{ env.EVALUATION_DIRECTORY }}
+    needs: install-dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - uses: actions/cache@v4
+        id: yarn-cache
+        with:
+          path: |
+            **/node_modules
+            **/.eslintcache
+            ${{ needs.install-dependencies.outputs.YARN_CACHE_DIR }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Format
+        run: make fmt
+      - name: Lint
+        run: make lint
+
+  unit-test:
+    name: Unit test
+    defaults:
+      run:
+        working-directory: ${{ env.EVALUATION_DIRECTORY }}
+    needs: install-dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - uses: actions/cache@v4
+        id: yarn-cache
+        with:
+          path: |
+            **/node_modules
+            **/.eslintcache
+            ${{ needs.install-dependencies.outputs.YARN_CACHE_DIR }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Generated proto code
+        run: make gen_proto
+      - name: Unit test
+        run: make test
+
+  build:
+    name: Build
+    defaults:
+      run:
+        working-directory: ${{ env.EVALUATION_DIRECTORY }}
+    needs: install-dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - uses: actions/cache@v4
+        id: yarn-cache
+        with:
+          path: |
+            **/node_modules
+            **/.eslintcache
+            ${{ needs.install-dependencies.outputs.YARN_CACHE_DIR }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Generated proto code
+        run: make gen_proto
+      - name: Package Build
+        run: make build

.github/workflows/pr-go.yaml

@@ -8,6 +8,7 @@ on:
     paths-ignore:
       - "ui/**"
       - "**/**.md"
+      - "evaluation/typescript/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

evaluation/typescript/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+
+node_modules
+yarn-error.log
+lib
+__dist
+__lib
+__test
+__e2e
+dist
+.vscode/launch.json
+src/google/
+src/protoc-gen-openapiv2/ 
+src/proto/

evaluation/typescript/.npmignore

@@ -0,0 +1,30 @@
+.DS_Store
+.vscode
+__dist
+__lib
+__test
+__e2e
+e2e
+example
+src
+tools
+.eslintignore
+.eslintrc.js
+.gitignore
+.nvmrc
+.npmignore
+.prettierignore
+.prettierrc.js
+ava-e2e.config.mjs
+ava-test.config.mjs
+babel-e2e.config.js
+babel-test.config.js
+babel.config.js
+renovate.json
+Makefile
+tsconfig.json
+tsconfig.test.json
+tslint.json
+yarn-error.log
+bootstrap.js
+index.ts

evaluation/typescript/.npmrc

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}

evaluation/typescript/.nvmrc

@@ -0,0 +1 @@
+16.13.0

evaluation/typescript/.prettierignore

@@ -0,0 +1,4 @@
+**/*.d.ts
+src/google/
+src/protoc-gen-openapiv2/
+src/proto/

evaluation/typescript/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: 'all',
+  arrowParens: 'always',
+};

evaluation/typescript/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.0.1"
+}

evaluation/typescript/Makefile

@@ -0,0 +1,125 @@
+NPM_BIN_DIR := $(CURDIR)/node_modules/.bin
+GENFILES_DIR := $(CURDIR)/__lib
+
+GIT_REVISION := $(shell git rev-parse --verify HEAD)
+
+export PACKAGE_NAME := $(shell node -p "require('./package.json').name")
+export CURRENT_VERSION := $(shell npm view $(PACKAGE_NAME) version 2>/dev/null || echo 0.0.0)
+export LOCAL_VERSION := $(shell node -p "require('./package.json').version")
+
+.PHONY: init
+init:
+	yarn
+
+.PHONY: clean
+clean:
+	rm -rf $(CURDIR)/__test $(CURDIR)/__lib
+
+.PHONY: build
+build: clean-build tsc copy-proto-external-api-files-to-lib rename-js
+
+.PHONY: clean-build
+clean-build:
+	rm -rf $(GENFILES_DIR)
+
+.PHONY: tsc
+tsc: clean
+	$(NPM_BIN_DIR)/tsc --project tsconfig.json
+	cp -r $(SRC_DIR)/proto __lib/
+
+.PHONY: build_test
+build_test: clean
+	$(NPM_BIN_DIR)/tsc --project tsconfig.test.json
+	cp -r $(SRC_DIR)/proto __test/
+
+.PHONY: rename-js
+rename-js:
+	$(NPM_BIN_DIR)/rename '$(GENFILES_DIR)/**/*.js' '{{f}}.mjs'
+
+.PHONY: test
+test: build_test
+	$(NPM_BIN_DIR)/ava --config ava.config.mjs
+
+.PHONY: fmt
+fmt: tsfmt
+
+.PHONY: tsfmt
+tsfmt:
+	$(NPM_BIN_DIR)/prettier --write '$(CURDIR)/src/**/*.ts'
+
+.PHONY: lint
+lint:
+	$(NPM_BIN_DIR)/eslint
+
+.PHONY: fixLintErrors
+fixLintErrors:
+	$(NPM_BIN_DIR)/eslint . --fix
+
+.PHONY: copy-proto-external-api-files-to-lib
+copy-proto-external-api-files-to-lib:
+	$(NPM_BIN_DIR)/cpx '$(SRC_DIR)/protoc-gen-openapiv2/**/*.{js,d.ts}' $(GENFILES_DIR)/protoc-gen-openapiv2
+	$(NPM_BIN_DIR)/cpx '$(SRC_DIR)/google/**/*.{js,d.ts}' $(GENFILES_DIR)/google
+
+.PHONY: copy-genfiles
+copy-genfiles:
+	@rm -rf $(CURDIR)/lib
+	$(NPM_BIN_DIR)/cpx '$(GENFILES_DIR)/**/*.{mjs,d.ts}' $(CURDIR)/lib
+	$(NPM_BIN_DIR)/cpx '$(GENFILES_DIR)/bucketeer.*' $(CURDIR)/lib
+	@find $(CURDIR)/lib -type f -exec chmod 644 {} +
+	$(NPM_BIN_DIR)/rename '$(CURDIR)/lib/**/*.js' '{{f}}.mjs'
+	$(NPM_BIN_DIR)/babel lib --extensions '.mjs' --config-file "$(CURDIR)/babel.config.js" --out-dir "lib"
+
+.PHONY: publish-dry
+publish-dry: copy-genfiles
+	npm publish --dry-run
+
+.PHONY: publish
+publish: copy-genfiles
+ifeq ($(shell $(NPM_BIN_DIR)/semver -r ">$(CURRENT_VERSION)" $(LOCAL_VERSION) ),$(LOCAL_VERSION))
+	npm publish --access public
+else
+	@echo "$(LOCAL_VERSION) exists. skip publish."
+endif
+
+####################################
+# Generate proto definition files
+####################################
+
+ROOT_DIR := $(CURDIR)/../..
+SRC_DIR := $(CURDIR)/src
+PROTOBUF_INCLUDE_DIR := $(ROOT_DIR)/proto/external/protocolbuffers/protobuf/v23.4
+GOOGLEAPIS := $(ROOT_DIR)/proto/external/googleapis/googleapis/83e756a66b80b072bd234abcfe89edf459090974
+OPENAPI := $(ROOT_DIR)/proto/external/openapiv2
+NPM_BIN_DIR := $(CURDIR)/node_modules/.bin
+
+.PHONY: gen_proto
+gen_proto: clean_proto gen_proto_external_api
+	protoc \
+	--plugin=protoc-gen-ts=$(NPM_BIN_DIR)/protoc-gen-ts \
+	--plugin=protoc-gen-js=$(NPM_BIN_DIR)/protoc-gen-js \
+	--js_out=import_style=commonjs,binary:$(SRC_DIR) \
+	--ts_out=service=grpc-web:$(SRC_DIR) \
+	-I $(ROOT_DIR) \
+	-I $(PROTOBUF_INCLUDE_DIR) \
+	-I $(GOOGLEAPIS) \
+	-I $(OPENAPI) \
+	$(shell find $(ROOT_DIR)/proto -type f -name "*.proto" -not -path "**/external/*.proto" -not -path "**/auth/*.proto" -not -path "**/experiment/*.proto" -not -path "**/test/*.proto" -not -path "**/push/*.proto" -not -path "**/notification/*.proto"  -not -path "**/eventpersisterdwh/*.proto" -not -path "**/eventcounter/*.proto" -not -path "**/environment/*.proto" -not -path "**/batch/*.proto" -not -path "**/autoops/*.proto" -not -path "**/auditlog/*.proto" -not -path "**/account/*.proto" -not -path "**/openapi/web_default_settings.proto"  -not -path "**/google/protobuf/*.proto" -not -path "**/google/api/*.proto" -not -path "**/protoc-gen-openapiv2/options/*.proto")
+
+
+.PHONY: gen_proto_external_api
+gen_proto_external_api:
+	protoc \
+	--plugin=protoc-gen-ts=$(NPM_BIN_DIR)/protoc-gen-ts \
+	--plugin=protoc-gen-js=$(NPM_BIN_DIR)/protoc-gen-js \
+	--js_out=import_style=commonjs,binary:$(SRC_DIR) \
+	--ts_out=service=grpc-web:$(SRC_DIR) \
+	-I $(PROTOBUF_INCLUDE_DIR) \
+	-I $(GOOGLEAPIS) \
+	-I $(OPENAPI) \
+	$(shell find $(GOOGLEAPIS) -type f -name "*.proto") $(shell find $(OPENAPI) -type f -name "*.proto")
+
+.PHONY: clean_proto
+clean_proto:
+	rm -rf $(SRC_DIR)/proto/
+	rm -rf $(SRC_DIR)/google/
+	rm -rf $(SRC_DIR)/protoc-gen-openapiv2/

evaluation/typescript/README.md

@@ -0,0 +1,9 @@
+# Evaluation module for Node.JS
+
+## Setup
+```export NPM_TOKEN="YOUR_NPM_TOKEN"```
+```make init```
+```make copy_proto_generated_code```
+
+## Unit tests
+```make test```

evaluation/typescript/babel.config.js

@@ -0,0 +1,7 @@
+module.exports = function (api) {
+  api.cache(true);
+
+  return {
+    presets: ['@babel/preset-env'],
+  };
+};

evaluation/typescript/eslint.config.mjs

@@ -0,0 +1,27 @@
+import tsEslint from 'typescript-eslint';
+import tsParser from '@typescript-eslint/parser';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+
+export default [
+  {
+    files: ['src/**/*.ts', 'test/**/*.ts'],
+    ignores: ['**/*.d.ts', 'src/google/', 'src/protoc-gen-openapiv2/', 'src/proto/'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        sourceType: 'module',
+        project: [`tsconfig.json`, `tsconfig.test.json`],
+      },
+      globals: {
+        node: true,
+      },
+    },
+    plugins: {
+      ...tsEslint.configs.recommended,
+      eslintPluginPrettierRecommended,
+    },
+    rules: {
+      quotes: ['error', 'single', { avoidEscape: true }],
+    },
+  },
+];