Next Release Aug 2024 (#122)

* add eslint * add eslint * add eslint * add eslint * fix eslint errors * remove lock file * fix eslint errors * Change date schema to be compatible with ortto schema * Fix unit test based on changes * Fix lint errors * Fix lint errors * change main-pipeline * feat: change GivethNotificationTypes seed * fix: remove brake line * change Dockerfile * change Dockerfile to use yarn * remove userId from notify reward amount ortto request * add email to payload for notify reward * Fix tests for notify reward * fix: create migration to change givbacks notification * Change scripts to use ts-node for running migrations * Add tsconfig-paths module to application * ensure dataSource initialize before running migrations * Update packages * Use the previous version of ts * Allow ts to resolve json modules * Run pretest scripts before test migrations * Make pretest scripts stand alone * Revert changes on pre-test-scripts.ts * remove pre-test-scripts from migration commands * downgrade typeorm version to fix migration execution * run migrations using scripts * Upgrade typeorm version again * add create test database step to the staging-pipeline.yml * add wait for database step to the staging-pipeline.yml * change database port in the staging-pipeline.yml * change database name in the staging-pipeline.yml and remove redundant steps * change database name in the main-pipeline.yml * add migration for create Qacc third party * support Qacc on Ortto * Add Qacc to microServices --------- Co-authored-by: Ramin <[email protected]> Co-authored-by: ali ebrahimi <[email protected]> Co-authored-by: Reshzera <[email protected]> Co-authored-by: Ali Ebrahimi <[email protected]> Co-authored-by: Rafael E. Oshiro <[email protected]> Co-authored-by: Amin Latifi <[email protected]>
Giveth · Aug 28, 2024 · 6ae372d · 6ae372d
1 parent f6e4fe6
commit 6ae372d
Show file tree

Hide file tree

Showing 61 changed files with 8,378 additions and 18,904 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/workflows/main-pipeline.yml b/.github/workflows/main-pipeline.yml
@@ -30,7 +30,7 @@ jobs:
         env:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: givethio
+          POSTGRES_DB: notification-center
         options: >-
           --health-cmd pg_isready
           --health-interval 10s
@@ -43,15 +43,15 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 18.14.0
+          node-version: 20.14.0
       - name: Install dependencies
-        run: npm ci
+        run: yarn install
       - name: Run linter
-        run: npm run lint
+        run: yarn lint
       - name: Run migrations
-        run: npm run db:migrate:run:test
+        run: yarn db:migrate:run:test
       - name: Run tests
-        run: npm run test
+        run: yarn test
 
   publish:
     needs: test
@@ -60,6 +60,10 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+      - name: Install Yarn
+        run: npm install -g yarn
+      - name: Install dependencies
+        run: yarn install
       - name: Build image and push to GitHub Packages
         uses: docker/build-push-action@v1
         with:

diff --git a/.github/workflows/staging-pipeline.yml b/.github/workflows/staging-pipeline.yml
@@ -28,7 +28,7 @@ jobs:
         env:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: givethio
+          POSTGRES_DB: notification-center
         options: >-
           --health-cmd pg_isready
           --health-interval 10s
@@ -41,15 +41,17 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 18.14.0
+          node-version: 20.14.0
+      - name: Install Yarn
+        run: npm install -g yarn
       - name: Install dependencies
-        run: npm ci
+        run: yarn install
       - name: Run linter
-        run: npm run lint
+        run: yarn lint
       - name: Run migrations
-        run: npm run db:migrate:run:test
+        run: yarn db:migrate:run:test
       - name: Run tests
-        run: npm run test
+        run: yarn test
 
   publish:
     needs: test
@@ -58,6 +60,13 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+
+      - name: Install Yarn
+        run: npm install -g yarn
+
+      - name: Install dependencies
+        run: yarn install
+
       - name: Build image and push to GitHub Packages
         uses: docker/build-push-action@v1
         with:

diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 #https://hub.docker.com/_/node?tab=tags&page=1
-FROM node:18.14.0
+FROM node:20.14.0
 
 WORKDIR /usr/src/app
 
@@ -10,7 +10,7 @@ COPY src ./src
 COPY migrations ./migrations
 COPY test ./test
 
-RUN npm ci
 RUN npm i -g pm2
-RUN npm run build #It will run prebuild script for generating swagger spec by tsoa as well
+RUN yarn install --frozen-lockfile
+RUN yarn build #It will run prebuild script for generating swagger spec by tsoa as well
 RUN cp -rv public ./dist
diff --git a/config/example.env b/config/example.env
@@ -14,6 +14,7 @@ REDIS_PASSWORD=
 
 SEGMENT_API_KEY=FAKE_API_KEY
 ORTTO_API_KEY=FAKE_API_KEY
+QACC_ORTTO_API_KEY=FAKE_API_KEY
 ORTTO_ACTIVITY_API=https://api-us.ortto.app/v1/activities/create
 
 #JWT_AUTHORIZATION_ADAPTER=siweMicroservice

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,76 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import _import from 'eslint-plugin-import';
+import unusedImports from 'eslint-plugin-unused-imports';
+import { fixupPluginRules } from '@eslint/compat';
+import tsParser from '@typescript-eslint/parser';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  {
+    ignores: ['node_modules/*', 'dist/*'],
+  },
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ),
+  {
+    plugins: {
+      import: fixupPluginRules(_import),
+      'unused-imports': unusedImports,
+    },
+
+    languageOptions: {
+      parser: tsParser,
+    },
+
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      'unused-imports/no-unused-imports': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+        },
+      ],
+
+      'prettier/prettier': [
+        'error',
+        {
+          arrowParens: 'avoid',
+          singleQuote: true,
+          semi: true,
+          tabWidth: 2,
+          useTabs: false,
+          trailingComma: 'all',
+          'jsdoc-format': false,
+          endOfLine: 'auto',
+        },
+      ],
+
+      'import/order': [
+        'error',
+        {
+          groups: [
+            'builtin',
+            'external',
+            ['internal', 'parent', 'sibling'],
+            'index',
+            'object',
+            'type',
+          ],
+        },
+      ],
+    },
+  },
+];
diff --git a/migrations/1678175596807-changeNotificationCopies.ts b/migrations/1678175596807-changeNotificationCopies.ts
@@ -1,4 +1,4 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
+import { MigrationInterface } from 'typeorm';
 import { getNotificationTypeByEventName } from '../src/repositories/notificationTypeRepository';
 import { NOTIFICATION_TYPE_NAMES } from '../src/types/general';
 
@@ -24,7 +24,7 @@ export class changeNotificationCopies1678175596807
     await notificationType.save();
   }
 
-  public async up(queryRunner: QueryRunner): Promise<void> {
+  public async up(): Promise<void> {
     if (
       process.env.NODE_ENV === 'test' ||
       process.env.NODE_ENV === 'development'
@@ -339,7 +339,7 @@ export class changeNotificationCopies1678175596807
     );
   }
 
-  public async down(queryRunner: QueryRunner): Promise<void> {
+  public async down(): Promise<void> {
     //
   }
 }
diff --git a/migrations/1681206838965-changeCancelProjectNotificationCopies.ts b/migrations/1681206838965-changeCancelProjectNotificationCopies.ts
@@ -1,4 +1,4 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
+import { MigrationInterface } from 'typeorm';
 import { getNotificationTypeByEventName } from '../src/repositories/notificationTypeRepository';
 import { NOTIFICATION_TYPE_NAMES } from '../src/types/general';
 
@@ -21,7 +21,7 @@ export class changeCancelProjectNotificationCopies1681206838965
     await notificationType.save();
   }
 
-  public async up(queryRunner: QueryRunner): Promise<void> {
+  public async up(): Promise<void> {
     if (
       process.env.NODE_ENV === 'test' ||
       process.env.NODE_ENV === 'development'
@@ -84,7 +84,7 @@ export class changeCancelProjectNotificationCopies1681206838965
     );
   }
 
-  public async down(queryRunner: QueryRunner): Promise<void> {
+  public async down(): Promise<void> {
     //
   }
 }
diff --git a/migrations/1682242459196-seedNotificationTypeForProjectGetNewRank.ts b/migrations/1682242459196-seedNotificationTypeForProjectGetNewRank.ts
@@ -3,13 +3,12 @@ import {
   NotificationType,
   SCHEMA_VALIDATORS_NAMES,
 } from '../src/entities/notificationType';
-import { MICRO_SERVICES, THIRD_PARTY_EMAIL_SERVICES } from '../src/utils/utils';
+import { MICRO_SERVICES } from '../src/utils/utils';
 import {
   NOTIFICATION_CATEGORY,
   NOTIFICATION_TYPE_NAMES,
 } from '../src/types/general';
 import { NOTIFICATION_CATEGORY_GROUPS } from '../src/entities/notificationSetting';
-import { SegmentEvents } from '../src/services/segment/segmentAnalyticsSingleton';
 
 // https://github.com/Giveth/notification-center/issues/6 , https://gist.github.com/MohammadPCh/24434d50bc9ccd9b74905c271ee05482
 // icons https://gist.github.com/MohammadPCh/31e2b750dd9aa54edb21dcc6e7332efb

diff --git a/migrations/1692698983844-changeNotificationCopies.ts b/migrations/1692698983844-changeNotificationCopies.ts
@@ -1,4 +1,4 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
+import { MigrationInterface } from 'typeorm';
 import { getNotificationTypeByEventName } from '../src/repositories/notificationTypeRepository';
 import { NOTIFICATION_TYPE_NAMES } from '../src/types/general';
 
@@ -21,7 +21,7 @@ export class changeNotificationCopies1692698983844
     await notificationType.save();
   }
 
-  public async up(queryRunner: QueryRunner): Promise<void> {
+  public async up(): Promise<void> {
     if (
       process.env.NODE_ENV === 'test' ||
       process.env.NODE_ENV === 'development'
@@ -85,7 +85,7 @@ export class changeNotificationCopies1692698983844
     );
   }
 
-  public async down(queryRunner: QueryRunner): Promise<void> {
+  public async down(): Promise<void> {
     //
   }
 }
diff --git a/migrations/1712683625687-addSuperFluidNotificationForAllUsers.ts b/migrations/1712683625687-addSuperFluidNotificationForAllUsers.ts
@@ -1,21 +1,23 @@
-import { MigrationInterface, QueryRunner } from "typeorm"
+import { MigrationInterface, QueryRunner } from 'typeorm';
 
-export class addSuperFluidNotificationForAllUsers1712683625687 implements MigrationInterface {
-    public async up(queryRunner: QueryRunner): Promise<void> {
-        // Fetch the notificationTypeIds for the "superfluid" categoryGroup
-        const notificationTypeIds = await queryRunner.query(`
+export class addSuperFluidNotificationForAllUsers1712683625687
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    // Fetch the notificationTypeIds for the "superfluid" categoryGroup
+    const notificationTypeIds = await queryRunner.query(`
             SELECT "id" FROM "notification_type" WHERE "categoryGroup" = 'superfluid';
         `);
 
-        // Fetch all unique userAddressIds
-        const userAddressIds = await queryRunner.query(`
+    // Fetch all unique userAddressIds
+    const userAddressIds = await queryRunner.query(`
             SELECT DISTINCT "userAddressId" FROM "notification_setting";
         `);
 
-        // For each userAddressId, insert a new row for each notificationTypeId
-        for (const { userAddressId } of userAddressIds) {
-            for (const { id: notificationTypeId } of notificationTypeIds) {
-                await queryRunner.query(`
+    // For each userAddressId, insert a new row for each notificationTypeId
+    for (const { userAddressId } of userAddressIds) {
+      for (const { id: notificationTypeId } of notificationTypeIds) {
+        await queryRunner.query(`
                     INSERT INTO "notification_setting" (
                         "allowNotifications", 
                         "allowEmailNotification", 
@@ -24,22 +26,22 @@ export class addSuperFluidNotificationForAllUsers1712683625687 implements Migrat
                         "userAddressId"
                     ) VALUES (true, true, true, ${notificationTypeId}, ${userAddressId});
                 `);
-            }
-        }
+      }
     }
+  }
 
-    public async down(queryRunner: QueryRunner): Promise<void> {
-        // Fetch the notificationTypeIds for the "superfluid" categoryGroup
-        const notificationTypeIds = await queryRunner.query(`
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    // Fetch the notificationTypeIds for the "superfluid" categoryGroup
+    const notificationTypeIds = await queryRunner.query(`
             SELECT "id" FROM "notification_type" WHERE "categoryGroup" = 'superfluid';
         `);
 
-        // Convert fetched rows to a list of IDs for the IN clause
-        const ids = notificationTypeIds.map((nt: { id: any; }) => nt.id).join(', ');
+    // Convert fetched rows to a list of IDs for the IN clause
+    const ids = notificationTypeIds.map((nt: { id: any }) => nt.id).join(', ');
 
-        // Delete the rows with the fetched notificationTypeIds for all userAddressIds
-        await queryRunner.query(`
+    // Delete the rows with the fetched notificationTypeIds for all userAddressIds
+    await queryRunner.query(`
             DELETE FROM "notification_setting" WHERE "notificationTypeId" IN (${ids});
         `);
-    }
+  }
 }