acrylblends 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +22 -16
- package/dist/index.js +65 -20
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/plugins/acryl-inspect/LICENSE +21 -0
- package/plugins/acryl-inspect/plugin.json +12 -0
- package/plugins/acryl-inspect/src/index.ts +3 -0
- package/plugins/acryl-inspect/src/report.ts +126 -0
- package/plugins/acryl-inspect/src/service.ts +68 -0
- package/plugins/acryl-inspect/tests/report.spec.ts +63 -0
- package/plugins/acryl-inspect/tests/service.spec.ts +121 -0
- package/plugins/acryl-inspect/upstream.json +18 -0
- package/plugins/acryl-node-server/LICENSE +47 -0
- package/plugins/acryl-node-server/plugin.json +13 -0
- package/plugins/acryl-node-server/src/adapter/conninfo.ts +23 -0
- package/plugins/acryl-node-server/src/adapter/early-hints.ts +55 -0
- package/plugins/acryl-node-server/src/adapter/error.ts +11 -0
- package/plugins/acryl-node-server/src/adapter/headers.ts +249 -0
- package/plugins/acryl-node-server/src/adapter/index.ts +6 -0
- package/plugins/acryl-node-server/src/adapter/listener.ts +540 -0
- package/plugins/acryl-node-server/src/adapter/request.ts +797 -0
- package/plugins/acryl-node-server/src/adapter/response.ts +186 -0
- package/plugins/acryl-node-server/src/adapter/serve-static.ts +238 -0
- package/plugins/acryl-node-server/src/adapter/server.ts +36 -0
- package/plugins/acryl-node-server/src/adapter/types.ts +82 -0
- package/plugins/acryl-node-server/src/adapter/url.ts +42 -0
- package/plugins/acryl-node-server/src/adapter/utils/response/constants.ts +1 -0
- package/plugins/acryl-node-server/src/adapter/utils/response.ts +4 -0
- package/plugins/acryl-node-server/src/adapter/utils/stream.ts +88 -0
- package/plugins/acryl-node-server/src/adapter/utils.ts +96 -0
- package/plugins/acryl-node-server/src/adapter/websocket-types.ts +45 -0
- package/plugins/acryl-node-server/src/adapter/websocket.ts +375 -0
- package/plugins/acryl-node-server/src/index.ts +107 -0
- package/plugins/acryl-node-server/tests/adapter/app.ts +76 -0
- package/plugins/acryl-node-server/tests/adapter/assets/.static/plain.txt +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/favicon.ico +0 -0
- package/plugins/acryl-node-server/tests/adapter/assets/secret.txt +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/acryl.html +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/admin/secret.txt +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/data.json +5 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/extensionless +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/foo..bar.txt +0 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/index.html +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static/plain.txt +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static-with-context-path/plain.txt +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static-with-precompressed/hello.bin +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static-with-precompressed/hello.bin.br +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static-with-precompressed/hello.txt +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static-with-precompressed/hello.txt.br +1 -0
- package/plugins/acryl-node-server/tests/adapter/assets/static-with-precompressed/hello.txt.zst +1 -0
- package/plugins/acryl-node-server/tests/adapter/conninfo.test.ts +34 -0
- package/plugins/acryl-node-server/tests/adapter/content-length.test.ts +248 -0
- package/plugins/acryl-node-server/tests/adapter/early-hints.test.ts +457 -0
- package/plugins/acryl-node-server/tests/adapter/fixtures/keys/agent1-cert.pem +23 -0
- package/plugins/acryl-node-server/tests/adapter/fixtures/keys/agent1-key.pem +27 -0
- package/plugins/acryl-node-server/tests/adapter/headers.test.ts +252 -0
- package/plugins/acryl-node-server/tests/adapter/helpers/request.ts +190 -0
- package/plugins/acryl-node-server/tests/adapter/listener.test.ts +727 -0
- package/plugins/acryl-node-server/tests/adapter/request-client-disconnect.test.ts +189 -0
- package/plugins/acryl-node-server/tests/adapter/request.test.ts +1230 -0
- package/plugins/acryl-node-server/tests/adapter/response.test.ts +285 -0
- package/plugins/acryl-node-server/tests/adapter/serve-static.test.ts +849 -0
- package/plugins/acryl-node-server/tests/adapter/server-socket.test.ts +790 -0
- package/plugins/acryl-node-server/tests/adapter/server.test.ts +1302 -0
- package/plugins/acryl-node-server/tests/adapter/setup.ts +16 -0
- package/plugins/acryl-node-server/tests/adapter/url.test.ts +76 -0
- package/plugins/acryl-node-server/tests/adapter/utils/response.test.ts +23 -0
- package/plugins/acryl-node-server/tests/adapter/utils/stream.test.ts +75 -0
- package/plugins/acryl-node-server/tests/adapter/utils.test.ts +235 -0
- package/plugins/acryl-node-server/tests/adapter/websocket.test.ts +260 -0
- package/plugins/acryl-node-server/tests/server.spec.ts +141 -0
- package/plugins/acryl-node-server/upstream.json +18 -0
- package/plugins/acryl-router/LICENSE +47 -0
- package/plugins/acryl-router/plugin.json +13 -0
- package/plugins/acryl-router/src/client.ts +2 -0
- package/plugins/acryl-router/src/connection.ts +42 -0
- package/plugins/acryl-router/src/core/app-base.ts +544 -0
- package/plugins/acryl-router/src/core/app.test.ts +3833 -0
- package/plugins/acryl-router/src/core/app.ts +34 -0
- package/plugins/acryl-router/src/core/client/client.test.ts +2313 -0
- package/plugins/acryl-router/src/core/client/client.ts +249 -0
- package/plugins/acryl-router/src/core/client/fetch-result-please.ts +95 -0
- package/plugins/acryl-router/src/core/client/index.ts +17 -0
- package/plugins/acryl-router/src/core/client/types.test.ts +149 -0
- package/plugins/acryl-router/src/core/client/types.ts +393 -0
- package/plugins/acryl-router/src/core/client/utils.test.ts +405 -0
- package/plugins/acryl-router/src/core/client/utils.ts +117 -0
- package/plugins/acryl-router/src/core/compose.test.ts +751 -0
- package/plugins/acryl-router/src/core/compose.ts +73 -0
- package/plugins/acryl-router/src/core/context.test.ts +629 -0
- package/plugins/acryl-router/src/core/context.ts +781 -0
- package/plugins/acryl-router/src/core/helper/accepts/accepts.test.ts +344 -0
- package/plugins/acryl-router/src/core/helper/accepts/accepts.ts +96 -0
- package/plugins/acryl-router/src/core/helper/accepts/index.ts +6 -0
- package/plugins/acryl-router/src/core/helper/adapter/index.test.ts +55 -0
- package/plugins/acryl-router/src/core/helper/adapter/index.ts +90 -0
- package/plugins/acryl-router/src/core/helper/conninfo/index.ts +6 -0
- package/plugins/acryl-router/src/core/helper/conninfo/types.ts +45 -0
- package/plugins/acryl-router/src/core/helper/cookie/index.test.ts +510 -0
- package/plugins/acryl-router/src/core/helper/cookie/index.ts +146 -0
- package/plugins/acryl-router/src/core/helper/factory/index.test.ts +434 -0
- package/plugins/acryl-router/src/core/helper/factory/index.ts +375 -0
- package/plugins/acryl-router/src/core/helper/html/index.test.ts +78 -0
- package/plugins/acryl-router/src/core/helper/html/index.ts +57 -0
- package/plugins/acryl-router/src/core/helper/route/index.test.ts +259 -0
- package/plugins/acryl-router/src/core/helper/route/index.ts +144 -0
- package/plugins/acryl-router/src/core/helper/streaming/index.ts +9 -0
- package/plugins/acryl-router/src/core/helper/streaming/sse.ts +101 -0
- package/plugins/acryl-router/src/core/helper/streaming/stream.test.ts +128 -0
- package/plugins/acryl-router/src/core/helper/streaming/stream.ts +45 -0
- package/plugins/acryl-router/src/core/helper/streaming/text.test.ts +34 -0
- package/plugins/acryl-router/src/core/helper/streaming/text.ts +15 -0
- package/plugins/acryl-router/src/core/helper/streaming/utils.ts +11 -0
- package/plugins/acryl-router/src/core/helper/testing/index.test.ts +42 -0
- package/plugins/acryl-router/src/core/helper/testing/index.ts +28 -0
- package/plugins/acryl-router/src/core/helper/websocket/index.test.ts +124 -0
- package/plugins/acryl-router/src/core/helper/websocket/index.ts +140 -0
- package/plugins/acryl-router/src/core/http-exception.test.ts +45 -0
- package/plugins/acryl-router/src/core/http-exception.ts +77 -0
- package/plugins/acryl-router/src/core/index.ts +53 -0
- package/plugins/acryl-router/src/core/middleware/basic-auth/index.test.ts +434 -0
- package/plugins/acryl-router/src/core/middleware/basic-auth/index.ts +152 -0
- package/plugins/acryl-router/src/core/middleware/bearer-auth/index.test.ts +1018 -0
- package/plugins/acryl-router/src/core/middleware/bearer-auth/index.ts +220 -0
- package/plugins/acryl-router/src/core/middleware/body-limit/index.test.ts +273 -0
- package/plugins/acryl-router/src/core/middleware/body-limit/index.ts +110 -0
- package/plugins/acryl-router/src/core/middleware/combine/index.test.ts +355 -0
- package/plugins/acryl-router/src/core/middleware/combine/index.ts +171 -0
- package/plugins/acryl-router/src/core/middleware/compress/index.test.ts +535 -0
- package/plugins/acryl-router/src/core/middleware/compress/index.ts +142 -0
- package/plugins/acryl-router/src/core/middleware/context-storage/index.test.ts +43 -0
- package/plugins/acryl-router/src/core/middleware/context-storage/index.ts +58 -0
- package/plugins/acryl-router/src/core/middleware/cors/index.test.ts +532 -0
- package/plugins/acryl-router/src/core/middleware/cors/index.ts +163 -0
- package/plugins/acryl-router/src/core/middleware/csrf/index.test.ts +534 -0
- package/plugins/acryl-router/src/core/middleware/csrf/index.ts +150 -0
- package/plugins/acryl-router/src/core/middleware/etag/digest.test.ts +21 -0
- package/plugins/acryl-router/src/core/middleware/etag/digest.ts +95 -0
- package/plugins/acryl-router/src/core/middleware/etag/index.test.ts +503 -0
- package/plugins/acryl-router/src/core/middleware/etag/index.ts +135 -0
- package/plugins/acryl-router/src/core/middleware/ip-restriction/index.test.ts +217 -0
- package/plugins/acryl-router/src/core/middleware/ip-restriction/index.ts +278 -0
- package/plugins/acryl-router/src/core/middleware/jwk/index.test.ts +1135 -0
- package/plugins/acryl-router/src/core/middleware/jwk/index.ts +1 -0
- package/plugins/acryl-router/src/core/middleware/jwk/jwk.ts +195 -0
- package/plugins/acryl-router/src/core/middleware/jwk/keys.test.json +48 -0
- package/plugins/acryl-router/src/core/middleware/jwt/index.test.ts +802 -0
- package/plugins/acryl-router/src/core/middleware/jwt/index.ts +9 -0
- package/plugins/acryl-router/src/core/middleware/jwt/jwt.ts +189 -0
- package/plugins/acryl-router/src/core/middleware/language/index.test.ts +552 -0
- package/plugins/acryl-router/src/core/middleware/language/index.ts +12 -0
- package/plugins/acryl-router/src/core/middleware/language/language.ts +314 -0
- package/plugins/acryl-router/src/core/middleware/logger/index.test.ts +204 -0
- package/plugins/acryl-router/src/core/middleware/logger/index.ts +95 -0
- package/plugins/acryl-router/src/core/middleware/method-not-allowed/index.test.ts +292 -0
- package/plugins/acryl-router/src/core/middleware/method-not-allowed/index.ts +141 -0
- package/plugins/acryl-router/src/core/middleware/method-override/index.test.ts +221 -0
- package/plugins/acryl-router/src/core/middleware/method-override/index.ts +147 -0
- package/plugins/acryl-router/src/core/middleware/powered-by/index.test.ts +37 -0
- package/plugins/acryl-router/src/core/middleware/powered-by/index.ts +35 -0
- package/plugins/acryl-router/src/core/middleware/pretty-json/index.test.ts +218 -0
- package/plugins/acryl-router/src/core/middleware/pretty-json/index.ts +67 -0
- package/plugins/acryl-router/src/core/middleware/request-id/index.test.ts +168 -0
- package/plugins/acryl-router/src/core/middleware/request-id/index.ts +7 -0
- package/plugins/acryl-router/src/core/middleware/request-id/request-id.ts +59 -0
- package/plugins/acryl-router/src/core/middleware/secure-headers/index.test.ts +671 -0
- package/plugins/acryl-router/src/core/middleware/secure-headers/index.ts +8 -0
- package/plugins/acryl-router/src/core/middleware/secure-headers/permissions-policy.ts +101 -0
- package/plugins/acryl-router/src/core/middleware/secure-headers/secure-headers.ts +340 -0
- package/plugins/acryl-router/src/core/middleware/serve-static/index.test.ts +450 -0
- package/plugins/acryl-router/src/core/middleware/serve-static/index.ts +135 -0
- package/plugins/acryl-router/src/core/middleware/serve-static/path.test.ts +50 -0
- package/plugins/acryl-router/src/core/middleware/serve-static/path.ts +25 -0
- package/plugins/acryl-router/src/core/middleware/timeout/index.test.ts +70 -0
- package/plugins/acryl-router/src/core/middleware/timeout/index.ts +58 -0
- package/plugins/acryl-router/src/core/middleware/timing/index.test.ts +310 -0
- package/plugins/acryl-router/src/core/middleware/timing/index.ts +8 -0
- package/plugins/acryl-router/src/core/middleware/timing/timing.ts +256 -0
- package/plugins/acryl-router/src/core/middleware/trailing-slash/index.test.ts +381 -0
- package/plugins/acryl-router/src/core/middleware/trailing-slash/index.ts +156 -0
- package/plugins/acryl-router/src/core/request/constants.ts +1 -0
- package/plugins/acryl-router/src/core/request.test.ts +751 -0
- package/plugins/acryl-router/src/core/request.ts +502 -0
- package/plugins/acryl-router/src/core/router/common.case.test.ts +1132 -0
- package/plugins/acryl-router/src/core/router/linear-router/index.ts +6 -0
- package/plugins/acryl-router/src/core/router/linear-router/router.test.ts +80 -0
- package/plugins/acryl-router/src/core/router/linear-router/router.ts +152 -0
- package/plugins/acryl-router/src/core/router/pattern-router/index.ts +6 -0
- package/plugins/acryl-router/src/core/router/pattern-router/router.test.ts +46 -0
- package/plugins/acryl-router/src/core/router/pattern-router/router.ts +54 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/index.ts +7 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/matcher.ts +33 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/node.ts +170 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/prepared-router.test.ts +154 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/prepared-router.ts +165 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/router.test.ts +265 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/router.ts +174 -0
- package/plugins/acryl-router/src/core/router/reg-exp-router/trie.ts +84 -0
- package/plugins/acryl-router/src/core/router/smart-router/index.ts +6 -0
- package/plugins/acryl-router/src/core/router/smart-router/router.test.ts +13 -0
- package/plugins/acryl-router/src/core/router/smart-router/router.ts +70 -0
- package/plugins/acryl-router/src/core/router/trie-router/index.ts +6 -0
- package/plugins/acryl-router/src/core/router/trie-router/node.test.ts +896 -0
- package/plugins/acryl-router/src/core/router/trie-router/node.ts +221 -0
- package/plugins/acryl-router/src/core/router/trie-router/router.test.ts +8 -0
- package/plugins/acryl-router/src/core/router/trie-router/router.ts +18 -0
- package/plugins/acryl-router/src/core/router/utils.ts +1 -0
- package/plugins/acryl-router/src/core/router.ts +103 -0
- package/plugins/acryl-router/src/core/types.test.ts +4134 -0
- package/plugins/acryl-router/src/core/types.ts +2782 -0
- package/plugins/acryl-router/src/core/utils/accept.test.ts +299 -0
- package/plugins/acryl-router/src/core/utils/accept.ts +268 -0
- package/plugins/acryl-router/src/core/utils/basic-auth.test.ts +56 -0
- package/plugins/acryl-router/src/core/utils/basic-auth.ts +26 -0
- package/plugins/acryl-router/src/core/utils/body.test.ts +496 -0
- package/plugins/acryl-router/src/core/utils/body.ts +263 -0
- package/plugins/acryl-router/src/core/utils/buffer.test.ts +147 -0
- package/plugins/acryl-router/src/core/utils/buffer.ts +117 -0
- package/plugins/acryl-router/src/core/utils/color.test.ts +23 -0
- package/plugins/acryl-router/src/core/utils/color.ts +56 -0
- package/plugins/acryl-router/src/core/utils/compress.ts +10 -0
- package/plugins/acryl-router/src/core/utils/concurrent.test.ts +69 -0
- package/plugins/acryl-router/src/core/utils/concurrent.ts +55 -0
- package/plugins/acryl-router/src/core/utils/constants.ts +4 -0
- package/plugins/acryl-router/src/core/utils/cookie.test.ts +460 -0
- package/plugins/acryl-router/src/core/utils/cookie.ts +281 -0
- package/plugins/acryl-router/src/core/utils/crypto.test.ts +43 -0
- package/plugins/acryl-router/src/core/utils/crypto.ts +58 -0
- package/plugins/acryl-router/src/core/utils/encode.test.ts +61 -0
- package/plugins/acryl-router/src/core/utils/encode.ts +34 -0
- package/plugins/acryl-router/src/core/utils/filepath.test.ts +78 -0
- package/plugins/acryl-router/src/core/utils/filepath.ts +60 -0
- package/plugins/acryl-router/src/core/utils/handler.ts +15 -0
- package/plugins/acryl-router/src/core/utils/headers.ts +355 -0
- package/plugins/acryl-router/src/core/utils/html.test.ts +16 -0
- package/plugins/acryl-router/src/core/utils/html.ts +182 -0
- package/plugins/acryl-router/src/core/utils/http-status.ts +72 -0
- package/plugins/acryl-router/src/core/utils/ipaddr.test.ts +149 -0
- package/plugins/acryl-router/src/core/utils/ipaddr.ts +374 -0
- package/plugins/acryl-router/src/core/utils/jwt/index.ts +7 -0
- package/plugins/acryl-router/src/core/utils/jwt/jwa.test.ts +86 -0
- package/plugins/acryl-router/src/core/utils/jwt/jwa.ts +38 -0
- package/plugins/acryl-router/src/core/utils/jwt/jws.ts +235 -0
- package/plugins/acryl-router/src/core/utils/jwt/jwt.test.ts +1788 -0
- package/plugins/acryl-router/src/core/utils/jwt/jwt.ts +292 -0
- package/plugins/acryl-router/src/core/utils/jwt/types.ts +157 -0
- package/plugins/acryl-router/src/core/utils/jwt/utf8.ts +7 -0
- package/plugins/acryl-router/src/core/utils/mime.test.ts +64 -0
- package/plugins/acryl-router/src/core/utils/mime.ts +94 -0
- package/plugins/acryl-router/src/core/utils/stream.test.ts +212 -0
- package/plugins/acryl-router/src/core/utils/stream.ts +107 -0
- package/plugins/acryl-router/src/core/utils/types.test.ts +295 -0
- package/plugins/acryl-router/src/core/utils/types.ts +123 -0
- package/plugins/acryl-router/src/core/utils/url.test.ts +384 -0
- package/plugins/acryl-router/src/core/utils/url.ts +337 -0
- package/plugins/acryl-router/src/core/validator/index.ts +8 -0
- package/plugins/acryl-router/src/core/validator/utils.test.ts +82 -0
- package/plugins/acryl-router/src/core/validator/utils.ts +69 -0
- package/plugins/acryl-router/src/core/validator/validator.test.ts +1488 -0
- package/plugins/acryl-router/src/core/validator/validator.ts +185 -0
- package/plugins/acryl-router/src/helpers/index.ts +13 -0
- package/plugins/acryl-router/src/helpers/schema-validator.ts +35 -0
- package/plugins/acryl-router/src/index.ts +6 -0
- package/plugins/acryl-router/src/middleware/index.ts +25 -0
- package/plugins/acryl-router/src/middleware/loopback-only.ts +88 -0
- package/plugins/acryl-router/src/service.ts +356 -0
- package/plugins/acryl-router/tests/docs-examples.spec.ts +152 -0
- package/plugins/acryl-router/tests/live-install.spec.ts +64 -0
- package/plugins/acryl-router/tests/loader.spec.ts +72 -0
- package/plugins/acryl-router/tests/service.spec.ts +409 -0
- package/plugins/acryl-router/tests/shadow-state.spec.ts +79 -0
- package/plugins/acryl-router/upstream.json +20 -0
- package/plugins/acryl-router-http/LICENSE +21 -0
- package/plugins/acryl-router-http/plugin.json +12 -0
- package/plugins/acryl-router-http/src/bridge.ts +54 -0
- package/plugins/acryl-router-http/src/index.ts +63 -0
- package/plugins/acryl-router-http/src/serve.ts +24 -0
- package/plugins/acryl-router-http/tests/adapter.spec.ts +174 -0
- package/plugins/acryl-router-http/tests/stream.spec.ts +133 -0
- package/plugins/acryl-router-http/tests/surfaces.spec.ts +101 -0
- package/plugins/acryl-router-http/upstream.json +22 -0
- package/plugins/acryl-state/LICENSE +21 -0
- package/plugins/acryl-state/NOTICE +30 -0
- package/plugins/acryl-state/plugin.json +12 -0
- package/plugins/acryl-state/src/cell.ts +67 -0
- package/plugins/acryl-state/src/index.ts +3 -0
- package/plugins/acryl-state/src/react.ts +11 -0
- package/plugins/acryl-state/src/service.ts +119 -0
- package/plugins/acryl-state/tests/cell.spec.ts +71 -0
- package/plugins/acryl-state/tests/react.spec.ts +39 -0
- package/plugins/acryl-state/tests/service.spec.ts +132 -0
- package/plugins/acryl-state/upstream.json +22 -0
- package/plugins/builder/script.ts +6 -10
- package/plugins/extensions/index.ts +20 -3
- package/plugins/extensions/resolve.ts +28 -3
- package/plugins/openai/prompt.ts +12 -6
- package/plugins/tasks/index.ts +14 -0
- package/plugins/tsconfig.json +14 -5
- package/templates/agent/blend.yaml +5 -7
- package/templates/agent/src/app.ts +8 -8
- package/templates/agent/src/routes.ts +39 -38
- package/templates/agent/template.json +3 -3
- package/templates/agent/test/builder.test.ts +22 -14
- package/templates/agent/test/model.test.ts +3 -3
- package/templates/agent/tsconfig.json +8 -5
- package/templates/{app → blank}/blend.yaml +3 -3
- package/templates/{app → blank}/src/app.ts +5 -5
- package/templates/blank/src/routes.ts +16 -0
- package/templates/blank/template.json +1 -0
- package/templates/{app → blank}/test/app.test.ts +1 -1
- package/templates/{app → blank}/tsconfig.json +2 -4
- package/templates/todo/README.md +27 -0
- package/templates/todo/blend.yaml +25 -0
- package/templates/todo/gitignore +2 -0
- package/templates/todo/package.json +23 -0
- package/templates/todo/src/app.ts +71 -0
- package/templates/todo/src/main.ts +19 -0
- package/templates/todo/src/page.ts +28 -0
- package/templates/todo/src/todo.ts +123 -0
- package/templates/todo/template.json +1 -0
- package/templates/todo/test/todo.test.ts +145 -0
- package/templates/todo/tsconfig.json +17 -0
- package/templates/todo/upstream.json +12 -0
- package/plugins/events/index.ts +0 -42
- package/plugins/events/plugin.json +0 -9
- package/plugins/http/index.ts +0 -64
- package/plugins/http/plugin.json +0 -10
- package/plugins/server/index.ts +0 -138
- package/plugins/server/plugin.json +0 -10
- package/templates/app/src/routes.ts +0 -14
- package/templates/app/template.json +0 -1
- /package/templates/{app → blank}/README.md +0 -0
- /package/templates/{app → blank}/gitignore +0 -0
- /package/templates/{app → blank}/package.json +0 -0
- /package/templates/{app → blank}/src/main.ts +0 -0
|
@@ -0,0 +1,535 @@
|
|
|
1
|
+
import { compress } from './index.ts'
|
|
2
|
+
import { stream, streamSSE } from '../../helper/streaming/index.ts'
|
|
3
|
+
import { App } from '../../app.ts'
|
|
4
|
+
|
|
5
|
+
describe('Compress Middleware', () => {
|
|
6
|
+
const app = new App()
|
|
7
|
+
|
|
8
|
+
// Apply compress middleware to all routes
|
|
9
|
+
app.use('*', compress())
|
|
10
|
+
|
|
11
|
+
// Test routes
|
|
12
|
+
app.get('/small', (c) => {
|
|
13
|
+
c.header('Content-Type', 'text/plain')
|
|
14
|
+
c.header('Content-Length', '5')
|
|
15
|
+
return c.text('small')
|
|
16
|
+
})
|
|
17
|
+
app.get('/large', (c) => {
|
|
18
|
+
c.header('Content-Type', 'text/plain')
|
|
19
|
+
c.header('Content-Length', '1024')
|
|
20
|
+
return c.text('a'.repeat(1024))
|
|
21
|
+
})
|
|
22
|
+
app.get('/small-json', (c) => {
|
|
23
|
+
c.header('Content-Type', 'application/json')
|
|
24
|
+
c.header('Content-Length', '26')
|
|
25
|
+
return c.json({ message: 'Hello, World!' })
|
|
26
|
+
})
|
|
27
|
+
app.get('/large-json', (c) => {
|
|
28
|
+
c.header('Content-Type', 'application/json')
|
|
29
|
+
c.header('Content-Length', '1024')
|
|
30
|
+
return c.json({ data: 'a'.repeat(1024), message: 'Large JSON' })
|
|
31
|
+
})
|
|
32
|
+
app.get('/no-transform', (c) => {
|
|
33
|
+
c.header('Content-Type', 'text/plain')
|
|
34
|
+
c.header('Content-Length', '1024')
|
|
35
|
+
c.header('Cache-Control', 'no-transform')
|
|
36
|
+
return c.text('a'.repeat(1024))
|
|
37
|
+
})
|
|
38
|
+
app.get('/jpeg-image', (c) => {
|
|
39
|
+
c.header('Content-Type', 'image/jpeg')
|
|
40
|
+
c.header('Content-Length', '1024')
|
|
41
|
+
return c.body(new Uint8Array(1024)) // Simulated JPEG data
|
|
42
|
+
})
|
|
43
|
+
app.get('/already-compressed', (c) => {
|
|
44
|
+
c.header('Content-Type', 'application/octet-stream')
|
|
45
|
+
c.header('Content-Encoding', 'br')
|
|
46
|
+
c.header('Content-Length', '1024')
|
|
47
|
+
return c.body(new Uint8Array(1024)) // Simulated compressed data
|
|
48
|
+
})
|
|
49
|
+
app.get('/transfer-encoding-deflate', (c) => {
|
|
50
|
+
c.header('Content-Type', 'application/octet-stream')
|
|
51
|
+
c.header('Transfer-Encoding', 'deflate')
|
|
52
|
+
c.header('Content-Length', '1024')
|
|
53
|
+
return c.body(new Uint8Array(1024)) // Simulated deflate data
|
|
54
|
+
})
|
|
55
|
+
app.get('/chunked', (c) => {
|
|
56
|
+
c.header('Content-Type', 'application/octet-stream')
|
|
57
|
+
c.header('Transfer-Encoding', 'chunked')
|
|
58
|
+
c.header('Content-Length', '1024')
|
|
59
|
+
return c.body(new Uint8Array(1024)) // Simulated chunked data
|
|
60
|
+
})
|
|
61
|
+
app.get('/partial', (c) => {
|
|
62
|
+
c.header('Content-Type', 'text/plain')
|
|
63
|
+
c.header('Content-Length', '1024')
|
|
64
|
+
c.header('Content-Range', 'bytes 0-1023/2048')
|
|
65
|
+
return c.body('a'.repeat(1024), 206)
|
|
66
|
+
})
|
|
67
|
+
app.get('/stream', (c) =>
|
|
68
|
+
stream(c, async (stream) => {
|
|
69
|
+
c.header('Content-Type', 'text/plain')
|
|
70
|
+
// 60000 bytes
|
|
71
|
+
for (let i = 0; i < 10000; i++) {
|
|
72
|
+
await stream.write('chunk ')
|
|
73
|
+
}
|
|
74
|
+
})
|
|
75
|
+
)
|
|
76
|
+
app.get('/already-compressed-stream', (c) =>
|
|
77
|
+
stream(c, async (stream) => {
|
|
78
|
+
c.header('Content-Type', 'text/plain')
|
|
79
|
+
c.header('Content-Encoding', 'br')
|
|
80
|
+
// 60000 bytes
|
|
81
|
+
for (let i = 0; i < 10000; i++) {
|
|
82
|
+
await stream.write(new Uint8Array([0, 1, 2, 3, 4, 5])) // Simulated compressed data
|
|
83
|
+
}
|
|
84
|
+
})
|
|
85
|
+
)
|
|
86
|
+
app.get('/sse', (c) =>
|
|
87
|
+
streamSSE(c, async (stream) => {
|
|
88
|
+
for (let i = 0; i < 1000; i++) {
|
|
89
|
+
await stream.writeSSE({ data: 'chunk' })
|
|
90
|
+
}
|
|
91
|
+
})
|
|
92
|
+
)
|
|
93
|
+
app.notFound((c) => c.text('Custom NotFound', 404))
|
|
94
|
+
|
|
95
|
+
const testCompression = async (
|
|
96
|
+
path: string,
|
|
97
|
+
acceptEncoding: string,
|
|
98
|
+
expectedEncoding: string | null
|
|
99
|
+
) => {
|
|
100
|
+
const req = new Request(`http://localhost${path}`, {
|
|
101
|
+
method: 'GET',
|
|
102
|
+
headers: new Headers({ 'Accept-Encoding': acceptEncoding }),
|
|
103
|
+
})
|
|
104
|
+
const res = await app.request(req)
|
|
105
|
+
expect(res.headers.get('Content-Encoding')).toBe(expectedEncoding)
|
|
106
|
+
return res
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
describe('Compression Behavior', () => {
|
|
110
|
+
it('should compress large responses with gzip', async () => {
|
|
111
|
+
const res = await testCompression('/large', 'gzip', 'gzip')
|
|
112
|
+
expect(res.headers.get('Content-Length')).toBeNull()
|
|
113
|
+
expect((await res.arrayBuffer()).byteLength).toBeLessThan(1024)
|
|
114
|
+
})
|
|
115
|
+
|
|
116
|
+
it('should compress large responses with deflate', async () => {
|
|
117
|
+
const res = await testCompression('/large', 'deflate', 'deflate')
|
|
118
|
+
expect((await res.arrayBuffer()).byteLength).toBeLessThan(1024)
|
|
119
|
+
})
|
|
120
|
+
|
|
121
|
+
it('should prioritize gzip over deflate when both are accepted', async () => {
|
|
122
|
+
await testCompression('/large', 'gzip, deflate', 'gzip')
|
|
123
|
+
})
|
|
124
|
+
|
|
125
|
+
it('should not compress small responses', async () => {
|
|
126
|
+
const res = await testCompression('/small', 'gzip, deflate', null)
|
|
127
|
+
expect(res.headers.get('Content-Length')).toBe('5')
|
|
128
|
+
})
|
|
129
|
+
|
|
130
|
+
it('should not compress when no Accept-Encoding is provided', async () => {
|
|
131
|
+
await testCompression('/large', '', null)
|
|
132
|
+
})
|
|
133
|
+
|
|
134
|
+
it('should not compress images', async () => {
|
|
135
|
+
const res = await testCompression('/jpeg-image', 'gzip', null)
|
|
136
|
+
expect(res.headers.get('Content-Type')).toBe('image/jpeg')
|
|
137
|
+
expect(res.headers.get('Content-Length')).toBe('1024')
|
|
138
|
+
})
|
|
139
|
+
|
|
140
|
+
it('should not compress already compressed responses', async () => {
|
|
141
|
+
const res = await testCompression('/already-compressed', 'gzip', 'br')
|
|
142
|
+
expect(res.headers.get('Content-Length')).toBe('1024')
|
|
143
|
+
})
|
|
144
|
+
|
|
145
|
+
it('should remove Content-Length when compressing', async () => {
|
|
146
|
+
const res = await testCompression('/large', 'gzip', 'gzip')
|
|
147
|
+
expect(res.headers.get('Content-Length')).toBeNull()
|
|
148
|
+
})
|
|
149
|
+
|
|
150
|
+
it('should not remove Content-Length when not compressing', async () => {
|
|
151
|
+
const res = await testCompression('/jpeg-image', 'gzip', null)
|
|
152
|
+
expect(res.headers.get('Content-Length')).toBeDefined()
|
|
153
|
+
})
|
|
154
|
+
|
|
155
|
+
it('should not compress transfer-encoding: deflate', async () => {
|
|
156
|
+
const res = await testCompression('/transfer-encoding-deflate', 'gzip', null)
|
|
157
|
+
expect(res.headers.get('Content-Length')).toBe('1024')
|
|
158
|
+
expect(res.headers.get('Transfer-Encoding')).toBe('deflate')
|
|
159
|
+
})
|
|
160
|
+
|
|
161
|
+
it('should not compress transfer-encoding: chunked', async () => {
|
|
162
|
+
const res = await testCompression('/chunked', 'gzip', null)
|
|
163
|
+
expect(res.headers.get('Content-Length')).toBe('1024')
|
|
164
|
+
expect(res.headers.get('Transfer-Encoding')).toBe('chunked')
|
|
165
|
+
})
|
|
166
|
+
|
|
167
|
+
it('should not compress 206 Partial Content responses', async () => {
|
|
168
|
+
const res = await testCompression('/partial', 'gzip', null)
|
|
169
|
+
expect(res.status).toBe(206)
|
|
170
|
+
expect(res.headers.get('Content-Length')).toBe('1024')
|
|
171
|
+
expect(res.headers.get('Content-Range')).toBe('bytes 0-1023/2048')
|
|
172
|
+
expect(await res.text()).toBe('a'.repeat(1024))
|
|
173
|
+
})
|
|
174
|
+
})
|
|
175
|
+
|
|
176
|
+
describe('JSON Handling', () => {
|
|
177
|
+
it('should not compress small JSON responses', async () => {
|
|
178
|
+
const res = await testCompression('/small-json', 'gzip', null)
|
|
179
|
+
expect(res.headers.get('Content-Length')).toBe('26')
|
|
180
|
+
})
|
|
181
|
+
|
|
182
|
+
it('should compress large JSON responses', async () => {
|
|
183
|
+
const res = await testCompression('/large-json', 'gzip', 'gzip')
|
|
184
|
+
expect(res.headers.get('Content-Length')).toBeNull()
|
|
185
|
+
const decompressed = await decompressResponse(res)
|
|
186
|
+
const json = JSON.parse(decompressed)
|
|
187
|
+
expect(json.data.length).toBe(1024)
|
|
188
|
+
expect(json.message).toBe('Large JSON')
|
|
189
|
+
})
|
|
190
|
+
})
|
|
191
|
+
|
|
192
|
+
describe('Streaming Responses', () => {
|
|
193
|
+
it('should compress streaming responses written in multiple chunks', async () => {
|
|
194
|
+
const res = await testCompression('/stream', 'gzip', 'gzip')
|
|
195
|
+
const decompressed = await decompressResponse(res)
|
|
196
|
+
expect(decompressed.length).toBe(60000)
|
|
197
|
+
})
|
|
198
|
+
|
|
199
|
+
it('should not compress already compressed streaming responses', async () => {
|
|
200
|
+
const res = await testCompression('/already-compressed-stream', 'gzip', 'br')
|
|
201
|
+
expect((await res.arrayBuffer()).byteLength).toBe(60000)
|
|
202
|
+
})
|
|
203
|
+
|
|
204
|
+
it('should not compress server-sent events', async () => {
|
|
205
|
+
const res = await testCompression('/sse', 'gzip', null)
|
|
206
|
+
expect((await res.arrayBuffer()).byteLength).toBe(13000)
|
|
207
|
+
})
|
|
208
|
+
})
|
|
209
|
+
|
|
210
|
+
describe('ETag Handling', () => {
|
|
211
|
+
const app = new App()
|
|
212
|
+
app.use('*', compress())
|
|
213
|
+
app.get('/strong-etag', (c) => {
|
|
214
|
+
c.header('Content-Type', 'text/plain')
|
|
215
|
+
c.header('Content-Length', '1024')
|
|
216
|
+
c.header('ETag', '"strong-etag"')
|
|
217
|
+
return c.text('a'.repeat(1024))
|
|
218
|
+
})
|
|
219
|
+
app.get('/weak-etag', (c) => {
|
|
220
|
+
c.header('Content-Type', 'text/plain')
|
|
221
|
+
c.header('Content-Length', '1024')
|
|
222
|
+
c.header('ETag', 'W/"weak-etag"')
|
|
223
|
+
return c.text('a'.repeat(1024))
|
|
224
|
+
})
|
|
225
|
+
app.get('/no-etag', (c) => {
|
|
226
|
+
c.header('Content-Type', 'text/plain')
|
|
227
|
+
c.header('Content-Length', '1024')
|
|
228
|
+
return c.text('a'.repeat(1024))
|
|
229
|
+
})
|
|
230
|
+
|
|
231
|
+
it('should convert strong ETag to weak ETag when compressing', async () => {
|
|
232
|
+
const res = await app.request('/strong-etag', {
|
|
233
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
234
|
+
})
|
|
235
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
236
|
+
expect(res.headers.get('ETag')).toBe('W/"strong-etag"')
|
|
237
|
+
})
|
|
238
|
+
|
|
239
|
+
it('should keep strong ETag when not compressing', async () => {
|
|
240
|
+
const res = await app.request('/strong-etag')
|
|
241
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
242
|
+
expect(res.headers.get('ETag')).toBe('"strong-etag"')
|
|
243
|
+
})
|
|
244
|
+
|
|
245
|
+
it('should not modify weak ETag when compressing', async () => {
|
|
246
|
+
const res = await app.request('/weak-etag', {
|
|
247
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
248
|
+
})
|
|
249
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
250
|
+
expect(res.headers.get('ETag')).toBe('W/"weak-etag"')
|
|
251
|
+
})
|
|
252
|
+
|
|
253
|
+
it('should not add ETag when none exists', async () => {
|
|
254
|
+
const res = await app.request('/no-etag', {
|
|
255
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
256
|
+
})
|
|
257
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
258
|
+
expect(res.headers.get('ETag')).toBeNull()
|
|
259
|
+
})
|
|
260
|
+
})
|
|
261
|
+
|
|
262
|
+
describe('Vary Header', () => {
|
|
263
|
+
const app = new App()
|
|
264
|
+
app.use('*', compress())
|
|
265
|
+
app.get('/no-vary', (c) => {
|
|
266
|
+
c.header('Content-Type', 'text/plain')
|
|
267
|
+
c.header('Content-Length', '1024')
|
|
268
|
+
return c.text('a'.repeat(1024))
|
|
269
|
+
})
|
|
270
|
+
app.get('/existing-vary', (c) => {
|
|
271
|
+
c.header('Content-Type', 'text/plain')
|
|
272
|
+
c.header('Content-Length', '1024')
|
|
273
|
+
c.header('Vary', 'Cookie')
|
|
274
|
+
return c.text('a'.repeat(1024))
|
|
275
|
+
})
|
|
276
|
+
app.get('/already-accept-encoding', (c) => {
|
|
277
|
+
c.header('Content-Type', 'text/plain')
|
|
278
|
+
c.header('Content-Length', '1024')
|
|
279
|
+
c.header('Vary', 'Accept-Encoding')
|
|
280
|
+
return c.text('a'.repeat(1024))
|
|
281
|
+
})
|
|
282
|
+
app.get('/wildcard-vary', (c) => {
|
|
283
|
+
c.header('Content-Type', 'text/plain')
|
|
284
|
+
c.header('Content-Length', '1024')
|
|
285
|
+
c.header('Vary', '*')
|
|
286
|
+
return c.text('a'.repeat(1024))
|
|
287
|
+
})
|
|
288
|
+
app.get('/not-compressible', (c) => {
|
|
289
|
+
c.header('Content-Type', 'image/png')
|
|
290
|
+
c.header('Content-Length', '1024')
|
|
291
|
+
return c.body('a'.repeat(1024))
|
|
292
|
+
})
|
|
293
|
+
|
|
294
|
+
it('should set Vary: Accept-Encoding when compressing', async () => {
|
|
295
|
+
const res = await app.request('/no-vary', {
|
|
296
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
297
|
+
})
|
|
298
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
299
|
+
expect(res.headers.get('Vary')).toBe('Accept-Encoding')
|
|
300
|
+
})
|
|
301
|
+
|
|
302
|
+
it('should append Accept-Encoding to an existing Vary header', async () => {
|
|
303
|
+
const res = await app.request('/existing-vary', {
|
|
304
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
305
|
+
})
|
|
306
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
307
|
+
expect(res.headers.get('Vary')).toBe('Cookie, Accept-Encoding')
|
|
308
|
+
})
|
|
309
|
+
|
|
310
|
+
it('should not duplicate Accept-Encoding when Vary already lists it', async () => {
|
|
311
|
+
const res = await app.request('/already-accept-encoding', {
|
|
312
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
313
|
+
})
|
|
314
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
315
|
+
expect(res.headers.get('Vary')).toBe('Accept-Encoding')
|
|
316
|
+
})
|
|
317
|
+
|
|
318
|
+
it('should leave Vary: * unchanged', async () => {
|
|
319
|
+
const res = await app.request('/wildcard-vary', {
|
|
320
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
321
|
+
})
|
|
322
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
323
|
+
expect(res.headers.get('Vary')).toBe('*')
|
|
324
|
+
})
|
|
325
|
+
|
|
326
|
+
it('should set Vary on an identity response when Accept-Encoding is absent', async () => {
|
|
327
|
+
const res = await app.request('/no-vary')
|
|
328
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
329
|
+
expect(res.headers.get('Vary')).toBe('Accept-Encoding')
|
|
330
|
+
})
|
|
331
|
+
|
|
332
|
+
it('should set Vary on an identity response when no offered encoding is accepted', async () => {
|
|
333
|
+
const res = await app.request('/no-vary', {
|
|
334
|
+
headers: { 'Accept-Encoding': 'br' },
|
|
335
|
+
})
|
|
336
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
337
|
+
expect(res.headers.get('Vary')).toBe('Accept-Encoding')
|
|
338
|
+
})
|
|
339
|
+
|
|
340
|
+
it('should not add a Vary header when the response is not eligible for compression', async () => {
|
|
341
|
+
const res = await app.request('/not-compressible', {
|
|
342
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
343
|
+
})
|
|
344
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
345
|
+
expect(res.headers.get('Vary')).toBeNull()
|
|
346
|
+
})
|
|
347
|
+
})
|
|
348
|
+
|
|
349
|
+
describe('contentTypeFilter', () => {
|
|
350
|
+
describe('RegExp', () => {
|
|
351
|
+
const app = new App()
|
|
352
|
+
app.use('*', compress({ contentTypeFilter: /^application\/json/, threshold: 0 }))
|
|
353
|
+
app.get('/json', (c) => c.json({ data: 'a'.repeat(1024) }))
|
|
354
|
+
app.get('/text', (c) => c.text('a'.repeat(1024)))
|
|
355
|
+
|
|
356
|
+
it('should compress when Content-Type matches', async () => {
|
|
357
|
+
const res = await app.request('/json', {
|
|
358
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
359
|
+
})
|
|
360
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
361
|
+
})
|
|
362
|
+
|
|
363
|
+
it('should not compress when Content-Type does not match', async () => {
|
|
364
|
+
const res = await app.request('/text', {
|
|
365
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
366
|
+
})
|
|
367
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
368
|
+
})
|
|
369
|
+
})
|
|
370
|
+
|
|
371
|
+
describe('function', () => {
|
|
372
|
+
const app = new App()
|
|
373
|
+
app.use('*', compress({ contentTypeFilter: (type) => type.includes('json'), threshold: 0 }))
|
|
374
|
+
app.get('/json', (c) => c.json({ data: 'a'.repeat(1024) }))
|
|
375
|
+
app.get('/text', (c) => c.text('a'.repeat(1024)))
|
|
376
|
+
|
|
377
|
+
it('should compress when Content-Type matches', async () => {
|
|
378
|
+
const res = await app.request('/json', {
|
|
379
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
380
|
+
})
|
|
381
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
382
|
+
})
|
|
383
|
+
|
|
384
|
+
it('should not compress when Content-Type does not match', async () => {
|
|
385
|
+
const res = await app.request('/text', {
|
|
386
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
387
|
+
})
|
|
388
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
389
|
+
})
|
|
390
|
+
})
|
|
391
|
+
})
|
|
392
|
+
|
|
393
|
+
describe('Edge Cases', () => {
|
|
394
|
+
it('should not compress responses with Cache-Control: no-transform', async () => {
|
|
395
|
+
await testCompression('/no-transform', 'gzip', null)
|
|
396
|
+
})
|
|
397
|
+
|
|
398
|
+
it('should handle HEAD requests without compression', async () => {
|
|
399
|
+
const req = new Request('http://localhost/large', {
|
|
400
|
+
method: 'HEAD',
|
|
401
|
+
headers: new Headers({ 'Accept-Encoding': 'gzip' }),
|
|
402
|
+
})
|
|
403
|
+
const res = await app.request(req)
|
|
404
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
405
|
+
})
|
|
406
|
+
|
|
407
|
+
it('should compress custom 404 Not Found responses', async () => {
|
|
408
|
+
const res = await testCompression('/not-found', 'gzip', 'gzip')
|
|
409
|
+
expect(res.status).toBe(404)
|
|
410
|
+
const decompressed = await decompressResponse(res)
|
|
411
|
+
expect(decompressed).toBe('Custom NotFound')
|
|
412
|
+
})
|
|
413
|
+
})
|
|
414
|
+
|
|
415
|
+
describe('Encoding Option', () => {
|
|
416
|
+
const buildApp = (encoding: 'gzip' | 'deflate') => {
|
|
417
|
+
const app = new App()
|
|
418
|
+
app.use('*', compress({ encoding }))
|
|
419
|
+
app.get('/large', (c) => {
|
|
420
|
+
c.header('Content-Type', 'text/plain')
|
|
421
|
+
c.header('Content-Length', '1024')
|
|
422
|
+
return c.text('a'.repeat(1024))
|
|
423
|
+
})
|
|
424
|
+
return app
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
it('should compress when configured encoding is accepted by the client', async () => {
|
|
428
|
+
const app = buildApp('gzip')
|
|
429
|
+
const res = await app.request('/large', {
|
|
430
|
+
headers: { 'Accept-Encoding': 'gzip' },
|
|
431
|
+
})
|
|
432
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
433
|
+
})
|
|
434
|
+
|
|
435
|
+
it('should not compress when configured encoding is not in Accept-Encoding', async () => {
|
|
436
|
+
const app = buildApp('gzip')
|
|
437
|
+
const res = await app.request('/large', {
|
|
438
|
+
headers: { 'Accept-Encoding': 'deflate' },
|
|
439
|
+
})
|
|
440
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
441
|
+
})
|
|
442
|
+
|
|
443
|
+
it('should not compress when Accept-Encoding header is absent', async () => {
|
|
444
|
+
const app = buildApp('gzip')
|
|
445
|
+
const res = await app.request('/large')
|
|
446
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
447
|
+
})
|
|
448
|
+
})
|
|
449
|
+
|
|
450
|
+
describe('Accept-Encoding parsing', () => {
|
|
451
|
+
const buildAppDefault = () => {
|
|
452
|
+
const app = new App()
|
|
453
|
+
app.use('*', compress())
|
|
454
|
+
app.get('/large', (c) => {
|
|
455
|
+
c.header('Content-Type', 'text/plain')
|
|
456
|
+
c.header('Content-Length', '1024')
|
|
457
|
+
return c.text('a'.repeat(1024))
|
|
458
|
+
})
|
|
459
|
+
return app
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
const buildAppWithEncoding = (encoding: 'gzip' | 'deflate') => {
|
|
463
|
+
const app = new App()
|
|
464
|
+
app.use('*', compress({ encoding }))
|
|
465
|
+
app.get('/large', (c) => {
|
|
466
|
+
c.header('Content-Type', 'text/plain')
|
|
467
|
+
c.header('Content-Length', '1024')
|
|
468
|
+
return c.text('a'.repeat(1024))
|
|
469
|
+
})
|
|
470
|
+
return app
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
it('should not compress when configured encoding has q=0', async () => {
|
|
474
|
+
const app = buildAppWithEncoding('gzip')
|
|
475
|
+
const res = await app.request('/large', {
|
|
476
|
+
headers: { 'Accept-Encoding': 'gzip;q=0' },
|
|
477
|
+
})
|
|
478
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
479
|
+
})
|
|
480
|
+
|
|
481
|
+
it('should fall back to another encoding when the preferred one has q=0', async () => {
|
|
482
|
+
const app = buildAppDefault()
|
|
483
|
+
const res = await app.request('/large', {
|
|
484
|
+
headers: { 'Accept-Encoding': 'gzip;q=0, deflate' },
|
|
485
|
+
})
|
|
486
|
+
expect(res.headers.get('Content-Encoding')).toBe('deflate')
|
|
487
|
+
})
|
|
488
|
+
|
|
489
|
+
it('should compress when Accept-Encoding is the wildcard *', async () => {
|
|
490
|
+
const app = buildAppWithEncoding('gzip')
|
|
491
|
+
const res = await app.request('/large', {
|
|
492
|
+
headers: { 'Accept-Encoding': '*' },
|
|
493
|
+
})
|
|
494
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
495
|
+
})
|
|
496
|
+
|
|
497
|
+
it('should compress when Accept-Encoding token differs only in case', async () => {
|
|
498
|
+
const app = buildAppWithEncoding('gzip')
|
|
499
|
+
const res = await app.request('/large', {
|
|
500
|
+
headers: { 'Accept-Encoding': 'GZIP' },
|
|
501
|
+
})
|
|
502
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
503
|
+
})
|
|
504
|
+
|
|
505
|
+
it('should not treat x-gzip as gzip', async () => {
|
|
506
|
+
const app = buildAppWithEncoding('gzip')
|
|
507
|
+
const res = await app.request('/large', {
|
|
508
|
+
headers: { 'Accept-Encoding': 'x-gzip' },
|
|
509
|
+
})
|
|
510
|
+
expect(res.headers.get('Content-Encoding')).toBeNull()
|
|
511
|
+
})
|
|
512
|
+
|
|
513
|
+
it('should pick the encoding with the highest q value', async () => {
|
|
514
|
+
const app = buildAppDefault()
|
|
515
|
+
const res = await app.request('/large', {
|
|
516
|
+
headers: { 'Accept-Encoding': 'gzip;q=0.5, deflate;q=0.9' },
|
|
517
|
+
})
|
|
518
|
+
expect(res.headers.get('Content-Encoding')).toBe('deflate')
|
|
519
|
+
})
|
|
520
|
+
|
|
521
|
+
it('should prefer gzip over deflate when q values are equal', async () => {
|
|
522
|
+
const app = buildAppDefault()
|
|
523
|
+
const res = await app.request('/large', {
|
|
524
|
+
headers: { 'Accept-Encoding': 'gzip;q=0.5, deflate;q=0.5' },
|
|
525
|
+
})
|
|
526
|
+
expect(res.headers.get('Content-Encoding')).toBe('gzip')
|
|
527
|
+
})
|
|
528
|
+
})
|
|
529
|
+
})
|
|
530
|
+
|
|
531
|
+
async function decompressResponse(res: Response): Promise<string> {
|
|
532
|
+
const decompressedStream = res.body!.pipeThrough(new DecompressionStream('gzip'))
|
|
533
|
+
const decompressedResponse = new Response(decompressedStream)
|
|
534
|
+
return await decompressedResponse.text()
|
|
535
|
+
}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @module
|
|
3
|
+
* Compress Middleware for App.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import type { MiddlewareHandler } from '../../types.ts'
|
|
7
|
+
import { parseAccept } from '../../utils/accept.ts'
|
|
8
|
+
import { COMPRESSIBLE_CONTENT_TYPE_REGEX } from '../../utils/compress.ts'
|
|
9
|
+
|
|
10
|
+
export { COMPRESSIBLE_CONTENT_TYPE_REGEX }
|
|
11
|
+
|
|
12
|
+
const ENCODING_TYPES = ['gzip', 'deflate'] as const
|
|
13
|
+
type Encoding = (typeof ENCODING_TYPES)[number]
|
|
14
|
+
const cacheControlNoTransformRegExp = /(?:^|,)\s*?no-transform\s*?(?:,|$)/i
|
|
15
|
+
|
|
16
|
+
type ContentTypeFilter = RegExp | ((contentType: string) => boolean)
|
|
17
|
+
|
|
18
|
+
interface CompressionOptions {
|
|
19
|
+
encoding?: Encoding
|
|
20
|
+
threshold?: number
|
|
21
|
+
contentTypeFilter?: ContentTypeFilter
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const selectEncoding = (
|
|
25
|
+
header: string | undefined,
|
|
26
|
+
candidates: readonly Encoding[]
|
|
27
|
+
): Encoding | undefined => {
|
|
28
|
+
if (header === undefined) {
|
|
29
|
+
return undefined
|
|
30
|
+
}
|
|
31
|
+
const accepts = parseAccept(header)
|
|
32
|
+
const wildcardQ = accepts.find((a) => a.type === '*')?.q
|
|
33
|
+
let best: { encoding: Encoding; q: number } | undefined
|
|
34
|
+
for (const enc of candidates) {
|
|
35
|
+
const explicit = accepts.find((a) => a.type.toLowerCase() === enc)
|
|
36
|
+
const q = explicit ? explicit.q : (wildcardQ ?? 0)
|
|
37
|
+
if (q === 1) {
|
|
38
|
+
return enc
|
|
39
|
+
} else if (q > 0 && (!best || q > best.q)) {
|
|
40
|
+
best = { encoding: enc, q }
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
return best?.encoding
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
const varyAcceptEncodingRegExp = /(?:^|,)\s*accept-encoding\s*(?:,|$)/i
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Compress Middleware for App.
|
|
50
|
+
*
|
|
51
|
+
*
|
|
52
|
+
* @param {CompressionOptions} [options] - The options for the compress middleware.
|
|
53
|
+
* @param {'gzip' | 'deflate'} [options.encoding] - The compression scheme to allow for response compression. Either 'gzip' or 'deflate'. If not defined, both are allowed and will be used based on the Accept-Encoding header. 'gzip' is prioritized if this option is not provided and the client provides both in the Accept-Encoding header.
|
|
54
|
+
* @param {number} [options.threshold=1024] - The minimum size in bytes to compress. Defaults to 1024 bytes.
|
|
55
|
+
* @param {RegExp | Function} [options.contentTypeFilter=COMPRESSIBLE_CONTENT_TYPE_REGEX] - A RegExp or function to determine if the response Content-Type should be compressed.
|
|
56
|
+
* @returns {MiddlewareHandler} The middleware handler function.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const app = new App()
|
|
61
|
+
*
|
|
62
|
+
* app.use(compress())
|
|
63
|
+
*
|
|
64
|
+
* // Compress only JSON responses
|
|
65
|
+
* app.use(compress({ contentTypeFilter: /^application\/json/ }))
|
|
66
|
+
*
|
|
67
|
+
* // Compress based on custom Content-Type logic
|
|
68
|
+
* app.use(compress({ contentTypeFilter: (type) => COMPRESSIBLE_CONTENT_TYPE_REGEX.test(type) || type === "application/x-myformat" }))
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
export const compress = (options?: CompressionOptions): MiddlewareHandler => {
|
|
72
|
+
const threshold = options?.threshold ?? 1024
|
|
73
|
+
const candidates: readonly Encoding[] = options?.encoding ? [options.encoding] : ENCODING_TYPES
|
|
74
|
+
|
|
75
|
+
const contentTypeFilter = options?.contentTypeFilter ?? COMPRESSIBLE_CONTENT_TYPE_REGEX
|
|
76
|
+
const shouldCompress =
|
|
77
|
+
typeof contentTypeFilter === 'function'
|
|
78
|
+
? (res: Response) => {
|
|
79
|
+
const type = res.headers.get('Content-Type')
|
|
80
|
+
return type && contentTypeFilter(type)
|
|
81
|
+
}
|
|
82
|
+
: (res: Response) => {
|
|
83
|
+
const type = res.headers.get('Content-Type')
|
|
84
|
+
return type && contentTypeFilter.test(type)
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
return async function compress(ctx, next) {
|
|
88
|
+
await next()
|
|
89
|
+
|
|
90
|
+
const contentLength = ctx.res.headers.get('Content-Length')
|
|
91
|
+
|
|
92
|
+
// Check if response should be compressed
|
|
93
|
+
if (
|
|
94
|
+
ctx.res.status === 206 || // partial content, Content-Range refers to the uncompressed bytes
|
|
95
|
+
ctx.res.headers.has('Content-Encoding') || // already encoded
|
|
96
|
+
ctx.res.headers.has('Transfer-Encoding') || // already encoded or chunked
|
|
97
|
+
ctx.req.method === 'HEAD' || // HEAD request
|
|
98
|
+
(contentLength && Number(contentLength) < threshold) || // content-length below threshold
|
|
99
|
+
!shouldCompress(ctx.res) || // not compressible type
|
|
100
|
+
!shouldTransform(ctx.res) // cache-control: no-transform
|
|
101
|
+
) {
|
|
102
|
+
return
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// From here on the representation is selected from the request's Accept-Encoding,
|
|
106
|
+
// so caches must key on that header. This is done before the negotiation result is
|
|
107
|
+
// known, because an identity response served for a missing or unsupported
|
|
108
|
+
// Accept-Encoding is just as much a negotiated representation: RFC 9110 lists
|
|
109
|
+
// Accept-Encoding "or lack thereof" as a determining factor. Without this, a shared
|
|
110
|
+
// cache could reuse the identity response for a client that does accept gzip.
|
|
111
|
+
// https://www.rfc-editor.org/rfc/rfc9110#field.vary
|
|
112
|
+
const current = ctx.res.headers.get('Vary')
|
|
113
|
+
if (current !== '*' && !(current && varyAcceptEncodingRegExp.test(current))) {
|
|
114
|
+
ctx.header('Vary', current ? `${current}, Accept-Encoding` : 'Accept-Encoding')
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
const accepted = ctx.req.header('Accept-Encoding')
|
|
118
|
+
const encoding = selectEncoding(accepted, candidates)
|
|
119
|
+
if (!encoding || !ctx.res.body) {
|
|
120
|
+
return
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
// Compress the response
|
|
124
|
+
const stream = new CompressionStream(encoding)
|
|
125
|
+
ctx.res = new Response(ctx.res.body.pipeThrough(stream), ctx.res)
|
|
126
|
+
ctx.res.headers.delete('Content-Length')
|
|
127
|
+
ctx.res.headers.set('Content-Encoding', encoding)
|
|
128
|
+
|
|
129
|
+
// Convert strong ETag to weak ETag since compressed content is not byte-identical
|
|
130
|
+
const etag = ctx.res.headers.get('ETag')
|
|
131
|
+
if (etag && !etag.startsWith('W/')) {
|
|
132
|
+
ctx.res.headers.set('ETag', `W/${etag}`)
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
const shouldTransform = (res: Response) => {
|
|
138
|
+
const cacheControl = res.headers.get('Cache-Control')
|
|
139
|
+
// Don't compress for Cache-Control: no-transform
|
|
140
|
+
// https://tools.ietf.org/html/rfc7234#section-5.2.2.4
|
|
141
|
+
return !cacheControl || !cacheControlNoTransformRegExp.test(cacheControl)
|
|
142
|
+
}
|