From 2f75bb24db7db7526d385d3ec3c39cd1388f77f7 Mon Sep 17 00:00:00 2001
From: Marc Durdin <marc@durdin.net>
Date: Fri, 16 Aug 2024 08:04:18 +0200
Subject: [PATCH] fix(developer): enforce presence of kps Info.Description
 field in info compilers

The Description field should be required for published keyboards and
models, so this change means kmc-keyboard-info and kmc-model-info will
report an error if it is missing.

Relates-to: keymanapp/keyboards#3037
Relates-to: keymanapp/lexical-models#262
Fixes: #12202
---
 .../src/keyboard-info-compiler-messages.ts             | 10 ++++++++--
 .../kmc-keyboard-info/src/keyboard-info-compiler.ts    |  3 +++
 .../kmc-model-info/src/model-info-compiler-messages.ts |  5 +++++
 .../src/kmc-model-info/src/model-info-compiler.ts      |  3 +++
 4 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/developer/src/kmc-keyboard-info/src/keyboard-info-compiler-messages.ts b/developer/src/kmc-keyboard-info/src/keyboard-info-compiler-messages.ts
index d1a4c632c0..9b8a19a81e 100644
--- a/developer/src/kmc-keyboard-info/src/keyboard-info-compiler-messages.ts
+++ b/developer/src/kmc-keyboard-info/src/keyboard-info-compiler-messages.ts
@@ -52,8 +52,14 @@ export class KeyboardInfoCompilerMessages {
   static Error_FontFileCannotBeRead = (o:{filename: string}) => m(this.ERROR_FontFileCannotBeRead,
     `Font ${def(o.filename)} could not be parsed to extract a font family.`);
 
-static ERROR_FontFileMetaDataIsInvalid = SevError | 0x000F;
-static Error_FontFileMetaDataIsInvalid = (o:{filename: string,message:string}) => m(this.ERROR_FontFileMetaDataIsInvalid,
+  static ERROR_FontFileMetaDataIsInvalid = SevError | 0x000F;
+  static Error_FontFileMetaDataIsInvalid = (o:{filename: string,message:string}) => m(
+    this.ERROR_FontFileMetaDataIsInvalid,
     `Font ${def(o.filename)} meta data invalid: ${def(o.message)}.`);
+
+  static ERROR_DescriptionIsMissing = SevError | 0x0010;
+  static Error_DescriptionIsMissing = (o:{filename:string}) => m(
+    this.ERROR_DescriptionIsMissing,
+    `The Info.Description field in the package ${def(o.filename)} is required, but is missing or empty.`);
 }
 
diff --git a/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts b/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts
index c2a1376340..ed704c6e8c 100644
--- a/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts
+++ b/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts
@@ -246,6 +246,9 @@ export class KeyboardInfoCompiler implements KeymanCompiler {
 
     if(kmpJsonData.info.description?.description) {
       keyboard_info.description = kmpJsonData.info.description.description.trim();
+    } else {
+      this.callbacks.reportMessage(KeyboardInfoCompilerMessages.Error_DescriptionIsMissing({filename:sources.kpsFilename}));
+      return null;
     }
 
     // extract the language identifiers from the language metadata arrays for
diff --git a/developer/src/kmc-model-info/src/model-info-compiler-messages.ts b/developer/src/kmc-model-info/src/model-info-compiler-messages.ts
index 9a1c5fdbdc..bcbf95ff4b 100644
--- a/developer/src/kmc-model-info/src/model-info-compiler-messages.ts
+++ b/developer/src/kmc-model-info/src/model-info-compiler-messages.ts
@@ -44,5 +44,10 @@ export class ModelInfoCompilerMessages {
   static ERROR_NoLicenseFound = SevError | 0x0009;
   static Error_NoLicenseFound = () => m(this.ERROR_NoLicenseFound,
     `No license for the model was found. MIT license is required for publication to Keyman lexical-models repository.`);
+
+  static ERROR_DescriptionIsMissing = SevError | 0x000A;
+  static Error_DescriptionIsMissing = (o:{filename:string}) => m(
+    this.ERROR_DescriptionIsMissing,
+    `The Info.Description field in the package ${def(o.filename)} is required, but is missing or empty.`);
 }
 
diff --git a/developer/src/kmc-model-info/src/model-info-compiler.ts b/developer/src/kmc-model-info/src/model-info-compiler.ts
index b6a4af3064..e19411486b 100644
--- a/developer/src/kmc-model-info/src/model-info-compiler.ts
+++ b/developer/src/kmc-model-info/src/model-info-compiler.ts
@@ -199,6 +199,9 @@ export class ModelInfoCompiler implements KeymanCompiler {
 
     if(sources.kmpJsonData.info.description?.description) {
       model_info.description = sources.kmpJsonData.info.description.description.trim();
+    } else {
+      this.callbacks.reportMessage(ModelInfoCompilerMessages.Error_DescriptionIsMissing({filename:sources.kpsFilename}));
+      return null;
     }
 
     // isRTL -- this is a little bit of a heuristic from a compiled .js