feat(server): create client-version-check route [WPB-23299] #20307

screendriver · 2026-02-04T14:01:14Z

WPB-23299 [Web] Add support for remote force reload

Pull Request

Summary

Start to implement a force-reload feature.

Security Checklist (required)

External inputs are validated & sanitized on client and/or server where applicable.
API responses are validated; unexpected shapes are handled safely (fallbacks or errors).
No unsafe HTML is rendered; if unavoidable, sanitization is applied and documented where it happens.
Injection risks (XSS/SQL/command) are prevented via safe APIs and/or escaping.

Accessibility (required)

I have read and this PR upholds our Accessibility Best Practices.

Standards Acknowledgement (required)

I have read and this PR upholds our Coding Standards and Tech Radar Choices.

Screenshots or demo (if the user interface changed)

Notes for reviewers

Trade-offs:
Follow-ups (linked issues):
Linked PRs (e.g. web-packages):

Copilot

Pull request overview

This PR introduces a new server endpoint /client-version-check as the first step in implementing a force-reload feature. The endpoint is a simple stub that returns HTTP 200 OK.

Changes:

Created a new route handler for client version checking at /client-version-check

Copilot · 2026-02-04T14:04:12Z

apps/server/routes/client-version-check/ClientVersionCheck.ts

+import {Router} from 'express';
+import {StatusCodes as HTTP_STATUS} from 'http-status-codes';
+
+export const ClientVersionCheck = () => {


The exported function name should be ClientVersionCheckRoute instead of ClientVersionCheck to follow the established naming convention in the codebase. All other route files follow the pattern of appending "Route" to the function name (e.g., HealthCheckRoute, ConfigRoute, GoogleWebmasterRoute, AppleAssociationRoute).

Suggested change

export const ClientVersionCheck = () => {

export const ClientVersionCheckRoute = () => {

Copilot · 2026-02-04T14:04:13Z

apps/server/routes/client-version-check/ClientVersionCheck.ts

+export const ClientVersionCheck = () => {
+  return Router().get('/client-version-check', (request, response) => {
+    return response.sendStatus(HTTP_STATUS.OK);
+  });
+};


This route is defined but not registered in Server.ts, which means it will not be accessible. The route needs to be imported and registered in the Server.ts file's init() method, similar to how other routes like HealthCheckRoute and ConfigRoute are registered (see apps/server/Server.ts lines 33 and 73-76). Without this registration, this endpoint will return 404.

codecov · 2026-02-04T14:28:14Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 45.25%. Comparing base (8b2e1c1) to head (d610ecb).
⚠️ Report is 1 commits behind head on dev.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev   #20307   +/-   ##
=======================================
  Coverage   45.25%   45.25%           
=======================================
  Files        1633     1633           
  Lines       40245    40245           
  Branches     8325     8325           
=======================================
  Hits        18212    18212           
  Misses      20105    20105           
  Partials     1928     1928

Flag	Coverage Δ
app_webapp	`43.43% <ø> (ø)`
lib_api_client	`50.17% <ø> (ø)`
lib_core	`58.86% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-02-04T15:09:56Z

🔗 Download Full Report Artifact

🧪 Playwright Test Summary

✅ Passed: 10
❌ Failed: 0
⏭ Skipped: 4
🔁 Flaky: 0
📊 Total: 14
⏱ Total Runtime: 399.4s (~ 6 min 39 sec)

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Copilot · 2026-02-05T10:23:22Z

apps/server/routes/client-version-check/ClientVersionCheck.ts

+export const ClientVersionCheck = () => {
+  return Router().get('/client-version-check', (request, response) => {
+    return response.sendStatus(HTTP_STATUS.OK);
+  });
+};


[Important] - Missing test coverage

The codebase has test coverage for utility functions (BrowserUtil.test.ts, TimeUtil.test.ts), and this new route should also have test coverage. While some simple routes like HealthCheckRoute may not have tests, this is the beginning of a force-reload feature which is likely to grow in complexity.

Consider adding a test file at apps/server/routes/client-version-check/ClientVersionCheck.test.ts to verify the endpoint responds correctly with HTTP 200 status.

Copilot · 2026-02-05T10:23:22Z

apps/server/routes/client-version-check/ClientVersionCheck.ts

+export const ClientVersionCheck = () => {
+  return Router().get('/client-version-check', (request, response) => {
+    return response.sendStatus(HTTP_STATUS.OK);


[Important] - Route implementation is incomplete for force-reload feature

According to the PR description, this is meant to "implement a force-reload feature." However, the current implementation only returns HTTP 200 without any functionality to:

Check the client version (the route is named "client-version-check" but doesn't check anything)

Provide version information to clients

Signal when a reload is necessary

The route needs to either:

Accept client version information and compare it against current/minimum versions

Return version information that clients can use to determine if they need to reload

Include logic that indicates whether a force reload is required

Consider what data structure this endpoint should return. For example, it might return JSON like:

{ "currentVersion": "2024.12.14", "minimumVersion": "2024.12.01", "forceReload": false }

Suggested change

export const ClientVersionCheck = () => {

return Router().get('/client-version-check', (request, response) => {

return response.sendStatus(HTTP_STATUS.OK);

const CURRENT_VERSION = process.env.CLIENT_CURRENT_VERSION ?? '0.0.0';

const MINIMUM_VERSION = process.env.CLIENT_MINIMUM_VERSION ?? CURRENT_VERSION;

const VERSION_REGEX = /^[0-9]+(\.[0-9]+){0,2}$/;

const MAX_VERSION_LENGTH = 32;

const compareVersions = (a: string, b: string): number => {

const aParts = a.split('.').map(part => parseInt(part, 10) || 0);

const bParts = b.split('.').map(part => parseInt(part, 10) || 0);

const length = Math.max(aParts.length, bParts.length);

for (let i = 0; i < length; i += 1) {

const aVal = aParts[i] ?? 0;

const bVal = bParts[i] ?? 0;

if (aVal < bVal) {

return -1;

}

if (aVal > bVal) {

return 1;

}

}

return 0;

};

export const ClientVersionCheck = () => {

return Router().get('/client-version-check', (request, response) => {

const clientVersionRaw =

(typeof request.query.version === 'string' ? request.query.version : undefined) ||

(typeof request.headers['x-client-version'] === 'string'

? request.headers['x-client-version']

: undefined);

let clientVersion: string | undefined;

if (

typeof clientVersionRaw === 'string' &&

clientVersionRaw.length > 0 &&

clientVersionRaw.length <= MAX_VERSION_LENGTH &&

VERSION_REGEX.test(clientVersionRaw)

) {

clientVersion = clientVersionRaw;

}

const forceReload =

typeof clientVersion === 'string' &&

compareVersions(clientVersion, MINIMUM_VERSION) < 0;

return response.status(HTTP_STATUS.OK).json({

currentVersion: CURRENT_VERSION,

minimumVersion: MINIMUM_VERSION,

forceReload,

});

Copilot · 2026-02-05T10:23:22Z

apps/server/routes/client-version-check/ClientVersionCheck.ts

+import {StatusCodes as HTTP_STATUS} from 'http-status-codes';
+
+export const ClientVersionCheck = () => {
+  return Router().get('/client-version-check', (request, response) => {


[Suggestion] - Consider route placement in initLatestBrowserRequired

The route /client-version-check may need to be added to the ignored paths in the initLatestBrowserRequired middleware (apps/server/Server.ts:183-195) if it should be accessible without browser checks. Review whether this endpoint should bypass the browser requirement checks similar to how /_health, /commit, /test, etc. are handled.

Previously there were no single unit tests for this route so we should verify that the route is behaving as intended.

sonarqubecloud · 2026-02-11T14:38:42Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

Copilot · 2026-02-11T14:41:12Z

apps/server/Server.ts

    this.app.use(NotFoundRoute());
    this.app.use(InternalErrorRoute());
+    this.app.use(createClientVersionCheckRoute({router: Router()}));


[Blocker] - /client-version-check is registered after NotFoundRoute() and InternalErrorRoute(), so it will never be reached.

NotFoundRoute() registers a GET * handler (apps/server/routes/error/ErrorRoutes.ts:53-68) which will match /client-version-check first and return a 404 error page. Move createClientVersionCheckRoute(...) above NotFoundRoute() (and keep not-found / error handlers last).

Suggested change

this.app.use(NotFoundRoute());

this.app.use(InternalErrorRoute());

this.app.use(createClientVersionCheckRoute({router: Router()}));

this.app.use(createClientVersionCheckRoute({router: Router()}));

this.app.use(NotFoundRoute());

this.app.use(InternalErrorRoute());

Copilot · 2026-02-11T14:41:13Z

apps/server/routes/client-version-check/ClientVersionCheckRoute.ts

+  return router.get('/client-version-check', (request, response) => {
+    return response.sendStatus(HTTP_STATUS.OK);


[Important] - Unused request parameter will trigger @typescript-eslint/no-unused-vars warnings.

Other routes use _req/_request for unused parameters (e.g. AppleAssociationRoute, RedirectRoutes). Consider renaming request to _request (or _req) here to match the repo’s lint expectations.

Copilot · 2026-02-11T14:41:13Z

apps/server/routes/client-version-check/ClientVersionCheckRoute.ts

+type ClientVersionCheckRouteDependencies = {
+  readonly router: ReturnType<typeof Router>;
+};
+
+export function createClientVersionCheckRoute(dependencies: ClientVersionCheckRouteDependencies) {
+  const {router} = dependencies;


[Suggestion] - Route factory signature is inconsistent with the surrounding route style.

Most existing routes export XRoute = (...) => Router().get(...) and construct their own router (e.g. HealthCheckRoute, AppleAssociationRoute, ConfigRoute). Consider following the same pattern here (instead of injecting router), which would simplify usage in Server.ts and keep route registration consistent.

screendriver requested review from a team and otto-the-bot as code owners February 4, 2026 14:01

Copilot AI review requested due to automatic review settings February 4, 2026 14:01

otto-the-bot added type: feature / request ✨ 👕 size: S app: server labels Feb 4, 2026

Copilot started reviewing on behalf of screendriver February 4, 2026 14:01 View session

screendriver enabled auto-merge February 4, 2026 14:01

screendriver disabled auto-merge February 4, 2026 14:03

Copilot AI reviewed Feb 4, 2026

View reviewed changes

thisisamir98 approved these changes Feb 4, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings February 5, 2026 10:20

thisisamir98 force-pushed the force-reload branch from f6764b7 to b6dc392 Compare February 5, 2026 10:20

Copilot started reviewing on behalf of thisisamir98 February 5, 2026 10:20 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

screendriver force-pushed the force-reload branch from b6dc392 to 7b9dffc Compare February 11, 2026 14:34

screendriver added 2 commits February 11, 2026 15:36

feat(server): create client-version-check route

99786b8

feat(server): create unit tests for /client-version-check route

d610ecb

Previously there were no single unit tests for this route so we should verify that the route is behaving as intended.

Copilot AI review requested due to automatic review settings February 11, 2026 14:37

screendriver force-pushed the force-reload branch from 7b9dffc to d610ecb Compare February 11, 2026 14:37

Copilot started reviewing on behalf of screendriver February 11, 2026 14:37 View session

screendriver enabled auto-merge February 11, 2026 14:38

Copilot AI reviewed Feb 11, 2026

View reviewed changes

screendriver added this pull request to the merge queue Feb 11, 2026

thisisamir98 approved these changes Feb 11, 2026

View reviewed changes

Merged via the queue into dev with commit 3d9b1c7 Feb 11, 2026
58 checks passed

screendriver deleted the force-reload branch February 11, 2026 14:48

	export const ClientVersionCheck = () => {
	export const ClientVersionCheckRoute = () => {

-export const ClientVersionCheck = () => {
-  return Router().get('/client-version-check', (request, response) => {
-    return response.sendStatus(HTTP_STATUS.OK);
+const CURRENT_VERSION = process.env.CLIENT_CURRENT_VERSION ?? '0.0.0';
+const MINIMUM_VERSION = process.env.CLIENT_MINIMUM_VERSION ?? CURRENT_VERSION;
+const VERSION_REGEX = /^[0-9]+(\.[0-9]+){0,2}$/;
+const MAX_VERSION_LENGTH = 32;
+const compareVersions = (a: string, b: string): number => {
+  const aParts = a.split('.').map(part => parseInt(part, 10) || 0);
+  const bParts = b.split('.').map(part => parseInt(part, 10) || 0);
+  const length = Math.max(aParts.length, bParts.length);
+  for (let i = 0; i < length; i += 1) {
+    const aVal = aParts[i] ?? 0;
+    const bVal = bParts[i] ?? 0;
+    if (aVal < bVal) {
+      return -1;
+    }
+    if (aVal > bVal) {
+      return 1;
+    }
+  }
+  return 0;
+};
+export const ClientVersionCheck = () => {
+  return Router().get('/client-version-check', (request, response) => {
+    const clientVersionRaw =
+      (typeof request.query.version === 'string' ? request.query.version : undefined) ||
+      (typeof request.headers['x-client-version'] === 'string'
+        ? request.headers['x-client-version']
+        : undefined);
+    let clientVersion: string | undefined;
+    if (
+      typeof clientVersionRaw === 'string' &&
+      clientVersionRaw.length > 0 &&
+      clientVersionRaw.length <= MAX_VERSION_LENGTH &&
+      VERSION_REGEX.test(clientVersionRaw)
+    ) {
+      clientVersion = clientVersionRaw;
+    }
+    const forceReload =
+      typeof clientVersion === 'string' &&
+      compareVersions(clientVersion, MINIMUM_VERSION) < 0;
+    return response.status(HTTP_STATUS.OK).json({
+      currentVersion: CURRENT_VERSION,
+      minimumVersion: MINIMUM_VERSION,
+      forceReload,
+    });

		return router.get('/client-version-check', (request, response) => {
		return response.sendStatus(HTTP_STATUS.OK);

feat(server): create client-version-check route [WPB-23299] #20307

feat(server): create client-version-check route [WPB-23299] #20307

Conversation

screendriver commented Feb 4, 2026 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Summary

Security Checklist (required)

Accessibility (required)

Standards Acknowledgement (required)

Screenshots or demo (if the user interface changed)

Notes for reviewers

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Playwright Test Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 11, 2026

Quality Gate passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

screendriver commented Feb 4, 2026 •

edited by github-actions bot

Loading

codecov bot commented Feb 4, 2026 •

edited

Loading

github-actions bot commented Feb 4, 2026 •

edited

Loading