Skip to content

Adding missing guard for telemetry optout to avoid NRE when importing modules#18949

Merged
iSazonov merged 1 commit intoPowerShell:masterfrom
powercode:telemetry_fix
Jan 31, 2023
Merged

Adding missing guard for telemetry optout to avoid NRE when importing modules#18949
iSazonov merged 1 commit intoPowerShell:masterfrom
powercode:telemetry_fix

Conversation

@powercode
Copy link
Copy Markdown
Collaborator

@powercode powercode commented Jan 16, 2023

PR Summary

Adding a guard to SendModuleTelemetryMetric to avoid a NRE when accessing s_knownModules.

        internal static void SendModuleTelemetryMetric(TelemetryType telemetryType, string moduleName, string moduleVersion = AnonymousVersion)
        {
            if (!CanSendTelemetry)
            {
                return;
            }

            try

The same guard is present in SendTelemetryMetric a few lines below.

A callstack that triggers the NRE is

Microsoft.PowerShell.Telemetry.ApplicationInsightsTelemetry.GetModuleName(string moduleNameToValidate) Line 197	C#
Microsoft.PowerShell.Telemetry.ApplicationInsightsTelemetry.SendModuleTelemetryMetric(Microsoft.PowerShell.Telemetry.TelemetryType telemetryType, string moduleName, string moduleVersion) Line 143	C#
Microsoft.PowerShell.Commands.ImportModuleCommand.ImportModule_LocallyViaName_WithTelemetry(Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions importModuleOptions, string name) Line 518	C#
Microsoft.PowerShell.Commands.ImportModuleCommand.ProcessRecord() Line 1262	C#

PR Context

PR Checklist

@ghost ghost assigned daxian-dbw Jan 16, 2023
@iSazonov iSazonov requested a review from JamesWTruher January 16, 2023 11:25
@powercode
Copy link
Copy Markdown
Collaborator Author

powercode commented Jan 16, 2023 •
edited
Loading

The build failures seem to be unrelated to the change.

@iSazonov iSazonov closed this Jan 16, 2023
@iSazonov iSazonov reopened this Jan 16, 2023
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented Jan 16, 2023

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

Quantification details 

Label      : Extra Small
Size       : +2 -0
Percentile : 0.8%

Total files changed: 1

Change summary by file extension:
.cs : +2 -0

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.

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Jan 16, 2023

Reopen to restart prediction tests.

@ghost ghost added the Review - Needed The PR is being reviewed label Jan 24, 2023
@ghost
Copy link
Copy Markdown

ghost commented Jan 24, 2023

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

JamesWTruher
JamesWTruher approved these changes Jan 30, 2023
View reviewed changes
Copy link
Copy Markdown
Collaborator

@JamesWTruher JamesWTruher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yah - I found this as well, thanks very much!

@iSazonov iSazonov added CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log and removed Review - Needed The PR is being reviewed labels Jan 31, 2023
@iSazonov iSazonov assigned iSazonov and unassigned daxian-dbw Jan 31, 2023
@iSazonov iSazonov merged commit 4e80e76 into PowerShell:master Jan 31, 2023
@powercode powercode deleted the telemetry_fix branch February 3, 2023 09:42
@ghost
Copy link
Copy Markdown

ghost commented Mar 14, 2023

🎉v7.4.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

@ghost
Copy link
Copy Markdown

ghost commented Apr 13, 2023

🎉v7.3.4 has been released which incorporates this pull request.:tada:

Handy links:

adityapatwardhan pushed a commit to adityapatwardhan/PowerShell that referenced this pull request Apr 25, 2023
@powercode @daxian-dbw
Adding missing guard for telemetry optout to avoid NRE when importing…
142b17e 
… modules (PowerShell#18949)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

+1 more reviewer

@JamesWTruher JamesWTruher JamesWTruher approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@iSazonov iSazonov

Labels

Backport-7.3.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@powercode @iSazonov @JamesWTruher @SteveL-MSFT @daxian-dbw @adityapatwardhan