Merge branch 'main' into EDU-2000-Updates-delta-docs

Author: franrob-projects

.circleci/config.yml

@@ -87,7 +87,6 @@ jobs:
     environment:
       PORT: 3001
       STACK: heroku-24
-      ENABLE_BASIC_AUTH: "true"
     steps:
       - checkout
       - attach_workspace:
@@ -112,49 +111,31 @@ jobs:
           name: Test content request auth tokens
           command: |
             export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
-            mkdir -p logs/nginx
             ./bin/assert-content-auth.sh
-      - run:
-          name: Test nginx configuration
-          command: |
-            export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
-            erb config/nginx.conf.erb > config/nginx.conf
-            mkdir -p logs/nginx
-            nginx -p . -c config/nginx.conf -t
-      - run:
-          name: Start nginx
-          command: |
-            export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
-            mkdir -p logs/nginx
-            SKIP_HTTPS=false ./bin/start-nginx
-          background: true
-      - run:
-          name: Wait for nginx
-          command: |
-            until $(curl --retry 10 --output /dev/null --silent --head --fail http://localhost:3001/); do
-                printf '.'
-                sleep 1
-            done
       - run:
           name: Test basic auth for review apps
           command: |
+            export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
             ./bin/assert-basic-auth.sh /docs/getting-started/quickstart
       - run:
           name: Smoke test trailing slash redirects
           command: |
+            export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
             ./bin/assert-success.sh /docs/getting-started/quickstart
             ./bin/assert-redirect.sh /docs/getting-started/quickstart/ \
-                                     https://localhost/docs/getting-started/quickstart
+                                     http://localhost/docs/getting-started/quickstart
       - run:
           name: Smoke test redirect_from redirects
           command: |
+            export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
             ./bin/assert-redirect.sh /docs/how-ably-works \
                                      http://localhost/docs/key-concepts
             ./bin/assert-redirect.sh /docs/rest/history \
                                      http://localhost/docs/storage-history/history
       - run:
           name: Test website redirects
           command: |
+            export PATH="$PWD/bin:$PWD/buildpack/build/.heroku-buildpack-nginx/ruby/bin:$PATH"
             ./bin/assert-redirect.sh /tutorials https://ably.com/tutorials
 
 workflows:

.github/workflows/review-app.yml

@@ -56,7 +56,7 @@ jobs:
             }
 
       - name: Manage Heroku Review App
-        uses: fastruby/manage-heroku-review-app@v1
+        uses: fastruby/manage-heroku-review-app@v1.3
         with:
           action: ${{ (github.event.action == 'labeled' && github.event.label.name == 'review-app' && 'create') || 'destroy' }}
         env:

bin/assert-basic-auth.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+source "$(dirname "$0")/nginx-utils.sh"
+trap stop_nginx EXIT
+
 #
 # A utility script to assert basic auth is working correctly
 #
@@ -14,6 +17,10 @@ if [[ -z $URI_PATH ]]; then
   exit 1
 fi
 
+export ENABLE_BASIC_AUTH=true
+
+start_nginx
+
 # Test without credentials (should get 401)
 NO_AUTH_CODE=$(curl --header "X-Forwarded-Proto: https" \
                     --silent --output /dev/null \

bin/assert-content-auth.sh

@@ -1,4 +1,7 @@
-#!/usr/bin/env bash
+#!/bin/bash
+
+source "$(dirname "$0")/nginx-utils.sh"
+trap stop_nginx EXIT
 
 set -euo pipefail
 # set -x # uncomment to help debugging
@@ -10,58 +13,6 @@ set -euo pipefail
 # Make sure basic auth is disabled for these tests as it will interfere with the content request auth tokens
 export ENABLE_BASIC_AUTH=false
 
-# First we define some utility functions to help us in the test
-
-wait_for_nginx_pid_file() {
-    local operation=$1  # "start" or "stop"
-    local count=0
-
-    while ( [ "$operation" = "start" ] && [ ! -f /tmp/nginx.pid ] ) || \
-          ( [ "$operation" = "stop" ] && [ -f /tmp/nginx.pid ] ); do
-        # nginx operations are quick so we can be impatient here
-        sleep 0.1
-        count=$((count + 1))
-        if [ $count -ge 100 ]; then  # 0.1s * 100 = 10s
-            echo "Error: Timeout waiting for nginx to $operation"
-            exit 1
-        fi
-    done
-}
-
-start_nginx() {
-    # Start nginx in the background
-    ./bin/start-nginx &
-
-    # Wait for nginx to start successfully (pid file is created)
-    wait_for_nginx_pid_file "start"
-
-    # Get the PID from the nginx.pid file
-    NGINX_PID=$(cat /tmp/nginx.pid)
-
-    # Check if nginx is still running
-    if ! kill -0 $NGINX_PID 2>/dev/null; then
-        echo "Error: Failed to start nginx"
-        exit 1
-    fi
-}
-
-stop_nginx() {
-    # Read the PID from the file
-    if [ -f /tmp/nginx.pid ]; then
-        NGINX_PID=$(cat /tmp/nginx.pid)
-        # Kill nginx if it's still running
-        if kill -0 $NGINX_PID 2>/dev/null; then
-            kill $NGINX_PID
-        fi
-
-        # Wait for nginx to stop (pid file to be removed)
-        wait_for_nginx_pid_file "stop"
-    fi
-}
-
-# Set up trap to stop nginx on script exit or failure
-trap stop_nginx EXIT
-
 # Function to run a single test case
 run_test() {
     local path="$1"

bin/assert-redirect.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+source "$(dirname "$0")/nginx-utils.sh"
+trap stop_nginx EXIT
+
 #
 # A utility script to assert redirects served up by nginx
 #
@@ -16,6 +19,8 @@ if [[ -z $FROM || -z $TO ]]; then
   exit 1
 fi
 
+start_nginx
+
 # Add basic auth if enabled
 AUTH_OPTS=""
 if [[ "${ENABLE_BASIC_AUTH}" == "true" ]]; then

bin/assert-success.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+source "$(dirname "$0")/nginx-utils.sh"
+trap stop_nginx EXIT
+
 #
 # A utility script to assert successful responses served up by nginx
 #
@@ -14,6 +17,8 @@ if [[ -z $URI_PATH ]]; then
   exit 1
 fi
 
+start_nginx
+
 # Add basic auth if enabled
 AUTH_OPTS=""
 if [[ "${ENABLE_BASIC_AUTH}" == "true" ]]; then

bin/nginx-utils.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+# bin/nginx-utils.sh
+# Shared utility functions for starting, stopping, and waiting for nginx in test scripts.
+# Usage: source this file in your script, then call start_nginx, stop_nginx, etc.
+
+wait_for_nginx_pid_file() {
+    local operation=$1  # "start" or "stop"
+    local count=0
+
+    while ( [ "$operation" = "start" ] && [ ! -f /tmp/nginx.pid ] ) || \
+          ( [ "$operation" = "stop" ] && [ -f /tmp/nginx.pid ] ); do
+        sleep 0.1
+        count=$((count + 1))
+        if [ $count -ge 100 ]; then  # 0.1s * 100 = 10s
+            echo "Error: Timeout waiting for nginx to $operation" >&2
+            return 1
+        fi
+    done
+    return 0
+}
+
+start_nginx() {
+    mkdir -p logs/nginx
+    ./bin/start-nginx &
+    if ! wait_for_nginx_pid_file "start"; then
+        echo "Error: nginx did not start" >&2
+        return 1
+    fi
+    NGINX_PID=$(cat /tmp/nginx.pid)
+    if ! kill -0 $NGINX_PID 2>/dev/null; then
+        echo "Error: Failed to start nginx (PID $NGINX_PID not running)" >&2
+        return 1
+    fi
+    return 0
+}
+
+stop_nginx() {
+    if [ -f /tmp/nginx.pid ]; then
+        NGINX_PID=$(cat /tmp/nginx.pid)
+        if kill -0 $NGINX_PID 2>/dev/null; then
+            kill $NGINX_PID
+        fi
+        if ! wait_for_nginx_pid_file "stop"; then
+            echo "Error: nginx did not stop" >&2
+            return 1
+        fi
+    fi
+    return 0
+}

config/.htpasswd

@@ -1 +1 @@
-preview:$2y$05$lbdXr/rHqkB2cDDZx4x9OOagjzznFBnD3ZOijLD6B7sz..7pmgkrC
+preview:$apr1$IHsSHCLH$qJMp.hhrLSPDB/.f/yJUn/

config/nginx.conf.erb

@@ -24,8 +24,22 @@ http {
 
   server_tokens off;
 
+  log_format logfmtably
+    'nginx '
+    'request_time=$request_time '
+    'request_id=$http_x_request_id '
+    'status=$status '
+    'remote_addr=$remote_addr '
+    'remote_port=$remote_port '
+    'server_addr=$server_addr '
+    'bytes_sent=$bytes_sent body_bytes_sent=$body_bytes_sent '
+    'request_length=$request_length '
+    'scheme=$scheme request_method=$request_method '
+    'request_uri="$request_uri" host="$http_host" '
+    'referrer="$http_referer" user_agent="$http_user_agent" '
+    'content_type="$sent_http_content_type" accept="$http_accept"';
   log_format l2met 'measure#nginx.service=$request_time request_id=$http_x_request_id';
-  access_log <%= ENV['NGINX_ACCESS_LOG_PATH'] || 'logs/nginx/access.log' %> l2met;
+  access_log <%= ENV['NGINX_ACCESS_LOG_PATH'] || 'logs/nginx/access.log' %> logfmtably;
   error_log <%= ENV['NGINX_ERROR_LOG_PATH'] || 'logs/nginx/error.log' %> notice;
 
   include mime.types;
@@ -39,7 +53,7 @@ http {
   map_hash_bucket_size 8192;
 
   # Creates a map of redirects for us
-  map $uri $redirected_url {
+  map $request_uri $redirected_url {
     default "none";
     include website-redirects.conf;
     include client-lib-development-guide-redirects.conf;
@@ -207,10 +221,10 @@ http {
       <% if content_request_protected %>
       # Serve the file if it exists, otherwise try to authenticate
       # (.html requests won't match here, they'll go to the @html_auth location)
-      try_files $uri @html_auth;
+      try_files $request_uri @html_auth;
       <% else %>
       # Serve the file if it exists, try index.html for paths without a trailing slash, otherwise 404
-      try_files $uri $uri/index.html $uri/ =404;
+      try_files $request_uri $request_uri/index.html $request_uri/ =404;
       <% end %>
     }
 
@@ -222,14 +236,14 @@ http {
         # .html request without authentication, so handle it here by 404ing or redirecting to the canonical host
         # depending on whether CONTENT_REQUEST_CANONICAL_HOST is set or not
         <% if host = ENV['CONTENT_REQUEST_CANONICAL_HOST'] %>
-        return 301 <%= ENV['SKIP_HTTPS'] == 'true' ? '$scheme' : 'https' %>://<%= host %>$uri;
+        return 301 <%= ENV['SKIP_HTTPS'] == 'true' ? '$scheme' : 'https' %>://<%= host %>$request_uri;
         <% else %>
         return 404;
         <% end %>
       }
 
       # If the request is authenticated, break out of the location block and serve the file
-      try_files $uri.html $uri/index.html $uri/ =404;
+      try_files $request_uri.html $request_uri/index.html $request_uri/ =404;
     }
 
     # Don't serve files with the .html extension here, send them to the canonical location
@@ -242,7 +256,7 @@ http {
       # .html request without authentication, so handle it here by 404ing or redirecting to the canonical host
       # depending on whether CONTENT_REQUEST_CANONICAL_HOST is set or not
       <% if host = ENV['CONTENT_REQUEST_CANONICAL_HOST'] %>
-      return 301 <%= ENV['SKIP_HTTPS'] == 'true' ? '$scheme' : 'https' %>://<%= host %>$uri;
+      return 301 <%= ENV['SKIP_HTTPS'] == 'true' ? '$scheme' : 'https' %>://<%= host %>$request_uri;
       <% else %>
       return 404;
       <% end %>