Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use Scarf Gateway for Superset npm downloads #24433

Merged
merged 6 commits into from
Jul 19, 2023

Conversation

arjundevarajan
Copy link
Contributor

@arjundevarajan arjundevarajan commented Jun 16, 2023

SUMMARY

This PR updates the Superset configuration for npm by adding scarf-js as a dependency. This allows Superset maintainers to collect basic de-identified download and adoption metrics. These metrics include which versions of superset are being installed and the origin of installation (git, etc.). This does not have a runtime footprint and adds no additional dependencies beyond itself.

This change was suggested by Superset maintainers in direct discussions. There is also a pull request for updating the Docker compose and helm charts installation methods to retrieve metrics from those pathways.

Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented here and here.

TESTING INSTRUCTIONS

To test this, download Apache Superset using general npm methodology and verify that Apache Superset downloads without issue.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • [ x ] Introduces new feature or API
  • Removes existing feature or API

@rusackas rusackas requested a review from villebro July 8, 2023 19:06
@rusackas
Copy link
Member

rusackas commented Jul 8, 2023

Adding a note here that docs are added on the related PR: #24432

@rusackas rusackas added the v3.0 Label added by the release manager to track PRs to be included in the 3.0 branch label Jul 8, 2023
@rusackas rusackas added the v2.1 label Jul 18, 2023
@codecov
Copy link

codecov bot commented Jul 19, 2023

Codecov Report

Merging #24433 (adf32b2) into master (837e3c5) will not change coverage.
The diff coverage is n/a.

❗ Current head adf32b2 differs from pull request most recent head debe99b. Consider uploading reports for the commit debe99b to get more accurate results

@@           Coverage Diff           @@
##           master   #24433   +/-   ##
=======================================
  Coverage   68.89%   68.89%           
=======================================
  Files        1901     1901           
  Lines       73927    73927           
  Branches     8183     8183           
=======================================
  Hits        50932    50932           
  Misses      20874    20874           
  Partials     2121     2121           
Flag Coverage Δ
javascript 55.71% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@rusackas rusackas merged commit 5878c11 into apache:master Jul 19, 2023
@eschutho eschutho removed the v2.1 label Jul 19, 2023
michael-s-molina pushed a commit that referenced this pull request Jul 26, 2023
Co-authored-by: Arjun Devarajan <arjun.devarajan@scarf.sh>
Co-authored-by: Evan Rusackas <evan@preset.io>
Co-authored-by: Evan Rusackas <evan@rusackas.com>
@mistercrunch mistercrunch added 🍒 3.0.0 🍒 3.0.1 🍒 3.0.2 🍒 3.0.3 🍒 3.0.4 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels labels Mar 8, 2024
vinothkumar66 pushed a commit to vinothkumar66/superset that referenced this pull request Nov 11, 2024
Co-authored-by: Arjun Devarajan <arjun.devarajan@scarf.sh>
Co-authored-by: Evan Rusackas <evan@preset.io>
Co-authored-by: Evan Rusackas <evan@rusackas.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/S v3.0 Label added by the release manager to track PRs to be included in the 3.0 branch 🍒 3.0.0 🍒 3.0.1 🍒 3.0.2 🍒 3.0.3 🍒 3.0.4 🚢 3.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants