server: make capabilities cache size configurable and add a note when…

… all slots are taken
qgis · Mar 29, 2023 · 715f043 · 715f043
1 parent 7136793
commit 715f043
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 10 deletions.
diff --git a/python/server/auto_generated/qgscapabilitiescache.sip.in b/python/server/auto_generated/qgscapabilitiescache.sip.in
@@ -20,7 +20,7 @@ A cache for capabilities xml documents (by configuration file path)
 #include "qgscapabilitiescache.h"
 %End
   public:
-    QgsCapabilitiesCache();
+    QgsCapabilitiesCache( int size );
 
     const QDomDocument *searchCapabilitiesDocument( const QString &configFilePath, const QString &key );
 %Docstring

diff --git a/python/server/auto_generated/qgsserversettings.sip.in b/python/server/auto_generated/qgsserversettings.sip.in
@@ -64,6 +64,7 @@ Provides some enum describing the environment currently supported for configurat
       QGIS_SERVER_PROJECT_CACHE_STRATEGY,
       QGIS_SERVER_ALLOWED_EXTRA_SQL_TOKENS,
       QGIS_SERVER_APPLICATION_NAME,
+      QGIS_SERVER_CAPABILITIES_CACHE_SIZE,
     };
 };
 
@@ -357,6 +358,15 @@ by setting the environment variable QGIS_SERVER_APPLICATION_NAME.
 Returns the string representation of a setting.
 
 .. versionadded:: 3.16
+%End
+
+    int capabilitiesCacheSize() const;
+%Docstring
+Returns the maximum number of project capabilities to cache.
+The default value is 40 and the value can be changed
+by setting the environment variable QGIS_SERVER_CAPABILITIES_CACHE_SIZE.
+
+.. versionadded:: 3.31
 %End
 
 };

diff --git a/src/server/qgscapabilitiescache.cpp b/src/server/qgscapabilitiescache.cpp
@@ -25,9 +25,11 @@
 #endif
 
 #include "qgslogger.h"
+#include "qgsserversettings.h"
+#include "qgsmessagelog.h"
 
 
-QgsCapabilitiesCache::QgsCapabilitiesCache()
+QgsCapabilitiesCache::QgsCapabilitiesCache( int size ): mCacheSize( size )
 {
   QObject::connect( &mFileSystemWatcher, &QFileSystemWatcher::fileChanged, this, &QgsCapabilitiesCache::removeChangedEntry );
 
@@ -52,12 +54,14 @@ const QDomDocument *QgsCapabilitiesCache::searchCapabilitiesDocument( const QStr
 
 void QgsCapabilitiesCache::insertCapabilitiesDocument( const QString &configFilePath, const QString &key, const QDomDocument *doc )
 {
-  if ( mCachedCapabilities.size() > 40 )
+  if ( mCachedCapabilities.size() > mCacheSize )
   {
     //remove another cache entry to avoid memory problems
     const QHash<QString, QHash<QString, QDomDocument> >::iterator capIt = mCachedCapabilities.begin();
     mFileSystemWatcher.removePath( capIt.key() );
     mCachedCapabilities.erase( capIt );
+
+    QgsMessageLog::logMessage( QStringLiteral( "Removed cached WMS capabilities document because all %1 cache slots were taken" ).arg( mCacheSize ), QStringLiteral( "Server" ) );
   }
 
   if ( !mCachedCapabilities.contains( configFilePath ) )

diff --git a/src/server/qgscapabilitiescache.h b/src/server/qgscapabilitiescache.h
@@ -26,6 +26,7 @@
 #include <QTimer>
 
 #include "qgis_server.h"
+#include "qgsserversettings.h"
 
 /**
  * \ingroup server
@@ -35,7 +36,7 @@ class SERVER_EXPORT QgsCapabilitiesCache : public QObject
 {
     Q_OBJECT
   public:
-    QgsCapabilitiesCache();
+    QgsCapabilitiesCache( int size );
 
     /**
      * Returns cached capabilities document (or 0 if document for configuration file not in cache)
@@ -64,6 +65,7 @@ class SERVER_EXPORT QgsCapabilitiesCache : public QObject
     QHash< QString, QDateTime> mCachedCapabilitiesTimestamps;
     QFileSystemWatcher mFileSystemWatcher;
     QTimer mTimer;
+    int mCacheSize;
 
   private slots:
     //! Removes changed entry from this cache

diff --git a/src/server/qgsserver.cpp b/src/server/qgsserver.cpp
@@ -352,7 +352,7 @@ bool QgsServer::init()
   sConfigFilePath = new QString( defaultConfigFilePath );
 
   //create cache for capabilities XML
-  sCapabilitiesCache = new QgsCapabilitiesCache();
+  sCapabilitiesCache = new QgsCapabilitiesCache( sSettings()->capabilitiesCacheSize() );
 
   QgsFontUtils::loadStandardTestFonts( QStringList() << QStringLiteral( "Roman" ) << QStringLiteral( "Bold" ) );
 

diff --git a/src/server/qgsserversettings.cpp b/src/server/qgsserversettings.cpp
@@ -389,6 +389,15 @@ void QgsServerSettings::initSettings()
                                    };
   mSettings[ sApplicationName.envVar ] = sApplicationName;
 
+  const Setting sCapabilitiesCacheSize = { QgsServerSettingsEnv::QGIS_SERVER_CAPABILITIES_CACHE_SIZE,
+                                           QgsServerSettingsEnv::DEFAULT_VALUE,
+                                           QStringLiteral( "The QGIS Server capabilities cache size" ),
+                                           QStringLiteral( "/qgis/capabilities_cache_size" ),
+                                           QVariant::Int,
+                                           QVariant( 40 ),
+                                           QVariant()
+                                         };
+  mSettings[ sCapabilitiesCacheSize.envVar ] = sCapabilitiesCacheSize;
 }
 
 void QgsServerSettings::load()
@@ -709,3 +718,14 @@ QString QgsServerSettings::applicationName() const
 {
   return value( QgsServerSettingsEnv::QGIS_SERVER_APPLICATION_NAME ).toString().trimmed();
 }
+
+int QgsServerSettings::capabilitiesCacheSize() const
+{
+  bool ok;
+  int size = value( QgsServerSettingsEnv::QGIS_SERVER_CAPABILITIES_CACHE_SIZE ).toInt( &ok );
+  if ( ok && size >= 1 )
+    return size;
+
+  QgsMessageLog::logMessage( QStringLiteral( "Invalid capabilities cache size, expecting integer - defaulting to 40" ), "Server", Qgis::MessageLevel::Warning );
+  return 40;
+}
diff --git a/src/server/qgsserversettings.h b/src/server/qgsserversettings.h
@@ -82,6 +82,7 @@ class SERVER_EXPORT QgsServerSettingsEnv : public QObject
       QGIS_SERVER_PROJECT_CACHE_STRATEGY, //! Set the project cache strategy. Possible values are 'filesystem', 'periodic' or 'off' (since QGIS 3.26).
       QGIS_SERVER_ALLOWED_EXTRA_SQL_TOKENS, //! Adds these tokens to the list of allowed tokens that the services accept when filtering features (since QGIS 3.28).
       QGIS_SERVER_APPLICATION_NAME, //! Define the QGIS Server application name (since QGIS 3.30).
+      QGIS_SERVER_CAPABILITIES_CACHE_SIZE, //! Define the QGIS Server capabilities cache size (since QGIS 3.31)
     };
     Q_ENUM( EnvVar )
 };
@@ -356,6 +357,15 @@ class SERVER_EXPORT QgsServerSettings
      */
     static QString name( QgsServerSettingsEnv::EnvVar env );
 
+    /**
+     * Returns the maximum number of project capabilities to cache.
+     * The default value is 40 and the value can be changed
+     * by setting the environment variable QGIS_SERVER_CAPABILITIES_CACHE_SIZE.
+     *
+     * \since QGIS 3.31
+     */
+    int capabilitiesCacheSize() const;
+
   private:
     void initSettings();
     QVariant value( QgsServerSettingsEnv::EnvVar envVar, bool actual = false ) const;

diff --git a/tests/src/server/wfs/test_qgsserver_wfs_getfeature.cpp b/tests/src/server/wfs/test_qgsserver_wfs_getfeature.cpp
@@ -51,9 +51,9 @@ void TestQgsServerWfsGetFeature::cleanupTestCase()
 void TestQgsServerWfsGetFeature::nullValueProperty()
 {
   // init server iface
-  QgsCapabilitiesCache cache;
   QgsServiceRegistry registry;
   QgsServerSettings settings;
+  QgsCapabilitiesCache cache( settings.capabilitiesCacheSize() );
   QgsServerInterfaceImpl interface( &cache, &registry, &settings );
 
   // init project

diff --git a/tests/src/server/wms/test_qgsserver_wms_dxf.cpp b/tests/src/server/wms/test_qgsserver_wms_dxf.cpp
@@ -73,9 +73,9 @@ void TestQgsServerWmsDxf::use_title_as_layername_true()
   QgsMapLayer *layer = project.layerStore()->mapLayersByName( "testlayer èé" )[0];
   QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
 
-  QgsCapabilitiesCache cache;
   QgsServiceRegistry registry;
   QgsServerSettings settings;
+  QgsCapabilitiesCache cache( settings.capabilitiesCacheSize() );
   QgsServerInterfaceImpl interface( &cache, &registry, &settings );
 
   QgsWms::QgsWmsRenderContext context( &project, &interface );
@@ -121,9 +121,9 @@ void TestQgsServerWmsDxf::use_title_as_layername_false()
   QgsMapLayer *layer = project.layerStore()->mapLayersByName( "testlayer èé" )[0];
   QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
 
-  QgsCapabilitiesCache cache;
   QgsServiceRegistry registry;
   QgsServerSettings settings;
+  QgsCapabilitiesCache cache( settings.capabilitiesCacheSize() );
   QgsServerInterfaceImpl interface( &cache, &registry, &settings );
 
   QgsWms::QgsWmsRenderContext context( &project, &interface );

diff --git a/tests/src/server/wms/test_qgsserver_wms_restorer.cpp b/tests/src/server/wms/test_qgsserver_wms_restorer.cpp
@@ -57,9 +57,9 @@ void TestQgsServerWmsRestorer::restorer_layer()
   const QgsWms::QgsWmsParameters parameters( query );
 
   // init context
-  QgsCapabilitiesCache cache;
   QgsServiceRegistry registry;
   QgsServerSettings settings;
+  QgsCapabilitiesCache cache( settings.capabilitiesCacheSize() );
   QgsServerInterfaceImpl interface( &cache, &registry, &settings );
 
   QgsWms::QgsWmsRenderContext context( &project, &interface );

diff --git a/tests/src/server/wms/test_qgsserver_wms_vector_tile.cpp b/tests/src/server/wms/test_qgsserver_wms_vector_tile.cpp
@@ -71,9 +71,9 @@ void TestQgsServerWmsVectorTile::opacity()
   const QgsWms::QgsWmsParameters parameters( query );
 
   // init wms renderer
-  QgsCapabilitiesCache cache;
   QgsServiceRegistry registry;
   QgsServerSettings settings;
+  QgsCapabilitiesCache cache( settings.capabilitiesCacheSize() );
   QgsServerInterfaceImpl interface( &cache, &registry, &settings );
 
   QgsWms::QgsWmsRenderContext context( &project, &interface );