Skip to content

feat: add the possibility to overwrite the cache with the operator #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TrayserCassa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add the possibility to overwrite the cache with the operator #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/v1/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,7 @@ type AppCacheSpec struct {
}

type RedisSpec struct {
RedisDSN string `json:"redisDsn,omitempty"`
RedisHost string `json:"redisHost,omitempty"`
// +kubebuilder:default=6379
RedisPort int `json:"redisPort,omitempty"`
Expand Down
85 changes: 77 additions & 8 deletions api/v1/store_env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ import (
// redis
func (s *Store) getAppCache() []corev1.EnvVar {
if s.Spec.AppCache.Adapter == "redis" {
// If DSN is provided, use it directly
if s.Spec.AppCache.RedisDSN != "" {
return []corev1.EnvVar{
{
Name: "K8S_CACHE_TYPE",
Value: "redis",
},
{
Name: "K8S_REDIS_APP_DSN",
Value: s.Spec.AppCache.RedisDSN,
},
}
}

// Otherwise build from individual fields
return []corev1.EnvVar{
// TODO: Will be moved to yaml configuration
{
Expand Down Expand Up @@ -46,21 +61,63 @@ func (s *Store) getAppCache() []corev1.EnvVar {
}

// Handled by PHP itself
func (s *Store) getSessionCache() []corev1.EnvVar {
// DEPRECATED: (6.7) Use symfony cache instead
func (s *Store) getOldSessionCache() []corev1.EnvVar {
if s.Spec.SessionCache.Adapter == "redis" {
var savePath string
// If DSN is provided, use it directly
if s.Spec.SessionCache.RedisDSN != "" {
savePath = s.Spec.SessionCache.RedisDSN
} else {
// Otherwise build from individual fields
savePath = fmt.Sprintf(
"tcp://%s:%d/%d",
s.Spec.SessionCache.RedisHost,
s.Spec.SessionCache.RedisPort,
s.Spec.SessionCache.RedisIndex,
)
}

return []corev1.EnvVar{
{
Name: "PHP_SESSION_HANDLER",
Value: "redis",
},
{
Name: "PHP_SESSION_SAVE_PATH",
Value: fmt.Sprintf(
"tcp://%s:%d/%d",
s.Spec.SessionCache.RedisHost,
s.Spec.SessionCache.RedisPort,
s.Spec.SessionCache.RedisIndex,
),
Name: "PHP_SESSION_SAVE_PATH",
Value: savePath,
},
}
}
return []corev1.EnvVar{
{
Name: "PHP_SESSION_HANDLER",
Value: "files",
},
}
}

// Added in 6.7
func (s *Store) getSessionCache() []corev1.EnvVar {
if s.Spec.SessionCache.Adapter == "redis" {
var dsn string
// If DSN is provided, use it directly
if s.Spec.SessionCache.RedisDSN != "" {
dsn = s.Spec.SessionCache.RedisDSN
} else {
// Otherwise build from individual fields
dsn = fmt.Sprintf(
"redis://%s:%d/%d",
s.Spec.SessionCache.RedisHost,
s.Spec.SessionCache.RedisPort,
s.Spec.SessionCache.RedisIndex,
)
}

return []corev1.EnvVar{
{
Name: "K8S_REDIS_SESSION_DSN",
Value: dsn,
},
}
}
Expand Down Expand Up @@ -121,6 +178,17 @@ func (f *FPMSpec) getFPMConfiguration() []corev1.EnvVar {
// https://symfony.com/doc/current/messenger.html#transport-configuration
func (s *Store) getWorker() []corev1.EnvVar {
if s.Spec.Worker.Adapter == "redis" {
// If DSN is provided, use it directly
if s.Spec.Worker.RedisDSN != "" {
return []corev1.EnvVar{
{
Name: "MESSENGER_TRANSPORT_DSN",
Value: s.Spec.Worker.RedisDSN,
},
}
}

// Otherwise build from individual fields
return []corev1.EnvVar{
{
Name: "MESSENGER_TRANSPORT_DSN",
Expand Down Expand Up @@ -439,6 +507,7 @@ func (s *Store) GetEnv() []corev1.EnvVar {
})
}

c = append(c, s.getOldSessionCache()...)
c = append(c, s.getSessionCache()...)
c = append(c, s.getAppCache()...)
c = append(c, s.getOtel()...)
Expand Down
234 changes: 234 additions & 0 deletions api/v1/store_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,3 +337,237 @@ func TestEnvMerge(t *testing.T) {
}
}
}

func TestAppCacheRedisDsnOverwrite(t *testing.T) {
t.Run("AppCache with DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
AppCache: v1.AppCacheSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisDSN: "redis://custom-redis:6380/5?password=secret",
},
},
},
}

env := store.GetEnv()
var foundCacheType, foundRedisDSN bool
for _, envVar := range env {
if envVar.Name == "K8S_CACHE_TYPE" {
foundCacheType = true
assert.Equal(t, "redis", envVar.Value)
}
if envVar.Name == "K8S_REDIS_APP_DSN" {
foundRedisDSN = true
assert.Equal(t, "redis://custom-redis:6380/5?password=secret", envVar.Value)
}
// Ensure individual fields are NOT set when DSN is provided
if envVar.Name == "K8S_CACHE_HOST" || envVar.Name == "K8S_CACHE_PORT" || envVar.Name == "K8S_CACHE_INDEX" || envVar.Name == "K8S_CACHE_URL" {
t.Errorf("Individual cache field %s should not be set when DSN is provided", envVar.Name)
}
}
assert.True(t, foundCacheType, "K8S_CACHE_TYPE should be set")
assert.True(t, foundRedisDSN, "K8S_REDIS_APP_DSN should be set with DSN value")
})

t.Run("AppCache without DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
AppCache: v1.AppCacheSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisHost: "redis-host",
RedisPort: 6379,
RedisIndex: 2,
},
},
},
}

env := store.GetEnv()
var foundHost, foundPort, foundIndex, foundURL bool
for _, envVar := range env {
if envVar.Name == "K8S_CACHE_HOST" {
foundHost = true
assert.Equal(t, "redis-host", envVar.Value)
}
if envVar.Name == "K8S_CACHE_PORT" {
foundPort = true
assert.Equal(t, "6379", envVar.Value)
}
if envVar.Name == "K8S_CACHE_INDEX" {
foundIndex = true
assert.Equal(t, "2", envVar.Value)
}
if envVar.Name == "K8S_CACHE_URL" {
foundURL = true
assert.Equal(t, "redis://redis-host:6379/2", envVar.Value)
}
}
assert.True(t, foundHost, "K8S_CACHE_HOST should be set")
assert.True(t, foundPort, "K8S_CACHE_PORT should be set")
assert.True(t, foundIndex, "K8S_CACHE_INDEX should be set")
assert.True(t, foundURL, "K8S_CACHE_URL should be built from individual fields")
})
}

func TestSessionCacheRedisDsnOverwrite(t *testing.T) {
t.Run("SessionCache with DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
SessionCache: v1.SessionCacheSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisDSN: "tcp://session-redis:6380/3?auth=secret",
},
},
},
}

env := store.GetEnv()
var foundHandler, foundSavePath bool
for _, envVar := range env {
if envVar.Name == "PHP_SESSION_HANDLER" {
foundHandler = true
assert.Equal(t, "redis", envVar.Value)
}
if envVar.Name == "PHP_SESSION_SAVE_PATH" {
foundSavePath = true
assert.Equal(t, "tcp://session-redis:6380/3?auth=secret", envVar.Value)
}
}
assert.True(t, foundHandler, "PHP_SESSION_HANDLER should be set")
assert.True(t, foundSavePath, "PHP_SESSION_SAVE_PATH should be set with DSN value")
})

t.Run("SessionCache without DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
SessionCache: v1.SessionCacheSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisHost: "session-host",
RedisPort: 6379,
RedisIndex: 1,
},
},
},
}

env := store.GetEnv()
var foundHandler, foundSavePath bool
for _, envVar := range env {
if envVar.Name == "PHP_SESSION_HANDLER" {
foundHandler = true
assert.Equal(t, "redis", envVar.Value)
}
if envVar.Name == "PHP_SESSION_SAVE_PATH" {
foundSavePath = true
assert.Equal(t, "tcp://session-host:6379/1", envVar.Value)
}
}
assert.True(t, foundHandler, "PHP_SESSION_HANDLER should be set")
assert.True(t, foundSavePath, "PHP_SESSION_SAVE_PATH should be built from individual fields")
})
}

func TestNewSessionCacheRedisDsnOverwrite(t *testing.T) {
t.Run("New SessionCache with DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
SessionCache: v1.SessionCacheSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisDSN: "redis://session-redis:6380/3?password=secret",
},
},
},
}

env := store.GetEnv()
var foundRedisDSN bool
for _, envVar := range env {
if envVar.Name == "K8S_REDIS_SESSION_DSN" {
foundRedisDSN = true
assert.Equal(t, "redis://session-redis:6380/3?password=secret", envVar.Value)
}
}
assert.True(t, foundRedisDSN, "K8S_REDIS_SESSION_DSN should be set with DSN value")
})

t.Run("New SessionCache without DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
SessionCache: v1.SessionCacheSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisHost: "session-host",
RedisPort: 6379,
RedisIndex: 1,
},
},
},
}

env := store.GetEnv()
var foundRedisDSN bool
for _, envVar := range env {
if envVar.Name == "K8S_REDIS_SESSION_DSN" {
foundRedisDSN = true
assert.Equal(t, "redis://session-host:6379/1", envVar.Value)
}
}
assert.True(t, foundRedisDSN, "K8S_REDIS_SESSION_DSN should be built from individual fields")
})
}

func TestWorkerRedisDsnOverwrite(t *testing.T) {
t.Run("Worker with DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
Worker: v1.WorkerSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisDSN: "redis://worker-redis:6380/messages?password=secret&group=custom",
},
},
},
}

env := store.GetEnv()
var foundDSN bool
for _, envVar := range env {
if envVar.Name == "MESSENGER_TRANSPORT_DSN" {
foundDSN = true
assert.Equal(t, "redis://worker-redis:6380/messages?password=secret&group=custom", envVar.Value)
}
}
assert.True(t, foundDSN, "MESSENGER_TRANSPORT_DSN should be set with DSN value")
})

t.Run("Worker without DSN", func(t *testing.T) {
store := &v1.Store{
Spec: v1.StoreSpec{
Worker: v1.WorkerSpec{
Adapter: "redis",
RedisSpec: v1.RedisSpec{
RedisHost: "worker-host",
RedisPort: 6379,
RedisIndex: 3,
},
},
},
}

env := store.GetEnv()
var foundDSN bool
for _, envVar := range env {
if envVar.Name == "MESSENGER_TRANSPORT_DSN" {
foundDSN = true
assert.Equal(t, "redis://worker-host:6379/messages/symfony/consumer?auto_setup=true&serializer=1&stream_max_entries=0&dbindex=3", envVar.Value)
}
}
assert.True(t, foundDSN, "MESSENGER_TRANSPORT_DSN should be built from individual fields")
})
}
Loading