Skip to content

docs(tasks): add Cache-Aside task (type 18) - #19

Merged
yilmaztayfun merged 1 commit into
burgan-tech:mainfrom
yldz-eren:docs/cache-aside-task
Jul 21, 2026
Merged

docs(tasks): add Cache-Aside task (type 18)#19
yilmaztayfun merged 1 commit into
burgan-tech:mainfrom
yldz-eren:docs/cache-aside-task

Conversation

@yldz-eren

@yldz-eren yldz-eren commented Jul 20, 2026

Copy link
Copy Markdown

Özet

Yeni Cache-Aside (read-through) task'ını (TaskType 18) belgeler. State Store (type 17) task sayfasıyla birebir aynı format/bölümlerde.

vnext runtime tarafındaki implementasyon: burgan-tech/vnext PR #814 (sprint15-26/CacheAside).

Değişiklikler

  • docs/components/tasks/cache-aside.md — yeni (TR)
  • i18n/en/.../components/tasks/cache-aside.md — yeni (EN)
  • sidebars.ts — State Store'dan sonra cache-aside girişi
  • docs/components/tasks/index.md (TR) + EN index — task sayısı 17→18, yeni satır

İçerik

Read-through akışı (hit → cached dön, miss → sourceTask çalıştır → sourceMapping ile şekillendir → TTL+consistency ile cache'le), config alanları (key, storeName, ttlInSeconds, consistency, sourceTask, sourceMapping, bypassOnCacheError, forceRefresh), mimari (cache I/O Execution cacheaside invoker'ında, StateStore ile ortak custom: prefix), dinamik anahtar (mapping InputHandler → task.SetCacheKey), örnekler ve standart yanıt.

🤖 Generated with Claude Code

Summary by Sourcery

Document the new Cache-Aside Task (type 18) and add it to the task type listings and sidebar navigation.

Documentation:

  • Add Turkish and English documentation pages for the Cache-Aside (read-through) task explaining configuration, behavior, and examples.
  • Update Turkish and English task index pages to state there are 18 task types and include CacheAsideTask in the listing.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the new Cache-Aside Task (Type 18), including cache hits, misses, refresh behavior, configuration, key generation, error handling, and response metadata.
    • Updated the task type documentation to list 18 supported task types and include CacheAsideTask.
    • Added the Cache-Aside Task page to the documentation sidebar.

Documents the new Cache-Aside (read-through) task type, mirroring the State Store
task page format. Adds TR + EN pages, sidebar entry, and index table row (17→18).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@yldz-eren
yldz-eren requested a review from a team July 20, 2026 14:33
@sourcery-ai

sourcery-ai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Reviewer's Guide

Documents the new Cache-AsideTask (task type 18) in both TR and EN docs, wires it into the tasks index and sidebar navigation, and explains its configuration, runtime behavior, and relationship to the existing StateStore task.

Sequence diagram for CacheAsideTask read-through behavior

sequenceDiagram
    actor Orchestration
    participant CacheAsideTaskExecutor
    participant CacheAsideTaskInvoker
    participant StateStore
    participant SourceTaskInvoker

    Orchestration->>CacheAsideTaskExecutor: execute CacheAsideTask
    CacheAsideTaskExecutor->>CacheAsideTaskInvoker: cacheaside TaskEnvelope

    alt [cache read]
        CacheAsideTaskInvoker->>StateStore:
        StateStore-->>CacheAsideTaskInvoker: cached value
        CacheAsideTaskInvoker-->>CacheAsideTaskExecutor: raw cached result
    else [cache miss or forceRefresh]
        CacheAsideTaskInvoker->>StateStore:
        StateStore-->>CacheAsideTaskInvoker: not found
        CacheAsideTaskInvoker->>SourceTaskInvoker: sourceTask envelope
        SourceTaskInvoker-->>CacheAsideTaskInvoker: raw source result
        CacheAsideTaskInvoker->>StateStore:
        StateStore-->>CacheAsideTaskInvoker: stored
        CacheAsideTaskInvoker-->>CacheAsideTaskExecutor: raw source result
    end

    CacheAsideTaskExecutor-->>Orchestration: shaped result via sourceMapping OutputHandler
Loading

File-Level Changes

Change Details Files
Add full Turkish documentation page for Cache-Aside Task (type 18), mirroring State Store task doc structure and detailing behavior, configuration, and semantics.
  • Create new TR doc page describing Cache-Aside Task read-through flow (hit/miss/forceRefresh) and when sourceTask runs
  • Document config fields such as key, storeName, ttlInSeconds, consistency, sourceTask, sourceMapping, bypassOnCacheError, and forceRefresh
  • Explain architecture split between CacheAsideTaskExecutor and CacheAsideTaskInvoker and sharing of IStateStoreClient/custom: prefix with StateStore
  • Describe dynamic cache key resolution via InputHandler and task.SetCacheKey, plus standard response shape and metadata fields
docs/components/tasks/cache-aside.md
Add full English documentation page for Cache-Aside Task (type 18) aligned with the TR version and runtime implementation details.
  • Create new EN doc page for Cache-Aside Task with definition, configuration table, and read-through flow
  • Describe architecture (orchestration vs execution), raw-result caching, and application of sourceMapping on read
  • Document semantics for cache errors, source task failures, and remotely-invokable sourceTask requirement
  • Provide usage examples for simple caching, forceRefresh, and sourceMapping, plus standard response payload
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
Register Cache-AsideTask as task type 18 in both Turkish and English task index documents, including its description and detail link. i18n/en/docusaurus-plugin-content-docs/current/components/tasks/index.md
docs/components/tasks/index.md
Expose the new Cache-Aside Task documentation in the sidebar navigation after State Store task.
  • Add components/tasks/cache-aside to the tasks section of the Docusaurus sidebar immediately after state-store entry
sidebars.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added comprehensive CacheAsideTask type 18 documentation in English and localized task pages, including configuration, execution semantics, examples, response metadata, and dynamic cache keys. Updated task counts, catalog entries, and sidebar navigation.

Changes

Cache-Aside Task

Layer / File(s) Summary
Cache-aside contract and execution semantics
docs/components/tasks/cache-aside.md, i18n/en/.../components/tasks/cache-aside.md
Documents type 18 schema, cache hit/miss and refresh behavior, configuration fields, runtime responsibilities, key naming, and error handling.
Dynamic keys, examples, and responses
docs/components/tasks/cache-aside.md, i18n/en/.../components/tasks/cache-aside.md
Adds SetCacheKey guidance, usage examples, source mapping, response metadata, and related links.
Task catalog and sidebar registration
docs/components/tasks/index.md, i18n/en/.../components/tasks/index.md, sidebars.ts
Updates supported task counts, adds CacheAsideTask, and registers the new page in navigation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related issues

  • burgan-tech/vnext issue 801 — Covers the same CacheAside task type, behavior, and configuration documented by this PR.

Suggested reviewers: yilmaztayfun

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: adding the Cache-Aside task documentation for type 18.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces documentation for the new Cache-Aside Task (Type 18) in both Turkish and English, updating the task index files and the sidebar configuration accordingly. The review feedback suggests using relative paths instead of absolute paths for internal links in the "Related" section of both documentation files to ensure that Docusaurus localization (i18n) and versioning function correctly without losing the language context.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +172 to +173
- [Tasks Genel Bakış](/docs/components/tasks/) — task türleri ve referans mekanizması
- [State Store Task](/docs/components/tasks/state-store) — paylaşılan cache primitifi (get/set/delete); aynı `custom:` prefix ve state store

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Docusaurus üzerinde yerelleştirme (i18n) ve versiyonlama desteğinin sağlıklı çalışabilmesi için mutlak (absolute) yollar yerine göreceli (relative) yolların kullanılması önerilir. Mutlak yollar (/docs/...), İngilizce (/en/docs/...) gibi farklı dillerdeki sayfalardan tıklandığında kullanıcının dil bağlamını kaybetmesine ve varsayılan dile yönlenmesine neden olur.

Suggested change
- [Tasks Genel Bakış](/docs/components/tasks/) — task türleri ve referans mekanizması
- [State Store Task](/docs/components/tasks/state-store) — paylaşılan cache primitifi (get/set/delete); aynı `custom:` prefix ve state store
- [Tasks Genel Bakış](./) — task türleri ve referans mekanizması
- [State Store Task](./state-store) — paylaşılan cache primitifi (get/set/delete); aynı custom: prefix ve state store

Comment on lines +172 to +173
- [Tasks Overview](/docs/components/tasks/) — task types and the reference mechanism
- [State Store Task](/docs/components/tasks/state-store) — the shared caching primitive (get/set/delete); same `custom:` prefix and state store

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Docusaurus üzerinde yerelleştirme (i18n) ve versiyonlama desteğinin sağlıklı çalışabilmesi için mutlak (absolute) yollar yerine göreceli (relative) yolların kullanılması önerilir. Mutlak yollar (/docs/...), İngilizce (/en/docs/...) gibi farklı dillerdeki sayfalardan tıklandığında kullanıcının dil bağlamını kaybetmesine ve varsayılan dile yönlenmesine neden olur.

Suggested change
- [Tasks Overview](/docs/components/tasks/) — task types and the reference mechanism
- [State Store Task](/docs/components/tasks/state-store) — the shared caching primitive (get/set/delete); same `custom:` prefix and state store
- [Tasks Overview](./) — task types and the reference mechanism
- [State Store Task](./state-store) — the shared caching primitive (get/set/delete); same custom: prefix and state store

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/components/tasks/cache-aside.md`:
- Around line 1-4: Add the required frontmatter to both cache-aside
documentation pages: in docs/components/tasks/cache-aside.md, define stable
Turkish id, slug, and sidebar_label values; in
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md,
preserve the source id and slug while translating title and sidebar_label.
- Around line 44-55: Add the missing enum reference table for the consistency
field in docs/components/tasks/cache-aside.md (lines 44-55), using Turkish
descriptions, and in
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
(lines 44-55), using English descriptions. Document the supported values
Eventual and Strong consistently with the inline field descriptions.
- Around line 134-143: Update the sourceMapping heading and surrounding wording
in docs/components/tasks/cache-aside.md:134-143 and
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md:134-143
to state that mapping shapes the returned value, while the raw result is what
gets cached and mapping runs only on read. Keep both language versions
semantically consistent with the architecture section.
- Around line 105-146: The Turkish examples in
docs/components/tasks/cache-aside.md lines 105-146 and the corresponding English
examples in
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
lines 105-146 need links to working examples. Add specific full GitHub links to
the burgan-tech/vnext-example repository for the inline examples on both pages,
using the appropriate language-specific examples while preserving the existing
documentation content.
- Line 50: Align the ttlInSeconds descriptions in
docs/components/tasks/cache-aside.md (line 50) and
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
(line 50) with the State Store contract by removing the claim that 0 means no
expiry and documenting the valid minimum of 1, or explicitly documenting the
cache-aside exception if that behavior is intentional.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9d8f8d6f-94ef-4a82-bac5-ec70448983c0

📥 Commits

Reviewing files that changed from the base of the PR and between 6563b9c and d8a28d8.

📒 Files selected for processing (5)
  • docs/components/tasks/cache-aside.md
  • docs/components/tasks/index.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/index.md
  • sidebars.ts

Comment on lines +1 to +4
---
sidebar_position: 14
title: Cache-Aside Task
description: Bir kaynağın sonucunu read-through (cache-aside) deseni ile cache'leyen task

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add required metadata to both documentation pages.

Both pages omit required frontmatter metadata.

  • docs/components/tasks/cache-aside.md#L1-L4: add stable Turkish id, slug, and sidebar_label.
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L1-L4: preserve the source id/slug and translate title/sidebar_label.
📍 Affects 2 files
  • docs/components/tasks/cache-aside.md#L1-L4 (this comment)
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L1-L4
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/components/tasks/cache-aside.md` around lines 1 - 4, Add the required
frontmatter to both cache-aside documentation pages: in
docs/components/tasks/cache-aside.md, define stable Turkish id, slug, and
sidebar_label values; in
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md,
preserve the source id and slug while translating title and sidebar_label.

Source: Coding guidelines

Comment on lines +44 to +55
## Konfigürasyon Alanları

| Alan | Tip | Zorunlu | Açıklama |
|------|-----|---------|----------|
| `key` | string | Evet* | Cache anahtarı; **verbatim** kullanılır. Dinamik anahtar için transition mapping'inin `InputHandler`'ı `task.SetCacheKey(...)` çağırır (State Store task'ındaki standart mekanizmanın aynısı). *Statik `key` yoksa anahtar mapping ile set edilmelidir |
| `storeName` | string | Hayır | Cache olarak kullanılacak Dapr state store bileşen adı. Boş bırakılırsa çalışan runtime'ın `DAPR_STATE_STORE_NAME` konfigürasyon değeri kullanılır |
| `ttlInSeconds` | integer | Hayır | Cache kaydının time-to-live süresi (Dapr `ttlInSeconds` metadata'sı). Belirtilmezse veya `0` ise kayıt **süresizdir** |
| `consistency` | string | Hayır | `Eventual` (varsayılan) veya `Strong` — okuma ve yazmada state store'a geçirilir |
| `sourceTask` | object | Evet | Cache miss'te çalıştırılan task referansı (`key` / `domain` / `flow` / `version`). **Uzaktan invoke edilebilir** bir tip olmalıdır (HTTP / SOAP / Dapr / GetInstanceData). `flow` verilmezse runtime tasks şeması varsayılır |
| `sourceMapping` | object | Hayır | Cache'lenmiş (ham) sonucu döndürmeden önce şekillendiren `.csx` mapping (`location` + base64 `code`). Mapping'in `OutputHandler`'ı olarak, hem hit hem miss durumunda **okuma anında** çalışır |
| `bypassOnCacheError` | boolean | Hayır | `true` (varsayılan): cache okuma/yazma hataları pipeline'ı düşürmek yerine source task'a fallback yapar. `false`: cache hataları task başarısızlığı olarak yüzeye çıkar (error boundary uygulanır) |
| `forceRefresh` | boolean | Hayır | `true`: cache okuma atlanır; source task her zaman çalıştırılır ve kayıt üzerine yazılır |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Complete the component reference template.

Both pages document the fixed consistency values inline but omit the required enum table.

  • docs/components/tasks/cache-aside.md#L44-L55: add the Turkish enum table.
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L44-L55: add the English enum table.
📍 Affects 2 files
  • docs/components/tasks/cache-aside.md#L44-L55 (this comment)
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L44-L55
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/components/tasks/cache-aside.md` around lines 44 - 55, Add the missing
enum reference table for the consistency field in
docs/components/tasks/cache-aside.md (lines 44-55), using Turkish descriptions,
and in
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
(lines 44-55), using English descriptions. Document the supported values
Eventual and Strong consistently with the inline field descriptions.

Source: Coding guidelines

|------|-----|---------|----------|
| `key` | string | Evet* | Cache anahtarı; **verbatim** kullanılır. Dinamik anahtar için transition mapping'inin `InputHandler`'ı `task.SetCacheKey(...)` çağırır (State Store task'ındaki standart mekanizmanın aynısı). *Statik `key` yoksa anahtar mapping ile set edilmelidir |
| `storeName` | string | Hayır | Cache olarak kullanılacak Dapr state store bileşen adı. Boş bırakılırsa çalışan runtime'ın `DAPR_STATE_STORE_NAME` konfigürasyon değeri kullanılır |
| `ttlInSeconds` | integer | Hayır | Cache kaydının time-to-live süresi (Dapr `ttlInSeconds` metadata'sı). Belirtilmezse veya `0` ise kayıt **süresizdir** |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf 'FILES:\n'
git ls-files | rg '(^|/)(docs/components/tasks/cache-aside\.md|i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside\.md|.*state.*store.*|.*ttlInSeconds.*|.*cache-aside.*)$' || true

printf '\nSEARCH ttlInSeconds:\n'
rg -n --hidden --glob '!**/node_modules/**' 'ttlInSeconds|TTL|Time-to-live|state store|State Store' docs i18n . 2>/dev/null | sed -n '1,240p'

Repository: burgan-tech/vnext-docs

Length of output: 30286


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf 'CACHE-ASIDE (TR/EN) TTL SECTION:\n'
sed -n '40,60p' docs/components/tasks/cache-aside.md
printf '\n---\n'
sed -n '40,60p' i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md

printf '\nSTATE-STORE (TR/EN) TTL SECTION:\n'
sed -n '40,58p' docs/components/tasks/state-store.md
printf '\n---\n'
sed -n '40,58p' i18n/en/docusaurus-plugin-content-docs/current/components/tasks/state-store.md

Repository: burgan-tech/vnext-docs

Length of output: 6488


🌐 Web query:

Dapr state store ttlInSeconds 0 no expiry minimum 1 documentation

💡 Result:

In Dapr, the behavior of ttlInSeconds regarding expiration and persistence is as follows: 1. To indicate that a specific state record should never expire (persist indefinitely) and to ignore any default TTL policies (whether set globally in the Dapr component or at the database level), you should set ttlInSeconds to -1 [1][2]. 2. When ttlInSeconds is set to 0, it typically does not signify "no expiry." Instead, for many Dapr state store components, setting ttlInSeconds to a value of 0 or less as a global default in the component configuration means that no default TTL is applied [3]. In this scenario, items will only expire if a TTL is explicitly provided in the request metadata [3]. In summary, use -1 to explicitly persist data indefinitely [1], while 0 is generally used to disable the application of a default TTL policy [3]. Always verify the specific behavior for your chosen state store component, as support for TTL features can vary between implementations [1][4].

Citations:


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf 'TTL VALIDATION / TASK IMPLEMENTATION SEARCH:\n'
rg -n --hidden --glob '!**/node_modules/**' 'ttlInSeconds|minimum: 1|no expiry|never expire|CacheAsideTask|StateStoreTask|SetCacheKey|IStateStoreClient' . 2>/dev/null | sed -n '1,260p'

Repository: burgan-tech/vnext-docs

Length of output: 8948


Align ttlInSeconds semantics across both cache-aside docs. docs/components/tasks/cache-aside.md and its English mirror say 0 means no expiry, but the State Store task already documents ttlInSeconds as minimum: 1. Make the cache-aside wording match that contract, or call out an explicit exception.

📍 Affects 2 files
  • docs/components/tasks/cache-aside.md#L50-L50 (this comment)
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L50-L50
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/components/tasks/cache-aside.md` at line 50, Align the ttlInSeconds
descriptions in docs/components/tasks/cache-aside.md (line 50) and
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
(line 50) with the State Store contract by removing the claim that 0 means no
expiry and documenting the valid minimum of 1, or explicitly documenting the
cache-aside exception if that behavior is intentional.

Comment on lines +105 to +146
## Örnekler

### Basit read-through (HTTP source)

```json
"attributes": {
"type": "18",
"config": {
"key": "customer:42:profile",
"storeName": "vnext-state",
"ttlInSeconds": 300,
"sourceTask": { "key": "get-customer-http", "domain": "core", "flow": "sys-tasks", "version": "1.0.0" }
}
}
```

### `forceRefresh` — cache'i her zaman tazele

```json
"attributes": {
"type": "18",
"config": {
"key": "customer:42:profile",
"sourceTask": { "key": "get-customer-http", "domain": "core", "flow": "sys-tasks", "version": "1.0.0" },
"forceRefresh": true
}
}
```

### `sourceMapping` — ham sonucu şekillendirerek cache'le/dön

```json
"attributes": {
"type": "18",
"config": {
"key": "customer:42:profile",
"sourceTask": { "key": "get-customer-http", "domain": "core", "flow": "sys-tasks", "version": "1.0.0" },
"sourceMapping": { "location": "./src/mappings/get-customer-cached.csx", "code": "<base64>" },
"ttlInSeconds": 300
}
}
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add working-example links to both pages.

The inline examples need specific full GitHub links to burgan-tech/vnext-example.

  • docs/components/tasks/cache-aside.md#L105-L146: link the Turkish examples.
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L105-L146: link the English examples.
🧰 Tools
🪛 LanguageTool

[grammar] ~105-~105: Ensure spelling is correct
Context: ...e ile invalidation yapılabilir. ::: ## Örnekler ### Basit read-through (HTTP source) ```jso...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~134-~134: Ensure spelling is correct
Context: ...ue } } ### `sourceMapping` — ham sonucu şekillendirerek cache'le/dön json "...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

📍 Affects 2 files
  • docs/components/tasks/cache-aside.md#L105-L146 (this comment)
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L105-L146
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/components/tasks/cache-aside.md` around lines 105 - 146, The Turkish
examples in docs/components/tasks/cache-aside.md lines 105-146 and the
corresponding English examples in
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md
lines 105-146 need links to working examples. Add specific full GitHub links to
the burgan-tech/vnext-example repository for the inline examples on both pages,
using the appropriate language-specific examples while preserving the existing
documentation content.

Source: Coding guidelines

Comment on lines +134 to +143
### `sourceMapping` — ham sonucu şekillendirerek cache'le/dön

```json
"attributes": {
"type": "18",
"config": {
"key": "customer:42:profile",
"sourceTask": { "key": "get-customer-http", "domain": "core", "flow": "sys-tasks", "version": "1.0.0" },
"sourceMapping": { "location": "./src/mappings/get-customer-cached.csx", "code": "<base64>" },
"ttlInSeconds": 300

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Make sourceMapping semantics consistent with the architecture section.

Both headings imply the mapped value is cached, while the surrounding contract says raw results are cached and mapping runs only on read.

  • docs/components/tasks/cache-aside.md#L134-L143: state that mapping shapes the returned value, not the cached value.
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L134-L143: make the same correction in English.
🧰 Tools
🪛 LanguageTool

[grammar] ~134-~134: Ensure spelling is correct
Context: ...ue } } ### `sourceMapping` — ham sonucu şekillendirerek cache'le/dön json "...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

📍 Affects 2 files
  • docs/components/tasks/cache-aside.md#L134-L143 (this comment)
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md#L134-L143
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/components/tasks/cache-aside.md` around lines 134 - 143, Update the
sourceMapping heading and surrounding wording in
docs/components/tasks/cache-aside.md:134-143 and
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/cache-aside.md:134-143
to state that mapping shapes the returned value, while the raw result is what
gets cached and mapping runs only on read. Keep both language versions
semantically consistent with the architecture section.

@yilmaztayfun
yilmaztayfun merged commit 8a43c54 into burgan-tech:main Jul 21, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants