Switch from 'error_logger' to 'logger'

Includes changes on the `openriak-3.2` branch.

wday-contrib 2325

Author: tburghart

.github/workflows/erlang.yml

@@ -21,7 +21,7 @@ jobs:
         rebar: ['3.20', '3.22']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         with:
           otp-version: ${{ matrix.otp }}

README.md

@@ -1,7 +1,7 @@
 ## Bitcask - A Log-Structured Hash Table for Fast Key/Value Data
 
-[![Build Status](https://github.com/basho/bitcask/workflows/erlang.yml/badge.svg)](https://github.com/basho/bitcask/actions)
+[![Build Status](https://github.com/OpenRiak/bitcask/actions/workflows/erlang.yml/badge.svg)](https://github.com/OpenRiak/bitcask/actions/workflows/erlang.yml)
 
-Bitcask requires [Erlang/OTP](https://erlang.org) 22+ and [Rebar3](https://rebar3.org) in your `$PATH`.
+Bitcask requires [Erlang/OTP](https://erlang.org) 24+ and [Rebar3](https://rebar3.org) in your `$PATH`.
 
 The included [Makefile](Makefile) wraps most common Rebar3 build operations.

eqc/bitcask_qc_expiry.erl

@@ -26,10 +26,17 @@
 -include_lib("eqc/include/eqc.hrl").
 -include_lib("eunit/include/eunit.hrl").
 -include("include/bitcask.hrl").
--include("stacktrace.hrl").
 
 -compile([export_all, nowarn_export_all]).
 
+-ifdef(OTP_RELEASE). %% This implies 21 or higher
+-define(_exception_(Class, Reason, StackToken), Class:Reason:StackToken).
+-define(_get_stacktrace_(StackToken), StackToken).
+-else.
+-define(_exception_(Class, Reason, _), Class:Reason).
+-define(_get_stacktrace_(_), erlang:get_stacktrace()).
+-endif.
+
 keys() ->
     eqc_gen:non_empty(list(eqc_gen:non_empty(binary()))).
 

rebar.config

@@ -70,24 +70,21 @@
             {app_default, "http://www.erlang.org/doc/man"},
             {preprocess, true},
             {macros, [
-                {'EDOC', true},
-                {'BASHO_DOCS', true}
+                {'EDOC', true}
             ]}
         ]}
     ]},
     {prod, [
         {erl_opts, [
-            warnings_as_errors,
-            {d, 'BASHO_PROD'}
+            warnings_as_errors
         ]}
     ]},
     % Builds the NIF library with debug output, otherwise same as 'prod'.
     % Note that the name of the NIF library is unchanged, so it will appear
     % up-to-date for any profile.
     {debug, [
         {erl_opts, [
-            warnings_as_errors,
-            {d, 'BASHO_PROD'}
+            warnings_as_errors
         ]},
         {port_env, [
             {"CFLAGS", "$CFLAGS -DBITCASK_DEBUG"}
@@ -152,8 +149,7 @@
             nowarn_export_all,
             nowarn_unused_function,
             nowarn_unused_import,   % EQC
-            warnings_as_errors,
-            {d, 'BASHO_TEST'}
+            warnings_as_errors
         ]},
         {deps, [
             {meck, "0.9.2"},

src/bitcask.app.src

@@ -1,6 +1,6 @@
 {application, bitcask, [
     {description, "Yet another key/value storage engine"},
-    {vsn, "2.1.0.4"},
+    {vsn, "2.1.0.5"},
     {modules, []},
     {registered, []},
     {applications, [kernel, stdlib]},

src/bitcask.erl

@@ -1,7 +1,7 @@
 %% -------------------------------------------------------------------
 %%
 %% Copyright (c) 2010-2017 Basho Technologies, Inc.
-%% Copyright (c) 2018-2024 Workday, Inc.
+%% Copyright (c) 2018-2025 Workday, Inc.
 %%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
@@ -95,7 +95,7 @@
 %% This atom is the signal that it failed but is harmless in this situation.
 -define(POLL_FOR_MERGE_LOCK_PSEUDOFAILURE, pseudo_failure).
 
-%% @type bc_state().
+%% Type bc_state().
 -record(bc_state, {dirname :: string(),
                    write_file :: 'fresh' | 'undefined' | #filestate{},     % File for writing
                    write_lock :: 'undefined' | reference(),     % Reference to write lock
@@ -168,9 +168,9 @@ open(Dirname, Opts) ->
                   ok;
               not_stale ->
                   ?LOG_ERROR(
-                      "Attempted to obtain the Bitcask write lock for '~ts' but"
-                      " another Bitcask DB has the lock! Continuing but all"
-                      " write operations will fail.", [Dirname])
+                      "Attempted to obtain the Bitcask write lock for '~ts'"
+                      " but another Bitcask DB has the lock! Continuing but"
+                      " all write operations will fail.", [Dirname])
           end,
           fresh;
         false ->
@@ -2190,9 +2190,16 @@ roundtrip_test_() ->
     {timeout, 60, fun roundtrip_test2/0}.
 
 setup_testfolder(Path) ->
-    DN = filename:join(?TEST_FILEPATH, Path),
-    os:cmd("rm -rf " ++ DN),
-    DN.
+    Target = filename:join(?TEST_FILEPATH, Path),
+    case filelib:is_file(Target) of
+        true ->
+            ?assertMatch(ok, file:del_dir_r(Target), Target),
+            ?assertMatch(ok, file:make_dir(Target), Target);
+        _ ->
+            Dummy = filename:join(Target, "dummy"),
+            ?assertMatch(ok, filelib:ensure_dir(Dummy), Dummy)
+    end,
+    Target.
 
 roundtrip_test2() ->
     FN = setup_testfolder("bc.test.roundtrip"),

src/bitcask_nifs.erl

@@ -61,11 +61,6 @@
     file_seekbof/1,
     file_truncate/1
 ]).
--ifdef(BASHO_CHECK).
-%% Dialyzer and XRef won't recognize 'on_load' as using the function and
-%% will complain about it.
--export([init_nif_lib/0]).
--endif.
 
 %% Make sure only a consistent set of test macros are defined so we don't
 %% have to keep checking them all repeatedly.

test/bitcask_lockops_tests.erl

@@ -1,6 +1,6 @@
 %% -------------------------------------------------------------------
 %%
-%% Copyright (c) 2018-2022 Workday, Inc.
+%% Copyright (c) 2018-2025 Workday, Inc.
 %%
 %% This file is provided to you under the Apache License,
 %% Version 2.0 (the "License"); you may not use this file
@@ -19,21 +19,28 @@
 %% -------------------------------------------------------------------
 -module(bitcask_lockops_tests).
 
+%% Warning: Without 'export_all', the first test will fail (that is, it
+%% succeeds in acquiring the lock on the second call). This happens even if
+%% the tests and external-vm functions are explicitly exported. Clearly
+%% something funky is going on in eunit.hrl.
+-compile([export_all, nowarn_export_all]).
+
+%% Comment this out to see output from the spawned process.
+-define(NODEBUG, true).
+
 -include_lib("eunit/include/eunit.hrl").
 -include("bitcask.hrl").
 
--compile([export_all, nowarn_export_all]).
-
 lock_cannot_be_obtained_on_already_locked_file_within_same_os_process_test() ->
-    Dir = bitcask:create_test_dir(),
+    Dir = create_test_dir(?FUNCTION_NAME),
     Filename = bitcask_lockops:lock_filename(write,Dir),
     ok = file_delete(Filename),
     ok = file:write_file(Filename, ""),
     {ok, _Lock} = bitcask_lockops:acquire(write, Dir),
     ?assertMatch({error, locked}, bitcask_lockops:acquire(write, Dir)).
 
 lock_can_be_obtained_on_already_locked_file_is_unlocked_test() ->
-    Dir = bitcask:create_test_dir(),
+    Dir = create_test_dir(?FUNCTION_NAME),
     Filename = bitcask_lockops:lock_filename(write,Dir),
     ok = file_delete(Filename),
     ok = file:write_file(Filename, ""),
@@ -42,17 +49,18 @@ lock_can_be_obtained_on_already_locked_file_is_unlocked_test() ->
     ?assertMatch({ok, _}, bitcask_lockops:acquire(write, Dir)).
 
 lock_cannot_be_obtained_on_already_locked_file_across_os_process_test() ->
-    DbDir = filename:absname(bitcask:create_test_dir()),
+    DbDir = filename:absname(create_test_dir(?FUNCTION_NAME)),
     %% start another erlang vm that will open the DB and obtain a write
     %% lock, then, when we try to obtain a write lock on the current vm
     %% it should fail.
+    %% ToDo: Post OTP 24 use the 'peer' module, too much hassle before then.
     {?MODULE, _, TBeam} = code:get_object_code(?MODULE),
     {bitcask, _, BBeam} = code:get_object_code(bitcask),
     Tbin = filename:dirname(TBeam),
     Bbin = filename:dirname(BBeam),
     Erl = filename:join([code:root_dir(), "bin", "erl"]),
     Cmd = lists:flatten([
-        Erl, " -pa ", Bbin, " -pa ", Tbin, " -noinput -noshell -eval"
+        "'", Erl, "' -pa '", Bbin, "' -pa '", Tbin, "' -noinput -noshell -eval"
         " 'bitcask_lockops_tests:bitcask_locker_vm_main(\"", DbDir, "\").'"
     ]),
     ?debugFmt("~n= COMMAND: ~ts", [Cmd]),
@@ -62,13 +70,13 @@ lock_cannot_be_obtained_on_already_locked_file_across_os_process_test() ->
     DB = bitcask:open(DbDir, [read_write]),
     ?assertMatch({error, {error, locked}}, bitcask:put(DB, <<"k">>, <<"v">>)),
     receive
-        {'DOWN', MonRef, _Type, _Object, _Info} = Msg ->
-            ?debugFmt("~n= RECEIVE: ~0tp", [Msg])
+        {'DOWN', MonRef, _Type, _Object, _Info} = _Msg ->
+            ?debugFmt("~n= RECEIVE: ~p~n", [_Msg])
     end.
 
 run_vm_process(Command) ->
-    Output = ?cmd(Command),
-    ?debugFmt("~n= OUTPUT ~0tp: ~ts", [erlang:self(), Output]).
+    _Output = ?cmd(Command),
+    ?debugFmt("~n= CMD OUTPUT: ~s~n", [_Output]).
 
 %% entry function for another vm to lock a bitcask DB
 bitcask_locker_vm_main(DbDir) ->
@@ -91,3 +99,7 @@ file_delete(Filename) ->
             ok
     end.
 
+-spec create_test_dir(Label :: atom() | string()) -> string().
+%% Creates a new, empty, directory for testing.
+create_test_dir(Label) ->
+    bitcask:setup_testfolder(io_lib:format("bc.lockops.~s", [Label])).