Dev/update cache manager

.github/workflows/gh-release.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           tag_name: ${{ steps.meta.outputs.tag }}
           name: Release ${{ steps.meta.outputs.tag }}
-          body: View [CHANGELOG.md](https://github.com/strapi-community/strapi-plugin-rest-cache/blob/main/CHANGELOG.md) for details
+          body: View [CHANGELOG.md](https://github.com/strapi-community/plugin-rest-cache/blob/main/CHANGELOG.md) for details
           draft: false
           prerelease: false
-          discussion_category_name: announcements
+          discussion_category_name: announcements

.nvmrc

@@ -1 +1 @@
-v14.19.1
+v20.18.0

BENCHMARKS.md

@@ -1,5 +1,7 @@
 # Benchmarks
 
+These benchmarks are out of date for the current version of the plugin. They are kept here for reference and might be updated in the future.
+
 ## Context
 
 - Rest cache version: `4.2.4`
@@ -15,13 +17,13 @@
 $ ENABLE_CACHE=false yarn profile:memory
 ```
 
-| Stat        | 2.5%    | 50%     | 97.5%   | 99%     | Avg        | Stdev     | Max     |
-| ----------- | ------- | ------- | ------- | ------- | ---------- | --------- | ------- |
+| Stat        | 2.5%    | 50%     | 97.5%   | 99%     | Avg        | Stdev  | Max     |
+|-------------|---------|---------|---------|---------|------------|--------|---------|
 | **Latency** | 2424 ms | 2555 ms | 2921 ms | 3012 ms | 2565.12 ms | 133.23 | 3401 ms |
 
-| Stat          | 1%  | 2.5% | 50%    | 97.5%   | Avg    | Stdev  | Min    |
-| ------------- | --- | ---- | ------ | ------- | ------ | ------ | ------ |
-| **Req/Sec**   | 0   | 0    | 386    | 1000    | 383.34 | 382.38 | 39     |
+| Stat          | 1%  | 2.5% | 50%    | 97.5%   | Avg    | Stdev  | Min     |
+|---------------|-----|------|--------|---------|--------|--------|---------|
+| **Req/Sec**   | 0   | 0    | 386    | 1000    | 383.34 | 382.38 | 39      |
 | **Bytes/Sec** | 0 B | 0 B  | 453 kB | 1.17 MB | 450 kB | 449 kB | 45.7 kB |
 
 ### Cache enabled (without etag)
@@ -30,12 +32,12 @@ $ ENABLE_CACHE=false yarn profile:memory
 $ ENABLE_ETAG=false yarn profile:memory
 ```
 
-| Stat        | 2.5%   | 50%    | 97.5%  | 99%    | Avg       | Stdev   | Max    |
-| ----------- | ------ | ------ | ------ | ------ | --------- | ------- | ------ |
+| Stat        | 2.5%   | 50%    | 97.5%  | 99%    | Avg       | Stdev    | Max    |
+|-------------|--------|--------|--------|--------|-----------|----------|--------|
 | **Latency** | 113 ms | 116 ms | 166 ms | 175 ms | 120.04 ms | 12.86 ms | 275 ms |
 
 | Stat          | 1%      | 2.5%    | 50%     | 97.5%   | Avg     | Stdev  | Min     |
-| ------------- | ------- | ------- | ------- | ------- | ------- | ------ | ------- |
+|---------------|---------|---------|---------|---------|---------|--------|---------|
 | **Req/Sec**   | 7451    | 7523    | 8287    | 8687    | 8293.49 | 306.35 | 6381    |
 | **Bytes/Sec** | 8.85 MB | 8.93 MB | 9.84 MB | 10.3 MB | 9.84 MB | 364 kB | 7.57 MB |
 
@@ -46,10 +48,10 @@ $ yarn profile:memory
 ```
 
 | Stat        | 2.5%   | 50%    | 97.5%  | 99%    | Avg       | Stdev    | Max    |
-| ----------- | ------ | ------ | ------ | ------ | --------- | -------- | ------ |
+|-------------|--------|--------|--------|--------|-----------|----------|--------|
 | **Latency** | 119 ms | 125 ms | 185 ms | 197 ms | 131.05 ms | 16.87 ms | 307 ms |
 
-| Stat          | 1%      | 2.5%    | 50%     | 97.5%   | Avg     | Stdev  | Min     |
-| ------------- | ------- | ------- | ------- | ------- | ------- | ------ | ------- |
-| **Req/Sec**   | 6551    | 6559    | 7651    | 8231    | 7599.39 | 472.94  | 6100    |
+| Stat          | 1%      | 2.5%    | 50%    | 97.5%   | Avg     | Stdev  | Min    |
+|---------------|---------|---------|--------|---------|---------|--------|--------|
+| **Req/Sec**   | 6551    | 6559    | 7651   | 8231    | 7599.39 | 472.94 | 6100   |
 | **Bytes/Sec** | 8.05 MB | 8.07 MB | 9.4 MB | 10.1 MB | 9.34 MB | 581 kB | 7.5 MB |

README.md

@@ -4,11 +4,11 @@
 <p style="margin-top: 0;">Speed-up HTTP requests with LRU cache.</p>
 
 <p>
-  <a href="https://www.npmjs.org/package/strapi-plugin-rest-cache">
-    <img src="https://img.shields.io/npm/v/strapi-plugin-rest-cache/latest.svg" alt="NPM Version" />
+  <a href="https://www.npmjs.org/package/@strapi-community/plugin-rest-cache">
+    <img src="https://img.shields.io/npm/v/@strapi-community/plugin-rest-cache/latest.svg" alt="NPM Version" />
   </a>
-  <a href="https://www.npmjs.org/package/strapi-plugin-rest-cache">
-    <img src="https://img.shields.io/npm/dm/strapi-plugin-rest-cache" alt="Monthly download on NPM" />
+  <a href="https://www.npmjs.org/package/@strapi-community/plugin-rest-cache">
+    <img src="https://img.shields.io/npm/dm/@strapi-community/plugin-rest-cache" alt="Monthly download on NPM" />
   </a>
 </p>
 </div>
@@ -46,7 +46,7 @@ Supported Strapi Versions:
 
 ## 🚚 Getting Started
 
-[Read the Docs to Learn More.](https://strapi-community.github.io/strapi-plugin-rest-cache/)
+[Read the Docs to Learn More.](https://strapi-community.github.io/plugin-rest-cache/)
 
 ## Contributing
 

docs/.vitepress/components/LegacyWarning.vue

@@ -0,0 +1,29 @@
+<script setup lang="ts">
+import { useData, useRoute } from 'vitepress'
+import { computed } from 'vue'
+
+const { site } = useData()
+const route = useRoute()
+
+// Define which versions should show the legacy warning
+const legacyVersions = ['4.x.x']
+
+// Check if current URL starts with any version folder name
+const shouldShowWarning = computed(() => {
+  const path = route.path
+  return legacyVersions.some(version => path.startsWith(`${site.value.base}${version}/`))
+})
+</script>
+
+<template>
+  <div v-if="shouldShowWarning" class="warning custom-block">
+    <p class="custom-block-title">WARNING</p>
+    <p>You're looking at the old Rest Cache plugin documentation for <strong>Strapi v4</strong>. Documentation for Strapi v5 can be <a :href="`${site.base}guide/`">found here</a>.</p>
+  </div>
+</template>
+
+<style scoped>
+.warning {
+  margin-bottom: 2rem;
+}
+</style>

docs/.vitepress/components/VersionSwitcher.vue

@@ -0,0 +1,161 @@
+<script setup lang="ts">
+import { useData, useRouter } from "vitepress"
+import { computed, ref } from 'vue'
+import VPMenuLink from 'vitepress/dist/client/theme-default/components/VPMenuLink.vue'
+import VPFlyout from 'vitepress/dist/client/theme-default/components/VPFlyout.vue'
+const props = defineProps<{
+  versioningPlugin: { versions: string[], latestVersion: string }
+  screenMenu?: boolean
+}>();
+
+const router = useRouter();
+const { site } = useData();
+
+const currentVersion = computed(() => {
+  let version = props.versioningPlugin.latestVersion;
+
+  for (const v of props.versioningPlugin.versions) {
+    if (router.route.path.startsWith(`${site.value.base}${v}/`)) {
+      version = v;
+      break;
+    }
+  }
+
+  return version;
+});
+
+const isOpen = ref(false);
+const toggle = () => {
+  isOpen.value = !isOpen.value;
+};
+</script>
+
+<template>
+  <VPFlyout v-if="!screenMenu" class="VPVersionSwitcher" icon="vpi-versioning" :button="currentVersion"
+    :label="'Switch Version'">
+    <div class="items">
+      <VPMenuLink v-if="currentVersion != versioningPlugin.latestVersion" :item="{
+        text: versioningPlugin.latestVersion,
+        link: `/`,
+      }" />
+      <template v-for="version in versioningPlugin.versions" :key="version">
+        <VPMenuLink v-if="currentVersion != version" :item="{
+          text: version,
+          link: `/${version}/`,
+        }" />
+      </template>
+    </div>
+  </VPFlyout>
+  <div v-else class="VPScreenVersionSwitcher" :class="{ open: isOpen }">
+    <button class="button" aria-controls="navbar-group-version" :aria-expanded="isOpen" @click="toggle">
+      <span class="button-text"><span class="vpi-versioning icon" />Switch Version</span>
+      <span class="vpi-plus button-icon" />
+    </button>
+
+    <div id="navbar-group-version" class="items">
+      <VPMenuLink :item="{
+        text: versioningPlugin.latestVersion,
+        link: `/`,
+      }" />
+      <template v-for="version in versioningPlugin.versions" :key="version">
+        <VPMenuLink :item="{
+          text: version,
+          link: `/${version}/`,
+        }" />
+      </template>
+    </div>
+  </div>
+</template>
+
+<style>
+.vpi-versioning.option-icon {
+  margin-right: 2px !important;
+}
+
+.vpi-versioning {
+  --icon: url("data:image/svg+xml;charset=utf-8;base64,PHN2ZyB3aWR0aD0iNjRweCIgaGVpZ2h0PSI2NHB4IiB2aWV3Qm94PSIwIDAgMjQgMjQiIHN0cm9rZS13aWR0aD0iMi4yIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGNvbG9yPSIjMDAwMDAwIj48cGF0aCBkPSJNMTcgN0MxOC4xMDQ2IDcgMTkgNi4xMDQ1NyAxOSA1QzE5IDMuODk1NDMgMTguMTA0NiAzIDE3IDNDMTUuODk1NCAzIDE1IDMuODk1NDMgMTUgNUMxNSA2LjEwNDU3IDE1Ljg5NTQgNyAxNyA3WiIgc3Ryb2tlPSIjMDAwMDAwIiBzdHJva2Utd2lkdGg9IjIuMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIj48L3BhdGg+PHBhdGggZD0iTTcgN0M4LjEwNDU3IDcgOSA2LjEwNDU3IDkgNUM5IDMuODk1NDMgOC4xMDQ1NyAzIDcgM0M1Ljg5NTQzIDMgNSAzLjg5NTQzIDUgNUM1IDYuMTA0NTcgNS44OTU0MyA3IDcgN1oiIHN0cm9rZT0iIzAwMDAwMCIgc3Ryb2tlLXdpZHRoPSIyLjIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCI+PC9wYXRoPjxwYXRoIGQ9Ik03IDIxQzguMTA0NTcgMjEgOSAyMC4xMDQ2IDkgMTlDOSAxNy44OTU0IDguMTA0NTcgMTcgNyAxN0M1Ljg5NTQzIDE3IDUgMTcuODk1NCA1IDE5QzUgMjAuMTA0NiA1Ljg5NTQzIDIxIDcgMjFaIiBzdHJva2U9IiMwMDAwMDAiIHN0cm9rZS13aWR0aD0iMi4yIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjwvcGF0aD48cGF0aCBkPSJNNyA3VjE3IiBzdHJva2U9IiMwMDAwMDAiIHN0cm9rZS13aWR0aD0iMi4yIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjwvcGF0aD48cGF0aCBkPSJNMTcgN1Y4QzE3IDEwLjUgMTUgMTEgMTUgMTFMOSAxM0M5IDEzIDcgMTMuNSA3IDE2VjE3IiBzdHJva2U9IiMwMDAwMDAiIHN0cm9rZS13aWR0aD0iMi4yIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjwvcGF0aD48L3N2Zz4=")
+}
+</style>
+
+<style scoped>
+.VPVersionSwitcher {
+  display: flex;
+  align-items: center;
+}
+
+.icon {
+  padding: 8px;
+}
+
+.title {
+  padding: 0 24px 0 12px;
+  line-height: 32px;
+  font-size: 14px;
+  font-weight: 700;
+  color: var(--vp-c-text-1);
+}
+
+.VPScreenVersionSwitcher {
+  border-bottom: 1px solid var(--vp-c-divider);
+  height: 48px;
+  overflow: hidden;
+  transition: border-color 0.5s;
+}
+
+.VPScreenVersionSwitcher .items {
+  visibility: hidden;
+}
+
+.VPScreenVersionSwitcher.open .items {
+  visibility: visible;
+}
+
+.VPScreenVersionSwitcher.open {
+  padding-bottom: 10px;
+  height: auto;
+}
+
+.VPScreenVersionSwitcher.open .button {
+  padding-bottom: 6px;
+  color: var(--vp-c-brand-1);
+}
+
+.VPScreenVersionSwitcher.open .button-icon {
+  /*rtl:ignore*/
+  transform: rotate(45deg);
+}
+
+.VPScreenVersionSwitcher button .icon {
+  margin-right: 8px;
+}
+
+.button {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  padding: 12px 4px 11px 0;
+  width: 100%;
+  line-height: 24px;
+  font-size: 14px;
+  font-weight: 500;
+  color: var(--vp-c-text-1);
+  transition: color 0.25s;
+}
+
+.button:hover {
+  color: var(--vp-c-brand-1);
+}
+
+.button-icon {
+  transition: transform 0.25s;
+}
+
+.group:first-child {
+  padding-top: 0px;
+}
+
+.group+.group,
+.group+.item {
+  padding-top: 4px;
+}
+</style>