Filter tracking (#76)

* Support filtering types for compression in tracking
* Remove double build from pre-push
* Pin to fork of np since it actually works
* Remove double build from github action

Author: kristoferbaxter

.github/workflows/unit-test.yml

@@ -15,5 +15,4 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: yarn install
-    - run: yarn build
     - run: yarn test

package.json

@@ -17,7 +17,8 @@
     "url": "https://github.com/ampproject/filesize.git"
   },
   "scripts": {
-    "pretest": "tsc -p test/tsconfig.json",
+    "build-tests": "tsc -p test/tsconfig.json",
+    "pretest": "yarn npm-run-all build build-tests",
     "test": "ava -v --timeout=2m",
     "clean": "rimraf dist output test/output",
     "build": "rollup -c; shx chmod a+x dist/filesize",
@@ -42,7 +43,7 @@
     "ava": "3.5.1",
     "husky": "4.2.5",
     "lint-staged": "10.1.4",
-    "np": "6.2.1",
+    "np": "https://github.com/pixelastic/np/tarball/c3ab2e3b053c7da0ce40a572ca1616273ac080f8",
     "npm-run-all": "4.1.5",
     "prettier": "2.0.4",
     "rimraf": "3.0.2",
@@ -85,7 +86,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-push": "yarn npm-run-all clean build test",
+      "pre-push": "yarn npm-run-all clean test",
       "pre-commit": "lint-staged"
     }
   },

src/validation/Config.ts

@@ -66,7 +66,7 @@ const CONDITIONS = [
         return `There is no 'filesize' configuration in '${context.packagePath}'`;
       }
 
-      const { track, ...keys } = json;
+      const { track, trackFormat, ...keys } = json;
       if (Object.entries(keys).length === 0 && track === undefined) {
         return `There is no data inside the 'filesize' configuration in '${context.packagePath}'`;
       }
@@ -96,7 +96,7 @@ const CONDITIONS = [
 ];
 
 const Config: ConditionFunction = (context: Context) =>
-  async function() {
+  async function () {
     for await (const condition of CONDITIONS) {
       const conditionResult = await condition(context);
       if (conditionResult !== null) {

src/validation/File.ts

@@ -23,7 +23,7 @@ const bytes = require('bytes');
  * Format input string to a known Compression Enum Value.
  * @param fsValue
  */
-function validateCompressionName(fsValue: string): Compression | null {
+export function validateCompressionName(fsValue: string): Compression | null {
   const lowerCaseValue = fsValue.toLowerCase();
   switch (fsValue.toLowerCase()) {
     case 'brotli':

src/validation/Track.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
-import { Context, ValidationResponse } from './Condition';
-import glob from 'fast-glob';
 import { resolve } from 'path';
+import glob from 'fast-glob';
+import { Context, ValidationResponse, SizeMapValue } from './Condition';
+import { validateCompressionName } from './File';
 
 /**
  * Use 'fast-glob' to find files requested to track from configuration.
@@ -27,15 +28,26 @@ export async function Track(context: Context, json: any): Promise<ValidationResp
   if ('track' in json && Array.isArray(json.track)) {
     const entries: Array<string> = await glob(json.track);
 
+    let trackedFormats: SizeMapValue = [
+      [null, undefined],
+      [null, undefined],
+      [null, undefined],
+    ];
+    if ('trackFormat' in json && Array.isArray(json.trackFormat)) {
+      // `trackFormats` allows you to limit the compression types for tracking
+      const formats = json.trackFormat.map((format: any) => validateCompressionName(String(format))).filter(Boolean);
+      trackedFormats = [
+        [formats.includes('brotli') ? null : undefined, undefined],
+        [formats.includes('gzip') ? null : undefined, undefined],
+        [formats.includes('none') ? null : undefined, undefined],
+      ];
+    }
+
     // glob ensures the results are valid files.
     for (const entry of entries) {
       const path = resolve(entry);
 
-      context.compressed.set(path, [
-        [null, undefined],
-        [null, undefined],
-        [null, undefined],
-      ]);
+      context.compressed.set(path, trackedFormats);
       context.originalPaths.set(path, entry);
     }
   }

test/config-validation/fixtures/track-standalone-format/index.js

@@ -0,0 +1,6 @@
+{
+  "filesize": {
+    "track": ["test/config-validation/fixtures/track-standalone-format/**/*.js"],
+    "trackFormat": ["brotli"]
+  }
+}

test/config-validation/fixtures/track-standalone-format/package.json

@@ -20,7 +20,7 @@ import { report } from '../../src/api';
 import Config from '../../src/validation/Config';
 import { Context, SizeMapValue, SizeMap } from '../../src/validation/Condition';
 
-test('including trackable items should succeed', async t => {
+test('including trackable items should succeed', async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/track/package.json',
     projectPath: 'test/config-validation/fixtures/track',
@@ -37,7 +37,7 @@ test('including trackable items should succeed', async t => {
   t.is(message, null);
 });
 
-test('trackable items uses glob to find files', async t => {
+test('trackable items uses glob to find files', async (t) => {
   const sizes: SizeMapValue = [
     [null, undefined], // brotli
     [null, undefined], // gzip
@@ -55,3 +55,22 @@ test('trackable items uses glob to find files', async t => {
   }
   t.deepEqual(results, expected);
 });
+
+test('trackable items uses trackFormats to restrict compression types', async (t) => {
+  const sizes: SizeMapValue = [
+    [null, undefined], // brotli
+    [undefined, undefined], // gzip
+    [undefined, undefined], // none
+  ];
+  const expected: SizeMap = new Map();
+  expected.set(resolve('test/config-validation/fixtures/track-standalone-format/index.js'), sizes);
+
+  const values = report('test/config-validation/fixtures/track-standalone-format', null);
+  let next = await values.next();
+  let results: SizeMap | undefined = undefined;
+  while (!next.done) {
+    results = next.value[0];
+    next = await values.next();
+  }
+  t.deepEqual(results, expected);
+});