[core] Add the download tracker package #33899
Conversation
package.json
Outdated
| @@ -7,7 +7,7 @@ | |||
| "deduplicate": "node scripts/deduplicate.js", | |||
| "benchmark:browser": "yarn workspace benchmark browser", | |||
| "build:codesandbox": "lerna run --parallel --scope \"@mui/*\" build", | |||
| "release:version": "lerna version --no-changelog --no-push --no-git-tag-version", | |||
| "release:version": "lerna version --no-changelog --no-push --no-git-tag-version --force-publish=@mui/internal-usage-tracker", | |||
|
This will remain no-op and just be used for install tracking i.e. anything that npm already does? You might want to add explicit docs for that in the package readme. Anything "tracking" will trigger privacy alarms otherwise |
|
Good point, thanks. @samuelsycamore, would you mind taking a look at the README file in this PR to whether it explains our intent clearly? |
There was a problem hiding this comment.
As discussed in https://www.notion.so/mui-org/Define-a-one-year-goal-for-MUI-Core-07-2022-06-2023-d7a69c1f6a1c4f4aafc4c57061e6dbb0.
I have made the page public
to figure out the usage of @mui/base alone.
Did we envision the implications of versioning? I mean, considering that the version of this package won't be bumped, does it mean that it will be more cached than our other developer-facing package, hence not downloaded, hence not increasing the npm download stats, hence not helping?
| @@ -0,0 +1,5 @@ | |||
| # @mui/internal-usage-tracker | |||
There was a problem hiding this comment.
Maybe? So it feels less frightening from a privacy perspective. No, it doesn't include telemetry.
| # @mui/internal-usage-tracker | |
| # @mui/internal-download-tracker |
Same for the title of this PR for the changelog
Also from a namespace perspective, since @mui is shared between all products, maybe a prefix with core would help.
There was a problem hiding this comment.
I like the download tracker since it sounds less scary at a glance
There was a problem hiding this comment.
@mui/core-internal-download-tracker, then?
It will be. The |
michaldudak
changed the title
| "private": false, | ||
| "author": "MUI Team", | ||
| "description": "Internal package to track number of downloads of our design system libraries", | ||
| "main": "./index.js", |
There was a problem hiding this comment.
Are we sure about this one? It doesn't look CommonJS. I'm curious to see if it doesn't break some developers's bundle once released. I guess not since we don't import from it.
There was a problem hiding this comment.
Nothing is ever imported from this package, so it shouldn't break.
Adds a no-op package to track downloads of @mui/material and @mui/joy, and, using this data, be able to figure out the usage of @mui/base alone.
As discussed in https://www.notion.so/mui-org/Define-a-one-year-goal-for-MUI-Core-07-2022-06-2023-d7a69c1f6a1c4f4aafc4c57061e6dbb0.