Enable caching stored procedure results -> REST (GET) GraphQL (Queries)

[seantleonard]

Why make this change?

• Closes [Enhancement] Cache - Stored Procedure Support #2299
• Enabling DAB's cache only worked for generic table/view queries (REST: GET, GraphQL: queries). Stored procedure results were always fetched from the database.
• This change enables caching for stored procedure results when the stored procedure is configured as such:

"entities": {
  "MyStoredProcedureEntity": {
    "source": {
      "type": "stored-procedure",
      "object": "dbo.spExample"
    },
    "graphql": {
      "operation": "query"
    },
    "rest": {
      "methods": [ "GET" ]
    },
    "cache": {
      "enabled": true,
      "ttl-seconds": 5
    },
    "permissions": [
      {
        "role": "anonymous",
        "actions": [
          "execute"
        ]
      }
    ]
  }

What is this change?

• Updates DAB's SqlQueryEngine function private async Task<JsonDocument?> ExecuteAsync(SqlExecuteStructure structure, string dataSourceName) to utilize DAB's cache service.
• The code now checks whether caching is enabled globally:
  • RuntimeConfig.Cache.Enabled is true
  • RuntimeConfig.DataSource.Options.SetSessionContext is false
• The cache service is invoked with type JsonArray : _cache.GetOrSetAsync<JsonArray?>(...)

How was this tested?

• Integration Tests
• Unit Tests: tests that cache invocation with type JsonArray succeeds. This covers how stored procedures are executed in the query engine.

Sample Request(s)

Dab config: use example entity at top of this description.
Example stored procedure:

create procedure [dbo].[stp_Dummy]
@mandatoryParam int,
@optionalParam int = 10
as
select 
    @mandatoryParam as mandatoryParam,
    @optionalParam as optionalParam
GO

REST

GET http://localhost:5000/api/Dummy?mandatoryParam=123&optionalParam=2345

GraphQL

query mySP{
  executeDummy {
    mandatoryParam
    optionalParam
  }
}

[abhishekkumams]

how would it work, when caching is disabled globally but enabled at entity level or vice-versa?

[seantleonard]

how would it work, when caching is disabled globally but enabled at entity level or vice-versa?

@abhishekkumams
For caching:

1. Global cache must be enabled (with session context turned off)
2. Entity cache must be turned on + no db policy configured.

[seantleonard]

/azp run

[Aniruddh25]

Would this cache results even if the stored proc has a mutation operation in it? If thats the case, in a cache hit, will the stores proc not be executed? So, for cache hits, we will NOT execute the mutation operation.. Is the responsibility to ensure they enable cache only for READ-ONLY stored procs with our customer developers?

[Aniruddh25]

Looks good, left a few questions and suggestions

[seantleonard]

@Aniruddh25

Would this cache results even if the stored proc has a mutation operation in it?

No, this code is within the QueryEngine so Stored Procedures configured as mutations would not enter this code path.

[abhishekkumams]

/azp run