Is it possible to override the Site object with own fixture during Front End tests of a Plugin?

Development

AI-generated summary

merefield is facing an issue while writing a Front End test for the Locations Plugin. They are attempting to override the Site object with a custom fixture, but the data is not persisting. The test fails due to a missing country_codes attribute.

After investigation, merefield found that the Site object is set by the core test helper and cannot be overridden directly. They tried modifying the fixture in core, but that’s not the desired solution.

Finally, merefield solved the issue by using the needs method to specify the custom fixture for the Site object. The solution involves adding needs.site(cloneJSON(siteFixtures["country_codes.json"])); to the test code. This allows the custom fixture to be used for the scope of the test, resolving the issue.

1

I’m currently working on this PR: FIX: presenting formatted location on User Card by merefield · Pull Request #73 · merefield/discourse-locations · GitHub

I’m attempting to cover the change with a new Front End test.

But the test fails to run because a required data attribute is not defined.

The issue I’m facing is how to successfully override the data within Site with a fixture held here:

https://github.com/paviliondev/discourse-locations/pull/73/files#diff-2832ca21c6e61a472acdc999c8da22e843c1ebec1a0b8d7a7ef85e4a8d5b5065

which contains an additional attribute Site holds when Locations Plugin is present.

… and make it persist for the rest of the test!

The new test is here.

https://github.com/paviliondev/discourse-locations/pull/73/files#diff-4d360f60e91cae2f99c0368cf620bf82c41a22783b590c65b9899802a3ab0f44

I successfully load Site with the fixture, apparently.

I stop at this debugger point during the qunit run in the browser and I can tell it’s correctly loaded:

  test("user card location - shows correct format", async function (assert) {
    const siteAttrs = {
      ...siteFixtures["site.json"].site,
    };
    PreloadStore.store("site", cloneJSON(siteAttrs));
    Site.resetCurrent();
    debugger;
    PreloadStore.get("site")

image

but when the User Card is clicked, the data is not what you’d expect and critically, the country_codes attribute is missing, so the test grinds to a halt, here:

image
image842×126 12.2 KB

Why is my overridden Site data getting lost?

2

OK, this is frustrating.

It looks as though the value of the Site object is set here:

And cannot be overridden?

I’ve checked this out by modifying the fixture in core (here: discourse/app/assets/javascripts/discourse/tests/fixtures/site-fixtures.js at 93a4012ecb3af7306de0c51283d6dd2b2e90818c · discourse/discourse · GitHub) and it picks up my modification.

But I don’t want that, I want to override it in my plugin test with a fixture stored in my plugin.

To re-iterate, I’m able to do that for the scope of the test code but once the plugin code is running, the scope appears to pick up the site object that relates to the fixture loaded by the core test helper …

:thinking:

3

I finally solved this. Worked out you can use needs just as you can for other objects:

Clue here:

Final code:

  needs.site(cloneJSON(siteFixtures["country_codes.json"]));