macaw_framework 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fdecdae940a89142bf0252b2d0b818684f87b50d030c86c1523224aab684b0f
-  data.tar.gz: bf7ff6874613d14f1a97f803ca3bc063269cc2fb5f34d17679fc694ca80ed2f2
+  metadata.gz: 75201cbb67c0e3d1f913751ed085cf3102f42794a3d5f3721b4acd00234ac257
+  data.tar.gz: 1b15fe1043c6213fe8a7f5be7ea22f2ed1bd6c917215de79edf66b622e6c2e85
 SHA512:
-  metadata.gz: 85c4c95350b29411fcfa51bbfaf8929f9046d8927c8d8ebb56b7725f05680a0ec5845c4b9ad2a03aff07ab951289e81035711fe1a76132a534b51876543916d1
-  data.tar.gz: 777150885e128a091f05e9d63548fd715a4fa36cf61f7ed350bf291dc75b22b12f5f69aa7252f4dea2dbee827d6a0c852830a1ea105c45919d5e08b486fc7b71
+  metadata.gz: 0f6feb4910080a14c3908a8f5d89d5768fbf40e40882f8d98e6ecfdcf99475ec86e0522bd09f0db9b73577e2e1b72912f1db9da169271ac5b403bc680e09a0a4
+  data.tar.gz: 2417693c644f10af4c4a23186dde6451405c1a34c595ec507292f5eba1f7451193a4e728b9cd28195bc1010ab22f8f4a7368240e016e3f871515cb3ec22ea242

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: disable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -108,6 +108,14 @@
 - Optimizing bug report template on GitHub
 - Optimizing return clause of the get_files_public_folder method
 
-## [1.2.0] - 2023-09-17
+## [1.2.0] - 2023-10-05
 
 - Fixing bug where the server would accept new connections during shutdown
+
+## [1.2.1] - 2023-11-06
+
+- Simplifying logging aspect for readability
+
+## [1.2.2]
+
+- Including possibility of setting port, bind and threads programmatically

data/README.md

@@ -8,6 +8,7 @@ provides developers with the essential tools to quickly build and deploy their a
 - [MacawFramework](#macawframework)
     * [Features](#features)
     * [Installation](#installation)
+    * [Performance](#performance)
     * [Compatibility](#compatibility)
     * [MacawFramework's Built-In Web Server](#macawframeworks-built-in-web-server)
     * [Usage](#usage)
@@ -42,6 +43,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install macaw_framework
 
+## Performance
+
+We evaluated MacawFramework (Version 1.2.0) to assess its ability to handle simultaneous requests under heavy load. Disabling non-essential features, such as cache and logging, we observed remarkable results. The framework demonstrated efficient memory usage (243.3 MB average) and handled an impressive 600,000 HTTP requests with an average response time of just 1 millisecond. Throughput reached an outstanding 10,196.45 requests per second. These findings suggest that MacawFramework is well-equipped to handle substantial HTTP traffic without significant performance degradation. For detailed results, please refer to the [full report](https://github.com/ariasdiniz/macaw_performance_test).
+
 ## Compatibility
 
 MacawFramework is built to be highly compatible, since it uses only native Ruby code:
@@ -132,12 +137,6 @@ end
     "port": 8080,
     "bind": "localhost",
     "threads": 200,
-    "log": {
-      "max_length": 1024,
-      "sensitive_fields": [
-        "password"
-      ]
-    },
     "cache": {
       "cache_invalidation": 3600,
       "ignore_headers": [
@@ -225,11 +224,24 @@ MacawFramework::Macaw.new(custom_log: nil)
 - URL parameters like `...endOfUrl?key1=value1&key2=value2` can be found in the `context[:params]`
 
 ```ruby
+m = MacawFramework::Macaw.new
+
 m.get('/test_params') do |context|
   context[:params]["key1"] # returns: value1
 end
 ```
 
+- You can also set `port`, `bind` and `threads` programmatically as shown below. This will override values set in the
+`application.json` file
+
+```ruby
+m = MacawFramework::Macaw.new
+
+m.port = 3000
+m.bind = '0.0.0.0'
+m.threads = 300
+```
+
 - The default number of virtual threads in the thread pool is 200.
 
 - Rate Limit window should also be specified in seconds. Rate limit will be activated only if the `rate_limiting` config

data/lib/macaw_framework/aspects/logging_aspect.rb

@@ -12,17 +12,12 @@ module LoggingAspect
     return super(*args) if logger.nil?
 
     endpoint_name = args[1].split(".")[1..].join("/")
-    logger.info(LogDataFilter.sanitize_for_logging(
-                  "Request received for #{endpoint_name} with arguments: #{args[2..]}"
-                ))
+    logger.info("Request received for [#{endpoint_name}] from [#{args[-1]}]")
 
     begin
       response = super(*args)
-      logger.info(LogDataFilter.sanitize_for_logging("Response for #{endpoint_name}: #{response}"))
     rescue StandardError => e
-      logger.error(
-        LogDataFilter.sanitize_for_logging("Error processing #{endpoint_name}: #{e.message}\n#{e.backtrace.join("\n")}")
-      )
+      logger.error("#{e.message}\n#{e.backtrace.join("\n")}")
       raise e
     end
 

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -20,7 +20,8 @@ module MacawFramework
   class Macaw
     ##
     # Array containing the routes defined in the application
-    attr_reader :routes, :port, :bind, :threads, :macaw_log, :config, :jobs
+    attr_reader :routes, :macaw_log, :config, :jobs
+    attr_accessor :port, :bind, :threads
 
     ##
     # @param {Logger} custom_log
@@ -49,7 +50,7 @@ module MacawFramework
       @endpoints_to_cache = []
       @prometheus ||= nil
       @prometheus_middleware ||= nil
-      @server = server.new(self, @endpoints_to_cache, @cache, @prometheus, @prometheus_middleware)
+      @server_class = server
     end
 
     ##
@@ -161,6 +162,7 @@ module MacawFramework
         @macaw_log.info("Number of threads: #{@threads}")
         @macaw_log.info("---------------------------------")
       end
+      @server = @server_class.new(self, @endpoints_to_cache, @cache, @prometheus, @prometheus_middleware)
       server_loop(@server)
     rescue Interrupt
       if @macaw_log.nil?

data/sig/macaw_framework/macaw.rbs

@@ -9,18 +9,17 @@ module MacawFramework
 
     @prometheus: untyped
     @prometheus_middleware: untyped
-    @server: Server
+    @server: untyped
 
     @threads: Integer
 
-    attr_reader bind: String
+    attr_accessor bind: String
     attr_reader config: Hash[String, untyped]
     attr_reader jobs: Array[String]
     attr_reader macaw_log: Logger?
-    attr_reader port: Integer
+    attr_accessor port: Integer
     attr_reader routes: Array[String]
-
-    attr_reader threads: Integer
+    attr_accessor threads: Integer
 
     def delete: -> nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client