Packages using memory even if they are not used · directus/directus#24334

(2 comments) (0 reactions) (0 assignees)TypeScript (25,193 stars) (3,505 forks)batch import

EngineHelp WantedOptimizationPerformance

説明

Describe the Improvement

While investigating https://github.com/directus/directus/issues/24035 I found multiple packages being loaded into memory even if they were not being in use. The most impactful package was node-xmllint from @authenio/samlify-node-xmllint even though I was not using SAML. But others like openid-client or ldapjs were being loaded as well, but my configuration was not using OpenId or LDAP.

To reduce the memory usage, we could lazy load these and all other packages that are not required if respective configuration is not active. For example, lazy load @tus/server and only import it if TUS_ENABLED is set to true

コントリビューターガイド

技術スタック: typescriptnodejs
領域: backendperformance
Issue 種別: performance
難度: 3
推定時間: half day
活動状況: fresh
明確さ: clear
前提条件: TypeScriptNode.js module system
初心者向け度: 60
調査方針: First, examine the Directus codebase to locate where packages like `@authenio/samlify node xmllint`, `openid client`, `ldapjs`, and `@tus/server` are imported. These are likely in files handling SAML, OpenID, LDAP, and TUS configuration. To implement lazy loading, replace static imports with dynamic `import()` statements, conditionally executed only when the corresponding configuration option (e.g., `TUS ENABLED`) is active. Refer to issue #24035 for context. Check if there are existing patterns for lazy loading in the codebase to follow. Test that the functionality still works when the features are enabled and that memory usage decreases when disabled.