Merge pull request #5569 from nocodb/refactor/rename-package-names

Refactor - rename package folder names in monorepo

.github/workflows/ci-cd.yml

@@ -9,7 +9,6 @@ on:
         paths:
             - "packages/nc-gui/**"
             - "packages/nocodb/**"
-            - "packages/nocodb-nest/**"
             - ".github/workflows/ci-cd.yml"
             - "tests/playwright/**"
     pull_request:
@@ -18,7 +17,6 @@ on:
         paths:
             - "packages/nc-gui/**"
             - "packages/nocodb/**"
-            - "packages/nocodb-nest/**"
             - ".github/workflows/ci-cd.yml"
             - "tests/playwright/**"
 
@@ -60,10 +58,10 @@ jobs:
           working-directory: ./packages/nocodb-sdk
           run: npm run build:main
         - name: Install dependencies
-          working-directory: ./packages/nocodb-nest
+          working-directory: ./packages/nocodb
           run: npm install
         - name: run unit tests
-          working-directory: ./packages/nocodb-nest
+          working-directory: ./packages/nocodb
           run: npm run test:unit
     unit-tests-pg:
       runs-on: ubuntu-20.04
@@ -101,10 +99,10 @@ jobs:
           working-directory: ./packages/nocodb-sdk
           run: npm run build:main
         - name: Install dependencies
-          working-directory: ./packages/nocodb-nest
+          working-directory: ./packages/nocodb
           run: npm install
         - name: run unit tests
-          working-directory: ./packages/nocodb-nest
+          working-directory: ./packages/nocodb
           run: npm run test:unit:pg
     playwright-mysql-1:
       if: ${{ github.event_name == 'push' || contains(github.event.pull_request.labels.*.name, 'trigger-CI') || !github.event.pull_request.draft }}

.github/workflows/playwright-test-workflow.yml

@@ -69,7 +69,7 @@ jobs:
         working-directory: ./packages/nc-gui
         run: npm run ci:run
       - name: Run backend
-        working-directory: ./packages/nocodb-nest
+        working-directory: ./packages/nocodb
         run: |
           npm install
           npm run watch:run:playwright > ${{ inputs.db }}_${{ inputs.shard }}_test_backend.log &
@@ -109,13 +109,13 @@ jobs:
       # Quick tests (pg on sqlite shard 0 and sqlite on sqlite shard 1)
       - name: Run quick server and tests (pg)
         if: ${{ inputs.db == 'sqlite' && inputs.shard == '1' }}
-        working-directory: ./packages/nocodb-nest
+        working-directory: ./packages/nocodb
         run: |
           kill -9 $(lsof -t -i:8080)
           npm run watch:run:playwright:pg:cyquick &
       - name: Run quick server and tests (sqlite)
         if: ${{ inputs.db == 'sqlite' && inputs.shard == '2' }}
-        working-directory: ./packages/nocodb-nest
+        working-directory: ./packages/nocodb
         run: |
           kill -9 $(lsof -t -i:8080)
           npm run watch:run:playwright:quick > quick_${{ inputs.shard }}_test_backend.log &
@@ -132,7 +132,7 @@ jobs:
         if: ${{ inputs.db == 'sqlite' }}
         with:
           name: quick-backend-log-${{ inputs.shard }}
-          path: ./packages/nocodb-nest/quick_${{ inputs.shard }}_test_backend.log
+          path: ./packages/nocodb/quick_${{ inputs.shard }}_test_backend.log
           retention-days: 2
       - uses: actions/upload-artifact@v3
         if: ${{ inputs.db == 'sqlite' }}
@@ -157,5 +157,5 @@ jobs:
         if: always()
         with:
           name: backend-logs-${{ inputs.db }}-${{ inputs.shard }}
-          path: ./packages/nocodb-nest/${{ inputs.db }}_${{ inputs.shard }}_test_backend.log
+          path: ./packages/nocodb/${{ inputs.db }}_${{ inputs.shard }}_test_backend.log
           retention-days: 2

.github/workflows/release-docker.yml

@@ -43,7 +43,7 @@ jobs:
   buildx:
     runs-on: ubuntu-latest
     env:
-      working-directory: ./packages/nocodb-nest
+      working-directory: ./packages/nocodb
     steps:
       - name: Get Docker Repository
         id: get-docker-repository

.github/workflows/release-npm.yml

@@ -35,7 +35,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     env:
-      working-directory: ./packages/nocodb-nest
+      working-directory: ./packages/nocodb
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -62,7 +62,7 @@ jobs:
           targetEnv=${{ github.event.inputs.targetEnv || inputs.targetEnv }} targetVersion=${{ github.event.inputs.tag || inputs.tag }} npm run build:copy:publish &&
           cd ../.. &&
           sleep 60 &&
-          targetEnv=${{ github.event.inputs.targetEnv || inputs.targetEnv }} node scripts/upgradeNcGui.js && cd packages/nocodb-nest && npm install && npm run obfuscate:build:publish
+          targetEnv=${{ github.event.inputs.targetEnv || inputs.targetEnv }} node scripts/upgradeNcGui.js && cd packages/nocodb && npm install && npm run obfuscate:build:publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Create Pull Request

.github/workflows/release-pr.yml

@@ -13,7 +13,6 @@ on:
       - "packages/nc-gui/**"
       - "packages/nc-plugin/**"
       - "packages/nocodb/**"
-      - "packages/nocodb-nest/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

.gitignore

@@ -81,8 +81,8 @@ mongod
 *.sln
 
 .history
-/packages/nocodb/docker/main.js.LICENSE.txt
-/packages/nocodb/noco_log.db
+/packages/nocodb-legacy/docker/main.js.LICENSE.txt
+/packages/nocodb-legacy/noco_log.db
 
 # NC_DBs
 #=========

.run/Clear metadb.run.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Drop metadb" type="NodeJSConfigurationType" path-to-js-file="deleteMetaDb.js" working-dir="$PROJECT_DIR$/packages/nocodb/src/run">
+  <configuration default="false" name="Drop metadb" type="NodeJSConfigurationType" path-to-js-file="$PROJECT_DIR$/packages/nocodb-legacy/src/run/deleteMetaDb.js" working-dir="$PROJECT_DIR$/packages/nocodb-legacy/src/run">
     <method v="2" />
   </configuration>
 </component>

package.json

@@ -34,7 +34,7 @@
   "scripts": {
     "lint:staged:playwright": "cd ./tests/playwright; npx lint-staged; cd -",
     "build:common": "cd ./packages/nocodb-sdk; npm install; npm run build",
-    "install:common": "cd ./packages/nocodb; npm install ../nocodb-sdk; cd ../nc-gui; npm install ../nocodb-sdk",
+    "install:common": "cd packages/nocodb-legacy; npm install ../nocodb-sdk; cd ../nc-gui; npm install ../nocodb-sdk",
     "start:web": "npm run build:common ; cd ./packages/nc-gui; npm install ../nocodb-sdk; npm install; ANT_MESSAGE_DURATION=0.5 npm run dev",
     "test:travis": "git log --pretty=format:'%h' -n 1 --skip 1 | xargs  lerna run test:travis --since",
     "lerna:install": "git log --pretty=format:'%h' -n 1 --skip 1 | xargs  lerna bootstrap --ignore nc-cli --since",

packages/nocodb-legacy/.gitignore

@@ -0,0 +1,22 @@
+node_modules
+build
+src/**.js
+.idea/*
+dist
+coverage
+.nyc_output
+*.log
+
+yarn.lock
+server
+help
+.serverless
+projects/test/config.xc.json
+xc.db*
+noco.db*
+/nc/
+/docker/main.js
+test_meta.db
+test_sakila.db
+test_sakila_*.db
+.env

packages/nocodb-legacy/Dockerfile

@@ -31,9 +31,9 @@ COPY ./package*.json ./
 COPY ./docker/main.js ./docker/main.js
 #COPY ./docker/start.sh /usr/src/appEntry/start.sh
 COPY ./docker/start-litestream.sh /usr/src/appEntry/start.sh
-COPY ./public/css/*.css ./docker/public/css/
-COPY ./public/js/*.js ./docker/public/js/
-COPY ./public/favicon.ico ./docker/public/
+COPY ./src/lib/public/css/*.css ./docker/public/css/
+COPY ./src/lib/public/js/*.js ./docker/public/js/
+COPY ./src/lib/public/favicon.ico ./docker/public/
 
 # install production dependencies,
 # reduce node_module size with modclean & removing sqlite deps,

packages/nocodb-legacy/README.md

@@ -0,0 +1,22 @@
+# Nocodb
+
+## Running locally
+
+Even though this package is a backend project, you can still visit the dashboard as it includes ``nc-lib-gui``. 
+
+```sh
+npm install
+npm run watch:run
+# open localhost:8080/dashboard in browser
+```
+
+As ``nc-lib-gui`` is hosted in the npm registry, for local development, you should run ``nc-gui`` separately. 
+
+If you wish to combine the frontend and backend together in your local development environment, you may use ``packages/nc-lib-gui`` as a local dependency by updating the ``packages/nocodb/package.json`` to 
+
+```json
+"nc-lib-gui": "file:../nc-lib-gui"
+```
+
+In this case, whenever there are any changes made in the frontend, you need to run ``npm run build:copy`` under ``packages/nc-gui/``.
+

packages/nocodb-legacy/docker/webpack.config.js

@@ -1,25 +1,17 @@
 const nodeExternals = require('webpack-node-externals');
+// const CopyPlugin = require('copy-webpack-plugin');
 const webpack = require('webpack')
 const TerserPlugin = require('terser-webpack-plugin');
+// const JavaScriptObfuscator = require('webpack-obfuscator');
 
 module.exports = {
-  entry: './src/run/dockerEntry.ts',
+  entry: './docker/index.js',
   module: {
     rules: [
-      {
-        test: /\.tsx?$/,
-        exclude: /node_modules/,
-        use: {
-          loader: 'ts-loader',
-          options: {
-            transpileOnly: true,
-          },
-        },
-      },
     ],
   },
   resolve: {
-    extensions: ['.tsx', '.ts', '.js', '.json'],
+    extensions: ['.js'],
   },
   output: {
     path: require('path').resolve("./docker"),

packages/nocodb-legacy/package.json

@@ -16,40 +16,44 @@
     "url": "https://github.com/nocodb/nocodb/issues"
   },
   "license": "AGPL-3.0-or-later",
+  "keywords": [],
   "scripts": {
-    "build": "nest build",
+    "build": "run-s clean && run-p build:*",
     "build:obfuscate": "EE=true webpack  --config webpack.config.js",
+    "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
     "obfuscate:build:publish": "npm run build:obfuscate && npm publish .",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "start": "nest start",
-    "start:dev": "nest start --watch",
-    "start:debug": "nest start --debug --watch",
-    "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "lint": "eslint src --ext .ts --fix",
+    "test": "cross-env TS_NODE_PROJECT=tsconfig.json mocha -r ts-node/register   src/__tests__/**/*.test.ts --recursive",
+    "unit-test": "cross-env TS_NODE_PROJECT=tsconfig.json mocha --require ts-node/register 'src/__tests__/unit/**/*.test.ts' --recursive --check-leaks --exit",
+    "local:test:unit": "cross-env TS_NODE_PROJECT=./tests/unit/tsconfig.json mocha -r ts-node/register   tests/unit/index.test.ts --recursive --timeout 300000  --exit --delay",
+    "test:unit": "cross-env TS_NODE_PROJECT=./tests/unit/tsconfig.json mocha -r ts-node/register   tests/unit/index.test.ts --recursive --timeout 300000  --exit --delay",
+    "test:unit:pg": "cp tests/unit/.pg.env tests/unit/.env; cross-env TS_NODE_PROJECT=./tests/unit/tsconfig.json mocha -r ts-node/register   tests/unit/index.test.ts --recursive --timeout 300000  --exit --delay",
+    "test:lint": "tslint --project . && prettier \"src/**/*.ts\" --list-different",
+    "watch": "run-s clean build:main && run-p \"build:main -- -w\" \"test:unit -- --watch\"",
+    "clean": "trash build src/test",
+    "docker:build": "EE=\"true-xc-test\" webpack  --config docker/webpack.config.js",
+    "watch:build": "nodemon -e ts,js -w ./src -x npm run build",
+    "watch:run": "cross-env NC_DISABLE_TELE1=true EE=true nodemon -e ts,js -w ./src -x \"ts-node src/run/docker --log-error --project tsconfig.json\"",
     "watch:run:playwright": "rm -f ./test_noco.db; cross-env DATABASE_URL=sqlite:./test_noco.db PLAYWRIGHT_TEST=true NC_DISABLE_TELE=true EE=true nodemon -e ts,js -w ./src -x \"ts-node src/run/testDocker --log-error --project tsconfig.json\"",
     "watch:run:playwright:quick": "rm -f ./test_noco.db; cp ../../tests/playwright/fixtures/noco_0_91_7.db ./test_noco.db; cross-env DATABASE_URL=sqlite:./test_noco.db NC_DISABLE_TELE=true EE=true nodemon -e ts,js -w ./src -x \"ts-node src/run/docker --log-error --project tsconfig.json\"",
     "watch:run:playwright:pg:cyquick": "rm -f ./test_noco.db; cp ../../tests/playwright/fixtures/noco_0_91_7.db ./test_noco.db; cross-env NC_DISABLE_TELE=true EE=true nodemon -e ts,js -w ./src -x \"ts-node src/run/dockerRunPG_CyQuick.ts --log-error --project tsconfig.json\"",
-    "test:unit": "cross-env TS_NODE_PROJECT=./tests/unit/tsconfig.json mocha -r ts-node/register   tests/unit/index.test.ts --recursive --timeout 300000  --exit --delay",
-    "test:unit:pg": "cp tests/unit/.pg.env tests/unit/.env; cross-env TS_NODE_PROJECT=./tests/unit/tsconfig.json mocha -r ts-node/register   tests/unit/index.test.ts --recursive --timeout 300000  --exit --delay",
-    "docker:build": "EE=\"true-xc-test\" webpack  --config docker/webpack.config.js"
+    "watch:run:mysql": "cross-env  NC_DISABLE_TELE=true EE=true nodemon -e ts,js -w ./src -x \"ts-node src/run/dockerRunMysql --log-error --project tsconfig.json\"",
+    "watch:run:pg": "cross-env  NC_DISABLE_TELE=true EE=true nodemon -e ts,js -w ./src -x \"ts-node src/run/dockerRunPG --log-error --project tsconfig.json\"",
+    "run": "ts-node src/run/docker",
+    "watch:try": "nodemon -e ts,js -w ./src -x \"ts-node src/run/try --log-error --project tsconfig.json\"",
+    "example:docker": "ts-node src/run/docker.ts",
+    "redoc": "nodemon -e ts,json -w ./src/schema -x \"ts-node src/run/redoc --log-error --project tsconfig.json\""
+  },
+  "engines": {
+    "node": ">=8.9"
   },
   "dependencies": {
     "@google-cloud/storage": "^5.7.2",
     "@graphql-tools/merge": "^6.0.12",
-    "@nestjs/common": "^9.4.0",
-    "@nestjs/core": "^9.4.0",
-    "@nestjs/jwt": "^10.0.3",
-    "@nestjs/mapped-types": "*",
-    "@nestjs/passport": "^9.0.3",
-    "@nestjs/platform-express": "^9.4.0",
-    "@nestjs/serve-static": "^3.0.1",
     "@sentry/node": "^6.3.5",
-    "@types/chai": "^4.2.12",
     "airtable": "^0.11.3",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
@@ -62,8 +66,8 @@
     "boxen": "^5.0.0",
     "bullmq": "^1.81.1",
     "clear": "^0.1.0",
-    "colors": "^1.4.0",
-    "compare-versions": "^6.0.0-rc.1",
+    "colors": "1.4.0",
+    "compare-versions": "^5.0.1",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
     "cron": "^1.8.2",
@@ -101,17 +105,17 @@
     "mkdirp": "^2.1.3",
     "morgan": "^1.10.0",
     "mssql": "^6.2.0",
-    "multer": "^1.4.4",
-    "mysql2": "^3.2.0",
+    "multer": "^1.4.2",
+    "mysql2": "^2.2.5",
     "nanoid": "^3.1.20",
-    "nc-help": "^0.2.87",
-    "nc-lib-gui": "0.106.0",
+    "nc-help": "0.2.87",
+    "nc-lib-gui": "0.106.1",
     "nc-plugin": "0.1.2",
     "ncp": "^2.0.0",
     "nocodb-sdk": "file:../nocodb-sdk",
     "nodemailer": "^6.4.10",
     "object-hash": "^3.0.0",
-    "os-locale": "^6.0.2",
+    "os-locale": "^5.0.0",
     "papaparse": "^5.3.1",
     "parse-database-url": "^0.3.0",
     "passport": "^0.4.1",
@@ -119,78 +123,69 @@
     "passport-custom": "^1.1.1",
     "passport-github": "^1.1.0",
     "passport-google-oauth20": "^2.0.0",
-    "passport-jwt": "^4.0.1",
+    "passport-jwt": "^4.0.0",
     "passport-local": "^1.0.0",
-    "pg": "^8.10.0",
-    "reflect-metadata": "^0.1.13",
+    "pg": "^8.3.0",
     "request": "^2.88.2",
     "request-ip": "^2.1.3",
     "rmdir": "^1.2.0",
-    "rxjs": "^7.2.0",
     "slash": "^3.0.0",
     "socket.io": "^4.4.1",
-    "sqlite3": "^5.1.6",
+    "sqlite3": "5.1.2",
     "tedious": "^15.0.0",
     "tinycolor2": "^1.4.2",
     "twilio": "^3.55.1",
     "unique-names-generator": "^4.3.1",
-    "uuid": "^9.0.0",
+    "uuid": "^8.2.0",
     "validator": "^13.1.1",
     "xc-core-ts": "^0.1.0",
     "xlsx": "^0.18.5"
   },
   "devDependencies": {
-    "@nestjs/cli": "^9.0.0",
-    "@nestjs/schematics": "^9.0.0",
-    "@nestjs/testing": "^9.0.0",
-    "@nestjsplus/dyn-schematics": "^1.0.12",
-    "@types/express": "^4.17.13",
-    "@types/jest": "^29.5.0",
-    "@types/mocha": "^10.0.1",
-    "@types/multer": "^1.4.7",
-    "@types/node": "18.15.11",
-    "@types/passport-google-oauth20": "^2.0.11",
-    "@types/passport-jwt": "^3.0.8",
-    "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
+    "@types/chai": "^4.2.12",
+    "@types/express": "^4.17.7",
+    "@types/inflection": "^1.5.28",
+    "@types/lru-cache": "^5.1.0",
+    "@types/minio": "^7.0.7",
+    "@types/mkdirp": "^1.0.2",
+    "@types/mocha": "^8.0.1",
+    "@types/node": "^18.0.0",
+    "@types/nodemailer": "^6.4.0",
+    "@types/supertest": "^2.0.10",
+    "@types/tinycolor2": "^1.4.3",
+    "@typescript-eslint/eslint-plugin": "^4.0.1",
+    "@typescript-eslint/parser": "^4.0.1",
     "chai": "^4.2.0",
-    "copy-webpack-plugin": "^11.0.0",
+    "copy-webpack-plugin": "^6.4.0",
     "cross-env": "^7.0.3",
+    "cz-conventional-changelog": "^2.1.0",
     "eslint": "^7.8.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-functional": "^3.0.2",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-prettier": "^4.0.0",
-    "jest": "29.5.0",
     "mocha": "^10.1.0",
-    "nodemon": "^2.0.22",
+    "nodemon": "^2.0.7",
+    "npm-run-all": "^4.1.5",
     "prettier": "^2.7.1",
-    "source-map-support": "^0.5.20",
-    "supertest": "^6.1.3",
-    "ts-jest": "29.0.5",
-    "ts-loader": "^9.2.3",
-    "ts-node": "^10.0.0",
-    "tsconfig-paths": "4.2.0",
-    "typescript": "^4.7.4",
-    "webpack-cli": "^5.0.1"
+    "supertest": "^4.0.2",
+    "terser-webpack-plugin": "^4.1.0",
+    "trash-cli": "^3.0.0",
+    "ts-loader": "^8.0.5",
+    "ts-node": "^8.10.2",
+    "typescript": "^4.0.3",
+    "webpack": "^4.44.1",
+    "webpack-cli": "^3.3.12",
+    "webpack-node-externals": "^2.5.2",
+    "webpack-obfuscator": "^1.12.0"
   },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
   },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
+  "prettier": {
+    "singleQuote": true
   }
 }