#1572 Default cache policy to cached for queries with cascade term

Author: SanderMertens

distr/flecs.c

@@ -32130,6 +32130,17 @@ int flecs_query_set_caching_policy(
     bool group_order_by = desc->group_by || desc->group_by_callback || 
             desc->order_by || desc->order_by_callback;
 
+    /* If the query has a Cascade term it'll use group_by */
+    int32_t i, term_count = impl->pub.term_count;
+    const ecs_term_t *terms = impl->pub.terms;
+    for (i = 0; i < term_count; i ++) {
+        const ecs_term_t *term = &terms[i];
+        if (term->src.id & EcsCascade) {
+            group_order_by = true;
+            break;
+        }
+    }
+
     /* If caching policy is default, try to pick a policy that does the right
      * thing in most cases. */
     if (kind == EcsQueryCacheDefault) {
@@ -32152,7 +32163,7 @@ int flecs_query_set_caching_policy(
     /* Don't cache query, even if it has cacheable terms */
     if (kind == EcsQueryCacheNone) {
         impl->pub.cache_kind = EcsQueryCacheNone;
-        if (desc->group_by || desc->order_by) {
+        if (group_order_by && !(impl->pub.flags & EcsQueryNested)) {
             ecs_err("cannot create uncached query with group_by/order_by");
             return -1;
         }
@@ -32186,8 +32197,6 @@ int flecs_query_set_caching_policy(
              * terms, as this would build a cache that contains all tables. */
             int32_t not_optional_terms = 0, cacheable_terms = 0;
             if (!group_order_by) {
-                int32_t i, term_count = impl->pub.term_count;
-                const ecs_term_t *terms = impl->pub.terms;
                 for (i = 0; i < term_count; i ++) {
                     const ecs_term_t *term = &terms[i];
                     if (term->flags_ & EcsTermIsCacheable) {

src/query/api.c

@@ -76,6 +76,17 @@ int flecs_query_set_caching_policy(
     bool group_order_by = desc->group_by || desc->group_by_callback || 
             desc->order_by || desc->order_by_callback;
 
+    /* If the query has a Cascade term it'll use group_by */
+    int32_t i, term_count = impl->pub.term_count;
+    const ecs_term_t *terms = impl->pub.terms;
+    for (i = 0; i < term_count; i ++) {
+        const ecs_term_t *term = &terms[i];
+        if (term->src.id & EcsCascade) {
+            group_order_by = true;
+            break;
+        }
+    }
+
     /* If caching policy is default, try to pick a policy that does the right
      * thing in most cases. */
     if (kind == EcsQueryCacheDefault) {
@@ -98,7 +109,7 @@ int flecs_query_set_caching_policy(
     /* Don't cache query, even if it has cacheable terms */
     if (kind == EcsQueryCacheNone) {
         impl->pub.cache_kind = EcsQueryCacheNone;
-        if (desc->group_by || desc->order_by) {
+        if (group_order_by && !(impl->pub.flags & EcsQueryNested)) {
             ecs_err("cannot create uncached query with group_by/order_by");
             return -1;
         }
@@ -132,8 +143,6 @@ int flecs_query_set_caching_policy(
              * terms, as this would build a cache that contains all tables. */
             int32_t not_optional_terms = 0, cacheable_terms = 0;
             if (!group_order_by) {
-                int32_t i, term_count = impl->pub.term_count;
-                const ecs_term_t *terms = impl->pub.terms;
                 for (i = 0; i < term_count; i ++) {
                     const ecs_term_t *term = &terms[i];
                     if (term->flags_ & EcsTermIsCacheable) {

test/query/project.json

@@ -1627,7 +1627,8 @@
                 "invalid_cascade_for_second",
                 "invalid_desc_without_cascade",
                 "invalid_desc_for_first",
-                "invalid_desc_for_second"
+                "invalid_desc_for_second",
+                "cascade_w_cache_kind_default"
             ]
         }, {
             "id": "Cached",

test/query/src/Cascade.c

@@ -974,7 +974,8 @@ void Cascade_invalid_cascade_for_uncached(void) {
     ecs_log_set_level(-4);
 
     ecs_query_t *q = ecs_query(world, {
-        .expr = "Position(cascade)"
+        .expr = "Position(cascade)",
+        .cache_kind = EcsQueryCacheNone
     });
 
     test_assert(q == NULL);
@@ -1079,3 +1080,22 @@ void Cascade_invalid_desc_for_second(void) {
 
     ecs_fini(world);
 }
+
+void Cascade_cascade_w_cache_kind_default(void) {
+    ecs_world_t *world = ecs_mini();
+    
+    ECS_COMPONENT(world, Position);
+
+    ecs_log_set_level(-4);
+
+    ecs_query_t *q = ecs_query(world, {
+        .expr = "Position(cascade)",
+        .cache_kind = EcsQueryCacheDefault
+    });
+
+    test_assert(q != NULL);
+
+    ecs_query_fini(q);
+
+    ecs_fini(world);
+}

test/query/src/main.c

@@ -1566,6 +1566,7 @@ void Cascade_invalid_cascade_for_second(void);
 void Cascade_invalid_desc_without_cascade(void);
 void Cascade_invalid_desc_for_first(void);
 void Cascade_invalid_desc_for_second(void);
+void Cascade_cascade_w_cache_kind_default(void);
 
 // Testsuite 'Cached'
 void Cached_simple_query_existing_table(void);
@@ -8288,6 +8289,10 @@ bake_test_case Cascade_testcases[] = {
     {
         "invalid_desc_for_second",
         Cascade_invalid_desc_for_second
+    },
+    {
+        "cascade_w_cache_kind_default",
+        Cascade_cascade_w_cache_kind_default
     }
 };
 
@@ -10799,7 +10804,7 @@ static bake_test_suite suites[] = {
         "Cascade",
         NULL,
         NULL,
-        23,
+        24,
         Cascade_testcases
     },
     {