From 66e1ef4f08eb830ca63035336c0b742cedbce91d Mon Sep 17 00:00:00 2001 From: Arjun Devarajan Date: Fri, 16 Jun 2023 14:44:23 -0400 Subject: [PATCH 1/6] feat: use Scarf Gateway for Superset npm downloads --- superset-frontend/package.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/superset-frontend/package.json b/superset-frontend/package.json index 5104ad87db2a..57965e4efe3d 100644 --- a/superset-frontend/package.json +++ b/superset-frontend/package.json @@ -204,6 +204,7 @@ "regenerator-runtime": "^0.13.5", "rimraf": "^3.0.2", "rison": "^0.1.1", + "scarf-js": "^1.1.1", "scroll-into-view-if-needed": "^2.2.28", "shortid": "^2.2.6", "tinycolor2": "^1.4.2", @@ -346,6 +347,9 @@ "webpack-manifest-plugin": "^4.1.1", "webpack-sources": "^3.2.3" }, + "scarfSettings": { + "allowTopLevel": true + }, "engines": { "node": "^16.9.1", "npm": "^7.5.4 || ^8.1.2" From 88aef18f7b49f94c7eeb58575518364186c609f4 Mon Sep 17 00:00:00 2001 From: Arjun Devarajan Date: Sat, 17 Jun 2023 09:34:22 -0400 Subject: [PATCH 2/6] Update superset-frontend/package.json Co-authored-by: Evan Rusackas --- superset-frontend/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/superset-frontend/package.json b/superset-frontend/package.json index 57965e4efe3d..ea8e0e0e7df1 100644 --- a/superset-frontend/package.json +++ b/superset-frontend/package.json @@ -204,7 +204,7 @@ "regenerator-runtime": "^0.13.5", "rimraf": "^3.0.2", "rison": "^0.1.1", - "scarf-js": "^1.1.1", + "@scarf/scarf": "^1.1.1", "scroll-into-view-if-needed": "^2.2.28", "shortid": "^2.2.6", "tinycolor2": "^1.4.2", From 2e9b71f2c875d3cf8ba1591599a728733bcb20e1 Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Mon, 10 Jul 2023 10:05:54 -0600 Subject: [PATCH 3/6] adding package lock file --- superset-frontend/package-lock.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/superset-frontend/package-lock.json b/superset-frontend/package-lock.json index 82bb7c360785..6b46482c86d6 100644 --- a/superset-frontend/package-lock.json +++ b/superset-frontend/package-lock.json @@ -21,6 +21,7 @@ "@emotion/styled": "^11.3.0", "@fontsource/inter": "^4.0.0", "@reduxjs/toolkit": "^1.9.3", + "@scarf/scarf": "^1.1.1", "@superset-ui/chart-controls": "file:./packages/superset-ui-chart-controls", "@superset-ui/core": "file:./packages/superset-ui-core", "@superset-ui/legacy-plugin-chart-calendar": "file:./plugins/legacy-plugin-chart-calendar", @@ -12345,6 +12346,12 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, + "node_modules/@scarf/scarf": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.1.1.tgz", + "integrity": "sha512-VGbKDbk1RFIaSmdVb0cNjjWJoRWRI/Weo23AjRCC2nryO0iAS8pzsToJfPVPtVs74WHw4L1UTADNdIYRLkirZQ==", + "hasInstallScript": true + }, "node_modules/@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -72744,6 +72751,11 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, + "@scarf/scarf": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.1.1.tgz", + "integrity": "sha512-VGbKDbk1RFIaSmdVb0cNjjWJoRWRI/Weo23AjRCC2nryO0iAS8pzsToJfPVPtVs74WHw4L1UTADNdIYRLkirZQ==" + }, "@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", From ec12a9272d3677d30819f4f60792c89776c842c6 Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Mon, 10 Jul 2023 10:20:43 -0600 Subject: [PATCH 4/6] Adding npm opt-out instructions --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c5d60f23682..91f224bc03cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -577,6 +577,18 @@ cd superset-frontend npm ci ``` +Note that Superset uses [Scarf](https://docs.scarf.sh) to capture telemetry/analytics about versions being installed, including the `scarf-js` npm package. As noted elsewhere in this documentation, Scarf gathers aggregated stats for the sake of security/release strategy, and does not capture/retain PII. [You can read here](https://docs.scarf.sh/package-analytics/) about the package, and various means to opt out of it, but one easy way to opt out is to add this setting in `superset-frontent/package.json`: +```json +// your-package/package.json +{ + // ... + "scarfSettings": { + "enabled": false + } + // ... +} +``` + #### Build assets There are three types of assets you can build: From 8bb533e64c485ee1b3242634ab41e76ac32c9946 Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Wed, 19 Jul 2023 11:17:27 -0600 Subject: [PATCH 5/6] tweaked package lock --- superset-frontend/package-lock.json | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/superset-frontend/package-lock.json b/superset-frontend/package-lock.json index 6b46482c86d6..1e9eca6f27f0 100644 --- a/superset-frontend/package-lock.json +++ b/superset-frontend/package-lock.json @@ -12318,6 +12318,12 @@ } } }, + "node_modules/@scarf/scarf": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.1.1.tgz", + "integrity": "sha512-VGbKDbk1RFIaSmdVb0cNjjWJoRWRI/Weo23AjRCC2nryO0iAS8pzsToJfPVPtVs74WHw4L1UTADNdIYRLkirZQ==", + "hasInstallScript": true + }, "node_modules/@sigstore/protobuf-specs": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.1.0.tgz", @@ -12346,12 +12352,6 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, - "node_modules/@scarf/scarf": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.1.1.tgz", - "integrity": "sha512-VGbKDbk1RFIaSmdVb0cNjjWJoRWRI/Weo23AjRCC2nryO0iAS8pzsToJfPVPtVs74WHw4L1UTADNdIYRLkirZQ==", - "hasInstallScript": true - }, "node_modules/@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -72729,6 +72729,11 @@ "any-observable": "^0.3.0" } }, + "@scarf/scarf": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.1.1.tgz", + "integrity": "sha512-VGbKDbk1RFIaSmdVb0cNjjWJoRWRI/Weo23AjRCC2nryO0iAS8pzsToJfPVPtVs74WHw4L1UTADNdIYRLkirZQ==" + }, "@sigstore/protobuf-specs": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.1.0.tgz", @@ -72751,11 +72756,6 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, - "@scarf/scarf": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.1.1.tgz", - "integrity": "sha512-VGbKDbk1RFIaSmdVb0cNjjWJoRWRI/Weo23AjRCC2nryO0iAS8pzsToJfPVPtVs74WHw4L1UTADNdIYRLkirZQ==" - }, "@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", From debe99be6a184e5625278f4a39e5a084a93f0d82 Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Wed, 19 Jul 2023 11:50:10 -0600 Subject: [PATCH 6/6] formatting package.json (lint troubles) --- superset-frontend/package.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/superset-frontend/package.json b/superset-frontend/package.json index ea8e0e0e7df1..1a6b202e4be1 100644 --- a/superset-frontend/package.json +++ b/superset-frontend/package.json @@ -86,6 +86,7 @@ "@emotion/styled": "^11.3.0", "@fontsource/inter": "^4.0.0", "@reduxjs/toolkit": "^1.9.3", + "@scarf/scarf": "^1.1.1", "@superset-ui/chart-controls": "file:./packages/superset-ui-chart-controls", "@superset-ui/core": "file:./packages/superset-ui-core", "@superset-ui/legacy-plugin-chart-calendar": "file:./plugins/legacy-plugin-chart-calendar", @@ -204,7 +205,6 @@ "regenerator-runtime": "^0.13.5", "rimraf": "^3.0.2", "rison": "^0.1.1", - "@scarf/scarf": "^1.1.1", "scroll-into-view-if-needed": "^2.2.28", "shortid": "^2.2.6", "tinycolor2": "^1.4.2", @@ -347,9 +347,6 @@ "webpack-manifest-plugin": "^4.1.1", "webpack-sources": "^3.2.3" }, - "scarfSettings": { - "allowTopLevel": true - }, "engines": { "node": "^16.9.1", "npm": "^7.5.4 || ^8.1.2" @@ -361,5 +358,8 @@ } }, "readme": "ERROR: No README data found!", + "scarfSettings": { + "allowTopLevel": true + }, "_id": "superset@0.0.0-dev" }