execjs-pcruntime 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77461be271505a3cd4f7cb935147fa28686999ea670eb3973c09081b3ec4ac5f
+  data.tar.gz: 6128b62988059ab70234f7b1145bed2eede524236632fc2e9c85f0913ded3c1a
+SHA512:
+  metadata.gz: 1fd2524a2926f54ea485eb4487a4ee39b6453aebd92d79f1f204887af23e9dfe535830e23bf81a0517c51409ac67f1243ca7cdbb3bb19fb8db0549662db0e4b6
+  data.tar.gz: 21a8aaf06830cccf8604a5172ae220c290ae31184cdb28582b3daba968afff9d85b69603544dc3cfbc4b37daaa228eb3aae30fd07999ba7887c65b4e708f525e

data/.gitignore

@@ -0,0 +1,12 @@
+/*
+!/bin
+!/lib
+!/test
+!/.gitignore
+!/.rubocop.yml
+!/CODE_OF_CONDUCT.md
+!/execjs-pcruntime.gemspec
+!/Gemfile
+!/LICENSE.txt
+!/Rakefile
+!/README.md

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  NewCops: disable
+
+Metrics/MethodLength:
+  Max: 16
+
+require:
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shintaro.otsuka@st.inc. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in execjs-pcruntime.gemspec
+gemspec
+
+gem 'execjs', '~> 2.0'
+
+group :development do
+  gem 'rubocop', require: false
+  gem 'rubocop-minitest', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+end
+
+group :test do
+  gem 'minitest', '~> 5.0'
+  gem 'rake', '~> 10.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 White-Green
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# ExecJS::PCRuntime
+
+Accelerated ExecJS Runtime by launching Node.js Processes per Context, not per execution.
+
+inspired by [execjs-fastnode](https://github.com/jhawthorn/execjs-fastnode)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'execjs-pcruntime'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+## Usage
+
+Once installed, the Runtime will automatically be replaced.
+If you want to set it, you can use environment variable `EXECJS_RUNTIME=PCRuntime`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/execjs-pcruntime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Execjs::Pcruntime project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/execjs-pcruntime/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb', 'test/test_execjs.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'execjs/pcruntime'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/execjs-pcruntime.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'execjs/pcruntime/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'execjs-pcruntime'
+  spec.version       = Execjs::PCRuntime::VERSION
+  spec.authors       = ['White-Green']
+  spec.required_ruby_version = '>3.0.0'
+  spec.summary       = 'Fast ExecJS Runtime using Process as a Context.'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['source_code_uri'] = 'https://github.com/heyinc/execjs-pcruntime'
+    spec.metadata['rubygems_mfa_required'] = 'true'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+end

data/lib/execjs/pcruntime/context_process_runtime.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+require 'execjs/runtime'
+require 'tmpdir'
+require 'json'
+require 'net/protocol'
+require 'net/http'
+
+module ExecJS
+  module PCRuntime
+    # override ExecJS::Runtime
+    class ContextProcessRuntime < Runtime
+      # override ExecJS::Runtime::Context
+      class Context < Runtime::Context
+        # @param [String] runtime Instance of ContextProcessRuntime
+        # @param [String] source JavaScript source code that Runtime load at startup
+        # @param [any] options
+        def initialize(runtime, source = '', options = {})
+          super(runtime, source, options)
+
+          # @type [JSRuntimeHandle]
+          @runtime = runtime.create_runtime_handle
+
+          # load initial source to Context
+          @runtime.evaluate(source.encode('UTF-8'))
+        end
+
+        # override ExecJS::Runtime::Context#eval
+        # @param [String] source
+        # @param [any] _options
+        def eval(source, _options = {})
+          return unless /\S/.match?(source)
+
+          @runtime.evaluate("(#{source.encode('UTF-8')})")
+        end
+
+        # override ExecJS::Runtime::Context#exec
+        # @param [String] source
+        # @param [any] _options
+        def exec(source, _options = {})
+          @runtime.evaluate("(()=>{#{source.encode('UTF-8')}})()")
+        end
+
+        # override ExecJS::Runtime:Context#call
+        # @param [String] identifier
+        # @param [Array<_ToJson>] args
+        def call(identifier, *args)
+          @runtime.evaluate("(#{identifier}).apply(this, #{::JSON.generate(args)})")
+        end
+      end
+
+      # Handle of JavaScript Runtime
+      # launch Runtime by .new and finished on finalizer
+      class JSRuntimeHandle
+        # @param [Array<String>] binary Launch command for the node(or similar JavaScript Runtime) binary,
+        #     such as ['node'], ['deno', 'run'].
+        # @param [String] initial_source Path of .js Runtime loads at startup.
+        def initialize(binary, initial_source)
+          Dir::Tmpname.create 'execjs_pcruntime' do |path|
+            # Dir::Tmpname.create rescues Errno::EEXIST and retry block
+            # So, raise it if failed to create Process.
+            @runtime_pid = create_process(path, *binary, initial_source) || raise(Errno::EEXIST)
+            @socket_path = path
+          end
+          ObjectSpace.define_finalizer(self, self.class.finalizer(@runtime_pid))
+        end
+
+        # Evaluate JavaScript source code and return the result.
+        # @param [String] source JavaScript source code
+        # @return [object]
+        def evaluate(source)
+          post_request(@socket_path, '/eval', 'text/javascript', source)
+        end
+
+        # Create a procedure to kill the Process that has specified pid.
+        # It used as the finalizer of JSRuntimeHandle.
+        # @param [Integer] pid
+        def self.finalizer(pid)
+          proc do
+            err = kill_process(pid)
+            warn err.full_message unless err.nil?
+          end
+        end
+
+        # Kill the Process that has specified pid.
+        # If raised error then return it.
+        # @param [Integer] pid
+        # @return [StandardError, nil] return error iff an error is raised
+        def self.kill_process(pid)
+          Process.kill(:KILL, pid)
+          nil
+        rescue StandardError => e
+          e
+        end
+
+        private
+
+        # Attempt to execute the block several times, spacing out the attempts over a certain period.
+        # @param [Integer] times maximum number of attempts
+        # @yieldreturn [Boolean] true iff succeed execute
+        # @return [Boolean] true if the block attempt is successful, false if the maximum number of attempts is reached
+        def delayed_retries(times)
+          while times.positive?
+            return true if yield
+
+            sleep 0.05
+            times -= 1
+          end
+          false
+        end
+
+        # Launch JavaScript Runtime Process.
+        # @param [String] socket_path path used for the UNIX domain socket
+        #     it is passed at Runtime through the PORT environment variable
+        # @param [Array<String>] command command to start the Runtime such as ['node', 'runner.js']
+        # @return [Integer, nil] if the Process successfully launches, return its pid. if it fails return nil
+        def create_process(socket_path, *command)
+          pid = Process.spawn({ 'PORT' => socket_path }, *command)
+
+          unless delayed_retries(20) { File.exist?(socket_path) }
+            self.class.kill_process(pid)
+            return nil
+          end
+
+          begin
+            post_request(socket_path, '/')
+          rescue StandardError
+            self.class.kill_process(pid)
+            return nil
+          end
+          pid
+        end
+
+        # Create a socket connected to the Process.
+        # @return [Net::BufferedIO]
+        def create_socket(socket_path)
+          Net::BufferedIO.new(UNIXSocket.new(socket_path))
+        end
+
+        # Send request to JavaScript Runtime.
+        # @param [String] socket_path path of the UNIX domain socket
+        # @param [String] path Path on HTTP request such as '/eval'
+        # @param [String, nil] content_type Content-type of body
+        # @param [String, nil] body body of HTTP request
+        # @return [object?]
+        # There seems to be no particular meaning in dividing it any further and it's a simple sequential process
+        # so suppressing lint errors.
+        # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+        def post_request(socket_path, path, content_type = nil, body = nil)
+          socket = create_socket socket_path
+
+          # timeout occurred during the test
+          socket.read_timeout *= 100
+          socket.write_timeout *= 100
+
+          request = Net::HTTP::Post.new(path)
+          request['Connection'] = 'close'
+          unless content_type.nil?
+            request['Content-Type'] = content_type
+            request.body = body
+          end
+
+          # Net::HTTPGenericRequest#exec
+          # I'd rather not use it as it's marked for 'internal use only', but I can't find a good alternative.
+          request.exec(socket, '1.1', path)
+
+          # Adopting RuboCop's proposal changes the operation and causes an infinite loop
+          # rubocop:disable Lint/Loop
+          begin
+            response = Net::HTTPResponse.read_new(socket)
+          end while response.is_a?(Net::HTTPContinue)
+          # rubocop:enable Lint/Loop
+          response.reading_body(socket, request.response_body_permitted?) {}
+
+          if response.code == '200'
+            result = response.body
+            ::JSON.parse(response.body, create_additions: false) if /\S/.match?(result)
+          else
+            message, stack = response.body.split "\0"
+            error_class = /SyntaxError:/.match?(message) ? RuntimeError : ProgramError
+            error = error_class.new(message)
+            error.set_backtrace(stack)
+            raise error
+          end
+        end
+        # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+      end
+
+      attr_reader :name
+
+      # @param [String] name name of Runtime
+      # @param [Array<String>] command candidates for JavaScript Runtime commands such as ['deno run', 'node']
+      # @param [String] runner_path path of the .js file to run in the Runtime
+      def initialize(name, command, runner_path = File.expand_path('runner.js', __dir__), deprecated: false)
+        super()
+        @name = name
+        @command = command
+        @runner_path = runner_path
+        @binary = nil
+        @deprecated = deprecated
+      end
+
+      # override ExecJS::Runtime#available?
+      def available?
+        require 'json'
+        binary ? true : false
+      end
+
+      # override ExecJS::Runtime#deprecated?
+      def deprecated?
+        @deprecated
+      end
+
+      # Launch JavaScript Runtime and return its handle.
+      # @return [JSRuntimeHandle]
+      def create_runtime_handle
+        JSRuntimeHandle.new(binary, @runner_path)
+      end
+
+      private
+
+      # Return the launch command for the JavaScript Runtime.
+      # @return [Array<String>]
+      def binary
+        @binary ||= which(@command)
+      end
+
+      # Locate a executable file in the path.
+      # @param [Array<String>] commands candidates for commands such as ['deno run', 'node']
+      # @return [Array<String>] the absolute path of the command and command-line arguments
+      #     e.g. ["/the/absolute/path/to/deno", "run"]
+      def which(commands)
+        commands.each do |command|
+          command, *args = split_command_string command
+          command = search_executable_path command
+          return [command] + args unless command.nil?
+        end
+      end
+
+      # Search for absolute path of the executable file from the command.
+      # @param [String] command
+      # @return [String, nil] the absolute path of the command, or nil if not found
+      # It seems that further method splitting might actually make it harder to read, so suppressing
+      # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      def search_executable_path(command)
+        @extensions ||= ExecJS.windows? ? ENV['PATHEXT'].split(File::PATH_SEPARATOR) + [''] : ['']
+        @path ||= ENV['PATH'].split(File::PATH_SEPARATOR) + ['']
+        @path.each do |base_path|
+          @extensions.each do |extension|
+            executable_path = base_path == '' ? command + extension : File.join(base_path, command + extension)
+            return executable_path if File.executable?(executable_path) && File.exist?(executable_path)
+          end
+        end
+        nil
+      end
+      # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+
+      # Split command string
+      #   split_command_string "deno run" # ["deno", "run"]
+      # @param [String] command command string
+      # @return [Array<String>] array split from the command string
+      def split_command_string(command)
+        regex = /([^\s"']+)|"([^"]+)"|'([^']+)'(?:\s+|\s*\Z)/
+        command.scan(regex).flatten.compact
+      end
+    end
+  end
+end

data/lib/execjs/pcruntime/runner.js

@@ -0,0 +1,38 @@
+const vm = require('vm');
+let context = vm.createContext();
+vm.runInContext("delete console;", context);
+
+const http = require('http');
+const server = http.createServer(function (req, res) {
+    switch (req.url) {
+        case '/':
+            res.statusCode = 200;
+            res.end();
+            break;
+        case '/eval':
+            let allData = '';
+            req.on('data', (data) => allData += data);
+            req.on('end', () => {
+                try {
+                    const result = vm.runInContext(allData, context, "(execjs)");
+                    res.statusCode = 200;
+                    res.setHeader('Content-Type', 'application/json');
+                    res.end(JSON.stringify(result), 'utf-8');
+                } catch (e) {
+                    res.statusCode = 500;
+                    res.setHeader('Content-Type', 'text/plain');
+                    res.end(e.toString() + "\0" + (e.stack || ""));
+                }
+            });
+            break;
+        case '/exit':
+            process.exit(0);
+            break;
+        default:
+            console.log("Unknown Path");
+            break;
+    }
+});
+
+const port = process.env.PORT || 3001;
+server.listen(port);

data/lib/execjs/pcruntime/runtimes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'execjs/pcruntime/version'
+require 'execjs/pcruntime/context_process_runtime'
+require 'execjs/runtimes'
+
+module ExecJS
+  # extends ExecJS::Runtimes
+  module Runtimes
+    PCRuntime = PCRuntime::ContextProcessRuntime.new(
+      'Node.js (V8) Process as Context',
+      %w[nodejs node]
+    )
+
+    runtimes.unshift(PCRuntime)
+  end
+end

data/lib/execjs/pcruntime/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Execjs
+  module PCRuntime
+    VERSION = '0.1.0'
+  end
+end

data/lib/execjs/pcruntime.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'execjs/pcruntime/version'
+require 'execjs/pcruntime/runtimes'
+require 'execjs'
+ExecJS.runtime = ExecJS::Runtimes.autodetect

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: execjs-pcruntime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- White-Green
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- execjs-pcruntime.gemspec
+- lib/execjs/pcruntime.rb
+- lib/execjs/pcruntime/context_process_runtime.rb
+- lib/execjs/pcruntime/runner.js
+- lib/execjs/pcruntime/runtimes.rb
+- lib/execjs/pcruntime/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/heyinc/execjs-pcruntime
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Fast ExecJS Runtime using Process as a Context.
+test_files: []