-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: plugin manifest utils (#10959)
* refactor: util * refactor: more refactor: more refactor: fix refactor: fix refactor: template test: fix test: ut 1 test: 2 test: more test: test more test: test 4 test: more test: more refactor: string * refactor: string
- Loading branch information
1 parent
9f3f330
commit 155e086
Showing
17 changed files
with
770 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
packages/fx-core/src/component/driver/teamsApp/utils/PluginManifestUtils.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| import { | ||
| FxError, | ||
| PluginManifestSchema, | ||
| Result, | ||
| TeamsAppManifest, | ||
| err, | ||
| ok, | ||
| } from "@microsoft/teamsfx-api"; | ||
| import fs from "fs-extra"; | ||
| import { FileNotFoundError, JSONSyntaxError } from "../../../../error/common"; | ||
| import stripBom from "strip-bom"; | ||
| import path from "path"; | ||
| import { manifestUtils } from "./ManifestUtils"; | ||
|
|
||
| export class PluginManifestUtils { | ||
| public async readPluginManifestFile( | ||
| path: string | ||
| ): Promise<Result<PluginManifestSchema, FxError>> { | ||
| if (!(await fs.pathExists(path))) { | ||
| return err(new FileNotFoundError("PluginManifestUtils", path)); | ||
| } | ||
| // Be compatible with UTF8-BOM encoding | ||
| // Avoid Unexpected token error at JSON.parse() | ||
| let content = await fs.readFile(path, { encoding: "utf-8" }); | ||
| content = stripBom(content); | ||
|
|
||
| try { | ||
| const manifest = JSON.parse(content) as PluginManifestSchema; | ||
| return ok(manifest); | ||
| } catch (e) { | ||
| return err(new JSONSyntaxError(path, e, "PluginManifestUtils")); | ||
| } | ||
| } | ||
|
|
||
| public async getApiSpecFilePathFromTeamsManifest( | ||
| manifest: TeamsAppManifest, | ||
| manifestPath: string | ||
| ): Promise<Result<string[], FxError>> { | ||
| const pluginFilePathRes = await manifestUtils.getPluginFilePath(manifest, manifestPath); | ||
| if (pluginFilePathRes.isErr()) { | ||
| return err(pluginFilePathRes.error); | ||
| } | ||
| const pluginFilePath = pluginFilePathRes.value; | ||
| const pluginContentRes = await this.readPluginManifestFile(pluginFilePath); | ||
| if (pluginContentRes.isErr()) { | ||
| return err(pluginContentRes.error); | ||
| } | ||
| const apiSpecFiles = await this.getApiSpecFilePathFromPlugin( | ||
| pluginContentRes.value, | ||
| pluginFilePath | ||
| ); | ||
| return ok(apiSpecFiles); | ||
| } | ||
|
|
||
| async getApiSpecFilePathFromPlugin( | ||
| plugin: PluginManifestSchema, | ||
| pluginPath: string | ||
| ): Promise<string[]> { | ||
| const runtimes = plugin.runtimes; | ||
| const files: string[] = []; | ||
| if (!runtimes) { | ||
| return files; | ||
| } | ||
| for (const runtime of runtimes) { | ||
| if (runtime.type === "OpenApi" && runtime.spec?.url) { | ||
| const specFile = path.resolve(path.dirname(pluginPath), runtime.spec.url); | ||
| if (await fs.pathExists(specFile)) { | ||
| files.push(specFile); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return files; | ||
| } | ||
| } | ||
|
|
||
| export const pluginManifestUtils = new PluginManifestUtils(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.