Inherit default values for EntityCacheOption.Enabled and EntityCacheOption.Level from RuntimeCacheOptions by aaronburtle · Pull Request #3155 · Azure/data-api-builder

aaronburtle · 2026-02-24T21:44:13Z

Why make this change?

What is this change?

Instead of having static default values for the EntityCacheOptions.Enabled and EntityCacheOptions.Level, we inherit these default values from the RuntimeCacheOptions.

How was this tested?

We add a test that validates the new behavior in CachingConfigProcessingTests

Sample Request(s)

Example REST and/or GraphQL request to demonstrate modifications
Example of CLI usage to demonstrate modifications

…tting

Copilot

Pull request overview

This pull request implements inheritance of default values for entity-level cache configuration from runtime-level cache configuration. When entities don't explicitly configure cache.enabled or cache.level, they now inherit these values from the global runtime cache settings, addressing issue #3149.

Changes:

Entity cache enabled state inherits from runtime cache enabled state when not explicitly configured
Entity cache level inherits from runtime cache Level2 configuration (L1L2 if Level2 enabled, otherwise L1) when not explicitly configured
Removed exceptions from GetEntityCacheEntryTtl and GetEntityCacheEntryLevel methods when caching is disabled, as these methods can now be safely called to retrieve inherited defaults

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/Service.Tests/Caching/CachingConfigProcessingTests.cs	Added comprehensive test coverage for entity cache inheritance behavior from runtime cache settings
src/Core/Resolvers/SqlQueryEngine.cs	Updated to use new `IsEntityCachingEnabled()` method instead of entity property for inheritance-aware caching checks
src/Config/ObjectModel/RuntimeConfig.cs	Added `IsEntityCachingEnabled()` and `GlobalCacheEntryLevel()` methods; updated `GetEntityCacheEntryTtl/Level()` to support inheritance
src/Config/ObjectModel/RuntimeCacheOptions.cs	Added `InferredLevel` property to compute cache level from Level2 configuration
src/Config/ObjectModel/EntityCacheOptions.cs	Added `UserProvidedEnabledOptions` flag and updated constructor to track explicit vs inherited enabled state

src/Config/ObjectModel/EntityCacheOptions.cs

JerryNixon

Same as the other PR: If the old Entity.IsCachingEnabled incorporated additional logic (for example: entity absent cache block, entity defaults, or other gating like unsupported entity types), this change could enable caching where it previously wouldn’t, or vice-versa.

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

src/Config/ObjectModel/RuntimeConfig.cs

src/Config/ObjectModel/EntityCacheOptions.cs

src/Service.Tests/Caching/CachingConfigProcessingTests.cs

RubenCerna2079

LGTM! Just need to resolve comments by copilot.

aaronburtle · 2026-02-26T21:00:24Z

/azp run

azure-pipelines · 2026-02-26T21:00:50Z

Azure Pipelines successfully started running 6 pipeline(s).

Aniruddh25 · 2026-02-26T23:48:53Z

src/Config/ObjectModel/EntityCacheOptions.cs

    [JsonConstructor]
    public EntityCacheOptions(bool? Enabled = null, int? TtlSeconds = null, EntityCacheLevel? Level = null)
    {
-        // TODO: shouldn't we apply the same "UserProvidedXyz" logic to Enabled, too?


Dont we need the "UserProvidedxyz" logic to Enabled?

I don't think so, because in the case that it is not user provided the value will be null, that let's us distinguish between if its user set or not.

Aniruddh25 · 2026-02-26T23:52:02Z

src/Config/ObjectModel/RuntimeConfig.cs

+    {
+        return Runtime?.Cache is not null
+            ? Runtime.Cache.InferredLevel
+            : EntityCacheOptions.DEFAULT_LEVEL;


The Default cache level when level 2 Cache section is NOT specified in runtime is L1 (as is evident from the InferredCacheLevel). But for EntityCacheOptions.DEFAULT_LEVEL it seems to be L1L2. Is that accurate and what we want?

This is misleading because for us to get to the default level here, caching would be turned off at the runtime level. I will update so it isn't confusing.

Aniruddh25 · 2026-03-03T22:30:48Z

src/Config/Converters/EntityCacheOptionsConverterFactory.cs

            if (reader.TokenType is JsonTokenType.StartObject)
            {
-                bool? enabled = false;
+                // Default to null (unset) so that an empty cache object ("cache": {})


Fix PR description. The following should be deleted - its remnant from the template.

Sample Request(s)
Example REST and/or GraphQL request to demonstrate modifications
Example of CLI usage to demonstrate modifications

Aniruddh25 · 2026-03-04T00:34:34Z

src/Config/ObjectModel/RuntimeConfig.cs

+    /// <param name="entityName">Name of the entity to check cache configuration.</param>
+    /// <returns>Whether caching is enabled for the entity.</returns>
+    /// <exception cref="DataApiBuilderException">Raised when an invalid entity name is provided.</exception>
+    public virtual bool IsEntityCachingEnabled(string entityName)


What happened to the function IsCachingEnabled defined in Entity.cs? Are we deleting that? If not, where would that be called now?

If we are deleting, this function should be defined in Entity.cs itself or simply modify the existing IsCachingEnabled function. We do not need to introduce this new function.

Aniruddh25 · 2026-03-04T00:41:39Z

src/Service.Tests/Caching/CachingConfigProcessingTests.cs

+    [DataRow(@",""cache"": { ""enabled"": true }", EntityCacheLevel.L1, DisplayName = "Global cache enabled, no Level2: inferred level is L1.")]
+    [DataRow(@",""cache"": { ""enabled"": true, ""level-2"": { ""enabled"": true } }", EntityCacheLevel.L1L2, DisplayName = "Global cache enabled, Level2 enabled: inferred level is L1L2.")]
+    [DataRow(@",""cache"": { ""enabled"": true, ""level-2"": { ""enabled"": false } }", EntityCacheLevel.L1, DisplayName = "Global cache enabled, Level2 disabled: inferred level is L1.")]
+    [DataRow(@"", EntityCacheLevel.L1L2, DisplayName = "No global cache: default level is L1L2.")]


default level when no global cache should be L1. Similar to the case above when Global cache is enabled but L2 is not specified, L1 is preferred.

Aniruddh25 · 2026-03-04T00:51:20Z

src/Service.Tests/Caching/CachingConfigProcessingTests.cs

+    /// <param name="entityCacheConfig">Entity cache configuration JSON fragment.</param>
+    /// <param name="expectedLevel">Expected cache level returned by GetEntityCacheEntryLevel.</param>
+    [DataRow(@",""cache"": { ""enabled"": true, ""level-2"": { ""enabled"": true } }", @",""cache"": { ""enabled"": true }", EntityCacheLevel.L1L2, DisplayName = "Level2 enabled, entity has no level: inherits L1L2 from runtime.")]
+    [DataRow(@",""cache"": { ""enabled"": true }", @",""cache"": { ""enabled"": true }", EntityCacheLevel.L1, DisplayName = "No Level2, entity has no level: inherits L1 from runtime.")]


This DataRow

[DataRow(@",""cache"": { ""enabled"": true }", @",""cache"": { ""enabled"": true }"

has the same effect as the one in the above test:

[DataRow(@",""cache"": { ""enabled"": true }", EntityCacheLevel.L1, DisplayName = "Global cache enabled, no Level2: inferred level is L1.")]

Please go through each DataRow in this test and above to ensure we only have unique cases. The two test methods can be combined into a single method with multiple DataRows to check for level.

Aniruddh25

Fix the duplicate tests with similar DataRows.

aaronburtle added 2 commits February 24, 2026 11:23

take default for entity cache enabled and level from runtime cache se…

340ef73

…tting

include test for new behavior

44c8335

Copilot AI review requested due to automatic review settings February 24, 2026 21:44

aaronburtle requested review from Alekhya-Polavarapu, Aniruddh25, JerryNixon, RubenCerna2079, anushakolan, rusamant, sourabh1007, souvikghosh04, stuartpa and vadeveka as code owners February 24, 2026 21:44

Copilot started reviewing on behalf of aaronburtle February 24, 2026 21:44 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

src/Config/ObjectModel/EntityCacheOptions.cs Outdated Show resolved Hide resolved

JerryNixon approved these changes Feb 24, 2026

View reviewed changes

JerryNixon requested a review from Copilot February 24, 2026 22:21

Copilot started reviewing on behalf of JerryNixon February 24, 2026 22:22 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

addressing comments

eea3044

RubenCerna2079 approved these changes Feb 26, 2026

View reviewed changes

aaronburtle added 4 commits February 26, 2026 12:34

merge conflicts

5649f2b

revert accidental change

07a2bd9

addressing comments

6039a1e

cleanup

d808b30

Aniruddh25 reviewed Feb 26, 2026

View reviewed changes

Aniruddh25 reviewed Mar 3, 2026

View reviewed changes

Aniruddh25 reviewed Mar 4, 2026

View reviewed changes

Aniruddh25 requested changes Mar 4, 2026

View reviewed changes

Aniruddh25 added the 2.0 label Mar 4, 2026

Conversation

aaronburtle commented Feb 24, 2026

Why make this change?

What is this change?

How was this tested?

Sample Request(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

JerryNixon left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RubenCerna2079 left a comment

Choose a reason for hiding this comment

Uh oh!

aaronburtle commented Feb 26, 2026

Uh oh!

azure-pipelines bot commented Feb 26, 2026

Uh oh!

Aniruddh25 Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

aaronburtle Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronburtle Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Aniruddh25 Feb 26, 2026 •

edited

Loading

Aniruddh25 Mar 4, 2026 •

edited

Loading

Aniruddh25 Mar 4, 2026 •

edited

Loading