fix: make package name mandatory

an English package name should be mandatory as it's used as a fallback

Author: janbritz

questionpy_common/manifest.py

@@ -7,7 +7,7 @@
 from keyword import iskeyword, issoftkeyword
 from typing import Annotated, NewType
 
-from pydantic import BaseModel, ByteSize, PositiveInt, conset, field_validator
+from pydantic import BaseModel, ByteSize, PositiveInt, StringConstraints, conset, field_validator
 from pydantic.fields import Field
 
 
@@ -97,7 +97,7 @@ class SourceManifest(BaseModel):
     version: Annotated[str, Field(pattern=RE_SEMVER)]
     api_version: Annotated[str, Field(pattern=RE_API)]
     author: str
-    name: dict[Bcp47LanguageTag, str] = {}
+    name: dict[Bcp47LanguageTag, Annotated[str, StringConstraints(min_length=1)]] = Field(min_length=1)
     entrypoint: str | None = None
     url: str | None = None
     languages: list[Bcp47LanguageTag] = Field(min_length=1)
@@ -119,6 +119,16 @@ class SourceManifest(BaseModel):
     def ensure_is_valid_name(cls, value: str) -> str:
         return ensure_is_valid_name(value)
 
+    @field_validator("languages", "name")
+    @classmethod
+    def ensure_contains_english_translation(
+        cls, value: list[Bcp47LanguageTag] | dict[Bcp47LanguageTag, str]
+    ) -> list[Bcp47LanguageTag] | dict[Bcp47LanguageTag, str]:
+        if Bcp47LanguageTag("en") not in value:
+            msg = "must contain an english translation"
+            raise ValueError(msg)
+        return value
+
     @property
     def identifier(self) -> str:
         return f"@{self.namespace}/{self.short_name}"

questionpy_server/worker/runtime/package_location.py

@@ -68,6 +68,7 @@ def __init__(self, module_name: str, function_name: str = "init", manifest: Mani
                 version="0.1.0-debug",
                 api_version="0.1",
                 author="Debug Modulovitch",
+                name={Bcp47LanguageTag("en"): "Debug Package"},
                 languages=[Bcp47LanguageTag("en")],
             )
 

tests/questionpy_common/test_manifest.py

@@ -15,11 +15,12 @@
     "version": "0.1.0",
     "api_version": "0.1",
     "author": "John Doe",
+    "name": {"en": "Minimal Package"},
     "languages": ["en"],
 }
 maximal_manifest = {
     **minimal_manifest,
-    "name": {"en": "test_name"},
+    "name": {"en": "Maximal Package"},
     "entrypoint": "test_entrypoint",
     "url": "https://example.com/package",
     "languages": ["de", "en", "en-AU"],
@@ -66,7 +67,7 @@ def test_ignore_additional_properties(data: dict[str, Any]) -> None:
     ("data", "error_message"),
     [
         # no manifest
-        ({}, r"5 validation errors for \w"),
+        ({}, r"6 validation errors for \w"),
         # 'name' is not a dict
         ({**minimal_manifest, "name": "test_name"}, r"1 validation error for \w"),
         # 'type' is not a valid PackageType

tests/questionpy_server/repository/test_repository.py

@@ -20,15 +20,19 @@
 REPO_URL = "https://example.com/repo/"
 REPO_PACKAGE_VERSIONS_0 = RepoPackageVersionsFactory.build(
     manifest={
-        "short_name": "package_1",
-        "namespace": "namespace_1",
+        "short_name": "package_0",
+        "namespace": "namespace_0",
+        "name": {"en": "Package 0"},
+        "languages": ["en"],
     },
     versions=[{"sha256": "2", "version": "3.0.0", "api_version": "3.0"}],
 )
 REPO_PACKAGE_VERSIONS_1 = RepoPackageVersionsFactory.build(
     manifest={
-        "short_name": "package_0",
-        "namespace": "namespace_0",
+        "short_name": "package_1",
+        "namespace": "namespace_1",
+        "name": {"en": "Package 1"},
+        "languages": ["en"],
     },
     versions=[
         {"sha256": "0", "version": "1.0.0", "api_version": "1.0"},
@@ -142,7 +146,7 @@ async def test_log_warning_when_package_index_is_too_big_for_cache(
 async def test_get_package() -> None:
     repository = Repository(REPO_URL, Mock())
 
-    manifest = ManifestFactory.build(short_name="package", namespace="namespace")
+    manifest = ManifestFactory.build()
     package_path = "path/to/package.qpy"
     package = RepoPackage(manifest=manifest, sha256="hash", size=1, path=package_path)
 

tests/test_data/factories.py

@@ -9,7 +9,7 @@
 from polyfactory.factories.pydantic_factory import ModelFactory
 from semver import Version
 
-from questionpy_common.manifest import PartialPackagePermissions
+from questionpy_common.manifest import Bcp47LanguageTag, PartialPackagePermissions
 from questionpy_server.repository.models import RepoMeta, RepoPackageVersions
 from questionpy_server.utils.manifest import ComparableManifest
 
@@ -37,6 +37,8 @@ class ManifestFactory(CustomFactory):
 
     short_name = Use(lambda: ModelFactory.__faker__.word().lower() + "_sn")
     namespace = Use(lambda: ModelFactory.__faker__.word().lower() + "_ns")
+    name = {Bcp47LanguageTag("en"): "Factory Package"}
+    languages = [Bcp47LanguageTag("en")]
     url = Use(ModelFactory.__faker__.url)
     icon = None
     permissions = PartialPackagePermissions()