Mas d34 i453 eqwalizer (#454)

* Add eqwalizer and clear for codec & sst

The eqwalizer errors highlighted the need in several places for type clarification.

Within tests there are some issue where a type is assumed, and so ignore has been used to handle this rather than write more complex code to be explicit about the assumption.

The handling of arrays isn't great by eqwalizer - to be specific about the content of array causes issues when initialising an array.  Perhaps a type (map maybe) where one can be more explicit about types might be a better option (even if there is a minimal performance impact).

The use of a ?TOMB_COUNT defined option complicated the code much more with eqwalizer.  So for now, there is no developer option to disable ?TOMB_COUNT.

Test fixes required where strings have been used for buckets/keys not binaries.

The leveled_sst statem needs a different state record for starting when compared to other modes.  The state record has been divided up to reflect this, to make type management easier.  The impact on performance needs to be tested.

* Update ct tests to support binary keys/buckets only

* Eqwalizer for leveled_cdb and leveled_tictac

As array is used in leveled_tictac - there is the same issue as with leveled_sst

* Remove redundant indirection of leveled_rand

A legacy of pre-20 OTP

* Morde modules eqwalized

ebloom/log/util/monitor

* Eqwalize further modules

elp eqwalize leveled_codec; elp eqwalize leveled_sst; elp eqwalize leveled_cdb; elp eqwalize leveled_tictac; elp eqwalize leveled_log; elp eqwalize leveled_monitor; elp eqwalize leveled_head; elp eqwalize leveled_ebloom; elp eqwalize leveled_iclerk

All concurrently OK

* Refactor unit tests to use binary() no string() in key

Previously string() was allowed just to avoid having to change all these tests.  Go through the pain now, as part of eqwalizing.

* Add fixes for penciller, inker

Add a new ?IS_DEF macro to replace =/= undefined.

Now more explicit about primary, object and query keys

* Further fixes

Need to clarify functions used by runner - where keys , query keys and object keys are used

* Further eqwalisation

* Eqwalize leveled_pmanifest

Also make implementation independent of choice of dict - i.e. one can save a manifest using dict for blooms/pending_deletions and then open a manifest with code that uses a different type.  Allow for slow dict to be replaced with map.

Would not be backwards compatible though, without further thought - i.e. if you upgrade then downgrade.

Redundant code created by leveled_sst refactoring removed.

* Fix backwards compatibility issues

* Manifest Entry to belong to leveled_pmanifest

There are two manifests - leveled_pmanifest and leveled_imanifest.  Both have manifest_entry() type objects, but these types are different.  To avoid confusion don't include the pmanifest manifest_entry() within the global include file - be specific that it belongs to the leveled_pmanifest module

* Ignore elp file - large binary

* Update src/leveled_pmem.erl

Remove unnecessary empty list from type definition

Co-authored-by: Thomas Arts <[email protected]>

---------

Co-authored-by: Thomas Arts <[email protected]>

.gitignore

@@ -9,3 +9,4 @@ cover
 cover_*
 .eqc-info
 leveled_data/*
+elp

include/leveled.hrl

@@ -70,6 +70,15 @@
     %% Inker key type used for tombstones
 %%%============================================================================
 
+%%%============================================================================
+%%% Helper Function
+%%%============================================================================
+
+-define(IS_DEF(Attribute), Attribute =/= undefined).
+
+-if(?OTP_RELEASE < 26).
+-type dynamic() :: any().
+-endif.
 
 %%%============================================================================
 %%% Shared records
@@ -79,13 +88,6 @@
                         is_basement = false :: boolean(),
                         timestamp :: integer()}).                      
 
--record(manifest_entry,
-                        {start_key :: tuple() | undefined,
-                        end_key :: tuple() | undefined,
-                        owner :: pid()|list(),
-                        filename :: string() | undefined,
-                        bloom = none :: leveled_ebloom:bloom() | none}).
-
 -record(cdb_options,
                         {max_size :: pos_integer() | undefined,
                         max_count :: pos_integer() | undefined,
@@ -129,14 +131,15 @@
                         singlefile_compactionperc :: float()|undefined,
                         maxrunlength_compactionperc :: float()|undefined,
                         score_onein = 1 :: pos_integer(),
-                        snaptimeout_long :: pos_integer() | undefined,
+                        snaptimeout_long = 60 :: pos_integer(),
                         monitor = {no_monitor, 0}
                             :: leveled_monitor:monitor()}).
 
 -record(penciller_options,
                         {root_path :: string() | undefined,
                         sst_options = #sst_options{} :: #sst_options{},
-                        max_inmemory_tablesize :: integer() | undefined,
+                        max_inmemory_tablesize  = ?MIN_PCL_CACHE_SIZE
+                            :: pos_integer(),
                         start_snapshot = false :: boolean(),
                         snapshot_query,
                         bookies_pid :: pid() | undefined,

rebar.config

@@ -12,6 +12,14 @@
 
 {eunit_opts, [verbose]}.
 
+{project_plugins, [
+  {eqwalizer_rebar3,
+    {git_subdir,
+        "https://github.com/whatsapp/eqwalizer.git",
+        {branch, "main"},
+        "eqwalizer_rebar3"}}
+]}.
+
 {profiles,
  [{eqc, [{deps, [meck, fqc]},
     {erl_opts, [debug_info,  {d, 'EQC'}]},
@@ -28,7 +36,8 @@
 
 {deps, [
   {lz4, ".*", {git, "https://github.com/nhs-riak/erlang-lz4", {branch, "nhse-develop-3.4"}}},
-  {zstd, ".*", {git, "https://github.com/nhs-riak/zstd-erlang", {branch, "nhse-develop"}}}
+  {zstd, ".*", {git, "https://github.com/nhs-riak/zstd-erlang", {branch, "nhse-develop"}}},
+  {eqwalizer_support, {git_subdir, "https://github.com/whatsapp/eqwalizer.git", {branch, "main"}, "eqwalizer_support"}}
         ]}.
 
 {ct_opts, [{dir, ["test/end_to_end"]}]}.