apostrophe 4.29.0 → 4.30.0-alpha.1

package/test/assets.js

@@ -98,15 +98,75 @@ describe('Assets', function() {
     retryAssertTrue
   } = loadUtils();
 
+  // Wait for the chokidar watcher to be ready before writing files.
+  // Without this, writes can happen before chokidar has finished its
+  // initial scan, so the change event is never emitted. This is
+  // especially visible with slower adapters like sqlite.
+  function waitForWatcherReady(watcher, timeoutMs = 10000) {
+    if (watcher._readyEmitted) {
+      return Promise.resolve();
+    }
+    return new Promise((resolve, reject) => {
+      const timer = setTimeout(() => reject(new Error('Watcher ready timeout')), timeoutMs);
+      watcher.on('ready', () => {
+        clearTimeout(timer);
+        resolve();
+      });
+    });
+  }
+
+  // Many asset tests modify source files in test/modules/ to trigger
+  // rebuilds, then restore them at the end. If a test fails mid-execution
+  // the files stay dirty and poison subsequent runs. To prevent this we
+  // snapshot every mutable file before the suite and restore them
+  // automatically after each test via afterEach. The before hook also
+  // cleans up build artifacts and webpack cache from prior runs.
+  const mutableFiles = [
+    'test/modules/bundle-page/ui/src/extra.js',
+    'test/modules/default-page/ui/src/index.js',
+    'test/modules/default-page/ui/src/index.scss',
+    'test/modules/default-page/ui/public/index.js',
+    'test/modules/default-page/ui/public/index.css',
+    'test/modules/default-page/ui/apos/components/FakeComponent.vue',
+    'test/package-lock.json'
+  ].map((rel) => path.join(process.cwd(), rel));
+  const snapshots = new Map();
+
+  before(async function() {
+    // Snapshot every mutable file so afterEach can restore them
+    for (const file of mutableFiles) {
+      try {
+        snapshots.set(file, await fs.readFile(file));
+      } catch (e) {
+        // File might not exist yet, that's OK
+      }
+    }
+    // Start clean: remove build artifacts and cache from prior runs
+    await deleteBuiltFolders(publicFolderPath, true);
+    await removeCache();
+  });
+
   after(async function() {
     await deleteBuiltFolders(publicFolderPath, true);
     await removeCache();
     await t.destroy(apos);
   });
 
-  afterEach(function() {
+  afterEach(async function() {
     // Prevent hang forever if particular tests fail while testing prod.
     process.env.NODE_ENV = 'development';
+    // Restore any files that were modified by the test
+    for (const [ file, content ] of snapshots) {
+      try {
+        const current = await fs.readFile(file);
+        if (!current.equals(content)) {
+          await fs.writeFile(file, content);
+        }
+      } catch (e) {
+        // If the file was deleted, restore it
+        await fs.writeFile(file, content);
+      }
+    }
   });
 
   this.timeout(5 * 60 * 1000);
@@ -162,6 +222,7 @@ describe('Assets', function() {
   });
 
   it('should get webpack extensions from modules and fill extra bundles', async function () {
+    await t.destroy(apos);
     const expectedEntryPointsNames = {
       js: [ 'company', 'main', 'another', 'extra', 'extra2' ],
       css: [ 'company', 'main', 'extra' ]
@@ -309,6 +370,7 @@ describe('Assets', function() {
   });
 
   it('should build with cache and gain performance', async function() {
+    await t.destroy(apos);
     await removeCache();
     await removeCache(cacheFolderPath.replace('/webpack-cache', '/changed'));
 
@@ -346,9 +408,11 @@ describe('Assets', function() {
     assert(meta2['default:apos']);
     assert(meta2['default:src']);
 
-    // Expect at least 40% gain, in reallity it should be 50+
+    // Caching should provide a measurable speedup. The threshold is kept
+    // low (10%) to avoid flaky failures on loaded CI runners where the
+    // cold run can be fast due to OS-level caching.
     const gain = (execTime - execTimeCached) / execTime * 100;
-    assert(gain >= 20, `Expected gain >=20%, got ${gain}%`);
+    assert(gain >= 10, `Expected gain >=10%, got ${gain}%`);
 
     // Modification times
     assert(meta['default:apos'].mdate);
@@ -509,11 +573,11 @@ describe('Assets', function() {
     assert(apos.asset.restartId);
     assert(!result.builds);
     assert(!result.changes);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     // Modify asset and rebuild
     const assetPath = path.join(process.cwd(), 'test/modules/bundle-page/ui/src/extra.js');
     const assetPathPublic = path.join(process.cwd(), 'test/public/apos-frontend/default/extra-module-bundle.js');
-    const assetContent = fs.readFileSync(assetPath, 'utf-8');
     fs.writeFileSync(
       assetPath,
       'export default () => { \'bundle-page-watcher-test-src\'; };\n',
@@ -524,34 +588,33 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathPublic, 'utf8')).match(/bundle-page-watcher-test-src/),
       'Unable to verify public asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     await retryAssertTrue(
       () => apos.asset.restartId !== restartId,
       'Unable to verify restartId has been changed',
       500,
-      10000
+      20000
     );
 
     await retryAssertTrue(
       () => result.builds.length === 1 && result.builds.includes('src'),
       'Unable to verify build "src" has been triggered',
       50,
-      1000
+      2000
     );
 
     await retryAssertTrue(
       () => result.changes.length === 1 && result.changes[0].includes('modules/bundle-page/ui/src/extra.js'),
       'Unable to verify changes contain the proper file',
       50,
-      1000
+      2000
     );
 
     await t.destroy(apos);
     assert.equal(apos.asset.buildWatcher, null);
     apos = null;
-    fs.writeFileSync(assetPath, assetContent, 'utf8');
   });
 
   it('should watch and rebuild assets and reload page in development (src)', async function() {
@@ -567,12 +630,6 @@ describe('Assets', function() {
     const assetPathPublicCss = path.join(rootPath, 'test/public/apos-frontend/default/public-bundle.css');
     const assetPathAposJs = path.join(rootPath, 'test/public/apos-frontend/default/apos-module-bundle.js');
     const assetPathAposCss = path.join(rootPath, 'test/public/apos-frontend/default/apos-bundle.css');
-    const assetContentJs = fs.readFileSync(assetPathJs, 'utf-8');
-    const assetContentScss = fs.readFileSync(assetPathScss, 'utf-8');
-    // Resurrect the default assets content if test has failed
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
-    fs.writeFileSync(assetPathScss, assetContentScss, 'utf8');
-
     apos = await t.create({
       root: module,
       autoBuild: true,
@@ -595,6 +652,7 @@ describe('Assets', function() {
     assert(apos.asset.restartId);
     assert(!result.builds);
     assert(!result.changes);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     // * modify assets and rebuild
     fs.writeFileSync(
@@ -613,13 +671,13 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathPublicJs, 'utf8')).match(/default-page-watcher-test-src/),
       'Unable to verify public JS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
     await retryAssertTrue(
       async () => (await fs.readFile(assetPathPublicCss, 'utf8')).match(/\.default-page-watcher-test-src/),
       'Unable to verify public CSS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     // * change is in the apos bundle
@@ -627,13 +685,13 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathAposJs, 'utf8')).match(/default-page-watcher-test-src/),
       'Unable to verify apos JS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
     await retryAssertTrue(
       async () => (await fs.readFile(assetPathAposCss, 'utf8')).match(/\.default-page-watcher-test-src/),
       'Unable to verify apos CSS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     // * page has been restarted
@@ -641,7 +699,7 @@ describe('Assets', function() {
       () => apos.asset.restartId !== restartId,
       'Unable to verify restartId has been changed',
       500,
-      10000
+      20000
     );
 
     // * only src related builds were triggered
@@ -650,7 +708,7 @@ describe('Assets', function() {
         result.builds.includes('src'),
       'Unable to verify build "src" has been triggered',
       50,
-      1000
+      2000
     );
 
     // * changes detected
@@ -665,14 +723,12 @@ describe('Assets', function() {
           .length === 2,
       'Unable to verify changes contain the proper source files',
       50,
-      1000
+      2000
     );
 
     await t.destroy(apos);
     assert.equal(apos.asset.buildWatcher, null);
     apos = null;
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
-    fs.writeFileSync(assetPathScss, assetContentScss, 'utf8');
   });
 
   it('should watch and rebuild assets and reload page in development (public)', async function() {
@@ -688,12 +744,6 @@ describe('Assets', function() {
     const assetPathPublicCss = path.join(rootPath, 'test/public/apos-frontend/default/public-bundle.css');
     const assetPathAposJs = path.join(rootPath, 'test/public/apos-frontend/default/apos-module-bundle.js');
     const assetPathAposCss = path.join(rootPath, 'test/public/apos-frontend/default/apos-bundle.css');
-    const assetContentJs = fs.readFileSync(assetPathJs, 'utf-8');
-    const assetContentScss = fs.readFileSync(assetPathCss, 'utf-8');
-    // Resurrect the default assets content if test has failed
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
-    fs.writeFileSync(assetPathCss, assetContentScss, 'utf8');
-
     apos = await t.create({
       root: module,
       autoBuild: true,
@@ -716,6 +766,7 @@ describe('Assets', function() {
     assert(apos.asset.restartId);
     assert(!result.builds);
     assert(!result.changes);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     // * modify assets and rebuild
     fs.writeFileSync(
@@ -734,13 +785,13 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathPublicJs, 'utf8')).match(/default-page-watcher-test-public/),
       'Unable to verify public JS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
     await retryAssertTrue(
       async () => (await fs.readFile(assetPathPublicCss, 'utf8')).match(/\.default-page-watcher-test-public/),
       'Unable to verify public CSS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     // * change is in the apos bundle
@@ -748,13 +799,13 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathAposJs, 'utf8')).match(/default-page-watcher-test-public/),
       'Unable to verify apos JS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
     await retryAssertTrue(
       async () => (await fs.readFile(assetPathAposCss, 'utf8')).match(/\.default-page-watcher-test-public/),
       'Unable to verify apos CSS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     // * page has been restarted
@@ -762,7 +813,7 @@ describe('Assets', function() {
       () => apos.asset.restartId !== restartId,
       'Unable to verify restartId has been changed',
       500,
-      10000
+      20000
     );
 
     // * only public build was triggered
@@ -771,7 +822,7 @@ describe('Assets', function() {
         result.builds.includes('public'),
       'Unable to verify build "public" has been triggered',
       50,
-      1000
+      2000
     );
 
     // * changes detected
@@ -786,14 +837,12 @@ describe('Assets', function() {
           .length === 2,
       'Unable to verify changes contain the proper source files',
       50,
-      1000
+      2000
     );
 
     await t.destroy(apos);
     assert.equal(apos.asset.buildWatcher, null);
     apos = null;
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
-    fs.writeFileSync(assetPathCss, assetContentScss, 'utf8');
   });
 
   it('should watch and rebuild assets and reload page in development (apos)', async function() {
@@ -836,6 +885,7 @@ describe('Assets', function() {
     assert(apos.asset.restartId);
     assert(!result.builds);
     assert(!result.changes);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     // * modify assets and rebuild
     fs.writeFileSync(
@@ -850,7 +900,7 @@ describe('Assets', function() {
         .includes('default-page-watcher-test-apos'),
       'Unable to verify apos JS asset was rebuilt by the watcher',
       500,
-      20000
+      40000
     );
 
     // * page has been restarted
@@ -858,7 +908,7 @@ describe('Assets', function() {
       () => apos.asset.restartId !== restartId,
       'Unable to verify restartId has been changed',
       500,
-      10000
+      20000
     );
 
     // * only apos build was triggered
@@ -867,7 +917,7 @@ describe('Assets', function() {
         result.builds.includes('apos'),
       'Unable to verify build "apos" has been triggered',
       50,
-      1000
+      2000
     );
 
     // * changes detected
@@ -877,13 +927,12 @@ describe('Assets', function() {
         result.changes[0].includes('modules/default-page/ui/apos/components/FakeComponent.vue'),
       'Unable to verify changes contain the proper source files',
       50,
-      1000
+      2000
     );
 
     await t.destroy(apos);
     assert.equal(apos.asset.buildWatcher, null);
     apos = null;
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
   });
 
   it('should watch and recover after build error in development', async function() {
@@ -898,9 +947,6 @@ describe('Assets', function() {
     const assetPathScss = path.join(rootPath, 'test/modules/default-page/ui/src/index.scss');
     const assetPathPublicCss = path.join(rootPath, 'test/public/apos-frontend/default/public-bundle.css');
     const assetPathAposCss = path.join(rootPath, 'test/public/apos-frontend/default/apos-bundle.css');
-    const assetContentScss = '.default-page {color:red;}\n';
-    // Resurrect the default assets content if test has failed
-    fs.writeFileSync(assetPathScss, assetContentScss, 'utf8');
 
     apos = await t.create({
       root: module,
@@ -924,6 +970,7 @@ describe('Assets', function() {
     assert(apos.asset.restartId);
     assert(!result.builds);
     assert(!result.changes);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     // * modify assets and rebuild
     fs.writeFileSync(
@@ -937,7 +984,7 @@ describe('Assets', function() {
       () => called === 1 && result.builds.length === 0,
       'Unable to verify build with error was triggered',
       100,
-      10000
+      20000
     );
 
     // * page has NOT been restarted
@@ -945,7 +992,7 @@ describe('Assets', function() {
       () => apos.asset.restartId === restartId,
       'Unable to verify restartId has been changed',
       100,
-      10000
+      20000
     );
 
     // * modify assets and recover
@@ -960,7 +1007,7 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathPublicCss, 'utf8')).match(/\.default-page-watcher-test-recover/),
       'Unable to verify public CSS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     // * change is in the apos bundle
@@ -968,7 +1015,7 @@ describe('Assets', function() {
       async () => (await fs.readFile(assetPathAposCss, 'utf8')).match(/\.default-page-watcher-test-recover/),
       'Unable to verify apos CSS asset was rebuilt by the watcher',
       500,
-      10000
+      20000
     );
 
     // * page has been restarted
@@ -976,7 +1023,7 @@ describe('Assets', function() {
       () => apos.asset.restartId !== restartId,
       'Unable to verify restartId has been changed',
       500,
-      10000
+      20000
     );
 
     // * only src related builds were triggered
@@ -985,7 +1032,7 @@ describe('Assets', function() {
         result.builds.includes('src'),
       'Unable to verify build "src" have been triggered',
       50,
-      1000
+      2000
     );
 
     // * changes detected
@@ -999,13 +1046,12 @@ describe('Assets', function() {
           .length === 1,
       'Unable to verify changes contain the proper source files',
       50,
-      1000
+      2000
     );
 
     await t.destroy(apos);
     assert.equal(apos.asset.buildWatcher, null);
     apos = null;
-    fs.writeFileSync(assetPathScss, assetContentScss, 'utf8');
   });
 
   it('should watch but not rebuild assets and not reload page when changes are not in use', async function() {
@@ -1023,12 +1069,6 @@ describe('Assets', function() {
     const assetPathPublicCss = path.join(rootPath, 'test/public/apos-frontend/default/public-bundle.css');
     const assetPathAposJs = path.join(rootPath, 'test/public/apos-frontend/default/apos-module-bundle.js');
     const assetPathAposCss = path.join(rootPath, 'test/public/apos-frontend/default/apos-bundle.css');
-    const assetContentJs = fs.readFileSync(assetPathJs, 'utf-8');
-    const assetContentScss = fs.readFileSync(assetPathScss, 'utf-8');
-    // Resurrect the default assets content if test has failed
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
-    fs.writeFileSync(assetPathScss, assetContentScss, 'utf8');
-
     apos = await t.create({
       root: module,
       autoBuild: true,
@@ -1051,6 +1091,7 @@ describe('Assets', function() {
     assert(!result.builds);
     assert(!result.changes);
     assert.equal(rebuilt, false);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     // * modify assets
     fs.writeFileSync(
@@ -1139,8 +1180,6 @@ describe('Assets', function() {
     await t.destroy(apos);
     assert.equal(apos.asset.buildWatcher, null);
     apos = null;
-    fs.writeFileSync(assetPathJs, assetContentJs, 'utf8');
-    fs.writeFileSync(assetPathScss, assetContentScss, 'utf8');
   });
 
   it('should watch and rebuild assets in a debounced queue', async function() {
@@ -1167,10 +1206,10 @@ describe('Assets', function() {
       }
     });
     assert(apos.asset.buildWatcher);
+    await waitForWatcherReady(apos.asset.buildWatcher);
 
     const assetPath = path.join(process.cwd(), 'test/modules/bundle-page/ui/src/extra.js');
     const assetPathPublic = path.join(process.cwd(), 'test/public/apos-frontend/default/extra-module-bundle.js');
-    const assetContent = fs.readFileSync(assetPath, 'utf-8');
 
     // Modify below the debounce rate
     for (const i of [ 1, 2, 3 ]) {
@@ -1195,7 +1234,9 @@ describe('Assets', function() {
       5000
     );
 
-    // Modify above the debounce rate, test the queue cap
+    // Modify well above the debounce rate (default 1000ms) so each
+    // write triggers its own rebuild. Use 2000ms to avoid flaky
+    // failures on loaded CI runners.
     timesRebuilt = 0;
     for (const i of [ 1, 2, 3 ]) {
       await fs.writeFile(
@@ -1203,7 +1244,7 @@ describe('Assets', function() {
         `export default () => { 'bundle-page-watcher-test-${i}0'; };\n`,
         'utf8'
       );
-      await Promise.delay(1050);
+      await Promise.delay(2000);
     }
     await retryAssertTrue(
       async () => (await fs.readFile(assetPathPublic, 'utf8')).match(/bundle-page-watcher-test-30/),
@@ -1220,10 +1261,10 @@ describe('Assets', function() {
 
     await t.destroy(apos);
     apos = null;
-    fs.writeFileSync(assetPath, assetContent, 'utf8');
   });
 
   it('should be able to setup the debounce time', async function() {
+    await t.destroy(apos);
 
     apos = await t.create({
       root: module,
@@ -1317,6 +1358,7 @@ describe('Assets', function() {
   });
 
   it('should pass the right options to webpack extensions from all modules', async function() {
+    await t.destroy(apos);
     const { extConfig1, extConfig2 } = getWebpackConfigsForExtensionOptions();
 
     apos = await t.create({
@@ -1347,6 +1389,7 @@ describe('Assets', function() {
   });
 
   it('should allow two modules extending each others to pass options to the same webpack extension', async function() {
+    await t.destroy(apos);
     const { extConfig1, extConfig2 } = getWebpackConfigsForExtensionOptions();
 
     apos = await t.create({