@jsenv/core 27.0.0-alpha.82 → 27.0.0-alpha.85

package/src/plugins/url_analysis/css/css_urls.js

@@ -2,9 +2,8 @@
  * https://github.com/parcel-bundler/parcel/blob/v2/packages/transformers/css/src/CSSTransformer.js
  */
 
-import { createMagicSource } from "@jsenv/utils/sourcemap/magic_source.js"
-import { applyPostCss } from "@jsenv/utils/css_ast/apply_post_css.js"
-import { postCssPluginUrlVisitor } from "@jsenv/utils/css_ast/postcss_plugin_url_visitor.js"
+import { createMagicSource } from "@jsenv/sourcemap"
+import { applyPostCss, postCssPluginUrlVisitor } from "@jsenv/ast"
 
 export const parseAndTransformCssUrls = async (urlInfo, context) => {
   const actions = []

package/src/plugins/url_analysis/html/html_urls.js

@@ -1,11 +1,13 @@
 import {
   parseHtmlString,
+  visitHtmlNodes,
+  getHtmlNodeAttribute,
+  getHtmlNodePosition,
+  setHtmlNodeAttributes,
+  getHtmlNodeAttributePosition,
+  parseSrcSet,
   stringifyHtmlAst,
-  getHtmlNodeAttributeByName,
-  htmlNodePosition,
-  visitHtmlAst,
-} from "@jsenv/utils/html_ast/html_ast.js"
-import { htmlAttributeSrcSet } from "@jsenv/utils/html_ast/html_attribute_src_set.js"
+} from "@jsenv/ast"
 
 export const parseAndTransformHtmlUrls = async (urlInfo, context) => {
   const url = urlInfo.originalUrl
@@ -26,9 +28,12 @@ export const parseAndTransformHtmlUrls = async (urlInfo, context) => {
       column,
       originalLine,
       originalColumn,
+      node,
+      attributeName,
       specifier,
-      attribute,
     }) => {
+      const { crossorigin, integrity } = readFetchMetas(node)
+
       const isRessourceHint = [
         "preconnect",
         "dns-prefetch",
@@ -45,9 +50,15 @@ export const parseAndTransformHtmlUrls = async (urlInfo, context) => {
         specifierLine: line,
         specifierColumn: column,
         isRessourceHint,
+        crossorigin,
+        integrity,
       })
       actions.push(async () => {
-        attribute.value = await referenceUtils.readGeneratedSpecifier(reference)
+        setHtmlNodeAttributes(node, {
+          [attributeName]: await referenceUtils.readGeneratedSpecifier(
+            reference,
+          ),
+        })
       })
     },
   })
@@ -60,25 +71,39 @@ export const parseAndTransformHtmlUrls = async (urlInfo, context) => {
   }
 }
 
+const crossOriginCompatibleTagNames = ["script", "link", "img", "source"]
+const integrityCompatibleTagNames = ["script", "link", "img", "source"]
+const readFetchMetas = (node) => {
+  const meta = {}
+  if (crossOriginCompatibleTagNames.includes(node.nodeName)) {
+    const crossorigin = getHtmlNodeAttribute(node, "crossorigin") !== undefined
+    meta.crossorigin = crossorigin
+  }
+  if (integrityCompatibleTagNames.includes(node.nodeName)) {
+    const integrity = getHtmlNodeAttribute(node, "integrity")
+    meta.integrity = integrity
+  }
+  return meta
+}
+
 const visitHtmlUrls = ({ url, htmlAst, onUrl }) => {
   const addDependency = ({
     type,
     subtype,
     expectedType,
     node,
-    attribute,
+    attributeName,
     specifier,
   }) => {
-    const generatedFromInlineContent = Boolean(
-      getHtmlNodeAttributeByName(node, "generated-from-inline-content"),
-    )
+    const generatedFromInlineContent =
+      getHtmlNodeAttribute(node, "generated-from-inline-content") !== undefined
     let position
     if (generatedFromInlineContent) {
       // when generated from inline content,
       // line, column is not "src" nor "generated-from-src" but "original-position"
-      position = htmlNodePosition.readNodePosition(node)
+      position = getHtmlNodePosition(node)
     } else {
-      position = htmlNodePosition.readAttributePosition(node, attribute.name)
+      position = getHtmlNodeAttributePosition(node, attributeName)
     }
     const {
       line,
@@ -93,18 +118,61 @@ const visitHtmlUrls = ({ url, htmlAst, onUrl }) => {
       column,
       // originalLine, originalColumn
       specifier,
-      attribute,
-      // injected:Boolean(getHtmlNodeAttributeByName(node, "injected-by"))
-      // srcGeneratedFromInlineContent
-      ...readFetchMetas(node),
+      node,
+      attributeName,
     })
   }
-  const visitors = {
+  const visitAttributeAsUrlSpecifier = ({ node, attributeName, ...rest }) => {
+    const value = getHtmlNodeAttribute(node, attributeName)
+    if (value) {
+      const generatedBy = getHtmlNodeAttribute(node, "generated-by")
+      if (generatedBy !== undefined) {
+        // during build the importmap is inlined
+        // and shoud not be considered as a dependency anymore
+        return
+      }
+      addDependency({
+        ...rest,
+        node,
+        attributeName,
+        specifier:
+          attributeName === "generated-from-src" ||
+          attributeName === "generated-from-href"
+            ? new URL(value, url).href
+            : value,
+      })
+    } else if (attributeName === "src") {
+      visitAttributeAsUrlSpecifier({
+        ...rest,
+        node,
+        attributeName: "generated-from-src",
+      })
+    } else if (attributeName === "href") {
+      visitAttributeAsUrlSpecifier({
+        ...rest,
+        node,
+        attributeName: "generated-from-href",
+      })
+    }
+  }
+  const visitSrcset = ({ type, node }) => {
+    const srcset = getHtmlNodeAttribute(node, "srcset")
+    if (srcset) {
+      const srcCandidates = parseSrcSet(srcset)
+      srcCandidates.forEach((srcCandidate) => {
+        addDependency({
+          type,
+          node,
+          attributeName: "srcset",
+          specifier: srcCandidate.specifier,
+        })
+      })
+    }
+  }
+  visitHtmlNodes(htmlAst, {
     link: (node) => {
-      const relAttribute = getHtmlNodeAttributeByName(node, "rel")
-      const rel = relAttribute ? relAttribute.value : undefined
-      const typeAttribute = getHtmlNodeAttributeByName(node, "type")
-      const type = typeAttribute ? typeAttribute.value : undefined
+      const rel = getHtmlNodeAttribute(node, "rel")
+      const type = getHtmlNodeAttribute(node, "type")
       visitAttributeAsUrlSpecifier({
         type: "link_href",
         subtype: rel,
@@ -120,15 +188,16 @@ const visitHtmlUrls = ({ url, htmlAst, onUrl }) => {
     },
     // style: () => {},
     script: (node) => {
-      const typeAttributeNode = getHtmlNodeAttributeByName(node, "type")
+      const type = getHtmlNodeAttribute(node, "type")
+      const expectedType = {
+        "undefined": "js_classic",
+        "text/javascript": "js_classic",
+        "module": "js_module",
+        "importmap": "importmap",
+      }[type]
       visitAttributeAsUrlSpecifier({
         type: "script_src",
-        expectedType: {
-          "undefined": "js_classic",
-          "text/javascript": "js_classic",
-          "module": "js_module",
-          "importmap": "importmap",
-        }[typeAttributeNode ? typeAttributeNode.value : undefined],
+        expectedType,
         node,
         attributeName: "src",
       })
@@ -184,89 +253,5 @@ const visitHtmlUrls = ({ url, htmlAst, onUrl }) => {
         attributeName: "href",
       })
     },
-  }
-  const visitAttributeAsUrlSpecifier = ({
-    type,
-    subtype,
-    expectedType,
-    node,
-    attributeName,
-  }) => {
-    const attribute = getHtmlNodeAttributeByName(node, attributeName)
-    const value = attribute ? attribute.value : undefined
-    if (value) {
-      const generatedBy = getHtmlNodeAttributeByName(node, "generated-by")
-      if (generatedBy) {
-        // during build the importmap is inlined
-        // and shoud not be considered as a dependency anymore
-        return
-      }
-      addDependency({
-        type,
-        subtype,
-        expectedType,
-        node,
-        attribute,
-        specifier:
-          attributeName === "generated-from-src" ||
-          attributeName === "generated-from-href"
-            ? new URL(value, url).href
-            : value,
-      })
-    } else if (attributeName === "src") {
-      visitAttributeAsUrlSpecifier({
-        type,
-        subtype,
-        expectedType,
-        node,
-        attributeName: "generated-from-src",
-      })
-    } else if (attributeName === "href") {
-      visitAttributeAsUrlSpecifier({
-        type,
-        subtype,
-        expectedType,
-        node,
-        attributeName: "generated-from-href",
-      })
-    }
-  }
-  const visitSrcset = ({ type, node }) => {
-    const srcsetAttribute = getHtmlNodeAttributeByName(node, "srcset")
-    const srcset = srcsetAttribute ? srcsetAttribute.value : undefined
-    if (srcset) {
-      const srcCandidates = htmlAttributeSrcSet.parse(srcset)
-      srcCandidates.forEach((srcCandidate) => {
-        addDependency({
-          type,
-          node,
-          attribute: srcsetAttribute,
-          specifier: srcCandidate.specifier,
-        })
-      })
-    }
-  }
-  visitHtmlAst(htmlAst, (node) => {
-    const visitor = visitors[node.nodeName]
-    if (visitor) {
-      visitor(node)
-    }
   })
 }
-
-const crossOriginCompatibleTagNames = ["script", "link", "img", "source"]
-const integrityCompatibleTagNames = ["script", "link", "img", "source"]
-const readFetchMetas = (node) => {
-  const meta = {}
-  if (crossOriginCompatibleTagNames.includes(node.nodeName)) {
-    const crossoriginAttribute = getHtmlNodeAttributeByName(node, "crossorigin")
-    meta.crossorigin = crossoriginAttribute
-      ? crossoriginAttribute.value
-      : undefined
-  }
-  if (integrityCompatibleTagNames.includes(node.nodeName)) {
-    const integrityAttribute = getHtmlNodeAttributeByName(node, "integrity")
-    meta.integrity = integrityAttribute ? integrityAttribute.value : undefined
-  }
-  return meta
-}

package/src/plugins/url_analysis/js/js_urls.js

@@ -1,5 +1,6 @@
-import { parseJsUrls } from "@jsenv/utils/js_ast/parse_js_urls.js"
-import { createMagicSource } from "@jsenv/utils/sourcemap/magic_source.js"
+import { createMagicSource } from "@jsenv/sourcemap"
+import { parseJsUrls } from "@jsenv/ast"
+
 import { isWebWorkerUrlInfo } from "@jsenv/core/src/omega/web_workers.js"
 
 export const parseAndTransformJsUrls = async (urlInfo, context) => {

package/src/test/coverage/babel_plugin_instrument.js

@@ -0,0 +1,82 @@
+import { URL_META } from "@jsenv/url-meta"
+import { fileSystemPathToUrl } from "@jsenv/urls"
+
+import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
+
+// https://github.com/istanbuljs/babel-plugin-istanbul/blob/321740f7b25d803f881466ea819d870f7ed6a254/src/index.js
+
+export const babelPluginInstrument = (
+  api,
+  {
+    rootDirectoryUrl,
+    useInlineSourceMaps = false,
+    coverageConfig = { "./**/*": true },
+  },
+) => {
+  const { programVisitor } = requireFromJsenv("istanbul-lib-instrument")
+
+  const { types } = api
+
+  const associations = URL_META.resolveAssociations(
+    { cover: coverageConfig },
+    rootDirectoryUrl,
+  )
+  const shouldInstrument = (url) => {
+    return URL_META.applyAssociations({ url, associations }).cover
+  }
+
+  return {
+    name: "transform-instrument",
+    visitor: {
+      Program: {
+        enter(path) {
+          const { file } = this
+          const { opts } = file
+          if (!opts.sourceFileName) {
+            console.warn(
+              `cannot instrument file when "sourceFileName" option is not set`,
+            )
+            return
+          }
+          const fileUrl = fileSystemPathToUrl(opts.sourceFileName)
+          if (!shouldInstrument(fileUrl)) {
+            return
+          }
+
+          this.__dv__ = null
+
+          let inputSourceMap
+
+          if (useInlineSourceMaps) {
+            // https://github.com/istanbuljs/babel-plugin-istanbul/commit/a9e15643d249a2985e4387e4308022053b2cd0ad#diff-1fdf421c05c1140f6d71444ea2b27638R65
+            inputSourceMap =
+              opts.inputSourceMap || file.inputMap
+                ? file.inputMap.sourcemap
+                : null
+          } else {
+            inputSourceMap = opts.inputSourceMap
+          }
+
+          this.__dv__ = programVisitor(
+            types,
+            opts.filenameRelative || opts.filename,
+            {
+              coverageVariable: "__coverage__",
+              inputSourceMap,
+            },
+          )
+          this.__dv__.enter(path)
+        },
+
+        exit(path) {
+          if (!this.__dv__) {
+            return
+          }
+          const object = this.__dv__.exit(path)
+          // object got two properties: fileCoverage and sourceMappingURL
+          this.file.metadata.coverage = object.fileCoverage
+        },
+      },
+    },
+  }
+}

package/src/test/coverage/coverage_reporter_html_directory.js

@@ -0,0 +1,36 @@
+import { readFileSync } from "node:fs"
+import { resolveUrl, urlToFileSystemPath } from "@jsenv/urls"
+
+import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
+import { istanbulCoverageMapFromCoverage } from "./istanbul_coverage_map_from_coverage.js"
+
+export const generateCoverageHtmlDirectory = async (
+  coverage,
+  {
+    rootDirectoryUrl,
+    coverageHtmlDirectoryRelativeUrl,
+    coverageSkipEmpty,
+    coverageSkipFull,
+  },
+) => {
+  const libReport = requireFromJsenv("istanbul-lib-report")
+  const reports = requireFromJsenv("istanbul-reports")
+
+  const context = libReport.createContext({
+    dir: urlToFileSystemPath(rootDirectoryUrl),
+    coverageMap: istanbulCoverageMapFromCoverage(coverage),
+    sourceFinder: (path) => {
+      return readFileSync(
+        urlToFileSystemPath(resolveUrl(path, rootDirectoryUrl)),
+        "utf8",
+      )
+    },
+  })
+
+  const report = reports.create("html", {
+    skipEmpty: coverageSkipEmpty,
+    skipFull: coverageSkipFull,
+    subdir: coverageHtmlDirectoryRelativeUrl,
+  })
+  report.execute(context)
+}

package/src/test/coverage/coverage_reporter_json_file.js

@@ -0,0 +1,22 @@
+import { writeFile } from "@jsenv/filesystem"
+import { urlToFileSystemPath } from "@jsenv/urls"
+import { byteAsFileSize } from "@jsenv/log"
+
+export const generateCoverageJsonFile = async ({
+  coverage,
+  coverageJsonFileUrl,
+  coverageJsonFileLog,
+  logger,
+}) => {
+  const coverageAsText = JSON.stringify(coverage, null, "  ")
+
+  if (coverageJsonFileLog) {
+    logger.info(
+      `-> ${urlToFileSystemPath(coverageJsonFileUrl)} (${byteAsFileSize(
+        Buffer.byteLength(coverageAsText),
+      )})`,
+    )
+  }
+
+  await writeFile(coverageJsonFileUrl, coverageAsText)
+}

package/src/test/coverage/coverage_reporter_text_log.js

@@ -0,0 +1,19 @@
+import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
+import { istanbulCoverageMapFromCoverage } from "./istanbul_coverage_map_from_coverage.js"
+
+export const generateCoverageTextLog = (
+  coverage,
+  { coverageSkipEmpty, coverageSkipFull },
+) => {
+  const libReport = requireFromJsenv("istanbul-lib-report")
+  const reports = requireFromJsenv("istanbul-reports")
+
+  const context = libReport.createContext({
+    coverageMap: istanbulCoverageMapFromCoverage(coverage),
+  })
+  const report = reports.create("text", {
+    skipEmpty: coverageSkipEmpty,
+    skipFull: coverageSkipFull,
+  })
+  report.execute(context)
+}

package/src/test/coverage/empty_coverage_factory.js

@@ -0,0 +1,52 @@
+import { readFile } from "@jsenv/filesystem"
+import { resolveUrl } from "@jsenv/urls"
+import { Abort } from "@jsenv/abort"
+import { applyBabelPlugins } from "@jsenv/ast"
+
+import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
+import { babelPluginInstrument } from "./babel_plugin_instrument.js"
+
+export const relativeUrlToEmptyCoverage = async (
+  relativeUrl,
+  { signal, rootDirectoryUrl },
+) => {
+  const operation = Abort.startOperation()
+  operation.addAbortSignal(signal)
+
+  try {
+    const fileUrl = resolveUrl(relativeUrl, rootDirectoryUrl)
+    const content = await readFile(fileUrl, { as: "string" })
+
+    operation.throwIfAborted()
+    const { metadata } = await applyBabelPlugins({
+      babelPlugins: [[babelPluginInstrument, { rootDirectoryUrl }]],
+      urlInfo: {
+        originalUrl: fileUrl,
+        content,
+      },
+    })
+    const { coverage } = metadata
+    if (!coverage) {
+      throw new Error(`missing coverage for file`)
+    }
+    // https://github.com/gotwarlost/istanbul/blob/bc84c315271a5dd4d39bcefc5925cfb61a3d174a/lib/command/common/run-with-cover.js#L229
+    Object.keys(coverage.s).forEach(function (key) {
+      coverage.s[key] = 0
+    })
+    return coverage
+  } catch (e) {
+    if (e && e.code === "PARSE_ERROR") {
+      // return an empty coverage for that file when
+      // it contains a syntax error
+      return createEmptyCoverage(relativeUrl)
+    }
+    throw e
+  } finally {
+    await operation.end()
+  }
+}
+
+const createEmptyCoverage = (relativeUrl) => {
+  const { createFileCoverage } = requireFromJsenv("istanbul-lib-coverage")
+  return createFileCoverage(relativeUrl).toJSON()
+}

package/src/test/coverage/file_by_file_coverage.js

@@ -0,0 +1,25 @@
+import {
+  urlToRelativeUrl,
+  fileSystemPathToUrl,
+  isFileSystemPath,
+} from "@jsenv/urls"
+
+export const normalizeFileByFileCoveragePaths = (
+  fileByFileCoverage,
+  rootDirectoryUrl,
+) => {
+  const fileByFileNormalized = {}
+  Object.keys(fileByFileCoverage).forEach((key) => {
+    const fileCoverage = fileByFileCoverage[key]
+    const { path } = fileCoverage
+    const url = isFileSystemPath(path)
+      ? fileSystemPathToUrl(path)
+      : new URL(path, rootDirectoryUrl).href
+    const relativeUrl = urlToRelativeUrl(url, rootDirectoryUrl)
+    fileByFileNormalized[`./${relativeUrl}`] = {
+      ...fileCoverage,
+      path: `./${relativeUrl}`,
+    }
+  })
+  return fileByFileNormalized
+}

package/src/test/coverage/istanbul_coverage_composition.js

@@ -0,0 +1,28 @@
+import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
+
+export const composeTwoFileByFileIstanbulCoverages = (
+  firstFileByFileIstanbulCoverage,
+  secondFileByFileIstanbulCoverage,
+) => {
+  const fileByFileIstanbulCoverage = {}
+  Object.keys(firstFileByFileIstanbulCoverage).forEach((key) => {
+    fileByFileIstanbulCoverage[key] = firstFileByFileIstanbulCoverage[key]
+  })
+  Object.keys(secondFileByFileIstanbulCoverage).forEach((key) => {
+    const firstCoverage = firstFileByFileIstanbulCoverage[key]
+    const secondCoverage = secondFileByFileIstanbulCoverage[key]
+    fileByFileIstanbulCoverage[key] = firstCoverage
+      ? merge(firstCoverage, secondCoverage)
+      : secondCoverage
+  })
+
+  return fileByFileIstanbulCoverage
+}
+
+const merge = (firstIstanbulCoverage, secondIstanbulCoverage) => {
+  const { createFileCoverage } = requireFromJsenv("istanbul-lib-coverage")
+  const istanbulFileCoverageObject = createFileCoverage(firstIstanbulCoverage)
+  istanbulFileCoverageObject.merge(secondIstanbulCoverage)
+  const istanbulCoverage = istanbulFileCoverageObject.toJSON()
+  return istanbulCoverage
+}

package/src/test/coverage/istanbul_coverage_map_from_coverage.js

@@ -0,0 +1,16 @@
+import { requireFromJsenv } from "@jsenv/core/src/require_from_jsenv.js"
+
+export const istanbulCoverageMapFromCoverage = (coverage) => {
+  const { createCoverageMap } = requireFromJsenv("istanbul-lib-coverage")
+
+  const coverageAdjusted = {}
+  Object.keys(coverage).forEach((key) => {
+    coverageAdjusted[key.slice(2)] = {
+      ...coverage[key],
+      path: key.slice(2),
+    }
+  })
+
+  const coverageMap = createCoverageMap(coverageAdjusted)
+  return coverageMap
+}

package/src/test/coverage/list_files_not_covered.js

@@ -0,0 +1,15 @@
+import { collectFiles } from "@jsenv/filesystem"
+
+export const listRelativeFileUrlToCover = async ({
+  signal,
+  rootDirectoryUrl,
+  coverageConfig,
+}) => {
+  const matchingFileResultArray = await collectFiles({
+    signal,
+    directoryUrl: rootDirectoryUrl,
+    associations: { cover: coverageConfig },
+    predicate: ({ cover }) => cover,
+  })
+  return matchingFileResultArray.map(({ relativeUrl }) => relativeUrl)
+}

package/src/test/coverage/missing_coverage.js

@@ -0,0 +1,41 @@
+import { Abort } from "@jsenv/abort"
+
+import { listRelativeFileUrlToCover } from "./list_files_not_covered.js"
+import { relativeUrlToEmptyCoverage } from "./empty_coverage_factory.js"
+
+export const getMissingFileByFileCoverage = async ({
+  signal,
+  rootDirectoryUrl,
+  coverageConfig,
+  fileByFileCoverage,
+}) => {
+  const relativeUrlsToCover = await listRelativeFileUrlToCover({
+    signal,
+    rootDirectoryUrl,
+    coverageConfig,
+  })
+  const relativeUrlsMissing = relativeUrlsToCover.filter((relativeUrlToCover) =>
+    Object.keys(fileByFileCoverage).every((key) => {
+      return key !== `./${relativeUrlToCover}`
+    }),
+  )
+
+  const operation = Abort.startOperation()
+  operation.addAbortSignal(signal)
+  const missingFileByFileCoverage = {}
+  await relativeUrlsMissing.reduce(async (previous, relativeUrlMissing) => {
+    operation.throwIfAborted()
+    await previous
+    await operation.withSignal(async (signal) => {
+      const emptyCoverage = await relativeUrlToEmptyCoverage(
+        relativeUrlMissing,
+        {
+          signal,
+          rootDirectoryUrl,
+        },
+      )
+      missingFileByFileCoverage[`./${relativeUrlMissing}`] = emptyCoverage
+    })
+  }, Promise.resolve())
+  return missingFileByFileCoverage
+}