Add project build step in CI - placeholder in build script (#6193)

* add scripts * remove webpack-web-server to avoid node-gyp error * fix lint errors * add doc --------- Co-authored-by: rotorsoft <[email protected]>
hicommonwealth · Jan 4, 2024 · a5b8019 · a5b8019
1 parent 8efbd79
commit a5b8019
Show file tree

Hide file tree

Showing 7 changed files with 77 additions and 1,355 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -57,14 +57,8 @@ jobs:
           path: '**/node_modules'
           key: ${{ matrix.node }}-${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
-      - name: Add node-gyp
-        run: yarn global add node-gyp
-
-      - name: Install dependencies
-        run: yarn --ignore-engines
-
-      - name: Init Db
-        run: cd packages/commonwealth && npx sequelize db:migrate
+      - name: Build project
+        run: yarn build-project
 
       - name: Cache browsers
         id: playwright-cache
@@ -154,14 +148,8 @@ jobs:
           path: '**/node_modules'
           key: ${{ matrix.node }}-${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
-      - name: Add node-gyp
-        run: yarn global add node-gyp
-
-      - name: Install dependencies
-        run: yarn --ignore-engines
-
-      - name: Init Db
-        run: cd packages/commonwealth && npx sequelize db:migrate
+      - name: Build project
+        run: yarn build-project
 
       - name: Cache browsers
         id: playwright-cache
@@ -250,14 +238,8 @@ jobs:
           path: '**/node_modules'
           key: ${{ matrix.node }}-${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
-      - name: Add node-gyp
-        run: yarn global add node-gyp
-
-      - name: Install dependencies
-        run: yarn --ignore-engines
-
-      - name: Init Db
-        run: cd packages/commonwealth && npx sequelize db:migrate
+      - name: Build project
+        run: yarn build-project
 
       - name: Cache browsers
         id: playwright-cache
@@ -360,6 +342,9 @@ jobs:
             exit 1
           fi
 
+      - name: Build libs
+        run: yarn workspace @hicommonwealth/core build
+
       - name: Run linter
         env:
           GITHUB_BASE_REF: ${{ github.base_ref }}
@@ -368,7 +353,7 @@ jobs:
       - name: Commonwealth Typecheck
         run: yarn --cwd packages/commonwealth check-types
 
-      - name: Dicsord-Bot Typecheck
+      - name: Discord-Bot Typecheck
         run: yarn --cwd packages/discord-bot check-types
 
   # These tests run quickly, so run them in a separate job
@@ -417,14 +402,8 @@ jobs:
           path: '**/node_modules'
           key: ${{ matrix.node }}-${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
-      - name: Add node-gyp
-        run: yarn global add node-gyp
-
-      - name: Install dependencies
-        run: yarn --ignore-engines
-
-      - name: Init Db
-        run: cd packages/commonwealth && npx sequelize db:migrate
+      - name: Build project
+        run: yarn build-project
 
       - name: Run unit tests
         run: yarn --cwd packages/commonwealth unit-test --forbid-only
@@ -501,14 +480,8 @@ jobs:
           path: '**/node_modules'
           key: ${{ matrix.node }}-${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
-      - name: Add node-gyp
-        run: yarn global add node-gyp
-
-      - name: Install dependencies
-        run: yarn --ignore-engines
-
-      - name: Init Db
-        run: cd packages/commonwealth && npx sequelize db:migrate
+      - name: Build project
+        run: yarn build-project
 
       ## EVM Section:
       - name: Start EVM Testnet

diff --git a/knowledge_base/Package-Scripts.md b/knowledge_base/Package-Scripts.md
@@ -73,6 +73,16 @@ If you add a script to the package.json, you must add documentation here, descri
 
 # Build Scripts
 
+## build-project
+
+Definition: `yarn global add node-gyp && yarn --ignore-engines && yarn workspace @hicommonwealth/core build && yarn workspace commonwealth migrate-db`
+
+Description: Temporary placeholder for common script used by the CI pipeline to:
+
+- Install dependencies
+- Incrementally build project with references (tsc -b)
+- Migrate DB
+
 ## build-all
 
 Definition: `NODE_OPTIONS=--max_old_space_size=4096 webpack --config webpack/webpack.prod.config.js --progress && yarn build-consumer`
@@ -521,4 +531,4 @@ Description: Starts existing dormant Cosmos devnet containers.
 
 Definition: `chmod u+x test/util/cosmos-chain-testing/v1/stop.sh && ./test/util/cosmos-chain-testing/v1/stop.sh && chmod u+x test/util/cosmos-chain-testing/v1beta1/stop.sh && ./test/util/cosmos-chain-testing/v1beta1/stop.sh && chmod u+x test/util/cosmos-chain-testing/ethermint/stop.sh && ./test/util/cosmos-chain-testing/ethermint/stop.sh`
 
-Description: Stop all Cosmos devnet containers.
+Description: Stop all Cosmos devnet containers.
diff --git a/package.json b/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "scripts": {
+    "build-project": "yarn global add node-gyp && yarn --ignore-engines && yarn workspace @hicommonwealth/core build && yarn workspace commonwealth migrate-db",
     "start": "yarn --cwd packages/commonwealth start",
     "build": "chmod u+x scripts/build.sh && ./scripts/build.sh",
     "clean": "find . -name node_modules -exec rm -rf {} \\;; yarn --ignore-engines",
@@ -23,7 +24,7 @@
     "lint-branch-warnings": "FAIL_WARNINGS=1 ./scripts/lint-branch.sh",
     "stylelint": "stylelint packages/commonwealth/client/styles/*",
     "chromatic": "chromatic --exit-zero-on-changes",
-    "prepare": "husky install & yarn workspace @hicommonwealth/core build",
+    "prepare": "husky install",
     "watch-core": "tsc --watch --project libs/core/tsconfig.json",
     "dev-server": "yarn workspace commonwealth start",
     "dev": "concurrently -k -c 'auto' -n 'core,server' 'yarn watch-core' 'yarn dev-server'"

diff --git a/packages/common-common/src/rabbitmq/mockRabbitMQController.ts b/packages/common-common/src/rabbitmq/mockRabbitMQController.ts
@@ -1,5 +1,5 @@
-import { RabbitMQControllerError } from './rabbitMQController';
 import type * as Rascal from 'rascal';
+import { RabbitMQControllerError } from './rabbitMQController';
 import type {
   RascalPublications,
   RascalSubscriptions,
@@ -24,7 +24,7 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
   public async init(): Promise<void> {
     if (this._initialized === true) {
       throw new RabbitMQControllerError(
-        'RabbitMQController is already initialized!'
+        'RabbitMQController is already initialized!',
       );
     }
 
@@ -49,27 +49,27 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
   public async startSubscription(
     messageProcessor: (data: TRmqMessages, ...args: any) => Promise<void>,
     subscriptionName: RascalSubscriptions,
-    msgProcessorContext?: { [key: string]: any }
+    msgProcessorContext?: { [key: string]: any },
   ): Promise<any> {
     if (!this._initialized) {
       throw new RabbitMQControllerError(
-        'RabbitMQController is not initialized!'
+        'RabbitMQController is not initialized!',
       );
     }
 
     // process existing messages
     await this.runMessageProcessor(
       messageProcessor,
       this._queuedMessages[subscriptionName],
-      msgProcessorContext
+      msgProcessorContext,
     );
 
     const checkQueues = async () => {
       if (this._queuedMessages[subscriptionName].length > 0) {
         await this.runMessageProcessor(
           messageProcessor,
           this._queuedMessages[subscriptionName],
-          msgProcessorContext
+          msgProcessorContext,
         );
       }
     };
@@ -88,11 +88,11 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
 
   public async publish(
     data: TRmqMessages,
-    publisherName: RascalPublications
+    publisherName: RascalPublications,
   ): Promise<any> {
     if (!this._initialized) {
       throw new RabbitMQControllerError(
-        'RabbitMQController is not initialized!'
+        'RabbitMQController is not initialized!',
       );
     }
     const subscription = this.routeMessage(publisherName);
@@ -104,7 +104,7 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
     publishData: TRmqMessages,
     objectId: number | string,
     publication: RascalPublications,
-    DB?: any
+    // DB?: any,
   ) {
     await this.publish(publishData, publication);
   }
@@ -130,12 +130,12 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
     const { exchange, routingKey } = config.publications[publication];
     const queue = Object.values(config.bindings).find(
       (binding) =>
-        binding.source === exchange && binding.bindingKey === routingKey
+        binding.source === exchange && binding.bindingKey === routingKey,
     ).destination;
 
     if (!queue) {
       throw new Error(
-        'Routing Failed: Could not find a queue that matches the given publication'
+        'Routing Failed: Could not find a queue that matches the given publication',
       );
     }
 
@@ -144,22 +144,22 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
     }
 
     throw new Error(
-      'Routing Failed: Could not find a subscription that matches the given publication'
+      'Routing Failed: Could not find a subscription that matches the given publication',
     );
   }
 
   private async runMessageProcessor(
     messageProcessor: (data: TRmqMessages, ...args: any) => Promise<void>,
     messages: any[],
-    msgProcessorContext?: { [key: string]: any }
+    msgProcessorContext?: { [key: string]: any },
   ) {
     const numMessages = messages.length;
     for (let i = 0; i < numMessages; i++) {
       const message = messages.shift();
       try {
         await messageProcessor.call(
           { rmqController: this, ...msgProcessorContext },
-          message
+          message,
         );
       } catch (e) {
         const errorMsg = `
@@ -170,11 +170,11 @@ export class MockRabbitMQController extends AbstractRabbitMQController {
         // message to avoid re-queuing the message multiple times
         if (e instanceof RmqMsgFormatError) {
           throw new Error(
-            `Negative Acknowledgement: Invalid Message Format Error - ${errorMsg}`
+            `Negative Acknowledgement: Invalid Message Format Error - ${errorMsg}`,
           );
         } else {
           throw new Error(
-            `Negative Acknowledgement: Unknown Error - Message would be re-queued in production`
+            `Negative Acknowledgement: Unknown Error - Message would be re-queued in production`,
           );
         }
       }

diff --git a/packages/commonwealth/package.json b/packages/commonwealth/package.json
@@ -327,7 +327,6 @@
     "webpack-cli": "^4.10.0",
     "webpack-deduplication-plugin": "^0.0.8",
     "webpack-dev-middleware": "^5.3.3",
-    "webpack-dev-server": "^3.1.14",
     "webpack-hot-middleware": "^2.25.2",
     "webpack-merge": "^5.8.0"
   },

diff --git a/scripts/build.sh b/scripts/build.sh
@@ -1,3 +1,6 @@
+# build libs (use tsc -b once project references are enabled)
+yarn workspace @hicommonwealth/core build
+
 if [ "$CW_BUILD" = true ]; then
   yarn --cwd packages/commonwealth build-all
 elif [ "$SL_BUILD" = true ]; then