rstudio: build as electron app, add darwin support (#362637)

Author: jbedo

pkgs/applications/editors/rstudio/default.nix

@@ -1,6 +1,7 @@
 {
   lib,
   stdenv,
+  runCommand,
   fetchzip,
   fetchFromGitHub,
   replaceVars,
@@ -9,7 +10,7 @@
   zlib,
   openssl,
   R,
-  libsForQt5,
+  fontconfig,
   quarto,
   libuuid,
   hunspellDicts,
@@ -21,16 +22,34 @@
   yaml-cpp,
   soci,
   sqlite,
+  apple-sdk_11,
+  xcbuild,
   nodejs,
+  npmHooks,
+  fetchNpmDeps,
   yarn,
   yarnConfigHook,
   fetchYarnDeps,
+  zip,
+  git,
+  makeWrapper,
+  electron_33,
   server ? false, # build server version
   pam,
   nixosTests,
 }:
 
 let
+  # Note: we shouldn't use the latest electron here, since the node-abi dependency might
+  # need to be updated every time the latest electron gets a new abi version number
+  electron = electron_33;
+
+  # unpack tarball containing electron's headers
+  electron-headers = runCommand "electron-headers" { } ''
+    mkdir -p $out
+    tar -C $out --strip-components=1 -xvf ${electron.headers}
+  '';
+
   mathJaxSrc = fetchzip {
     url = "https://s3.amazonaws.com/rstudio-buildtools/mathjax-27.zip";
     hash = "sha256-J7SZK/9q3HcXTD7WFHxvh++ttuCd89Vc4SEBrUEU0AI=";
@@ -53,6 +72,14 @@ let
     d: !(lib.hasAttr "dictFileName" d && lib.elem d.dictFileName (map (d: d.dictFileName) largeDicts))
   ) hunspellDictionaries;
   dictionaries = largeDicts ++ otherDicts;
+
+  # rstudio assumes quarto bundles pandoc into bin/tools/
+  quartoWrapper = runCommand "quarto-wrapper" { } ''
+    mkdir -p $out/bin/tools
+    ln -s ${lib.getExe pandoc} $out/bin/tools/pandoc
+    ln -s ${lib.getExe quarto} $out/bin/quarto
+    ln -s ${quarto}/share $out/share
+  '';
 in
 stdenv.mkDerivation rec {
   pname = "RStudio";
@@ -66,7 +93,7 @@ stdenv.mkDerivation rec {
   src = fetchFromGitHub {
     owner = "rstudio";
     repo = "rstudio";
-    rev = "refs/tags/v${version}";
+    tag = "v${version}";
     hash = "sha256-j258eW1MYQrB6kkpjyolXdNuwQ3zSWv9so4q0QLsZuw=";
   };
 
@@ -78,9 +105,14 @@ stdenv.mkDerivation rec {
       nodejs
       yarn
       yarnConfigHook
+      zip
+      git
     ]
+    ++ lib.optionals stdenv.hostPlatform.isDarwin [ xcbuild ]
     ++ lib.optionals (!server) [
-      libsForQt5.wrapQtAppsHook
+      (nodejs.python.withPackages (ps: [ ps.setuptools ]))
+      npmHooks.npmConfigHook
+      makeWrapper
     ];
 
   buildInputs =
@@ -94,30 +126,30 @@ stdenv.mkDerivation rec {
       soci
       sqlite.dev
     ]
+    ++ lib.optionals stdenv.hostPlatform.isDarwin [ apple-sdk_11 ]
     ++ lib.optionals server [ pam ]
-    ++ lib.optionals (!server) [
-      libsForQt5.qtbase
-      libsForQt5.qtxmlpatterns
-      libsForQt5.qtsensors
-      libsForQt5.qtwebengine
-      libsForQt5.qtwebchannel
-    ];
+    ++ lib.optionals (!server) [ fontconfig ];
 
   cmakeFlags =
     [
-      (lib.cmakeFeature "RSTUDIO_TARGET" (if server then "Server" else "Desktop"))
+      (lib.cmakeFeature "RSTUDIO_TARGET" (if server then "Server" else "Electron"))
       (lib.cmakeBool "RSTUDIO_USE_SYSTEM_SOCI" true)
       (lib.cmakeBool "RSTUDIO_USE_SYSTEM_BOOST" true)
       (lib.cmakeBool "RSTUDIO_USE_SYSTEM_YAML_CPP" true)
       (lib.cmakeBool "RSTUDIO_DISABLE_CHECK_FOR_UPDATES" true)
       (lib.cmakeBool "QUARTO_ENABLED" true)
-      (lib.cmakeFeature "CMAKE_INSTALL_PREFIX" "${placeholder "out"}/lib/rstudio")
+      (lib.cmakeBool "RSTUDIO_CRASHPAD_ENABLED" false) # This is a NOOP except on x86_64-darwin
+      (lib.cmakeFeature "CMAKE_INSTALL_PREFIX" (
+        (placeholder "out") + (if stdenv.isDarwin then "/Applications" else "/lib/rstudio")
+      ))
     ]
     ++ lib.optionals (!server) [
-      (lib.cmakeFeature "QT_QMAKE_EXECUTABLE" "${libsForQt5.qmake}/bin/qmake")
-      (lib.cmakeBool "RSTUDIO_INSTALL_FREEDESKTOP" true)
+      (lib.cmakeBool "RSTUDIO_INSTALL_FREEDESKTOP" stdenv.hostPlatform.isLinux)
     ];
 
+  # on Darwin, cmake uses find_library to locate R instead of using the PATH
+  env.NIX_LDFLAGS = "-L${R}/lib/R/lib";
+
   patches = [
     # Hack RStudio to only use the input R and provided libclang.
     (replaceVars ./r-location.patch {
@@ -130,8 +162,10 @@ stdenv.mkDerivation rec {
     ./fix-resources-path.patch
     ./ignore-etc-os-release.patch
     ./dont-yarn-install.patch
-    ./dont-assume-pandoc-in-quarto.patch
     ./boost-1.86.patch
+    ./fix-darwin.patch
+    # needed for rebuilding for later electron versions
+    ./update-nan-and-node-abi.patch
   ];
 
   postPatch = ''
@@ -151,6 +185,21 @@ stdenv.mkDerivation rec {
 
   dontYarnInstallDeps = true; # will call manually in preConfigure
 
+  npmRoot = "src/node/desktop";
+
+  # don't build native modules with node headers
+  npmFlags = [ "--ignore-scripts" ];
+
+  npmDeps = fetchNpmDeps {
+    name = "rstudio-${version}-npm-deps";
+    inherit src;
+    patches = [ ./update-nan-and-node-abi.patch ];
+    postPatch = "cd ${npmRoot}";
+    hash = "sha256-CtHCN4sWeHNDd59TV/TgTC4d6h7X1Cl4E/aJkAfRk7g=";
+  };
+
+  env.ELECTRON_SKIP_BINARY_DOWNLOAD = "1";
+
   preConfigure = ''
     # set up node_modules directory inside quarto so that panmirror can be built
     mkdir src/gwt/lib/quarto
@@ -170,35 +219,89 @@ stdenv.mkDerivation rec {
       done
     done
 
-    ln -s ${quarto} dependencies/quarto
+    ln -s ${quartoWrapper} dependencies/quarto
 
     # version in dependencies/common/install-mathjax
     ln -s ${mathJaxSrc} dependencies/mathjax-27
 
-    # version in CMakeGlobals.txt (PANDOC_VERSION)
-    mkdir -p dependencies/pandoc/2.18
-    ln -s ${lib.getBin pandoc}/bin/* dependencies/pandoc/2.18
-
-    # version in CMakeGlobals.txt (RSTUDIO_INSTALLED_NODE_VERSION)
     mkdir -p dependencies/common/node
+    # node used by cmake
+    # version in CMakeGlobals.txt (RSTUDIO_NODE_VERSION)
+    ln -s ${nodejs} dependencies/common/node/18.18.2
+    # node used at runtime
+    # version in CMakeGlobals.txt (RSTUDIO_INSTALLED_NODE_VERSION)
     ln -s ${nodejs} dependencies/common/node/18.20.3
+
+    ${lib.optionalString (!server) ''
+      pushd $npmRoot
+
+      substituteInPlace package.json \
+        --replace-fail "npm ci && " ""
+
+      # use electron's headers to make node-gyp compile against the electron ABI
+      export npm_config_nodedir="${electron-headers}"
+
+      ### override the detected electron version
+      substituteInPlace node_modules/@electron-forge/core-utils/dist/electron-version.js \
+        --replace-fail "return version" "return '${electron.version}'"
+
+      ### create the electron archive to be used by electron-packager
+      cp -r ${electron.dist} electron-dist
+      chmod -R u+w electron-dist
+
+      pushd electron-dist
+      zip -0Xqr ../electron.zip .
+      popd
+
+      rm -r electron-dist
+
+      # force @electron/packager to use our electron instead of downloading it
+      substituteInPlace node_modules/@electron/packager/src/index.js \
+        --replace-fail "await this.getElectronZipPath(downloadOpts)" "'$(pwd)/electron.zip'"
+
+      # Work around known nan issue for electron_33 and above
+      # https://github.com/nodejs/nan/issues/978
+      substituteInPlace node_modules/nan/nan.h \
+          --replace-fail '#include "nan_scriptorigin.h"' ""
+
+      # now that we patched everything, we still have to run the scripts we ignored with --ignore-scripts
+      npm rebuild
+
+      popd
+    ''}
   '';
 
   postInstall = ''
     mkdir -p $out/bin
 
-    ${lib.optionalString server ''
+    ${lib.optionalString (server && stdenv.hostPlatform.isLinux) ''
       ln -s $out/lib/rstudio/bin/{crash-handler-proxy,postback,r-ldpath,rpostback,rserver,rserver-pam,rsession,rstudio-server} $out/bin
     ''}
 
-    ${lib.optionalString (!server) ''
-      ln -s $out/lib/rstudio/bin/{diagnostics,rpostback,rstudio} $out/bin
+    ${lib.optionalString (!server && stdenv.hostPlatform.isLinux) ''
+      # remove unneeded electron files, since we'll wrap the app with our own electron
+      shopt -s extglob
+      rm -r $out/lib/rstudio/!(locales|resources|resources.pak)
+
+      makeWrapper ${lib.getExe electron} "$out/bin/rstudio" \
+        --add-flags "$out/lib/rstudio/resources/app/" \
+        --set-default ELECTRON_FORCE_IS_PACKAGED 1 \
+        --suffix PATH : ${lib.makeBinPath [ gnumake ]}
+
+      ln -s $out/lib/rstudio/resources/app/bin/{diagnostics,rpostback} $out/bin
     ''}
-  '';
 
-  qtWrapperArgs = lib.optionals (!server) [
-    "--suffix PATH : ${lib.makeBinPath [ gnumake ]}"
-  ];
+    ${lib.optionalString (server && stdenv.hostPlatform.isDarwin) ''
+      ln -s $out/Applications/RStudio.app/Contents/MacOS/{crash-handler-proxy,postback,r-ldpath,rpostback,rserver,rserver-pam,rsession,rstudio-server} $out/bin
+    ''}
+
+    ${lib.optionalString (!server && stdenv.hostPlatform.isDarwin) ''
+      # electron can't find its files if we use a symlink here
+      makeWrapper $out/Applications/RStudio.app/Contents/MacOS/RStudio $out/bin/rstudio
+
+      ln -s $out/Applications/RStudio.app/Contents/Resources/app/bin/{diagnostics,rpostback} $out/bin
+    ''}
+  '';
 
   passthru = {
     inherit server;
@@ -208,15 +311,15 @@ stdenv.mkDerivation rec {
   };
 
   meta = {
-    broken = (stdenv.hostPlatform.isLinux && stdenv.hostPlatform.isAarch64);
     description = "Set of integrated tools for the R language";
     homepage = "https://www.rstudio.com/";
     license = lib.licenses.agpl3Only;
     maintainers = with lib.maintainers; [
       ciil
       cfhammill
+      tomasajt
     ];
     mainProgram = "rstudio" + lib.optionalString server "-server";
-    platforms = lib.platforms.linux;
+    platforms = lib.platforms.linux ++ lib.platforms.darwin;
   };
 }