mirror of
https://github.com/JonasunderscoreJones/aka-worker.git
synced 2025-10-23 09:59:19 +02:00
Initial commit (by create-cloudflare CLI)
This commit is contained in:
parent
8cb86120f1
commit
fff961078a
1777 changed files with 1011798 additions and 0 deletions
176
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/LICENSE_APACHE
generated
vendored
Normal file
176
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/LICENSE_APACHE
generated
vendored
Normal file
|
|
@ -0,0 +1,176 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
25
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/LICENSE_MIT
generated
vendored
Normal file
25
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/LICENSE_MIT
generated
vendored
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
Copyright (c) 2018 Ashley Williams <ashley666ashley@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any
|
||||
person obtaining a copy of this software and associated
|
||||
documentation files (the "Software"), to deal in the
|
||||
Software without restriction, including without
|
||||
limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software
|
||||
is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice
|
||||
shall be included in all copies or substantial portions
|
||||
of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
329
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/README.md
generated
vendored
Normal file
329
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/README.md
generated
vendored
Normal file
|
|
@ -0,0 +1,329 @@
|
|||
# @cloudflare/kv-asset-handler
|
||||
|
||||
[](https://www.npmjs.com/package/@cloudflare/kv-asset-handler)
|
||||
[](https://github.com/cloudflare/kv-asset-handler/actions/workflows/test.yml)
|
||||
[](https://github.com/cloudflare/kv-asset-handler/actions/workflows/lint.yml)
|
||||
|
||||
`kv-asset-handler` is an open-source library for managing the retrieval of static assets from [Workers KV](https://developers.cloudflare.com/workers/runtime-apis/kv) inside of a [Cloudflare Workers](https://workers.dev) function. `kv-asset-handler` is designed for use with [Workers Sites](https://developers.cloudflare.com/workers/platform/sites), a feature included in [Wrangler](https://github.com/cloudflare/wrangler), our command-line tool for deploying Workers projects.
|
||||
|
||||
`kv-asset-handler` runs as part of a Cloudflare Workers function, so it allows you to customize _how_ and _when_ your static assets are loaded, as well as customize how those assets behave before they're sent to the client.
|
||||
|
||||
Most users and sites will not need these customizations, and just want to serve their statically built applications. For that simple use-case, you can check out [Cloudflare Pages](https://pages.cloudflare.com), our batteries-included approach to deploying static sites on Cloudflare's edge network. Workers Sites was designed as a precursor to Cloudflare Pages, so check out Pages if you just want to deploy your static site without any special customizations!
|
||||
|
||||
For users who _do_ want to customize their assets, and want to build complex experiences on top of their static assets, `kv-asset-handler` (and the default [Workers Sites template](https://github.com/cloudflare/worker-sites-template), which is provided for use with Wrangler + Workers Sites) allows you to customize caching behavior, headers, and anything else about how your Workers function loads the static assets for your site stored in Workers KV.
|
||||
|
||||
The Cloudflare Workers Discord server is an active place where Workers users get help, share feedback, and collaborate on making our platform better. The `#workers-sites` channel in particular is a great place to chat about `kv-asset-handler`, and building cool experiences for your users using these tools! If you have questions, want to share what you're working on, or give feedback, [join us in Discord and say hello](https://discord.gg/cloudflaredev)!
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [`getAssetFromKV`](#-getassetfromkv)
|
||||
- [Example](#example)
|
||||
* [Return](#return)
|
||||
* [Optional Arguments](#optional-arguments)
|
||||
- [`mapRequestToAsset`](#-maprequesttoasset)
|
||||
- [Example](#example-1)
|
||||
- [`cacheControl`](#-cachecontrol)
|
||||
- [`browserTTL`](#browserttl)
|
||||
- [`edgeTTL`](#edgettl)
|
||||
- [`bypassCache`](#bypasscache)
|
||||
- [`ASSET_NAMESPACE` (required for ES Modules)](#asset_namespace-required-for-es-modules)
|
||||
- [`ASSET_MANIFEST` (required for ES Modules)](#asset_manifest-required-for-es-modules)
|
||||
|
||||
* [Helper functions](#helper-functions)
|
||||
- [`mapRequestToAsset`](#maprequesttoasset-1)
|
||||
- [`serveSinglePageApp`](#servesinglepageapp)
|
||||
* [Cache revalidation and etags](#cache-revalidation-and-etags)
|
||||
|
||||
## Installation
|
||||
|
||||
Add this package to your `package.json` by running this in the root of your
|
||||
project's directory:
|
||||
|
||||
```
|
||||
npm i @cloudflare/kv-asset-handler
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
This package was designed to work with [Worker Sites](https://workers.cloudflare.com/sites).
|
||||
|
||||
## `getAssetFromKV`
|
||||
|
||||
getAssetFromKV(Evt) => Promise<Response>
|
||||
|
||||
`getAssetFromKV` is an async function that takes an `Evt` object (containing a `Request` and a [`waitUntil`](https://developers.cloudflare.com/workers/runtime-apis/fetch-event#waituntil)) and returns a `Response` object if the request matches an asset in KV, otherwise it will throw a `KVError`.
|
||||
|
||||
#### Example
|
||||
|
||||
This example checks for the existence of a value in KV, and returns it if it's there, and returns a 404 if it is not. It also serves index.html from `/`.
|
||||
|
||||
### Return
|
||||
|
||||
`getAssetFromKV` returns a `Promise<Response>` with `Response` being the body of the asset requested.
|
||||
|
||||
Known errors to be thrown are:
|
||||
|
||||
- MethodNotAllowedError
|
||||
- NotFoundError
|
||||
- InternalError
|
||||
|
||||
#### ES Modules
|
||||
|
||||
```js
|
||||
import { getAssetFromKV, NotFoundError, MethodNotAllowedError } from '@cloudflare/kv-asset-handler'
|
||||
import manifestJSON from '__STATIC_CONTENT_MANIFEST'
|
||||
const assetManifest = JSON.parse(manifestJSON)
|
||||
|
||||
export default {
|
||||
async fetch(request, env, ctx) {
|
||||
if (request.url.includes('/docs')) {
|
||||
try {
|
||||
return await getAssetFromKV(
|
||||
{
|
||||
request,
|
||||
waitUntil(promise) {
|
||||
return ctx.waitUntil(promise)
|
||||
},
|
||||
},
|
||||
{
|
||||
ASSET_NAMESPACE: env.__STATIC_CONTENT,
|
||||
ASSET_MANIFEST: assetManifest,
|
||||
},
|
||||
)
|
||||
} catch (e) {
|
||||
if (e instanceof NotFoundError) {
|
||||
// ...
|
||||
} else if (e instanceof MethodNotAllowedError) {
|
||||
// ...
|
||||
} else {
|
||||
return new Response('An unexpected error occurred', { status: 500 })
|
||||
}
|
||||
}
|
||||
} else return fetch(request)
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
#### Service Worker
|
||||
|
||||
```js
|
||||
import { getAssetFromKV, NotFoundError, MethodNotAllowedError } from '@cloudflare/kv-asset-handler'
|
||||
|
||||
addEventListener('fetch', (event) => {
|
||||
event.respondWith(handleEvent(event))
|
||||
})
|
||||
|
||||
async function handleEvent(event) {
|
||||
if (event.request.url.includes('/docs')) {
|
||||
try {
|
||||
return await getAssetFromKV(event)
|
||||
} catch (e) {
|
||||
if (e instanceof NotFoundError) {
|
||||
// ...
|
||||
} else if (e instanceof MethodNotAllowedError) {
|
||||
// ...
|
||||
} else {
|
||||
return new Response('An unexpected error occurred', { status: 500 })
|
||||
}
|
||||
}
|
||||
} else return fetch(event.request)
|
||||
}
|
||||
```
|
||||
|
||||
### Optional Arguments
|
||||
|
||||
You can customize the behavior of `getAssetFromKV` by passing the following properties as an object into the second argument.
|
||||
|
||||
```
|
||||
getAssetFromKV(event, { mapRequestToAsset: ... })
|
||||
```
|
||||
|
||||
#### `mapRequestToAsset`
|
||||
|
||||
mapRequestToAsset(Request) => Request
|
||||
|
||||
Maps the incoming request to the value that will be looked up in Cloudflare's KV
|
||||
|
||||
By default, mapRequestToAsset is set to the exported function [`mapRequestToAsset`](#maprequesttoasset-1). This works for most static site generators, but you can customize this behavior by passing your own function as `mapRequestToAsset`. The function should take a `Request` object as its only argument, and return a new `Request` object with an updated path to be looked up in the asset manifest/KV.
|
||||
|
||||
For SPA mapping pass in the [`serveSinglePageApp`](#servesinglepageapp) function
|
||||
|
||||
#### Example
|
||||
|
||||
Strip `/docs` from any incoming request before looking up an asset in Cloudflare's KV.
|
||||
|
||||
```js
|
||||
import { getAssetFromKV, mapRequestToAsset } from '@cloudflare/kv-asset-handler'
|
||||
...
|
||||
const customKeyModifier = request => {
|
||||
let url = request.url
|
||||
//custom key mapping optional
|
||||
url = url.replace('/docs', '').replace(/^\/+/, '')
|
||||
return mapRequestToAsset(new Request(url, request))
|
||||
}
|
||||
let asset = await getAssetFromKV(event, { mapRequestToAsset: customKeyModifier })
|
||||
```
|
||||
|
||||
#### `cacheControl`
|
||||
|
||||
type: object
|
||||
|
||||
`cacheControl` allows you to configure options for both the Cloudflare Cache accessed by your Worker, and the browser cache headers sent along with your Workers' responses. The default values are as follows:
|
||||
|
||||
```javascript
|
||||
let cacheControl = {
|
||||
browserTTL: null, // do not set cache control ttl on responses
|
||||
edgeTTL: 2 * 60 * 60 * 24, // 2 days
|
||||
bypassCache: false, // do not bypass Cloudflare's cache
|
||||
}
|
||||
```
|
||||
|
||||
##### `browserTTL`
|
||||
|
||||
type: number | null
|
||||
nullable: true
|
||||
|
||||
Sets the `Cache-Control: max-age` header on the response returned from the Worker. By default set to `null` which will not add the header at all.
|
||||
|
||||
##### `edgeTTL`
|
||||
|
||||
type: number | null
|
||||
nullable: true
|
||||
|
||||
Sets the `Cache-Control: max-age` header on the response used as the edge cache key. By default set to 2 days (`2 * 60 * 60 * 24`). When null will not cache on the edge at all.
|
||||
|
||||
##### `bypassCache`
|
||||
|
||||
type: boolean
|
||||
|
||||
Determines whether to cache requests on Cloudflare's edge cache. By default set to `false` (recommended for production builds). Useful for development when you need to eliminate the cache's effect on testing.
|
||||
|
||||
#### `ASSET_NAMESPACE` (required for ES Modules)
|
||||
|
||||
type: KV Namespace Binding
|
||||
|
||||
The binding name to the KV Namespace populated with key/value entries of files for the Worker to serve. By default, Workers Sites uses a [binding to a Workers KV Namespace](https://developers.cloudflare.com/workers/reference/storage/api/#namespaces) named `__STATIC_CONTENT`.
|
||||
|
||||
It is further assumed that this namespace consists of static assets such as HTML, CSS, JavaScript, or image files, keyed off of a relative path that roughly matches the assumed URL pathname of the incoming request.
|
||||
|
||||
In ES Modules format, this argument is required, and can be gotten from `env`.
|
||||
|
||||
##### ES Module
|
||||
|
||||
```js
|
||||
return getAssetFromKV(
|
||||
{
|
||||
request,
|
||||
waitUntil(promise) {
|
||||
return ctx.waitUntil(promise)
|
||||
},
|
||||
},
|
||||
{
|
||||
ASSET_NAMESPACE: env.__STATIC_CONTENT,
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
##### Service Worker
|
||||
|
||||
```
|
||||
return getAssetFromKV(event, { ASSET_NAMESPACE: MY_NAMESPACE })
|
||||
```
|
||||
|
||||
#### `ASSET_MANIFEST` (required for ES Modules)
|
||||
|
||||
type: text blob (JSON formatted) or object
|
||||
|
||||
The mapping of requested file path to the key stored on Cloudflare.
|
||||
|
||||
Workers Sites with Wrangler bundles up a text blob that maps request paths to content-hashed keys that are generated by Wrangler as a cache-busting measure. If this option/binding is not present, the function will fallback to using the raw pathname to look up your asset in KV. If, for whatever reason, you have rolled your own implementation of this, you can include your own by passing a stringified JSON object where the keys are expected paths, and the values are the expected keys in your KV namespace.
|
||||
|
||||
In ES Modules format, this argument is required, and can be imported.
|
||||
|
||||
##### ES Module
|
||||
|
||||
```js
|
||||
import manifestJSON from '__STATIC_CONTENT_MANIFEST'
|
||||
let manifest = JSON.parse(manifestJSON)
|
||||
manifest['index.html'] = 'index.special.html'
|
||||
|
||||
return getAssetFromKV(
|
||||
{
|
||||
request,
|
||||
waitUntil(promise) {
|
||||
return ctx.waitUntil(promise)
|
||||
},
|
||||
},
|
||||
{
|
||||
ASSET_MANIFEST: manifest,
|
||||
// ...
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
##### Service Worker
|
||||
|
||||
```
|
||||
let assetManifest = { "index.html": "index.special.html" }
|
||||
return getAssetFromKV(event, { ASSET_MANIFEST: assetManifest })
|
||||
```
|
||||
|
||||
#### `defaultMimeType` (optional)
|
||||
|
||||
type: string
|
||||
|
||||
This is the mime type that will be used for files with unrecognized or missing extensions. The default value is `'text/plain'`.
|
||||
|
||||
If you are serving a static site and would like to use extensionless HTML files instead of index.html files, set this to `'text/html'`.
|
||||
|
||||
#### `defaultDocument` (optional)
|
||||
|
||||
type: string
|
||||
|
||||
This is the default document that will be concatenated for requests ends in `'/'` or without a valid mime type like `'/about'` or `'/about.me'`. The default value is `'index.html'`.
|
||||
|
||||
# Helper functions
|
||||
|
||||
## `mapRequestToAsset`
|
||||
|
||||
mapRequestToAsset(Request) => Request
|
||||
|
||||
The default function for mapping incoming requests to keys in Cloudflare's KV.
|
||||
|
||||
Takes any path that ends in `/` or evaluates to an HTML file and appends `index.html` or `/index.html` for lookup in your Workers KV namespace.
|
||||
|
||||
## `serveSinglePageApp`
|
||||
|
||||
serveSinglePageApp(Request) => Request
|
||||
|
||||
A custom handler for mapping requests to a single root: `index.html`. The most common use case is single-page applications - frameworks with in-app routing - such as React Router, VueJS, etc. It takes zero arguments.
|
||||
|
||||
```js
|
||||
import { getAssetFromKV, serveSinglePageApp } from '@cloudflare/kv-asset-handler'
|
||||
...
|
||||
let asset = await getAssetFromKV(event, { mapRequestToAsset: serveSinglePageApp })
|
||||
```
|
||||
|
||||
# Cache revalidation and etags
|
||||
|
||||
All responses served from cache (including those with `cf-cache-status: MISS`) include an `etag` response header that identifies the version of the resource. The `etag` value is identical to the path key used in the `ASSET_MANIFEST`. It is updated each time an asset changes and looks like this: `etag: <filename>.<hash of file contents>.<extension>` (ex. `etag: index.54321.html`).
|
||||
|
||||
Resources served with an `etag` allow browsers to use the `if-none-match` request header to make conditional requests for that resource in the future. This has two major benefits:
|
||||
|
||||
- When a request's `if-none-match` value matches the `etag` of the resource in Cloudflare cache, Cloudflare will send a `304 Not Modified` response without a body, saving bandwidth.
|
||||
- Changes to a file on the server are immediately reflected in the browser - even when the cache control directive `max-age` is unexpired.
|
||||
|
||||
#### Disable the `etag`
|
||||
|
||||
To turn `etags` **off**, you must bypass cache:
|
||||
|
||||
```js
|
||||
/* Turn etags off */
|
||||
let cacheControl = {
|
||||
bypassCache: true,
|
||||
}
|
||||
```
|
||||
|
||||
#### Syntax and comparison context
|
||||
|
||||
`kv-asset-handler` sets and evaluates etags as [strong validators](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests#Strong_validation). To preserve `etag` integrity, the format of the value deviates from the [RFC2616 recommendation to enclose the `etag` with quotation marks](https://tools.ietf.org/html/rfc2616#section-3.11). This is intentional. Cloudflare cache applies the `W/` prefix to all `etags` that use quoted-strings -- a process that converts the `etag` to a "weak validator" when served to a client.
|
||||
36
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/index.d.ts
generated
vendored
Normal file
36
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
import { Options, CacheControl, MethodNotAllowedError, NotFoundError, InternalError } from './types';
|
||||
declare global {
|
||||
var __STATIC_CONTENT: any, __STATIC_CONTENT_MANIFEST: string;
|
||||
}
|
||||
/**
|
||||
* maps the path of incoming request to the request pathKey to look up
|
||||
* in bucket and in cache
|
||||
* e.g. for a path '/' returns '/index.html' which serves
|
||||
* the content of bucket/index.html
|
||||
* @param {Request} request incoming request
|
||||
*/
|
||||
declare const mapRequestToAsset: (request: Request, options?: Partial<Options>) => Request;
|
||||
/**
|
||||
* maps the path of incoming request to /index.html if it evaluates to
|
||||
* any HTML file.
|
||||
* @param {Request} request incoming request
|
||||
*/
|
||||
declare function serveSinglePageApp(request: Request, options?: Partial<Options>): Request;
|
||||
/**
|
||||
* takes the path of the incoming request, gathers the appropriate content from KV, and returns
|
||||
* the response
|
||||
*
|
||||
* @param {FetchEvent} event the fetch event of the triggered request
|
||||
* @param {{mapRequestToAsset: (string: Request) => Request, cacheControl: {bypassCache:boolean, edgeTTL: number, browserTTL:number}, ASSET_NAMESPACE: any, ASSET_MANIFEST:any}} [options] configurable options
|
||||
* @param {CacheControl} [options.cacheControl] determine how to cache on Cloudflare and the browser
|
||||
* @param {typeof(options.mapRequestToAsset)} [options.mapRequestToAsset] maps the path of incoming request to the request pathKey to look up
|
||||
* @param {Object | string} [options.ASSET_NAMESPACE] the binding to the namespace that script references
|
||||
* @param {any} [options.ASSET_MANIFEST] the map of the key to cache and store in KV
|
||||
* */
|
||||
declare type Evt = {
|
||||
request: Request;
|
||||
waitUntil: (promise: Promise<any>) => void;
|
||||
};
|
||||
declare const getAssetFromKV: (event: Evt, options?: Partial<Options>) => Promise<Response>;
|
||||
export { getAssetFromKV, mapRequestToAsset, serveSinglePageApp };
|
||||
export { Options, CacheControl, MethodNotAllowedError, NotFoundError, InternalError };
|
||||
267
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/index.js
generated
vendored
Normal file
267
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,267 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.InternalError = exports.NotFoundError = exports.MethodNotAllowedError = exports.serveSinglePageApp = exports.mapRequestToAsset = exports.getAssetFromKV = void 0;
|
||||
const mime = require("mime");
|
||||
const types_1 = require("./types");
|
||||
Object.defineProperty(exports, "MethodNotAllowedError", { enumerable: true, get: function () { return types_1.MethodNotAllowedError; } });
|
||||
Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return types_1.NotFoundError; } });
|
||||
Object.defineProperty(exports, "InternalError", { enumerable: true, get: function () { return types_1.InternalError; } });
|
||||
const defaultCacheControl = {
|
||||
browserTTL: null,
|
||||
edgeTTL: 2 * 60 * 60 * 24,
|
||||
bypassCache: false, // do not bypass Cloudflare's cache
|
||||
};
|
||||
const parseStringAsObject = (maybeString) => typeof maybeString === 'string' ? JSON.parse(maybeString) : maybeString;
|
||||
const getAssetFromKVDefaultOptions = {
|
||||
ASSET_NAMESPACE: typeof __STATIC_CONTENT !== 'undefined' ? __STATIC_CONTENT : undefined,
|
||||
ASSET_MANIFEST: typeof __STATIC_CONTENT_MANIFEST !== 'undefined'
|
||||
? parseStringAsObject(__STATIC_CONTENT_MANIFEST)
|
||||
: {},
|
||||
cacheControl: defaultCacheControl,
|
||||
defaultMimeType: 'text/plain',
|
||||
defaultDocument: 'index.html',
|
||||
pathIsEncoded: false,
|
||||
};
|
||||
function assignOptions(options) {
|
||||
// Assign any missing options passed in to the default
|
||||
// options.mapRequestToAsset is handled manually later
|
||||
return Object.assign({}, getAssetFromKVDefaultOptions, options);
|
||||
}
|
||||
/**
|
||||
* maps the path of incoming request to the request pathKey to look up
|
||||
* in bucket and in cache
|
||||
* e.g. for a path '/' returns '/index.html' which serves
|
||||
* the content of bucket/index.html
|
||||
* @param {Request} request incoming request
|
||||
*/
|
||||
const mapRequestToAsset = (request, options) => {
|
||||
options = assignOptions(options);
|
||||
const parsedUrl = new URL(request.url);
|
||||
let pathname = parsedUrl.pathname;
|
||||
if (pathname.endsWith('/')) {
|
||||
// If path looks like a directory append options.defaultDocument
|
||||
// e.g. If path is /about/ -> /about/index.html
|
||||
pathname = pathname.concat(options.defaultDocument);
|
||||
}
|
||||
else if (!mime.getType(pathname)) {
|
||||
// If path doesn't look like valid content
|
||||
// e.g. /about.me -> /about.me/index.html
|
||||
pathname = pathname.concat('/' + options.defaultDocument);
|
||||
}
|
||||
parsedUrl.pathname = pathname;
|
||||
return new Request(parsedUrl.toString(), request);
|
||||
};
|
||||
exports.mapRequestToAsset = mapRequestToAsset;
|
||||
/**
|
||||
* maps the path of incoming request to /index.html if it evaluates to
|
||||
* any HTML file.
|
||||
* @param {Request} request incoming request
|
||||
*/
|
||||
function serveSinglePageApp(request, options) {
|
||||
options = assignOptions(options);
|
||||
// First apply the default handler, which already has logic to detect
|
||||
// paths that should map to HTML files.
|
||||
request = mapRequestToAsset(request, options);
|
||||
const parsedUrl = new URL(request.url);
|
||||
// Detect if the default handler decided to map to
|
||||
// a HTML file in some specific directory.
|
||||
if (parsedUrl.pathname.endsWith('.html')) {
|
||||
// If expected HTML file was missing, just return the root index.html (or options.defaultDocument)
|
||||
return new Request(`${parsedUrl.origin}/${options.defaultDocument}`, request);
|
||||
}
|
||||
else {
|
||||
// The default handler decided this is not an HTML page. It's probably
|
||||
// an image, CSS, or JS file. Leave it as-is.
|
||||
return request;
|
||||
}
|
||||
}
|
||||
exports.serveSinglePageApp = serveSinglePageApp;
|
||||
const getAssetFromKV = async (event, options) => {
|
||||
options = assignOptions(options);
|
||||
const request = event.request;
|
||||
const ASSET_NAMESPACE = options.ASSET_NAMESPACE;
|
||||
const ASSET_MANIFEST = parseStringAsObject(options.ASSET_MANIFEST);
|
||||
if (typeof ASSET_NAMESPACE === 'undefined') {
|
||||
throw new types_1.InternalError(`there is no KV namespace bound to the script`);
|
||||
}
|
||||
const rawPathKey = new URL(request.url).pathname.replace(/^\/+/, ''); // strip any preceding /'s
|
||||
let pathIsEncoded = options.pathIsEncoded;
|
||||
let requestKey;
|
||||
// if options.mapRequestToAsset is explicitly passed in, always use it and assume user has own intentions
|
||||
// otherwise handle request as normal, with default mapRequestToAsset below
|
||||
if (options.mapRequestToAsset) {
|
||||
requestKey = options.mapRequestToAsset(request);
|
||||
}
|
||||
else if (ASSET_MANIFEST[rawPathKey]) {
|
||||
requestKey = request;
|
||||
}
|
||||
else if (ASSET_MANIFEST[decodeURIComponent(rawPathKey)]) {
|
||||
pathIsEncoded = true;
|
||||
requestKey = request;
|
||||
}
|
||||
else {
|
||||
const mappedRequest = mapRequestToAsset(request);
|
||||
const mappedRawPathKey = new URL(mappedRequest.url).pathname.replace(/^\/+/, '');
|
||||
if (ASSET_MANIFEST[decodeURIComponent(mappedRawPathKey)]) {
|
||||
pathIsEncoded = true;
|
||||
requestKey = mappedRequest;
|
||||
}
|
||||
else {
|
||||
// use default mapRequestToAsset
|
||||
requestKey = mapRequestToAsset(request, options);
|
||||
}
|
||||
}
|
||||
const SUPPORTED_METHODS = ['GET', 'HEAD'];
|
||||
if (!SUPPORTED_METHODS.includes(requestKey.method)) {
|
||||
throw new types_1.MethodNotAllowedError(`${requestKey.method} is not a valid request method`);
|
||||
}
|
||||
const parsedUrl = new URL(requestKey.url);
|
||||
const pathname = pathIsEncoded ? decodeURIComponent(parsedUrl.pathname) : parsedUrl.pathname; // decode percentage encoded path only when necessary
|
||||
// pathKey is the file path to look up in the manifest
|
||||
let pathKey = pathname.replace(/^\/+/, ''); // remove prepended /
|
||||
// @ts-ignore
|
||||
const cache = caches.default;
|
||||
let mimeType = mime.getType(pathKey) || options.defaultMimeType;
|
||||
if (mimeType.startsWith('text') || mimeType === 'application/javascript') {
|
||||
mimeType += '; charset=utf-8';
|
||||
}
|
||||
let shouldEdgeCache = false; // false if storing in KV by raw file path i.e. no hash
|
||||
// check manifest for map from file path to hash
|
||||
if (typeof ASSET_MANIFEST !== 'undefined') {
|
||||
if (ASSET_MANIFEST[pathKey]) {
|
||||
pathKey = ASSET_MANIFEST[pathKey];
|
||||
// if path key is in asset manifest, we can assume it contains a content hash and can be cached
|
||||
shouldEdgeCache = true;
|
||||
}
|
||||
}
|
||||
// TODO this excludes search params from cache, investigate ideal behavior
|
||||
let cacheKey = new Request(`${parsedUrl.origin}/${pathKey}`, request);
|
||||
// if argument passed in for cacheControl is a function then
|
||||
// evaluate that function. otherwise return the Object passed in
|
||||
// or default Object
|
||||
const evalCacheOpts = (() => {
|
||||
switch (typeof options.cacheControl) {
|
||||
case 'function':
|
||||
return options.cacheControl(request);
|
||||
case 'object':
|
||||
return options.cacheControl;
|
||||
default:
|
||||
return defaultCacheControl;
|
||||
}
|
||||
})();
|
||||
// formats the etag depending on the response context. if the entityId
|
||||
// is invalid, returns an empty string (instead of null) to prevent the
|
||||
// the potentially disastrous scenario where the value of the Etag resp
|
||||
// header is "null". Could be modified in future to base64 encode etc
|
||||
const formatETag = (entityId = pathKey, validatorType = 'strong') => {
|
||||
if (!entityId) {
|
||||
return '';
|
||||
}
|
||||
switch (validatorType) {
|
||||
case 'weak':
|
||||
if (!entityId.startsWith('W/')) {
|
||||
return `W/${entityId}`;
|
||||
}
|
||||
return entityId;
|
||||
case 'strong':
|
||||
if (entityId.startsWith(`W/"`)) {
|
||||
entityId = entityId.replace('W/', '');
|
||||
}
|
||||
if (!entityId.endsWith(`"`)) {
|
||||
entityId = `"${entityId}"`;
|
||||
}
|
||||
return entityId;
|
||||
default:
|
||||
return '';
|
||||
}
|
||||
};
|
||||
options.cacheControl = Object.assign({}, defaultCacheControl, evalCacheOpts);
|
||||
// override shouldEdgeCache if options say to bypassCache
|
||||
if (options.cacheControl.bypassCache ||
|
||||
options.cacheControl.edgeTTL === null ||
|
||||
request.method == 'HEAD') {
|
||||
shouldEdgeCache = false;
|
||||
}
|
||||
// only set max-age if explicitly passed in a number as an arg
|
||||
const shouldSetBrowserCache = typeof options.cacheControl.browserTTL === 'number';
|
||||
let response = null;
|
||||
if (shouldEdgeCache) {
|
||||
response = await cache.match(cacheKey);
|
||||
}
|
||||
if (response) {
|
||||
if (response.status > 300 && response.status < 400) {
|
||||
if (response.body && 'cancel' in Object.getPrototypeOf(response.body)) {
|
||||
// Body exists and environment supports readable streams
|
||||
response.body.cancel();
|
||||
}
|
||||
else {
|
||||
// Environment doesnt support readable streams, or null repsonse body. Nothing to do
|
||||
}
|
||||
response = new Response(null, response);
|
||||
}
|
||||
else {
|
||||
// fixes #165
|
||||
let opts = {
|
||||
headers: new Headers(response.headers),
|
||||
status: 0,
|
||||
statusText: '',
|
||||
};
|
||||
opts.headers.set('cf-cache-status', 'HIT');
|
||||
if (response.status) {
|
||||
opts.status = response.status;
|
||||
opts.statusText = response.statusText;
|
||||
}
|
||||
else if (opts.headers.has('Content-Range')) {
|
||||
opts.status = 206;
|
||||
opts.statusText = 'Partial Content';
|
||||
}
|
||||
else {
|
||||
opts.status = 200;
|
||||
opts.statusText = 'OK';
|
||||
}
|
||||
response = new Response(response.body, opts);
|
||||
}
|
||||
}
|
||||
else {
|
||||
const body = await ASSET_NAMESPACE.get(pathKey, 'arrayBuffer');
|
||||
if (body === null) {
|
||||
throw new types_1.NotFoundError(`could not find ${pathKey} in your content namespace`);
|
||||
}
|
||||
response = new Response(body);
|
||||
if (shouldEdgeCache) {
|
||||
response.headers.set('Accept-Ranges', 'bytes');
|
||||
response.headers.set('Content-Length', body.length);
|
||||
// set etag before cache insertion
|
||||
if (!response.headers.has('etag')) {
|
||||
response.headers.set('etag', formatETag(pathKey, 'strong'));
|
||||
}
|
||||
// determine Cloudflare cache behavior
|
||||
response.headers.set('Cache-Control', `max-age=${options.cacheControl.edgeTTL}`);
|
||||
event.waitUntil(cache.put(cacheKey, response.clone()));
|
||||
response.headers.set('CF-Cache-Status', 'MISS');
|
||||
}
|
||||
}
|
||||
response.headers.set('Content-Type', mimeType);
|
||||
if (response.status === 304) {
|
||||
let etag = formatETag(response.headers.get('etag'), 'strong');
|
||||
let ifNoneMatch = cacheKey.headers.get('if-none-match');
|
||||
let proxyCacheStatus = response.headers.get('CF-Cache-Status');
|
||||
if (etag) {
|
||||
if (ifNoneMatch && ifNoneMatch === etag && proxyCacheStatus === 'MISS') {
|
||||
response.headers.set('CF-Cache-Status', 'EXPIRED');
|
||||
}
|
||||
else {
|
||||
response.headers.set('CF-Cache-Status', 'REVALIDATED');
|
||||
}
|
||||
response.headers.set('etag', formatETag(etag, 'weak'));
|
||||
}
|
||||
}
|
||||
if (shouldSetBrowserCache) {
|
||||
response.headers.set('Cache-Control', `max-age=${options.cacheControl.browserTTL}`);
|
||||
}
|
||||
else {
|
||||
response.headers.delete('Cache-Control');
|
||||
}
|
||||
return response;
|
||||
};
|
||||
exports.getAssetFromKV = getAssetFromKV;
|
||||
14
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/mocks.d.ts
generated
vendored
Normal file
14
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/mocks.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
export declare const getEvent: (request: Request) => any;
|
||||
export declare const mockKV: (store: any) => {
|
||||
get: (path: string) => any;
|
||||
};
|
||||
export declare const mockManifest: () => string;
|
||||
export declare const mockCaches: () => {
|
||||
default: {
|
||||
match(key: any): Promise<any>;
|
||||
put(key: any, val: Response): Promise<void>;
|
||||
};
|
||||
};
|
||||
export declare function mockRequestScope(): void;
|
||||
export declare function mockGlobalScope(): void;
|
||||
export declare const sleep: (milliseconds: number) => Promise<unknown>;
|
||||
146
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/mocks.js
generated
vendored
Normal file
146
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/mocks.js
generated
vendored
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.sleep = exports.mockGlobalScope = exports.mockRequestScope = exports.mockCaches = exports.mockManifest = exports.mockKV = exports.getEvent = void 0;
|
||||
const makeServiceWorkerEnv = require('service-worker-mock');
|
||||
const HASH = '123HASHBROWN';
|
||||
const getEvent = (request) => {
|
||||
const waitUntil = async (callback) => {
|
||||
await callback;
|
||||
};
|
||||
return {
|
||||
request,
|
||||
waitUntil,
|
||||
};
|
||||
};
|
||||
exports.getEvent = getEvent;
|
||||
const store = {
|
||||
'key1.123HASHBROWN.txt': 'val1',
|
||||
'key1.123HASHBROWN.png': 'val1',
|
||||
'index.123HASHBROWN.html': 'index.html',
|
||||
'cache.123HASHBROWN.html': 'cache me if you can',
|
||||
'测试.123HASHBROWN.html': 'My filename is non-ascii',
|
||||
'%not-really-percent-encoded.123HASHBROWN.html': 'browser percent encoded',
|
||||
'%2F.123HASHBROWN.html': 'user percent encoded',
|
||||
'你好.123HASHBROWN.html': 'I shouldnt be served',
|
||||
'%E4%BD%A0%E5%A5%BD.123HASHBROWN.html': 'Im important',
|
||||
'nohash.txt': 'no hash but still got some result',
|
||||
'sub/blah.123HASHBROWN.png': 'picturedis',
|
||||
'sub/index.123HASHBROWN.html': 'picturedis',
|
||||
'client.123HASHBROWN': 'important file',
|
||||
'client.123HASHBROWN/index.html': 'Im here but serve my big bro above',
|
||||
'image.123HASHBROWN.png': 'imagepng',
|
||||
'image.123HASHBROWN.webp': 'imagewebp',
|
||||
'你好/index.123HASHBROWN.html': 'My path is non-ascii',
|
||||
};
|
||||
const mockKV = (store) => {
|
||||
return {
|
||||
get: (path) => store[path] || null,
|
||||
};
|
||||
};
|
||||
exports.mockKV = mockKV;
|
||||
const mockManifest = () => {
|
||||
return JSON.stringify({
|
||||
'key1.txt': `key1.${HASH}.txt`,
|
||||
'key1.png': `key1.${HASH}.png`,
|
||||
'cache.html': `cache.${HASH}.html`,
|
||||
'测试.html': `测试.${HASH}.html`,
|
||||
'你好.html': `你好.${HASH}.html`,
|
||||
'%not-really-percent-encoded.html': `%not-really-percent-encoded.${HASH}.html`,
|
||||
'%2F.html': `%2F.${HASH}.html`,
|
||||
'%E4%BD%A0%E5%A5%BD.html': `%E4%BD%A0%E5%A5%BD.${HASH}.html`,
|
||||
'index.html': `index.${HASH}.html`,
|
||||
'sub/blah.png': `sub/blah.${HASH}.png`,
|
||||
'sub/index.html': `sub/index.${HASH}.html`,
|
||||
client: `client.${HASH}`,
|
||||
'client/index.html': `client.${HASH}`,
|
||||
'image.png': `image.${HASH}.png`,
|
||||
'image.webp': `image.${HASH}.webp`,
|
||||
'你好/index.html': `你好/index.${HASH}.html`,
|
||||
});
|
||||
};
|
||||
exports.mockManifest = mockManifest;
|
||||
let cacheStore = new Map();
|
||||
const mockCaches = () => {
|
||||
return {
|
||||
default: {
|
||||
async match(key) {
|
||||
let cacheKey = {
|
||||
url: key.url,
|
||||
headers: {},
|
||||
};
|
||||
let response;
|
||||
if (key.headers.has('if-none-match')) {
|
||||
let makeStrongEtag = key.headers.get('if-none-match').replace('W/', '');
|
||||
Reflect.set(cacheKey.headers, 'etag', makeStrongEtag);
|
||||
response = cacheStore.get(JSON.stringify(cacheKey));
|
||||
}
|
||||
else {
|
||||
// if client doesn't send if-none-match, we need to iterate through these keys
|
||||
// and just test the URL
|
||||
const activeCacheKeys = Array.from(cacheStore.keys());
|
||||
for (const cacheStoreKey of activeCacheKeys) {
|
||||
if (JSON.parse(cacheStoreKey).url === key.url) {
|
||||
response = cacheStore.get(cacheStoreKey);
|
||||
}
|
||||
}
|
||||
}
|
||||
// TODO: write test to accomodate for rare scenarios with where range requests accomodate etags
|
||||
if (response && !key.headers.has('if-none-match')) {
|
||||
// this appears overly verbose, but is necessary to document edge cache behavior
|
||||
// The Range request header triggers the response header Content-Range ...
|
||||
const range = key.headers.get('range');
|
||||
if (range) {
|
||||
response.headers.set('content-range', `bytes ${range.split('=').pop()}/${response.headers.get('content-length')}`);
|
||||
}
|
||||
// ... which we are using in this repository to set status 206
|
||||
if (response.headers.has('content-range')) {
|
||||
response.status = 206;
|
||||
}
|
||||
else {
|
||||
response.status = 200;
|
||||
}
|
||||
let etag = response.headers.get('etag');
|
||||
if (etag && !etag.includes('W/')) {
|
||||
response.headers.set('etag', `W/${etag}`);
|
||||
}
|
||||
}
|
||||
return response;
|
||||
},
|
||||
async put(key, val) {
|
||||
let headers = new Headers(val.headers);
|
||||
let url = new URL(key.url);
|
||||
let resWithBody = new Response(val.body, { headers, status: 200 });
|
||||
let resNoBody = new Response(null, { headers, status: 304 });
|
||||
let cacheKey = {
|
||||
url: key.url,
|
||||
headers: {
|
||||
etag: `"${url.pathname.replace('/', '')}"`,
|
||||
},
|
||||
};
|
||||
cacheStore.set(JSON.stringify(cacheKey), resNoBody);
|
||||
cacheKey.headers = {};
|
||||
cacheStore.set(JSON.stringify(cacheKey), resWithBody);
|
||||
return;
|
||||
},
|
||||
},
|
||||
};
|
||||
};
|
||||
exports.mockCaches = mockCaches;
|
||||
// mocks functionality used inside worker request
|
||||
function mockRequestScope() {
|
||||
Object.assign(global, makeServiceWorkerEnv());
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: (0, exports.mockManifest)() });
|
||||
Object.assign(global, { __STATIC_CONTENT: (0, exports.mockKV)(store) });
|
||||
Object.assign(global, { caches: (0, exports.mockCaches)() });
|
||||
}
|
||||
exports.mockRequestScope = mockRequestScope;
|
||||
// mocks functionality used on global isolate scope. such as the KV namespace bind
|
||||
function mockGlobalScope() {
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: (0, exports.mockManifest)() });
|
||||
Object.assign(global, { __STATIC_CONTENT: (0, exports.mockKV)(store) });
|
||||
}
|
||||
exports.mockGlobalScope = mockGlobalScope;
|
||||
const sleep = (milliseconds) => {
|
||||
return new Promise((resolve) => setTimeout(resolve, milliseconds));
|
||||
};
|
||||
exports.sleep = sleep;
|
||||
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV-optional.d.ts
generated
vendored
Normal file
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV-optional.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
export {};
|
||||
22
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV-optional.js
generated
vendored
Normal file
22
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV-optional.js
generated
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const ava_1 = require("ava");
|
||||
const mocks_1 = require("../mocks");
|
||||
(0, mocks_1.mockGlobalScope)();
|
||||
// manually reset manifest global, to test optional behaviour
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: undefined });
|
||||
const index_1 = require("../index");
|
||||
(0, ava_1.default)('getAssetFromKV return correct val from KV without manifest', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
// manually reset manifest global, to test optional behaviour
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: undefined });
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/key1.123HASHBROWN.txt'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'val1');
|
||||
t.true(res.headers.get('content-type').includes('text'));
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts
generated
vendored
Normal file
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
export {};
|
||||
446
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js
generated
vendored
Normal file
446
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js
generated
vendored
Normal file
|
|
@ -0,0 +1,446 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const ava_1 = require("ava");
|
||||
const mocks_1 = require("../mocks");
|
||||
(0, mocks_1.mockGlobalScope)();
|
||||
const index_1 = require("../index");
|
||||
(0, ava_1.default)('getAssetFromKV return correct val from KV and default caching', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/key1.txt'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(res.headers.get('cache-control'), null);
|
||||
t.is(res.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(await res.text(), 'val1');
|
||||
t.true(res.headers.get('content-type').includes('text'));
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV evaluated the file matching the extensionless path first /client/ -> client', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request(`https://foo.com/client/`));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
t.is(await res.text(), 'important file');
|
||||
t.true(res.headers.get('content-type').includes('text'));
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV evaluated the file matching the extensionless path first /client -> client', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request(`https://foo.com/client`));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
t.is(await res.text(), 'important file');
|
||||
t.true(res.headers.get('content-type').includes('text'));
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV if not in asset manifest still returns nohash.txt', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/nohash.txt'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'no hash but still got some result');
|
||||
t.true(res.headers.get('content-type').includes('text'));
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV if no asset manifest /client -> client fails', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request(`https://foo.com/client`));
|
||||
const error = await t.throwsAsync((0, index_1.getAssetFromKV)(event, { ASSET_MANIFEST: {} }));
|
||||
t.is(error.status, 404);
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV if sub/ -> sub/index.html served', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request(`https://foo.com/sub`));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'picturedis');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV gets index.html by default for / requests', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'index.html');
|
||||
t.true(res.headers.get('content-type').includes('html'));
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV non ASCII path support', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/测试.html'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'My filename is non-ascii');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV supports browser percent encoded URLs', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://example.com/%not-really-percent-encoded.html'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'browser percent encoded');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV supports user percent encoded URLs', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/%2F.html'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'user percent encoded');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV only decode URL when necessary', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event1 = (0, mocks_1.getEvent)(new Request('https://blah.com/%E4%BD%A0%E5%A5%BD.html'));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request('https://blah.com/你好.html'));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event1);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res1 && res2) {
|
||||
t.is(await res1.text(), 'Im important');
|
||||
t.is(await res2.text(), 'Im important');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV Support for user decode url path', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event1 = (0, mocks_1.getEvent)(new Request('https://blah.com/%E4%BD%A0%E5%A5%BD/'));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request('https://blah.com/你好/'));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event1);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res1 && res2) {
|
||||
t.is(await res1.text(), 'My path is non-ascii');
|
||||
t.is(await res2.text(), 'My path is non-ascii');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV custom key modifier', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/docs/sub/blah.png'));
|
||||
const customRequestMapper = (request) => {
|
||||
let defaultModifiedRequest = (0, index_1.mapRequestToAsset)(request);
|
||||
let url = new URL(defaultModifiedRequest.url);
|
||||
url.pathname = url.pathname.replace('/docs', '');
|
||||
return new Request(url.toString(), request);
|
||||
};
|
||||
const res = await (0, index_1.getAssetFromKV)(event, { mapRequestToAsset: customRequestMapper });
|
||||
if (res) {
|
||||
t.is(await res.text(), 'picturedis');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV request override with existing manifest file', async (t) => {
|
||||
// see https://github.com/cloudflare/kv-asset-handler/pull/159 for more info
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/image.png')); // real file in manifest
|
||||
const customRequestMapper = (request) => {
|
||||
let defaultModifiedRequest = (0, index_1.mapRequestToAsset)(request);
|
||||
let url = new URL(defaultModifiedRequest.url);
|
||||
url.pathname = '/image.webp'; // other different file in manifest
|
||||
return new Request(url.toString(), request);
|
||||
};
|
||||
const res = await (0, index_1.getAssetFromKV)(event, { mapRequestToAsset: customRequestMapper });
|
||||
if (res) {
|
||||
t.is(await res.text(), 'imagewebp');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when setting browser caching', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event, { cacheControl: { browserTTL: 22 } });
|
||||
if (res) {
|
||||
t.is(res.headers.get('cache-control'), 'max-age=22');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when setting custom cache setting', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event1 = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request('https://blah.com/key1.png?blah=34'));
|
||||
const cacheOnlyPngs = (req) => {
|
||||
if (new URL(req.url).pathname.endsWith('.png'))
|
||||
return {
|
||||
browserTTL: 720,
|
||||
edgeTTL: 720,
|
||||
};
|
||||
else
|
||||
return {
|
||||
bypassCache: true,
|
||||
};
|
||||
};
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event1, { cacheControl: cacheOnlyPngs });
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2, { cacheControl: cacheOnlyPngs });
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cache-control'), null);
|
||||
t.true(res2.headers.get('content-type').includes('png'));
|
||||
t.is(res2.headers.get('cache-control'), 'max-age=720');
|
||||
t.is(res2.headers.get('cf-cache-status'), 'MISS');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV caches on two sequential requests', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const resourceKey = 'cache.html';
|
||||
const resourceVersion = JSON.parse((0, mocks_1.mockManifest)())[resourceKey];
|
||||
const event1 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
}));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event1, { cacheControl: { edgeTTL: 720, browserTTL: 720 } });
|
||||
await (0, mocks_1.sleep)(1);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(res1.headers.get('cache-control'), 'max-age=720');
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV does not store max-age on two sequential requests', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const resourceKey = 'cache.html';
|
||||
const resourceVersion = JSON.parse((0, mocks_1.mockManifest)())[resourceKey];
|
||||
const event1 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
}));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event1, { cacheControl: { edgeTTL: 720 } });
|
||||
await (0, mocks_1.sleep)(100);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(res1.headers.get('cache-control'), null);
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED');
|
||||
t.is(res2.headers.get('cache-control'), null);
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV does not cache on Cloudflare when bypass cache set', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event, { cacheControl: { bypassCache: true } });
|
||||
if (res) {
|
||||
t.is(res.headers.get('cache-control'), null);
|
||||
t.is(res.headers.get('cf-cache-status'), null);
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV with no trailing slash on root', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'index.html');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV with no trailing slash on a subdirectory', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/sub/blah.png'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'picturedis');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV no result throws an error', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/random'));
|
||||
const error = await t.throwsAsync((0, index_1.getAssetFromKV)(event));
|
||||
t.is(error.status, 404);
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV TTls set to null should not cache on browser or edge', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event, { cacheControl: { browserTTL: null, edgeTTL: null } });
|
||||
await (0, mocks_1.sleep)(100);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event, { cacheControl: { browserTTL: null, edgeTTL: null } });
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), null);
|
||||
t.is(res1.headers.get('cache-control'), null);
|
||||
t.is(res2.headers.get('cf-cache-status'), null);
|
||||
t.is(res2.headers.get('cache-control'), null);
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV passing in a custom NAMESPACE serves correct asset', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let CUSTOM_NAMESPACE = (0, mocks_1.mockKV)({
|
||||
'key1.123HASHBROWN.txt': 'val1',
|
||||
});
|
||||
Object.assign(global, { CUSTOM_NAMESPACE });
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const res = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res) {
|
||||
t.is(await res.text(), 'index.html');
|
||||
t.true(res.headers.get('content-type').includes('html'));
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when custom namespace without the asset should fail', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let CUSTOM_NAMESPACE = (0, mocks_1.mockKV)({
|
||||
'key5.123HASHBROWN.txt': 'customvalu',
|
||||
});
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com'));
|
||||
const error = await t.throwsAsync((0, index_1.getAssetFromKV)(event, { ASSET_NAMESPACE: CUSTOM_NAMESPACE }));
|
||||
t.is(error.status, 404);
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when namespace not bound fails', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
var MY_CUSTOM_NAMESPACE = undefined;
|
||||
Object.assign(global, { MY_CUSTOM_NAMESPACE });
|
||||
const event = (0, mocks_1.getEvent)(new Request('https://blah.com/'));
|
||||
const error = await t.throwsAsync((0, index_1.getAssetFromKV)(event, { ASSET_NAMESPACE: MY_CUSTOM_NAMESPACE }));
|
||||
t.is(error.status, 500);
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when if-none-match === active resource version, should revalidate', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const resourceKey = 'key1.png';
|
||||
const resourceVersion = JSON.parse((0, mocks_1.mockManifest)())[resourceKey];
|
||||
const event1 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `W/"${resourceVersion}"`,
|
||||
},
|
||||
}));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event1, { cacheControl: { edgeTTL: 720 } });
|
||||
await (0, mocks_1.sleep)(100);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when if-none-match equals etag of stale resource then should bypass cache', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const resourceKey = 'key1.png';
|
||||
const resourceVersion = JSON.parse((0, mocks_1.mockManifest)())[resourceKey];
|
||||
const req1 = new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
});
|
||||
const req2 = new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}-another-version"`,
|
||||
},
|
||||
});
|
||||
const event = (0, mocks_1.getEvent)(req1);
|
||||
const event2 = (0, mocks_1.getEvent)(req2);
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event, { cacheControl: { edgeTTL: 720 } });
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event);
|
||||
const res3 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res1 && res2 && res3) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(res2.headers.get('etag'), `W/${req1.headers.get('if-none-match')}`);
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED');
|
||||
t.not(res3.headers.get('etag'), req2.headers.get('if-none-match'));
|
||||
t.is(res3.headers.get('cf-cache-status'), 'MISS');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV when resource in cache, etag should be weakened before returned to eyeball', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
const resourceKey = 'key1.png';
|
||||
const resourceVersion = JSON.parse((0, mocks_1.mockManifest)())[resourceKey];
|
||||
const req1 = new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
});
|
||||
const event = (0, mocks_1.getEvent)(req1);
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event, { cacheControl: { edgeTTL: 720 } });
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(res2.headers.get('etag'), `W/${req1.headers.get('if-none-match')}`);
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV if-none-match not sent but resource in cache, should return cache hit 200 OK', async (t) => {
|
||||
const resourceKey = 'cache.html';
|
||||
const event = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`));
|
||||
const res1 = await (0, index_1.getAssetFromKV)(event, { cacheControl: { edgeTTL: 720 } });
|
||||
await (0, mocks_1.sleep)(1);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event);
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS');
|
||||
t.is(res1.headers.get('cache-control'), null);
|
||||
t.is(res2.status, 200);
|
||||
t.is(res2.headers.get('cf-cache-status'), 'HIT');
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
(0, ava_1.default)('getAssetFromKV if range request submitted and resource in cache, request fulfilled', async (t) => {
|
||||
const resourceKey = 'cache.html';
|
||||
const event1 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`));
|
||||
const event2 = (0, mocks_1.getEvent)(new Request(`https://blah.com/${resourceKey}`, { headers: { range: 'bytes=0-10' } }));
|
||||
const res1 = (0, index_1.getAssetFromKV)(event1, { cacheControl: { edgeTTL: 720 } });
|
||||
await res1;
|
||||
await (0, mocks_1.sleep)(2);
|
||||
const res2 = await (0, index_1.getAssetFromKV)(event2);
|
||||
if (res2.headers.has('content-range')) {
|
||||
t.is(res2.status, 206);
|
||||
}
|
||||
else {
|
||||
t.fail('Response was undefined');
|
||||
}
|
||||
});
|
||||
ava_1.default.todo('getAssetFromKV when body not empty, should invoke .cancel()');
|
||||
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts
generated
vendored
Normal file
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
export {};
|
||||
34
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js
generated
vendored
Normal file
34
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js
generated
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const ava_1 = require("ava");
|
||||
const mocks_1 = require("../mocks");
|
||||
(0, mocks_1.mockGlobalScope)();
|
||||
const index_1 = require("../index");
|
||||
(0, ava_1.default)('mapRequestToAsset() correctly changes /about -> /about/index.html', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let path = '/about';
|
||||
let request = new Request(`https://foo.com${path}`);
|
||||
let newRequest = (0, index_1.mapRequestToAsset)(request);
|
||||
t.is(newRequest.url, request.url + '/index.html');
|
||||
});
|
||||
(0, ava_1.default)('mapRequestToAsset() correctly changes /about/ -> /about/index.html', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let path = '/about/';
|
||||
let request = new Request(`https://foo.com${path}`);
|
||||
let newRequest = (0, index_1.mapRequestToAsset)(request);
|
||||
t.is(newRequest.url, request.url + 'index.html');
|
||||
});
|
||||
(0, ava_1.default)('mapRequestToAsset() correctly changes /about.me/ -> /about.me/index.html', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let path = '/about.me/';
|
||||
let request = new Request(`https://foo.com${path}`);
|
||||
let newRequest = (0, index_1.mapRequestToAsset)(request);
|
||||
t.is(newRequest.url, request.url + 'index.html');
|
||||
});
|
||||
(0, ava_1.default)('mapRequestToAsset() correctly changes /about -> /about/default.html', async (t) => {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let path = '/about';
|
||||
let request = new Request(`https://foo.com${path}`);
|
||||
let newRequest = (0, index_1.mapRequestToAsset)(request, { defaultDocument: 'default.html' });
|
||||
t.is(newRequest.url, request.url + '/default.html');
|
||||
});
|
||||
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts
generated
vendored
Normal file
1
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
export {};
|
||||
34
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js
generated
vendored
Normal file
34
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js
generated
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const ava_1 = require("ava");
|
||||
const mocks_1 = require("../mocks");
|
||||
(0, mocks_1.mockGlobalScope)();
|
||||
const index_1 = require("../index");
|
||||
function testRequest(path) {
|
||||
(0, mocks_1.mockRequestScope)();
|
||||
let url = new URL('https://example.com');
|
||||
url.pathname = path;
|
||||
let request = new Request(url.toString());
|
||||
return request;
|
||||
}
|
||||
(0, ava_1.default)('serveSinglePageApp returns root asset path when request path ends in .html', async (t) => {
|
||||
let path = '/foo/thing.html';
|
||||
let request = testRequest(path);
|
||||
let expected_request = testRequest('/index.html');
|
||||
let actual_request = (0, index_1.serveSinglePageApp)(request);
|
||||
t.deepEqual(expected_request, actual_request);
|
||||
});
|
||||
(0, ava_1.default)('serveSinglePageApp returns root asset path when request path does not have extension', async (t) => {
|
||||
let path = '/foo/thing';
|
||||
let request = testRequest(path);
|
||||
let expected_request = testRequest('/index.html');
|
||||
let actual_request = (0, index_1.serveSinglePageApp)(request);
|
||||
t.deepEqual(expected_request, actual_request);
|
||||
});
|
||||
(0, ava_1.default)('serveSinglePageApp returns requested asset when request path has non-html extension', async (t) => {
|
||||
let path = '/foo/thing.js';
|
||||
let request = testRequest(path);
|
||||
let expected_request = request;
|
||||
let actual_request = (0, index_1.serveSinglePageApp)(request);
|
||||
t.deepEqual(expected_request, actual_request);
|
||||
});
|
||||
28
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/types.d.ts
generated
vendored
Normal file
28
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/types.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
export declare type CacheControl = {
|
||||
browserTTL: number;
|
||||
edgeTTL: number;
|
||||
bypassCache: boolean;
|
||||
};
|
||||
export declare type AssetManifestType = Record<string, string>;
|
||||
export declare type Options = {
|
||||
cacheControl: ((req: Request) => Partial<CacheControl>) | Partial<CacheControl>;
|
||||
ASSET_NAMESPACE: any;
|
||||
ASSET_MANIFEST: AssetManifestType | string;
|
||||
mapRequestToAsset?: (req: Request, options?: Partial<Options>) => Request;
|
||||
defaultMimeType: string;
|
||||
defaultDocument: string;
|
||||
pathIsEncoded: boolean;
|
||||
};
|
||||
export declare class KVError extends Error {
|
||||
constructor(message?: string, status?: number);
|
||||
status: number;
|
||||
}
|
||||
export declare class MethodNotAllowedError extends KVError {
|
||||
constructor(message?: string, status?: number);
|
||||
}
|
||||
export declare class NotFoundError extends KVError {
|
||||
constructor(message?: string, status?: number);
|
||||
}
|
||||
export declare class InternalError extends KVError {
|
||||
constructor(message?: string, status?: number);
|
||||
}
|
||||
31
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/types.js
generated
vendored
Normal file
31
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/dist/types.js
generated
vendored
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.InternalError = exports.NotFoundError = exports.MethodNotAllowedError = exports.KVError = void 0;
|
||||
class KVError extends Error {
|
||||
constructor(message, status = 500) {
|
||||
super(message);
|
||||
// see: typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html
|
||||
Object.setPrototypeOf(this, new.target.prototype); // restore prototype chain
|
||||
this.name = KVError.name; // stack traces display correctly now
|
||||
this.status = status;
|
||||
}
|
||||
}
|
||||
exports.KVError = KVError;
|
||||
class MethodNotAllowedError extends KVError {
|
||||
constructor(message = `Not a valid request method`, status = 405) {
|
||||
super(message, status);
|
||||
}
|
||||
}
|
||||
exports.MethodNotAllowedError = MethodNotAllowedError;
|
||||
class NotFoundError extends KVError {
|
||||
constructor(message = `Not Found`, status = 404) {
|
||||
super(message, status);
|
||||
}
|
||||
}
|
||||
exports.NotFoundError = NotFoundError;
|
||||
class InternalError extends KVError {
|
||||
constructor(message = `Internal Error in KV Asset Handler`, status = 500) {
|
||||
super(message, status);
|
||||
}
|
||||
}
|
||||
exports.InternalError = InternalError;
|
||||
52
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/package.json
generated
vendored
Normal file
52
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/package.json
generated
vendored
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
{
|
||||
"name": "@cloudflare/kv-asset-handler",
|
||||
"version": "0.2.0",
|
||||
"description": "Routes requests to KV assets",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"scripts": {
|
||||
"prepack": "npm run build",
|
||||
"build": "tsc -d",
|
||||
"format": "prettier --write \"**/*.{js,ts,json,md}\"",
|
||||
"pretest": "npm run build",
|
||||
"lint:code": "prettier --check \"**/*.{js,ts,json,md}\"",
|
||||
"lint:markdown": "markdownlint \"**/*.md\" --ignore node_modules",
|
||||
"test": "ava dist/test/*.js --verbose"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/cloudflare/kv-asset-handler.git"
|
||||
},
|
||||
"keywords": [
|
||||
"kv",
|
||||
"cloudflare",
|
||||
"workers",
|
||||
"wrangler",
|
||||
"assets"
|
||||
],
|
||||
"files": [
|
||||
"src",
|
||||
"dist",
|
||||
"LICENSE_APACHE",
|
||||
"LICENSE_MIT"
|
||||
],
|
||||
"author": "wrangler@cloudflare.com",
|
||||
"license": "MIT OR Apache-2.0",
|
||||
"bugs": {
|
||||
"url": "https://github.com/cloudflare/kv-asset-handler/issues"
|
||||
},
|
||||
"homepage": "https://github.com/cloudflare/kv-asset-handler#readme",
|
||||
"dependencies": {
|
||||
"mime": "^3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@ava/typescript": "^3.0.0",
|
||||
"@cloudflare/workers-types": "^3.0.0",
|
||||
"@types/mime": "^2.0.3",
|
||||
"@types/node": "^15.14.9",
|
||||
"ava": "^3.15.0",
|
||||
"prettier": "^2.4.1",
|
||||
"service-worker-mock": "^2.0.5",
|
||||
"typescript": "^4.4.4"
|
||||
}
|
||||
}
|
||||
312
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/index.ts
generated
vendored
Normal file
312
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/index.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,312 @@
|
|||
import * as mime from 'mime'
|
||||
import {
|
||||
Options,
|
||||
CacheControl,
|
||||
MethodNotAllowedError,
|
||||
NotFoundError,
|
||||
InternalError,
|
||||
AssetManifestType,
|
||||
} from './types'
|
||||
|
||||
declare global {
|
||||
var __STATIC_CONTENT: any, __STATIC_CONTENT_MANIFEST: string
|
||||
}
|
||||
|
||||
const defaultCacheControl: CacheControl = {
|
||||
browserTTL: null,
|
||||
edgeTTL: 2 * 60 * 60 * 24, // 2 days
|
||||
bypassCache: false, // do not bypass Cloudflare's cache
|
||||
}
|
||||
|
||||
const parseStringAsObject = <T>(maybeString: string | T): T =>
|
||||
typeof maybeString === 'string' ? (JSON.parse(maybeString) as T) : maybeString
|
||||
|
||||
const getAssetFromKVDefaultOptions: Partial<Options> = {
|
||||
ASSET_NAMESPACE: typeof __STATIC_CONTENT !== 'undefined' ? __STATIC_CONTENT : undefined,
|
||||
ASSET_MANIFEST:
|
||||
typeof __STATIC_CONTENT_MANIFEST !== 'undefined'
|
||||
? parseStringAsObject<AssetManifestType>(__STATIC_CONTENT_MANIFEST)
|
||||
: {},
|
||||
cacheControl: defaultCacheControl,
|
||||
defaultMimeType: 'text/plain',
|
||||
defaultDocument: 'index.html',
|
||||
pathIsEncoded: false,
|
||||
}
|
||||
|
||||
function assignOptions(options?: Partial<Options>): Options {
|
||||
// Assign any missing options passed in to the default
|
||||
// options.mapRequestToAsset is handled manually later
|
||||
return <Options>Object.assign({}, getAssetFromKVDefaultOptions, options)
|
||||
}
|
||||
|
||||
/**
|
||||
* maps the path of incoming request to the request pathKey to look up
|
||||
* in bucket and in cache
|
||||
* e.g. for a path '/' returns '/index.html' which serves
|
||||
* the content of bucket/index.html
|
||||
* @param {Request} request incoming request
|
||||
*/
|
||||
const mapRequestToAsset = (request: Request, options?: Partial<Options>) => {
|
||||
options = assignOptions(options)
|
||||
|
||||
const parsedUrl = new URL(request.url)
|
||||
let pathname = parsedUrl.pathname
|
||||
|
||||
if (pathname.endsWith('/')) {
|
||||
// If path looks like a directory append options.defaultDocument
|
||||
// e.g. If path is /about/ -> /about/index.html
|
||||
pathname = pathname.concat(options.defaultDocument)
|
||||
} else if (!mime.getType(pathname)) {
|
||||
// If path doesn't look like valid content
|
||||
// e.g. /about.me -> /about.me/index.html
|
||||
pathname = pathname.concat('/' + options.defaultDocument)
|
||||
}
|
||||
|
||||
parsedUrl.pathname = pathname
|
||||
return new Request(parsedUrl.toString(), request)
|
||||
}
|
||||
|
||||
/**
|
||||
* maps the path of incoming request to /index.html if it evaluates to
|
||||
* any HTML file.
|
||||
* @param {Request} request incoming request
|
||||
*/
|
||||
function serveSinglePageApp(request: Request, options?: Partial<Options>): Request {
|
||||
options = assignOptions(options)
|
||||
|
||||
// First apply the default handler, which already has logic to detect
|
||||
// paths that should map to HTML files.
|
||||
request = mapRequestToAsset(request, options)
|
||||
|
||||
const parsedUrl = new URL(request.url)
|
||||
|
||||
// Detect if the default handler decided to map to
|
||||
// a HTML file in some specific directory.
|
||||
if (parsedUrl.pathname.endsWith('.html')) {
|
||||
// If expected HTML file was missing, just return the root index.html (or options.defaultDocument)
|
||||
return new Request(`${parsedUrl.origin}/${options.defaultDocument}`, request)
|
||||
} else {
|
||||
// The default handler decided this is not an HTML page. It's probably
|
||||
// an image, CSS, or JS file. Leave it as-is.
|
||||
return request
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* takes the path of the incoming request, gathers the appropriate content from KV, and returns
|
||||
* the response
|
||||
*
|
||||
* @param {FetchEvent} event the fetch event of the triggered request
|
||||
* @param {{mapRequestToAsset: (string: Request) => Request, cacheControl: {bypassCache:boolean, edgeTTL: number, browserTTL:number}, ASSET_NAMESPACE: any, ASSET_MANIFEST:any}} [options] configurable options
|
||||
* @param {CacheControl} [options.cacheControl] determine how to cache on Cloudflare and the browser
|
||||
* @param {typeof(options.mapRequestToAsset)} [options.mapRequestToAsset] maps the path of incoming request to the request pathKey to look up
|
||||
* @param {Object | string} [options.ASSET_NAMESPACE] the binding to the namespace that script references
|
||||
* @param {any} [options.ASSET_MANIFEST] the map of the key to cache and store in KV
|
||||
* */
|
||||
|
||||
type Evt = {
|
||||
request: Request
|
||||
waitUntil: (promise: Promise<any>) => void
|
||||
}
|
||||
|
||||
const getAssetFromKV = async (event: Evt, options?: Partial<Options>): Promise<Response> => {
|
||||
options = assignOptions(options)
|
||||
|
||||
const request = event.request
|
||||
const ASSET_NAMESPACE = options.ASSET_NAMESPACE
|
||||
const ASSET_MANIFEST = parseStringAsObject<AssetManifestType>(options.ASSET_MANIFEST)
|
||||
|
||||
if (typeof ASSET_NAMESPACE === 'undefined') {
|
||||
throw new InternalError(`there is no KV namespace bound to the script`)
|
||||
}
|
||||
|
||||
const rawPathKey = new URL(request.url).pathname.replace(/^\/+/, '') // strip any preceding /'s
|
||||
let pathIsEncoded = options.pathIsEncoded
|
||||
let requestKey
|
||||
// if options.mapRequestToAsset is explicitly passed in, always use it and assume user has own intentions
|
||||
// otherwise handle request as normal, with default mapRequestToAsset below
|
||||
if (options.mapRequestToAsset) {
|
||||
requestKey = options.mapRequestToAsset(request)
|
||||
} else if (ASSET_MANIFEST[rawPathKey]) {
|
||||
requestKey = request
|
||||
} else if (ASSET_MANIFEST[decodeURIComponent(rawPathKey)]) {
|
||||
pathIsEncoded = true
|
||||
requestKey = request
|
||||
} else {
|
||||
const mappedRequest = mapRequestToAsset(request)
|
||||
const mappedRawPathKey = new URL(mappedRequest.url).pathname.replace(/^\/+/, '')
|
||||
if (ASSET_MANIFEST[decodeURIComponent(mappedRawPathKey)]) {
|
||||
pathIsEncoded = true
|
||||
requestKey = mappedRequest
|
||||
} else {
|
||||
// use default mapRequestToAsset
|
||||
requestKey = mapRequestToAsset(request, options)
|
||||
}
|
||||
}
|
||||
|
||||
const SUPPORTED_METHODS = ['GET', 'HEAD']
|
||||
if (!SUPPORTED_METHODS.includes(requestKey.method)) {
|
||||
throw new MethodNotAllowedError(`${requestKey.method} is not a valid request method`)
|
||||
}
|
||||
|
||||
const parsedUrl = new URL(requestKey.url)
|
||||
const pathname = pathIsEncoded ? decodeURIComponent(parsedUrl.pathname) : parsedUrl.pathname // decode percentage encoded path only when necessary
|
||||
|
||||
// pathKey is the file path to look up in the manifest
|
||||
let pathKey = pathname.replace(/^\/+/, '') // remove prepended /
|
||||
|
||||
// @ts-ignore
|
||||
const cache = caches.default
|
||||
let mimeType = mime.getType(pathKey) || options.defaultMimeType
|
||||
if (mimeType.startsWith('text') || mimeType === 'application/javascript') {
|
||||
mimeType += '; charset=utf-8'
|
||||
}
|
||||
|
||||
let shouldEdgeCache = false // false if storing in KV by raw file path i.e. no hash
|
||||
// check manifest for map from file path to hash
|
||||
if (typeof ASSET_MANIFEST !== 'undefined') {
|
||||
if (ASSET_MANIFEST[pathKey]) {
|
||||
pathKey = ASSET_MANIFEST[pathKey]
|
||||
// if path key is in asset manifest, we can assume it contains a content hash and can be cached
|
||||
shouldEdgeCache = true
|
||||
}
|
||||
}
|
||||
|
||||
// TODO this excludes search params from cache, investigate ideal behavior
|
||||
let cacheKey = new Request(`${parsedUrl.origin}/${pathKey}`, request)
|
||||
|
||||
// if argument passed in for cacheControl is a function then
|
||||
// evaluate that function. otherwise return the Object passed in
|
||||
// or default Object
|
||||
const evalCacheOpts = (() => {
|
||||
switch (typeof options.cacheControl) {
|
||||
case 'function':
|
||||
return options.cacheControl(request)
|
||||
case 'object':
|
||||
return options.cacheControl
|
||||
default:
|
||||
return defaultCacheControl
|
||||
}
|
||||
})()
|
||||
|
||||
// formats the etag depending on the response context. if the entityId
|
||||
// is invalid, returns an empty string (instead of null) to prevent the
|
||||
// the potentially disastrous scenario where the value of the Etag resp
|
||||
// header is "null". Could be modified in future to base64 encode etc
|
||||
const formatETag = (entityId: any = pathKey, validatorType: string = 'strong') => {
|
||||
if (!entityId) {
|
||||
return ''
|
||||
}
|
||||
switch (validatorType) {
|
||||
case 'weak':
|
||||
if (!entityId.startsWith('W/')) {
|
||||
return `W/${entityId}`
|
||||
}
|
||||
return entityId
|
||||
case 'strong':
|
||||
if (entityId.startsWith(`W/"`)) {
|
||||
entityId = entityId.replace('W/', '')
|
||||
}
|
||||
if (!entityId.endsWith(`"`)) {
|
||||
entityId = `"${entityId}"`
|
||||
}
|
||||
return entityId
|
||||
default:
|
||||
return ''
|
||||
}
|
||||
}
|
||||
|
||||
options.cacheControl = Object.assign({}, defaultCacheControl, evalCacheOpts)
|
||||
|
||||
// override shouldEdgeCache if options say to bypassCache
|
||||
if (
|
||||
options.cacheControl.bypassCache ||
|
||||
options.cacheControl.edgeTTL === null ||
|
||||
request.method == 'HEAD'
|
||||
) {
|
||||
shouldEdgeCache = false
|
||||
}
|
||||
// only set max-age if explicitly passed in a number as an arg
|
||||
const shouldSetBrowserCache = typeof options.cacheControl.browserTTL === 'number'
|
||||
|
||||
let response = null
|
||||
if (shouldEdgeCache) {
|
||||
response = await cache.match(cacheKey)
|
||||
}
|
||||
|
||||
if (response) {
|
||||
if (response.status > 300 && response.status < 400) {
|
||||
if (response.body && 'cancel' in Object.getPrototypeOf(response.body)) {
|
||||
// Body exists and environment supports readable streams
|
||||
response.body.cancel()
|
||||
} else {
|
||||
// Environment doesnt support readable streams, or null repsonse body. Nothing to do
|
||||
}
|
||||
response = new Response(null, response)
|
||||
} else {
|
||||
// fixes #165
|
||||
let opts = {
|
||||
headers: new Headers(response.headers),
|
||||
status: 0,
|
||||
statusText: '',
|
||||
}
|
||||
|
||||
opts.headers.set('cf-cache-status', 'HIT')
|
||||
|
||||
if (response.status) {
|
||||
opts.status = response.status
|
||||
opts.statusText = response.statusText
|
||||
} else if (opts.headers.has('Content-Range')) {
|
||||
opts.status = 206
|
||||
opts.statusText = 'Partial Content'
|
||||
} else {
|
||||
opts.status = 200
|
||||
opts.statusText = 'OK'
|
||||
}
|
||||
response = new Response(response.body, opts)
|
||||
}
|
||||
} else {
|
||||
const body = await ASSET_NAMESPACE.get(pathKey, 'arrayBuffer')
|
||||
if (body === null) {
|
||||
throw new NotFoundError(`could not find ${pathKey} in your content namespace`)
|
||||
}
|
||||
response = new Response(body)
|
||||
|
||||
if (shouldEdgeCache) {
|
||||
response.headers.set('Accept-Ranges', 'bytes')
|
||||
response.headers.set('Content-Length', body.length)
|
||||
// set etag before cache insertion
|
||||
if (!response.headers.has('etag')) {
|
||||
response.headers.set('etag', formatETag(pathKey, 'strong'))
|
||||
}
|
||||
// determine Cloudflare cache behavior
|
||||
response.headers.set('Cache-Control', `max-age=${options.cacheControl.edgeTTL}`)
|
||||
event.waitUntil(cache.put(cacheKey, response.clone()))
|
||||
response.headers.set('CF-Cache-Status', 'MISS')
|
||||
}
|
||||
}
|
||||
response.headers.set('Content-Type', mimeType)
|
||||
|
||||
if (response.status === 304) {
|
||||
let etag = formatETag(response.headers.get('etag'), 'strong')
|
||||
let ifNoneMatch = cacheKey.headers.get('if-none-match')
|
||||
let proxyCacheStatus = response.headers.get('CF-Cache-Status')
|
||||
if (etag) {
|
||||
if (ifNoneMatch && ifNoneMatch === etag && proxyCacheStatus === 'MISS') {
|
||||
response.headers.set('CF-Cache-Status', 'EXPIRED')
|
||||
} else {
|
||||
response.headers.set('CF-Cache-Status', 'REVALIDATED')
|
||||
}
|
||||
response.headers.set('etag', formatETag(etag, 'weak'))
|
||||
}
|
||||
}
|
||||
if (shouldSetBrowserCache) {
|
||||
response.headers.set('Cache-Control', `max-age=${options.cacheControl.browserTTL}`)
|
||||
} else {
|
||||
response.headers.delete('Cache-Control')
|
||||
}
|
||||
return response
|
||||
}
|
||||
|
||||
export { getAssetFromKV, mapRequestToAsset, serveSinglePageApp }
|
||||
export { Options, CacheControl, MethodNotAllowedError, NotFoundError, InternalError }
|
||||
148
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/mocks.ts
generated
vendored
Normal file
148
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/mocks.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
const makeServiceWorkerEnv = require('service-worker-mock')
|
||||
|
||||
const HASH = '123HASHBROWN'
|
||||
|
||||
export const getEvent = (request: Request): any => {
|
||||
const waitUntil = async (callback: any) => {
|
||||
await callback
|
||||
}
|
||||
return {
|
||||
request,
|
||||
waitUntil,
|
||||
}
|
||||
}
|
||||
const store: any = {
|
||||
'key1.123HASHBROWN.txt': 'val1',
|
||||
'key1.123HASHBROWN.png': 'val1',
|
||||
'index.123HASHBROWN.html': 'index.html',
|
||||
'cache.123HASHBROWN.html': 'cache me if you can',
|
||||
'测试.123HASHBROWN.html': 'My filename is non-ascii',
|
||||
'%not-really-percent-encoded.123HASHBROWN.html': 'browser percent encoded',
|
||||
'%2F.123HASHBROWN.html': 'user percent encoded',
|
||||
'你好.123HASHBROWN.html': 'I shouldnt be served',
|
||||
'%E4%BD%A0%E5%A5%BD.123HASHBROWN.html': 'Im important',
|
||||
'nohash.txt': 'no hash but still got some result',
|
||||
'sub/blah.123HASHBROWN.png': 'picturedis',
|
||||
'sub/index.123HASHBROWN.html': 'picturedis',
|
||||
'client.123HASHBROWN': 'important file',
|
||||
'client.123HASHBROWN/index.html': 'Im here but serve my big bro above',
|
||||
'image.123HASHBROWN.png': 'imagepng',
|
||||
'image.123HASHBROWN.webp': 'imagewebp',
|
||||
'你好/index.123HASHBROWN.html': 'My path is non-ascii',
|
||||
}
|
||||
export const mockKV = (store: any) => {
|
||||
return {
|
||||
get: (path: string) => store[path] || null,
|
||||
}
|
||||
}
|
||||
|
||||
export const mockManifest = () => {
|
||||
return JSON.stringify({
|
||||
'key1.txt': `key1.${HASH}.txt`,
|
||||
'key1.png': `key1.${HASH}.png`,
|
||||
'cache.html': `cache.${HASH}.html`,
|
||||
'测试.html': `测试.${HASH}.html`,
|
||||
'你好.html': `你好.${HASH}.html`,
|
||||
'%not-really-percent-encoded.html': `%not-really-percent-encoded.${HASH}.html`,
|
||||
'%2F.html': `%2F.${HASH}.html`,
|
||||
'%E4%BD%A0%E5%A5%BD.html': `%E4%BD%A0%E5%A5%BD.${HASH}.html`,
|
||||
'index.html': `index.${HASH}.html`,
|
||||
'sub/blah.png': `sub/blah.${HASH}.png`,
|
||||
'sub/index.html': `sub/index.${HASH}.html`,
|
||||
client: `client.${HASH}`,
|
||||
'client/index.html': `client.${HASH}`,
|
||||
'image.png': `image.${HASH}.png`,
|
||||
'image.webp': `image.${HASH}.webp`,
|
||||
'你好/index.html': `你好/index.${HASH}.html`,
|
||||
})
|
||||
}
|
||||
|
||||
let cacheStore: any = new Map()
|
||||
interface CacheKey {
|
||||
url: object
|
||||
headers: object
|
||||
}
|
||||
export const mockCaches = () => {
|
||||
return {
|
||||
default: {
|
||||
async match(key: any) {
|
||||
let cacheKey: CacheKey = {
|
||||
url: key.url,
|
||||
headers: {},
|
||||
}
|
||||
let response
|
||||
if (key.headers.has('if-none-match')) {
|
||||
let makeStrongEtag = key.headers.get('if-none-match').replace('W/', '')
|
||||
Reflect.set(cacheKey.headers, 'etag', makeStrongEtag)
|
||||
response = cacheStore.get(JSON.stringify(cacheKey))
|
||||
} else {
|
||||
// if client doesn't send if-none-match, we need to iterate through these keys
|
||||
// and just test the URL
|
||||
const activeCacheKeys: Array<string> = Array.from(cacheStore.keys())
|
||||
for (const cacheStoreKey of activeCacheKeys) {
|
||||
if (JSON.parse(cacheStoreKey).url === key.url) {
|
||||
response = cacheStore.get(cacheStoreKey)
|
||||
}
|
||||
}
|
||||
}
|
||||
// TODO: write test to accomodate for rare scenarios with where range requests accomodate etags
|
||||
if (response && !key.headers.has('if-none-match')) {
|
||||
// this appears overly verbose, but is necessary to document edge cache behavior
|
||||
// The Range request header triggers the response header Content-Range ...
|
||||
const range = key.headers.get('range')
|
||||
if (range) {
|
||||
response.headers.set(
|
||||
'content-range',
|
||||
`bytes ${range.split('=').pop()}/${response.headers.get('content-length')}`,
|
||||
)
|
||||
}
|
||||
// ... which we are using in this repository to set status 206
|
||||
if (response.headers.has('content-range')) {
|
||||
response.status = 206
|
||||
} else {
|
||||
response.status = 200
|
||||
}
|
||||
let etag = response.headers.get('etag')
|
||||
if (etag && !etag.includes('W/')) {
|
||||
response.headers.set('etag', `W/${etag}`)
|
||||
}
|
||||
}
|
||||
return response
|
||||
},
|
||||
async put(key: any, val: Response) {
|
||||
let headers = new Headers(val.headers)
|
||||
let url = new URL(key.url)
|
||||
let resWithBody = new Response(val.body, { headers, status: 200 })
|
||||
let resNoBody = new Response(null, { headers, status: 304 })
|
||||
let cacheKey: CacheKey = {
|
||||
url: key.url,
|
||||
headers: {
|
||||
etag: `"${url.pathname.replace('/', '')}"`,
|
||||
},
|
||||
}
|
||||
cacheStore.set(JSON.stringify(cacheKey), resNoBody)
|
||||
cacheKey.headers = {}
|
||||
cacheStore.set(JSON.stringify(cacheKey), resWithBody)
|
||||
return
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// mocks functionality used inside worker request
|
||||
export function mockRequestScope() {
|
||||
Object.assign(global, makeServiceWorkerEnv())
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: mockManifest() })
|
||||
Object.assign(global, { __STATIC_CONTENT: mockKV(store) })
|
||||
Object.assign(global, { caches: mockCaches() })
|
||||
}
|
||||
|
||||
// mocks functionality used on global isolate scope. such as the KV namespace bind
|
||||
export function mockGlobalScope() {
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: mockManifest() })
|
||||
Object.assign(global, { __STATIC_CONTENT: mockKV(store) })
|
||||
}
|
||||
|
||||
export const sleep = (milliseconds: number) => {
|
||||
return new Promise((resolve) => setTimeout(resolve, milliseconds))
|
||||
}
|
||||
24
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/getAssetFromKV-optional.ts
generated
vendored
Normal file
24
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/getAssetFromKV-optional.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
import test from 'ava'
|
||||
import { mockRequestScope, mockGlobalScope, getEvent, sleep, mockKV, mockManifest } from '../mocks'
|
||||
mockGlobalScope()
|
||||
|
||||
// manually reset manifest global, to test optional behaviour
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: undefined })
|
||||
|
||||
import { getAssetFromKV, mapRequestToAsset } from '../index'
|
||||
|
||||
test('getAssetFromKV return correct val from KV without manifest', async (t) => {
|
||||
mockRequestScope()
|
||||
// manually reset manifest global, to test optional behaviour
|
||||
Object.assign(global, { __STATIC_CONTENT_MANIFEST: undefined })
|
||||
|
||||
const event = getEvent(new Request('https://blah.com/key1.123HASHBROWN.txt'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'val1')
|
||||
t.true(res.headers.get('content-type').includes('text'))
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
488
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts
generated
vendored
Normal file
488
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,488 @@
|
|||
import test from 'ava'
|
||||
import { mockRequestScope, mockGlobalScope, getEvent, sleep, mockKV, mockManifest } from '../mocks'
|
||||
mockGlobalScope()
|
||||
|
||||
import { getAssetFromKV, mapRequestToAsset } from '../index'
|
||||
import { KVError } from '../types'
|
||||
|
||||
test('getAssetFromKV return correct val from KV and default caching', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/key1.txt'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(res.headers.get('cache-control'), null)
|
||||
t.is(res.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(await res.text(), 'val1')
|
||||
t.true(res.headers.get('content-type').includes('text'))
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
test('getAssetFromKV evaluated the file matching the extensionless path first /client/ -> client', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request(`https://foo.com/client/`))
|
||||
const res = await getAssetFromKV(event)
|
||||
t.is(await res.text(), 'important file')
|
||||
t.true(res.headers.get('content-type').includes('text'))
|
||||
})
|
||||
test('getAssetFromKV evaluated the file matching the extensionless path first /client -> client', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request(`https://foo.com/client`))
|
||||
const res = await getAssetFromKV(event)
|
||||
t.is(await res.text(), 'important file')
|
||||
t.true(res.headers.get('content-type').includes('text'))
|
||||
})
|
||||
|
||||
test('getAssetFromKV if not in asset manifest still returns nohash.txt', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/nohash.txt'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'no hash but still got some result')
|
||||
t.true(res.headers.get('content-type').includes('text'))
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV if no asset manifest /client -> client fails', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request(`https://foo.com/client`))
|
||||
const error: KVError = await t.throwsAsync(getAssetFromKV(event, { ASSET_MANIFEST: {} }))
|
||||
t.is(error.status, 404)
|
||||
})
|
||||
|
||||
test('getAssetFromKV if sub/ -> sub/index.html served', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request(`https://foo.com/sub`))
|
||||
const res = await getAssetFromKV(event)
|
||||
if (res) {
|
||||
t.is(await res.text(), 'picturedis')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV gets index.html by default for / requests', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'index.html')
|
||||
t.true(res.headers.get('content-type').includes('html'))
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV non ASCII path support', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/测试.html'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'My filename is non-ascii')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV supports browser percent encoded URLs', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://example.com/%not-really-percent-encoded.html'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'browser percent encoded')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV supports user percent encoded URLs', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/%2F.html'))
|
||||
const res = await getAssetFromKV(event)
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'user percent encoded')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV only decode URL when necessary', async (t) => {
|
||||
mockRequestScope()
|
||||
const event1 = getEvent(new Request('https://blah.com/%E4%BD%A0%E5%A5%BD.html'))
|
||||
const event2 = getEvent(new Request('https://blah.com/你好.html'))
|
||||
const res1 = await getAssetFromKV(event1)
|
||||
const res2 = await getAssetFromKV(event2)
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(await res1.text(), 'Im important')
|
||||
t.is(await res2.text(), 'Im important')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV Support for user decode url path', async (t) => {
|
||||
mockRequestScope()
|
||||
const event1 = getEvent(new Request('https://blah.com/%E4%BD%A0%E5%A5%BD/'))
|
||||
const event2 = getEvent(new Request('https://blah.com/你好/'))
|
||||
const res1 = await getAssetFromKV(event1)
|
||||
const res2 = await getAssetFromKV(event2)
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(await res1.text(), 'My path is non-ascii')
|
||||
t.is(await res2.text(), 'My path is non-ascii')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV custom key modifier', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/docs/sub/blah.png'))
|
||||
|
||||
const customRequestMapper = (request: Request) => {
|
||||
let defaultModifiedRequest = mapRequestToAsset(request)
|
||||
|
||||
let url = new URL(defaultModifiedRequest.url)
|
||||
url.pathname = url.pathname.replace('/docs', '')
|
||||
return new Request(url.toString(), request)
|
||||
}
|
||||
|
||||
const res = await getAssetFromKV(event, { mapRequestToAsset: customRequestMapper })
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'picturedis')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV request override with existing manifest file', async (t) => {
|
||||
// see https://github.com/cloudflare/kv-asset-handler/pull/159 for more info
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/image.png')) // real file in manifest
|
||||
|
||||
const customRequestMapper = (request: Request) => {
|
||||
let defaultModifiedRequest = mapRequestToAsset(request)
|
||||
|
||||
let url = new URL(defaultModifiedRequest.url)
|
||||
url.pathname = '/image.webp' // other different file in manifest
|
||||
return new Request(url.toString(), request)
|
||||
}
|
||||
|
||||
const res = await getAssetFromKV(event, { mapRequestToAsset: customRequestMapper })
|
||||
|
||||
if (res) {
|
||||
t.is(await res.text(), 'imagewebp')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV when setting browser caching', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/'))
|
||||
|
||||
const res = await getAssetFromKV(event, { cacheControl: { browserTTL: 22 } })
|
||||
|
||||
if (res) {
|
||||
t.is(res.headers.get('cache-control'), 'max-age=22')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV when setting custom cache setting', async (t) => {
|
||||
mockRequestScope()
|
||||
const event1 = getEvent(new Request('https://blah.com/'))
|
||||
const event2 = getEvent(new Request('https://blah.com/key1.png?blah=34'))
|
||||
const cacheOnlyPngs = (req: Request) => {
|
||||
if (new URL(req.url).pathname.endsWith('.png'))
|
||||
return {
|
||||
browserTTL: 720,
|
||||
edgeTTL: 720,
|
||||
}
|
||||
else
|
||||
return {
|
||||
bypassCache: true,
|
||||
}
|
||||
}
|
||||
|
||||
const res1 = await getAssetFromKV(event1, { cacheControl: cacheOnlyPngs })
|
||||
const res2 = await getAssetFromKV(event2, { cacheControl: cacheOnlyPngs })
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cache-control'), null)
|
||||
t.true(res2.headers.get('content-type').includes('png'))
|
||||
t.is(res2.headers.get('cache-control'), 'max-age=720')
|
||||
t.is(res2.headers.get('cf-cache-status'), 'MISS')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
test('getAssetFromKV caches on two sequential requests', async (t) => {
|
||||
mockRequestScope()
|
||||
const resourceKey = 'cache.html'
|
||||
const resourceVersion = JSON.parse(mockManifest())[resourceKey]
|
||||
const event1 = getEvent(new Request(`https://blah.com/${resourceKey}`))
|
||||
const event2 = getEvent(
|
||||
new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
}),
|
||||
)
|
||||
|
||||
const res1 = await getAssetFromKV(event1, { cacheControl: { edgeTTL: 720, browserTTL: 720 } })
|
||||
await sleep(1)
|
||||
const res2 = await getAssetFromKV(event2)
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(res1.headers.get('cache-control'), 'max-age=720')
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
test('getAssetFromKV does not store max-age on two sequential requests', async (t) => {
|
||||
mockRequestScope()
|
||||
const resourceKey = 'cache.html'
|
||||
const resourceVersion = JSON.parse(mockManifest())[resourceKey]
|
||||
const event1 = getEvent(new Request(`https://blah.com/${resourceKey}`))
|
||||
const event2 = getEvent(
|
||||
new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
}),
|
||||
)
|
||||
|
||||
const res1 = await getAssetFromKV(event1, { cacheControl: { edgeTTL: 720 } })
|
||||
await sleep(100)
|
||||
const res2 = await getAssetFromKV(event2)
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(res1.headers.get('cache-control'), null)
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED')
|
||||
t.is(res2.headers.get('cache-control'), null)
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV does not cache on Cloudflare when bypass cache set', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/'))
|
||||
|
||||
const res = await getAssetFromKV(event, { cacheControl: { bypassCache: true } })
|
||||
|
||||
if (res) {
|
||||
t.is(res.headers.get('cache-control'), null)
|
||||
t.is(res.headers.get('cf-cache-status'), null)
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV with no trailing slash on root', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com'))
|
||||
const res = await getAssetFromKV(event)
|
||||
if (res) {
|
||||
t.is(await res.text(), 'index.html')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV with no trailing slash on a subdirectory', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/sub/blah.png'))
|
||||
const res = await getAssetFromKV(event)
|
||||
if (res) {
|
||||
t.is(await res.text(), 'picturedis')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV no result throws an error', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/random'))
|
||||
const error: KVError = await t.throwsAsync(getAssetFromKV(event))
|
||||
t.is(error.status, 404)
|
||||
})
|
||||
test('getAssetFromKV TTls set to null should not cache on browser or edge', async (t) => {
|
||||
mockRequestScope()
|
||||
const event = getEvent(new Request('https://blah.com/'))
|
||||
|
||||
const res1 = await getAssetFromKV(event, { cacheControl: { browserTTL: null, edgeTTL: null } })
|
||||
await sleep(100)
|
||||
const res2 = await getAssetFromKV(event, { cacheControl: { browserTTL: null, edgeTTL: null } })
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), null)
|
||||
t.is(res1.headers.get('cache-control'), null)
|
||||
t.is(res2.headers.get('cf-cache-status'), null)
|
||||
t.is(res2.headers.get('cache-control'), null)
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
test('getAssetFromKV passing in a custom NAMESPACE serves correct asset', async (t) => {
|
||||
mockRequestScope()
|
||||
let CUSTOM_NAMESPACE = mockKV({
|
||||
'key1.123HASHBROWN.txt': 'val1',
|
||||
})
|
||||
Object.assign(global, { CUSTOM_NAMESPACE })
|
||||
const event = getEvent(new Request('https://blah.com/'))
|
||||
const res = await getAssetFromKV(event)
|
||||
if (res) {
|
||||
t.is(await res.text(), 'index.html')
|
||||
t.true(res.headers.get('content-type').includes('html'))
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
test('getAssetFromKV when custom namespace without the asset should fail', async (t) => {
|
||||
mockRequestScope()
|
||||
let CUSTOM_NAMESPACE = mockKV({
|
||||
'key5.123HASHBROWN.txt': 'customvalu',
|
||||
})
|
||||
|
||||
const event = getEvent(new Request('https://blah.com'))
|
||||
const error: KVError = await t.throwsAsync(
|
||||
getAssetFromKV(event, { ASSET_NAMESPACE: CUSTOM_NAMESPACE }),
|
||||
)
|
||||
t.is(error.status, 404)
|
||||
})
|
||||
test('getAssetFromKV when namespace not bound fails', async (t) => {
|
||||
mockRequestScope()
|
||||
var MY_CUSTOM_NAMESPACE = undefined
|
||||
Object.assign(global, { MY_CUSTOM_NAMESPACE })
|
||||
|
||||
const event = getEvent(new Request('https://blah.com/'))
|
||||
const error: KVError = await t.throwsAsync(
|
||||
getAssetFromKV(event, { ASSET_NAMESPACE: MY_CUSTOM_NAMESPACE }),
|
||||
)
|
||||
t.is(error.status, 500)
|
||||
})
|
||||
|
||||
test('getAssetFromKV when if-none-match === active resource version, should revalidate', async (t) => {
|
||||
mockRequestScope()
|
||||
const resourceKey = 'key1.png'
|
||||
const resourceVersion = JSON.parse(mockManifest())[resourceKey]
|
||||
const event1 = getEvent(new Request(`https://blah.com/${resourceKey}`))
|
||||
const event2 = getEvent(
|
||||
new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `W/"${resourceVersion}"`,
|
||||
},
|
||||
}),
|
||||
)
|
||||
|
||||
const res1 = await getAssetFromKV(event1, { cacheControl: { edgeTTL: 720 } })
|
||||
await sleep(100)
|
||||
const res2 = await getAssetFromKV(event2)
|
||||
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV when if-none-match equals etag of stale resource then should bypass cache', async (t) => {
|
||||
mockRequestScope()
|
||||
const resourceKey = 'key1.png'
|
||||
const resourceVersion = JSON.parse(mockManifest())[resourceKey]
|
||||
const req1 = new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
})
|
||||
const req2 = new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}-another-version"`,
|
||||
},
|
||||
})
|
||||
const event = getEvent(req1)
|
||||
const event2 = getEvent(req2)
|
||||
const res1 = await getAssetFromKV(event, { cacheControl: { edgeTTL: 720 } })
|
||||
const res2 = await getAssetFromKV(event)
|
||||
const res3 = await getAssetFromKV(event2)
|
||||
if (res1 && res2 && res3) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(res2.headers.get('etag'), `W/${req1.headers.get('if-none-match')}`)
|
||||
t.is(res2.headers.get('cf-cache-status'), 'REVALIDATED')
|
||||
t.not(res3.headers.get('etag'), req2.headers.get('if-none-match'))
|
||||
t.is(res3.headers.get('cf-cache-status'), 'MISS')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
test('getAssetFromKV when resource in cache, etag should be weakened before returned to eyeball', async (t) => {
|
||||
mockRequestScope()
|
||||
const resourceKey = 'key1.png'
|
||||
const resourceVersion = JSON.parse(mockManifest())[resourceKey]
|
||||
const req1 = new Request(`https://blah.com/${resourceKey}`, {
|
||||
headers: {
|
||||
'if-none-match': `"${resourceVersion}"`,
|
||||
},
|
||||
})
|
||||
const event = getEvent(req1)
|
||||
const res1 = await getAssetFromKV(event, { cacheControl: { edgeTTL: 720 } })
|
||||
const res2 = await getAssetFromKV(event)
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(res2.headers.get('etag'), `W/${req1.headers.get('if-none-match')}`)
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV if-none-match not sent but resource in cache, should return cache hit 200 OK', async (t) => {
|
||||
const resourceKey = 'cache.html'
|
||||
const event = getEvent(new Request(`https://blah.com/${resourceKey}`))
|
||||
const res1 = await getAssetFromKV(event, { cacheControl: { edgeTTL: 720 } })
|
||||
await sleep(1)
|
||||
const res2 = await getAssetFromKV(event)
|
||||
if (res1 && res2) {
|
||||
t.is(res1.headers.get('cf-cache-status'), 'MISS')
|
||||
t.is(res1.headers.get('cache-control'), null)
|
||||
t.is(res2.status, 200)
|
||||
t.is(res2.headers.get('cf-cache-status'), 'HIT')
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test('getAssetFromKV if range request submitted and resource in cache, request fulfilled', async (t) => {
|
||||
const resourceKey = 'cache.html'
|
||||
const event1 = getEvent(new Request(`https://blah.com/${resourceKey}`))
|
||||
const event2 = getEvent(
|
||||
new Request(`https://blah.com/${resourceKey}`, { headers: { range: 'bytes=0-10' } }),
|
||||
)
|
||||
const res1 = getAssetFromKV(event1, { cacheControl: { edgeTTL: 720 } })
|
||||
await res1
|
||||
await sleep(2)
|
||||
const res2 = await getAssetFromKV(event2)
|
||||
if (res2.headers.has('content-range')) {
|
||||
t.is(res2.status, 206)
|
||||
} else {
|
||||
t.fail('Response was undefined')
|
||||
}
|
||||
})
|
||||
|
||||
test.todo('getAssetFromKV when body not empty, should invoke .cancel()')
|
||||
37
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts
generated
vendored
Normal file
37
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
import test from 'ava'
|
||||
import { mockRequestScope, mockGlobalScope } from '../mocks'
|
||||
mockGlobalScope()
|
||||
|
||||
import { mapRequestToAsset } from '../index'
|
||||
|
||||
test('mapRequestToAsset() correctly changes /about -> /about/index.html', async (t) => {
|
||||
mockRequestScope()
|
||||
let path = '/about'
|
||||
let request = new Request(`https://foo.com${path}`)
|
||||
let newRequest = mapRequestToAsset(request)
|
||||
t.is(newRequest.url, request.url + '/index.html')
|
||||
})
|
||||
|
||||
test('mapRequestToAsset() correctly changes /about/ -> /about/index.html', async (t) => {
|
||||
mockRequestScope()
|
||||
let path = '/about/'
|
||||
let request = new Request(`https://foo.com${path}`)
|
||||
let newRequest = mapRequestToAsset(request)
|
||||
t.is(newRequest.url, request.url + 'index.html')
|
||||
})
|
||||
|
||||
test('mapRequestToAsset() correctly changes /about.me/ -> /about.me/index.html', async (t) => {
|
||||
mockRequestScope()
|
||||
let path = '/about.me/'
|
||||
let request = new Request(`https://foo.com${path}`)
|
||||
let newRequest = mapRequestToAsset(request)
|
||||
t.is(newRequest.url, request.url + 'index.html')
|
||||
})
|
||||
|
||||
test('mapRequestToAsset() correctly changes /about -> /about/default.html', async (t) => {
|
||||
mockRequestScope()
|
||||
let path = '/about'
|
||||
let request = new Request(`https://foo.com${path}`)
|
||||
let newRequest = mapRequestToAsset(request, { defaultDocument: 'default.html' })
|
||||
t.is(newRequest.url, request.url + '/default.html')
|
||||
})
|
||||
44
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts
generated
vendored
Normal file
44
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
import test from 'ava'
|
||||
import { mockRequestScope, mockGlobalScope } from '../mocks'
|
||||
mockGlobalScope()
|
||||
|
||||
import { serveSinglePageApp } from '../index'
|
||||
|
||||
function testRequest(path: string) {
|
||||
mockRequestScope()
|
||||
let url = new URL('https://example.com')
|
||||
url.pathname = path
|
||||
let request = new Request(url.toString())
|
||||
|
||||
return request
|
||||
}
|
||||
|
||||
test('serveSinglePageApp returns root asset path when request path ends in .html', async (t) => {
|
||||
let path = '/foo/thing.html'
|
||||
let request = testRequest(path)
|
||||
|
||||
let expected_request = testRequest('/index.html')
|
||||
let actual_request = serveSinglePageApp(request)
|
||||
|
||||
t.deepEqual(expected_request, actual_request)
|
||||
})
|
||||
|
||||
test('serveSinglePageApp returns root asset path when request path does not have extension', async (t) => {
|
||||
let path = '/foo/thing'
|
||||
let request = testRequest(path)
|
||||
|
||||
let expected_request = testRequest('/index.html')
|
||||
let actual_request = serveSinglePageApp(request)
|
||||
|
||||
t.deepEqual(expected_request, actual_request)
|
||||
})
|
||||
|
||||
test('serveSinglePageApp returns requested asset when request path has non-html extension', async (t) => {
|
||||
let path = '/foo/thing.js'
|
||||
let request = testRequest(path)
|
||||
|
||||
let expected_request = request
|
||||
let actual_request = serveSinglePageApp(request)
|
||||
|
||||
t.deepEqual(expected_request, actual_request)
|
||||
})
|
||||
43
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/types.ts
generated
vendored
Normal file
43
cool-dawn-3d3b/node_modules/@cloudflare/kv-asset-handler/src/types.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
export type CacheControl = {
|
||||
browserTTL: number
|
||||
edgeTTL: number
|
||||
bypassCache: boolean
|
||||
}
|
||||
|
||||
export type AssetManifestType = Record<string, string>
|
||||
|
||||
export type Options = {
|
||||
cacheControl: ((req: Request) => Partial<CacheControl>) | Partial<CacheControl>
|
||||
ASSET_NAMESPACE: any
|
||||
ASSET_MANIFEST: AssetManifestType | string
|
||||
mapRequestToAsset?: (req: Request, options?: Partial<Options>) => Request
|
||||
defaultMimeType: string
|
||||
defaultDocument: string
|
||||
pathIsEncoded: boolean
|
||||
}
|
||||
|
||||
export class KVError extends Error {
|
||||
constructor(message?: string, status: number = 500) {
|
||||
super(message)
|
||||
// see: typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html
|
||||
Object.setPrototypeOf(this, new.target.prototype) // restore prototype chain
|
||||
this.name = KVError.name // stack traces display correctly now
|
||||
this.status = status
|
||||
}
|
||||
status: number
|
||||
}
|
||||
export class MethodNotAllowedError extends KVError {
|
||||
constructor(message: string = `Not a valid request method`, status: number = 405) {
|
||||
super(message, status)
|
||||
}
|
||||
}
|
||||
export class NotFoundError extends KVError {
|
||||
constructor(message: string = `Not Found`, status: number = 404) {
|
||||
super(message, status)
|
||||
}
|
||||
}
|
||||
export class InternalError extends KVError {
|
||||
constructor(message: string = `Internal Error in KV Asset Handler`, status: number = 500) {
|
||||
super(message, status)
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue