docs(ecosystem): adds @blastorg/fastify/aws-dynamodb-cache to community plugins list by fredrikj31 · Pull Request #5158 · fastify/fastify

fredrikj31 · 2023-11-13T09:26:55Z

This PR adds a new plugin to the community plugins list. This plugin is made for the purpose to help cache API responses using AWS DynamoDB as a caching storage, so you are able to run multiple API instances on serverless functions and still have access to the same cached responses.

Link to the plugin (Github): https://github.com/blastorg/fastify-aws-dynamodb-cache

Plugin Usage:

import Fastify from "fastify";
import { dynamodbCache } from "@blastorg/fastify-aws-dynamodb-cache";

const fastify = Fastify().register(dynamodbCache, {
  dynamoDbRegion: "", // AWS region of your choice.
  dynamoDbAddress: "http://localhost:8000", // Optional! If you are hosting your own instance of Dynamo (locally or cloud), then specify the ip address of the database here.
  tableName: "fastify-dynamodb-cache", // DynamoDB table name
  defaultTTLSeconds: 30, // Default TTL (seconds), which would be used if no TTL is specified on the endpoint.
  disableCache: true, // Optional! If you want to disable caching from being set on endpoints, you can set this to true. Set it to false or leave it empty to enable cache.
});

fastify.get(
  "/",
  {
    config: {
      config: {
        cache: {
          cacheEnabled: true, // Set to true if endpoint responses should be cached. If you don't want to cache responses set it to false, or don't specify it.
          ttlSeconds: 10, // Optional! TTL on the cached value
        },
      },
    },
    schema: {},
  },
  async (_, res) => {
    // handler...

    return res.status(200).send({});
  }
);

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

metcoder95

LGTM, just a couple of comments from reviewing your plugin:

As an advice, I recommend you to always disable the plugin by default and allow the implementer to enable it accordingly to its needs, unless there's a global flag that enables it automatically (ref: https://github.com/blastorg/fastify-aws-dynamodb-cache/blob/3fda1b1732ef442e79e9ed78ae47e173582a1042/src/index.ts#L26). That will save a lot of people from headaches
It would be nice if you the plugin follows by default the Cache Control headers directive. So clients has the correct hints about the caching, and as well implementers has this out of the box.
Also you can consider the ETag header as well

fredrikj31 · 2023-11-17T12:51:05Z

Thank you for reviewing the plugin.

There is a global flag that you can use to disable/enable the caching on the whole api (ex. during development)

I see a lot of good features/fixes in your suggestions, which I can see would benefit the users who uses the plugin.

So thanks for the feedback 🙏

fredrikj31 · 2023-11-28T06:51:19Z

Is there any update to this? I'm only seeing that somebody with write access needs to merge this PR in 🤔

…ty plugins list

github-actions · 2024-12-07T00:29:33Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

github-actions bot added documentation Improvements or additions to documentation plugin Identify a pr to the doc that adds a plugin. labels Nov 13, 2023

fredrikj31 force-pushed the adds-aws-dynamodb-caching-plugin branch from 2449f7d to 80c5fcc Compare November 16, 2023 14:18

metcoder95 approved these changes Nov 17, 2023

View reviewed changes

fredrikj31 force-pushed the adds-aws-dynamodb-caching-plugin branch from 80c5fcc to adb2a22 Compare November 30, 2023 07:51

fredrikj31 requested a review from metcoder95 December 5, 2023 09:41

docs(ecosystem): adds @blastorg/fastify/aws-dynamodb-cache to communi…

e571c76

…ty plugins list

fredrikj31 force-pushed the adds-aws-dynamodb-caching-plugin branch from adb2a22 to e571c76 Compare December 5, 2023 19:25

metcoder95 approved these changes Dec 5, 2023

View reviewed changes

metcoder95 merged commit 5d29f5c into fastify:main Dec 5, 2023

github-actions bot locked as resolved and limited conversation to collaborators Dec 7, 2024

fredrikj31 deleted the adds-aws-dynamodb-caching-plugin branch December 10, 2024 13:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(ecosystem): adds @blastorg/fastify/aws-dynamodb-cache to community plugins list#5158

docs(ecosystem): adds @blastorg/fastify/aws-dynamodb-cache to community plugins list#5158
metcoder95 merged 1 commit intofastify:mainfrom
blastorg:adds-aws-dynamodb-caching-plugin

fredrikj31 commented Nov 13, 2023

Uh oh!

metcoder95 left a comment

Uh oh!

fredrikj31 commented Nov 17, 2023 •

edited

Loading

Uh oh!

fredrikj31 commented Nov 28, 2023

Uh oh!

github-actions bot commented Dec 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

fredrikj31 commented Nov 13, 2023

Plugin Usage:

Checklist

Uh oh!

metcoder95 left a comment

Choose a reason for hiding this comment

Uh oh!

fredrikj31 commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fredrikj31 commented Nov 28, 2023

Uh oh!

github-actions bot commented Dec 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fredrikj31 commented Nov 17, 2023 •

edited

Loading