cacheable - Release 5.1.1

Published by zzau13 about 2 years ago

5.1.1 (2022-10-19)

Bug Fixes

bad Cache definition (3746c39)
mget/mset examples in README (1ca67a4)

cacheable - Release 5.1.0

Published by zzau13 about 2 years ago

5.1.0 (2022-10-19)

Features

add ttl argument in wrap method (b06c1e5)

cacheable - v10.2.1

Published by jaredwray about 2 years ago

10.2.1 Bug fixes and Changes

Biggest change has been that when an agent is KeepAlive: true we are now sending a response end which will close the socket instead of an error.

What's Changed

Moved @types/http-cache-semantics to dependencies by @Maxim-Mazurok in https://github.com/jaredwray/cacheable-request/pull/195
fix dangling response on cache revalidation by @zkx5xkt in https://github.com/jaredwray/cacheable-request/pull/196

New Contributors

@Maxim-Mazurok made their first contribution in https://github.com/jaredwray/cacheable-request/pull/195
@zkx5xkt made their first contribution in https://github.com/jaredwray/cacheable-request/pull/196

Full Changelog: https://github.com/jaredwray/cacheable-request/compare/v10.2.0...v10.2.1

cacheable - v10.2.0

Published by jaredwray about 2 years ago

Hooks `onResponse` replacing `response` hook

response will still work but will be deprecated as we expand this functionality. onResponse will be the name moving forward. Here are examples of how to use it.

How to decompress

import http from 'http';
import CacheableRequest from 'cacheable-request';

const cacheableRequest = new CacheableRequest(request, cache).request();

// adding a hook to decompress response
cacheableRequest.addHook('onResponse', async (value: CacheValue, response: any) => {
  const buffer = await pm(gunzip)(value.body);
  value.body = buffer.toString();
  return value;
});

how to add a remote address

import CacheableRequest, {CacheValue} from 'cacheable-request';

const cacheableRequest = new CacheableRequest(request, cache).request();
cacheableRequest.addHook('onResponse', (value: CacheValue, response: any) => {
  if (response.connection) {
    value.remoteAddress = response.connection.remoteAddress;
  }

  return value;
});

In addition to that we have also updated some of the packages to their lates which you can read below 👇

What's Changed

upgrading xo to 0.52.3 and updating types.ts with type definitions by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/190
upgrading ts-jest to 29.0.1 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/191
upgrading sqlite3 to 5.1.1 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/192
added remote address by @alphmth in https://github.com/jaredwray/cacheable-request/pull/189
moving to onResponse for hooks by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/193

Full Changelog: https://github.com/jaredwray/cacheable-request/compare/v10.1.2...v10.2.0

cacheable - v10.1.2

Published by jaredwray about 2 years ago

⚠️ Breaking Change

Based on feedback (thanks @szmarczak!) we have renamed the function createCacheableRequest to just request.

- const cacheableRequest = new CacheableRequest(https.request).createCacheableRequest();
+ const cacheableRequest = new CacheableRequest(https.request).request();

v10 code with `createCacheableRequest`

import CacheableRequest from 'cacheable-request';

// Now You can do
const cacheableRequest = new CacheableRequest(http.request).request();
const cacheReq = cacheableRequest('http://example.com', cb);
cacheReq.on('request', req => req.end());
// Future requests to 'example.com' will be returned from cache if still valid

// You pass in any other http.request API compatible method to be wrapped with cache support:
const cacheableRequest = new CacheableRequest(https.request).createCacheableRequest();
const cacheableRequest = new CacheableRequest(electron.net).createCacheableRequest();

v10.1.2 code with `request`

import CacheableRequest from 'cacheable-request';

// Now You can do
const cacheableRequest = new CacheableRequest(http.request).request();
const cacheReq = cacheableRequest('http://example.com', cb);
cacheReq.on('request', req => req.end());
// Future requests to 'example.com' will be returned from cache if still valid

// You pass in any other http.request API compatible method to be wrapped with cache support:
const cacheableRequest = new CacheableRequest(https.request).request();
const cacheableRequest = new CacheableRequest(electron.net).request();

What's Changed

refactor code by @alphmth in https://github.com/jaredwray/cacheable-request/pull/188

Full Changelog: https://github.com/jaredwray/cacheable-request/compare/v10.0.2...v10.1.2

cacheable - v10.0.2

Published by jaredwray about 2 years ago

Change to support got by exporting types enabling better integration with upstream packages.

What's Changed

fixed types by @alphmth in https://github.com/jaredwray/cacheable-request/pull/187

Full Changelog: https://github.com/jaredwray/cacheable-request/compare/v10.0.1...v10.0.2

cacheable - v10.0.1

Published by jaredwray about 2 years ago

Minor maintenance release with some primary packages updated such as:

@types/node to 18.7.16
keyv to 4.5.0
normalize-url to 7.10

Changelog

upgrading jest and ts-jest to version 29 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/177
upgrading @types/node to 18.7.16 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/178
upgrading eslint-plugin-jest to 27.0.4 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/179
updating documentation to on contribution by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/180
adding in table of contents by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/181
upgrading keyv to 4.5.0 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/182
adding a warning to security document on v8 support by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/183
upgrading typescript to 4.8.3 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/184
upgrading normalize-url to 7.1.0 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/185
updating docs and prepare when publishing by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/186

Full Changelog: https://github.com/jaredwray/cacheable-request/compare/v10.0.0...v10.0.1

cacheable - v10.0.0

Published by jaredwray about 2 years ago

Breaking Change with v10.0.0

This release contains breaking changes as we are now using class to handle instances and hooks better. This is the new way to use this package.

Usage Before v10

import http from 'http';
import CacheableRequest from 'cacheable-request';

// Then instead of
const req = http.request('http://example.com', cb);
req.end();

// You can do
const cacheableRequest = new CacheableRequest(http.request);
const cacheReq = cacheableRequest('http://example.com', cb);
cacheReq.on('request', req => req.end());
// Future requests to 'example.com' will be returned from cache if still valid

// You pass in any other http.request API compatible method to be wrapped with cache support:
const cacheableRequest = new CacheableRequest(https.request);
const cacheableRequest = new CacheableRequest(electron.net);

Usage After v10

import CacheableRequest from 'cacheable-request';

// Now You can do
const cacheableRequest = new CacheableRequest(http.request).createCacheableRequest();
const cacheReq = cacheableRequest('http://example.com', cb);
cacheReq.on('request', req => req.end());
// Future requests to 'example.com' will be returned from cache if still valid

// You pass in any other http.request API compatible method to be wrapped with cache support:
const cacheableRequest = new CacheableRequest(https.request).createCacheableRequest();
const cacheableRequest = new CacheableRequest(electron.net).createCacheableRequest();

The biggest change is that when you do a new CacheableRequest you now want to call createCacheableRequest method will give you the instance to use.

- const cacheableRequest = new CacheableRequest(http.request);
+ const cacheableRequest = new CacheableRequest(http.request).createCacheableRequest();

What's Changed

updating security readme on support for v8.x.x by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/166
upgrading keyv to 4.4.1 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/168
upgrading ts-jest to 28.0.8 by @jaredwray in https://github.com/jaredwray/cacheable-request/pull/169
fixed hooks instance issue by @alphmth in https://github.com/jaredwray/cacheable-request/pull/167
fixed issue by @alphmth in https://github.com/jaredwray/cacheable-request/pull/172
fixed type issues by @alphmth in https://github.com/jaredwray/cacheable-request/pull/173
Issue #174 by @slwhitman in https://github.com/jaredwray/cacheable-request/pull/176
Issue 171 by @alphmth in https://github.com/jaredwray/cacheable-request/pull/175

New Contributors

@slwhitman made their first contribution in https://github.com/jaredwray/cacheable-request/pull/176

Full Changelog: https://github.com/jaredwray/cacheable-request/compare/v9.0.0...v10.0.0

cacheable - v9.0.0

Published by jaredwray about 2 years ago

v9 is now pure ESM 🎉

cacheable-request is now pure ESM with version v9.0.0 and up. Version v.8.x.x is the supported commonjs version which will get only major security fixes moving forward until end of 2022. If you would like to learn about uprgrading / using ESM @sindresorhus has an amazing reference guide here: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

Major thank you to @alphmth, @sindresorhus, @szmarczak, @jasonbaik, and everybody for help on this. 🙌

Special call out to @CyberShadow as in the previous release we forgot to mention the work done on issue #28 as without their guidance and code we wouldn't have fixed it. ❤️

Typescript

In addition to pure ESM we are now fulling using Typescript moving forward on this project which means all type definitions are now native with the service. 🤩

Hooks!

Hooks have been introduced for the response object that will run a processing function like so if you wanted to do compression:

CacheableRequest.addHook('response', async (response: any) => {
  const buffer = await pm(gunzip)(response);
  return buffer.toString();
});

const cacheableRequest = CacheableRequest(request, cache);