A platform for community discussion. Free, open, simple.
FIX: Stop has_badge leaking between routes (#43487)
Kris748e0df9a8a7
diff --git a/frontend/discourse/app/controllers/badges/show.js b/frontend/discourse/app/controllers/badges/show.jsindex 61ac46b1557..95b35c9d7eb 100644--- a/frontend/discourse/app/controllers/badges/show.js+++ b/frontend/discourse/app/controllers/badges/show.js@@ -50,12 +50,19 @@ export default class ShowController extends Controller {return this.model?.grant_count - this.userBadgesGrantCount;}- @computed("model.allow_title", "model.has_badge", "model")+ @computed("model.id", "userBadgesAll")+ get currentUserHasBadge() {+ return !!this.userBadgesAll?.some(+ (userBadge) => userBadge.badge?.id === this.model?.id+ );+ }++ @computed("model.allow_title", "currentUserHasBadge")get canSelectTitle() {return (this.siteSettings.enable_badges &&this.model?.allow_title &&- this.model?.has_badge+ this.currentUserHasBadge);}diff --git a/frontend/discourse/app/data/normalize.js b/frontend/discourse/app/data/normalize.jsindex d723cdc94a9..fee6397fd7f 100644--- a/frontend/discourse/app/data/normalize.js+++ b/frontend/discourse/app/data/normalize.js@@ -10,8 +10,11 @@ import { TopicDetailsSchema } from "discourse/data/schemas/topic-details";import { UserBadgeSchema } from "discourse/data/schemas/user-badge";import { badgeGroupingDisplayName } from "discourse/models/badge-grouping";-function badgeResource(raw, includedIds) {+function badgeResource(raw, includedIds, { grantsKnown = false } = {}) {const resource = resourceFrom("badge", BadgeSchema, raw);+ if (grantsKnown) {+ resource.attributes.has_badge = raw.has_badge ?? false;+ }const relationships = {};maybeRelate(relationships,@@ -89,11 +92,14 @@ export function normalizeBadgesPayload(payload) {collectBadgeMetaIncluded(payload, included);const includedIds = indexIncluded(included);+ const opts = { grantsKnown: true };if (payload.badge) {- return { data: badgeResource(payload.badge, includedIds), included };+ return { data: badgeResource(payload.badge, includedIds, opts), included };}return {- data: (payload.badges ?? []).map((raw) => badgeResource(raw, includedIds)),+ data: (payload.badges ?? []).map((raw) =>+ badgeResource(raw, includedIds, opts)+ ),included,};}diff --git a/frontend/discourse/app/templates/badges/index.gjs b/frontend/discourse/app/templates/badges/index.gjsindex 0f3c353348a..b5ef7e66e8c 100644--- a/frontend/discourse/app/templates/badges/index.gjs+++ b/frontend/discourse/app/templates/badges/index.gjs@@ -27,6 +27,7 @@ export default <template>{{#each bg.badges as |b|}}<DBadgeCard@badge={{b}}+ @granted={{b.has_badge}}@username={{@controller.currentUser.username}}/>{{/each}}diff --git a/frontend/discourse/app/templates/badges/show.gjs b/frontend/discourse/app/templates/badges/show.gjsindex bf78ac6270c..4ed8c0e2082 100644--- a/frontend/discourse/app/templates/badges/show.gjs+++ b/frontend/discourse/app/templates/badges/show.gjs@@ -28,6 +28,7 @@ export default <template><DBadgeCard@badge={{@controller.model}}@count={{@controller.userBadgesGrantCount}}+ @granted={{@controller.currentUserHasBadge}}@size="large"/><divdiff --git a/frontend/discourse/app/ui-kit/d-badge-card.gjs b/frontend/discourse/app/ui-kit/d-badge-card.gjsindex 81bde805688..6fccdf10b5c 100644--- a/frontend/discourse/app/ui-kit/d-badge-card.gjs+++ b/frontend/discourse/app/ui-kit/d-badge-card.gjs@@ -53,7 +53,7 @@ export default class DBadgeCard extends Component {ids.push(`badge-granted-${badge.slug}`);}- if (badge.has_badge) {+ if (this.args.granted) {ids.push(`badge-awarded-${badge.slug}`);}@@ -112,7 +112,7 @@ export default class DBadgeCard extends Component {</div></div>- {{#if @badge.has_badge}}+ {{#if @granted}}<divaria-label={{i18n "notifications.titles.granted_badge"}}class="check-display status-checked"diff --git a/frontend/discourse/tests/acceptance/badges-test.js b/frontend/discourse/tests/acceptance/badges-test.jsindex 136ca47de7a..318725d2573 100644--- a/frontend/discourse/tests/acceptance/badges-test.js+++ b/frontend/discourse/tests/acceptance/badges-test.js@@ -38,6 +38,17 @@ acceptance("Badges", function (needs) {"CustomBadge");});++ test("marks a badge the current user holds as granted", async function (assert) {+ await visit("/badges/50/custombadge");++ assert+ .dom(".show-badge-details .check-display")+ .exists("the badge is marked as granted");+ assert+ .dom(".badge-grant-info .btn-default")+ .exists("the badge title can be selected");+ });});acceptance("Badges - favorites", function (needs) {diff --git a/frontend/discourse/tests/integration/ui-kit/d-badge-card-test.gjs b/frontend/discourse/tests/integration/ui-kit/d-badge-card-test.gjsnew file mode 100644index 00000000000..1d7bfe3964b--- /dev/null+++ b/frontend/discourse/tests/integration/ui-kit/d-badge-card-test.gjs@@ -0,0 +1,47 @@+import { render } from "@ember/test-helpers";+import { module, test } from "qunit";+import { setupRenderingTest } from "discourse/tests/helpers/component-test";+import DBadgeCard from "discourse/ui-kit/d-badge-card";++module("Integration | ui-kit | DBadgeCard", function (hooks) {+ setupRenderingTest(hooks);++ test("granted", async function (assert) {+ const badge = { slug: "custombadge" };++ await render(+ <template><DBadgeCard @badge={{badge}} @granted={{true}} /></template>+ );++ assert.dom(".check-display").exists();+ assert+ .dom(".badge-link")+ .hasAttribute(+ "aria-describedby",+ "badge-summary-custombadge badge-awarded-custombadge"+ );+ });++ test("not granted", async function (assert) {+ const badge = { slug: "custombadge" };++ await render(<template><DBadgeCard @badge={{badge}} /></template>);++ assert.dom(".check-display").doesNotExist();+ assert+ .dom(".badge-link")+ .hasAttribute("aria-describedby", "badge-summary-custombadge");+ });++ test("ignores has_badge on the badge itself", async function (assert) {+ const badge = { slug: "custombadge", has_badge: true };++ await render(<template><DBadgeCard @badge={{badge}} /></template>);++ assert+ .dom(".check-display")+ .doesNotExist(+ "the caller says who holds the badge, not the shared record"+ );+ });+});diff --git a/frontend/discourse/tests/unit/models/badge-test.js b/frontend/discourse/tests/unit/models/badge-test.jsindex 09da3cd9f15..f53e762aa8c 100644--- a/frontend/discourse/tests/unit/models/badge-test.js+++ b/frontend/discourse/tests/unit/models/badge-test.js@@ -2,6 +2,7 @@ import { getOwner } from "@ember/owner";import { setupTest } from "ember-qunit";import { module, test } from "qunit";import Badge from "discourse/models/badge";+import UserBadge from "discourse/models/user-badge";import pretender, {parsePostData,response,@@ -49,6 +50,86 @@ module("Unit | Model | badge", function (hooks) {assert.false(Array.isArray(badge), "does not returns an array");});+ test("has_badge is kept when the payload provides it", function (assert) {+ const badges = Badge.createFromJson({+ badge_types: [{ id: 6, name: "Silver 1" }],+ badges: [+ {+ id: 1127,+ name: "Badge 1",+ description: null,+ badge_type_id: 6,+ has_badge: true,+ },+ {+ id: 1128,+ name: "Badge 2",+ description: null,+ badge_type_id: 6,+ has_badge: false,+ },+ ],+ });++ assert.true(badges[0].has_badge, "true is preserved");+ assert.false(badges[1].has_badge, "false is preserved");+ });++ test("has_badge is cleared by a payload that omits it", function (assert) {+ Badge.createFromJson({+ badge_types: [{ id: 6, name: "Silver 1" }],+ badges: [+ {+ id: 1126,+ name: "Badge 1",+ description: null,+ badge_type_id: 6,+ has_badge: true,+ },+ ],+ });++ const sideloaded = Badge.createFromJson({+ badge_types: [{ id: 6, name: "Silver 1" }],+ badges: [+ { id: 1126, name: "Badge 1", description: null, badge_type_id: 6 },+ ],+ });++ assert.false(+ sideloaded[0].has_badge,+ "a payload that cannot know about the viewer's grants clears the flag"+ );+ });++ test("has_badge survives a badge sideloaded with user badges", function (assert) {+ Badge.createFromJson({+ badge_types: [{ id: 6, name: "Silver 1" }],+ badges: [+ {+ id: 1129,+ name: "Badge 1",+ description: null,+ badge_type_id: 6,+ has_badge: true,+ },+ ],+ });++ const userBadges = UserBadge.createFromJson({+ badge_types: [{ id: 6, name: "Silver 1" }],+ badges: [+ { id: 1129, name: "Badge 1", description: null, badge_type_id: 6 },+ ],+ user_badges: [{ id: 42, badge_id: 1129, granted_at: "2020-01-01" }],+ });++ assert.true(+ userBadges[0].badge.has_badge,+ "a payload that cannot know the viewer's grants leaves the flag alone"+ );+ });+test("updateFromJson", function (assert) {const store = getOwner(this).lookup("service:store");const badge = store.createRecord("badge", { name: "Badge 1" });