clogger 0.0.1 → 0.0.2

data/GNUmakefile

@@ -32,6 +32,45 @@ test: test-ext test-pure
 Manifest.txt:
 	git ls-files > $@+
 	cmp $@+ $@ || mv $@+ $@
-	$(RM) -f $@+
+	$(RM) $@+
 
-.PHONY: test doc Manifest.txt
+VERSION := $(shell git describe 2>/dev/null | sed 's/^v//')
+
+ifneq ($(VERSION),)
+v := /^v$(VERSION)$$/
+vPREV := $(shell git tag -l 2>/dev/null | sed -n -e '$(v)!h' -e '$(v){x;p;q}')
+release_notes := release_notes-$(VERSION).txt
+release_changes := release_changes-$(VERSION).txt
+$(release_changes): verify
+	git diff --stat $(vPREV) v$(VERSION) > $@+
+	echo >> $@+
+	git log $(vPREV) v$(VERSION) >> $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+$(release_notes): verify package
+	gem spec pkg/clogger-$(VERSION).gem description | sed -ne '/\w/p' > $@+
+	git cat-file tag v$(VERSION) | awk 'p>1{print $$0}/^$$/{++p}' >> $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+verify:
+	@test -n "$(VERSION)" || { echo >&2 VERSION= not defined; exit 1; }
+	git rev-parse --verify refs/tags/v$(VERSION)^{}
+	@test -n "$(VISUAL)" || { echo >&2 VISUAL= not defined; exit 1; }
+
+package: verify
+	git diff-index --quiet HEAD^0
+	test `git rev-parse --verify HEAD^0` = \
+	     `git rev-parse --verify refs/tags/v$(VERSION)^{}`
+	$(RM) -r pkg
+	unset CLOGGER_EXT; rake package VERSION=$(VERSION)
+	CLOGGER_EXT=1 rake package VERSION=$(VERSION)
+
+# not using Hoe's release system since we release 2 gems but only one tgz
+release: package Manifest.txt $(release_notes) $(release_changes)
+	rubyforge add_release -f -n $(release_notes) -c $(release_changes) \
+	  clogger clogger $(VERSION) pkg/clogger-$(VERSION).gem
+	rubyforge add_file \
+	  clogger clogger $(VERSION) pkg/clogger-$(VERSION).tgz
+	rubyforge add_release -f -n $(release_notes) -c $(release_changes) \
+	  clogger clogger_ext $(VERSION) pkg/clogger_ext-$(VERSION).gem
+endif
+
+.PHONY: test doc Manifest.txt release

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.0.2 / 2009-08-29
+
+* 2 bug fixes
+
+   * support "$request_uri" as a log variable
+   * Log bad/invalid app responses as 500 errors
+
 === 0.0.1 / 2009-08-28
 
 * 1 major enhancement

data/ext/clogger_ext/clogger.c

@@ -54,7 +54,8 @@ enum clogger_special {
 	CL_SP_request_length,
 	CL_SP_response_length,
 	CL_SP_ip,
-	CL_SP_pid
+	CL_SP_pid,
+	CL_SP_request_uri,
 };
 
 struct clogger {
@@ -92,6 +93,7 @@ static VALUE g_HTTP_X_FORWARDED_FOR;
 static VALUE g_REMOTE_ADDR;
 static VALUE g_REQUEST_METHOD;
 static VALUE g_PATH_INFO;
+static VALUE g_REQUEST_URI;
 static VALUE g_QUERY_STRING;
 static VALUE g_HTTP_VERSION;
 static VALUE g_rack_errors;
@@ -102,6 +104,7 @@ static VALUE g_empty;
 static VALUE g_space;
 static VALUE g_question_mark;
 static VALUE g_rack_request_cookie_hash;
+static VALUE g_bad_app_response;
 
 #define LOG_BUF_INIT_SIZE 128
 
@@ -410,30 +413,44 @@ static void append_time_fmt(struct clogger *c, const VALUE *op)
 	append_tv(c, op, &now);
 }
 
+static void append_request_uri(struct clogger *c)
+{
+	VALUE tmp;
+
+	tmp = rb_hash_aref(c->env, g_REQUEST_URI);
+	if (NIL_P(tmp)) {
+		tmp = rb_hash_aref(c->env, g_PATH_INFO);
+		if (!NIL_P(tmp))
+			rb_str_buf_append(c->log_buf, byte_xs(tmp));
+		tmp = rb_hash_aref(c->env, g_QUERY_STRING);
+		if (!NIL_P(tmp) && RSTRING_LEN(tmp) != 0) {
+			rb_str_buf_append(c->log_buf, g_question_mark);
+			rb_str_buf_append(c->log_buf, byte_xs(tmp));
+		}
+	} else {
+		rb_str_buf_append(c->log_buf, byte_xs(tmp));
+	}
+}
+
 static void append_request(struct clogger *c)
 {
 	VALUE tmp;
-	VALUE env = c->env;
 
 	/* REQUEST_METHOD doesn't need escaping, Rack::Lint governs it */
-	tmp = rb_hash_aref(env, g_REQUEST_METHOD);
-	rb_str_buf_append(c->log_buf, NIL_P(tmp) ? g_empty : tmp);
+	tmp = rb_hash_aref(c->env, g_REQUEST_METHOD);
+	if (!NIL_P(tmp))
+		rb_str_buf_append(c->log_buf, tmp);
+
 	rb_str_buf_append(c->log_buf, g_space);
 
-	/* broken clients can send " and other questionable URIs */
-	tmp = rb_hash_aref(env, g_PATH_INFO);
-	rb_str_buf_append(c->log_buf, NIL_P(tmp) ? g_empty : byte_xs(tmp));
+	append_request_uri(c);
 
-	tmp = rb_hash_aref(env, g_QUERY_STRING);
-	if (RSTRING_LEN(tmp) != 0) {
-		rb_str_buf_append(c->log_buf, g_question_mark);
-		rb_str_buf_append(c->log_buf, byte_xs(tmp));
-	}
 	rb_str_buf_append(c->log_buf, g_space);
 
 	/* HTTP_VERSION can be injected by malicious clients */
-	tmp = rb_hash_aref(env, g_HTTP_VERSION);
-	rb_str_buf_append(c->log_buf, NIL_P(tmp) ? g_empty : byte_xs(tmp));
+	tmp = rb_hash_aref(c->env, g_HTTP_VERSION);
+	if (!NIL_P(tmp))
+		rb_str_buf_append(c->log_buf, byte_xs(tmp));
 }
 
 static void append_request_length(struct clogger *c)
@@ -538,6 +555,9 @@ static void special_var(struct clogger *c, enum clogger_special var)
 		break;
 	case CL_SP_pid:
 		append_pid(c);
+                break;
+	case CL_SP_request_uri:
+		append_request_uri(c);
 	}
 }
 
@@ -703,10 +723,21 @@ static VALUE clogger_fileno(VALUE self)
 
 static void ccall(struct clogger *c, VALUE env)
 {
+	VALUE rv;
+
 	gettimeofday(&c->tv_start, NULL);
 	c->env = env;
 	c->cookies = Qfalse;
-	c->response = rb_funcall(c->app, call_id, 1, env);
+	rv = rb_funcall(c->app, call_id, 1, env);
+	if (TYPE(rv) == T_ARRAY && RARRAY_LEN(rv) == 3) {
+		c->response = rv;
+	} else {
+		c->response = g_bad_app_response;
+		cwrite(c);
+		rb_raise(rb_eTypeError,
+		         "app response not a 3 element Array: %s",
+			 RSTRING_PTR(rb_inspect(rv)));
+	}
 }
 
 /*
@@ -763,6 +794,16 @@ static VALUE clogger_init_copy(VALUE clone, VALUE orig)
 
 #define CONST_GLOBAL_STR(val) CONST_GLOBAL_STR2(val, #val)
 
+static void init_bad_response(void)
+{
+	g_bad_app_response = rb_ary_new();
+	rb_ary_store(g_bad_app_response, 0, INT2NUM(500));
+	rb_ary_store(g_bad_app_response, 1, rb_obj_freeze(rb_hash_new()));
+	rb_ary_store(g_bad_app_response, 2, rb_obj_freeze(rb_ary_new()));
+	rb_obj_freeze(g_bad_app_response);
+	rb_global_variable(&g_bad_app_response);
+}
+
 void Init_clogger_ext(void)
 {
 	ltlt_id = rb_intern("<<");
@@ -788,6 +829,7 @@ void Init_clogger_ext(void)
 	CONST_GLOBAL_STR(REQUEST_METHOD);
 	CONST_GLOBAL_STR(PATH_INFO);
 	CONST_GLOBAL_STR(QUERY_STRING);
+	CONST_GLOBAL_STR(REQUEST_URI);
 	CONST_GLOBAL_STR(HTTP_VERSION);
 	CONST_GLOBAL_STR2(rack_errors, "rack.errors");
 	CONST_GLOBAL_STR2(rack_input, "rack.input");
@@ -797,4 +839,5 @@ void Init_clogger_ext(void)
 	CONST_GLOBAL_STR2(space, " ");
 	CONST_GLOBAL_STR2(question_mark, "?");
 	CONST_GLOBAL_STR2(rack_request_cookie_hash, "rack.request.cookie_hash");
+	init_bad_response();
 }

data/lib/clogger.rb

@@ -1,6 +1,6 @@
 # -*- encoding: binary -*-
 class Clogger
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
   OP_LITERAL = 0
   OP_REQUEST = 1
@@ -29,6 +29,7 @@ class Clogger
     :response_length => 4, # like body_bytes_sent, except "-" instead of "0"
     :ip => 5, # HTTP_X_FORWARDED_FOR || REMOTE_ADDR || -
     :pid => 6, # getpid()
+    :request_uri => 7
   }
 
 private

data/lib/clogger/pure.rb

@@ -16,7 +16,12 @@ class Clogger
 
   def call(env)
     @start = Time.now
-    status, headers, body = @app.call(env)
+    resp = @app.call(env)
+    unless resp.instance_of?(Array) && resp.size == 3
+      log(env, 500, {})
+      raise TypeError, "app response not a 3 element Array: #{resp.inspect}"
+    end
+    status, headers, body = resp
     if wrap_body?
       @reentrant = env['rack.multithread']
       @env, @status, @headers, @body = env, status, headers, body
@@ -63,6 +68,13 @@ private
 
   SPECIAL_RMAP = SPECIAL_VARS.inject([]) { |ary, (k,v)| ary[v] = k; ary }
 
+  def request_uri(env)
+    ru = env['REQUEST_URI'] and return byte_xs(ru)
+    qs = env['QUERY_STRING']
+    qs.empty? or qs = "?#{byte_xs(qs)}"
+    "#{byte_xs(env['PATH_INFO'])}#{qs}"
+  end
+
   def special_var(special_nr, env, status, headers)
     case SPECIAL_RMAP[special_nr]
     when :body_bytes_sent
@@ -74,8 +86,10 @@ private
       qs = env['QUERY_STRING']
       qs.empty? or qs = "?#{byte_xs(qs)}"
       "#{env['REQUEST_METHOD']} " \
-        "#{byte_xs(env['PATH_INFO'])}#{qs} " \
+        "#{request_uri(env)} " \
         "#{byte_xs(env['HTTP_VERSION'])}"
+    when :request_uri
+      request_uri(env)
     when :request_length
       env['rack.input'].size.to_s
     when :response_length

data/test/test_clogger.rb

@@ -333,6 +333,22 @@ class TestClogger < Test::Unit::TestCase
     assert_equal expect, str.string
   end
 
+  def test_request_uri_fallback
+    str = StringIO.new
+    app = lambda { |env| [ 200, {}, [] ] }
+    cl = Clogger.new(app, :logger => str, :format => '$request_uri')
+    status, headers, body = cl.call(@req)
+    assert_equal "/hello?goodbye=true\n", str.string
+  end
+
+  def test_request_uri_set
+    str = StringIO.new
+    app = lambda { |env| [ 200, {}, [] ] }
+    cl = Clogger.new(app, :logger => str, :format => '$request_uri')
+    status, headers, body = cl.call(@req.merge("REQUEST_URI" => '/zzz'))
+    assert_equal "/zzz\n", str.string
+  end
+
   def test_cookies
     str = StringIO.new
     app = lambda { |env|
@@ -346,4 +362,15 @@ class TestClogger < Test::Unit::TestCase
     status, headers, body = cl.call(req)
     assert_equal "bar h&m\n", str.string
   end
+
+  def test_bogus_app_response
+    str = StringIO.new
+    app = lambda { |env| 302 }
+    cl = Clogger.new(app, :logger => str)
+    assert_raise(TypeError) { cl.call(@req) }
+    str = str.string
+    e = Regexp.quote " \"GET /hello?goodbye=true HTTP/1.0\" 500 -"
+    assert_match %r{#{e}$}m, str
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clogger
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Eric Wong
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-28 00:00:00 -07:00
+date: 2009-08-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency