chore(v2): fix windows Jest tests (#3959)

* test(v2): Fix docusaurus-utils tests for windows

* test(v2): Fix plugin-client-redirects test

- add the posixPath in writeRedirectsFiles.ts

* test(v2): Fix plugin-content-pages test

add posixPath in test and index

* test(v2): add window test configuration

 - add the window test configuration in nodejs-windows.yml

* test(v2): revert plugin-content-pages test fix

* test(v2): Fix mdx-loader/transformImage test

* test(v2): add cleanPath in transformImage test

* fix version path tests for windows

* make versionMetadata test work on Windows

* try to fix posix/win32 path issues

* attempt to fix windows test

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* specific jest config for windows

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* remove bad cleanPath fn

* try to fix windows tests

* try to fix windows tests

* blog: try to fix windows tests by using same logic as on docs plugin

* try to fix windows tests

* try to fix windows tests

* try to fix windows tests

* try to fix windows tests

* improve the Github CI setup for windows: make jobs run in parallel

* revert GH action change

Co-authored-by: Sachin Kumar Rajput <skr571999@gmail.com>

packages/docusaurus-utils/src/__tests__/index.test.ts

@@ -45,7 +45,9 @@ describe('load utils', () => {
       'user/docs/test.md': '@site/../docs/test.md',
     };
     Object.keys(asserts).forEach((file) => {
-      expect(aliasedSitePath(file, 'user/website')).toBe(asserts[file]);
+      expect(posixPath(aliasedSitePath(file, 'user/website'))).toBe(
+        asserts[file],
+      );
     });
   });
 
@@ -521,15 +523,15 @@ describe('removePrefix', () => {
 
 describe('getFilePathForRoutePath', () => {
   test('works for /', () => {
-    expect(getFilePathForRoutePath('/')).toEqual('/index.html');
+    expect(posixPath(getFilePathForRoutePath('/'))).toEqual('/index.html');
   });
   test('works for /somePath', () => {
-    expect(getFilePathForRoutePath('/somePath')).toEqual(
+    expect(posixPath(getFilePathForRoutePath('/somePath'))).toEqual(
       '/somePath/index.html',
     );
   });
   test('works for /somePath/', () => {
-    expect(getFilePathForRoutePath('/somePath/')).toEqual(
+    expect(posixPath(getFilePathForRoutePath('/somePath/'))).toEqual(
       '/somePath/index.html',
     );
   });

packages/docusaurus-utils/src/index.ts

@@ -140,6 +140,17 @@ export function posixPath(str: string): string {
   return str.replace(/\\/g, '/');
 }
 
+// When you want to display a path in a message/warning/error,
+// it's more convenient to:
+// - make it relative to cwd()
+// - convert to posix (ie not using windows \ path separator)
+// This way, Jest tests can run more reliably on any computer/CI
+// on both Unix/Windows
+// For Windows users this is not perfect (as they see / instead of \) but it's probably good enough
+export function toMessageRelativeFilePath(filePath: string) {
+  return posixPath(path.relative(process.cwd(), filePath));
+}
+
 const chunkNameCache = new Map();
 /**
  * Generate unique chunk name given a module path.
@@ -365,7 +376,7 @@ export function normalizeUrl(rawUrls: string[]): string {
  * Example: some/path/to/website/docs/foo.md -> @site/docs/foo.md
  */
 export function aliasedSitePath(filePath: string, siteDir: string): string {
-  const relativePath = path.relative(siteDir, filePath);
+  const relativePath = posixPath(path.relative(siteDir, filePath));
   // Cannot use path.join() as it resolves '../' and removes
   // the '@site'. Let webpack loader resolve it.
   return `@site/${relativePath}`;