Merge pull request #3910 from effigies/refactor/lazy-clients

refactor(server): Lazy-initialize Redis, Redlock, and Elasticsearch clients, fix import cycles

Author: nellh

.pnp.cjs

@@ -3,6 +3,7 @@
   "scripts": {
     "start": "docker-compose up --build -V",
     "build": "yarn pnpify tsc -b",
+    "dump-schema": "yarn tsx scripts/dump-schema.ts",
     "bootstrap": "lerna bootstrap",
     "test": "vitest",
     "coverage": "vitest --coverage",
@@ -43,6 +44,7 @@
     "react": "18.2.0",
     "sass": "1.93.2",
     "tsc-watch": "6.0.4",
+    "tsx": "^3.7.0",
     "typescript": "5.6.3",
     "typescript-eslint": "^8.11.0",
     "vite": "7.3.2",

package.json

@@ -22,7 +22,7 @@ import * as jwt from "./libs/authentication/jwt"
 import * as auth from "./libs/authentication/states"
 import { sitemapHandler } from "./handlers/sitemap"
 import { setupPassportAuth } from "./libs/authentication/passport"
-import { redis } from "./libs/redis"
+import { getRedis } from "./libs/redis"
 import { version } from "./lerna.json"
 export { Express } from "express-serve-static-core"
 
@@ -67,7 +67,7 @@ export async function expressApolloSetup() {
     // Always allow introspection - our schema is public
     introspection: true,
     // @ts-expect-error Type mismatch for keyv and ioredis recent releases
-    cache: new KeyvAdapter(new Keyv({ store: new KeyvRedis(redis) })),
+    cache: new KeyvAdapter(new Keyv({ store: new KeyvRedis(getRedis()) })),
     plugins: [
       ApolloServerPluginLandingPageLocalDefault(),
       ApolloServerPluginDrainHttpServer({

packages/openneuro-server/scripts/dump-schema.test.ts

@@ -27,7 +27,7 @@ vi.mock("../../cache/item")
 vi.mock("../files")
 vi.mock("../../utils/datasetOrSnapshot")
 vi.mock("../libs/redis", () => ({
-  redis: vi.fn(),
+  getRedis: vi.fn(),
 }))
 
 const mockYamlLoad = vi.mocked(yaml.load)

packages/openneuro-server/src/app.ts

@@ -13,7 +13,7 @@ import type { TreeEntry } from "../../cache/tree"
 
 vi.mock("ioredis")
 vi.mock("../../config.ts")
-vi.mock("../../libs/redis", () => ({ redis: {} }))
+vi.mock("../../libs/redis", () => ({ getRedis: () => ({}) }))
 vi.mock("../../libs/presign", () => ({
   getPresignedUrl: vi.fn().mockResolvedValue(
     "https://s3.amazonaws.com/bucket/key?presigned=true",

packages/openneuro-server/src/datalad/__tests__/contributors.spec.ts

@@ -10,12 +10,12 @@ import { connect } from "mongoose"
 // Mock requests to Datalad service
 vi.mock("superagent")
 vi.mock("../../libs/redis.js", () => ({
-  redis: {
+  getRedis: () => ({
     del: vi.fn(),
-  },
-  redlock: {
+  }),
+  getRedlock: () => ({
     lock: vi.fn().mockImplementation(() => ({ unlock: vi.fn() })),
-  },
+  }),
 }))
 // Mock draft files calls
 vi.mock("../draft.ts", () => ({

packages/openneuro-server/src/datalad/__tests__/files.spec.ts

@@ -1,6 +1,6 @@
 import * as Sentry from "@sentry/node"
 import CacheItem, { CacheType } from "../cache/item"
-import { redis } from "../libs/redis"
+import { getRedis } from "../libs/redis"
 import {
   type DatasetOrSnapshot,
   datasetOrSnapshot,
@@ -26,7 +26,7 @@ export const contributors = async (
   if (!datasetId) return []
 
   const revisionShort = revision ? revision.substring(0, 7) : "HEAD"
-  const dataciteCache = new CacheItem(redis, CacheType.dataciteYml, [
+  const dataciteCache = new CacheItem(getRedis(), CacheType.dataciteYml, [
     datasetId,
     revisionShort,
   ])

packages/openneuro-server/src/datalad/__tests__/snapshots.spec.ts

@@ -12,7 +12,7 @@ import type * as Mongoose from "mongoose"
 import config from "../config"
 import * as subscriptions from "../handlers/subscriptions"
 import { generateDataladCookie } from "../libs/authentication/jwt"
-import { redis } from "../libs/redis"
+import { getRedis } from "../libs/redis"
 import CacheItem, { CacheType } from "../cache/item"
 import { getDraftRevision, updateDatasetRevision } from "./draft"
 import { encodeFilePath, filesUrl, fileUrl, getFileName } from "./files"
@@ -114,7 +114,7 @@ export const deleteDataset = async (datasetId, user) => {
 export const cacheDatasetConnection = (options) => (connectionArguments) => {
   const connection = datasetsConnection(options)
   const cache = new CacheItem(
-    redis,
+    getRedis(),
     CacheType.datasetsConnection,
     [objectHash(options)],
     60,

packages/openneuro-server/src/datalad/contributors.ts

@@ -3,7 +3,7 @@
  */
 import config from "../config"
 import request from "superagent"
-import { redis } from "../libs/redis"
+import { getRedis } from "../libs/redis"
 import { commitFiles } from "./dataset"
 import { fileUrl } from "./files"
 import { generateDataladCookie } from "../libs/authentication/jwt"
@@ -135,7 +135,7 @@ export const description = async (obj) => {
     Name: datasetId,
     BIDSVersion: "1.8.0",
   }
-  const cache = new CacheItem(redis, CacheType.datasetDescription, [
+  const cache = new CacheItem(getRedis(), CacheType.datasetDescription, [
     datasetId,
     revision.substring(0, 7),
   ])