Core: Update to Strapi 5 stacked (#109)

Co-authored-by: Derrick Mehaffy <[email protected]>

Author: boazpoolman

.eslintrc

@@ -0,0 +1,25 @@
+{
+  "env": {
+    "commonjs": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": ["eslint:recommended", "plugin:import/recommended", "prettier"],
+  "overrides": [
+    {
+      "env": {
+        "node": true
+      },
+      "files": [".eslintrc.{js,cjs}"],
+      "parserOptions": {
+        "sourceType": "script"
+      }
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "rules": {
+    "no-undef": "off"
+  }
+}

.eslintrc.js

@@ -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

.github/workflows/gh-release.yml

@@ -3,35 +3,27 @@ name: tests
 on:
   workflow_call:
   push:
-    branches: [main]
-    paths:
-      - ".github/**"
-      - "data/**"
-      - "packages/**"
-      - "playgrounds/**"
-      - "shared/**"
+    branches:
+      - main
+      - 'dev/**'
   pull_request:
     branches: [main]
-    paths:
-      - ".github/**"
-      - "data/**"
-      - "packages/**"
-      - "playgrounds/**"
-      - "shared/**"
 
 jobs:
   linters:
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        node: [20, 22]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: ${{ matrix.node }}
 
       # cache node_modules
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: yarn-cache
         with:
           path: |
@@ -49,16 +41,18 @@ jobs:
 
   e2e_memory:
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        node: [20, 22]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: ${{ matrix.node }}
 
       # cache node_modules
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: yarn-cache
         with:
           path: |
@@ -74,13 +68,17 @@ jobs:
 
       - run: yarn postinstall:memory
 
+      - run: yarn build:plugin:rest-cache
+
       - name: Run Memory e2e tests
         working-directory: playgrounds/memory
         run: yarn test:e2e
 
   e2e_redis:
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        node: [20, 22]
     services:
       redis:
         image: bitnami/redis:latest
@@ -91,14 +89,14 @@ jobs:
           - 6379:6379
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: ${{ matrix.node }}
 
       # cache node_modules
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: yarn-cache
         with:
           path: |
@@ -114,6 +112,8 @@ jobs:
 
       - run: yarn postinstall:redis
 
+      - run: yarn build:plugin:rest-cache
+
       - name: Run Redis e2e tests
         working-directory: playgrounds/redis
         run: yarn test:e2e

.github/workflows/tests.yml

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

.nvmrc

@@ -0,0 +1,8 @@
+{
+    "endOfLine": "lf",
+    "semi": true,
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "printWidth": 100
+  }

.prettierrc

@@ -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 |

.prettierrc.js

@@ -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
 

BENCHMARKS.md

@@ -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>