All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jetbrains.kotlin.cli.js.dce.K2JSDce.kt Maven / Gradle / Ivy

There is a newer version: 2.1.0-RC
Show newest version
/*
 * Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

package org.jetbrains.kotlin.cli.js.dce

import org.jetbrains.kotlin.cli.common.CLITool
import org.jetbrains.kotlin.cli.common.ExitCode
import org.jetbrains.kotlin.cli.common.arguments.DevModeOverwritingStrategies
import org.jetbrains.kotlin.cli.common.arguments.K2JSDceArguments
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
import org.jetbrains.kotlin.cli.common.messages.MessageCollector
import org.jetbrains.kotlin.config.Services
import org.jetbrains.kotlin.js.dce.*
import org.jetbrains.kotlin.js.sourceMap.RelativePathCalculator
import org.jetbrains.kotlin.js.parser.sourcemaps.*
import java.io.*
import java.util.zip.ZipFile

class K2JSDce : CLITool() {
    override fun createArguments(): K2JSDceArguments = K2JSDceArguments()

    override fun execImpl(messageCollector: MessageCollector, services: Services, arguments: K2JSDceArguments): ExitCode {
        val baseDir = File(arguments.outputDirectory ?: "min")
        val files = arguments.freeArgs.flatMap { arg ->
            collectInputFiles(baseDir, arg, messageCollector)
        }

        if (messageCollector.hasErrors()) return ExitCode.COMPILATION_ERROR

        if (files.isEmpty() && !arguments.version) {
            messageCollector.report(CompilerMessageSeverity.ERROR, "no source files")
            return ExitCode.COMPILATION_ERROR
        }

        val existingFiles = mutableMapOf()
        for (file in files) {
            existingFiles[file.outputPath]?.let {
                messageCollector.report(
                    CompilerMessageSeverity.ERROR,
                    "duplicate target file will be created for '${file.resource.name}' and '${it.resource.name}'"
                )
                return ExitCode.COMPILATION_ERROR
            }
            existingFiles[file.outputPath] = file
            if (File(file.outputPath).isDirectory) {
                messageCollector.report(CompilerMessageSeverity.ERROR, "cannot open output file '${file.outputPath}': it is a directory")
                return ExitCode.COMPILATION_ERROR
            }
        }

        return if (!arguments.devMode) {
            performDce(files, arguments, messageCollector)
        } else {
            val devModeOverwritingStrategy =
                arguments.devModeOverwritingStrategy ?:
                System.getProperty("kotlin.js.dce.devmode.overwriting.strategy", DevModeOverwritingStrategies.OLDER)

            val overwriteOnlyOlderFiles = devModeOverwritingStrategy == DevModeOverwritingStrategies.OLDER

            copyFiles(files, overwriteOnlyOlderFiles)
            ExitCode.OK
        }
    }

    private fun performDce(files: List, arguments: K2JSDceArguments, messageCollector: MessageCollector): ExitCode {
        val includedDeclarations = arguments.declarationsToKeep.orEmpty().toSet()

        val logConsumer = { level: DCELogLevel, message: String ->
            val severity = when (level) {
                DCELogLevel.ERROR -> CompilerMessageSeverity.ERROR
                DCELogLevel.WARN -> CompilerMessageSeverity.WARNING
                DCELogLevel.INFO -> CompilerMessageSeverity.LOGGING
            }
            messageCollector.report(severity, message)
        }

        val dceResult = DeadCodeElimination.run(
            files,
            includedDeclarations,
            arguments.printReachabilityInfo,
            logConsumer
        )
        if (dceResult.status == DeadCodeEliminationStatus.FAILED) return ExitCode.COMPILATION_ERROR

        if (arguments.printReachabilityInfo) {
            val reachabilitySeverity = CompilerMessageSeverity.INFO
            messageCollector.report(reachabilitySeverity, "")
            for (node in dceResult.reachableNodes.extractReachableRoots(dceResult.context!!)) {
                printTree(
                    node, { messageCollector.report(reachabilitySeverity, it) },
                    printNestedMembers = false, showLocations = true
                )
            }
        }

        return ExitCode.OK
    }

    private fun copyFiles(files: List, overwriteOnlyOlderFiles: Boolean) {
        for (file in files) {
            copyResource(file.resource, File(file.outputPath), overwriteOnlyOlderFiles)
            file.sourceMapResource?.let { sourceMap ->
                val sourceMapTarget = File(file.outputPath + ".map")
                val inputFile = File(sourceMap.name)
                if (!inputFile.exists() || !mapSourcePaths(inputFile, sourceMapTarget)) {
                    copyResource(sourceMap, sourceMapTarget, overwriteOnlyOlderFiles)
                }
            }
        }
    }

    private fun copyResource(resource: InputResource, targetFile: File, overwriteOnlyOlderFiles: Boolean) {
        // TODO shouldn't it be "<="?
        if (overwriteOnlyOlderFiles && targetFile.exists() && resource.lastModified() < targetFile.lastModified()) return

        targetFile.parentFile.mkdirs()
        resource.reader().use { input ->
            FileOutputStream(targetFile).use { output ->
                input.copyTo(output)
            }
        }
    }

    private fun mapSourcePaths(inputFile: File, targetFile: File): Boolean {
        val jsonOut = StringWriter()
        val pathCalculator = RelativePathCalculator(targetFile.parentFile)
        val sourceMapChanged = try {
            SourceMap.mapSources(inputFile.readText(), jsonOut) {
                val result = pathCalculator.calculateRelativePathTo(File(inputFile.parentFile, it))
                if (result != null) {
                    if (File(targetFile.parentFile, result).exists()) {
                        result
                    } else {
                        it
                    }
                } else {
                    it
                }
            }
        } catch (e: SourceMapSourceReplacementException) {
            false
        }

        if (!sourceMapChanged) return false

        targetFile.parentFile.mkdirs()
        OutputStreamWriter(FileOutputStream(targetFile), "UTF-8").use { it.write(jsonOut.toString()) }

        return true
    }

    private fun collectInputFiles(baseDir: File, fileName: String, messageCollector: MessageCollector): List {
        val file = File(fileName)
        return when {
            file.isDirectory -> {
                collectInputFilesFromDirectory(baseDir, fileName)
            }
            file.isFile -> {
                when {
                    fileName.endsWith(".js") -> {
                        listOf(singleInputFile(baseDir, fileName))
                    }
                    fileName.endsWith(".zip") || fileName.endsWith(".jar") -> {
                        collectInputFilesFromZip(baseDir, fileName)
                    }
                    else -> {
                        messageCollector.report(
                            CompilerMessageSeverity.WARNING,
                            "invalid file name '${file.absolutePath}'; must end either with '.js', '.zip' or '.jar'"
                        )
                        emptyList()
                    }
                }
            }
            else -> {
                messageCollector.report(CompilerMessageSeverity.ERROR, "source file or directory not found: $fileName")
                emptyList()
            }
        }
    }

    private fun singleInputFile(baseDir: File, path: String): InputFile {
        val moduleName = getModuleNameFromPath(path)
        val pathToSourceMapCandidate = "$path.map"
        val pathToSourceMap = if (File(pathToSourceMapCandidate).exists()) pathToSourceMapCandidate else null
        return InputFile(
            InputResource.file(path), pathToSourceMap?.let { InputResource.file(it) },
            File(baseDir, "$moduleName.js").absolutePath, moduleName
        )
    }

    private fun collectInputFilesFromZip(baseDir: File, path: String): List {
        return ZipFile(path).use { zipFile ->
            zipFile.entries().asSequence()
                .filter { !it.isDirectory }
                .filter { it.name.endsWith(".js") }
                .filter { zipFile.getEntry(it.name.metaJs()) != null }
                .distinctBy { it.name }
                .map { entry ->
                    val moduleName = getModuleNameFromPath(entry.name)
                    val pathToSourceMapCandidate = "${entry.name}.map"
                    val pathToSourceMap = if (zipFile.getEntry(pathToSourceMapCandidate) != null) pathToSourceMapCandidate else null
                    InputFile(
                        InputResource.zipFile(path, entry.name), pathToSourceMap?.let { InputResource.zipFile(path, it) },
                        File(baseDir, "$moduleName.js").absolutePath, moduleName
                    )
                }
                .toList()
        }
    }

    private fun collectInputFilesFromDirectory(baseDir: File, path: String): List {
        return File(path).walkTopDown().asSequence()
            .filter { !it.isDirectory }
            .filter { it.name.endsWith(".js") }
            .filter { File(it.path.metaJs()).exists() }
            .map { entry ->
                val moduleName = getModuleNameFromPath(entry.name)
                val pathToSourceMapCandidate = "${entry.path}.map"
                val pathToSourceMap = if (File(pathToSourceMapCandidate).exists()) pathToSourceMapCandidate else null
                InputFile(
                    InputResource.file(entry.path), pathToSourceMap?.let { InputResource.file(it) },
                    File(baseDir, "$moduleName.js").absolutePath, moduleName
                )
            }
            .toList()
    }

    private fun String.metaJs() = removeSuffix(".js") + ".meta.js"

    private fun getModuleNameFromPath(path: String): String {
        val dotIndex = path.lastIndexOf('.')
        val slashIndex = maxOf(path.lastIndexOf('/'), path.lastIndexOf('\\'))
        return path.substring(slashIndex + 1, if (dotIndex < 0) path.length else dotIndex)
    }

    override fun executableScriptFileName(): String = "kotlin-dce-js"

    companion object {
        @JvmStatic
        fun main(args: Array) {
            CLITool.doMain(K2JSDce(), args)
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy