Add support for js-sources (#8636)

* Add support for js-sources

* Add changelog

* Add comment about C-like sources

* Add tests

* Fix test

* Fix skipUnless and factorize

* Fix skipIfGhcVersion

Author: hsyl20

Cabal/src/Distribution/Simple/Build.hs

@@ -277,6 +277,7 @@ buildComponent verbosity numJobs pkg_descr lbi suffixes
                                   $ flip addExtraCmmSources extras
                                   $ flip addExtraCxxSources extras
                                   $ flip addExtraCSources   extras
+                                  $ flip addExtraJsSources  extras
                                   $ libbi
                    }
 
@@ -454,6 +455,13 @@ addExtraAsmSources :: BuildInfo -> [FilePath] -> BuildInfo
 addExtraAsmSources bi extras = bi { asmSources = new }
   where new = ordNub (extras ++ asmSources bi)
 
+-- | Add extra JS sources generated by preprocessing to build
+-- information.
+addExtraJsSources :: BuildInfo -> [FilePath] -> BuildInfo
+addExtraJsSources bi extras = bi { jsSources = new }
+  where new = ordNub (extras ++ jsSources bi)
+
+
 -- | Add extra HS modules generated by preprocessing to build
 -- information.
 addExtraOtherModules :: BuildInfo -> [ModuleName.ModuleName] -> BuildInfo

Cabal/src/Distribution/Simple/GHC.hs

@@ -567,6 +567,11 @@ buildOrReplLib mReplFlags verbosity numJobs pkg_descr lbi lib clbi = do
                       , toNubListR (cxxSources libBi)
                       , toNubListR (cmmSources libBi)
                       , toNubListR (asmSources libBi)
+                      , toNubListR (jsSources  libBi)
+                        -- JS files are C-like with GHC's JS backend: they are
+                        -- "compiled" into `.o` files (renamed with a header).
+                        -- This is a difference from GHCJS, for which we only
+                        -- pass the JS files at link time.
                       ]
       cLikeObjs   = map (`replaceExtension` objExtension) cLikeSources
       baseOpts    = componentGhcOptions verbosity lbi libBi clbi libTargetDir
@@ -724,6 +729,25 @@ buildOrReplLib mReplFlags verbosity numJobs pkg_descr lbi lib clbi = do
            unless forRepl $ whenProfLib (runGhcProgIfNeeded profCcOpts)
       | filename <- cSources libBi]
 
+  -- build any JS sources
+  unless (not has_code || null (jsSources libBi)) $ do
+    info verbosity "Building JS Sources..."
+    sequence_
+      [ do let vanillaJsOpts = Internal.componentJsGhcOptions verbosity implInfo
+                               lbi libBi clbi relLibTargetDir filename
+               profJsOpts    = vanillaJsOpts `mappend` mempty {
+                                 ghcOptProfilingMode = toFlag True,
+                                 ghcOptObjSuffix     = toFlag "p_o"
+                               }
+               odir          = fromFlag (ghcOptObjDir vanillaJsOpts)
+           createDirectoryIfMissingVerbose verbosity True odir
+           let runGhcProgIfNeeded jsOpts = do
+                 needsRecomp <- checkNeedsRecompilation filename jsOpts
+                 when needsRecomp $ runGhcProg jsOpts
+           runGhcProgIfNeeded vanillaJsOpts
+           unless forRepl $ whenProfLib (runGhcProgIfNeeded profJsOpts)
+      | filename <- jsSources libBi]
+
   -- build any ASM sources
   unless (not has_code || null (asmSources libBi)) $ do
     info verbosity "Building Assembler Sources..."
@@ -2063,6 +2087,7 @@ installLib verbosity lbi targetDir dynlibTargetDir _builtDir pkg lib clbi = do
                    && null (cxxSources (libBuildInfo lib))
                    && null (cmmSources (libBuildInfo lib))
                    && null (asmSources (libBuildInfo lib))
+                   && null (jsSources (libBuildInfo lib))
     has_code = not (componentIsIndefinite clbi)
     whenHasCode = when has_code
     whenVanilla = when (hasLib && withVanillaLib lbi)

Cabal/src/Distribution/Simple/GHC/Internal.hs

@@ -22,6 +22,7 @@ module Distribution.Simple.GHC.Internal (
         componentCmmGhcOptions,
         componentCxxGhcOptions,
         componentAsmGhcOptions,
+        componentJsGhcOptions,
         componentGhcOptions,
         mkGHCiLibName,
         mkGHCiProfLibName,
@@ -382,6 +383,32 @@ componentAsmGhcOptions verbosity _implInfo lbi bi clbi odir filename =
       ghcOptObjDir         = toFlag odir
     }
 
+componentJsGhcOptions :: Verbosity -> GhcImplInfo -> LocalBuildInfo
+                      -> BuildInfo -> ComponentLocalBuildInfo
+                      -> FilePath -> FilePath
+                      -> GhcOptions
+componentJsGhcOptions verbosity _implInfo lbi bi clbi odir filename =
+    mempty {
+      -- Respect -v0, but don't crank up verbosity on GHC if
+      -- Cabal verbosity is requested. For that, use --ghc-option=-v instead!
+      ghcOptVerbosity      = toFlag (min verbosity normal),
+      ghcOptMode           = toFlag GhcModeCompile,
+      ghcOptInputFiles     = toNubListR [filename],
+
+      ghcOptCppIncludePath = toNubListR $ [autogenComponentModulesDir lbi clbi
+                                          ,autogenPackageModulesDir lbi
+                                          ,odir]
+                                          -- includes relative to the package
+                                          ++ includeDirs bi
+                                          -- potential includes generated by `configure'
+                                          -- in the build directory
+                                          ++ [buildDir lbi </> dir | dir <- includeDirs bi],
+      ghcOptHideAllPackages= toFlag True,
+      ghcOptPackageDBs     = withPackageDB lbi,
+      ghcOptPackages       = toNubListR $ mkGhcOptPackages clbi,
+      ghcOptObjDir         = toFlag odir
+    }
+
 
 componentGhcOptions :: Verbosity -> GhcImplInfo -> LocalBuildInfo
                     -> BuildInfo -> ComponentLocalBuildInfo -> FilePath

Cabal/src/Distribution/Simple/Register.hs

@@ -466,8 +466,7 @@ generalInstalledPackageInfo adjustRelIncDirs pkg abi_hash lib lbi clbi installDi
                              || not (null (asmSources bi))
                              || not (null (cmmSources bi))
                              || not (null (cxxSources bi))
-                             || (not (null (jsSources bi)) &&
-                                compilerFlavor comp == GHCJS))
+                             || not (null (jsSources bi)))
                && not (componentIsIndefinite clbi)
     libdirsStatic
       | hasLibrary = libdir installDirs : extraLibDirsStaticOrFallback

cabal-testsuite/PackageTests/JS/JsSources/cabal.project

@@ -0,0 +1 @@
+packages: .

cabal-testsuite/PackageTests/JS/JsSources/cabal.test.hs

@@ -0,0 +1,8 @@
+import Test.Cabal.Prelude
+
+main = setupAndCabalTest $ do
+    skipUnlessGhcVersion ">= 9.6"
+    skipUnlessJavaScript
+
+    res <- cabal' "v2-run" ["demo"]
+    assertOutputContains "Hello JS!" res

cabal-testsuite/PackageTests/JS/JsSources/demo/Main.hs

@@ -0,0 +1,6 @@
+module Main where
+
+import Lib
+
+main :: IO ()
+main = foo

cabal-testsuite/PackageTests/JS/JsSources/jsbits/lib.js

@@ -0,0 +1,3 @@
+function foo() {
+  console.log("Hello JS!");
+}

cabal-testsuite/PackageTests/JS/JsSources/jssources.cabal

@@ -0,0 +1,17 @@
+cabal-version: 3.0
+name: jssources
+version: 0
+build-type: Simple
+
+library
+  default-language: Haskell2010
+  js-sources: jsbits/lib.js
+  hs-source-dirs: src
+  exposed-modules: Lib
+  build-depends: base
+
+executable demo
+  default-language: Haskell2010
+  main-is: Main.hs
+  hs-source-dirs: demo
+  build-depends: base, jssources

cabal-testsuite/PackageTests/JS/JsSources/src/Lib.hs

@@ -0,0 +1,3 @@
+module Lib where
+
+foreign import javascript foo :: IO ()

cabal-testsuite/src/Test/Cabal/Prelude.hs

@@ -28,7 +28,7 @@ import Distribution.Simple.PackageDescription (readGenericPackageDescription)
 import Distribution.Simple.Program.Types
 import Distribution.Simple.Program.Db
 import Distribution.Simple.Program
-import Distribution.System (OS(Windows,Linux,OSX), buildOS)
+import Distribution.System (OS(Windows,Linux,OSX), Arch(JavaScript), buildOS, buildArch)
 import Distribution.Simple.Utils
     ( withFileContents, withTempDirectory, tryFindPackageDesc )
 import Distribution.Simple.Configure
@@ -889,7 +889,13 @@ skipUnlessGhcVersion :: String -> TestM ()
 skipUnlessGhcVersion range = skipUnless ("needs ghc " ++ range) =<< isGhcVersion range
 
 skipIfGhcVersion :: String -> TestM ()
-skipIfGhcVersion range = skipUnless ("incompatible with ghc " ++ range) =<< isGhcVersion range
+skipIfGhcVersion range = skipIf ("incompatible with ghc " ++ range) =<< isGhcVersion range
+
+skipUnlessJavaScript :: TestM ()
+skipUnlessJavaScript = skipUnless "needs the JavaScript backend" =<< isJavaScript
+
+skipIfJavaScript :: TestM ()
+skipIfJavaScript = skipIf "incompatible with the JavaScript backend" =<< isJavaScript
 
 isWindows :: TestM Bool
 isWindows = return (buildOS == Windows)
@@ -900,6 +906,11 @@ isOSX = return (buildOS == OSX)
 isLinux :: TestM Bool
 isLinux = return (buildOS == Linux)
 
+isJavaScript :: TestM Bool
+isJavaScript = return (buildArch == JavaScript)
+  -- should probably be `hostArch` but Cabal doesn't distinguish build platform
+  -- and host platform
+
 skipIfWindows :: TestM ()
 skipIfWindows = skipIf "Windows" =<< isWindows
 

changelog.d/pr-8636

@@ -0,0 +1,8 @@
+synopsis: Support `js-sources` with GHC, not only with GHCJS
+prs: #8636
+description: {
+
+- Take into account js-sources when building library components with GHC
+- Missing support for js-sources in executable components is tracked in #8639
+
+}