quiesce-plan-cache (#521)

Summary:

- Current implementation of plan cache provdes zero benefit.
- Logic needs rework.
- This change quiesces the plan cache until such time as the requisite work is prioritised.

Author: general-kroll-4-life

.github/goreleaser/.goreleaser-for-darwin.yaml

@@ -28,7 +28,7 @@ builds:
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildCommitSHA={{.FullCommit}}
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildShortCommitSHA={{.ShortCommit}}
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildDate={{.Date}}
-      -X stackql/internal/stackql/planbuilder.PlanCacheEnabled=true
+      -X stackql/internal/stackql/planbuilder.PlanCacheEnabled=false
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildPlatform={{.Os}}
 
 archives:

.github/goreleaser/.goreleaser-for-linux.yaml

@@ -34,7 +34,7 @@ builds:
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildCommitSHA={{.FullCommit}}
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildShortCommitSHA={{.ShortCommit}}
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildDate={{.Date}}
-      -X stackql/internal/stackql/planbuilder.PlanCacheEnabled=true
+      -X stackql/internal/stackql/planbuilder.PlanCacheEnabled=false
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildPlatform={{.Os}}
 
 archives:

.github/goreleaser/.goreleaser-for-windows.yaml

@@ -29,7 +29,7 @@ builds:
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildCommitSHA={{.FullCommit}}
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildShortCommitSHA={{.ShortCommit}}
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildDate={{.Date}}
-      -X stackql/internal/stackql/planbuilder.PlanCacheEnabled=true
+      -X stackql/internal/stackql/planbuilder.PlanCacheEnabled=false
       -X github.com/stackql/stackql/internal/stackql/cmd.BuildPlatform={{.Os}}
 
 archives:

.github/workflows/build.yml

@@ -30,7 +30,7 @@ env:
   TESTSCRIPT: "test/python/main.py"
   GOPRIVATE: github.com/stackql/*
   GH_ACCESS_TOKEN: ${{ secrets.ACTIONS_PRIVATE_PACKAGE_SECRET }}
-  PLANCACHEENABLED: "true"
+  PLANCACHEENABLED: "false"
   CI_IS_EXPRESS: ${{ github.ref_type == 'tag' && contains(github.ref_name, 'express') && 'true' || 'false' }}
   STACKQL_IMAGE_NAME: ${{ vars.STACKQL_IMAGE_NAME != '' && vars.STACKQL_IMAGE_NAME || (github.repository == 'stackql/stackql' ||  github.repository == 'stackql/stackql-devel') && github.repository || 'stackql/stackql' }}
 

Dockerfile

@@ -26,7 +26,7 @@ ARG BUILDPATCHVERSION="1"
 ARG BUILDCOMMITSHA="1"
 ARG BUILDSHORTCOMMITSHA="1"
 ARG BUILDDATE="1"
-ARG PLANCACHEENABLED="1"
+ARG PLANCACHEENABLED="false"
 ARG BUILDPLATFORM="1"
 ARG RUN_INTEGRATION_TESTS="1"
 
@@ -115,7 +115,7 @@ ARG BUILDPATCHVERSION="1"
 ARG BUILDCOMMITSHA="1"
 ARG BUILDSHORTCOMMITSHA="1"
 ARG BUILDDATE="1"
-ARG PLANCACHEENABLED="1"
+ARG PLANCACHEENABLED="false"
 ARG BUILDPLATFORM="1"
 ARG RUN_INTEGRATION_TESTS
 

cicd/python/build.py

@@ -6,6 +6,8 @@
 import os
 import subprocess
 
+_DEFAULT_PLANCACHEENABLED = 'false'
+
 
 def build_stackql(verbose :bool) -> int:
     os.environ['BUILDMAJORVERSION'] = os.environ.get('BUILDMAJORVERSION', '1')
@@ -19,7 +21,7 @@ def build_stackql(verbose :bool) -> int:
         f'-X github.com/stackql/stackql/internal/stackql/cmd.BuildCommitSHA={os.environ.get("BUILDCOMMITSHA", "")} '
         f'-X github.com/stackql/stackql/internal/stackql/cmd.BuildShortCommitSHA={os.environ.get("BUILDCOMMITSHA", "")[0:7 or None]} '
         f"-X 'github.com/stackql/stackql/internal/stackql/cmd.BuildDate={os.environ.get('BUILDDATE', '')}' "
-        f"-X 'stackql/internal/stackql/planbuilder.PlanCacheEnabled={os.environ.get('PLANCACHEENABLED', '')}' "
+        f"-X 'stackql/internal/stackql/planbuilder.PlanCacheEnabled={os.environ.get('PLANCACHEENABLED', _DEFAULT_PLANCACHEENABLED)}' "
         f'-X github.com/stackql/stackql/internal/stackql/cmd.BuildPlatform={os.environ.get("BUILDPLATFORM", "")}" '
         '-o build/ ./stackql',
         shell=True

docs/developer_guide.md

@@ -48,7 +48,7 @@ As of now, `stackql` handles `xml` SERDE through the core, and does not route th
 ## Building locally
 
 ```bash
-env CGO_ENABLED=1 go build \
+env CGO_ENABLED=1 PLANCACHEENABLED=false go build \
   --tags "sqlite_stackql" \
   -ldflags "-X github.com/stackql/stackql/internal/stackql/cmd.BuildMajorVersion=${BUILDMAJORVERSION:-1} \
   -X github.com/stackql/stackql/internal/stackql/cmd.BuildMinorVersion=${BUILDMINORVERSION:-1} \

internal/stackql/planbuilder/plan_builder.go

@@ -30,14 +30,19 @@ import (
 	"github.com/stackql/stackql-parser/go/vt/sqlparser"
 )
 
+const (
+	negativePlanCacheEnabled = "false"
+	defaultPlanCacheEnabled  = negativePlanCacheEnabled
+)
+
 var (
 	// only string "false" will disable.
-	PlanCacheEnabled string           = "true" //nolint:revive,gochecknoglobals // acceptable
+	PlanCacheEnabled string           = defaultPlanCacheEnabled //nolint:revive,gochecknoglobals // acceptable
 	_                planGraphBuilder = &standardPlanGraphBuilder{}
 )
 
 func isPlanCacheEnabled() bool {
-	return strings.ToLower(PlanCacheEnabled) != "false"
+	return strings.ToLower(PlanCacheEnabled) != negativePlanCacheEnabled
 }
 
 type planGraphBuilder interface {