feat: add schema validation for localization files

packages/fx-core/resource/package.nls.json

@@ -210,6 +210,9 @@
   "_error.appstudio.BotProvisionReturnsForbiddenResult.comment": "This is to describe API call, no need to translate 'Botframework'.",
   "error.appstudio.BotProvisionReturnsConflictResult": "Botframework provisioning returns conflict result when attempting to create bot registration.",
   "_error.appstudio.BotProvisionReturnsConflictResult.comment": "This is to describe API call, no need to translate 'Botframework'.",
+  "error.appstudio.localizationFile.pathNotDefined": "Localization file not found. Path: %s.",
+  "error.appstudio.localizationFile.validationFailed": "Localization file validation failed. File: %s. Error:\n%s",
+  "error.appstudio.localizationFile.validationException": "Localization file validation failed with exceptions. File: %s. Error: %s",
   "error.generator.ScaffoldLocalTemplateError": "Unable to scaffold template based on local zip package.",
   "error.generator.TemplateNotFoundError": "Unable to find template: %s.",
   "error.generator.SampleNotFoundError": "Unable to find sample: %s.",

packages/fx-core/src/component/driver/teamsApp/validate.ts

@@ -1,7 +1,17 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { Result, FxError, ok, err, Platform, ManifestUtil, Colors } from "@microsoft/teamsfx-api";
+import {
+  Result,
+  FxError,
+  ok,
+  err,
+  Platform,
+  ManifestUtil,
+  Colors,
+  TeamsAppManifest,
+  UserError,
+} from "@microsoft/teamsfx-api";
 import { hooks } from "@feathersjs/hooks/lib";
 import { Service } from "typedi";
 import { EOL } from "os";
@@ -96,6 +106,16 @@
       );
     }
 
+    // validate localization files
+    const localizationFilesValidationRes = await this.validateLocalizatoinFiles(
+      args,
+      context,
+      manifest
+    );
+    if (localizationFilesValidationRes.isErr()) {
+      return err(localizationFilesValidationRes.error);
+    }
+
     let declarativeCopilotValidationResult;
     let pluginValidationResult;
     let pluginPath = "";
@@ -337,4 +357,83 @@
     }
     return ok(undefined);
   }
+
+  public async validateLocalizatoinFiles(
+    args: ValidateManifestArgs,
+    context: WrapDriverContext,
+    manifest: TeamsAppManifest
+  ): Promise<Result<any, FxError>> {
+    const additionalLanguages = manifest.localizationInfo?.additionalLanguages;
+    if (!additionalLanguages || additionalLanguages.length == 0) {
+      return ok(undefined);
+    }
+    for (const language of additionalLanguages) {
+      const filePath = language?.file;
+      if (!filePath) {
+        return err(
+          AppStudioResultFactory.UserError(
+            AppStudioError.ValidationFailedError.name,
+            AppStudioError.ValidationFailedError.message([
+              getLocalizedString("error.appstudio.localizationFile.pathNotDefined", filePath),
+            ]),
+            HelpLinks.WhyNeedProvision
+          )
+        );
+      }
+      const localizationFileDir = path.dirname(
+        getAbsolutePath(args.manifestPath, context.projectPath)
+      );
+      const localizationFilePath = getAbsolutePath(filePath, localizationFileDir);
+
+      const manifestRes = await manifestUtils._readAppManifest(localizationFilePath);
+      if (manifestRes.isErr()) {
+        return err(manifestRes.error);
+      }
+      const localizationFile = manifestRes.value;
+      try {
+        const schema = await ManifestUtil.fetchSchema(localizationFile);
+        // the current localization schema has invalid regex sytax, we will skip some properties validation temporarily
+        delete schema.patternProperties[
+          "^activities.activityTypes\\[\\b([0-9]|[1-8][0-9]|9[0-9]|1[01][0-9]|12[0-7])\\b]\\.description$"
+        ];
+        delete schema.patternProperties[
+          "^activities.activityTypes\\[\\b([0-9]|[1-8][0-9]|9[0-9]|1[01][0-9]|12[0-7])\\b]\\.templateText$"
+        ];
+        const validationRes = await ManifestUtil.validateManifestAgainstSchema(
+          localizationFile,
+          schema
+        );
+        if (validationRes.length > 0) {
+          return err(
+            AppStudioResultFactory.UserError(
+              AppStudioError.ValidationFailedError.name,
+              AppStudioError.ValidationFailedError.message([
+                getLocalizedString(
+                  "error.appstudio.localizationFile.validationFailed",
+                  filePath,
+                  validationRes.join(EOL)
+                ),
+              ]),
+              HelpLinks.WhyNeedProvision
+            )
+          );
+        }
+      } catch (e: any) {
+        return err(
+          AppStudioResultFactory.UserError(
+            AppStudioError.ValidationFailedError.name,
+            AppStudioError.ValidationFailedError.message([
+              getLocalizedString(
+                "error.appstudio.localizationFile.validationException",
+                filePath,
+                e.message
+              ),
+            ]),
+            HelpLinks.WhyNeedProvision
+          )
+        );
+      }
+    }
+    return ok(undefined);
+  }
 }

packages/fx-core/tests/component/driver/teamsApp/validate.test.ts

@@ -220,6 +220,122 @@ describe("teamsApp/validateManifest", async () => {
     }
   });
 
+  describe("validateLocalizatoinFiles", async () => {
+    const teamsAppDriver = new ValidateManifestDriver();
+    const mockedDriverContext: any = {
+      projectPath: "./",
+    };
+
+    afterEach(() => {
+      sinon.restore();
+    });
+
+    it("should return ok when no additionalLanguages in manifest", async () => {
+      const args: ValidateManifestArgs = { manifestPath: "fakepath" };
+      const manifest = { localizationInfo: { additionalLanguages: [] } } as any;
+
+      const result = await teamsAppDriver.validateLocalizatoinFiles(
+        args,
+        mockedDriverContext,
+        manifest
+      );
+      chai.assert(result.isOk());
+    });
+
+    it("should return error when language file path is not defined", async () => {
+      const args: ValidateManifestArgs = { manifestPath: "fakepath" };
+      const manifest = { localizationInfo: { additionalLanguages: [{ file: undefined }] } } as any;
+
+      const result = await teamsAppDriver.validateLocalizatoinFiles(
+        args,
+        mockedDriverContext,
+        manifest
+      );
+      chai.assert(result.isErr());
+      if (result.isErr()) {
+        chai.assert.equal(result.error.name, AppStudioError.ValidationFailedError.name);
+      }
+    });
+
+    it("should return error when manifest file cannot be found", async () => {
+      const args: ValidateManifestArgs = { manifestPath: "fakepath" };
+      const manifest = { localizationInfo: { additionalLanguages: [{ file: "filePath" }] } } as any;
+
+      sinon
+        .stub(manifestUtils, "_readAppManifest")
+        .resolves(err(new SystemError("error", "error", "", "")));
+
+      const result = await teamsAppDriver.validateLocalizatoinFiles(
+        args,
+        mockedDriverContext,
+        manifest
+      );
+      chai.assert(result.isErr());
+      if (result.isErr()) {
+        chai.assert.equal(result.error.name, "error");
+      }
+    });
+
+    it("should return error when validation fails", async () => {
+      const args: ValidateManifestArgs = { manifestPath: "fakepath" };
+      const manifest = { localizationInfo: { additionalLanguages: [{ file: "filePath" }] } } as any;
+      const fakeLocalizationFile = {};
+
+      sinon.stub(manifestUtils, "_readAppManifest").resolves(ok(fakeLocalizationFile as any));
+      sinon.stub(ManifestUtil, "validateManifestAgainstSchema").resolves(["Validation error"]);
+
+      const result = await teamsAppDriver.validateLocalizatoinFiles(
+        args,
+        mockedDriverContext,
+        manifest
+      );
+      chai.assert(result.isErr());
+      if (result.isErr()) {
+        chai.assert.equal(result.error.name, AppStudioError.ValidationFailedError.name);
+      }
+    });
+
+    it("should return error when validation throws exception", async () => {
+      const args: ValidateManifestArgs = { manifestPath: "fakepath" };
+      const manifest = { localizationInfo: { additionalLanguages: [{ file: "filePath" }] } } as any;
+      const fakeLocalizationFile = {};
+
+      sinon.stub(manifestUtils, "_readAppManifest").resolves(ok(fakeLocalizationFile as any));
+      sinon
+        .stub(ManifestUtil, "validateManifestAgainstSchema")
+        .throws(new Error("validation exception"));
+
+      const result = await teamsAppDriver.validateLocalizatoinFiles(
+        args,
+        mockedDriverContext,
+        manifest
+      );
+      chai.assert(result.isErr());
+      if (result.isErr()) {
+        chai.assert.equal(result.error.name, AppStudioError.ValidationFailedError.name);
+      }
+    });
+
+    it("should return ok when localization file is valid", async () => {
+      const args: ValidateManifestArgs = { manifestPath: "fakepath" };
+      const manifest = { localizationInfo: { additionalLanguages: [{ file: "filePath" }] } } as any;
+      const fakeLocalizationFile = {
+        $schema:
+          "https://developer.microsoft.com/en-us/json-schemas/teams/v1.16/MicrosoftTeams.Localization.schema.json",
+      };
+
+      sinon.stub(manifestUtils, "_readAppManifest").resolves(ok(fakeLocalizationFile as any));
+      sinon.stub(ManifestUtil, "validateManifestAgainstSchema").resolves([]);
+
+      const result = await teamsAppDriver.validateLocalizatoinFiles(
+        args,
+        mockedDriverContext,
+        manifest
+      );
+      chai.assert(result.isOk());
+    });
+  });
+
   describe("validate Copilot extensions", async () => {
     it("validate with errors returned", async () => {
       const teamsManifest: TeamsAppManifest = new TeamsAppManifest();