NAS-133590 / 25.10 / Allow sorting apps by popularity (#16496)

This PR adds another attribute to `app.available` / `app.latest` which
shows how popular an app is. Higher the value of this attribute means it
is more popular in comparison to apps which have a lower value or no
value present.

Author: sonicaj

src/middlewared/middlewared/api/v25_10_0/app.py

@@ -365,6 +365,7 @@ class AppAvailableResponse(CatalogAppInfo):
     catalog: NonEmptyString
     installed: bool
     train: NonEmptyString
+    popularity_rank: int | None
 
 
 class AppCategoriesArgs(BaseModel):

src/middlewared/middlewared/plugins/catalog/apps.py

@@ -35,6 +35,7 @@ def available(self, filters, options):
         if not self.middleware.call_sync('catalog.synced'):
             self.middleware.call_sync('catalog.sync').wait_sync()
 
+        apps_popularity = self.middleware.call_sync('catalog.popularity_cache')
         results = []
         installed_apps = [
             (app['metadata']['name'], app['metadata']['train'])
@@ -51,6 +52,7 @@ def available(self, filters, options):
                     'catalog': catalog['label'],
                     'installed': (app_data['name'], train) in installed_apps,
                     'train': train,
+                    'popularity_rank': apps_popularity.get(train, {}).get(app_data['name']),
                     **app_data,
                 })
 

src/middlewared/middlewared/plugins/catalog/sync.py

@@ -1,3 +1,5 @@
+import aiohttp
+
 from middlewared.api import api_method
 from middlewared.api.current import CatalogSyncArgs, CatalogSyncResult
 from middlewared.service import job, private, Service
@@ -6,10 +8,32 @@
 from .utils import OFFICIAL_LABEL, OFFICIAL_CATALOG_REPO, OFFICIAL_CATALOG_BRANCH
 
 
+STATS_URL = 'https://telemetry.sys.truenas.net/apps/truenas-apps-stats.json'
+
+
 class CatalogService(Service):
 
+    POPULARITY_INFO = {}
     SYNCED = False
 
+    @private
+    async def update_popularity_cache(self):
+        async with aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=10)) as session:
+            try:
+                async with session.get(STATS_URL) as response:
+                    response.raise_for_status()
+                    self.POPULARITY_INFO = {
+                        k.lower(): v for k, v in (await response.json()).items()
+                        # Making sure we have a consistent format as for trains we see capitalized
+                        # entries in the file
+                    }
+            except Exception as e:
+                self.logger.error('Failed to fetch popularity stats for apps: %r', e)
+
+    @private
+    async def popularity_cache(self):
+        return self.POPULARITY_INFO
+
     @private
     async def synced(self):
         return self.SYNCED
@@ -38,6 +62,7 @@ async def sync(self, job):
                 'retrieve_all_trains': True,
                 'trains': [],
             })
+            await self.update_popularity_cache()
         except Exception as e:
             await self.middleware.call(
                 'alert.oneshot_create', 'CatalogSyncFailed', {'catalog': OFFICIAL_LABEL, 'error': str(e)}