Integrate best practices (#39)

* updated vscode settings

* added config, schema, upgraded sdk-nestjs to latest version

* added functionality for config yaml

* improved startup experience

* cache warmer app fix

* fixed queue worker app

* fixed transactions processor, deleted confings

* unified app module for tx processor

* some more simplifications

* processed queue module in the new simplified way

* cache warmer app processing

* simplified api

* major refactoring

* small improvements

* better loading of db entities

* added linting rules

* fixed metrics service import

* deleted abi, simplified linting rules, simplified package json

* code formatting, simplified eslint rules

* moved examples in apps/api

* added annotation to token service

* more restrictive dependencies

* implemented env-specific loaders

.env.devnet

@@ -0,0 +1 @@
+API_URL=https://devnet-api.multiversx.com

.env.mainnet

@@ -0,0 +1 @@
+API_URL=https://api.multiversx.com

.env.testnet

@@ -0,0 +1 @@
+API_URL=https://testnet-api.multiversx.com

.eslintrc.js

@@ -8,12 +8,55 @@ module.exports = {
   extends: [
     'plugin:@typescript-eslint/recommended',
     // 'plugin:prettier/recommended',
+    'plugin:boundaries/strict',
   ],
   root: true,
   env: {
     node: true,
     jest: true,
   },
+  settings: {
+    "import/resolver": {
+      typescript: {
+        alwaysTryTypes: true,
+        project: 'tsconfig.json'
+      },
+    },
+    'boundaries/elements': [
+      {
+        type: 'apps/api',
+        pattern: 'apps/api',
+      },
+      {
+        type: 'apps/cache-warmer',
+        pattern: 'apps/cache-warmer',
+      },
+      {
+        type: 'apps/queue-worker',
+        pattern: 'apps/queue-worker',
+      },
+      {
+        type: 'apps/transactions-processor',
+        pattern: 'apps/transactions-processor',
+      },
+      {
+        type: 'libs/common',
+        pattern: 'libs/common'
+      },
+      {
+        type: 'libs/database',
+        pattern: 'libs/database'
+      },
+      {
+        type: 'libs/entities',
+        pattern: 'libs/entities'
+      },
+      {
+        type: 'libs/services',
+        pattern: 'libs/services'
+      },
+    ]
+  },
   rules: {
     "@typescript-eslint/no-explicit-any": ["off"],
     "@typescript-eslint/no-unused-vars": ["off"],
@@ -28,6 +71,79 @@ module.exports = {
     "semi": ["error"],
     "comma-dangle": ["error", "always-multiline"],
     "eol-last": ["error"],
+    'no-restricted-imports': ['error', {
+      patterns: ['libs/*', 'apps/*', '**/apps', '**/libs'],
+    }],
+    "boundaries/element-types": ["error", {
+      default: 'disallow',
+      rules: [
+        {
+          from: 'apps/api',
+          allow: ['libs/common', 'libs/entities', 'libs/services']
+        },
+        {
+          from: 'apps/cache-warmer',
+          allow: ['libs/common', 'libs/entities', 'libs/services']
+        },
+        {
+          from: 'apps/queue-worker',
+          allow: ['libs/common', 'libs/entities', 'libs/services']
+        },
+        {
+          from: 'apps/transactions-processor',
+          allow: ['libs/common', 'libs/entities', 'libs/services']
+        },
+        {
+          from: 'libs/database',
+          allow: ['libs/common', 'libs/entities']
+        },
+        {
+          from: 'libs/services',
+          allow: ['libs/common', 'libs/entities', 'libs/database']
+        },
+        {
+          from: 'libs/common',
+          allow: ['libs/entities']
+        }
+      ]
+    }],
+    'boundaries/no-unknown': [2],
+    'boundaries/no-unknown-files': [2],
+    'boundaries/no-private': [0]
   },
   ignorePatterns: ['.eslintrc.js'],
+  "overrides": [
+    {
+      "files": ["libs/common/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": ["error", {
+          "patterns": ["@libs/common*"]
+        }]
+      }
+    },
+    {
+      "files": ["libs/database/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": ["error", {
+          "patterns": ["@libs/database*"]
+        }]
+      }
+    },
+    {
+      "files": ["libs/entities/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": ["error", {
+          "patterns": ["@libs/entities*"]
+        }]
+      }
+    },
+    {
+      "files": ["libs/services/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": ["error", {
+          "patterns": ["@libs/services*"]
+        }]
+      }
+    }
+  ]
 };

.gitignore

@@ -36,4 +36,8 @@ lerna-debug.log*
 
 # Configs
 **/*/config/config.yaml
-**/*/config/config.custom.yaml
+**/*/config/config.custom.yaml
+
+**/*/config/schema.json
+**/*/config/config.yaml
+**/*/config/schema.yaml

.vscode/settings.json

@@ -1,9 +1,7 @@
 {
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
-  "eslint.validate": [
-    "javascript"
-  ],
+  "eslint.validate": ["javascript"],
   "editor.formatOnSave": true
-}
+}

apps/api/src/config/app-config.module.ts

@@ -0,0 +1,13 @@
+import { Global, Module } from "@nestjs/common";
+import { AppConfigService } from "./app-config.service";
+
+@Global()
+@Module({
+  providers: [
+    AppConfigService,
+  ],
+  exports: [
+    AppConfigService,
+  ],
+})
+export class AppConfigModule { }

apps/api/src/config/app-config.service.ts

@@ -0,0 +1,7 @@
+import { configuration } from "@libs/common/config/configuration";
+import { Injectable } from "@nestjs/common";
+
+@Injectable()
+export class AppConfigService {
+  readonly config = configuration().apps.api;
+}

apps/api/src/endpoints/auth/auth.controller.ts

@@ -7,11 +7,9 @@ import { ApiResponse, ApiTags } from "@nestjs/swagger";
 export class AuthController {
 	@Get("/auth")
 	@UseGuards(NativeAuthGuard)
-	@ApiResponse({
-		status: 200,
-		description: 'Authorizes the user and returns the encoded address',
-	})
-	authorize(@NativeAuth('address') address: string
+	@ApiResponse({ status: 200, description: 'Authorizes the user and returns the encoded address' })
+	authorize(
+		@NativeAuth('address') address: string
 	): string {
 		return address;
 	}

apps/api/src/endpoints/auth/auth.module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { AuthController } from './auth.controller';
+import { DynamicModuleUtils } from '@libs/common';
+
+@Module({
+  controllers: [
+    AuthController,
+  ],
+  providers: [
+    DynamicModuleUtils.getNestJsApiConfigService(),
+  ],
+})
+export class AuthModule { }