Updated AIB contract with default portal language #959
Conversation
…act' of https://github.com/microsoft/powerplatform-vscode into users/ramukaritik/default-language-support-to-AIB-contract
The code changes add a new function `findWebsiteYAML` that recursively searches for the `website.yml` file in the given directory and its parent directories. It returns the content of the YAML file if found, or `null` otherwise. The function is used in the `readWebsiteYAML` function to read the `website.yml` file in the workspace folder. This commit message suggests adding the function to read the website YAML file.
| import { CopilotDataverseMetadataFailureEvent, CopilotDataverseMetadataSuccessEvent, CopilotGetEntityFailureEvent, CopilotYamlParsingFailureEvent } from "./telemetry/telemetryConstants"; | ||
| import { getEntityMetadata } from "../../web/client/utilities/fileAndEntityUtil"; | ||
| import { CopilotDataverseMetadataFailureEvent, CopilotDataverseMetadataSuccessEvent, CopilotGetEntityFailureEvent, CopilotGetLanguageCodeFailureEvent, CopilotGetLanguageCodeSuccessEvent, CopilotYamlParsingFailureEvent } from "./telemetry/telemetryConstants"; | ||
| import { getEntityMetadata, getDefaultLanguageCodeWeb } from "../../web/client/utilities/fileAndEntityUtil"; |
There was a problem hiding this comment.
same here - do not introduce dependency on web/client module in common
| const websiteYAMLFilePath = path.join(dir, "website.yml"); | ||
| try { | ||
| const diskRead = await import("fs"); | ||
|
|
There was a problem hiding this comment.
why are we importing this fs here with an await?
There was a problem hiding this comment.
following the pattern used in the code. We had these multiple imports in block level scope.
There was a problem hiding this comment.
Evaluate if this is really adding benefit in performance or is there a specific reason - if not lets keep this at start of file like other modules
src/common/utilities/Utils.ts
Outdated
| ) { | ||
| return null; | ||
| } | ||
| return await findWebsiteYAML(parentDir, workspaceFolderPath); |
There was a problem hiding this comment.
not a great idea to use catch for sceanrio handling
There was a problem hiding this comment.
Using try-catch with async-await makes error handling clear and straightforward, enhancing both readability and robustness. Have updated some bits of the flow.
There was a problem hiding this comment.
better to load exception telemetry and do rest of the code handling in a separate code block
| @@ -89,6 +90,18 @@ export function getFileName(fsPath: string) { | |||
| return fsPath.split(/[\\/]/).pop(); | |||
| } | |||
|
|
|||
| export function getDefaultLanguageCodeWeb() { | |||
There was a problem hiding this comment.
you should not be fetching languages on the fly in copilot using these functions - but as part of init call - check the way we are passing orgId, envId etc. That is the right pattern to use. Otherwise you will land in cross module dependency.
…EnabledPPACFlag as being a required parameter.
…aders The code changes in this commit update the fetchLanguageCodeFromAPI function to use the getCommonHeaders function from the AuthenticationProvider service to set the request headers. This change improves code readability and maintainability by centralizing the logic for setting common headers. Refactor the fetchLanguageCodeFromAPI function to use the getCommonHeaders function for setting request headers.
The code changes in this commit update the findWebsiteYAML function to handle parent directories when the website.yml file is not found in the current directory. It recursively searches for the file in the parent directories until it is found or until the workspace folder path is reached. This change improves the functionality of the findWebsiteYAML function and ensures that the correct YAML file is retrieved. Update findWebsiteYAML function to handle parent directories when searching for website.yml file.
…act' of https://github.com/microsoft/powerplatform-vscode into users/ramukaritik/default-language-support-to-AIB-contract
…d web environments The code changes in this commit update the getDefaultLanguageCode function in the Language/Utils module. It introduces conditional logic to handle different environments: desktop and web. In the desktop environment, the function fetches the language code from an API based on the organization URL and other parameters. In the web environment, the function calls the getDefaultLanguageCodeWeb function. This change improves the functionality of the getDefaultLanguageCode function and ensures the correct language code is retrieved based on the environment. Update getDefaultLanguageCode function to handle desktop and web environments.
The code changes in this commit update the `Utils.ts` file to include the `parseYAMLAndFetchKey` function. This function is used to parse YAML content and fetch a specific key from it. The function is added to the existing `Utils.ts` module and can be used in other parts of the codebase. This change improves the modularity and reusability of the code. Update `Utils.ts` to include `parseYAMLAndFetchKey` function.
|
as per discussion with Neeraj, dropping plan of using "portal Base Language" to localize co-pilot for now, hence closing this PR. |
This pull request primarily focuses on adding support for default portal language code in the
sendApiRequestfunction and related changes in various files. The changes include adding a new parameter to thesendApiRequestfunction, fetching the default language code, and passing it to thesendApiRequestfunction. Additionally, there are changes to telemetry events and utility functions related to finding website YAML files.The most important changes are:
Addition of default portal language code:
src/common/copilot/IntelligenceApiService.ts: ThesendApiRequestfunction now includes a new parameterdefaultPortalLanguageCodewhich is used in the request body. [1] [2]Fetching and passing default language code:
src/common/copilot/PowerPagesCopilot.ts: ThedefaultPortalLanguageCodeis fetched using thegetDefaultLanguageCodefunction and passed to thesendApiRequestfunction. [1] [2] [3]Support for fetching default language code:
src/common/copilot/dataverseMetadata.ts: Added a new functiongetDefaultLanguageCodeto fetch the default language code. This function uses various other helper functions added in this file to read website YAML files and fetch language code from API. [1] [2]Telemetry events:
src/common/copilot/telemetry/telemetryConstants.ts: Added new telemetry eventsCopilotGetLanguageCodeSuccessEventandCopilotGetLanguageCodeFailureEvent.Utility functions:
src/common/utilities/Utils.ts: Added a new functionfindWebsiteYAMLto find YAML files in the website. [1] [2]Additional changes:
src/web/client/schema/constants.ts: Added new keysLANGUAGE_NAME_CODEandLANGUAGE_IDto theEntityMetadataKeyAdxenum.src/web/client/utilities/fileAndEntityUtil.ts: Added a new functiongetDefaultLanguageCodeWebto get the default language code in the web client. [1] [2]