source: frontend/node_modules/webpack/lib/dependencies/CommonJsFullRequireDependency.js

/*
        MIT License http://www.opensource.org/licenses/mit-license.php
        Author Tobias Koppers @sokra
*/

"use strict";

const Template = require("../Template");
const { equals } = require("../util/ArrayHelpers");
const { getTrimmedIdsAndRange } = require("../util/chainedImports");
const makeSerializable = require("../util/makeSerializable");
const { propertyAccess } = require("../util/property");
const {
        ESM_MODULE_EXPORTS_NAME,
        getRequireEsmModuleExportsAccess,
        isRequireEsmModuleExportsModule
} = require("./CommonJsDependencyHelpers");
const ModuleDependency = require("./ModuleDependency");

/** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
/** @typedef {import("../Dependency")} Dependency */
/** @typedef {import("../Dependency").ReferencedExports} ReferencedExports */
/** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
/** @typedef {import("../ModuleGraph")} ModuleGraph */
/** @typedef {import("../javascript/JavascriptParser").Range} Range */
/** @typedef {import("../ExportsInfo").ExportInfoName} ExportInfoName */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
/** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
/** @typedef {import("../util/chainedImports").IdRanges} IdRanges */

class CommonJsFullRequireDependency extends ModuleDependency {
        /**
         * Creates an instance of CommonJsFullRequireDependency.
         * @param {string} request the request string
         * @param {Range} range location in source code
         * @param {ExportInfoName[]} names accessed properties on module
         * @param {IdRanges=} idRanges ranges for members of ids; the two arrays are right-aligned
         */
        constructor(
                request,
                range,
                names,
                idRanges /* TODO webpack 6 make this non-optional. It must always be set to properly trim ids. */
        ) {
                super(request);
                this.range = range;
                this.names = names;
                this.idRanges = idRanges;
                /** @type {boolean} */
                this.call = false;
                /** @type {undefined | boolean} */
                this.asiSafe = undefined;
        }

        /**
         * Returns list of exports referenced by this dependency
         * @param {ModuleGraph} moduleGraph module graph
         * @param {RuntimeSpec} runtime the runtime for which the module is analysed
         * @returns {ReferencedExports} referenced exports
         */
        getReferencedExports(moduleGraph, runtime) {
                const importedModule = moduleGraph.getModule(this);
                if (
                        importedModule &&
                        isRequireEsmModuleExportsModule(importedModule, moduleGraph)
                ) {
                        // When `require(esm)` unwraps a `"module.exports"` named export, the
                        // user's property access lands on that value (which webpack does not
                        // model), so only the "module.exports" export itself is referenced.
                        return [[ESM_MODULE_EXPORTS_NAME]];
                }
                if (
                        this.call &&
                        (!importedModule ||
                                importedModule.getExportsType(moduleGraph, false) !== "namespace")
                ) {
                        return [this.names.slice(0, -1)];
                }
                return [this.names];
        }

        /**
         * Serializes this instance into the provided serializer context.
         * @param {ObjectSerializerContext} context context
         */
        serialize(context) {
                const { write } = context;
                write(this.names);
                write(this.idRanges);
                write(this.call);
                write(this.asiSafe);
                super.serialize(context);
        }

        /**
         * Restores this instance from the provided deserializer context.
         * @param {ObjectDeserializerContext} context context
         */
        deserialize(context) {
                const { read } = context;
                this.names = read();
                this.idRanges = read();
                this.call = read();
                this.asiSafe = read();
                super.deserialize(context);
        }

        get type() {
                return "cjs full require";
        }

        get category() {
                return "commonjs";
        }
}

CommonJsFullRequireDependency.Template = class CommonJsFullRequireDependencyTemplate extends (
        ModuleDependency.Template
) {
        /**
         * Applies the plugin by registering its hooks on the compiler.
         * @param {Dependency} dependency the dependency for which the template should be applied
         * @param {ReplaceSource} source the current replace source which can be modified
         * @param {DependencyTemplateContext} templateContext the context object
         * @returns {void}
         */
        apply(
                dependency,
                source,
                { runtimeTemplate, moduleGraph, chunkGraph, runtimeRequirements, runtime }
        ) {
                const dep = /** @type {CommonJsFullRequireDependency} */ (dependency);
                if (!dep.range) return;
                const importedModule = moduleGraph.getModule(dep);
                let requireExpr = runtimeTemplate.moduleExports({
                        module: importedModule,
                        chunkGraph,
                        request: dep.request,
                        weak: dep.weak,
                        runtimeRequirements
                });

                const esmRequireAccess = importedModule
                        ? getRequireEsmModuleExportsAccess(importedModule, moduleGraph, runtime)
                        : null;

                const {
                        trimmedRange: [trimmedRangeStart, trimmedRangeEnd],
                        trimmedIds
                } = getTrimmedIdsAndRange(
                        dep.names,
                        dep.range,
                        dep.idRanges,
                        moduleGraph,
                        dep
                );

                if (esmRequireAccess !== null) {
                        const access = `${esmRequireAccess}${propertyAccess(trimmedIds)}`;
                        requireExpr =
                                dep.asiSafe === true
                                        ? `(${requireExpr}${access})`
                                        : `${requireExpr}${access}`;
                } else if (importedModule) {
                        const usedImported = moduleGraph
                                .getExportsInfo(importedModule)
                                .getUsedName(trimmedIds, runtime);
                        if (usedImported) {
                                const comment = equals(usedImported, trimmedIds)
                                        ? ""
                                        : `${Template.toNormalComment(propertyAccess(trimmedIds))} `;
                                const access = `${comment}${propertyAccess(usedImported)}`;
                                requireExpr =
                                        dep.asiSafe === true
                                                ? `(${requireExpr}${access})`
                                                : `${requireExpr}${access}`;
                        }
                }
                source.replace(trimmedRangeStart, trimmedRangeEnd - 1, requireExpr);
        }
};

makeSerializable(
        CommonJsFullRequireDependency,
        "webpack/lib/dependencies/CommonJsFullRequireDependency"
);

module.exports = CommonJsFullRequireDependency;