feat: automate port number selection (#52)

domjtalbot · Aug 14, 2022 · 5e436b8 · 5e436b8
1 parent 329c391
commit 5e436b8
Show file tree

Hide file tree

Showing 45 changed files with 392 additions and 134 deletions.
diff --git a/.changeset/beige-planets-perform.md b/.changeset/beige-planets-perform.md
@@ -0,0 +1,5 @@
+---
+'nx-plugin-graphql-mesh': minor
+---
+
+Add automatic port selection for `dev`, `start` & `serve` executors
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -63,12 +63,13 @@ jobs:
     env:
       NX_CLOUD_ENV_NAME: node-${{ matrix.node }}
     outputs:
-      affected: ${{ steps.affected.affected }}
-      affectedLength: ${{ steps.affected.affectedLength }}
-      affectedApps: ${{ steps.affected.affectedApps }}
-      affectedAppsLength: ${{ steps.affected.affectedAppsLength }}
-      affectedLibs: ${{ steps.affected.affectedLibs }}
-      affectedLibsLength: ${{ steps.affected.affectedLibsLength }}
+      affected: ${{ steps.affected.outputs.affected }}
+      affectedLength: ${{ steps.affected.outputs.affectedLength }}
+      affectedApps: ${{ steps.affected.outputs.affectedApps }}
+      affectedAppsLength: ${{ steps.affected.outputs.affectedAppsLength }}
+      affectedLibs: ${{ steps.affected.outputs.affectedLibs }}
+      affectedLibsLength: ${{ steps.affected.outputs.affectedLibsLength }}
+      hasAffected: ${{ steps.affected.outputs.hasAffected }}
     steps:
       - name: Check out repository
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
@@ -82,7 +83,6 @@ jobs:
 
       - name: Affected
         id: affected
-        if: matrix.node == 'lts'
         uses: ./.github/actions/nx-affected
 
       - name: Workspace Lint

diff --git a/README.md b/README.md
@@ -298,12 +298,19 @@ This is the equifilent of using `graphql-mesh dev`.
 
 #### Options
 
-| Name          | Type       | Required | Default | Description                                                                                 |
-| ------------- | ---------- | :------: | ------- | ------------------------------------------------------------------------------------------- |
-| **`debug`**   | `boolean`  |    -     | `false` | Display debugging info by applying the `DEBUG` env variable.                                |
-| **`dir`**     | `string`   |    ✅    | -       | The path of the directory containing the GraphQL Mesh config.                               |
-| **`port`**    | `number`   |    -     | `4000`  | The port number to run on.                                                                  |
-| **`require`** | `string[]` |    -     | `[]`    | Loads specific require.extensions before running the codegen and reading the configuration. |
+| Name                  | Type           | Required | Default   | Description                                                                                        |
+| --------------------- | -------------- | :------: | --------- | -------------------------------------------------------------------------------------------------- |
+| **`debug`**           | `boolean`      |    -     | `false`   | Display debugging info by applying the `DEBUG` env variable.                                       |
+| **`dir`**             | `string`       |    ✅    | -         | The path of the directory containing the GraphQL Mesh config.                                      |
+| **`port`**            | `object`       |    -     | -         | Port selection settings                                                                            |
+| **`port.auto`**       | `boolean`      |    -     | `true`    | Use the first available port                                                                       |
+| **`port.number`**     | `number`       |    -     | `4200`    | Define the preferred port to use when `auto` is set to `false`                                     |
+| **`port.range`**      | `object`       |    -     | -         | The range of ports to select from.                                                                 |
+| **`port.range.from`** | `boolean`      |    -     | -         | The first port of the range. Must be in the range `1024`...`65535`                                 |
+| **`port.range.to`**   | `boolean`      |    -     | -         | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. |
+| **`port.fallback`**   | `auto`, `none` |    -     | `auto`    | The fallback strategy to use when the preferred port is unavailable.                               |
+| **`port.host`**       | `string`       |    -     | `0.0.0.0` | The host to listern on (only used for port number lookup).                                         |
+| **`require`**         | `string[]`     |    -     | `[]`      | Loads specific require.extensions before running the codegen and reading the configuration.        |
 
 <br/>
 
@@ -326,12 +333,19 @@ This is the equifilent of using `graphql-mesh start`.
 
 #### Options
 
-| Name          | Type       | Required | Default | Description                                                                                 |
-| ------------- | ---------- | :------: | ------- | ------------------------------------------------------------------------------------------- |
-| **`debug`**   | `boolean`  |    -     | `false` | Display debugging info by applying the `DEBUG` env variable.                                |
-| **`dir`**     | `string`   |    ✅    | -       | The path of the directory containing the GraphQL Mesh config.                               |
-| **`port`**    | `number`   |    -     | `4000`  | The port number to run on.                                                                  |
-| **`require`** | `string[]` |    -     | `[]`    | Loads specific require.extensions before running the codegen and reading the configuration. |
+| Name                  | Type           | Required | Default   | Description                                                                                        |
+| --------------------- | -------------- | :------: | --------- | -------------------------------------------------------------------------------------------------- |
+| **`debug`**           | `boolean`      |    -     | `false`   | Display debugging info by applying the `DEBUG` env variable.                                       |
+| **`dir`**             | `string`       |    ✅    | -         | The path of the directory containing the GraphQL Mesh config.                                      |
+| **`port`**            | `object`       |    -     | -         | Port selection settings                                                                            |
+| **`port.auto`**       | `boolean`      |    -     | `true`    | Use the first available port                                                                       |
+| **`port.number`**     | `number`       |    -     | `4200`    | Define the preferred port to use when `auto` is set to `false`                                     |
+| **`port.range`**      | `object`       |    -     | -         | The range of ports to select from.                                                                 |
+| **`port.range.from`** | `boolean`      |    -     | -         | The first port of the range. Must be in the range `1024`...`65535`                                 |
+| **`port.range.to`**   | `boolean`      |    -     | -         | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. |
+| **`port.fallback`**   | `auto`, `none` |    -     | `auto`    | The fallback strategy to use when the preferred port is unavailable.                               |
+| **`port.host`**       | `string`       |    -     | `0.0.0.0` | The host to listern on (only used for port number lookup).                                         |
+| **`require`**         | `string[]`     |    -     | `[]`      | Loads specific require.extensions before running the codegen and reading the configuration.        |
 
 <br/>
 
@@ -360,13 +374,20 @@ This combines `dev` & `start` via a `dev` option toggle.
 
 #### Options
 
-| Name          | Type       | Required | Default | Description                                                                                 |
-| ------------- | ---------- | :------: | ------- | ------------------------------------------------------------------------------------------- |
-| **`debug`**   | `boolean`  |    -     | `false` | Display debugging info by applying the `DEBUG` env variable.                                |
-| **`dev`**     | `string`   |    -     | `false` | Run the server in dev or production mode.                                                   |
-| **`dir`**     | `string`   |    ✅    | -       | The path of the directory containing the GraphQL Mesh config.                               |
-| **`port`**    | `number`   |    -     | `4000`  | The port number to run on.                                                                  |
-| **`require`** | `string[]` |    -     | `[]`    | Loads specific require.extensions before running the codegen and reading the configuration. |
+| Name                  | Type           | Required | Default   | Description                                                                                        |
+| --------------------- | -------------- | :------: | --------- | -------------------------------------------------------------------------------------------------- |
+| **`debug`**           | `boolean`      |    -     | `false`   | Display debugging info by applying the `DEBUG` env variable.                                       |
+| **`dev`**             | `string`       |    -     | `false`   | Run the server in dev or production mode.                                                          |
+| **`dir`**             | `string`       |    ✅    | -         | The path of the directory containing the GraphQL Mesh config.                                      |
+| **`port`**            | `object`       |    -     | -         | Port selection settings                                                                            |
+| **`port.auto`**       | `boolean`      |    -     | `true`    | Use the first available port                                                                       |
+| **`port.number`**     | `number`       |    -     | `4200`    | Define the preferred port to use when `auto` is set to `false`                                     |
+| **`port.range`**      | `object`       |    -     | -         | The range of ports to select from.                                                                 |
+| **`port.range.from`** | `boolean`      |    -     | -         | The first port of the range. Must be in the range `1024`...`65535`                                 |
+| **`port.range.to`**   | `boolean`      |    -     | -         | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. |
+| **`port.fallback`**   | `auto`, `none` |    -     | `auto`    | The fallback strategy to use when the preferred port is unavailable.                               |
+| **`port.host`**       | `string`       |    -     | `0.0.0.0` | The host to listern on (only used for port number lookup).                                         |
+| **`require`**         | `string[]`     |    -     | `[]`      | Loads specific require.extensions before running the codegen and reading the configuration.        |
 
 <br/>
 

diff --git a/apps/api-gateway/javascript-wiki/cjs-config/project.json b/apps/api-gateway/javascript-wiki/cjs-config/project.json
@@ -18,8 +18,7 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dev": true,
-        "dir": "apps/api-gateway/javascript-wiki/cjs-config",
-        "port": 4800
+        "dir": "apps/api-gateway/javascript-wiki/cjs-config"
       },
       "configurations": {
         "production": {

diff --git a/apps/api-gateway/javascript-wiki/js-config/project.json b/apps/api-gateway/javascript-wiki/js-config/project.json
@@ -18,8 +18,7 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dev": true,
-        "dir": "apps/api-gateway/javascript-wiki/js-config",
-        "port": 4801
+        "dir": "apps/api-gateway/javascript-wiki/js-config"
       },
       "configurations": {
         "production": {

diff --git a/apps/api-gateway/javascript-wiki/json-config/project.json b/apps/api-gateway/javascript-wiki/json-config/project.json
@@ -18,8 +18,7 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dev": true,
-        "dir": "apps/api-gateway/javascript-wiki/json-config",
-        "port": 4802
+        "dir": "apps/api-gateway/javascript-wiki/json-config"
       },
       "configurations": {
         "production": {

diff --git a/apps/api-gateway/javascript-wiki/yml-config/project.json b/apps/api-gateway/javascript-wiki/yml-config/project.json
@@ -18,8 +18,7 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dev": true,
-        "dir": "apps/api-gateway/javascript-wiki/yml-config",
-        "port": 4803
+        "dir": "apps/api-gateway/javascript-wiki/yml-config"
       },
       "configurations": {
         "production": {

diff --git a/apps/api-gateway/stackexchange/project.json b/apps/api-gateway/stackexchange/project.json
@@ -23,40 +23,34 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dir": "apps/api-gateway/stackexchange",
-        "port": 4700,
         "dev": true
       },
       "configurations": {
         "production": {
           "dir": "dist/apps/api-gateway/stackexchange",
-          "dev": false,
-          "port": 5200
+          "dev": false
         }
       }
     },
     "dev": {
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:dev",
       "options": {
-        "dir": "apps/api-gateway/stackexchange",
-        "port": 4500
+        "dir": "apps/api-gateway/stackexchange"
       },
       "configurations": {
         "e2e": {
-          "debug": false,
-          "port": 4700
+          "debug": false
         }
       }
     },
     "start": {
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:start",
       "options": {
-        "dir": "dist/apps/api-gateway/stackexchange",
-        "port": 5200
+        "dir": "dist/apps/api-gateway/stackexchange"
       },
       "configurations": {
         "e2e": {
-          "debug": false,
-          "port": 5201
+          "debug": false
         }
       },
       "dependsOn": [

diff --git a/apps/api-gateway/trippin/project.json b/apps/api-gateway/trippin/project.json
@@ -20,40 +20,37 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dir": "apps/api-gateway/trippin",
-        "port": 5001,
-        "dev": true
+        "dev": true,
+        "port": {
+          "host": "localhost"
+        }
       },
       "configurations": {
         "production": {
           "dir": "dist/apps/api-gateway/trippin",
-          "dev": false,
-          "port": 5100
+          "dev": false
         }
       }
     },
     "dev": {
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:dev",
       "options": {
-        "dir": "apps/api-gateway/trippin",
-        "port": 4500
+        "dir": "apps/api-gateway/trippin"
       },
       "configurations": {
         "e2e": {
-          "debug": false,
-          "port": 5001
+          "debug": false
         }
       }
     },
     "start": {
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:start",
       "options": {
-        "dir": "dist/apps/api-gateway/trippin",
-        "port": 5100
+        "dir": "dist/apps/api-gateway/trippin"
       },
       "configurations": {
         "e2e": {
-          "debug": false,
-          "port": 5101
+          "debug": false
         }
       },
       "dependsOn": [

diff --git a/apps/api-gateway/weatherbit/project.json b/apps/api-gateway/weatherbit/project.json
@@ -20,40 +20,34 @@
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:serve",
       "options": {
         "dir": "apps/api-gateway/weatherbit",
-        "port": 4600,
         "dev": true
       },
       "configurations": {
         "production": {
           "dir": "dist/apps/api-gateway/weatherbit",
-          "dev": false,
-          "port": 5300
+          "dev": false
         }
       }
     },
     "dev": {
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:dev",
       "options": {
-        "dir": "apps/api-gateway/weatherbit",
-        "port": 4500
+        "dir": "apps/api-gateway/weatherbit"
       },
       "configurations": {
         "e2e": {
-          "debug": false,
-          "port": 4600
+          "debug": false
         }
       }
     },
     "start": {
       "executor": "@domjtalbot/nx-plugin-graphql-mesh:start",
       "options": {
-        "dir": "dist/apps/api-gateway/weatherbit",
-        "port": 5300
+        "dir": "dist/apps/api-gateway/weatherbit"
       },
       "configurations": {
         "e2e": {
-          "debug": false,
-          "port": 5301
+          "debug": false
         }
       },
       "dependsOn": [

diff --git a/apps/nextjs/javascript-wiki-swc/project.json b/apps/nextjs/javascript-wiki-swc/project.json
@@ -21,7 +21,8 @@
       "defaultConfiguration": "development",
       "options": {
         "buildTarget": "nextjs-javascript-wiki-swc:build",
-        "dev": true
+        "dev": true,
+        "port": 4800
       },
       "configurations": {
         "development": {
@@ -30,8 +31,7 @@
         },
         "e2e": {
           "buildTarget": "nextjs-javascript-wiki-swc:build:production",
-          "dev": false,
-          "port": 4900
+          "dev": false
         },
         "production": {
           "buildTarget": "nextjs-javascript-wiki-swc:build:production",

diff --git a/apps/nextjs/javascript-wiki/project.json b/apps/nextjs/javascript-wiki/project.json
@@ -21,7 +21,8 @@
       "defaultConfiguration": "development",
       "options": {
         "buildTarget": "nextjs-javascript-wiki:build",
-        "dev": true
+        "dev": true,
+        "port": 5000
       },
       "configurations": {
         "development": {
@@ -30,8 +31,7 @@
         },
         "e2e": {
           "buildTarget": "nextjs-javascript-wiki:build:production",
-          "dev": false,
-          "port": 4900
+          "dev": false
         },
         "production": {
           "buildTarget": "nextjs-javascript-wiki:build:production",

diff --git a/apps/nextjs/stackexchange/project.json b/apps/nextjs/stackexchange/project.json
@@ -21,7 +21,8 @@
       "defaultConfiguration": "development",
       "options": {
         "buildTarget": "nextjs-stackexchange:build",
-        "dev": true
+        "dev": true,
+        "port": 4700
       },
       "configurations": {
         "development": {
@@ -30,8 +31,7 @@
         },
         "e2e": {
           "buildTarget": "nextjs-stackexchange:build:production",
-          "dev": false,
-          "port": 5002
+          "dev": false
         },
         "production": {
           "buildTarget": "nextjs-stackexchange:build:production",

diff --git a/apps/nextjs/trippin-swc/project.json b/apps/nextjs/trippin-swc/project.json
@@ -21,7 +21,8 @@
       "defaultConfiguration": "development",
       "options": {
         "buildTarget": "nextjs-trippin-swc:build",
-        "dev": true
+        "dev": true,
+        "port": 4500
       },
       "configurations": {
         "development": {
@@ -30,8 +31,7 @@
         },
         "e2e": {
           "buildTarget": "nextjs-trippin:build:production",
-          "dev": false,
-          "port": 4300
+          "dev": false
         },
         "production": {
           "buildTarget": "nextjs-trippin-swc:build:production",

diff --git a/apps/nextjs/trippin/project.json b/apps/nextjs/trippin/project.json
@@ -21,7 +21,8 @@
       "defaultConfiguration": "development",
       "options": {
         "buildTarget": "nextjs-trippin:build",
-        "dev": true
+        "dev": true,
+        "port": 4600
       },
       "configurations": {
         "development": {
@@ -30,8 +31,7 @@
         },
         "e2e": {
           "buildTarget": "nextjs-trippin:build:production",
-          "dev": false,
-          "port": 4900
+          "dev": false
         },
         "production": {
           "buildTarget": "nextjs-trippin:build:production",