asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: Caching Module (#13701)

Browse Source 
* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
This commit is contained in:
Shahed Nasser
2025-10-21 10:34:27 +03:00
committed by GitHub
parent eefda0edce
commit 76f9da5ef4
50 changed files with 10530 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
www/utils/generated/typedoc-json-output/cache.json
View File

@@ -1,19 +1,19 @@
{
"id": 61101,
"id": 0,
"name": "cache",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 61102,
"id": 1,
"name": "ICacheService",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 61103,
"id": 2,
"name": "get",
"variant": "declaration",
"kind": 2048,
@@ -23,12 +23,12 @@
"fileName": "service.ts",
"line": 11,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L11"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L11"
}
],
"signatures": [
{
"id": 61104,
"id": 3,
"name": "get",
"variant": "signature",
"kind": 4096,
@@ -66,12 +66,12 @@
"fileName": "service.ts",
"line": 11,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L11"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L11"
}
],
"typeParameters": [
{
"id": 61105,
"id": 4,
"name": "T",
"variant": "typeParam",
"kind": 131072,
@@ -80,7 +80,7 @@
],
"parameters": [
{
"id": 61106,
"id": 5,
"name": "key",
"variant": "param",
"kind": 32768,
@@ -115,7 +115,7 @@
},
{
"type": "reference",
"target": 61105,
"target": 4,
"name": "T",
"package": "@medusajs/types",
"refersToTypeParameter": true
@@ -130,7 +130,7 @@
]
},
{
"id": 61107,
"id": 6,
"name": "set",
"variant": "declaration",
"kind": 2048,
@@ -140,12 +140,12 @@
"fileName": "service.ts",
"line": 22,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L22"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L22"
}
],
"signatures": [
{
"id": 61108,
"id": 7,
"name": "set",
"variant": "signature",
"kind": 4096,
@@ -174,12 +174,12 @@
"fileName": "service.ts",
"line": 22,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L22"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L22"
}
],
"parameters": [
{
"id": 61109,
"id": 8,
"name": "key",
"variant": "param",
"kind": 32768,
@@ -198,7 +198,7 @@
}
},
{
"id": 61110,
"id": 9,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -217,7 +217,7 @@
}
},
{
"id": 61111,
"id": 10,
"name": "ttl",
"variant": "param",
"kind": 32768,
@@ -257,7 +257,7 @@
]
},
{
"id": 61112,
"id": 11,
"name": "invalidate",
"variant": "declaration",
"kind": 2048,
@@ -267,12 +267,12 @@
"fileName": "service.ts",
"line": 31,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L31"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L31"
}
],
"signatures": [
{
"id": 61113,
"id": 12,
"name": "invalidate",
"variant": "signature",
"kind": 4096,
@@ -301,12 +301,12 @@
"fileName": "service.ts",
"line": 31,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L31"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L31"
}
],
"parameters": [
{
"id": 61114,
"id": 13,
"name": "key",
"variant": "param",
"kind": 32768,
@@ -348,9 +348,9 @@
{
"title": "Methods",
"children": [
61103,
61107,
61112
2,
6,
11
]
}
],
@@ -359,7 +359,7 @@
"fileName": "service.ts",
"line": 1,
"character": 17,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L1"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L1"
}
]
}
@@ -368,65 +368,65 @@
{
"title": "Interfaces",
"children": [
61102
1
]
}
],
"packageName": "@medusajs/types",
"symbolIdMap": {
"61101": {
"0": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": ""
},
"61102": {
"1": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService"
},
"61103": {
"2": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.get"
},
"61104": {
"3": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.get"
},
"61105": {
"4": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "T"
},
"61106": {
"5": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "key"
},
"61107": {
"6": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.set"
},
"61108": {
"7": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.set"
},
"61109": {
"8": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "key"
},
"61110": {
"9": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "data"
},
"61111": {
"10": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ttl"
},
"61112": {
"11": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.invalidate"
},
"61113": {
"12": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.invalidate"
},
"61114": {
"13": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "key"
}
@@ -436,7 +436,7 @@
"1": "../../../../packages/core/types/src/cache/service.ts"
},
"reflections": {
"1": 61101
"1": 0
}
}
}

2942
www/utils/generated/typedoc-json-output/caching.json Normal file
View File

File diff suppressed because it is too large Load Diff

5
www/utils/packages/typedoc-generate-references/src/constants/custom-options.ts
View File

@@ -22,6 +22,11 @@ const customOptions: Record<string, Partial<TypeDocOptions>> = {
tsConfigName: "types.json",
name: "cache",
}),
caching: getOptions({
entryPointPath: "packages/core/types/src/caching/index.ts",
tsConfigName: "types.json",
name: "caching",
}),
"core-flows": getOptions({
entryPointPath: "packages/core/core-flows/src/index.ts",
tsConfigName: "core-flows.json",

9
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/cache.ts
View File

@@ -5,7 +5,14 @@ const cacheOptions: FormattingOptionsType = {
reflectionGroups: {
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn about the different methods in the Cache Module's service and how to use them.`,
reflectionDescription: `In this document, you’ll learn about the different methods in the Cache Module's service and how to use them.
:::note[Deprecation Notice]
The Cache Module is deprecated starting from [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). [Use the Caching Module](#) instead.
:::
`,
frontmatterData: {
slug: "/references/cache-service",
tags: ["cache", "server", "how to"],

215
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/caching.ts Normal file
View File

@@ -0,0 +1,215 @@
import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const cachingOptions: FormattingOptionsType = {
"^caching/.*ICachingProviderService": {
reflectionGroups: {
Constructors: false,
},
reflectionDescription: `In this guide, you’ll learn how to create a Caching Module Provider and the methods you must implement in its main service.
:::note
The Caching Module and its providers are available starting [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0).
:::`,
frontmatterData: {
slug: "/references/caching-module-provider",
tags: ["caching", "server", "how to"],
sidebar_label: "Create Caching Provider",
keywords: ["caching", "provider", "integration"],
},
reflectionTitle: {
fullReplacement: "How to Create a Caching Module Provider",
},
shouldIncrementAfterStartSections: true,
expandMembers: true,
expandProperties: true,
sortMembers: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [
// TODO add link to memcached guide when available
`## Implementation Example
As you implement your Caching Module Provider, it can be useful to refer to an existing provider and how it's implemeted.
If you need to refer to an existing implementation as an example, check the [Redis Caching Module Provider in the Medusa repository](https://github.com/medusajs/medusa/tree/develop/packages/modules/providers/caching-redis).`,
`## 1. Create Module Provider Directory
Start by creating a new directory for your module provider.
If you're creating the module provider in a Medusa application, create it under the \`src/modules\` directory. For example, \`src/modules/my-caching\`.
If you're creating the module provider in a plugin, create it under the \`src/providers\` directory. For example, \`src/providers/my-caching\`.
<Note>
The rest of this guide always uses the \`src/modules/my-caching\` directory as an example.
</Note>`,
`## 2. Create the Caching Module Provider Service
Create the file \`src/modules/my-caching/service.ts\` that holds the module provider's main service. It must implement the \`ICachingProviderService\` interface imported from \`@medusajs/framework/types\`:
\`\`\`ts title="src/modules/my-caching/service.ts"
import { ICachingProviderService } from "@medusajs/framework/types"
class MyCachingProviderService implements ICachingProviderService {
// TODO implement methods
}
export default MyCachingProviderService
\`\`\``,
],
endSections: [
`## 3. Create Module Definition File
Create the file \`src/modules/my-caching/index.ts\` with the following content:
\`\`\`ts title="src/modules/my-caching/index.ts"
import { ModuleProvider, Modules } from "@medusajs/framework/utils"
import MyCachingProviderService from "./service"
export default ModuleProvider(Modules.CACHING, {
services: [MyCachingProviderService],
})
\`\`\`
This exports the module provider's definition, indicating that the \`MyCachingProviderService\` is the module provider's service.`,
`## 4. Use Module Provider
To use your Caching Module Provider, add it to the \`providers\` array of the Caching Module in \`medusa-config.ts\`:
\`\`\`ts title="medusa-config.ts"
module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/medusa/caching",
options: {
providers: [
{
// if module provider is in a plugin, use \`plugin-name/providers/my-caching\`
resolve: "./src/modules/my-caching",
id: "my-caching",
// set this if you want this provider to be used by default
// and you have other Caching Module Providers registered.
is_default: true,
options: {
url: "http://example.com",
// provider options...
}
},
]
}
}
]
})
\`\`\`
`,
`## 5. Test it Out
To test out your Caching Module Provider, create a simple API route that retrieves cached data with Query:
\`\`\`ts title="src/api/test-caching/route.ts"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const query = req.scope.resolve("query")
const { data } = await query.graph({
entity: "product",
fields: ["id", "title"],
}, {
cache: {
enable: true,
providers: ["my-caching"], // use your provider id here
}
})
res.status(200).json({ data })
}
\`\`\`
Then, start your Medusa server with the following command:
\`\`\`bash npm2yarn
npm run dev
\`\`\`
Next, send a \`GET\` request to \`http://localhost:9000/test-caching\`:
\`\`\`bash
curl http://localhost:9000/test-caching
\`\`\`
You will receive a response with the list of products. The first time you make this request, the products will be fetched from the database and cached in memory. Subsequent requests will retrieve the products from the cache, which improves performance.
`,
`## Useful Guides
- [How to Use Caching Module](/references/caching-service)
`,
],
},
"^caching/.*ICachingModuleService": {
reflectionGroups: {
Constructors: false,
},
reflectionDescription: `In this guide, you’ll learn about the different methods in the Caching Module's service and how to use them.
:::note
The Caching Module and its providers are available starting [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0).
:::
:::tip
You should use the Caching Module's service when you're caching computed data or data from external APIs. To cache database query results, enable caching in [Query](!docs!/learn/fundamentals/module-links/query#cache) or [Index Module](!docs!/learn/fundamentals/module-links/index-module#cache) instead.
:::
`,
frontmatterData: {
slug: "/references/caching-service",
tags: ["caching", "server", "how to"],
sidebar_label: "Use Caching Module",
},
reflectionTitle: {
fullReplacement: "How to Use Caching Module",
},
expandMembers: true,
sortMembers: true,
startSections: [
`## Resolve Caching Module's Service
In your workflow's step, you can resolve the Caching Module's service from the Medusa container:
\`\`\`ts
import { Modules } from "@medusajs/framework/utils"
import { createStep } from "@medusajs/framework/workflows-sdk"
const step1 = createStep(
"step-1",
async ({}, { container }) => {
const cachingModuleService = container.resolve(
Modules.CACHING
)
// TODO use cachingModuleService
}
)
\`\`\`
You can then use the Caching Module's service's methods in the step. The rest of this guide details these methods.
---
`,
],
},
}
export default cachingOptions

2
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/index.ts
View File

@@ -1,5 +1,6 @@
import { FormattingOptionsType } from "types"
import authProviderOptions from "./auth-provider.js"
import cachingOptions from "./caching.js"
import fileOptions from "./file.js"
import fulfillmentProviderOptions from "./fulfillment-provider.js"
import helperStepsOptions from "./helper-steps.js"
@@ -25,6 +26,7 @@ const mergerCustomOptions: FormattingOptionsType = {
...analyticsProviderOptions,
...authProviderOptions,
...cacheOptions,
...cachingOptions,
...coreFlowsOptions,
...dmlOptions,
...eventOptions,

6
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/locking.ts
View File

@@ -6,7 +6,7 @@ const lockingOptions: FormattingOptionsType = {
reflectionGroups: {
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn how to create a Locking Module Provider and the methods you must implement in its main service.`,
reflectionDescription: `In this guide, you’ll learn how to create a Locking Module Provider and the methods you must implement in its main service.`,
frontmatterData: {
slug: "/references/locking-module-provider",
tags: ["locking", "server", "how to"],
@@ -86,7 +86,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/medusa/payment",
resolve: "@medusajs/medusa/locking",
options: {
providers: [
{
@@ -130,7 +130,7 @@ The Locking Module will now use your provider to handle all locking operations.
reflectionGroups: {
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn about the different methods in the Locking Module's service and how to use them.`,
reflectionDescription: `In this guide, you’ll learn about the different methods in the Locking Module's service and how to use them.`,
frontmatterData: {
slug: "/references/locking-service",
tags: ["locking", "server", "how to"],

1
www/utils/packages/typedoc-generate-references/src/constants/references.ts
View File

@@ -38,6 +38,7 @@ const allReferences = [
"workflows",
"locking",
"cache",
"caching",
"event",
"file-service",
"notification-service",