feat: Publisher react app #4934

steverydz · 2024-12-09T13:15:33Z

Done

Moved all sections from the publisher pages into a single React application
Replaced template routes with API endpoints.

How to QA

All code has been reviewed on this feature branch so only QA is needed
Go to https://snapcraft-io-4934.demos.haus/<SNAP_NAME>/listing
Go though all the publisher pages and click around
Especially pay attention to any areas you have worked on recently in case there are any regressions
Please put any bugs or issues you find in this epic rather than noting them on this PR (https://warthogs.atlassian.net/browse/WD-14619)

Testing

This PR has tests
No testing required (explain why):

Issue / Card

Fixes https://warthogs.atlassian.net/browse/WD-14619

webteam-app · 2024-12-09T13:15:37Z

Demo

Jenkins

demos.haus

github-actions · 2024-12-09T13:15:53Z

webapp/publisher/snaps/settings_views.py

+def get_settings_data(snap_name):
+    snap_details = publisher_api.get_snap_info(snap_name, flask.session)
+
+    if "whitelist_country_codes" in snap_details:


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:53Z

webapp/publisher/snaps/settings_views.py

+    snap_details = publisher_api.get_snap_info(snap_name, flask.session)
+
+    if "whitelist_country_codes" in snap_details:
+        whitelist_country_codes = (


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:53Z

webapp/publisher/snaps/settings_views.py

+
+    if "whitelist_country_codes" in snap_details:
+        whitelist_country_codes = (
+            snap_details["whitelist_country_codes"]


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:53Z

webapp/publisher/snaps/settings_views.py

+    if "whitelist_country_codes" in snap_details:
+        whitelist_country_codes = (
+            snap_details["whitelist_country_codes"]
+            if len(snap_details["whitelist_country_codes"]) > 0


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:53Z

webapp/publisher/snaps/settings_views.py

+            else []
+        )
+    else:
+        whitelist_country_codes = []


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:54Z

static/js/publisher-pages/types/index.d.ts

@@ -12,3 +12,71 @@ export type ValidationSet = {
  snaps: Snap[];
  timestamp: string;
 };
+
+export type SettingsData = {
+  blacklist_countries: string[];


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] blacklist may be insensitive, use denylist, blocklist instead

github-actions · 2024-12-09T13:15:54Z

static/js/publisher-pages/types/index.d.ts

+
+export type SettingsData = {
+  blacklist_countries: string[];
+  blacklist_country_keys: string;


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] blacklist may be insensitive, use denylist, blocklist instead

github-actions · 2024-12-09T13:15:54Z

static/js/publisher-pages/types/index.d.ts

+  update_metadata_on_release: boolean;
+  visibility: string;
+  visibility_locked: boolean;
+  whitelist_countries: string[];


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:55Z

static/js/publisher-pages/types/index.d.ts

+  visibility: string;
+  visibility_locked: boolean;
+  whitelist_countries: string[];
+  whitelist_country_keys: string;


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] whitelist may be insensitive, use allowlist instead

github-actions · 2024-12-09T13:15:55Z

static/js/publisher-pages/types/index.d.ts

+  issues: { url: string }[];
+  primary_website: string;
+  public_metrics_enabled: boolean;
+  public_metrics_blacklist: string[];


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] blacklist may be insensitive, use denylist, blocklist instead

* feat: migrate metrics page to react

* feat: added downsampling and pagination

Simplify step 1 Simplify step 2 Simplify step 3 Simplify step 4 Simplify step 5

static/js/publisher-pages/pages/Listing/ListingDetails/ImageUpload.tsx

@@ -179,7 +188,7 @@
                  }}
                >
                  <img
-                    src={previewImageUrl}
+                    src={getValues(imageUrlFieldKey)}


To fix the problem, we need to ensure that the value retrieved by getValues(imageUrlFieldKey) is properly sanitized before being used in the src attribute of the img tag. This can be achieved by using a library like DOMPurify to sanitize the value, ensuring that any potentially malicious content is removed.

Import the DOMPurify library.

Use DOMPurify.sanitize to sanitize the value retrieved by getValues(imageUrlFieldKey) before using it in the src attribute.

github-actions · 2024-12-11T15:37:51Z

static/js/publisher-pages/pages/Publicise/PubliciseButtons.tsx

+          >
+            tar.gz
+          </a>
+          <a href="https://raw.githubusercontent.com/snapcore/snap-store-badges/master/LICENSE.md">


[Inclusive naming check] _{reported by reviewdog 🐶}
[warning] master may be insensitive, use primary, main instead

fix: Ignore metrics TS errors for now (#4933) fix: Fix checkbox values resetting in publisher settings form (#4937) fix: Fix primary website field clearing on revert (#4938) fix: Make sure Edit button on preview page closes current tab (#4939) fix: Fix deleting icon or banner not activating save button (#4940) fix: render selected language in HTML and markdown snippets (#4942) fix: remove extra whitespace in embeddable card (#4943) fix: Fix missing contact links in preview (#4944) fix: Fix preview card button being squashed (#4945) fix: Fix display of releases table (#4946) fix: Add loading state to single build page (#4947) fix: ensure markdown is rendered correctly (#4948) fix: build page showing stale data while fetching logs (#4949) fix: Fix missing banner in listing publisher page (#4950) fix: Fix form not resetting when making changes to images (#4952)

github-actions bot reviewed Dec 9, 2024

View reviewed changes

steverydz added the Don't merge label Dec 9, 2024

steverydz changed the title ~~Publisher react app~~ feat: Publisher react app Dec 9, 2024

steverydz added the Review: QA needed label Dec 9, 2024

steverydz and others added 23 commits December 9, 2024 14:46

feat: Move publicise into publisher app (#4844)

b7148d0

feat: Move settings into publisher app (#4847)

8cacd7e

Wd 14634 metrics page (#4851)

fbb281a

* feat: migrate metrics page to react

Wd 15262 improve performance of metric page (#4863)

a69af94

* feat: added downsampling and pagination

chore: Move listing page into publisher app (#4865)

f8dbf3f

feat: add breadcrumb nav to the metrics page (#4871)

2d1670a

feat: Create endpoints to get repo data and builds data (#4873)

175a239

feat: update badge sources (#4892)

46f36b5

feat: Add builds section to publisher pages (#4890)

4453b7c

Simplify step 1 Simplify step 2 Simplify step 3 Simplify step 4 Simplify step 5

feat: Move releases section into the publisher app (#4902)

a7f35e7

fix: Fix publicise disabled notification (#4911)

a303422

fix: Fix issue with saving settings when navigating from listing (#4913)

97b72ac

fix: Fix publicise view for private snaps (#4914)

47ded70

Rebase

655bc4c

fix: Fix issues with tour styles (#4916)

2c77db4

fix: Fix code linting errors in publisher app (#4921)

e2a1395

fix: Fix a11y errors in builds section (#4922)

e69125f

fix: Fix publisher a11y errors in the publicise cards section (#4923)

d6aee20

fix: Fix publisher a11y errors in publicise badges section (#4924)

e192b7a

fix: Fix publisher a11y errors in publicise buttons section (#4925)

8ecf8eb

fix: Fix publisher a11y errors in settings section (#4926)

1d92a4b

fix: Fix a11y errors in license search (#4928)

ca89c9e

fix: Fix a11y errors in search autocomplete (#4929)

bc93343

steverydz force-pushed the publisher-react-app branch from 77a693a to 0dcaeb9 Compare December 9, 2024 14:47

abbiesims force-pushed the publisher-react-app branch from be48c64 to 5716968 Compare December 10, 2024 14:53

github-advanced-security bot found potential problems Dec 11, 2024

View reviewed changes

github-actions bot reviewed Dec 11, 2024

View reviewed changes

steverydz force-pushed the publisher-react-app branch 2 times, most recently from 36c98e8 to 74e7a1e Compare January 6, 2025 13:59

steverydz added Review: Code +1 Review: QA +1 and removed Review: QA needed labels Jan 6, 2025

codeEmpress1 approved these changes Jan 6, 2025

View reviewed changes

steverydz merged commit 5a70885 into main Jan 6, 2025
20 of 30 checks passed

steverydz deleted the publisher-react-app branch January 6, 2025 15:00

@@ -1,2 +1,3 @@
             import { useState, SyntheticEvent } from "react";
+            import DOMPurify from "dompurify";
             import {
@@ -201,3 +202,3 @@
                               <img
-                                src={getValues(imageUrlFieldKey)}
+                                src={DOMPurify.sanitize(getValues(imageUrlFieldKey))}
                                 width={previewWidth}

@@ -107,3 +107,4 @@
                 "webpack-cli": "5.1.4",
-                "whatwg-fetch": "3.6.20"
+                "whatwg-fetch": "3.6.20",
+                "dompurify": "^3.2.3"
               },

Package	Version	Security advisories
dompurify (npm)	3.2.3	None

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Publisher react app #4934

feat: Publisher react app #4934

steverydz commented Dec 9, 2024 •

edited

Loading

webteam-app commented Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

github-actions bot Dec 9, 2024

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

github-actions bot Dec 11, 2024

feat: Publisher react app #4934

feat: Publisher react app #4934

Conversation

steverydz commented Dec 9, 2024 • edited Loading

Done

How to QA

Testing

Issue / Card

webteam-app commented Dec 9, 2024

Demo

Jenkins

demos.haus

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

steverydz commented Dec 9, 2024 •

edited

Loading