From 41f2db3a582967761aef2a2c4894741ffc7cc92f Mon Sep 17 00:00:00 2001
From: Konstantin Knizhnik <knizhnik@garret.ru>
Date: Sun, 4 Jun 2023 14:15:48 +0300
Subject: [PATCH] Add comment about list_tenants()

---
 pageserver/src/tenant/mgr.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/pageserver/src/tenant/mgr.rs b/pageserver/src/tenant/mgr.rs
index 0c597c0ffe..751769f62e 100644
--- a/pageserver/src/tenant/mgr.rs
+++ b/pageserver/src/tenant/mgr.rs
@@ -634,6 +634,11 @@ pub enum TenantMapListError {
 /// Get list of tenants, for the mgmt API
 ///
 #[cfg(feature = "testing")]
+// Many tests are using list_tenants to check if tenant is in active state
+// With lazy loading tenants are initially in NotLoaded state.
+// To make all this tests pass, lets force loading of tenants if testing feature is specified.
+// Alternatively it is possible to pass extra parameter to list_tenants to choose between
+// eager and lazy loading of tenants.
 pub async fn list_tenants() -> Result<Vec<(TenantId, TenantState)>, TenantMapListError> {
     let tenants = TENANTS.read().await;
     match &*tenants {