fix: check if port before running http-server (#81)

Closes #80

Author: manekinekko

src/cli/commands/start.ts

@@ -70,6 +70,21 @@ export async function start(startContext: string, program: CLIConfig) {
     const { port } = parseUrl(useAppDevServer);
     appPort = port;
   } else {
+    if (
+      (await isPortAvailable({
+        port: appPort,
+      })) === false
+    ) {
+      const randomPort = Math.floor(Math.random() * 49150) + 1024;
+      // @Todo: don't block and just define a random port for static server
+      // program.appPort = randomPort;
+
+      console.info(`INFO: Cannot start static server at "http://${program.host}:${appPort}". Port is already in use.`);
+      console.info(`INFO: Choose a different port (1024 to 49151).`);
+      console.info(`Hint: Try swa start ${startContext} --app-port=${randomPort}`);
+      process.exit(0);
+    }
+
     const { command: hostCommand, args: hostArgs } = createRuntimeHost({
       appPort: appPort,
       proxyHost: program.host as string,

src/proxy.ts

@@ -15,6 +15,7 @@ const SWA_CLI_PORT = parseInt(process.env.SWA_CLI_PORT || "", 10);
 const SWA_CLI_APP_URI = buildAdress(SWA_CLI_HOST, process.env.SWA_CLI_APP_PORT);
 const SWA_CLI_API_URI = buildAdress(SWA_CLI_HOST, process.env.SWA_CLI_API_PORT);
 const SWA_CLI_AUTH_URI = buildAdress(SWA_CLI_HOST, process.env.SWA_CLI_AUTH_PORT);
+const SWA_CLI_APP_ARTIFACT_LOCATION = process.env.SWA_CLI_APP_ARTIFACT_LOCATION;
 
 if (!isHttpUrl(SWA_CLI_APP_URI)) {
   console.log(`The provided app URI is not a valid`);
@@ -56,7 +57,6 @@ const serveStatic = (file: string, res: http.ServerResponse, status = 200) => {
       res.end(JSON.stringify(err));
       return;
     }
-    console.log("serving", file);
     res.writeHead(status);
     res.end(data);
   });
@@ -84,7 +84,7 @@ const readRoutes = (folder: string): UserDefinedRoute[] => {
   return require(path.join(folder, routesFile)).routes || [];
 };
 
-const routes = readRoutes(process.env.SWA_CLI_APP_ARTIFACT_LOCATION || "");
+const routes = readRoutes(SWA_CLI_APP_ARTIFACT_LOCATION || "");
 
 const routeTest = (userDefinedRoute: string, currentRoute: string) => {
   if (userDefinedRoute === currentRoute) {
@@ -185,7 +185,7 @@ const server = http.createServer(function (req, res) {
   // detected SPA mode
   else if (req.url.startsWith("/?")) {
     console.log("proxy>", req.method, req.headers.host + req.url);
-    const fileIndex = path.join(process.env.SWA_CLI_APP_ARTIFACT_LOCATION || "", "index.html");
+    const fileIndex = path.join(SWA_CLI_APP_ARTIFACT_LOCATION || "", "index.html");
     serveStatic(fileIndex, res);
   }
 

src/utils.ts

@@ -219,9 +219,9 @@ export const readConfigFile = ({ userConfig }: { userConfig?: Partial<GithubActi
   // if the user provides different app location, app artifact location or api location, use that information
   if (userConfig) {
     const { apiLocation, appArtifactLocation, appLocation } = validateUserConfig(userConfig);
-    app_location = userConfig.appLocation || appLocation;
-    app_artifact_location = userConfig.appArtifactLocation || appArtifactLocation;
-    api_location = userConfig.apiLocation || apiLocation;
+    app_location = appLocation;
+    app_artifact_location = appArtifactLocation;
+    api_location = apiLocation;
   }
 
   // convert variable names to camelCase
@@ -234,9 +234,7 @@ export const readConfigFile = ({ userConfig }: { userConfig?: Partial<GithubActi
     appArtifactLocation: app_artifact_location,
   };
 
-  console.log({ config });
-
-  console.info(`INFO: Using SWA configuration file: ${githubActionFile}`);
+  console.info(`INFO: Found SWA configuration file: ${githubActionFile}`);
   if (process.env.DEBUG) {
     console.info({ config });
   }