From 13769fc6f83c362a93f1a06edad7c74b04667d43 Mon Sep 17 00:00:00 2001 From: Marc Worrell Date: Fri, 11 Oct 2024 11:14:53 +0200 Subject: [PATCH 1/2] Use proc_lib:spawn_link. Test on new OTP versions --- .github/workflows/test.yml | 4 ++-- src/sidejob_supervisor.erl | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index af8fe42..0fed54b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -18,14 +18,14 @@ jobs: strategy: matrix: - otp_version: [21,22,23] + otp_version: [25,26,27] os: [ubuntu-latest] container: image: erlang:${{ matrix.otp_version }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Compile run: make - name: Test diff --git a/src/sidejob_supervisor.erl b/src/sidejob_supervisor.erl index b155604..7bdb21a 100644 --- a/src/sidejob_supervisor.erl +++ b/src/sidejob_supervisor.erl @@ -110,7 +110,7 @@ handle_call({start_child, Mod, Fun, Args}, _From, State) -> {reply, Reply, State2}; handle_call(spawn, _From, State) -> - Pid = erlang:spawn_link(fun spawned_worker/0), + Pid = proc_lib:spawn_link(fun spawned_worker/0), State2 = add_child(Pid, State), {reply, {ok, Pid}, State2}; From 5ac6e67c5373c704e270b8ea72637adbfffd6c55 Mon Sep 17 00:00:00 2001 From: Marc Worrell Date: Fri, 11 Oct 2024 11:50:28 +0200 Subject: [PATCH 2/2] Fix dialyzer and docs --- LICENSE | 178 +++++++++++++++++++++++++++++++++++++++ rebar.config | 21 ++++- src/sidejob.app.src | 2 +- test/supervisor_test.erl | 4 +- 4 files changed, 201 insertions(+), 4 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e454a52 --- /dev/null +++ b/LICENSE @@ -0,0 +1,178 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + diff --git a/rebar.config b/rebar.config index 2fef204..36da0f1 100644 --- a/rebar.config +++ b/rebar.config @@ -1,9 +1,23 @@ -{erl_opts, [debug_info, warn_untyped_records]}. +{erl_opts, [ + debug_info, + warn_untyped_records + ] +}. + +{deps, []}. + {cover_enabled, true}. {eunit_opts, [verbose]}. {edoc_opts, [{preprocess, true}]}. {xref_checks, [undefined_function_calls]}. -{deps, []}. + +{project_plugins, [rebar3_ex_doc]}. +{hex, [{doc, ex_doc}]}. +{ex_doc, [ + {source_url, <<"https://github.com/erlangpack/sidejob">>}, + {extras, [<<"README.md">>, <<"LICENSE">>]}, + {main, <<"readme">>} +]}. {profiles, [ {test, [ @@ -20,6 +34,9 @@ {dialyzer, [ {warnings, [ no_return + ]}, + {plt_extra_apps, [ + eunit ]} ]} ]} diff --git a/src/sidejob.app.src b/src/sidejob.app.src index 3468ae4..c4ff18f 100644 --- a/src/sidejob.app.src +++ b/src/sidejob.app.src @@ -2,7 +2,7 @@ {description, "sidejob is an Erlang library that implements a parallel, capacity-limited request pool. In sidejob, these pools are called resources. A resource is managed by multiple gen_server like processes which can be sent calls and casts using sidejob:call or sidejob:cast respectively."}, {vsn, "git"}, {registered, []}, - {applications, [kernel, stdlib]}, + {applications, [kernel, stdlib, syntax_tools, compiler]}, {mod, {sidejob_app, []}}, {env, []}, {maintainers, ["Ulf Norell", "ErlangPack"]}, diff --git a/test/supervisor_test.erl b/test/supervisor_test.erl index f0cc219..d1c3fda 100644 --- a/test/supervisor_test.erl +++ b/test/supervisor_test.erl @@ -1,5 +1,7 @@ -module(supervisor_test). + -export([fail_to_start_link/0]). + -include_lib("eunit/include/eunit.hrl"). -define(RESOURCE, supervisor_test_resource). @@ -9,7 +11,7 @@ spurious_exit_test() -> {ok, _} = application:ensure_all_started(sidejob), {ok, _} = sidejob:new_resource(?RESOURCE, sidejob_supervisor, 5, 1), - {WorkerReg} = ?RESOURCE:workers(), + {WorkerReg} = erlang:apply(?RESOURCE, workers, []), WorkerPid = whereis(WorkerReg), ?assert(is_process_alive(WorkerPid)), {ok, undefined} = sidejob_supervisor:start_child(?RESOURCE, ?MODULE, fail_to_start_link, []),