macaw_framework 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7be8f35960be882dfd7d36d929a06a2ee46416e077532d6cb08809b39db41eed
-  data.tar.gz: 4ea88706237b89a02b64a7f6c73848d2b64c4ec04643e641ad6ac2711985f57d
+  metadata.gz: 206cdc56fc4e1027b3f1cc5d98b57a531c4043500cb1e99545b6e198c9b01f9d
+  data.tar.gz: 954b2f0bcbfea9bdc8e0a39362455e3c155e7b04f7b2accf786c6be658740c65
 SHA512:
-  metadata.gz: 9a91371c336e35ad1207be16504767676ef1e2125cd40ea4caba201da704d2006a7bd538b77122502c90f85550142d11fc8d1c78c7a0426dd776f8e0b57a1b90
-  data.tar.gz: 67383dfb8aecb709167d5ab92af4cc9ed821e5898b92b2f06910ed8ccc2390af6afd7cc5325b7d1acf73fe3e731edf47afbbaa760e859fb3da92cae62103d8fd
+  metadata.gz: ec8a983e02579327ef6987a86267094ed0d0384ed8f1da4c244b0c77d27b1ddae2de4e1ef94020ab90824055ae892f03f5884ce724ec596551622e25ee88d167
+  data.tar.gz: 9a90daa6f5884b4148728b89780a6fb118e071e932c6e437c4efa8f4f548b7624d021bb540e25f929d584c20e398974c27e962869e0d7337894466e0cf914a37

data/CHANGELOG.md

@@ -79,3 +79,15 @@
 
 - Adding native cron jobs
 - Documentation improvement
+
+## [1.1.2] - 2023-05-31
+
+- Fixing retry bug in cron jobs, where retries were made after an exception without waiting for interval
+- Fixing another bug in cron jobs where an exception were thrown when start_delay were not set
+- Documentation improvement
+
+## [1.1.3] - 2023-05-31
+
+- Adding start_without_server! method for starting the framework without running a web server
+- Improving documentation
+- Raising the number of default threads from 5 to 10

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/macaw_framework.svg)](https://badge.fury.io/rb/macaw_framework) ![CI Pipeline](https://github.com/ariasdiniz/macaw_framework/actions/workflows/main.yml/badge.svg?branch=main)
 # MacawFramework
 
 MacawFramework is a lightweight, easy-to-use web framework for Ruby designed to simplify the development of small to 
@@ -8,6 +9,7 @@ provides developers with the essential tools to quickly build and deploy their a
     * [Features](#features)
     * [Installation](#installation)
     * [Compatibility](#compatibility)
+    * [MacawFramework's Built-In Web Server](#macawframeworks-built-in-web-server)
     * [Usage](#usage)
         + [Basic routing: Define routes with support for GET, POST, PUT, PATCH, and DELETE HTTP methods](#basic-routing-define-routes-with-support-for-get-post-put-patch-and-delete-http-methods)
         + [Caching: Improve performance by caching responses and configuring cache invalidation](#caching-improve-performance-by-caching-responses-and-configuring-cache-invalidation)
@@ -49,6 +51,28 @@ MacawFramework is built to be highly compatible, since it uses only native Ruby
 
 - **JRuby**: MacawFramework is also compatible with JRuby, a version of Ruby that runs on the Java Virtual Machine (JVM).
 
+Sure, here's a rewritten section for your README:
+
+## MacawFramework's Built-In Web Server
+
+MacawFramework includes a built-in web server based on Ruby's TCPServer class, providing a lightweight yet robust solution for serving your web applications. It incorporates features such as SSL security and a thread-based architecture, offering a balance of simplicity, performance, and robustness.
+
+### Key Features
+
+- **SSL Security**: Our server integrates SSL security, offering secure communication for your applications. By providing a valid SSL context, the built-in TCPServer will be wrapped in OpenSSL's SSLServer, adding an essential secure transport layer to your web server.
+
+- **Thread-based Architecture**: We employ a thread-based model where a specified number of worker threads are used to handle client connections. Incoming connections are queued in a work queue, where they are then processed by the worker threads, ensuring fair scheduling and load distribution.
+
+- **Thread Pool Management**: We make use of Ruby's built-in synchronization constructs, using a Mutex to safely manage the worker threads pool. A maintenance routine periodically checks the health of the worker threads, respawning any that have died, ensuring consistent server performance.
+
+- **Graceful Shutdown**: Our server is designed to gracefully shut down when required, making sure all pending connections in the work queue are processed before closing the worker threads and the server itself. This ensures that no client requests are abruptly terminated, providing a smooth user experience.
+
+It's worth noting that while our threading model is simple and effective, it has some limitations. The number of concurrent connections it can handle is limited by the number of worker threads, and it could be susceptible to slow clients, which could tie up a worker thread and reduce the server's capacity. However, for JRuby and TruffleRuby users, this threading model can leverage true system-level threading due to the lack of a Global Interpreter Lock (GIL), potentially providing better performance on multi-core systems and handling larger numbers of concurrent connections more efficiently.
+
+Despite these trade-offs, MacawFramework's built-in web server offers a good balance for most web applications, particularly for small to medium scale deployments. For larger-scale applications with high concurrency demands, consider supplementing the built-in server with an event-driven architecture or utilizing a third-party server solution better suited for such scenarios.
+
+In summary, MacawFramework's built-in web server provides a straightforward, efficient, and secure solution for running your web applications, requiring minimal configuration and making deployment a breeze.
+
 ## Usage
 
 ### Basic routing: Define routes with support for GET, POST, PUT, PATCH, and DELETE HTTP methods
@@ -166,6 +190,9 @@ Values for interval and start_delay are in seconds.
 
 **Caution: Defining a lot of jobs with low interval can severely degrade performance.**
 
+If you want to build an application with just cron jobs, that don't need to run a web server, you can start
+MacawFramework without running a web server with `start_without_server!` method, instead of `start!`.
+
 ### Tips
 
 - The automatic logging and log aspect are now optional. To disable them, simply start Macaw with `custom_log` set to nil.

data/lib/macaw_framework/core/cron_runner.rb

@@ -16,6 +16,7 @@ class CronRunner
   # @param {String} job_name
   # @param {Proc} block
   def start_cron_job_thread(interval, start_delay, job_name, &block)
+    start_delay ||= 0
     raise "interval can't be <= 0 and start_delay can't be < 0!" if interval <= 0 || start_delay.negative?
 
     @logger&.info("Starting thread for job #{job_name}")
@@ -39,6 +40,7 @@ class CronRunner
         sleep(sleep_time)
       rescue StandardError => e
         @logger&.error("Error executing cron job with name #{name}: #{e.message}")
+        sleep(interval)
       end
     end
     sleep(1)

data/lib/macaw_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MacawFramework
-  VERSION = "1.1.1"
+  VERSION = "1.1.3"
 end

data/lib/macaw_framework.rb

@@ -31,7 +31,7 @@ module MacawFramework
         @config = JSON.parse(File.read("application.json"))
         @port = @config["macaw"]["port"] || 8080
         @bind = @config["macaw"]["bind"] || "localhost"
-        @threads = @config["macaw"]["threads"] || 5
+        @threads = @config["macaw"]["threads"] || 10
         unless @config["macaw"]["cache"].nil?
           @cache = MemoryInvalidationMiddleware.new(@config["macaw"]["cache"]["cache_invalidation"].to_i || 3_600)
         end
@@ -56,7 +56,12 @@ module MacawFramework
     # with the respective path.
     # @param {String} path
     # @param {Proc} block
-    # @return {Integer, String}
+    # @example
+    #
+    # macaw = MacawFramework::Macaw.new
+    # macaw.get("/hello") do |context|
+    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    # end
     def get(path, cache: false, &block)
       map_new_endpoint("get", cache, path, &block)
     end
@@ -67,7 +72,12 @@ module MacawFramework
     # @param {String} path
     # @param {Boolean} cache
     # @param {Proc} block
-    # @return {String, Integer}
+    # @example
+    #
+    # macaw = MacawFramework::Macaw.new
+    # macaw.post("/hello") do |context|
+    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    # end
     def post(path, cache: false, &block)
       map_new_endpoint("post", cache, path, &block)
     end
@@ -77,7 +87,12 @@ module MacawFramework
     # with the respective path.
     # @param {String} path
     # @param {Proc} block
-    # @return {String, Integer}
+    # @example
+    #
+    # macaw = MacawFramework::Macaw.new
+    # macaw.put("/hello") do |context|
+    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    # end
     def put(path, cache: false, &block)
       map_new_endpoint("put", cache, path, &block)
     end
@@ -87,7 +102,12 @@ module MacawFramework
     # with the respective path.
     # @param {String} path
     # @param {Proc} block
-    # @return {String, Integer}
+    # @example
+    #
+    # macaw = MacawFramework::Macaw.new
+    # macaw.patch("/hello") do |context|
+    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    # end
     def patch(path, cache: false, &block)
       map_new_endpoint("patch", cache, path, &block)
     end
@@ -97,7 +117,12 @@ module MacawFramework
     # with the respective path.
     # @param {String} path
     # @param {Proc} block
-    # @return {String, Integer}
+    # @example
+    #
+    # macaw = MacawFramework::Macaw.new
+    # macaw.delete("/hello") do |context|
+    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    # end
     def delete(path, cache: false, &block)
       map_new_endpoint("delete", cache, path, &block)
     end
@@ -108,7 +133,13 @@ module MacawFramework
     # @param {Integer?} start_delay
     # @param {String} job_name
     # @param {Proc} block
-    def setup_job(interval: 60, start_delay: nil, job_name: "job_#{SecureRandom.uuid}", &block)
+    # @example
+    #
+    # macaw = MacawFramework::Macaw.new
+    # macaw.setup_job(interval: 60, start_delay: 60, job_name: "job 1") do
+    #   puts "I'm a cron job that runs every minute"
+    # end
+    def setup_job(interval: 60, start_delay: 0, job_name: "job_#{SecureRandom.uuid}", &block)
       @cron_runner ||= CronRunner.new(self)
       @jobs ||= []
       @cron_runner.start_cron_job_thread(interval, start_delay, job_name, &block)
@@ -142,6 +173,18 @@ module MacawFramework
       end
     end
 
+    ##
+    # This method is intended to start the framework
+    # without an web server. This can be useful when
+    # you just want to keep cron jobs running, without
+    # mapping any HTTP endpoints.
+    def start_without_server!
+      @macaw_log.nil? ? puts("Application starting") : @macaw_log.info("Application starting")
+      loop { sleep(3600) }
+    rescue Interrupt
+      @macaw_log.nil? ? puts("Macaw stop flying for some seeds.") : @macaw_log.info("Macaw stop flying for some seeds.")
+    end
+
     private
 
     def server_loop(server)

data/sig/macaw_framework/macaw.rbs

@@ -3,6 +3,7 @@ module MacawFramework
     @bind: String
     @cache: untyped
     @config: Hash[String, untyped]
+    @cron_runner: CronRunner
     @endpoints_to_cache: Array[String]
     @macaw_log: Logger?
 
@@ -31,6 +32,8 @@ module MacawFramework
 
     def put: -> nil
 
+    def setup_job: -> nil
+
     def start!: -> nil
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-28 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client