v3.1.0 #150

moonglum · 2025-03-09T12:10:30Z

Clean up utils

Looking into static, I noticed that we use the utils less than I thought.

FileManager is removed (pending based on the static/images work)
resolvePath is moved into util/index.js (this is a breaking change for aiur, but aiur will depend on 3 anyway)
generateFingerprint is moved into lib/manager.js as it is the only place where it is used (the test is moved accordingly)
SerializedRunner is moved to lib, as it is only used in core

This is a breaking change, but I could imagine putting it into core 3 as it is currently not used yet.

Remove remaining runtime dependencies

push the responsibility of dealing with browserslist to the plugin
make nite-owl optional. Open question: Should nite-owl be renamed to faucet-pipeline-watch?

Alternative name for static

To solve faucet-pipeline/faucet-pipeline-static#72 this allows users to use static as "assets".
Doc changes: faucet-pipeline/docs#105

Expose baseURI in manifest

This is needed in aiur, and removes some akward workarounds there.

Types

Add the types necessary to build a plugin. This does not run any TS on this project itself.

Remove `--liveserve`

The dependency has not been updated in over three years, and has severe security issues.

moonglum · 2025-03-15T19:25:58Z

test/test_plugins.js

@@ -21,6 +21,10 @@ let DEFAULTS = {
 		bucket: "static",
 		plugin: "faucet-pipeline-static"
 	},
+	assets: {


I think this file is also the place where we would mark the old name as deprecated.

I'm not currently sure how exactly we'd do that, especially because plugins can override these defaults? I guess we'll have to put on our hazmat suits and wade into the implementation eventually...

FND

Seems reasonable to me, though I've kinda run out of brainspace for the moment; let's conclude faucet-pipeline/faucet-pipeline-static#71 first.

FND · 2025-03-16T10:12:15Z

lib/manager.js

+}
+
+// exported for testing
+exports.generateFingerprint = generateFingerprint;


Suggested change

exports.generateFingerprint = generateFingerprint;

exports._generateFingerprint = generateFingerprint;

That makes it explicit; cf. _determinePlugins.

FND · 2025-03-16T10:14:32Z

lib/manager.js

+
+function generateFingerprint(filepath, data) {
+	let filename = path.basename(filepath);
+	let ext = filename.indexOf(".") === -1 ? "" : "." + filename.split(".").pop();


Why are we not using path.extname here? (See potentially related discussion for faucet-static/static-images.)

(Though we might reasonably opt not to risk changing the implementation here, due to backwards-compatibility concerns.)

FND · 2025-03-16T10:16:25Z

lib/manager.js

+exports.generateFingerprint = generateFingerprint;
+
+function generateHash(str) {
+	let hash = crypto.createHash("md5");


Should we perhaps change this to SHA-256? I realize that might be a backwards-compatibility concern though...

My results suggest that you should probably not be using MD5. MD5 is slower than SHA-256 and not as safe.

— JavaScript hashing speed comparison: MD5 versus SHA-256

FND · 2025-03-16T10:17:14Z

lib/util/index.js

+let fs = require("fs");
 let path = require("path");


Might as well do this while we're at it:

Suggested change

let fs = require("fs");

let path = require("path");

let fs = require("node:fs");

let path = require("node:path");

FND · 2025-03-16T10:22:01Z

lib/util/index.js

-let crypto = require("crypto");
-
-exports.abort = abort;
-exports.repr = repr;


FWIW, I had intentionally moved exports to the top (yay hoisting) so you don't have to go searching for them in the middle of random implementation details. 🤷

FND · 2025-03-16T10:23:42Z

test/test_plugins.js

@@ -21,6 +21,10 @@ let DEFAULTS = {
 		bucket: "static",
 		plugin: "faucet-pipeline-static"
 	},
+	assets: {


I'm not currently sure how exactly we'd do that, especially because plugins can override these defaults? I guess we'll have to put on our hazmat suits and wade into the implementation eventually...

This moves the responsibility to the plugin, where it makes more sense. This also removes the need for browserslist as a dependency in core.

moonglum · 2025-04-22T11:11:56Z

Thanks for the feedback! I plan to incorporate that this week.

I worked on two things we discussed in a chat:

I removed browserslist. The setup is really weird: We determine the browsers in core, and pass them to the plugin. But most of the handling is done by the plugin anyway. This doesn't make a lot of sense to me. I created this PR for faucet-pipeline-sass to show how I think it should work instead. This change in -sass, -css and -js would make it dual-compatible with 2.x and 3.x. See Implement browserslist handling outside of core faucet-pipeline-sass#210
I made nite-owl optional. I would like to take that opportunity to rename it to faucet-pipeline-watch (or -watcher), as that is what nite-owl really is. That makes it more consistent with other additional libraries you need to install.

Clean up utils

17dfc2f

moonglum mentioned this pull request Mar 15, 2025

faucet-pipeline-core 3.1.0 rollout #149

Open

6 tasks

moonglum changed the title ~~Clean up utils~~ v3.1.0 Mar 15, 2025

Allow to use static as assets

93d35ec

moonglum requested a review from FND March 15, 2025 17:35

This was referenced Mar 15, 2025

plugin name constitutes a reserved identifier, blocking ESM compatibility faucet-pipeline/faucet-pipeline-static#72

Open

Doc changes for the faucet 3.1 roll out faucet-pipeline/docs#105

Open

moonglum commented Mar 15, 2025

View reviewed changes

FND reviewed Mar 16, 2025

View reviewed changes

moonglum added 2 commits April 22, 2025 12:45

Remove browsers as a param to plugins

82a7635

This moves the responsibility to the plugin, where it makes more sense. This also removes the need for browserslist as a dependency in core.

Make nite-owl an optional dependency

1a40eb5

moonglum added 5 commits April 26, 2025 17:52

Make the baseURI available on the manifest

b8ad295

Add types for plugins

c9c4c9f

Clean up

85af017

Remove liveserver option

73777b8

Remove finally polyfill

7bf71e2

moonglum force-pushed the util-cleanup branch from b497165 to 7bf71e2 Compare May 20, 2025 13:11

Remove AssetManager#packagesDir

3bf9b98

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

v3.1.0 #150

v3.1.0 #150

Uh oh!

moonglum commented Mar 9, 2025 •

edited

Loading

Uh oh!

moonglum Mar 15, 2025

Uh oh!

FND Mar 16, 2025

Uh oh!

FND left a comment

Uh oh!

FND Mar 16, 2025

Uh oh!

FND Mar 16, 2025

Uh oh!

FND Mar 16, 2025

Uh oh!

FND Mar 16, 2025

Uh oh!

FND Mar 16, 2025

Uh oh!

FND Mar 16, 2025

Uh oh!

moonglum commented Apr 22, 2025

Uh oh!

Uh oh!

	exports.generateFingerprint = generateFingerprint;
	exports._generateFingerprint = generateFingerprint;

v3.1.0 #150

Are you sure you want to change the base?

v3.1.0 #150

Uh oh!

Conversation

moonglum commented Mar 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Clean up utils

Remove remaining runtime dependencies

Alternative name for static

Expose baseURI in manifest

Types

Remove --liveserve

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FND left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moonglum commented Apr 22, 2025

Uh oh!

Uh oh!

moonglum commented Mar 9, 2025 •

edited

Loading

Remove `--liveserve`