@atlaspack/core 2.17.3 → 2.18.0

package/test/RequestTracker.test.js

@@ -5,19 +5,36 @@ import nullthrows from 'nullthrows';
 import RequestTracker, {
   type RunAPI,
   cleanUpOrphans,
+  runInvalidation,
+  getBiggestFSEventsInvalidations,
+  invalidateRequestGraphFSEvents,
 } from '../src/RequestTracker';
 import {Graph} from '@atlaspack/graph';
+import {LMDBLiteCache} from '@atlaspack/cache';
 import WorkerFarm from '@atlaspack/workers';
 import {DEFAULT_OPTIONS} from './test-utils';
 import {FILE_CREATE, FILE_UPDATE, INITIAL_BUILD} from '../src/constants';
 import {makeDeferredWithPromise} from '@atlaspack/utils';
 import {toProjectPath} from '../src/projectPath';
 import {DEFAULT_FEATURE_FLAGS, setFeatureFlags} from '../../feature-flags/src';
+import sinon from 'sinon';
+import type {AtlaspackOptions} from '../src/types';
 
-const options = DEFAULT_OPTIONS;
+const options = {
+  ...DEFAULT_OPTIONS,
+  cache: new LMDBLiteCache(DEFAULT_OPTIONS.cacheDir),
+};
 const farm = new WorkerFarm({workerPath: require.resolve('../src/worker')});
 
 describe('RequestTracker', () => {
+  beforeEach(async () => {
+    await options.cache.ensure();
+
+    for (const key of options.cache.keys()) {
+      await options.cache.getNativeRef().delete(key);
+    }
+  });
+
   it('should not run requests that have not been invalidated', async () => {
     let tracker = new RequestTracker({farm, options});
     await tracker.runRequest({
@@ -482,7 +499,7 @@ describe('RequestTracker', () => {
             input: null,
           });
           const requestId = tracker.graph.getNodeIdByContentKey('abc');
-          const invalidated = await tracker.respondToFSEvents(
+          const {didInvalidate: invalidated} = await tracker.respondToFSEvents(
             [
               {
                 type: 'update',
@@ -521,7 +538,7 @@ describe('RequestTracker', () => {
             input: null,
           });
           const requestId = tracker.graph.getNodeIdByContentKey('abc');
-          const invalidated = await tracker.respondToFSEvents(
+          const {didInvalidate: invalidated} = await tracker.respondToFSEvents(
             [
               {
                 type: 'create',
@@ -584,3 +601,98 @@ root --- node1 --- node2 ----------- orphan1 --- orphan2
     assert.equal(Array.from(graph.getAllEdges()).length, 3);
   });
 });
+
+describe('runInvalidation', () => {
+  it('calls an invalidationFn and tracks the number of invalidated nodes', async () => {
+    const mockRequestTracker = {
+      getInvalidNodeCount: sinon.stub(),
+    };
+
+    mockRequestTracker.getInvalidNodeCount.returns(10000);
+    const result = await runInvalidation(mockRequestTracker, {
+      key: 'fsEvents',
+      fn: () => {
+        mockRequestTracker.getInvalidNodeCount.returns(30000);
+        return {
+          biggestInvalidations: [{path: 'my-file', count: 10000}],
+        };
+      },
+    });
+
+    assert.equal(result.key, 'fsEvents');
+    assert.equal(result.count, 20000);
+    assert.deepEqual(result.detail, {
+      biggestInvalidations: [{path: 'my-file', count: 10000}],
+    });
+    assert(result.duration > 0, 'Duration was not reported');
+  });
+});
+
+describe('invalidateRequestGraphFSEvents', () => {
+  it('calls requestGraph.respondToFSEvents and returns the biggest invalidations', async () => {
+    const requestGraph = {
+      respondToFSEvents: sinon.stub(),
+    };
+
+    requestGraph.respondToFSEvents.returns({
+      invalidationsByPath: new Map([
+        ['file-1', 10],
+        ['file-2', 5000],
+        ['file-3', 8000],
+      ]),
+    });
+    // $FlowFixMe
+    const options: AtlaspackOptions = {
+      unstableFileInvalidations: undefined,
+    };
+
+    const result = await invalidateRequestGraphFSEvents(requestGraph, options, [
+      {
+        path: 'file-1',
+        type: 'create',
+      },
+      {
+        path: 'file-2',
+        type: 'update',
+      },
+      {
+        path: 'file-3',
+        type: 'delete',
+      },
+    ]);
+
+    assert.deepEqual(result.biggestInvalidations, [
+      {path: 'file-3', count: 8000},
+      {path: 'file-2', count: 5000},
+      {path: 'file-1', count: 10},
+    ]);
+    assert.equal(requestGraph.respondToFSEvents.callCount, 1);
+    assert.deepEqual(requestGraph.respondToFSEvents.args[0], [
+      [
+        {path: 'file-1', type: 'create'},
+        {path: 'file-2', type: 'update'},
+        {path: 'file-3', type: 'delete'},
+      ],
+      options,
+      10000,
+      true,
+    ]);
+  });
+});
+
+describe('getBiggestFSEventsInvalidations', () => {
+  it('returns the paths that invalidated the most nodes', () => {
+    const invalidationsByPath = new Map([
+      ['file-1', 10],
+      ['file-2', 5000],
+      ['file-3', 8000],
+      ['file-4', 1000],
+      ['file-5', 1000],
+    ]);
+
+    assert.deepEqual(getBiggestFSEventsInvalidations(invalidationsByPath, 2), [
+      {path: 'file-3', count: 8000},
+      {path: 'file-2', count: 5000},
+    ]);
+  });
+});

package/test/public/Config.test.js

@@ -0,0 +1,108 @@
+// @flow strict-local
+
+import sinon from 'sinon';
+import {makeConfigProxy} from '../../src/public/Config';
+import assert from 'assert';
+
+describe('makeConfigProxy', () => {
+  it('tracks reads to nested fields', () => {
+    const onRead = sinon.spy();
+    const target = {a: {b: {c: 'd'}}};
+    const config = makeConfigProxy(onRead, target);
+    config.a.b.c;
+    assert.ok(onRead.calledWith(['a', 'b', 'c']));
+    assert.ok(onRead.calledOnce);
+  });
+
+  it('works for reading package.json dependencies', () => {
+    const packageJson = {
+      dependencies: {
+        react: '18.2.0',
+      },
+    };
+
+    const onRead = sinon.spy();
+    const config = makeConfigProxy(onRead, packageJson);
+    assert.equal(config.dependencies.react, '18.2.0');
+    // $FlowFixMe
+    assert.equal(config.dependencies.preact, undefined);
+    assert.ok(onRead.calledWith(['dependencies', 'react']));
+    assert.ok(onRead.calledWith(['dependencies', 'preact']));
+    assert.equal(onRead.callCount, 2);
+  });
+
+  it('will track reads for any missing or null keys', () => {
+    const packageJson = {
+      dependencies: {
+        react: '18.2.0',
+      },
+    };
+
+    const onRead = sinon.spy();
+    const config = makeConfigProxy(onRead, packageJson);
+
+    // $FlowFixMe
+    assert.equal(config.alias?.react, undefined);
+    assert.ok(onRead.calledWith(['alias']));
+    assert.equal(onRead.callCount, 1);
+  });
+
+  it('iterating over keys works normally and will register a read for the key being enumerated', () => {
+    const packageJson = {
+      nested: {
+        dependencies: {
+          react: '18.2.0',
+          'react-dom': '18.2.0',
+          'react-router': '6.14.2',
+        },
+      },
+    };
+
+    const onRead = sinon.spy();
+    const config = makeConfigProxy(onRead, packageJson);
+    assert.equal(Object.keys(config.nested.dependencies).length, 3);
+
+    assert.ok(onRead.calledWith(['nested', 'dependencies']));
+  });
+
+  it('if a key has an array value we will track a read for that key', () => {
+    const packageJson = {
+      scripts: ['build', 'test'],
+    };
+
+    const onRead = sinon.spy();
+    const config = makeConfigProxy(onRead, packageJson);
+    assert.equal(config.scripts[0], 'build');
+    assert.equal(onRead.callCount, 1);
+    assert.ok(onRead.calledWith(['scripts']));
+  });
+
+  it('if a key array value is iterated over we will track a read for that key', () => {
+    const packageJson = {
+      scripts: ['build', 'test'],
+    };
+
+    const onRead = sinon.spy();
+    const config = makeConfigProxy(onRead, packageJson);
+    let scriptCount = 0;
+    // eslint-disable-next-line no-unused-vars
+    for (const _script of config.scripts) {
+      scriptCount += 1;
+    }
+    assert.equal(scriptCount, 2);
+    assert.ok(onRead.calledWith(['scripts']));
+    assert.equal(onRead.callCount, 1);
+  });
+
+  it('if a key array value length is verified we will track a read for that key', () => {
+    const packageJson = {
+      scripts: ['build', 'test'],
+    };
+
+    const onRead = sinon.spy();
+    const config = makeConfigProxy(onRead, packageJson);
+    assert.equal(config.scripts.length, 2);
+    assert.ok(onRead.calledWith(['scripts']));
+    assert.equal(onRead.callCount, 1);
+  });
+});

package/test/requests/ConfigRequest.test.js

@@ -12,7 +12,10 @@ import type {
   ConfigRequestResult,
 } from '../../src/requests/ConfigRequest';
 import type {RunAPI} from '../../src/RequestTracker';
-import {runConfigRequest} from '../../src/requests/ConfigRequest';
+import {
+  getValueAtPath,
+  runConfigRequest,
+} from '../../src/requests/ConfigRequest';
 import {toProjectPath} from '../../src/projectPath';
 
 // $FlowFixMe unclear-type forgive me
@@ -228,7 +231,7 @@ describe('ConfigRequest tests', () => {
       ...baseRequest,
       invalidateOnConfigKeyChange: [
         {
-          configKey: 'key1',
+          configKey: ['key1'],
           filePath: toProjectPath(projectRoot, 'config.json'),
         },
       ],
@@ -244,8 +247,189 @@ describe('ConfigRequest tests', () => {
     const call = mockCast(mockRunApi.invalidateOnConfigKeyChange).getCall(0);
     assert.deepEqual(
       call.args,
-      ['config.json', 'key1', hashString('"value1"')],
+      ['config.json', ['key1'], hashString('"value1"')],
       'Invalidate was called for key1',
     );
   });
 });
+
+describe('getValueAtPath', () => {
+  it('can get a key from an object', () => {
+    const obj = {a: {b: {c: 'd'}}};
+    assert.equal(getValueAtPath(obj, ['a', 'b', 'c']), 'd');
+  });
+
+  it('returns the original object when key array is empty', () => {
+    const obj = {a: 1, b: 2};
+    assert.deepEqual(getValueAtPath(obj, []), obj);
+  });
+
+  it('can access single-level properties', () => {
+    const obj = {name: 'test', age: 25};
+    assert.equal(getValueAtPath(obj, ['name']), 'test');
+    assert.equal(getValueAtPath(obj, ['age']), 25);
+  });
+
+  it('returns undefined for non-existent keys', () => {
+    const obj = {a: {b: 'value'}};
+    assert.equal(getValueAtPath(obj, ['nonexistent']), undefined);
+    assert.equal(getValueAtPath(obj, ['a', 'nonexistent']), undefined);
+    assert.equal(getValueAtPath(obj, ['a', 'b', 'nonexistent']), undefined);
+  });
+
+  it('handles null and undefined values in the path', () => {
+    const obj = {a: null, b: {c: undefined}};
+    assert.equal(getValueAtPath(obj, ['a']), null);
+    assert.equal(getValueAtPath(obj, ['b', 'c']), undefined);
+  });
+
+  it('does not throw when trying to access property of null', () => {
+    const obj = {a: null};
+    assert.equal(getValueAtPath(obj, ['a', 'b']), undefined);
+  });
+
+  it('does not throw when trying to access property of undefined', () => {
+    const obj = {a: undefined};
+    assert.equal(getValueAtPath(obj, ['a', 'b']), undefined);
+  });
+
+  it('can access nested arrays and objects', () => {
+    const obj = {
+      data: [
+        {name: 'item1', props: {color: 'red'}},
+        {name: 'item2', props: {color: 'blue'}},
+      ],
+    };
+    assert.equal(getValueAtPath(obj, ['data', '0', 'name']), 'item1');
+    assert.equal(getValueAtPath(obj, ['data', '1', 'props', 'color']), 'blue');
+  });
+
+  it('handles numeric keys as strings', () => {
+    const obj = {'0': 'first', '1': {nested: 'value'}};
+    assert.equal(getValueAtPath(obj, ['0']), 'first');
+    assert.equal(getValueAtPath(obj, ['1', 'nested']), 'value');
+  });
+
+  it('handles keys with special characters', () => {
+    const obj = {
+      'key-with-dashes': 'value1',
+      'key.with.dots': {
+        'nested-key': 'value2',
+      },
+      'key with spaces': 'value3',
+      '@special$chars#': 'value4',
+    };
+    assert.equal(getValueAtPath(obj, ['key-with-dashes']), 'value1');
+    assert.equal(
+      getValueAtPath(obj, ['key.with.dots', 'nested-key']),
+      'value2',
+    );
+    assert.equal(getValueAtPath(obj, ['key with spaces']), 'value3');
+    assert.equal(getValueAtPath(obj, ['@special$chars#']), 'value4');
+  });
+
+  it('handles falsy values correctly', () => {
+    const obj = {
+      zero: 0,
+      false: false,
+      emptyString: '',
+      nullValue: null,
+      undefinedValue: undefined,
+      nested: {
+        zero: 0,
+        false: false,
+      },
+    };
+    assert.equal(getValueAtPath(obj, ['zero']), 0);
+    assert.equal(getValueAtPath(obj, ['false']), false);
+    assert.equal(getValueAtPath(obj, ['emptyString']), '');
+    assert.equal(getValueAtPath(obj, ['nullValue']), null);
+    assert.equal(getValueAtPath(obj, ['undefinedValue']), undefined);
+    assert.equal(getValueAtPath(obj, ['nested', 'zero']), 0);
+    assert.equal(getValueAtPath(obj, ['nested', 'false']), false);
+  });
+
+  it('handles deep nesting', () => {
+    const obj = {
+      level1: {
+        level2: {
+          level3: {
+            level4: {
+              level5: {
+                deepValue: 'found',
+              },
+            },
+          },
+        },
+      },
+    };
+    assert.equal(
+      getValueAtPath(obj, [
+        'level1',
+        'level2',
+        'level3',
+        'level4',
+        'level5',
+        'deepValue',
+      ]),
+      'found',
+    );
+  });
+
+  it('handles Date objects', () => {
+    const date = new Date('2023-01-01');
+    const obj = {
+      timestamp: date,
+      nested: {
+        date: date,
+      },
+    };
+    assert.equal(getValueAtPath(obj, ['timestamp']), date);
+    assert.equal(getValueAtPath(obj, ['nested', 'date']), date);
+  });
+
+  it('handles complex nested structures with mixed types', () => {
+    const obj = {
+      users: [
+        {
+          id: 1,
+          profile: {
+            settings: {
+              theme: 'dark',
+              notifications: true,
+            },
+          },
+        },
+        {
+          id: 2,
+          profile: {
+            settings: {
+              theme: 'light',
+              notifications: false,
+            },
+          },
+        },
+      ],
+      config: {
+        version: '1.0.0',
+        features: ['feature1', 'feature2'],
+      },
+    };
+
+    assert.equal(
+      getValueAtPath(obj, ['users', '0', 'profile', 'settings', 'theme']),
+      'dark',
+    );
+    assert.equal(
+      getValueAtPath(obj, [
+        'users',
+        '1',
+        'profile',
+        'settings',
+        'notifications',
+      ]),
+      false,
+    );
+    assert.equal(getValueAtPath(obj, ['config', 'features', '0']), 'feature1');
+  });
+});

package/test/test-utils.js

@@ -1,19 +1,14 @@
 // @flow strict-local
 
-import type {Environment, AtlaspackOptions, Target} from '../src/types';
+import type {AtlaspackOptions, Target} from '../src/types';
 
 import {DEFAULT_FEATURE_FLAGS} from '@atlaspack/feature-flags';
-import {FSCache} from '@atlaspack/cache';
-import tempy from 'tempy';
-import {inputFS, outputFS} from '@atlaspack/test-utils';
+import {inputFS, outputFS, cache, cacheDir} from '@atlaspack/test-utils';
 import {relativePath} from '@atlaspack/utils';
 import {NodePackageManager} from '@atlaspack/package-manager';
 import {createEnvironment} from '../src/Environment';
 import {toProjectPath} from '../src/projectPath';
-
-let cacheDir = tempy.directory();
-export let cache: FSCache = new FSCache(outputFS, cacheDir);
-cache.ensure();
+import type {EnvironmentRef} from '../src/EnvironmentManager';
 
 export const DEFAULT_OPTIONS: AtlaspackOptions = {
   cacheDir,
@@ -57,7 +52,7 @@ export const DEFAULT_OPTIONS: AtlaspackOptions = {
   },
 };
 
-export const DEFAULT_ENV: Environment = createEnvironment({
+export const DEFAULT_ENV: EnvironmentRef = createEnvironment({
   context: 'browser',
   engines: {
     browsers: ['> 1%'],