Skip to content
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

Refactor Redis connections to use Redis URL - closes #7421 #7736

Merged
merged 8 commits into from
Oct 16, 2024
Merged

Refactor Redis connections to use Redis URL - closes #7421 #7736

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
158ab70
Refactor Redis connection to use Redis URL
thomasmol Oct 16, 2024
4d15012
fix
thomasmol Oct 16, 2024
0ec9d12
fixes
thomasmol Oct 16, 2024
655265c
add fixes
thomasmol Oct 16, 2024
2ed4704
fix typing
Weiko Oct 16, 2024
9112b6c
Fix docker-compose CI
charlesBochet Oct 16, 2024
68c8612
fix
Weiko Oct 16, 2024
551f789
Fix
charlesBochet Oct 16, 2024
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
3 changes: 1 addition & 2 deletions packages/twenty-docker/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ TAG=latest
PG_DATABASE_HOST=db:5432

SERVER_URL=http://localhost:3000
# REDIS_HOST=redis
# REDIS_PORT=6379
# REDIS_URL=redis://localhost:6379
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Add a comment explaining the REDIS_URL format for clarity


# Use openssl rand -base64 32 for each secret
# ACCESS_TOKEN_SECRET=replace_me_with_a_random_string_access
Expand Down
6 changes: 2 additions & 4 deletions packages/twenty-docker/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ services:
PG_DATABASE_URL: postgres://twenty:twenty@${PG_DATABASE_HOST}/default
SERVER_URL: ${SERVER_URL}
FRONT_BASE_URL: ${FRONT_BASE_URL:-$SERVER_URL}
REDIS_PORT: ${REDIS_PORT:-6379}
REDIS_HOST: ${REDIS_HOST:-redis}
REDIS_URL: ${REDIS_URL:-redis://localhost:6379}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Consider using the redis service name instead of localhost in the default URL


ENABLE_DB_MIGRATIONS: "true"

Expand Down Expand Up @@ -59,8 +58,7 @@ services:
PG_DATABASE_URL: postgres://twenty:twenty@${PG_DATABASE_HOST}/default
SERVER_URL: ${SERVER_URL}
FRONT_BASE_URL: ${FRONT_BASE_URL:-$SERVER_URL}
REDIS_PORT: ${REDIS_PORT:-6379}
REDIS_HOST: ${REDIS_HOST:-redis}
REDIS_URL: ${REDIS_URL:-redis://localhost:6379}

ENABLE_DB_MIGRATIONS: "false" # it already runs on the server

Expand Down
6 changes: 2 additions & 4 deletions packages/twenty-docker/k8s/manifests/deployment-server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,8 @@ spec:
value: "https://crm.example.com:443"
- name: "PG_DATABASE_URL"
value: "postgres://twenty:twenty@twenty-db.twentycrm.svc.cluster.local/default"
- name: "REDIS_HOST"
value: "twentycrm-redis.twentycrm.svc.cluster.local"
- name: "REDIS_PORT"
value: 6379
- name: "REDIS_URL"
value: "redis://twentycrm-redis.twentycrm.svc.cluster.local:6379"
- name: ENABLE_DB_MIGRATIONS
value: "true"
- name: SIGN_IN_PREFILLED
Expand Down
6 changes: 2 additions & 4 deletions packages/twenty-docker/k8s/manifests/deployment-worker.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,8 @@ spec:
value: "bull-mq"
- name: "CACHE_STORAGE_TYPE"
value: "redis"
- name: "REDIS_HOST"
value: "twentycrm-redis.twentycrm.svc.cluster.local"
- name: "REDIS_PORT"
value: 6379
- name: "REDIS_URL"
value: "redis://twentycrm-redis.twentycrm.svc.cluster.local:6379"
- name: ACCESS_TOKEN_SECRET
valueFrom:
secretKeyRef:
Expand Down
8 changes: 2 additions & 6 deletions packages/twenty-docker/k8s/terraform/deployment-server.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,8 @@ resource "kubernetes_deployment" "twentycrm_server" {
value = "postgres://twenty:${var.twentycrm_pgdb_admin_password}@${kubernetes_service.twentycrm_db.metadata.0.name}.${kubernetes_namespace.twentycrm.metadata.0.name}.svc.cluster.local/default"
}
env {
name = "REDIS_HOST"
value = "${kubernetes_service.twentycrm_redis.metadata.0.name}.${kubernetes_namespace.twentycrm.metadata.0.name}.svc.cluster.local"
}
env {
name = "REDIS_PORT"
value = 6379
name = "REDIS_URL"
value = "redis://${kubernetes_service.twentycrm_redis.metadata.0.name}.${kubernetes_namespace.twentycrm.metadata.0.name}.svc.cluster.local:6379"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: The Redis URL format doesn't include authentication. If Redis requires auth, update the URL to include username and password

}
env {
name = "ENABLE_DB_MIGRATIONS"
Expand Down
9 changes: 2 additions & 7 deletions packages/twenty-docker/k8s/terraform/deployment-worker.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,8 @@ resource "kubernetes_deployment" "twentycrm_worker" {
}

env {
name = "REDIS_HOST"
value = "${kubernetes_service.twentycrm_redis.metadata.0.name}.${kubernetes_namespace.twentycrm.metadata.0.name}.svc.cluster.local"
}

env {
name = "REDIS_PORT"
value = 6379
name = "REDIS_URL"
value = "redis://${kubernetes_service.twentycrm_redis.metadata.0.name}.${kubernetes_namespace.twentycrm.metadata.0.name}.svc.cluster.local:6379"
Comment on lines +62 to +63
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Consider using a separate variable for the Redis URL instead of constructing it inline. This would improve maintainability and allow for easier configuration changes.

}

env {
Expand Down
5 changes: 1 addition & 4 deletions packages/twenty-server/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,7 @@ SIGN_IN_PREFILLED=true
# SENTRY_FRONT_DSN=https://xxx@xxx.ingest.sentry.io/xxx
# LOG_LEVELS=error,warn
# MESSAGE_QUEUE_TYPE=pg-boss
# REDIS_HOST=127.0.0.1
# REDIS_PORT=6379
# REDIS_USERNAME=
# REDIS_PASSWORD=
# REDIS_URL=redis://localhost:6379
# DEMO_WORKSPACE_IDS=REPLACE_ME_WITH_A_RANDOM_UUID
# SERVER_URL=http://localhost:3000
# WORKSPACE_INACTIVE_DAYS_BEFORE_NOTIFICATION=30
Expand Down
5 changes: 1 addition & 4 deletions packages/twenty-server/.env.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ DEMO_WORKSPACE_IDS=63db4589-590f-42b3-bdf1-85268b3da02f,8de58f3f-7e86-4a0b-998d-
MUTATION_MAXIMUM_RECORD_AFFECTED=100
MESSAGE_QUEUE_TYPE=pg-boss
CACHE_STORAGE_TYPE=redis
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
REDIS_USERNAME=default
REDIS_PASSWORD=
REDIS_URL=redis://localhost:6379

AUTH_GOOGLE_ENABLED=false
MESSAGING_PROVIDER_GMAIL_ENABLED=false
Expand Down
15 changes: 4 additions & 11 deletions packages/twenty-server/src/engine/core-modules/cache-storage/cache-storage.module-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,19 @@ export const cacheStorageModuleFactory = (
return cacheModuleOptions;
}
case CacheStorageType.Redis: {
const host = environmentService.get('REDIS_HOST');
const port = environmentService.get('REDIS_PORT');
const connectionString = environmentService.get('REDIS_URL');

if (!(host && port)) {
if (!connectionString) {
throw new Error(
`${cacheStorageType} cache storage requires host: ${host} and port: ${port} to be defined, check your .env file`,
`${cacheStorageType} cache storage requires ${connectionString} to be defined, check your .env file`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Error message uses connectionString variable, which could be undefined. Use 'REDIS_URL' string instead

thomasmol marked this conversation as resolved.
Show resolved Hide resolved
);
}

const username = environmentService.get('REDIS_USERNAME');
const password = environmentService.get('REDIS_PASSWORD');

return {
...cacheModuleOptions,
store: redisStore,
socket: {
host,
port,
username,
password,
connectionString,
},
};
}
Expand Down
15 changes: 7 additions & 8 deletions packages/twenty-server/src/engine/core-modules/environment/environment-variables.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,14 +375,13 @@ export class EnvironmentVariables {
@IsNumber()
MUTATION_MAXIMUM_AFFECTED_RECORDS = 100;

REDIS_HOST = '127.0.0.1';

@CastToPositiveNumber()
REDIS_PORT = 6379;

REDIS_USERNAME: string;

REDIS_PASSWORD: string;
@IsOptional()
@IsUrl({
protocols: ['redis'],
require_tld: false,
allow_underscores: true,
})
REDIS_URL: string;

API_TOKEN_EXPIRES_IN = '100y';

Expand Down
13 changes: 3 additions & 10 deletions packages/twenty-server/src/engine/core-modules/message-queue/message-queue.module-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
MessageQueueDriverType,
MessageQueueModuleOptions,
} from 'src/engine/core-modules/message-queue/interfaces';
import IORedis from 'ioredis';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Consider adding a comment explaining why IORedis is being imported and used


/**
* MessageQueue Module factory
Expand Down Expand Up @@ -32,20 +33,12 @@ export const messageQueueModuleFactory = async (
};
}
case MessageQueueDriverType.BullMQ: {
const host = environmentService.get('REDIS_HOST');
const port = environmentService.get('REDIS_PORT');
const username = environmentService.get('REDIS_USERNAME');
const password = environmentService.get('REDIS_PASSWORD');
const connectionString = environmentService.get('REDIS_URL');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Validate REDIS_URL before using it to prevent potential runtime errors


return {
type: MessageQueueDriverType.BullMQ,
options: {
connection: {
host,
port,
username,
password,
},
connection: new IORedis(connectionString)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems wrong actually, we should not instanciate here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

true, i changed it to just pass the connection string here. It works but there is a type error. Unsure why that is since passing a string should be OK as per: https://redis.github.io/ioredis/classes/Redis.html#constructor

},
};
}
Expand Down
5 changes: 1 addition & 4 deletions packages/twenty-website/src/content/developers/self-hosting/self-hosting-var.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,7 @@ yarn command:prod cron:calendar:calendar-event-list-fetch
<ArticleTable options={[
['PG_DATABASE_URL', 'postgres://user:pw@localhost:5432/default?connection_limit=1', 'Database connection'],
['PG_SSL_ALLOW_SELF_SIGNED', 'false', 'Allow self signed certificates'],
['REDIS_HOST', '127.0.0.1', 'Redis connection host'],
['REDIS_PORT', '6379', 'Redis connection port'],
['REDIS_USERNAME', 'redis_username', 'Redis connection username'],
['REDIS_PASSWORD', 'redis_pwd', 'Redis connection password'],
['REDIS_URL', 'redis://localhost:6379', 'Redis connection url'],
['FRONT_BASE_URL', 'http://localhost:3001', 'Url to the hosted frontend'],
['SERVER_URL', 'http://localhost:3000', 'Url to the hosted server'],
['PORT', '3000', 'Port'],
Expand Down
11 changes: 11 additions & 0 deletions packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,15 @@ yarn command:prod upgrade-0.31
The `yarn database:migrate:prod` command will apply the migrations to the database structure (core and metadata schemas)
The `yarn command:prod upgrade-31` takes care of the data migration of all workspaces.

# v0.31.0 to v0.32.0

### Environment Variables

The following environment variables have been changed:

- Removed: `REDIS_HOST`, `REDIS_PORT`, `REDIS_USERNAME`, `REDIS_PASSWORD`
- Added: `REDIS_URL`

Update your `.env` file to use the new `REDIS_URL` variable instead of the individual Redis connection parameters.

<ArticleEditContent></ArticleEditContent>
Loading