1
0
Fork 0
mirror of synced 2024-09-25 13:51:40 +12:00
budibase/packages/server/src/utilities/redis.ts
2023-05-31 17:48:18 +01:00

108 lines
3.2 KiB
TypeScript

import { redis, RedisClient } from "@budibase/backend-core"
import { getGlobalIDFromUserMetadataID } from "../db/utils"
import { ContextUser } from "@budibase/types"
import env from "../environment"
const APP_DEV_LOCK_SECONDS = 600
const AUTOMATION_TEST_FLAG_SECONDS = 60
let devAppClient: RedisClient,
debounceClient: RedisClient,
flagClient: RedisClient
// We need to maintain a duplicate client for socket.io pub/sub
let socketClient: RedisClient
let socketSubClient: any
// We init this as we want to keep the connection open all the time
// reduces the performance hit
export async function init() {
devAppClient = new redis.Client(redis.utils.Databases.DEV_LOCKS)
debounceClient = new redis.Client(redis.utils.Databases.DEBOUNCE)
flagClient = new redis.Client(redis.utils.Databases.FLAGS)
await devAppClient.init()
await debounceClient.init()
await flagClient.init()
// Duplicate the socket client for pub/sub
socketClient = await redis.clients.getSocketClient()
socketSubClient = socketClient.getClient().duplicate()
}
export async function shutdown() {
console.log("REDIS SHUTDOWN")
if (devAppClient) await devAppClient.finish()
if (debounceClient) await debounceClient.finish()
if (flagClient) await flagClient.finish()
if (socketSubClient) socketSubClient.disconnect()
// shutdown core clients
await redis.clients.shutdown()
console.log("Redis shutdown")
}
export async function doesUserHaveLock(devAppId: string, user: ContextUser) {
const value = await devAppClient.get(devAppId)
if (!value) {
return true
}
// make sure both IDs are global
const expected = getGlobalIDFromUserMetadataID(value._id)
const userId = getGlobalIDFromUserMetadataID(user._id!)
return expected === userId
}
export async function getLocksById(appIds: string[]) {
return await devAppClient.bulkGet(appIds)
}
export async function updateLock(devAppId: string, user: ContextUser) {
// make sure always global user ID
const globalId = getGlobalIDFromUserMetadataID(user._id!)
const inputUser = {
...user,
userId: globalId,
_id: globalId,
lockedAt: new Date().getTime(),
}
await devAppClient.store(devAppId, inputUser, APP_DEV_LOCK_SECONDS)
}
export async function clearLock(devAppId: string, user: ContextUser) {
const value = await devAppClient.get(devAppId)
if (!value) {
return
}
const userId = getGlobalIDFromUserMetadataID(user._id!)
if (value._id !== userId) {
throw "User does not hold lock, cannot clear it."
}
await devAppClient.delete(devAppId)
}
export async function checkDebounce(id: string) {
return debounceClient.get(id)
}
export async function setDebounce(id: string, seconds: number) {
await debounceClient.store(id, "debouncing", seconds)
}
export async function setTestFlag(id: string) {
await flagClient.store(id, { testing: true }, AUTOMATION_TEST_FLAG_SECONDS)
}
export async function checkTestFlag(id: string) {
const flag = await flagClient.get(id)
return !!(flag && flag.testing)
}
export async function clearTestFlag(id: string) {
await devAppClient.delete(id)
}
export function getSocketPubSubClients() {
return {
pub: socketClient.getClient(),
sub: socketSubClient,
}
}