construct-hub 0.4.406 → 0.4.407

package/lib/construct-hub.js

@@ -393,7 +393,7 @@ class ConstructHub extends constructs_1.Construct {
 }
 exports.ConstructHub = ConstructHub;
 _a = JSII_RTTI_SYMBOL_1;
-ConstructHub[_a] = { fqn: "construct-hub.ConstructHub", version: "0.4.406" };
+ConstructHub[_a] = { fqn: "construct-hub.ConstructHub", version: "0.4.407" };
 /**
  * How possibly risky operations (such as doc-generation, which requires
  * installing the indexed packages in order to trans-literate sample code) are

package/lib/monitoring/http-get-function.lambda.bundle/index.js

@@ -1645,6 +1645,17 @@ var require_http_cache_semantics = __commonJS({
       return parts.join(", ");
     }
     module2.exports = class CachePolicy {
+      /**
+       * Creates a new CachePolicy instance.
+       * @param {HttpRequest} req - Incoming client request.
+       * @param {HttpResponse} res - Received server response.
+       * @param {Object} [options={}] - Configuration options.
+       * @param {boolean} [options.shared=true] - Is the cache shared (a public proxy)? `false` for personal browser caches.
+       * @param {number} [options.cacheHeuristic=0.1] - Fallback heuristic (age fraction) for cache duration.
+       * @param {number} [options.immutableMinTimeToLive=86400000] - Minimum TTL for immutable responses in milliseconds.
+       * @param {boolean} [options.ignoreCargoCult=false] - Detect nonsense cache headers, and override them.
+       * @param {any} [options._fromObject] - Internal parameter for deserialization. Do not use.
+       */
       constructor(req, res, {
         shared,
         cacheHeuristic,
@@ -1662,6 +1673,7 @@ var require_http_cache_semantics = __commonJS({
         this._assertRequestHasHeaders(req);
         this._responseTime = this.now();
         this._isShared = shared !== false;
+        this._ignoreCargoCult = !!ignoreCargoCult;
         this._cacheHeuristic = void 0 !== cacheHeuristic ? cacheHeuristic : 0.1;
         this._immutableMinTtl = void 0 !== immutableMinTimeToLive ? immutableMinTimeToLive : 24 * 3600 * 1e3;
         this._status = "status" in res ? res.status : 200;
@@ -1673,7 +1685,7 @@ var require_http_cache_semantics = __commonJS({
         this._noAuthorization = !req.headers.authorization;
         this._reqHeaders = res.headers.vary ? req.headers : null;
         this._reqcc = parseCacheControl(req.headers["cache-control"]);
-        if (ignoreCargoCult && "pre-check" in this._rescc && "post-check" in this._rescc) {
+        if (this._ignoreCargoCult && "pre-check" in this._rescc && "post-check" in this._rescc) {
           delete this._rescc["pre-check"];
           delete this._rescc["post-check"];
           delete this._rescc["no-cache"];
@@ -1689,9 +1701,17 @@ var require_http_cache_semantics = __commonJS({
           this._rescc["no-cache"] = true;
         }
       }
+      /**
+       * You can monkey-patch it for testing.
+       * @returns {number} Current time in milliseconds.
+       */
       now() {
         return Date.now();
       }
+      /**
+       * Determines if the response is storable in a cache.
+       * @returns {boolean} `false` if can never be cached.
+       */
       storable() {
         return !!(!this._reqcc["no-store"] && // A cache MUST NOT store a response to any request, unless:
         // The request method is understood by the cache and defined as being cacheable, and
@@ -1707,42 +1727,142 @@ var require_http_cache_semantics = __commonJS({
         this._rescc["max-age"] || this._isShared && this._rescc["s-maxage"] || this._rescc.public || // has a status code that is defined as cacheable by default
         statusCodeCacheableByDefault.has(this._status)));
       }
+      /**
+       * @returns {boolean} true if expiration is explicitly defined.
+       */
       _hasExplicitExpiration() {
-        return this._isShared && this._rescc["s-maxage"] || this._rescc["max-age"] || this._resHeaders.expires;
+        return !!(this._isShared && this._rescc["s-maxage"] || this._rescc["max-age"] || this._resHeaders.expires);
       }
+      /**
+       * @param {HttpRequest} req - a request
+       * @throws {Error} if the headers are missing.
+       */
       _assertRequestHasHeaders(req) {
         if (!req || !req.headers) {
           throw Error("Request headers missing");
         }
       }
+      /**
+       * Checks if the request matches the cache and can be satisfied from the cache immediately,
+       * without having to make a request to the server.
+       *
+       * This doesn't support `stale-while-revalidate`. See `evaluateRequest()` for a more complete solution.
+       *
+       * @param {HttpRequest} req - The new incoming HTTP request.
+       * @returns {boolean} `true`` if the cached response used to construct this cache policy satisfies the request without revalidation.
+       */
       satisfiesWithoutRevalidation(req) {
+        const result = this.evaluateRequest(req);
+        return !result.revalidation;
+      }
+      /**
+       * @param {{headers: Record<string, string>, synchronous: boolean}|undefined} revalidation - Revalidation information, if any.
+       * @returns {{response: {headers: Record<string, string>}, revalidation: {headers: Record<string, string>, synchronous: boolean}|undefined}} An object with a cached response headers and revalidation info.
+       */
+      _evaluateRequestHitResult(revalidation) {
+        return {
+          response: {
+            headers: this.responseHeaders()
+          },
+          revalidation
+        };
+      }
+      /**
+       * @param {HttpRequest} request - new incoming
+       * @param {boolean} synchronous - whether revalidation must be synchronous (not s-w-r).
+       * @returns {{headers: Record<string, string>, synchronous: boolean}} An object with revalidation headers and a synchronous flag.
+       */
+      _evaluateRequestRevalidation(request, synchronous) {
+        return {
+          synchronous,
+          headers: this.revalidationHeaders(request)
+        };
+      }
+      /**
+       * @param {HttpRequest} request - new incoming
+       * @returns {{response: undefined, revalidation: {headers: Record<string, string>, synchronous: boolean}}} An object indicating no cached response and revalidation details.
+       */
+      _evaluateRequestMissResult(request) {
+        return {
+          response: void 0,
+          revalidation: this._evaluateRequestRevalidation(request, true)
+        };
+      }
+      /**
+       * Checks if the given request matches this cache entry, and how the cache can be used to satisfy it. Returns an object with:
+       *
+       * ```
+       * {
+       *     // If defined, you must send a request to the server.
+       *     revalidation: {
+       *         headers: {}, // HTTP headers to use when sending the revalidation response
+       *         // If true, you MUST wait for a response from the server before using the cache
+       *         // If false, this is stale-while-revalidate. The cache is stale, but you can use it while you update it asynchronously.
+       *         synchronous: bool,
+       *     },
+       *     // If defined, you can use this cached response.
+       *     response: {
+       *         headers: {}, // Updated cached HTTP headers you must use when responding to the client
+       *     },
+       * }
+       * ```
+       * @param {HttpRequest} req - new incoming HTTP request
+       * @returns {{response: {headers: Record<string, string>}|undefined, revalidation: {headers: Record<string, string>, synchronous: boolean}|undefined}} An object containing keys:
+       *   - revalidation: { headers: Record<string, string>, synchronous: boolean } Set if you should send this to the origin server
+       *   - response: { headers: Record<string, string> } Set if you can respond to the client with these cached headers
+       */
+      evaluateRequest(req) {
         this._assertRequestHasHeaders(req);
+        if (this._rescc["must-revalidate"]) {
+          return this._evaluateRequestMissResult(req);
+        }
+        if (!this._requestMatches(req, false)) {
+          return this._evaluateRequestMissResult(req);
+        }
         const requestCC = parseCacheControl(req.headers["cache-control"]);
         if (requestCC["no-cache"] || /no-cache/.test(req.headers.pragma)) {
-          return false;
+          return this._evaluateRequestMissResult(req);
         }
-        if (requestCC["max-age"] && this.age() > requestCC["max-age"]) {
-          return false;
+        if (requestCC["max-age"] && this.age() > toNumberOrZero(requestCC["max-age"])) {
+          return this._evaluateRequestMissResult(req);
         }
-        if (requestCC["min-fresh"] && this.timeToLive() < 1e3 * requestCC["min-fresh"]) {
-          return false;
+        if (requestCC["min-fresh"] && this.maxAge() - this.age() < toNumberOrZero(requestCC["min-fresh"])) {
+          return this._evaluateRequestMissResult(req);
         }
         if (this.stale()) {
-          const allowsStale = requestCC["max-stale"] && !this._rescc["must-revalidate"] && (true === requestCC["max-stale"] || requestCC["max-stale"] > this.age() - this.maxAge());
-          if (!allowsStale) {
-            return false;
+          const allowsStaleWithoutRevalidation = "max-stale" in requestCC && (true === requestCC["max-stale"] || requestCC["max-stale"] > this.age() - this.maxAge());
+          if (allowsStaleWithoutRevalidation) {
+            return this._evaluateRequestHitResult(void 0);
           }
+          if (this.useStaleWhileRevalidate()) {
+            return this._evaluateRequestHitResult(this._evaluateRequestRevalidation(req, false));
+          }
+          return this._evaluateRequestMissResult(req);
         }
-        return this._requestMatches(req, false);
+        return this._evaluateRequestHitResult(void 0);
       }
+      /**
+       * @param {HttpRequest} req - check if this is for the same cache entry
+       * @param {boolean} allowHeadMethod - allow a HEAD method to match.
+       * @returns {boolean} `true` if the request matches.
+       */
       _requestMatches(req, allowHeadMethod) {
-        return (!this._url || this._url === req.url) && this._host === req.headers.host && // the request method associated with the stored response allows it to be used for the presented request, and
+        return !!((!this._url || this._url === req.url) && this._host === req.headers.host && // the request method associated with the stored response allows it to be used for the presented request, and
         (!req.method || this._method === req.method || allowHeadMethod && "HEAD" === req.method) && // selecting header fields nominated by the stored response (if any) match those presented, and
-        this._varyMatches(req);
+        this._varyMatches(req));
       }
+      /**
+       * Determines whether storing authenticated responses is allowed.
+       * @returns {boolean} `true` if allowed.
+       */
       _allowsStoringAuthenticated() {
-        return this._rescc["must-revalidate"] || this._rescc.public || this._rescc["s-maxage"];
+        return !!(this._rescc["must-revalidate"] || this._rescc.public || this._rescc["s-maxage"]);
       }
+      /**
+       * Checks whether the Vary header in the response matches the new request.
+       * @param {HttpRequest} req - incoming HTTP request
+       * @returns {boolean} `true` if the vary headers match.
+       */
       _varyMatches(req) {
         if (!this._resHeaders.vary) {
           return true;
@@ -1756,6 +1876,11 @@ var require_http_cache_semantics = __commonJS({
         }
         return true;
       }
+      /**
+       * Creates a copy of the given headers without any hop-by-hop headers.
+       * @param {Record<string, string>} inHeaders - old headers from the cached response
+       * @returns {Record<string, string>} A new headers object without hop-by-hop headers.
+       */
       _copyWithoutHopByHopHeaders(inHeaders) {
         const headers = {};
         for (const name in inHeaders) {
@@ -1780,6 +1905,11 @@ var require_http_cache_semantics = __commonJS({
         }
         return headers;
       }
+      /**
+       * Returns the response headers adjusted for serving the cached response.
+       * Removes hop-by-hop headers and updates the Age and Date headers.
+       * @returns {Record<string, string>} The adjusted response headers.
+       */
       responseHeaders() {
         const headers = this._copyWithoutHopByHopHeaders(this._resHeaders);
         const age = this.age();
@@ -1791,8 +1921,8 @@ var require_http_cache_semantics = __commonJS({
         return headers;
       }
       /**
-       * Value of the Date response header or current time if Date was invalid
-       * @return timestamp
+       * Returns the Date header value from the response or the current time if invalid.
+       * @returns {number} Timestamp (in milliseconds) representing the Date header or response time.
        */
       date() {
         const serverDate = Date.parse(this._resHeaders.date);
@@ -1804,23 +1934,27 @@ var require_http_cache_semantics = __commonJS({
       /**
        * Value of the Age header, in seconds, updated for the current time.
        * May be fractional.
-       *
-       * @return Number
+       * @returns {number} The age in seconds.
        */
       age() {
         let age = this._ageValue();
         const residentTime = (this.now() - this._responseTime) / 1e3;
         return age + residentTime;
       }
+      /**
+       * @returns {number} The Age header value as a number.
+       */
       _ageValue() {
         return toNumberOrZero(this._resHeaders.age);
       }
       /**
-       * Value of applicable max-age (or heuristic equivalent) in seconds. This counts since response's `Date`.
+       * Possibly outdated value of applicable max-age (or heuristic equivalent) in seconds.
+       * This counts since response's `Date`.
        *
        * For an up-to-date value, see `timeToLive()`.
        *
-       * @return Number
+       * Returns the maximum age (freshness lifetime) of the response in seconds.
+       * @returns {number} The max-age value in seconds.
        */
       maxAge() {
         if (!this.storable() || this._rescc["no-cache"]) {
@@ -1863,24 +1997,52 @@ var require_http_cache_semantics = __commonJS({
         }
         return defaultMinTtl;
       }
+      /**
+       * Remaining time this cache entry may be useful for, in *milliseconds*.
+       * You can use this as an expiration time for your cache storage.
+       *
+       * Prefer this method over `maxAge()`, because it includes other factors like `age` and `stale-while-revalidate`.
+       * @returns {number} Time-to-live in milliseconds.
+       */
       timeToLive() {
         const age = this.maxAge() - this.age();
         const staleIfErrorAge = age + toNumberOrZero(this._rescc["stale-if-error"]);
         const staleWhileRevalidateAge = age + toNumberOrZero(this._rescc["stale-while-revalidate"]);
-        return Math.max(0, age, staleIfErrorAge, staleWhileRevalidateAge) * 1e3;
+        return Math.round(Math.max(0, age, staleIfErrorAge, staleWhileRevalidateAge) * 1e3);
       }
+      /**
+       * If true, this cache entry is past its expiration date.
+       * Note that stale cache may be useful sometimes, see `evaluateRequest()`.
+       * @returns {boolean} `false` doesn't mean it's fresh nor usable
+       */
       stale() {
         return this.maxAge() <= this.age();
       }
+      /**
+       * @returns {boolean} `true` if `stale-if-error` condition allows use of a stale response.
+       */
       _useStaleIfError() {
         return this.maxAge() + toNumberOrZero(this._rescc["stale-if-error"]) > this.age();
       }
+      /** See `evaluateRequest()` for a more complete solution
+       * @returns {boolean} `true` if `stale-while-revalidate` is currently allowed.
+       */
       useStaleWhileRevalidate() {
-        return this.maxAge() + toNumberOrZero(this._rescc["stale-while-revalidate"]) > this.age();
+        const swr = toNumberOrZero(this._rescc["stale-while-revalidate"]);
+        return swr > 0 && this.maxAge() + swr > this.age();
       }
+      /**
+       * Creates a `CachePolicy` instance from a serialized object.
+       * @param {Object} obj - The serialized object.
+       * @returns {CachePolicy} A new CachePolicy instance.
+       */
       static fromObject(obj) {
         return new this(void 0, void 0, { _fromObject: obj });
       }
+      /**
+       * @param {any} obj - The serialized object.
+       * @throws {Error} If already initialized or if the object is invalid.
+       */
       _fromObject(obj) {
         if (this._responseTime) throw Error("Reinitialized");
         if (!obj || obj.v !== 1) throw Error("Invalid serialization");
@@ -1888,6 +2050,7 @@ var require_http_cache_semantics = __commonJS({
         this._isShared = obj.sh;
         this._cacheHeuristic = obj.ch;
         this._immutableMinTtl = obj.imm !== void 0 ? obj.imm : 24 * 3600 * 1e3;
+        this._ignoreCargoCult = !!obj.icc;
         this._status = obj.st;
         this._resHeaders = obj.resh;
         this._rescc = obj.rescc;
@@ -1898,6 +2061,10 @@ var require_http_cache_semantics = __commonJS({
         this._reqHeaders = obj.reqh;
         this._reqcc = obj.reqcc;
       }
+      /**
+       * Serializes the `CachePolicy` instance into a JSON-serializable object.
+       * @returns {Object} The serialized object.
+       */
       toObject() {
         return {
           v: 1,
@@ -1905,6 +2072,7 @@ var require_http_cache_semantics = __commonJS({
           sh: this._isShared,
           ch: this._cacheHeuristic,
           imm: this._immutableMinTtl,
+          icc: this._ignoreCargoCult,
           st: this._status,
           resh: this._resHeaders,
           rescc: this._rescc,
@@ -1922,6 +2090,8 @@ var require_http_cache_semantics = __commonJS({
        *
        * Hop by hop headers are always stripped.
        * Revalidation headers may be added or removed, depending on request.
+       * @param {HttpRequest} incomingReq - The incoming HTTP request.
+       * @returns {Record<string, string>} The headers for the revalidation request.
        */
       revalidationHeaders(incomingReq) {
         this._assertRequestHasHeaders(incomingReq);
@@ -1960,15 +2130,18 @@ var require_http_cache_semantics = __commonJS({
        * Returns {policy, modified} where modified is a boolean indicating
        * whether the response body has been modified, and old cached body can't be used.
        *
-       * @return {Object} {policy: CachePolicy, modified: Boolean}
+       * @param {HttpRequest} request - The latest HTTP request asking for the cached entry.
+       * @param {HttpResponse} response - The latest revalidation HTTP response from the origin server.
+       * @returns {{policy: CachePolicy, modified: boolean, matches: boolean}} The updated policy and modification status.
+       * @throws {Error} If the response headers are missing.
        */
       revalidatedPolicy(request, response) {
         this._assertRequestHasHeaders(request);
         if (this._useStaleIfError() && isErrorResponse(response)) {
           return {
+            policy: this,
             modified: false,
-            matches: false,
-            policy: this
+            matches: true
           };
         }
         if (!response || !response.headers) {
@@ -1988,9 +2161,15 @@ var require_http_cache_semantics = __commonJS({
             matches = true;
           }
         }
+        const optionsCopy = {
+          shared: this._isShared,
+          cacheHeuristic: this._cacheHeuristic,
+          immutableMinTimeToLive: this._immutableMinTtl,
+          ignoreCargoCult: this._ignoreCargoCult
+        };
         if (!matches) {
           return {
-            policy: new this.constructor(request, response),
+            policy: new this.constructor(request, response, optionsCopy),
             // Client receiving 304 without body, even if it's invalid/mismatched has no option
             // but to reuse a cached body. We don't have a good way to tell clients to do
             // error recovery in such case.
@@ -2008,11 +2187,7 @@ var require_http_cache_semantics = __commonJS({
           headers
         });
         return {
-          policy: new this.constructor(request, newResponse, {
-            shared: this._isShared,
-            cacheHeuristic: this._cacheHeuristic,
-            immutableMinTimeToLive: this._immutableMinTtl
-          }),
+          policy: new this.constructor(request, newResponse, optionsCopy),
           modified: false,
           matches: true
         };