Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require sharp from the main thread to prevent issues on worker exit #7001

Merged
merged 2 commits into from
Oct 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/transformers/image/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
},
"dependencies": {
"@parcel/plugin": "2.0.0-rc.0",
"@parcel/workers": "2.0.0-rc.0",
"nullthrows": "^1.1.1"
},
"devDependencies": {
Expand Down
30 changes: 23 additions & 7 deletions packages/transformers/image/src/ImageTransformer.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
import {validateConfig} from './validateConfig';
import {Transformer} from '@parcel/plugin';
import nullthrows from 'nullthrows';
import WorkerFarm from '@parcel/workers';
import loadSharp from './loadSharp';

// from https://github.com/lovell/sharp/blob/df7b8ba73808fc494be413e88cfb621b6279218c/lib/output.js#L6-L17
const FORMATS = new Map([
Expand All @@ -16,7 +18,7 @@ const FORMATS = new Map([
['heif', 'heif'],
]);

const SHARP_RANGE = '^0.29.1';
let isSharpLoadedOnMainThread = false;

export default (new Transformer({
async loadConfig({config}) {
Expand Down Expand Up @@ -61,14 +63,28 @@ export default (new Transformer({
const outputOptions = config[format];

if (width || height || quality || targetFormat || outputOptions) {
// Sharp must be required from the main thread as well to prevent errors when workers exit
// See https://sharp.pixelplumbing.com/install#worker-threads and https://github.com/lovell/sharp/issues/2263
if (WorkerFarm.isWorker() && !isSharpLoadedOnMainThread) {
let api = WorkerFarm.getWorkerApi();
await api.callMaster({
location: __dirname + '/loadSharp.js',
args: [
options.packageManager,
asset.filePath,
options.shouldAutoInstall,
],
});

isSharpLoadedOnMainThread = true;
}

let inputBuffer = await asset.getBuffer();
let sharp = await options.packageManager.require(
'sharp',
let sharp = await loadSharp(
options.packageManager,
asset.filePath,
{
range: SHARP_RANGE,
shouldAutoInstall: options.shouldAutoInstall,
},
options.shouldAutoInstall,
true,
);

let imagePipeline = sharp(inputBuffer);
Expand Down
23 changes: 23 additions & 0 deletions packages/transformers/image/src/loadSharp.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// @flow
import type {PackageManager} from '@parcel/package-manager';
import type {FilePath} from '@parcel/types';

const SHARP_RANGE = '^0.29.1';

// This is used to load sharp on the main thread, which prevents errors when worker threads exit
// See https://sharp.pixelplumbing.com/install#worker-threads and https://github.com/lovell/sharp/issues/2263
module.exports = async (
packageManager: PackageManager,
filePath: FilePath,
shouldAutoInstall: boolean,
shouldReturn: boolean,
): Promise<any> => {
let sharp = await packageManager.require('sharp', filePath, {
range: SHARP_RANGE,
shouldAutoInstall: shouldAutoInstall,
});

if (shouldReturn) {
return sharp;
}
};