Include Module Version in error messages when module is not found

[ArmaanMcleod]

PR Summary

Fixes #20142

PR Context

Added more user friendly #requires error message when a module cannot be loaded, instead of just the module name.

If you had a required module included like:

#Requires -Modules @{ ModuleName = 'CosmosDB'; RequiredVersion = '4.6.0'}

Previous Behaviour

Just shows module name.

.\test.ps1: The script 'test.ps1' cannot be run because the following modules that are specified by the "#requires" statements of the script are missing: CosmosDB.

Current Behaviour

Includes full RESX message with module name and version.

.\test.ps1: The script 'test.ps1' cannot be run because the following modules that are specified by the "#requires" statements of the script are missing: The module 'CosmosDB' cannot be found with RequiredVersion '4.6.0'.

The new RESX messages are like below for each version type and if no version is specified

#Requires -Modules @{ ModuleName = 'CosmosDB'; RequiredVersion = '4.6.0' }
The module 'CosmosDB' cannot be found with RequiredVersion '4.6.0'. 

#Requires -Modules @{ ModuleName = 'CosmosDB'; ModuleVersion = '4.6.0' }
The module 'CosmosDB' cannot be found with ModuleVersion '4.6.0'.

#Requires -Modules @{ ModuleName = 'CosmosDB'; MaximumVersion = '4.6.0' }
The module 'CosmosDB' cannot be found with MaximumVersion '4.6.0'.

#Requires -Modules @{ ModuleName = 'CosmosDB'; ModuleVersion = '4.6.0';  MaximumVersion = '4.7.0' }
The module 'CosmosDB' cannot be found with ModuleVersion '4.6.0' and MaximumVersion '4.7.0'.

 #Requires -Modules @{ ModuleName = 'CosmosDB' }
The module 'CosmosDB' cannot be found.

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s):
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed
• Tooling
  • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
  • OR
  • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
    • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
      (which runs in a different PS Host).
      • Issue filed:
    • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
      • Issue filed:
    • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
      • Issue filed:
    • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
      • Issue filed:

[iSazonov]

.\test.ps1: The script 'test.ps1' cannot be run because the following modules that are specified by the "#requires" statements of the script are missing: @{ ModuleName = 'CosmosDB'; RequiredVersion = '4.6.0' }.

What if there are some modules?
It seems it is not user-friendly format.

[SteveL-MSFT]

I agree with @iSazonov that the output, although technically correct, isn't the most user friendly particularly those who simply got a script to run. It may be better to have a new resource string in a resx file added and specifically have the module name and module version instead of the hashtable syntax.

[ArmaanMcleod]

I agree with @iSazonov that the output, although technically correct, isn't the most user friendly particularly those who simply got a script to run. It may be better to have a new resource string in a resx file added and specifically have the module name and module version instead of the hashtable syntax.

Thanks @SteveL-MSFT @iSazonov.

I thought the same initially but wasn't sure what format we should include. The hashtable string looks ok for one module but for many it gets quite hard to read.

Could we do something like <Module Name> <Version>? Was also thinking if we should make it clear whether its ModuleVersion, RequiredVersion or MaximumVersion in the message as well?

Or should we have a full resx message like The module <module> cannot be found with required version <version>.

Happy to do whatever is preferred and most user friendly 😄.

[SteveL-MSFT]

@ArmaanMcleod my initial thinking is the latter: The module "<module>" cannot be found with required version <version>.

[iSazonov]

Since the directive has 3 parameters ModuleVersion, MaximumVersion , RequiredVersion (https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_requires?view=powershell-7.3#-modules-module-name--hashtable) my first question is - are two first error messages correct or we should fix them too? I think all three messages should have the same format (not one resx string I mean).

about Requires - PowerShell

Prevents a script from running without the required elements.

[kilasuit]

@ArmaanMcleod my initial thinking is the latter: The module "<module>" cannot be found with required version <version>.

This but if is a max version, not required version then the message should state along lines of The module "<module>" cannot be found with a maximum version of <version>.

So would need both in for full clarity.

[iSazonov]

LGTM with minor proposal.

[SteveL-MSFT]

Great change! Thanks!

[microsoft-github-policy-service]

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

[pull-request-quantifier-deprecated]

This PR has 96 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

---

Quantification details

Label      : Small
Size       : +90 -6
Percentile : 38.4%

Total files changed: 4

Change summary by file extension:
.cs : +28 -1
.resx : +15 -0
.ps1 : +47 -5

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

• Fast and predictable releases to production:
  • Optimal size changes are more likely to be reviewed faster with fewer
    iterations.
  • Similarity in low PR complexity drives similar review times.
• Review quality is likely higher as complexity is lower:
  • Bugs are more likely to be detected.
  • Code inconsistencies are more likely to be detected.
• Knowledge sharing is improved within the participants:
  • Small portions can be assimilated better.
• Better engineering practices are exercised:
  • Solving big problems by dividing them in well contained, smaller problems.
  • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

• Use the PullRequestQuantifier to quantify your PR accurately
  • Create a context profile for your repo using the context generator
  • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
  • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
  • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
• Change your engineering behaviors
  • For PRs that fall outside of the desired spectrum, review the details and check if:
    • Your PR could be split in smaller, self-contained PRs instead
    • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

• One line was added: +1 -0
• One line was deleted: +0 -1
• One line was modified: +1 -1 (git diff doesn't know about modified, it will
  interpret that line like one addition plus one deletion)
• Change percentiles: Change characteristics (addition, deletion, modification)
  of this PR in relation to all other PRs within the repository.

---

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.