|
| 1 | +component extends="wheels.WheelsTest" { |
| 2 | + |
| 3 | + // Regression / extension-point guard for issue #2830. |
| 4 | + // |
| 5 | + // The built-in `/_browser/login-as` fixture (mounted when |
| 6 | + // `application.wheels.loadBrowserTestFixtures = true`) hard-coded its |
| 7 | + // session writes to `session.userId = 1` and `session.userEmail = |
| 8 | + // params.identifier`. Real apps store richer session shapes, so they |
| 9 | + // either had to skip the framework fixture and duplicate the route |
| 10 | + // themselves or patch the vendor tree on every upgrade. |
| 11 | + // |
| 12 | + // The fix introduces `application.wheels.browserLoginAsHandler` — a |
| 13 | + // `"Controller##action"` string the framework reads at route- |
| 14 | + // registration time and uses as the `/_browser/login-as` target in |
| 15 | + // place of `BrowserTestLogin##create`. Env-gating moves to a |
| 16 | + // `wheels.middleware.BrowserTestFixtureGuard` middleware that's |
| 17 | + // attached to the whole `/_browser` scope so the gate still applies |
| 18 | + // when an app supplies its own handler. |
| 19 | + // |
| 20 | + // These tests pin the routing contract: default points at the built- |
| 21 | + // in controller, override redirects to the app's controller, and |
| 22 | + // every `/_browser/*` route declares the env-gate middleware so app |
| 23 | + // handlers don't need to re-implement it. |
| 24 | + |
| 25 | + function beforeAll() { |
| 26 | + _originalRoutes = Duplicate(application.wheels.routes); |
| 27 | + _originalNamed = StructCopy(application.wheels.namedRoutePositions); |
| 28 | + _originalEnv = application.wheels.environment; |
| 29 | + _originalLoadFixtures = StructKeyExists(application.wheels, "loadBrowserTestFixtures") |
| 30 | + ? application.wheels.loadBrowserTestFixtures |
| 31 | + : false; |
| 32 | + _hadHandler = StructKeyExists(application.wheels, "browserLoginAsHandler"); |
| 33 | + _originalHandler = _hadHandler ? application.wheels.browserLoginAsHandler : ""; |
| 34 | + _originalControllerPath = application.wheels.controllerPath; |
| 35 | + _originalStaticRoutes = StructKeyExists(application.wheels, "staticRoutes") |
| 36 | + ? StructCopy(application.wheels.staticRoutes) |
| 37 | + : {}; |
| 38 | + } |
| 39 | + |
| 40 | + function afterAll() { |
| 41 | + application.wheels.routes = _originalRoutes; |
| 42 | + application.wheels.namedRoutePositions = _originalNamed; |
| 43 | + application.wheels.environment = _originalEnv; |
| 44 | + application.wheels.loadBrowserTestFixtures = _originalLoadFixtures; |
| 45 | + application.wheels.controllerPath = _originalControllerPath; |
| 46 | + if (_hadHandler) { |
| 47 | + application.wheels.browserLoginAsHandler = _originalHandler; |
| 48 | + } else if (StructKeyExists(application.wheels, "browserLoginAsHandler")) { |
| 49 | + StructDelete(application.wheels, "browserLoginAsHandler"); |
| 50 | + } |
| 51 | + application.wheels.staticRoutes = _originalStaticRoutes; |
| 52 | + } |
| 53 | + |
| 54 | + function run() { |
| 55 | + describe("browserLoginAsHandler — app-level override of /_browser/login-as fixture (##2830)", () => { |
| 56 | + |
| 57 | + beforeEach(() => { |
| 58 | + application.wheels.environment = "testing"; |
| 59 | + application.wheels.loadBrowserTestFixtures = true; |
| 60 | + }); |
| 61 | + |
| 62 | + it("defaults /_browser/login-as to the framework's BrowserTestLogin##create when no override is set", () => { |
| 63 | + if (StructKeyExists(application.wheels, "browserLoginAsHandler")) { |
| 64 | + StructDelete(application.wheels, "browserLoginAsHandler"); |
| 65 | + } |
| 66 | + |
| 67 | + application.wo.$lockedLoadRoutes(); |
| 68 | + |
| 69 | + var loginRoute = $findRouteByName("browserTestLoginAs"); |
| 70 | + expect(StructIsEmpty(loginRoute)).toBeFalse( |
| 71 | + "expected /_browser/login-as route to be registered when loadBrowserTestFixtures = true" |
| 72 | + ); |
| 73 | + expect(loginRoute.controller).toBe("BrowserTestLogin"); |
| 74 | + expect(loginRoute.action).toBe("create"); |
| 75 | + }); |
| 76 | + |
| 77 | + it("delegates /_browser/login-as to browserLoginAsHandler controller##action when the setting is configured", () => { |
| 78 | + application.wheels.browserLoginAsHandler = "MyAuthFixture##loginAs"; |
| 79 | + |
| 80 | + application.wo.$lockedLoadRoutes(); |
| 81 | + |
| 82 | + var loginRoute = $findRouteByName("browserTestLoginAs"); |
| 83 | + expect(StructIsEmpty(loginRoute)).toBeFalse( |
| 84 | + "expected /_browser/login-as route to be registered when loadBrowserTestFixtures = true" |
| 85 | + ); |
| 86 | + expect(loginRoute.controller).toBe( |
| 87 | + "MyAuthFixture", |
| 88 | + "expected /_browser/login-as to dispatch to the app's controller from application.wheels.browserLoginAsHandler, got controller=" & loginRoute.controller |
| 89 | + ); |
| 90 | + expect(loginRoute.action).toBe("loginAs"); |
| 91 | + }); |
| 92 | + |
| 93 | + it("ignores an empty browserLoginAsHandler setting and falls back to BrowserTestLogin##create", () => { |
| 94 | + application.wheels.browserLoginAsHandler = ""; |
| 95 | + |
| 96 | + application.wo.$lockedLoadRoutes(); |
| 97 | + |
| 98 | + var loginRoute = $findRouteByName("browserTestLoginAs"); |
| 99 | + expect(StructIsEmpty(loginRoute)).toBeFalse(); |
| 100 | + expect(loginRoute.controller).toBe("BrowserTestLogin"); |
| 101 | + expect(loginRoute.action).toBe("create"); |
| 102 | + }); |
| 103 | + |
| 104 | + it("env-gates the /_browser/* scope via BrowserTestFixtureGuard middleware so app handlers still get the gate", () => { |
| 105 | + if (StructKeyExists(application.wheels, "browserLoginAsHandler")) { |
| 106 | + StructDelete(application.wheels, "browserLoginAsHandler"); |
| 107 | + } |
| 108 | + |
| 109 | + application.wo.$lockedLoadRoutes(); |
| 110 | + |
| 111 | + var loginRoute = $findRouteByName("browserTestLoginAs"); |
| 112 | + expect(StructIsEmpty(loginRoute)).toBeFalse(); |
| 113 | + expect(StructKeyExists(loginRoute, "middleware")).toBeTrue( |
| 114 | + "expected /_browser scope to register env-gate middleware on each route" |
| 115 | + ); |
| 116 | + |
| 117 | + var mw = loginRoute.middleware; |
| 118 | + if (IsSimpleValue(mw)) { |
| 119 | + mw = ListToArray(mw); |
| 120 | + } |
| 121 | + var found = false; |
| 122 | + for (var entry in mw) { |
| 123 | + if (FindNoCase("BrowserTestFixtureGuard", entry)) { |
| 124 | + found = true; |
| 125 | + break; |
| 126 | + } |
| 127 | + } |
| 128 | + expect(found).toBeTrue( |
| 129 | + "expected /_browser route middleware to include wheels.middleware.BrowserTestFixtureGuard, got: " & SerializeJSON(mw) |
| 130 | + ); |
| 131 | + }); |
| 132 | + |
| 133 | + }); |
| 134 | + } |
| 135 | + |
| 136 | + private struct function $findRouteByName(required string name) { |
| 137 | + for (var route in application.wheels.routes) { |
| 138 | + if (StructKeyExists(route, "name") && route.name == arguments.name) { |
| 139 | + return route; |
| 140 | + } |
| 141 | + } |
| 142 | + return {}; |
| 143 | + } |
| 144 | + |
| 145 | +} |
![wheels-bot[bot]](https://avatars.githubusercontent.com/in/3657588?v=4&size=40){kind=avatar}
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments