software/theia: Refactor and fix keytar rpath

See merge request nexedi/slapos!1103

component/theia/buildout.cfg

+[buildout]
+extends =
+  ../java-jdk/buildout.cfg
+  ../libsecret/buildout.cfg
+  ../pkgconfig/buildout.cfg
+  ../patchelf/buildout.cfg
+  ../yarn/buildout.cfg
+  download-plugins.cfg
+  buildout.hash.cfg
+
+
+[preloadTemplate.html]
+recipe = slapos.recipe.build:download
+shared = true
+url = ${:_profile_base_location_}/${:_buildout_section_name_}
+
+[yarn.lock]
+recipe = slapos.recipe.build:download
+shared = true
+url = ${:_profile_base_location_}/${:_buildout_section_name_}
+
+[theia]
+recipe = slapos.recipe.cmmi
+shared = true
+path = ${yarn.lock:location}
+# To regenerate yarn.lock, use package.json instead
+# path = ${package.json:location}
+environment =
+  TMPDIR=@@LOCATION@@/tmp
+  PATH=${nodejs:location}/bin:${pkgconfig:location}/bin:%(PATH)s
+  PKG_CONFIG_PATH=${libsecret:pkg-config-path}
+  LDFLAGS=-Wl,-rpath=${libsecret:location}/lib -L${gettext:location}/lib -Wl,-rpath=${gettext:location}/lib -Wl,-rpath=${glib:location}/lib
+pre-configure =
+  mkdir -p $TMPDIR
+  echo '${package.json:content}' > %(location)s/package.json
+  # To regenerate yarn.lock, comment the line below
+  cp yarn.lock %(location)s
+configure-command = true
+make-binary = cd %(location)s && ${yarn:location}/bin/yarn
+make-targets = theia build
+post-install =
+  # On Debian 9 the -rpath are not taken into account by yarn build for unknown reasons
+  cd %(location)s/node_modules/keytar/build/Release
+  ${patchelf:location}/bin/patchelf --set-rpath \
+    ${libsecret:location}/lib:${gettext:location}/lib:${glib:location}/lib \
+    keytar.node obj.target/keytar.node
+
+[theia-wrapper]
+recipe = slapos.recipe.template:jinja2
+rendered = ${buildout:bin-directory}/${:_buildout_section_name_}
+template =
+  inline:
+  #!/bin/sh
+  cd ${theia:location}
+  exec ${yarn:location}/bin/yarn theia start "$@"
+
+[theia-open]
+recipe = slapos.recipe.template:jinja2
+rendered = ${buildout:bin-directory}/${:_buildout_section_name_}
+template =
+  inline:
+  #!/bin/sh
+  exec ${nodejs:location}/bin/node ${theia:location}/node_modules/.bin/theia-open "$@"
+
+[theia-plugins]
+recipe = slapos.recipe.build
+urls = ${theia-download-plugins:urls}
+install =
+  import os
+  for line in options['urls'].splitlines():
+    extension_name, url, md5sum = line.split()
+    extract_dir = self.extract(self.download(url, md5sum))
+    destination_dir = os.path.join(options['location'], extension_name)
+    self.copyTree(guessworkdir(extract_dir), destination_dir)
+    os.chmod(destination_dir, 0o750)
+
+[package.json]
+content =
+  {
+      "private": true,
+      "theia": {
+          "backend": {
+              "config": {
+                  "warnOnPotentiallyInsecureHostPattern": false
+              }
+          },
+          "frontend": {
+              "config": {
+                  "applicationName": "Theia SlapOS",
+                  "preferences": {
+                      "application.confirmExit": "always",
+                      "files.associations": {
+                          "*.cfg": "zc-buildout"
+                      },
+                      "files.enableTrash": false,
+                      "files.exclude": {
+                          "**.pyc": true,
+                          "**.egg-info": true,
+                          "__pycache__": true,
+                          ".git": true,
+                          ".env": true,
+                          "**/node_modules/**": true
+                      },
+                      "files.watcherExclude": {
+                          "**/.eggs/**": true,
+                          "**/.env/**": true,
+                          "**/.git/**": true,
+                          "**/node_modules/**": true
+                      },
+                      "editor.multiCursorModifier": "ctrlCmd",
+                      "editor.tabSize": 2,
+                      "plantuml.server": "https://plantuml.host.vifib.net/svg/",
+                      "plantuml.render": "PlantUMLServer",
+                      "gitlens.remotes": [{ "domain": "lab.nexedi.com", "type": "GitLab" }],
+                      "java.home": "${java-jdk:location}"
+                  },
+                  "warnOnPotentiallyInsecureHostPattern": false
+              }
+          },
+          "generator": {
+              "config": {
+                  "preloadTemplate": "${preloadTemplate.html:target}"
+              }
+          }
+      },
+      "dependencies": {
+          "@theia/bulk-edit": "latest",
+          "@theia/callhierarchy": "latest",
+          "@theia/console": "latest",
+          "@theia/core": "latest",
+          "@theia/debug": "latest",
+          "@theia/editor": "latest",
+          "@theia/editor-preview": "latest",
+          "@theia/file-search": "latest",
+          "@theia/filesystem": "latest",
+          "@theia/getting-started": "latest",
+          "@theia/keymaps": "latest",
+          "@theia/markers": "latest",
+          "@theia/messages": "latest",
+          "@theia/metrics": "latest",
+          "@theia/mini-browser": "latest",
+          "@theia/monaco": "latest",
+          "@theia/navigator": "latest",
+          "@theia/outline-view": "latest",
+          "@theia/output": "latest",
+          "@theia/plugin-dev": "latest",
+          "@theia/plugin-ext": "latest",
+          "@theia/plugin-ext-vscode": "latest",
+          "@theia/preferences": "latest",
+          "@theia/preview": "latest",
+          "@theia/process": "latest",
+          "@theia/property-view": "latest",
+          "@theia/scm": "latest",
+          "@theia/scm-extra": "latest",
+          "@theia/search-in-workspace": "latest",
+          "@theia/task": "latest",
+          "@theia/terminal": "latest",
+          "@theia/timeline": "latest",
+          "@theia/typehierarchy": "latest",
+          "@theia/userstorage": "latest",
+          "@theia/variable-resolver": "latest",
+          "@theia/vsx-registry": "latest",
+          "@theia/workspace": "latest",
+          "@perrinjerome/theia-open": "latest",
+          "@perrinjerome/theia-open-cli": "latest"
+      },
+      "devDependencies": {
+          "@theia/cli": "latest"
+      }
+  }

component/theia/buildout.hash.cfg

+# THIS IS NOT A BUILDOUT FILE, despite purposedly using a compatible syntax.
+# The only allowed lines here are (regexes):
+# - "^#" comments, copied verbatim
+# - "^[" section beginings, copied verbatim
+# - lines containing an "=" sign which must fit in the following categorie.
+#   - "^\s*filename\s*=\s*path\s*$" where "path" is relative to this file
+#     Copied verbatim.
+#   - "^\s*hashtype\s*=.*" where "hashtype" is one of the values supported
+#     by the re-generation script.
+#     Re-generated.
+# - other lines are copied verbatim
+# Substitution (${...:...}), extension ([buildout] extends = ...) and
+# section inheritance (< = ...) are NOT supported (but you should really
+# not need these here).
+
+[preloadTemplate.html]
+_update_hash_filename_ = preloadTemplate.html
+md5sum = 8157c22134200bd862a07c6521ebf799
+
+[yarn.lock]
+_update_hash_filename_ = yarn.lock
+md5sum = 067d2db611b21f77885f3adfd7f81453

component/yarn/buildout.cfg

@@ -24,14 +24,19 @@ yarn-download = ${yarn-download-1.16.0:location}
 yarn-download = ${yarn-download-1.3.2:location}
 
 [yarn-wrapper]
-recipe = slapos.recipe.template:jinja2
-rendered = ${:location}/bin/yarn
-template = inline:
+recipe = slapos.recipe.build
+shared = true
+content =
   #!/bin/sh
   PATH=${nodejs:location}/bin/:$PATH
   exec ${:yarn-download}/bin/yarn $@
-location = ${buildout:parts-directory}/${:_buildout_section_name_}
-bin-yarn = ${:rendered}
+install =
+  import os
+  bin = os.path.join(options['location'], 'bin')
+  os.makedirs(bin)
+  with open(os.path.join(bin, 'yarn'), 'w') as f:
+    os.fchmod(f.fileno(), 0o755)
+    f.write(options['content'])
 
 [yarn-download]
 recipe = slapos.recipe.build:download-unpacked

software/theia/buildout.hash.cfg

@@ -15,7 +15,7 @@
 
 [instance-theia]
 _update_hash_filename_ = instance-theia.cfg.jinja.in
-md5sum = 9367b495fd2a143da3c31d750abfa519
+md5sum = 776d9275483b7378d13c5cf43a0ad886
 
 [instance]
 _update_hash_filename_ = instance.cfg.in
@@ -45,18 +45,10 @@ md5sum = e2f6c483cce09f87ab1e63ae8be0daf4
 _update_hash_filename_ = theia_import.py
 md5sum = 1a668d6203d42b4d46d56e24c7606cb2
 
-[yarn.lock]
-_update_hash_filename_ = yarn.lock
-md5sum = 067d2db611b21f77885f3adfd7f81453
-
 [python-language-server-requirements.txt]
 _update_hash_filename_ = python-language-server-requirements.txt
 md5sum = 9f478fd1b03b7738f3de549cb899bf54
 
-[preloadTemplate.html]
-_update_hash_filename_ = preloadTemplate.html
-md5sum = 8157c22134200bd862a07c6521ebf799
-
 [slapos.css.in]
 _update_hash_filename_ = slapos.css.in
 md5sum = d2930ec3ef973b7908f0fa896033fd64

software/theia/instance-theia.cfg.jinja.in

@@ -396,7 +396,7 @@ recipe = slapos.cookbook:wrapper
 wrapper-path = $${directory:services}/$${:_buildout_section_name_}
 command-line = $${theia-service:rendered}  --hostname=$${:hostname} --port=$${:port} $${directory:project}
 hash-existing-files =
-  ${yarn.lock:output}
+  ${yarn.lock:target}
   ${theia-wrapper:rendered}
 ip =  {{ ipv4_random }}
 hostname = $${:ip}

software/theia/software.cfg

 [buildout]
 extends =
-   ../../component/caddy/buildout.cfg
-   ../../component/git/buildout.cfg
-   ../../component/bash/buildout.cfg
-   ../../component/bash-completion/buildout.cfg
-   ../../component/fish-shell/buildout.cfg
-   ../../component/tmux/buildout.cfg
-   ../../component/tig/buildout.cfg
-   ../../component/vim/buildout.cfg
-   ../../component/curl/buildout.cfg
-   ../../component/coreutils/buildout.cfg
-   ../../component/java-jdk/buildout.cfg
-   ../../component/fonts/buildout.cfg
-   ../../component/libsecret/buildout.cfg
-   ../../component/pkgconfig/buildout.cfg
-   ../../stack/nodejs.cfg
-   ../../stack/slapos.cfg
-   ../../stack/monitor/buildout.cfg
-   ../../stack/resilient/buildout.cfg
-   ../../component/defaults.cfg
-   ./download-plugins.cfg
-   ./buildout.hash.cfg
+  ../../component/caddy/buildout.cfg
+  ../../component/git/buildout.cfg
+  ../../component/bash/buildout.cfg
+  ../../component/bash-completion/buildout.cfg
+  ../../component/fish-shell/buildout.cfg
+  ../../component/tmux/buildout.cfg
+  ../../component/tig/buildout.cfg
+  ../../component/vim/buildout.cfg
+  ../../component/curl/buildout.cfg
+  ../../component/coreutils/buildout.cfg
+  ../../component/fonts/buildout.cfg
+  ../../component/theia/buildout.cfg
+  ../../stack/slapos.cfg
+  ../../stack/monitor/buildout.cfg
+  ../../stack/resilient/buildout.cfg
+  ../../component/defaults.cfg
+  ./buildout.hash.cfg
 
 parts =
   theia-wrapper
@@ -201,147 +197,12 @@ stop-on-error = true
 [python-language-server-requirements.txt]
 <= download-base
 
-[theia]
-recipe = plone.recipe.command
-command = ${bash:location}/bin/bash -c "
-  export \
-    TMPDIR=${:location}/tmp \
-    PATH=${nodejs:location}/bin:${pkgconfig:location}/bin:$PATH \
-    PKG_CONFIG_PATH=${libsecret:pkg-config-path} \
-    LDFLAGS='-Wl,-rpath=${libsecret:location}/lib -L${gettext:location}/lib -Wl,-rpath=${gettext:location}/lib -Wl,-rpath=${glib:location}/lib' && \
-  mkdir -p ${:location} && \
-  mkdir -p \$TMPDIR && \
-  cd ${:location} && \
-  cp ${package.json:rendered} . &&
-  cp ${yarn.lock:output} . &&
-  ${yarn:location}/bin/yarn && \
-  ${yarn:location}/bin/yarn theia build"
-location = ${buildout:parts-directory}/${:_buildout_section_name_}
-stop-on-error = true
-uses = ${yarn.lock:recipe}
-
-[theia-plugins]
-recipe = slapos.recipe.build
-urls = ${theia-download-plugins:urls}
-install =
-  import os
-  for line in options['urls'].splitlines():
-    extension_name, url, md5sum = line.split()
-    extract_dir = self.extract(self.download(url, md5sum))
-    destination_dir = os.path.join(options['location'], extension_name)
-    self.copyTree(guessworkdir(extract_dir), destination_dir)
-    os.chmod(destination_dir, 0o750)
-
-[yarn.lock]
-<= download-base
-
-[preloadTemplate.html]
-<= download-base
-
 [slapos.css.in]
 <= download-base
 
 [logo.png]
 <= download-base
 
-[package.json]
-recipe = slapos.recipe.template:jinja2
-template =
-  inline:{
-      "private": true,
-      "theia": {
-          "backend": {
-              "config": {
-                  "warnOnPotentiallyInsecureHostPattern": false
-              }
-          },
-          "frontend": {
-              "config": {
-                  "applicationName": "Theia SlapOS",
-                  "preferences": {
-                      "application.confirmExit": "always",
-                      "files.associations": {
-                          "*.cfg": "zc-buildout"
-                      },
-                      "files.enableTrash": false,
-                      "files.exclude": {
-                          "**.pyc": true,
-                          "**.egg-info": true,
-                          "__pycache__": true,
-                          ".git": true,
-                          ".env": true,
-                          "**/node_modules/**": true
-                      },
-                      "files.watcherExclude": {
-                          "**/.eggs/**": true,
-                          "**/.env/**": true,
-                          "**/.git/**": true,
-                          "**/node_modules/**": true
-                      },
-                      "editor.multiCursorModifier": "ctrlCmd",
-                      "editor.tabSize": 2,
-                      "plantuml.server": "https://plantuml.host.vifib.net/svg/",
-                      "plantuml.render": "PlantUMLServer",
-                      "gitlens.remotes": [{ "domain": "lab.nexedi.com", "type": "GitLab" }],
-                      "java.home": "${java-jdk:location}"
-                  },
-                  "warnOnPotentiallyInsecureHostPattern": false
-              }
-          },
-          "generator": {
-              "config": {
-                  "preloadTemplate": "${preloadTemplate.html:output}"
-              }
-          }
-      },
-      "dependencies": {
-          "@theia/bulk-edit": "latest",
-          "@theia/callhierarchy": "latest",
-          "@theia/console": "latest",
-          "@theia/core": "latest",
-          "@theia/debug": "latest",
-          "@theia/editor": "latest",
-          "@theia/editor-preview": "latest",
-          "@theia/file-search": "latest",
-          "@theia/filesystem": "latest",
-          "@theia/getting-started": "latest",
-          "@theia/keymaps": "latest",
-          "@theia/markers": "latest",
-          "@theia/messages": "latest",
-          "@theia/metrics": "latest",
-          "@theia/mini-browser": "latest",
-          "@theia/monaco": "latest",
-          "@theia/navigator": "latest",
-          "@theia/outline-view": "latest",
-          "@theia/output": "latest",
-          "@theia/plugin-dev": "latest",
-          "@theia/plugin-ext": "latest",
-          "@theia/plugin-ext-vscode": "latest",
-          "@theia/preferences": "latest",
-          "@theia/preview": "latest",
-          "@theia/process": "latest",
-          "@theia/property-view": "latest",
-          "@theia/scm": "latest",
-          "@theia/scm-extra": "latest",
-          "@theia/search-in-workspace": "latest",
-          "@theia/task": "latest",
-          "@theia/terminal": "latest",
-          "@theia/timeline": "latest",
-          "@theia/typehierarchy": "latest",
-          "@theia/userstorage": "latest",
-          "@theia/variable-resolver": "latest",
-          "@theia/vsx-registry": "latest",
-          "@theia/workspace": "latest",
-          "@perrinjerome/theia-open": "latest",
-          "@perrinjerome/theia-open-cli": "latest"
-      },
-      "devDependencies": {
-          "@theia/cli": "latest"
-      }
-    }
-rendered = ${buildout:directory}/${:_buildout_section_name_}
-
-
 [gowork]
 install +=
    golang.org/x/tools/gopls@v0.6.6
@@ -351,23 +212,6 @@ install +=
 PATH = ${nodejs:location}/bin:${bash:location}/bin:${fish-shell:location}/bin:${tig:location}/bin:${vim:location}/bin:${tmux:location}/bin:${git:location}/bin:${curl:location}/bin:${python:location}/bin:${buildout:bin-directory}
 
 
-[theia-wrapper]
-recipe = slapos.recipe.template:jinja2
-rendered = ${buildout:bin-directory}/${:_buildout_section_name_}
-template =
-  inline:
-  #!/bin/sh
-  cd ${theia:location}
-  exec ${yarn:location}/bin/yarn theia start "$@"
-
-[theia-open]
-recipe = slapos.recipe.template:jinja2
-rendered = ${buildout:bin-directory}/${:_buildout_section_name_}
-template =
-  inline:
-  #!/bin/sh
-  exec ${nodejs:location}/bin/node ${theia:location}/node_modules/.bin/theia-open "$@"
-
 [python-with-eggs]
 recipe = zc.recipe.egg
 interpreter = ${:_buildout_section_name_}