Skip to content

Commit 21ff2f7

Browse files
authored
Merge pull request #10341 from MicrosoftDocs/matp-4243095
Matp 4243095
2 parents 7318161 + 3d07720 commit 21ff2f7

File tree

1 file changed

+33
-23
lines changed

1 file changed

+33
-23
lines changed

powerapps-docs/maker/data-platform/use-powerapps-checker.md

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
11
---
22
title: Improve component performance, stability, and reliability with solution checker
3-
description: Use solution checker to analyze Dataverse customizations to enhance user experience.
3+
description: Use solution checker to analyze Microsoft Dataverse customizations to enhance user experience.
44
author: Mattp123
55
ms.component: cds
66
ms.topic: article
7-
ms.date: 05/07/2024
7+
ms.date: 07/30/2024
88
ms.subservice: dataverse-maker
99
ms.author: matp
10+
ai-usage: ai-assisted
1011
search.audienceType:
1112
- maker
1213
---
13-
# Improve component performance, stability and reliability with solution checker
14+
# Improve solution performance, stability and reliability
1415

15-
To deliver on complex business requirements, makers often can end up with highly advanced solutions that customize and extend the Microsoft Dataverse platform. With advanced implementations come an increased risk where performance, stability, and reliability issues become introduced, which can negatively impact the user experience. Identifying and understanding how to resolve these issues can be complicated and time consuming. With the solution checker feature, you can perform a rich static analysis check on your solutions against a set of best practice rules and quickly identify these problematic patterns. After the check completes, you receive a detailed report that lists the issues identified, the components and code affected, and links to documentation that describes how to resolve each issue.
16+
Solutions are used to distribute Power Platform objects, such as apps, tables, flows, web resources, and plugins. This article introduces the solution checker feature, a powerful tool that performs a comprehensive static analysis of your solution objects against a set of [best practice rules](#best-practice-rules-used-by-solution-checker). By using solution checker, you can quickly identify problematic patterns in your components and receive detailed reports that highlight issues, affected components, and provide links to documentation on how to resolve each issue. This ensures your solutions are optimized for performance, stability, and reliability.
17+
18+
:::image type="content" source="media/solution-checker-viewresults.png" alt-text="Solution checker example results and details" lightbox="media/solution-checker-viewresults.png":::
19+
20+
Solution checker works with unmanaged solutions that can be exported from an environment.
21+
22+
You can run solution checker either from Power Apps (make.powerapps.com) or by using [PowerShell](#run-solution-checker-using-powershell).
23+
24+
## How solution checker helps you
25+
26+
To deliver on complex business requirements, makers often can end up with highly advanced solutions that customize and extend the Power Platform. With advanced implementations come an increased risk where performance, stability, and reliability issues become introduced, which can negatively impact the user experience. Identifying and understanding how to resolve these issues can be complicated and time consuming. With the solution checker feature, you can perform a check within seconds on your solution, which uses a set of best practice rules to quickly identify problematic patterns. After the check completes, you receive a detailed report in Power Apps as well as in an email message that lists the issues identified, the components and code affected, and links to documentation that describes how to resolve each issue.
1627

1728
The solution checker analyzes these solution components:
1829

@@ -22,13 +33,10 @@ The solution checker analyzes these solution components:
2233
- Power Automate flows (via [flow checker](/power-automate/error-checker))
2334
- Power Fx expressions (via [app checker](https://powerapps.microsoft.com/en-us/blog/new-app-checker-helps-you-fix-errors-and-make-accessible-apps/))
2435

25-
Solution checker works with unmanaged solutions that can be exported from an environment.
26-
2736
> [!NOTE]
2837
>
29-
> - This topic explains how to run solution checker from the Power Apps maker portal. A PowerShell module is also available that you can use to interact directly with the service. The Microsoft.PowerApps.Checker.PowerShell module can be used for analysis of unmanaged solutions for Power Apps environments, or to automate and integrate the service into your build and release pipelines. More information: [Microsoft.PowerApps.Checker.PowerShell Overview]( /powershell/powerapps/get-started-powerapps-checker?view=pa-ps-latest&preserve-view=true)
3038
> - Solution checker supports global variables for ECMAScript 2015 (ES6) and up to ECMAScript 2018 (ES9) syntax. When JavaScript is detected using global variables later than ES6 or syntax later than ES9, a web-unsupported-syntax issue for the web resource is reported.
31-
> - Use of solution checker does not guarantee that a solution import will be successful. The static analysis checks performed against the solution do not know the configured state of the destination environment and import success may be dependent on other solutions or configurations in the environment.
39+
> - Use of solution checker doesn't guarantee that a solution import will be successful. The static analysis checks performed against the solution don't know the configured state of the destination environment and import success might be dependent on other solutions or configurations in the environment.
3240
3341
## Run the solution checker
3442

@@ -41,13 +49,12 @@ Solution checker works with unmanaged solutions that can be exported from an env
4149
4250
4. The **Solution checker** command button has a loading indicator, and you'll notice a **Running…** state in the **Solution check** column of the **Solution** list.
4351

44-
> [!div class="mx-imgBorder"]
45-
> ![Solution checker status.](media/solution-checker-status.png "Solution checker status")
46-
47-
Note the following:
48-
- The solution checker can take a few minutes to complete the analysis.
52+
:::image type="content" source="media/solution-checker-status.png" alt-text="Solution checker status" lightbox="media/solution-checker-status.png":::
4953

50-
- You'll receive an email notification and a notification in the **Notifications** area of the Power Apps site when the check is completed.
54+
> [!NOTE]
55+
>
56+
> - The solution checker can take a few minutes to complete the analysis.
57+
> - You'll receive an email notification and a notification in the **Notifications** area of the Power Apps site when the check is completed.
5158
5259
5. [View the report](#review-the-solution-checker-report) when the check is completed.
5360

@@ -69,7 +76,7 @@ When you install the solution checker in your environment, the **Solution check*
6976
|Results as of *date and time* | Solution analysis completed and results are available for download. |
7077
|Couldn’t be completed. Result as of *date and time* | The latest analysis request didn't complete successfully. The last successful results can be downloaded. |
7178
|Checked by Microsoft | This is a Microsoft-managed solution. Solution analysis isn't permitted on these solutions. |
72-
|Checked by Publisher | This is a third-party-managed solution. Currently, solution analysis isn't available for these solutions. |
79+
|Checked by Publisher | This is a non-Microsoft managed solution. Currently, solution analysis isn't available for these solutions. |
7380

7481
## Review the solution checker report
7582

@@ -79,8 +86,7 @@ When a solution check is completed, you can view the analysis report in the port
7986
2. Next to the unmanaged solution where you want to view the solution checker report, select **...**, point to **Solution checker**, and then select **View results**.
8087
3. Select an issue to view the details and guidance on how to resolve.
8188

82-
> [!div class="mx-imgBorder"]
83-
> ![Solution checker view results.](media/solution-checker-viewresults.png "Solution checker view results")
89+
:::image type="content" source="media/solution-checker-viewresults.png" alt-text="Solution checker example results and details drill down" lightbox="media/solution-checker-viewresults.png":::
8490

8591
The solution check results are also available for download. The solution checker zip file is downloaded to the folder specified by your web browser. The download report is in [!INCLUDE [pn-excel-short](../../includes/pn-excel-short.md)] format and contains several visualizations and columns that assist you in identifying the impact, type, and ___location of each issue detected in your solution. A link to detailed guidance about how to resolve the issue is also provided.
8692

@@ -109,6 +115,10 @@ Here's a summary of each column in the report.
109115

110116
You can run solution checker rules in your development environment to detect issues much sooner as you create your solution resources. This is currently supported for web resources (JavaScript and [TypeScript](https://typescript-eslint.io/)). For more details, go to the NPM package [@microsoft/eslint-plugin-power-apps](https://www.npmjs.com/package/@microsoft/eslint-plugin-power-apps).
111117

118+
## Run solution checker using PowerShell
119+
120+
A PowerShell module is available that you can use to interact directly with the service. The Microsoft.PowerApps.Checker.PowerShell module can be used for analysis of unmanaged solutions for Power Apps environments, or to automate and integrate the service into your build and release pipelines. More information: [Microsoft.PowerApps.Checker.PowerShell Overview]( /powershell/powerapps/get-started-powerapps-checker?view=pa-ps-latest&preserve-view=true)
121+
112122
## Best practice rules used by solution checker
113123

114124
The following table lists the component type, rule description, severity, and category. Critical violations are blocked or warned when configured for solution checker enforcement with managed environments. More information: [Use solution checker in Managed Environments](/power-platform/admin/managed-environment-solution-checker)
@@ -147,26 +157,26 @@ The following table lists the component type, rule description, severity, and ca
147157
|Web Resources | [use-utility-dialogs](./powerapps-checker/rules/web/use-utility-dialogs.md) | | Medium | Usage |
148158
|Web Resources | [avoid-isActivityType](./powerapps-checker/rules/web/avoid-isactivitytype.md) | Replace Xrm.Utility.isActivityType method with new Xrm.Utility.gettableMetadata and don't use in ribbon rules. | Medium | Upgrade readiness |
149159
|Web Resources | [meta-avoid-silverlight](/power-platform/important-changes-coming?client=PAChecker&error=meta-avoid-silverlight&source=featuredocs) | Silverlight web resource usage is deprecated. | Medium | Upgrade readiness |
150-
| Web Resources | [remove-debug-script](../../developer/model-driven-apps/best-practices/index.md?client=PAChecker&error=web-remove-debug-script) | Avoid including debug script in non-development environments. | Medium | Usage |
160+
| Web Resources | [remove-debug-script](../../developer/model-driven-apps/best-practices/index.md?client=PAChecker&error=web-remove-debug-script) | Avoid including debug script in nondevelopment environments. | Medium | Usage |
151161
| Web Resources | [use-strict-mode](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Strict_mode/Transitioning_to_strict_mode) | Use strict mode when possible. | Medium | Usage |
152162
| Web Resources | [use-strict-equality-operators](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness) | Use strict equality operators. | Medium | Usage |
153-
| Web Resources | [avoid-eval](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/eval) | Don't use the 'eval' function or its functional equivalents. | Critical | Security |
163+
| Web Resources | [avoid-eval](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/eval) | Don't use the `eval` function or its functional equivalents. | Critical | Security |
154164
| Web Resources | [avoid-with](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/with) | Don't use the 'with' operator. | High | Performance |
155165
| Web Resources | [remove-alert](https://eslint.org/docs/rules/no-alert) | Don't use the 'alert' function or its functional equivalents. | Medium | Usage |
156166
| Web Resources | [remove-console](https://eslint.org/docs/rules/no-console) | Avoid using methods on console. | Medium | Usage |
157167
| Web Resources | [avoid-ui-refreshribbon](./powerapps-checker/rules/web/avoid-ui-refreshribbon.md) | Avoid using refreshRibbon in form onload and EnableRule. | Critical | Performance |
158168
| Web Resources | [use-getsecurityroleprivilegesinfo](./powerapps-checker/rules/web/use-getsecurityroleprivilegesinfo.md) | Avoid userSettings.securityRolePrivileges. Use userSettings.getSecurityRolePrivilegesInfo instead. | High | Performance |
159169
| Web Resources | [use-appsidepane-api](./powerapps-checker/rules/web/use-appsidepane-api.md) | Use Xrm.App.sidePanes.createPane instead of Xrm.Panels.loadPanel. | Medium | Upgrade readiness |
160-
| Web Resources | [web-sdl-no-cookies](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-cookies.md) | HTTP cookies are an old client-side storage mechanism with inherent risks and limitations. Use Web Storage, IndexedDB or other modern methods instead. | Medium | Security |
170+
| Web Resources | [web-sdl-no-cookies](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-cookies.md) | HTTP cookies are an old client-side storage mechanism with inherent risks and limitations. Use Web Storage, IndexedDB, or other modern methods instead. | Medium | Security |
161171
| Web Resources | [web-sdl-no-document-___domain](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-document-___domain.md) | Writes to document.___domain property must be reviewed to avoid bypass of same-origin checks. Usage of top level domains such as azurewebsites.net is strictly prohibited. | Medium | Security |
162172
| Web Resources | [web-sdl-no-document-write](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-document-write.md) | Calls to document.write or document.writeln manipulate DOM directly without any sanitization and should be avoided. Use document.createElement() or similar methods instead. | Medium | Security |
163-
| Web Resources | [web-sdl-no-html-method](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-html-method.md) | Direct calls to method html() often (e.g. in jQuery framework) manipulate DOM without any sanitization and should be avoided. Use document.createElement() or similar methods instead. | Medium | Security |
173+
| Web Resources | [web-sdl-no-html-method](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-html-method.md) | Direct calls to method html() often (for example, in jQuery framework) manipulate DOM without any sanitization and should be avoided. Use document.createElement() or similar methods instead. | Medium | Security |
164174
| Web Resources | [web-sdl-no-inner-html](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-inner-html.md) |Assignments to innerHTML or outerHTML properties manipulate DOM directly without any sanitization and should be avoided. Use document.createElement() or similar methods instead. | Medium | Security |
165175
| Web Resources | [web-sdl-no-insecure-url](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-insecure-url.md) | Insecure protocols such as HTTP or FTP should be replaced by their encrypted counterparts (HTTPS, FTPS) to avoid sending potentially sensitive data over untrusted networks in plaintext. | Medium | Security |
166176
| Web Resources | [web-sdl-no-msapp-exec-unsafe](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-msapp-exec-unsafe.md) | Calls to MSApp.execUnsafeLocalFunction() bypass script injection validation and should be avoided. | Medium | Security |
167177
| Web Resources | [web-sdl-no-postmessage-star-origin](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-postmessage-star-origin.md) | Always provide specific target origin, not * when sending data to other windows using postMessage to avoid data leakage outside of trust boundary. | Medium | Security |
168-
| Web Resources | [web-sdl-no-winjs-html-unsafe](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-winjs-html-unsafe.md) | Calls to WinJS.Utilities.setInnerHTMLUnsafe() and similar methods do not perform any input validation and should be avoided. Use WinJS.Utilities.setInnerHTML() instead. | Medium | Security |
169-
| Canvas App | [app-formula-issues-high](/powerapps/maker/canvas-apps/formula-reference) | Refer to Power Apps formula references for additional details. | Critical | Design |
178+
| Web Resources | [web-sdl-no-winjs-html-unsafe](https://github.com/microsoft/eslint-plugin-sdl/blob/main/docs/rules/no-winjs-html-unsafe.md) | Calls to WinJS.Utilities.setInnerHTMLUnsafe() and similar methods don't perform any input validation and should be avoided. Use WinJS.Utilities.setInnerHTML() instead. | Medium | Security |
179+
| Canvas App | [app-formula-issues-high](/powerapps/maker/canvas-apps/formula-reference) | Go to [Power Apps formula reference](/power-platform/power-fx/formula-reference) for additional details. | Critical | Design |
170180
| Canvas App | [app-formula-issues-medium](/powerapps/maker/canvas-apps/formula-reference) | Refer to Power Apps formula references for additional details. | Medium | Design |
171181
| Canvas App | [app-formula-issues-low](/powerapps/maker/canvas-apps/formula-reference) | Refer to Power Apps formula references for additional details. | Low | Design |
172182
| Canvas App | [app-use-delayoutput-text-input](/powerapps/maker/canvas-apps/performance-tips#use-delayed-load) | Use delayed load in some scenarios to improve performance. | Medium | Performance |

0 commit comments

Comments
 (0)