[Telemetry] Address package name limitations #14252
Conversation
| return false; | ||
| } | ||
|
|
||
| export function cleanTelemetryPackageName(str: string): string { |
There was a problem hiding this comment.
Not that it affects any of the packages, but there is no check to trim the package name if it's over 100 characters,
There was a problem hiding this comment.
Might be worth putting it in though, if it's an actual requirement.
| } | ||
| "include": [ | ||
| "src", | ||
| "../telemetry/src/utils/nameHelpers.ts" |
There was a problem hiding this comment.
You don't want to cross include packages, like this, don't include this here. You won't need it if you properly export the nameHelpers functions from the telemetry package, and remember to re-build the telemetry package so you can see them in this package.
| @@ -18,7 +18,7 @@ import { | |||
| findPropertyValue, | |||
| tryFindPropertyValueAsBoolean, | |||
| } from '../commands/config/configUtils'; | |||
| import * as nameHelpers from '../utils/nameHelpers'; | |||
| import * as nameHelpers from '@react-native-windows/telemetry/src/utils/nameHelpers'; | |||
There was a problem hiding this comment.
See the above comment for properly exporting the functions you need and consuming them here.
| @@ -29,7 +29,7 @@ import { | |||
| endTelemetrySession, | |||
| } from '../../utils/telemetryHelpers'; | |||
| import {copyAndReplaceWithChangedCallback} from '../../generator-common'; | |||
| import * as nameHelpers from '../../utils/nameHelpers'; | |||
| import * as nameHelpers from '@react-native-windows/telemetry/src/utils/nameHelpers'; | |||
There was a problem hiding this comment.
Look at telemetry/index.ts to see how to export the functions we need there (isValidProjectNamespace, isValidProjectName, cleanName, cleanNamespace). Then you can import those functions here with:
| import * as nameHelpers from '@react-native-windows/telemetry/src/utils/nameHelpers'; | |
| import {isValidProjectNamespace, isValidProjectName, cleanName, cleanNamespace} from '@react-native-windows/telemetry'; |
| return false; | ||
| } | ||
|
|
||
| export function cleanTelemetryPackageName(str: string): string { |
There was a problem hiding this comment.
Might be worth putting it in though, if it's an actual requirement.
microsoft-github-policy-service
bot
added
the
Needs: Author Feedback
Description
Fix to ensure that telemetry package names contain only the following characters: alphanumeric, underscore, dot. Also, make sure it starts with letter, and it has 100 characters or less.
Resolves #14218
Type of Change
Why
The telemetry backend doesn't like that some of the packages contain characters like
@and-. This is problematic when trying to create dimensions that depend on the version of packages like:react-native-windows@react-native-community/cliWhat
nameHelpersmodule from CLI to telemetry.nameHelpersto verify and process package names. Replace all "bad" characters with underscores.nameHelperstests to its own file, plus added test cases for the newnameHelpersfunctions.Screenshots
N/A
Testing
Added new test cases to nameHelpers, and verified in the telemetry backend that all package versions are uploaded.
Changelog
No
Microsoft Reviewers: Open in CodeFlow