chore(ci): Debug why jest tests sometimes can't find preset (#382)

Author: Tobbe

.github/workflows/cli-smoke-tests.yml

@@ -40,7 +40,31 @@ jobs:
         working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}
 
       - name: Run "rw test api"
-        run: yarn rw test api --no-watch
+        # Having a bunch of `ls` statements here to see if I can spot anything
+        # weird looking when this step fails
+        run: |
+          echo ""
+          echo "# ls /"
+          ls ${{ steps.set-up-test-project.outputs.test-project-path }}/node_modules/@cedarjs/testing
+          echo ""
+          echo "# ls /config"
+          ls ${{ steps.set-up-test-project.outputs.test-project-path }}/node_modules/@cedarjs/testing/config
+          echo ""
+          echo "# ls /config/jest"
+          ls ${{ steps.set-up-test-project.outputs.test-project-path }}/node_modules/@cedarjs/testing/config/jest
+          echo ""
+          echo "# ls /config/jest/api"
+          ls ${{ steps.set-up-test-project.outputs.test-project-path }}/node_modules/@cedarjs/testing/config/jest/api
+          echo ""
+          echo "# cat /package.json"
+          cat ${{ steps.set-up-test-project.outputs.test-project-path }}/node_modules/@cedarjs/testing/package.json && echo ""
+          echo ""
+          echo "# cat /config/jest/api/package.json"
+          cat ${{ steps.set-up-test-project.outputs.test-project-path }}/node_modules/@cedarjs/testing/config/jest/api/package.json && echo ""
+          echo ""
+          echo ""
+          echo "# Starting test"
+          yarn rw test api --no-watch
         working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}
 
       - name: Run "rw test web"

packages/testing/build.mts

@@ -34,21 +34,50 @@ fs.rmSync('./config', { recursive: true, force: true })
 fs.mkdirSync('./config')
 fs.cpSync('./dist/cjs/config', './config', { recursive: true })
 fs.cpSync('./dist/cjs/package.json', './config/package.json')
-// Some background on the two `fs.cpSync` calls below: I've been having problems
-// with jest testing in CI sometimes failing to find the jest preset file. I
-// don't know why. But after deep-diving into the jest source code I realized it
-// was looking for a package.json in the same directory as it first tries to
-// find the preset. It's supposed to traverse up the folder tree if it can't
-// find one, until it does. I'm not sure if this is sometimes failing, or what
-// happens when it finds one much further up the tree. Maybe jest then tries to
-// resolve the preset in *that* directory. Anyway, to make things as easy for it
-// as possible, I updated the testing package build script to put a package.json
-// files in the preset directories for both the api and the web sides. And after
-// that CI passed.
+
+// Some background on the package.json related commands below: I've been having
+// problems with jest testing in CI sometimes failing to find the jest preset
+// file. I don't know why. But after deep-diving into the jest source code I
+// realized it was looking for a package.json in the same directory as it first
+// tries to find the preset. It's supposed to traverse up the folder tree if it
+// can't find one, until it does. I'm not sure if this is sometimes failing, or
+// what happens when it finds one much further up the tree. Maybe jest then
+// tries to resolve the preset in *that* directory. Anyway, to make things as
+// easy for it as possible, I updated the testing package build script to put a
+// package.json files in the preset directories for both the api and the web
+// sides. And after that CI passed.
 // But since it's been flakey I don't know if this was the actual fix, or if it
 // just randomly decided to pass.
-fs.cpSync('./dist/cjs/package.json', './config/jest/api/package.json')
-fs.cpSync('./dist/cjs/package.json', './config/jest/web/package.json')
+fs.writeFileSync(
+  './config/jest/api/package.json',
+  JSON.stringify(
+    {
+      name: 'cedarjs-jest-api-preset',
+      version: '0.0.1',
+      type: 'commonjs',
+      main: 'index.js',
+      license: 'MIT',
+      types: './index.d.ts',
+    },
+    null,
+    2,
+  ),
+)
+fs.writeFileSync(
+  './config/jest/web/package.json',
+  JSON.stringify(
+    {
+      name: 'cedarjs-jest-web-preset',
+      version: '0.0.1',
+      type: 'commonjs',
+      main: 'index.js',
+      license: 'MIT',
+      types: './index.d.ts',
+    },
+    null,
+    2,
+  ),
+)
 
 // Replace relative imports with absolute @cedarjs/testing/dist/cjs imports in built CJS files
 function replaceImportsInFile(filePath: string) {