Adding TypeDB #125350

haskie-lambda · 2021-06-02T09:35:18Z

Motivation for this change

provide a standard way of installing typedb akin to the installers for other systems.

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Added a release notes entry if the change is major or breaking
Fits CONTRIBUTING.md.

…reddit.com/r/NixOS/comments/no9ctl/testing_newly_added_nixpkg/

roberth

Found the cause of your SO issue and I've added some suggestions that would come up in a review.

pkgs/servers/typedb/default.nix

roberth · 2021-06-03T07:23:34Z

pkgs/servers/typedb/default.nix

+        < JAVA_BIN=java
+        ---
+        > JAVA_BIN=${openjdk}/bin/java
+        '';


Indentation is a bit odd an there's some trailing whitespace. nixpkgs-fmt can help you out.

done; did not know about nixpkgs-fmt, that helps a lot

pkgs/servers/typedb/default.nix

roberth · 2021-06-03T15:43:45Z

pkgs/servers/typedb/default.nix

+  typedb-properties-patch = ''
+    19c19
+    < server.data=server/data/
+    ---
+    > server.data=${server-data}
+    22c22
+    < server.logs=server/logs/
+    ---
+    > server.logs=${server-logs}
+    24c24
+    < server.port=1729
+    ---
+    > server.port=${server-port}


While it's already much better, this is still a bit awkward. Ideally changes in configuration would not require a rebuild.
If we're lucky, we might still be able to use an environment variable instead of hardcoding it into the store path, although that's not the default property file behavior.

Somewhat relevant discussion https://stackoverflow.com/questions/2263929/regarding-application-properties-file-and-environment-variable. If it's built on apache commons, we're lucky.

Is it possible to specify properties or property files at runtime?

according to the typedb team not;
only at startup as a cli option or in the config file;

I decided to add a wrapper script again that makes it possible to change the three configuration options via environment variables.
at least until I am able to change the implementation of the property file reader in the typedb.

I am still debugging it, but at least it builds and the tests run fine now;
there are still some issues though...

only at startup as a cli option or in the config file;

The config file is not really a config file if it's packaged immutably with the software, so cli options are probably the easiest option. Do you plan to write a NixOS service as well?

didn't think about this before;
but I could actually do that, have to read up on that though ^^

pkgs/servers/typedb/default.nix

SuperSandro2000 · 2021-07-13T22:01:33Z

pkgs/servers/typedb/tests.nix

+    rm -r server_data
+    rm -r server_log


Suggested change

rm -r server_data

rm -r server_log

rm -r server_data server_log

SuperSandro2000 · 2021-07-13T22:01:45Z

pkgs/servers/typedb/tests.nix

+    mkdir "server_data"
+    mkdir "server_log"


Suggested change

mkdir "server_data"

mkdir "server_log"

mkdir server_data server_log

SuperSandro2000 · 2021-07-13T22:02:52Z

pkgs/servers/typedb/default.nix

+    '';
+    homepage = "https://www.grakn.ai/";
+    license = licenses.gpl3Plus;
+    platforms = lib.attrNames systems;


Suggested change

platforms = lib.attrNames systems;

platforms = attrNames systems;

SuperSandro2000 · 2021-07-13T22:04:42Z

pkgs/servers/typedb/default.nix

+    #patch before install
+    echo '${javaPatch}' > typedb_java.patch
+    echo '${typedb-wrapper-patch}' > typedb_wrapper.patch
+    patch ./typedb typedb_java.patch
+
+    mkdir $out
+    cp -r ./* $out
+    mkdir $out/bin
+
+    cat ${typedbWrapper} > $out/bin/typedb
+    echo "$out/typedb \"\$@\" --data=\$TYPEDB_SERVER_DATA --logs=\$TYPEDB_SERVER_LOGS --port=\$TYPEDB_SERVER_PORT" >> $out/bin/typedb
+    patch $out/bin/typedb typedb_wrapper.patch
+
+    chmod u+x $out/bin/typedb
+    rm typedb_java.patch
+    rm typedb_wrapper.patch


Suggested change

#patch before install

echo '${javaPatch}' > typedb_java.patch

echo '${typedb-wrapper-patch}' > typedb_wrapper.patch

patch ./typedb typedb_java.patch

mkdir $out

cp -r ./* $out

mkdir $out/bin

cat ${typedbWrapper} > $out/bin/typedb

echo "$out/typedb \"\$@\" --data=\$TYPEDB_SERVER_DATA --logs=\$TYPEDB_SERVER_LOGS --port=\$TYPEDB_SERVER_PORT" >> $out/bin/typedb

patch $out/bin/typedb typedb_wrapper.patch

chmod u+x $out/bin/typedb

rm typedb_java.patch

rm typedb_wrapper.patch

#patch before install

echo '${javaPatch}' > typedb_java.patch

echo '${typedb-wrapper-patch}' > typedb_wrapper.patch

patch ./typedb typedb_java.patch

mkdir -p $out/bin

cp -r ./* $out

cat ${typedbWrapper} > $out/bin/typedb

echo "$out/typedb \"\$@\" --data=\$TYPEDB_SERVER_DATA --logs=\$TYPEDB_SERVER_LOGS --port=\$TYPEDB_SERVER_PORT" >> $out/bin/typedb

patch $out/bin/typedb typedb_wrapper.patch

chmod u+x $out/bin/typedb

rm typedb_java.patch typedb_wrapper.patch

SuperSandro2000 · 2021-07-13T22:05:34Z

pkgs/servers/typedb/default.nix

+  systems = {
+    x86_64-linux = {
+      src = fetchurl {
+        url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-linux-2.1.1.tar.gz";
+        sha256 = "00wvkiahmrys32ckp6r59bbrzfd7jzsphniyjdj4p9bh7k339gn2";
+      };
+      dir = "typedb-all-linux-${typedbVersion}";
+    };
+    x86_64-darwin = {
+      src = fetchzip {
+        url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-mac-2.1.1.zip";
+        sha256 = "1njvssv9h0m13jz0ims96nfl1fjyk7lv8jdb6apcqpbkw7ykz8h8";
+      };
+      dir = "typedb-all-mac-${typedbVersion}";
+    };
+    x86_64-windows = {
+      src = fetchzip {
+        url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-windows-2.1.1.zip";


Suggested change

systems = {

x86_64-linux = {

src = fetchurl {

url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-linux-2.1.1.tar.gz";

sha256 = "00wvkiahmrys32ckp6r59bbrzfd7jzsphniyjdj4p9bh7k339gn2";

};

dir = "typedb-all-linux-${typedbVersion}";

};

x86_64-darwin = {

src = fetchzip {

url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-mac-2.1.1.zip";

sha256 = "1njvssv9h0m13jz0ims96nfl1fjyk7lv8jdb6apcqpbkw7ykz8h8";

};

dir = "typedb-all-mac-${typedbVersion}";

};

x86_64-windows = {

src = fetchzip {

url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-windows-2.1.1.zip";

systems = rec {

x86_64-linux = {

src = fetchurl {

url = "https://github.com/vaticle/typedb/releases/download/${version}/typedb-all-linux-${version}.tar.gz";

sha256 = "00wvkiahmrys32ckp6r59bbrzfd7jzsphniyjdj4p9bh7k339gn2";

};

dir = "typedb-all-linux-${typedbVersion}";

};

x86_64-darwin = {

src = fetchzip {

url = "https://github.com/vaticle/typedb/releases/download/${version}/typedb-all-mac-${version}.zip";

sha256 = "1njvssv9h0m13jz0ims96nfl1fjyk7lv8jdb6apcqpbkw7ykz8h8";

};

dir = "typedb-all-mac-${typedbVersion}";

};

x86_64-windows = {

src = fetchzip {

url = "https://github.com/vaticle/typedb/releases/download/${version}/typedb-all-windows-${version}.zip";

@SuperSandro2000 No need for rec. You only introduce version references, which don't come from this attrset.

stale · 2022-04-25T02:56:53Z

I marked this as stale due to inactivity. → More info

drupol · 2023-06-06T08:40:25Z

Hi @haskie-lambda,

I'm cherry picking old PR in nixpkgs and try to push them forward.

I notice that many feedback in here were never addressed.
Are you planning to give it a refresh at some point?

If you don't, and it's perfectly fine, do you mind closing the PR?

Thanks in advance.

haskie-lambda · 2023-06-06T08:53:40Z

much of it is probably outdated anyway; I'm gonna close it for now;
if I make a new attempt, it wouldn't be too bad of an idea to start over anyway...

drupol · 2023-06-06T08:54:35Z

Thank you very much.

haskie-lambda added 9 commits May 30, 2021 11:22

typedb: init at 2.1.1

58af248

maintainers: add haskie

f4bb177

typedb: add typedb to all-packages and completed install/patch procedure

1ce0419

Merge branch 'NixOS:master' into master

68151ee

typedb: added test

985789b

typedb: moved tests to installCheckPhase as discussed in https://www.…

5f86c9e

…reddit.com/r/NixOS/comments/no9ctl/testing_newly_added_nixpkg/

Merge branch 'NixOS:master' into master

4d786b4

typedb: using fetchurl instead of fetchTarball now

05b06cf

typedb: merge remote-tracking branch 'upstream/master'

a93b019

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 10.rebuild-linux: 1 labels Jun 2, 2021

roberth reviewed Jun 3, 2021

View reviewed changes

pkgs/servers/typedb/default.nix Outdated Show resolved Hide resolved

roberth reviewed Jun 3, 2021

View reviewed changes

pkgs/servers/typedb/default.nix Outdated Show resolved Hide resolved

haskie-lambda added 2 commits June 3, 2021 13:33

typedb: changed implementation to suggestions by roberth

4cab489

typedb: Merge remote-tracking branch 'upstream/master'

46058a2

roberth reviewed Jun 3, 2021

View reviewed changes

pkgs/servers/typedb/default.nix Outdated Show resolved Hide resolved

roberth reviewed Jun 3, 2021

View reviewed changes

haskie-lambda added 4 commits June 7, 2021 13:56

implemented fix suggested by roberth

4e28da1

typedb: merge remote-tracking branch 'upstream/master'

ddd56f8

typedb: merge remote-tracking branch 'upstream/master'

b4d3ebb

typedb: added wrapper script again to supply options as variables

9e9146a

haskie-lambda commented Jun 10, 2021

View reviewed changes

pkgs/servers/typedb/default.nix Outdated Show resolved Hide resolved

haskie-lambda added 3 commits June 10, 2021 14:04

typedb: fixed install- and installCheck-phase

16a0318

typedb: merge remote-tracking branch 'upstream/master'

6de79fa

typedb: removed unneccessary file

092a461

haskie-lambda added 2 commits June 10, 2021 14:30

typedb: reformatted using nixpkgs-fmt

c25bc44

typedb: removed trailing whitespace

80a7680

roberth reviewed Jun 10, 2021

View reviewed changes

pkgs/servers/typedb/default.nix Outdated Show resolved Hide resolved

typedb: added passthrough tests

6a0830e

haskie-lambda mentioned this pull request Jun 10, 2021

Customizing server.logs to a location outside the typedb folder has no effect vaticle/typedb#6370

Closed

haskie-lambda added 2 commits June 11, 2021 19:02

typedb: updated hash of darwin sources

a774de5

typedb: merge remote-tracking branch 'upstream/master'

6953e98

SuperSandro2000 reviewed Jul 13, 2021

View reviewed changes

typedb: Merge branch 'NixOS:master' into master

4fa8793

haskie-lambda force-pushed the master branch from 13967c7 to 4fa8793 Compare July 14, 2021 07:25

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Apr 25, 2022

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 6, 2023

haskie-lambda closed this Jun 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding TypeDB #125350

Adding TypeDB #125350

haskie-lambda commented Jun 2, 2021 •

edited by roberth

roberth left a comment

roberth Jun 3, 2021

haskie-lambda Jun 3, 2021

roberth Jun 3, 2021

roberth Jun 10, 2021

haskie-lambda Jun 10, 2021

roberth Jun 10, 2021

haskie-lambda Jun 10, 2021

SuperSandro2000 Jul 13, 2021

SuperSandro2000 Jul 13, 2021

SuperSandro2000 Jul 13, 2021

SuperSandro2000 Jul 13, 2021

SuperSandro2000 Jul 13, 2021

roberth Jul 14, 2021

stale bot commented Apr 25, 2022

drupol commented Jun 6, 2023

haskie-lambda commented Jun 6, 2023

drupol commented Jun 6, 2023

	rm -r server_data
	rm -r server_log
	rm -r server_data server_log

	mkdir "server_data"
	mkdir "server_log"
	mkdir server_data server_log

	platforms = lib.attrNames systems;
	platforms = attrNames systems;

Adding TypeDB #125350

Adding TypeDB #125350

Conversation

haskie-lambda commented Jun 2, 2021 • edited by roberth

Motivation for this change

Things done

roberth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stale bot commented Apr 25, 2022

drupol commented Jun 6, 2023

haskie-lambda commented Jun 6, 2023

drupol commented Jun 6, 2023

haskie-lambda commented Jun 2, 2021 •

edited by roberth