« index

Coverage for /Users/kris/q-io/http-apps/decorators.js : 68%

176 lines | 121 run | 55 missing | 0 partial | 34 blocks | 3 blocks run | 31 blocks missing

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

  var Q = require("q");
  var HTTP = require("../http");
  var RouteApps = require("./route");
  var StatusApps = require("./status");
  
  exports.Normalize = function (app) {
      return function (request, response) {
          var request = HTTP.normalizeRequest(request);
          return Q.when(app(request, response), function (response) {
              return HTTP.normalizeResponse(response);
          });
      };
  };
  
  exports.Date = function (app, present) {
      present = present || function () {
          return new Date();
      };
      return RouteApps.Trap(app, function (response, request) {
          response.headers["date"] = "" + present();
      });
  };
  
  /**
   * Decorates a JSGI application such that rejected response promises
   * get translated into `500` server error responses with no content.
   *
   * @param {App} app
   * @returns {App}
   */
  exports.Error = function (app, debug) {
      return function (request, response) {
          return Q.when(app(request, response), null, function (error) {
              if (!debug)
                  error = undefined;
              return StatusApps.responseForStatus(request, 500, error && error.stack || error);
          });
      };
  };
  
  exports.Debug = function (app) {
      return exports.Error(app, true);
  };
  
  /**
   * Decorates a Q-JSGI application such that all requests and responses
   * are logged.
   *
   * @param {App} app
   * @returns {App}
   */
  exports.Log = function (app, log, stamp) {
      log = log || console.log;
      stamp = stamp || function (message) {
          return new Date().toISOString() + " " + message;
      };
      return function (request, response) {
          var remoteHost =
              request.remoteHost + ":" +
              request.remotePort;
          var requestLine =
              request.method + " " +
              request.path + " " +
              "HTTP/" + request.version.join(".");
          log(stamp(
              remoteHost + " " +
              "-->     " +
              requestLine
          ));
          return Q.when(app(request, response), function (response) {
              if (response) {
                  log(stamp(
                      remoteHost + " " +
                      "<== " +
                      response.status + " " +
                      requestLine + " " +
                      (response.headers["content-length"] || "-")
                  ));
              } else {
                  log(stamp(
                      remoteHost + " " +
                      "... " +
                      "... " +
                      requestLine + " (response undefined / presumed streaming)"
                  ));
              }
              return response;
          }, function (reason) {
              log(stamp(
                  remoteHost + " " +
                  "!!!     " +
                  requestLine + " " +
                  (reason && reason.message || reason)
              ));
              return Q.reject(reason);
          });
      };
  };
  
  /**
   * Decorates a Q-JSGI application such that all responses have an
   * X-Response-Time header with the time between the request and the
   * response in milliseconds, not including any time needed to stream
   * the body to the client.
   *
   * @param {App} app
   * @returns {App}
   */
  exports.Time = function (app) {
      return function (request, response) {
          var start = new Date();
          return Q.when(app(request, response), function (response) {
              var stop = new Date();
              if (response && response.headers) {
                  response.headers["x-response-time"] = "" + (stop - start);
              }
              return response;
          });
      };
  };
  
  /**
   * Decorates a Q-JSGI application such that all responses have the
   * given additional headers.  These headers do not override the
   * application's given response headers.
   *
   * @param {Object} headers
   * @param {App} app decorated application.
   */
  exports.Headers = function (app, headers) {
      return function (request, response) {
          return Q.when(app(request, response), function (response) {
              if (response && response.headers) {
                  Object.keys(headers).forEach(function (key) {
                      if (!(key in response.headers)) {
                          response.headers[key] = headers[key];
                      }
                  });
              }
              return response;
          });
      };
  };
  
  var farFuture =
      1000 * // ms
      60 * // s
      60 * // m
      24 * // h
      365 * // d
      10; // years
  exports.Permanent = function (app, future) {
      future = future || function () {
          return new Date(new Date().getTime() + farFuture);
      };
      app = RouteApps.Tap(app, function (request, response) {
          request.permanent = future;
      });
      app = RouteApps.Trap(app, function (response, request) {
          response.headers["expires"] = "" + future();
      });
      return app;
  };
  
  /**
   * Wraps a Q-JSGI application in a sequence of decorators.
   * @param {Array * Decorator} decorators
   * @param {App} app
   * @returns {App}
   */
  exports.Decorators = function (decorators, app) {
      decorators.reversed().forEach(function (Middleware) {
          app = Middleware(app);
      });
      return app;
  };
« index | cover.io