Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Latest commit

 

History

History
529 lines (334 loc) · 25.1 KB

CHANGELOG.md

File metadata and controls

529 lines (334 loc) · 25.1 KB
Raw

Changelog

0.3.1

  • Maintenance

    • Remove tests from npm package to reduce npm package size - boidolr, pull/388

    This PR removes the tests from the npm package, reducing the size of the package by about half.

    These PRs bump dependencies of the project to their latest versions.

    This PR fixes the anchor links in the README.

0.3.0

  • Features

    • Allow configurable downgrade of ETag validator strength - [awwong1], [pull/315]

    This allows users to override the default strong ETag validator behaviour to use weak ETag validators. This change allows the developer to use weak ETags and preserve 304 responses (e.g. on *.workers.dev domains).

  • Fixes

    • Fix length property call on ArrayBuffer instance - [philipatkinson], [pull/295]

    Previously when edge cached was enabled, the content-length of the response was not being set correctly. This was due to the length property of the ArrayBuffer instance being called instead of the byteLength property. This PR fixes this issue.

  • Maintenance

    • chore(ci): bump node versions in actions - [KianNH], [pull/354]

      This bumps the Node versions used in the CI actions to the latest LTS versions.

    • chore: use tabs for indentation - Cherry, [pull/355]

      This PR changes the indentation of the project to use tabs instead of spaces, falling more in line with other Cloudflare JavaScript projects like wrangler.

    • chore: bump dependencies - Cherry, [pull/356]

      This bumps many dependencies of the project to their latest versions.

0.2.0

  • Features

    • Allow changing pathIsEncoded through options - JackPriceBurns, pull/243

      When using mapRequestToAsset, it encodes the URL / key and will never check the KV store for the decoded key.

      This adds the ability to set pathIsEncoded to true, which will decode the URL before getting it from the KV.

    • Support ES Modules. - threepointone, pull/261

      This PR provides a possible solution for getting Workers Sites working with ES Module workers. This approach is not as invasive as other approaches, so isn't as risky either.

      Usage:

      import manifestJSON from "__STATIC_CONTENT_MANIFEST";
const manifest = JSON.parse(manifestJSON);

export default {
  fetch(request, env, ctx) {
    return await getAssetFromKV(
      {
        request,
        waitUntil(promise) {
          return ctx.waitUntil(promise);
        },
      },
      {
        ASSET_NAMESPACE: env.ASSET_NAMESPACE,
        ASSET_MANIFEST: manifest,
      }
    );
    // ...
  },
};

  • Fixes

    • fix: default ASSET_MANIFEST to empty object - Cherry, pull/254

      As per discussion in Discord and the repo at [https://github.com/Erisa-bits/getassetfromkv-undefined-error], allowing ASSET_MANIFEST to be optional got lost somewhere along the years and errors when attempted to be used without it. This PR restores this functionality by setting it to an empty object (instead of undefined), which allows fall-through to the standard mapRequestToAsset function.

      chore: bump dependencies - This updates a few dependencies and also pins @types/node to 15.x since 16.x has some incompatible types. feat: generate more modern code - This removes the unnecessary async/await polyfill added by TypeScript

  • Maintenance

0.1.3

  • Performance

    • Only parse ASSET_MANIFEST once on startup - Cherry, pull/185

      This PR improves performance of the getAssetFromKV function by only parsing the asset manifest once on startup, instead of on each request. This can have a significant improvement in response times for larger sites. An example of the performance improvement with an asset manifest of over 50k files:

      Before change: 100 iterations: Done. Mean kv response time is 16.61 1000 iterations: Done. Mean kv response time is 17.798 After change: 100 iterations: Done. Mean kv response time is 6.62 1000 iterations: Done. Mean kv response time is 7.296

      Initial work and credit to groenlid in pull/143.

  • Fixes

    • ESM compatibility: fix crash on missing global environment variables - ttraenkler, pull/188

      This PR fixes the library from crashing when global environment variables such as __STATIC_CONTENT and __STATIC_CONTENT_MANIFEST are missing, which is currently the case when using the new ESM module syntax.

      Note that whilst this partially resolves the issue discussed in issue/174, it does not provide full ESM compatibility yet. Please see issue/174 for further discussion.

  • Maintenance

    • Tweak GitHub Actions Workflow for proper PR testing - Cherry, pull/185

      This PR tweaks the GitHub Actions Workflow to test PRs properly, both in terms of linting and the repository tests. It runs prettier to maintain code quality and style, and all unit tests on every PR to ensure no regressions occur.

    • Add test for mapRequestToAsset asset override - Cherry, pull/186

      This PR adds a test for the functionality added in pull/159. This tests that when overriding the mapRequestToAsset function in its entirety, this function is always run.

    • Dependabot updates

      A number of dependabot patch-level updates have been merged:

      • Bump @types/node from 15.3.1 to 15.6.0 (pull/183)
      • Bump @types/node from 15.6.0 to 15.6.1 (pull/184)
      • Bump @types/node from 15.6.1 to 15.9.0 (pull/189)
      • Bump @types/node from 15.9.0 to 15.12.0 (pull/190)
      • Bump @types/node from 15.12.0 to 15.12.1 (pull/191)
      • Bump @types/node from 15.12.1 to 15.12.2 (pull/193)
      • Bump typescript from 4.2.4 to 4.3.2 (pull/187)
      • Bump prettier from 2.3.0 to 2.3.1 (pull/192)

0.1.2

  • Features

    • Support for defaultDocument configuration - boemekeld, pull/161

      This PR adds support for customizing the defaultDocument option in getAssetFromKV. In situations where a project does not use index.html as the default document for a path, this can now be customized to values like index.shtm:

      return getAssetFromKV(event, { 
  defaultDocument: "index.shtm"
})

  • Fixes

    • Fire mapRequestToAsset for all requests, if explicitly defined - Cherry, pull/159

      This PR fixes an issue where a custom mapRequestToAsset handler weren't fired if a matching asset path was found in ASSET_MANIFEST data. By correctly checking for this handler, we can conditionally handle any assets with this handler even if they exist in the ASSET_MANIFEST.

      Note that this is a breaking change, as previously, the mapRequestToAsset function was ignored if you set it, and an exact match was found in the ASSET_MANIFEST. That being said, this behavior was a bug, and unexpected behavior, as documented in issue/158.

    • Etag logic refactor - shagamemnon, pull/133

      This PR refactors a great deal of the Etag functionality introduced in 0.0.11. kv-asset-handler will now correctly set strong and weak Etags both to the Cloudflare CDN and to client eyeballs, allowing for higher cache percentages with Workers Sites projects.

    • Fix path decoding issue - xiaolanglanglang, pull/142

      This PR improves support for non-alphanumeric character paths in kv-asset-handler, for instance, if the path requested is in Chinese.

    • Check HTTP method after mapRequestToAsset - oliverpool, pull/178

      This PR fixes an issue where the HTTP method for an asset is checked before the mapRequestToAsset handler is called. This has caused issues for users in the past, where they need to generate a requestKey based on an asset path, even if the request method is not GET. This fixes issue/151.

  • Maintenance

    • Add Markdown linting workflow to GitHub Actions - jbampton, pull/135

      Our GitHub Actions workflow now includes a linting workflow for Markdown in the project, including the README, this CHANGELOG, and any other .md files in the source code.

    • Dependabot updates

      A number of dependabot patch-level updates have been merged since our last release:

      • Bump @types/node from 15.30.0 to 15.30.1 (pull/180)
      • Bump hosted-git-info from 2.8.8 to 2.8.9 (pull/176)
      • Bump ini from 1.3.5 to 1.3.8 (pull/160)
      • Bump lodash from 4.17.19 to 4.17.21 (pull/175)
      • Bump urijs from 1.19.2 to 1.19.6 (pull/168)
      • Bump y18n from 4.0.0 to 4.0.1 (pull/173)

    • Repository maintenance - Cherry, pull/179

      New project maintainer Cherry did a ton of maintenance in this release, improving workflows, code quality, and more. Check out the full list in the PR.

  • Documentation

    • Update README.md - signalnerve, pull/177

      This PR adds context to our README, with mentions about what this project is, how to use it, and some new things since the last version of this package: namely, Cloudflare Pages and the new Cloudflare Workers Discord server

    • Add instructions for updating version in related repos - caass, [pull/171]

      This PR adds instructions for updating the kv-asset-handler version in related repositories, such as our templates, that use kv-asset-handler and are exposed to end-users of Wrangler and Workers.

0.1.1

0.0.12

  • Features

    • Add defaultMimeType option to getAssetFromKV - mgrahamjo, pull/121

      Some static website owners prefer not to create all of their web routes as directories containing index.html files. Instead, they prefer to create pages as extensionless HTML files. Providing a defaultMimeType option will allow users to set the Content-Type header for extensionless files to text/html, which will enable this use case.

    • Add defaultMimeType to types - shagamemnon, pull/132

      Adds the newly added defaultMimeType to the exported types for this package.

  • Fixes

    • Fix text/ charset - EatonZ, pull/130*

      Adds a missing - to the utf-8 charset value in response mime types.

    • Cache handling for HEAD requests - klittlepage, pull/141

      This PR skips caching for incoming HEAD requests, as they should not be able to be edge cached.

  • Maintenance

0.0.11

  • Features

    • Support cache revalidation using ETags and If-None-Match - shagamemnon, issue/62 pull/94 pull/113

      Previously, cacheable resources were not looked up from the browser cache because getAssetFromKV would never return a 304 Not Modified response.

      Now, getAssetFromKV sets an ETag header on all cacheable assets before putting them in the Cache API, and therefore will return a 304 response when appropriate.

    • Export TypeScript types - ispivey, issue/43 pull/106

  • Fixes

    • Support non-ASCII characters in paths - SukkaW, issue/99 pull/105

      Fixes an issue where non-ASCII paths were not URI-decoded before being looked up, causing non-ASCII paths to 404.

    • Support charset=utf8 in MIME type - theromis, issue/92 pull/97

      Fixes an issue where Content-Type: text/* was never appended with ; charset=utf8, meaning clients would not render non-ASCII characters properly.

    • Fix bugs in README examples - kentonv bradyjoslin, issue/93 pull/102 issue/88 pull/116

  • Maintenance

0.0.10

  • Features

    • Allow extensionless files to be served - victoriabernard92, cloudflare/wrangler/issues/980, pull/73

      Prior to this PR, getAssetFromKv assumed extensionless requests (e.g. /some-path) would be set up to be served as the corresponding HTML file in storage (e.g. some-path.html). This fix checks the ASSET_MANIFEST for the extensionless file name before appending the HTML extension. If the extensionless file exists (e.g. some-path exists as a key in the ASSET_MANIFEST) then we serve that file first. If the extensionless file does not exist, then the behavior does not change (e.g. it still looks for some-path.html).

  • Fixes

    • Fix URL parsing in serveSinglePageApp - signalnerve,sgiacosa, issue/72, pull/82

      This fixes an issue in serveSinglePageApp where the request.url is used as a string to retrieve static content. For example, if a query parameter was set, the URL lookup would break. This fix uses a parsed URL instead of the string and adjusts the README.

0.0.9

  • Fixes

    • Building and publishing to npm - victoriabernard92, [pull/78], pull/79

      Added a prepack step that builds JavaScript files from the TypeScript source. This fixes previously broken npm publishes.

0.0.8

  • Features

    • Support a variety of errors thrown from getAssetFromKV - victoriabernard92, issue/59 [pull/64]

      Previously, getAssetFromKv would throw the same error type if anything went wrong. Now it will throw different error types so that clients can catch and differentiate them. For example, a 404 NotFoundError error implies nothing went wrong, the asset just didn't exist while a 500 InternalError means an expected variable was undefined.

  • Fixes

    • Range Issue with Safari and videos - victoriabernard92, issue/60 pull/66

      Previously, if you wanted to serve a video from Workers KV using kv-asset-handler, it would be broken on Safari due to its requirement that all videos support the Content-Range header. Cloudflare already has a feature that will handle these headers automatically, we just needed to take advantage of it by passing in a Request object to the Cache API rather than a URL string. videos from not including the range headers.

    • Support custom asset namespaces passed into getAssetFromKV - victoriabernard92, issue/67 pull/68

      This functionality was documented but not properly supported. Tests and implementation fixes applied.

0.0.7

  • Features

    • Add handler for SPAs - ashleymichal, issue/46 pull/47

      Some browser applications employ client-side routers that handle navigation in the browser rather than on the server. These applications will work as expected until a non-root URL is requested from the server. This PR adds a special handler, serveSinglePageApp, that maps all HTML requests to the root index.html. This is similar to setting a static asset route pattern in an Express.js app.

  • Documentation

    • Add function API for getAssetFromKV to README.md - ashleymichal, [issue/48] [pull/52]

      This function, used to abstract away the implementation for retrieving static assets from a Workers KV namespace, includes a lot of great options for configuring your own, bespoke "Workers Sites" implementation. This PR adds documentation to the README for use by those who would like to tinker with these options.

0.0.6

  • Fixes

    • Improve caching - victoriabernard92, issue/38 pull/37

      • Don't use browser cache by default: Previously, kv-asset-handler would set a Cache-Control header on the response sent back from the Worker to the client. After this fix, the Cache-Control header will only be set if options.cacheControl.browserTTL is set by the caller.

      • Set default edge caching to 2 days: Previously the default cache time for static assets was 100 days. This PR sets the default to 2 days. This can be overridden with options.cacheControl.edgeTTL.