feat: prompt server port during setup (PalisadoesFoundation#2263)

* feat: prompt server port during setup

* fix: parseInt for env

* fix: SERVER_PORT in github env

* fix:set SERVER_PORT as env

* refactor: remove console log

* fix: positioning of text

.env.sample

@@ -6,6 +6,10 @@
 # Possible values are: development, production, test
 NODE_ENV=development
 
+#This environment variable is used to provide the port on which the server will run
+SERVER_PORT=
+
+
 # This environment variable is used to provide a unique random secret key for
 # for signing/verifying access tokens using JWT(jsonwebtokens)
 

.github/workflows/pull-request.yml

@@ -220,6 +220,9 @@ jobs:
 
       - name: Generate Refresh Token Secret
         run: echo "REFRESH_TOKEN_SECRET=$(openssl rand -hex 32)" >> $GITHUB_ENV
+
+      - name: Set up SERVER_PORT env
+        run: echo "SERVER_PORT=4000" >> $GITHUB_ENV
 
       - name: Set up Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
@@ -231,7 +234,10 @@ jobs:
         uses: juliangruber/sleep-action@v2
         with:
           time: 10s
-
+
+      - name: Create a videos directory
+        run: mkdir -p videos
+
       - name: Run the tests
         run: npm run test
 

README.md

@@ -25,7 +25,7 @@ Core features include:
 
 <!-- toc -->
 
-- [Talawa Components](#talawa-components)
+  - [Talawa Components](#talawa-components)
 - [Documentation](#documentation)
 - [Videos](#videos)
 

docker-compose.dev.yaml

@@ -20,7 +20,7 @@ services:
       context: .
       dockerfile: Dockerfile.dev
     ports:
-      - 4000:4000
+      - "${SERVER_PORT:-4000}:${SERVER_PORT:-4000}"
     volumes:
       - .:/usr/src/app
       - /usr/src/app/node_modules

setup.ts

@@ -855,6 +855,19 @@ async function main(): Promise<void> {
     await recaptchaSiteKey();
   }
 
+  const { serverPort } = await inquirer.prompt([
+    {
+      type: "input",
+      name: "serverPort",
+      message: "Enter the server port:",
+      default: 4000,
+    },
+  ]);
+  if (process.env.NODE_ENV === "development") {
+    const config = dotenv.parse(fs.readFileSync(".env"));
+    config.SERVER_PORT = serverPort;
+    updateEnvVariable(config);
+  }
   console.log(
     "\n You can configure either SMTP or Mail for sending emails through Talawa.\n",
   );
@@ -864,7 +877,6 @@ async function main(): Promise<void> {
       `Mail username already exists with the value ${process.env.MAIL_USERNAME}`,
     );
   }
-
   const { shouldSetMail } = await inquirer.prompt([
     {
       type: "confirm",

src/constants.ts

@@ -702,6 +702,8 @@ export const MAXIMUM_IMAGE_SIZE_LIMIT_KB = 20000;
 
 export const BASE_URL = `http://localhost:${process.env.port || 4000}/`;
 
+export const SERVER_PORT = ENV.SERVER_PORT;
+
 export const ACCESS_TOKEN_SECRET = ENV.ACCESS_TOKEN_SECRET;
 
 export const REFRESH_TOKEN_SECRET = ENV.REFRESH_TOKEN_SECRET;

src/env.ts

@@ -4,6 +4,7 @@ export const envSchema = z.object({
   NODE_ENV: z
     .string()
     .refine((value) => ["development", "production"].includes(value)),
+  SERVER_PORT: z.string(),
   ACCESS_TOKEN_SECRET: z.string(),
   REFRESH_TOKEN_SECRET: z.string(),
   MONGO_DB_URL: z.string().url(),

src/index.ts

@@ -23,6 +23,7 @@ import { logger } from "./libraries";
 import { isAuth } from "./middleware";
 import { composedResolvers } from "./resolvers";
 import { typeDefs } from "./typeDefs";
+import { SERVER_PORT } from "./constants";
 export const pubsub = new PubSub();
 
 // defines schema
@@ -121,7 +122,7 @@ async function startServer(): Promise<void> {
 
   // Modified server startup
   await new Promise<void>((resolve) =>
-    httpServer.listen({ port: 4000 }, resolve),
+    httpServer.listen({ port: parseInt(SERVER_PORT as string) }, resolve),
   );
 
   // Log all the configuration related issues
@@ -130,9 +131,11 @@ async function startServer(): Promise<void> {
   logger.info(
     `🚀 Server ready at ${
       process.env.NODE_ENV === "production" ? "https" : "http"
-    }://localhost:4000/graphql`,
+    }://localhost:${SERVER_PORT}/graphql`,
+  );
+  logger.info(
+    `🚀 Subscription endpoint ready at ws://localhost:${SERVER_PORT}/graphql`,
   );
-  logger.info(`🚀 Subscription endpoint ready at ws://localhost:4000/graphql`);
 }
 
 startServer();