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

Implement new loader applying method #98

Open
wants to merge 1 commit into
base: 5.x-dev
Choose a base branch
from
Open
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
60 changes: 36 additions & 24 deletions src/ModifySourcePlugin.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
import crypto from 'crypto';
import { validate } from 'schema-utils';
import type { Schema } from 'schema-utils/declarations/validate';
import type { Compiler, NormalModule } from 'webpack';

import { getPluginLoaderPath } from './getPluginLoaderPath';
import { isPluginWebpackLoader } from './isPluginWebpackLoader';
import { NormalModuleLoader } from './NormalModuleLoader';
import { AbstractOperation } from './operations';
import { PluginWebpackLoaderOptions } from './PluginWebpackLoaderOptions';

export interface Rule {
test: RegExp | ((module: NormalModule) => boolean);
Expand Down Expand Up @@ -48,6 +53,10 @@ const validationSchema: Schema = {

const PLUGIN_NAME = 'ModifySourcePlugin';

function hashModuleOptions(options: Record<string, any>): string {
return crypto.createHash('md5').update(JSON.stringify(options)).digest('hex');
}

export class ModifySourcePlugin {
constructor(protected readonly options: Options) {
validate(validationSchema, options, {
Expand All @@ -58,9 +67,9 @@ export class ModifySourcePlugin {
public apply(compiler: Compiler): void {
const { rules, debug, constants = {} } = this.options;

compiler.hooks.compilation.tap(PLUGIN_NAME, compilation => {
const modifiedModules: (string | number)[] = [];
const appliedOperationHashes: string[] = [];

compiler.hooks.compilation.tap(PLUGIN_NAME, compilation => {
const tapCallback = (_: any, normalModule: NormalModule) => {
const userRequest = normalModule.userRequest || '';

Expand All @@ -73,11 +82,28 @@ export class ModifySourcePlugin {
.substring(startIndex)
.replace(/\\/g, '/');

if (modifiedModules.includes(moduleRequest)) {
return;
}
const moduleLoaders = normalModule.loaders as NormalModuleLoader[];

rules.forEach(ruleOptions => {
const isRuleAlreadyApplied = moduleLoaders.some(moduleLoader => {
if (isPluginWebpackLoader(moduleLoader)) {
const loaderOptions =
typeof moduleLoader.options === 'string'
? (JSON.parse(
moduleLoader.options
) as PluginWebpackLoaderOptions)
: moduleLoader.options;

return appliedOperationHashes.includes(
hashModuleOptions(loaderOptions)
);
}
});

if (isRuleAlreadyApplied) {
return;
}

const test = ruleOptions.test;
const isMatched = (() => {
if (typeof test === 'function' && test(normalModule)) {
Expand All @@ -88,35 +114,21 @@ export class ModifySourcePlugin {
})();

if (isMatched) {
type NormalModuleLoader = {
loader: string;
options: any;
ident?: string;
type?: string;
};

const serializableOperations = ruleOptions.operations?.map(op =>
op.toSerializable()
);

const loader = (() => {
try {
return require.resolve('./loader');
} catch (e) {
return require.resolve('../build/loader.js');
}
})();

(normalModule.loaders as NormalModuleLoader[]).push({
loader,
const loader: NormalModuleLoader = {
loader: getPluginLoaderPath(),
options: {
moduleRequest,
operations: serializableOperations,
constants
}
});
};

modifiedModules.push(moduleRequest);
moduleLoaders.push(loader);
appliedOperationHashes.push(hashModuleOptions(loader.options));

if (debug) {
// eslint-disable-next-line no-console
Expand Down
6 changes: 6 additions & 0 deletions src/NormalModuleLoader.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export type NormalModuleLoader<TOptions = any> = {
loader: string;
options: TOptions | string;
ident?: string;
type?: string;
};
8 changes: 8 additions & 0 deletions src/PluginWebpackLoaderOptions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { AbstractOperation } from './operations';
import { SerializableClassInstance } from './serializable';

export type PluginWebpackLoaderOptions = {
moduleRequest: string;
operations?: SerializableClassInstance<AbstractOperation>[];
constants: Record<string, string | number>;
};
7 changes: 7 additions & 0 deletions src/getPluginLoaderPath.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export function getPluginLoaderPath(): string {
try {
return require.resolve('./loader');
} catch (e) {
return require.resolve('../build/loader.js');
}
}
9 changes: 9 additions & 0 deletions src/isPluginWebpackLoader.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { getPluginLoaderPath } from './getPluginLoaderPath';
import { NormalModuleLoader } from './NormalModuleLoader';
import { PluginWebpackLoaderOptions } from './PluginWebpackLoaderOptions';

export function isPluginWebpackLoader(
moduleLoader: NormalModuleLoader
): moduleLoader is NormalModuleLoader<PluginWebpackLoaderOptions> {
return moduleLoader.loader === getPluginLoaderPath();
}