Change python server port and add nginx to services for proxying

Author: bjester

.run/devserver.run.xml

@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="false" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="contentcuration/manage.py" />
-    <option name="PARAMETERS" value="runserver --settings=contentcuration.dev_settings 0.0.0.0:8080" />
+    <option name="PARAMETERS" value="runserver --settings=contentcuration.dev_settings 0.0.0.0:8081" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
     <option name="MODULE_MODE" value="false" />

Makefile

@@ -200,7 +200,7 @@ dctest: .docker/minio .docker/postgres
 
 dcservicesup: .docker/minio .docker/postgres
 	# launch all studio's dependent services using docker-compose
-	$(DOCKER_COMPOSE) -f docker-compose.yml -f docker-compose.alt.yml up minio postgres redis
+	$(DOCKER_COMPOSE) -f docker-compose.yml -f docker-compose.alt.yml up minio postgres redis studio-nginx
 
 dcservicesdown:
 	# stop services that were started using dcservicesup

contentcuration/contentcuration/models.py

@@ -2,7 +2,6 @@
 import json
 import logging
 import os
-import urllib.parse
 import uuid
 from datetime import datetime
 
@@ -671,44 +670,10 @@ def generate_storage_url(filename, request=None, *args):
 
     path = generate_object_storage_name(os.path.splitext(filename)[0], filename)
 
-    # There are three scenarios where Studio might be run as:
-    #
-    # 1. In normal kubernetes, nginx will proxy for us. We'll know we're in kubernetes when the
-    # environment variable RUN_MODE=k8s
-    #
-    # 2. In Docker Compose and bare metal runserver, we'll be running in runserver, and minio
-    # will be exposed in port 9000 in the host's localhost network.
-
-    # Note (aron): returning the true storage URL (e.g. https://storage.googleapis.com/storage/a.mp4)
-    # isn't too important, because we have CDN in front of our servers, so it should be cached.
-    # But change the logic here in case there is a potential for bandwidth and latency improvement.
-
-    # Detect our current state first
-    run_mode = os.getenv("RUN_MODE")
-
-    # if we're running inside k8s, then just serve the normal /content/{storage,databases} URL,
-    # and let nginx handle proper proxying.
-    if run_mode == "k8s":
-        url = "/content/{path}".format(
-            path=path,
-        )
-
-    # if we're in docker-compose or in baremetal, just return the object storage URL as localhost:9000
-    elif run_mode == "docker-compose" or run_mode is None:
-        # generate the minio storage URL, so we can get the GET parameters that give everyone
-        # access even if they don't need to log in
-        params = urllib.parse.urlparse(default_storage.url(path)).query
-        host = "localhost"
-        port = 9000  # hardcoded to the default minio IP address
-        url = "http://{host}:{port}/{bucket}/{path}?{params}".format(
-            host=host,
-            port=port,
-            bucket=settings.AWS_S3_BUCKET_NAME,
-            path=path,
-            params=params,
-        )
-
-    return url
+    # requires that we always have a proxy of /content to storage bucket, handled by nginx in dev
+    return "/content/{path}".format(
+        path=path,
+    )
 
 
 class FileOnDiskStorage(FileSystemStorage):

docker-compose.yml

@@ -14,7 +14,8 @@ x-studio-environment:
     CELERY_BROKER_ENDPOINT: redis
     CELERY_RESULT_BACKEND_ENDPOINT: redis
     CELERY_REDIS_PASSWORD: ""
-    PROBER_STUDIO_BASE_URL: http://studio-app:8080/{path}
+    PROBER_STUDIO_BASE_URL: http://studio-app:8081/{path}
+    WEBPACK_DEV_HOST: 0.0.0.0
 
 x-studio-worker:
   &studio-worker
@@ -36,18 +37,15 @@ services:
     build:
       context: .
       dockerfile: k8s/images/nginx/Dockerfile
-    ports:
-      - "8081:8080"
-    depends_on:
-      - studio-app
+    network_mode: host
     environment: *studio-environment
 
   studio-app:
     <<: *studio-worker
     entrypoint: python docker/entrypoint.py
     command: pnpm run devserver
     ports:
-      - "8080:8080"
+      - "8081:8081"
       - "4000:4000"
 
   celery-worker:

package.json

@@ -25,7 +25,7 @@
     "test-jest": "pnpm run test",
     "test-jest:debug": "node --inspect node_modules/.bin/jest --runInBand --watch",
     "minio": "MINIO_API_CORS_ALLOW_ORIGIN='http://localhost:8080,http://127.0.0.1:8080' MINIO_ACCESS_KEY=development MINIO_SECRET_KEY=development minio server ~/.minio_data/ || true",
-    "runserver": "cd contentcuration && python manage.py runserver --settings=contentcuration.dev_settings 0.0.0.0:8080",
+    "runserver": "cd contentcuration && python manage.py runserver --settings=contentcuration.dev_settings 0.0.0.0:8081",
     "devserver": "npm-run-all --parallel build:dev runserver",
     "devserver:hot": "npm-run-all --parallel build:dev:hot runserver",
     "devserver-hot": "pnpm run devserver:hot",

webpack.config.js

@@ -16,7 +16,12 @@ const WebpackRTLPlugin = require('kolibri-tools/lib/webpackRtlPlugin');
 
 const { InjectManifest } = require('workbox-webpack-plugin');
 
-// Function to detect if running in WSL
+const DEFAULT_WEBPACK_DEV_HOST = '127.0.0.1';
+
+/**
+ * Function to detect if running in WSL
+ * @return {boolean}
+ */
 function isWSL() {
   try {
     const version = fs.readFileSync('/proc/version', 'utf8');
@@ -26,14 +31,24 @@ function isWSL() {
   }
 }
 
-// Function to get WSL IP address
-function getWSLIP() {
+/**
+ * Get the host for the webpack dev server.
+ * @return {string}
+ */
+function getWebpackDevHost() {
+  if (process.env.WEBPACK_DEV_HOST) {
+    return process.env.WEBPACK_DEV_HOST;
+  }
+
+  if (!isWSL()) {
+    return DEFAULT_WEBPACK_DEV_HOST;
+  }
+
   try {
-    const ip = execSync('hostname -I').toString().trim().split(' ')[0];
-    return ip;
+    return execSync('hostname -I').toString().trim().split(' ')[0];
   } catch (err) {
     console.warn('Failed to get WSL IP address:', err);
-    return '127.0.0.1';
+    return DEFAULT_WEBPACK_DEV_HOST;
   }
 }
 
@@ -60,11 +75,8 @@ module.exports = (env = {}) => {
   const pnpmNodeModules = path.join(rootDir, 'node_modules', '.pnpm', 'node_modules');
 
   // Determine the appropriate dev server host and public path based on environment
-  const isWSLEnvironment = isWSL();
-  const devServerHost = isWSLEnvironment ? '0.0.0.0' : '127.0.0.1';
-  const devPublicPath = isWSLEnvironment ?
-    `http://${getWSLIP()}:4000/dist/` :
-    'http://127.0.0.1:4000/dist/';
+  const devServerHost = getWebpackDevHost();
+  const devPublicPath = `http://${devServerHost}:4000/dist/`;
 
   const workboxPlugin = new InjectManifest({
     swSrc: path.resolve(srcDir, 'serviceWorker/index.js'),
@@ -120,10 +132,8 @@ module.exports = (env = {}) => {
       allowedHosts: [
         '127.0.0.1',
         'localhost',
-      ].concat(
-        // For WSL, allow the WSL IP address
-        isWSLEnvironment ? [getWSLIP()] : []
-      ),
+        getWebpackDevHost(),
+      ]
     },
     module: {
       rules: [