save state

Mind r->header_only when processing the response body.

Fixes https://github.com/pagespeed/ngx_pagespeed/issues/1375

.travis.yml

@@ -9,6 +9,9 @@ env:
 #   jobs=8: 179s (29s to install new git, 150s to run the downloads)
 # We can't use --depth=1, though, because github doesn't have
 # allowReachableSHA1InWant set.
+#
+# TODO(jefftk): once we're running on a server with git 2.8 or later we can have
+#               --jobs without installing a new git.
 git:
   submodules: false
 before_install:
@@ -21,9 +24,10 @@ install:
 script:
   test/run_tests.sh $PWD/testing-dependencies/mod_pagespeed/ \
                     $PWD/nginx/sbin/nginx
+dist: trusty
 sudo: required
 compiler:
   - gcc
 notifications:
   email:
-    - jefftk@google.com
+    - pagespeed-ci@googlegroups.com

config

@@ -198,7 +198,7 @@ pagespeed_include="\
   $mod_pagespeed_dir/url"
 ngx_feature_path="$pagespeed_include"
 
-pagespeed_libs="$psol_binary $pagespeed_libs -lrt -pthread -lm"
+pagespeed_libs="$psol_binary $pagespeed_libs -lrt -pthread -lm -luuid"
 ngx_feature_libs="$pagespeed_libs"
 ngx_feature_test="
 

scripts/build_ngx_pagespeed.sh

@@ -80,6 +80,13 @@ Options:
       Assume the answer to all prompts is 'yes, please continue'.  Intended for
       automated usage, such as buildbots.
 
+  -a, --additional-nginx-configure-arguments
+      When running ./configure for nginx, you may want to specify additional
+      arguments, such as --with-http_ssl_module.  By default this script will
+      pause and prompt you for them, but this option lets you pass them in.  For
+      example, you might do:
+        -a '--with-http_ssl_module --with-cc-opt=\"-I /usr/local/include\"'
+
   -d, --dryrun
       Don't make any changes to the system, just print what changes you
       would have made.
@@ -302,10 +309,10 @@ function build_ngx_pagespeed() {
     fail "Your version of getopt is too old.  Exiting with no changes made."
   fi
 
-  opts=$(getopt -o v:n:mb:pslt:ydh \
+  opts=$(getopt -o v:n:mb:pslt:ya:dh \
     --longoptions ngx-pagespeed-version:,nginx-version:,dynamic-module \
     --longoptions buildir:,no-deps-check,psol-from-source,devel,build-type: \
-    --longoptions assume-yes,dryrun,help \
+    --longoptions assume-yes,additional-nginx-configure-arguments:,dryrun,help \
     -n "$(basename "$0")" -- "$@")
   if [ $? != 0 ]; then
     usage
@@ -356,6 +363,10 @@ function build_ngx_pagespeed() {
       -y | --assume-yes) shift
         ASSUME_YES="true"
         ;;
+      -a | --additional-nginx-configure-arguments) shift
+        ADDITIONAL_NGINX_CONFIGURE_ARGUMENTS="$1"
+        shift
+        ;;
       -d | --dryrun) shift
         DRYRUN="true"
         ;;
@@ -721,19 +732,26 @@ Not deleting $directory; name is suspiciously short.  Something is wrong."
     run cd "$nginx_dir"
 
     configure=("$configure_location/configure" "${configure_args[@]}")
-    if ! "$ASSUME_YES"; then
-      echo "About to build nginx.  Do you have any additional ./configure"
-      echo "arguments you would like to set?  For example, if you would like"
-      echo "to build nginx with https support give --with-http_ssl_module"
-      echo "If you don't have any, just press enter."
-      read -p "> " additional_configure_args
-      if [ -n "$additional_configure_args" ]; then
-        # Split additional_configure_args respecting any internal quotation.
-        # Otherwise things like --with-cc-opt='-foo -bar' won't work.
-        eval additional_configure_args=("$additional_configure_args")
-        configure=("${configure[@]}" "${additional_configure_args[@]}")
+    additional_configure_args=""
+    if [ -z "${ADDITIONAL_NGINX_CONFIGURE_ARGUMENTS+x}" ]; then
+      if ! "$ASSUME_YES"; then
+        echo "About to build nginx.  Do you have any additional ./configure"
+        echo "arguments you would like to set?  For example, if you would like"
+        echo "to build nginx with https support give --with-http_ssl_module"
+        echo "If you don't have any, just press enter."
+        read -p "> " additional_configure_args
       fi
+    else
+      additional_configure_args="$ADDITIONAL_NGINX_CONFIGURE_ARGUMENTS"
     fi
+
+    if [ -n "$additional_configure_args" ]; then
+      # Split additional_configure_args respecting any internal quotation.
+      # Otherwise things like --with-cc-opt='-foo -bar' won't work.
+      eval additional_configure_args=("$additional_configure_args")
+      configure=("${configure[@]}" "${additional_configure_args[@]}")
+    fi
+
     echo "About to configure nginx with:"
     echo "   $(quote_arguments "${configure[@]}")"
     continue_or_exit "Does this look right?"
@@ -749,25 +767,13 @@ Not deleting $directory; name is suspiciously short.  Something is wrong."
     if "$DEVEL"; then
       run make install
 
-      status "Nginx installed with ngx_pagespeed, and set up for testing."
-      # TODO(jefftk): pull these out into separate scripts.
-      echo "To run tests, pick a pair of ports like 8050 and 8051 and run:"
+      status "Nginx installed with ngx_pagespeed, and set up for development."
+      echo "To run tests:"
       echo "  cd $nps_module_dir"
-      echo "  RUN_TESTS=true \\"
-      echo "  USE_VALGRIND=false \\"
-      echo "  TEST_NATIVE_FETCHER=false \\"
-      echo "  TEST_SERF_FETCHER=true \\"
-      echo "  test/run_tests.sh \\"
-      echo "    $MOD_PAGESPEED_DIR \\"
-      echo "    $install_dir/nginx/sbin/nginx"
+      echo "  test/run_tests.sh"
       echo
       echo "To rebuild after changes:"
-      echo "  First, if you change things in PSOL or update it:"
-      echo "    cd $MOD_PAGESPEED_DIR/devel"
-      echo "    make apache_debug_psol"
-      echo "  Then, whether or not you updated PSOL, rebuild nginx:"
-      echo "    cd $install_dir/nginx"
-      echo "    make && make install"
+      echo "  scripts/rebuild.sh"
     else
       continue_or_exit "Install nginx?"
       run sudo make install

scripts/rebuild.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+#
+# Copyright 2016 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Usage: scripts/rebuild.sh
+#
+# After building with "scripts/build_ngx_pagespeed.sh --devel", if you make
+# changes to ngx_pagespeed you'll need to rebuild it.  The underlying commands
+# aren't complicated, but it's faster to work if it's automated.
+
+set -e  # exit script if any command returns an error
+set -u  # exit the script if any variable is uninitialized
+
+this_dir="$(dirname $0)"
+cd "$this_dir/.."
+nps_dir="$PWD"
+
+cd "$nps_dir/testing-dependencies/mod_pagespeed/devel"
+make apache_debug_psol
+
+cd "$nps_dir/testing-dependencies/nginx/"
+make
+make install

src/ngx_pagespeed.cc

@@ -239,6 +239,9 @@ ngx_http_output_body_filter_pt ngx_http_next_body_filter;
 ngx_int_t ps_base_fetch_filter(ngx_http_request_t* r, ngx_chain_t* in) {
   ps_request_ctx_t* ctx = ps_get_request_context(r);
 
+  if (r->header_only) {
+    return NGX_OK;
+  }
   if (ctx == NULL || ctx->base_fetch == NULL) {
     return ngx_http_next_body_filter(r, in);
   }
@@ -749,6 +752,11 @@ ngx_command_t ps_commands[] = {
   ngx_null_command
 };
 
+bool ps_disabled(ps_srv_conf_t* cfg_s) {
+  return cfg_s->server_context == NULL ||
+         cfg_s->server_context->config()->unplugged();
+}
+
 void ps_ignore_sigpipe() {
   struct sigaction act;
   ngx_memzero(&act, sizeof(act));
@@ -881,8 +889,7 @@ char* ps_configure(ngx_conf_t* cf,
   ps_main_conf_t* cfg_m = static_cast<ps_main_conf_t*>(
       ngx_http_cycle_get_module_main_conf(cf->cycle, ngx_pagespeed));
   if (*options == NULL) {
-    *options = new NgxRewriteOptions(
-        cfg_m->driver_factory->thread_system());
+    *options = new NgxRewriteOptions(cfg_m->driver_factory->thread_system());
   }
 
   ProcessScriptVariablesMode script_mode =
@@ -1148,13 +1155,17 @@ char* ps_merge_srv_conf(ngx_conf_t* cf, void* parent, void* child) {
   delete cfg_s->options;
   cfg_s->options = NULL;
 
-  if (cfg_s->server_context->global_options()->enabled()) {
+  if (!cfg_s->server_context->global_options()->unplugged()) {
     // Validate FileCachePath
     GoogleMessageHandler handler;
     const char* file_cache_path =
         cfg_s->server_context->config()->file_cache_path().c_str();
     if (file_cache_path[0] == '\0') {
-      return const_cast<char*>("FileCachePath must be set");
+      if (!cfg_s->server_context->global_options()->standby()) {
+        return const_cast<char*>("FileCachePath must be set, even for standby");
+      } else {
+        return const_cast<char*>("FileCachePath must be set");
+      }
     } else if (!cfg_m->driver_factory->file_system()->IsDir(
         file_cache_path, &handler).is_true()) {
       return const_cast<char*>(
@@ -1191,7 +1202,7 @@ char* ps_merge_loc_conf(ngx_conf_t* cf, void* parent, void* child) {
   ps_srv_conf_t* cfg_s = static_cast<ps_srv_conf_t*>(
       ngx_http_conf_get_module_srv_conf(cf, ngx_pagespeed));
 
-  if (cfg_s->server_context == NULL) {
+  if (ps_disabled(cfg_s)) {
     // Pagespeed options cannot be defined only in location blocks.  There must
     // be at least a single "pagespeed off" in the main block or a server
     // block.
@@ -1698,7 +1709,7 @@ void ps_release_request_context(void* data) {
 RequestRouting::Response ps_route_request(ngx_http_request_t* r) {
   ps_srv_conf_t* cfg_s = ps_get_srv_config(r);
 
-  if (!cfg_s->server_context->global_options()->enabled()) {
+  if (ps_disabled(cfg_s)) {
     // Not enabled for this server block.
     return RequestRouting::kPagespeedDisabled;
   }
@@ -1840,11 +1851,6 @@ ngx_int_t ps_resource_handler(ngx_http_request_t* r,
     options = cfg_s->server_context->global_options();
   }
 
-  if (!options->enabled()) {
-    // Disabled via query params or request headers.
-    return NGX_DECLINED;
-  }
-
   request_context->set_options(options->ComputeHttpOptions());
 
   // ps_determine_options modified url, removing any ModPagespeedFoo=Bar query
@@ -1871,6 +1877,14 @@ ngx_int_t ps_resource_handler(ngx_http_request_t* r,
       response_category == RequestRouting::kGlobalAdmin ||
       response_category == RequestRouting::kCachePurge;
 
+  // Normally if we're disabled we won't handle any requests, but if we're in
+  // standby mode we do want to handle requests for .pagespeed. resources.
+  if (options->unplugged() ||
+      (!options->enabled() && !pagespeed_resource)) {
+    // Disabled via query params or request headers.
+    return NGX_DECLINED;
+  }
+
   if (!html_rewrite) {
     // create request ctx
     CHECK(ctx == NULL);
@@ -2050,8 +2064,8 @@ ngx_int_t ps_resource_handler(ngx_http_request_t* r,
   if (options->in_place_rewriting_enabled() &&
       options->enabled() &&
       options->IsAllowed(url.Spec())) {
-    ps_create_base_fetch(url.Spec(), ctx, request_context, request_headers.release(),
-                         kIproLookup, options);
+    ps_create_base_fetch(url.Spec(), ctx, request_context,
+                         request_headers.release(), kIproLookup, options);
 
     // Do not store driver in request_context, it's not safe.
     RewriteDriver* driver;
@@ -2277,8 +2291,7 @@ ngx_http_output_body_filter_pt ngx_http_next_body_filter;
 // nginx so it can send them out to the browser.
 ngx_int_t ps_html_rewrite_header_filter(ngx_http_request_t* r) {
   ps_srv_conf_t* cfg_s = ps_get_srv_config(r);
-  if (cfg_s->server_context == NULL) {
-    // Pagespeed is on for some server block but not this one.
+  if (ps_disabled(cfg_s)) {
     return ngx_http_next_header_filter(r);
   }
 
@@ -2362,8 +2375,7 @@ ngx_int_t ps_html_rewrite_header_filter(ngx_http_request_t* r) {
 
 ngx_int_t ps_html_rewrite_body_filter(ngx_http_request_t* r, ngx_chain_t* in) {
   ps_srv_conf_t* cfg_s = ps_get_srv_config(r);
-  if (cfg_s->server_context == NULL) {
-    // Pagespeed is on for some server block but not this one.
+  if (ps_disabled(cfg_s)) {
     return ngx_http_next_body_filter(r, in);
   }
 
@@ -2887,8 +2899,8 @@ ngx_int_t ps_beacon_handler(ngx_http_request_t* r) {
 // supply it to the user.
 ngx_int_t ps_content_handler(ngx_http_request_t* r) {
   ps_srv_conf_t* cfg_s = ps_get_srv_config(r);
-  if (cfg_s->server_context == NULL) {
-    // Pagespeed is on for some server block but not this one.
+  if (ps_disabled(cfg_s)) {
+    // Pagespeed is not on for this server block.
     return NGX_DECLINED;
   }
 

src/ngx_rewrite_options.cc

@@ -192,15 +192,18 @@ RewriteOptions::OptionScope NgxRewriteOptions::GetOptionScope(
 
 RewriteOptions::OptionSettingResult NgxRewriteOptions::ParseAndSetOptions0(
     StringPiece directive, GoogleString* msg, MessageHandler* handler) {
-  if (IsDirective(directive, "on")) {
-    set_enabled(RewriteOptions::kEnabledOn);
-  } else if (IsDirective(directive, "off")) {
-    set_enabled(RewriteOptions::kEnabledOff);
-  } else if (IsDirective(directive, "unplugged")) {
-    set_enabled(RewriteOptions::kEnabledUnplugged);
-  } else {
+  EnabledEnum enabled;
+  if (!ParseFromString(directive, &enabled)) {
     return RewriteOptions::kOptionNameUnknown;
   }
+  if (enabled == RewriteOptions::kEnabledOff) {
+    // In ngx_pagespeed, for historical reasons, we treat "off" as "unplugged".
+    // Also, "off" is deprecated and people should be using "standby" or
+    // "unplugged" now depending on which sense they want.  See comment on
+    // RewriteOptions::EnabledEnum.
+    enabled = RewriteOptions::kEnabledUnplugged;
+  }
+  set_enabled(enabled);
   return RewriteOptions::kOptionOk;
 }
 

test/nginx_system_test.sh

@@ -369,6 +369,13 @@ fi
 # wants different ones than we want, so we need to reset our positional args.
 set -- "$PRIMARY_HOSTNAME"
 source $SYSTEM_TEST_FILE
+
+# If we were only asked to run a single test, it ran in SYSTEM_TEST_FILE, so
+# we're done now and should exit.
+if [ -n ${TEST_TO_RUN+x} ]; then
+  check_failures_and_exit
+fi
+
 source $REMOTE_CONFIG_TEST_FILE
 
 # nginx-specific system tests

test/pagespeed_test.conf.template

@@ -85,6 +85,8 @@ http {
   pagespeed StatisticsLogging on;
   pagespeed LogDir "@@TEST_TMP@@/logdir";
 
+  pagespeed MaxFetchRedirects 3;
+
   # Expanded to CentralControllerPort directive when RUN_CONTROLLER_TEST=on
   @@CONTROLLER@@
 
@@ -132,6 +134,42 @@ http {
       "@@SERVER_ROOT@@/mod_pagespeed_example/styles/";
   }
 
+  server {
+    listen @@SECONDARY_PORT@@;
+    listen [::]:@@SECONDARY_PORT@@;
+    server_name pagespeed-off.example.com;
+    pagespeed FileCachePath "@@FILE_CACHE@@";
+    pagespeed off;
+    pagespeed EnableFilters collapse_whitespace;
+  }
+
+  server {
+    listen @@SECONDARY_PORT@@;
+    listen [::]:@@SECONDARY_PORT@@;
+    server_name pagespeed-on.example.com;
+    pagespeed FileCachePath "@@FILE_CACHE@@";
+    pagespeed on;
+    pagespeed EnableFilters collapse_whitespace;
+  }
+
+  server {
+    listen @@SECONDARY_PORT@@;
+    listen [::]:@@SECONDARY_PORT@@;
+    server_name pagespeed-standby.example.com;
+    pagespeed FileCachePath "@@FILE_CACHE@@";
+    pagespeed standby;
+    pagespeed EnableFilters collapse_whitespace;
+  }
+
+  server {
+    listen @@SECONDARY_PORT@@;
+    listen [::]:@@SECONDARY_PORT@@;
+    server_name pagespeed-unplugged.example.com;
+    pagespeed FileCachePath "@@FILE_CACHE@@";
+    pagespeed unplugged;
+    pagespeed EnableFilters collapse_whitespace;
+  }
+
   pagespeed UseNativeFetcher "@@NATIVE_FETCHER@@";
   @@RESOLVER@@
 
@@ -1636,6 +1674,50 @@ http {
     pagespeed MessagesDomains Disallow *;
     pagespeed FileCachePath "@@FILE_CACHE@@";
   }
+
+  server {
+    listen @@SECONDARY_PORT@@;
+    listen [::]:@@SECONDARY_PORT@@;
+    server_name redirecting-fetch.example.com;
+    pagespeed FileCachePath "@@FILE_CACHE@@";
+    pagespeed Domain redirecting-fetch.example.com:@@SECONDARY_PORT@@;
+    pagespeed MapOriginDomain 127.0.0.1:@@SECONDARY_PORT@@
+    	      redirecting-fetch.example.com:@@SECONDARY_PORT@@;
+    pagespeed Disallow *styles/disallowed.css;
+    pagespeed InPlaceResourceOptimization off;
+
+    location /redir_to_test/styles/blue.css {
+      return 301 /mod_pagespeed_example/styles/yellow.css;
+    }
+    location /redir_to_test/styles/1.css {
+      return 301 /redir_to_test/styles/2.css;
+    }
+    location /redir_to_test/styles/2.css {
+      return 301 /mod_pagespeed_example/styles/yellow.css;
+    }
+    location /redir_to_test/styles/redirtodisallowed.css {
+      return 301 /redir_to_test/styles/disallowed.css;
+    }
+  }
+
+  server {
+    listen @@SECONDARY_PORT@@;
+    listen [::]:@@SECONDARY_PORT@@;
+    server_name redirecting-fetch-single-only.example.com;
+    pagespeed FileCachePath "@@FILE_CACHE@@";
+    pagespeed MaxFetchRedirects 1;
+    pagespeed Domain redirecting-fetch.example.com:@@SECONDARY_PORT@@;
+    pagespeed MapOriginDomain 127.0.0.1:@@SECONDARY_PORT@@ 
+       redirecting-fetch-single-only.example.com:@@SECONDARY_PORT@@;
+
+    location /redir_to_test/styles/1.css {
+      return 301 /redir_to_test/styles/2.css;
+    }
+    location /redir_to_test/styles/2.css {
+      return 301 /mod_pagespeed_example/styles/yellow.css;
+    }
+  }
+
   server {
     server_name nothing-explicitly-allowed.example.com;
     pagespeed FileCachePath "@@FILE_CACHE@@";

test/run_tests.sh

@@ -23,8 +23,15 @@
 # Exits with status 2 if command line args are wrong.
 #
 # Usage:
+#   ./run_tests.sh
+# Or:
 #   ./run_tests.sh /path/to/mod_pagespeed /path/to/nginx/binary
 #
+# If you built ngx_pagespeed with "scripts/build_ngx_pagespeed.sh --devel" then
+# you don't need to pass any arguments to run_tests.sh.  Otherwise, you'll need
+# to tell it where to find a mod_pagespeed checkout (for example html files etc)
+# and the nginx binary to test.
+#
 # By default the test script uses several ports.  If you have a port conflict
 # and need to override one you can do that by setting the relevant environment
 # variable.  For example:
@@ -45,14 +52,17 @@ RUN_TESTS=${RUN_TESTS:-true}
 # true.
 USE_VALGRIND=${USE_VALGRIND:-false}
 
-if [ "$#" -ne 2 ] ; then
-  echo "Usage: $0 mod_pagespeed_dir nginx_executable"
+if [ "$#" -eq 0 ]; then
+  MOD_PAGESPEED_DIR="testing-dependencies/mod_pagespeed/"
+  NGINX_EXECUTABLE="nginx/sbin/nginx"
+elif [ "$#" -eq 2 ]; then
+  MOD_PAGESPEED_DIR="$1"
+  NGINX_EXECUTABLE="$2"
+else
+  echo "Usage: $0 [mod_pagespeed_dir nginx_executable]"
   exit 2
 fi
 
-MOD_PAGESPEED_DIR="$1"
-NGINX_EXECUTABLE="$2"
-
 : ${PRIMARY_PORT:=8050}
 : ${SECONDARY_PORT:=8051}
 : ${CONTROLLER_PORT:=8053}