async-debug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e6c031c862d32fc655259441e30c747221067b52216a547c050b177c12325c0
+  data.tar.gz: 12b3dde7ba214e9c8422a81f5c4d029d5c6132648e02f34d3d6a8326c9d921de
+SHA512:
+  metadata.gz: 22e3d9c1719e58ccc1eb9e07c663e2bf376b933f7214abea83d32cf4a08be9de60888073b6dd14575ac84ca174c8ea002cafeec4cd58ccef42d9390155faa94d
+  data.tar.gz: 858ef197a2e6ddf3395cf5f37de67a01ef17d290440d2b88ebd50bb55a31b31782a74689e41653ebfe360d0f41005b5c1ba7e9d5288ebe18381390bf512152d5

data/lib/async/debug.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative "debug/version"
+
+require 'utopia/localization'
+require 'falcon/endpoint'
+require 'falcon/server'
+require 'utopia/setup'
+
+module Async
+	module Debug
+		# Start the debugger.
+		#
+		# @parameter endpoint [Async::IO::Endpoint] The endpoint to bind to. Defaults to <https://localhost:9090>.
+		def self.serve(endpoint: nil)
+			endpoint ||= Falcon::Endpoint.parse("https://localhost:9090")
+			builder = Rack::Builder.new
+			self.call(builder)
+			app = builder.to_app
+			middleware = Falcon::Server.middleware(app)
+			
+			Async(transient: true, annotation: self) do
+				Console.logger.info(self, "Live debugger binding to #{endpoint}...")
+				Async::HTTP::Server.new(middleware, endpoint).run
+			end
+		end
+		
+		# The root directory of the web application files.
+		SITE_ROOT = File.expand_path("../..", __dir__)
+		
+		# The root directory for the utopia middleware.
+		PAGES_ROOT = File.expand_path("pages", SITE_ROOT)
+		
+		# The root directory for static assets.
+		PUBLIC_ROOT = File.expand_path("public", SITE_ROOT)
+		
+		# Appends a project application to the rack builder.
+		#
+		# @parameter builder [Rack::Builder]
+		# @parameter root [String] The file-system root path of the project/gem.
+		# @parameter locales [Array(String)] an array of locales to support, e.g. `['en', 'ja']`.
+		def self.call(builder, root = Dir.pwd, locales: nil, utopia: Utopia.setup)
+			# We want to propate exceptions up when running tests:
+			builder.use Rack::ShowExceptions
+			
+			builder.use Utopia::Static, root: PUBLIC_ROOT
+			
+			builder.use Utopia::Redirection::Rewrite, {
+				'/' => '/index'
+			}
+			
+			builder.use Utopia::Redirection::DirectoryIndex
+			
+			builder.use Utopia::Redirection::Errors, {
+				404 => '/errors/file-not-found'
+			}
+			
+			if locales
+				builder.use Utopia::Localization,
+					default_locale: locales.first,
+					locales: locales
+			end
+			
+			builder.use Utopia::Controller, root: PAGES_ROOT
+			builder.use Utopia::Content, root: PAGES_ROOT
+			
+			builder.run lambda { |env| [404, {}, []] }
+		end
+	end
+end

data/lib/async/debug/reactor_view.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'live'
+
+module Async
+	module Debug
+		class ReactorView < Live::View
+			def initialize(id, **data)
+				super
+				
+				@update = nil
+				@top = Async::Task.current.reactor
+			end
+			
+			def bind(page)
+				super(page)
+				
+				@update = Async do |task|
+					while true
+						task.sleep(1.0/10.0)
+						self.replace!
+					end
+				end
+			end
+			
+			def close
+				@update.stop
+				
+				super
+			end
+			
+			def handle(event, details)
+				replace!
+			end
+			
+			def render_node(builder, node = @top)
+				klass = []
+				title = []
+				
+				if node.respond_to?(:status)
+					klass << node.status
+				end
+				
+				if node.transient?
+					klass << "transient"
+				end
+				
+				if node.respond_to?(:backtrace)
+					if backtrace = node.backtrace
+						title = backtrace.first(8)
+					end
+				end
+				
+				builder.inline :span, class: klass.join(' '), title: title.join("\n") do
+					text = node.annotation || "#{node.class} 0x#{node.object_id.to_s(16)}"
+					builder.text(text)
+				end
+				
+				if node.children
+					builder.tag :ul do
+						node.children.each do |child|
+							builder.inline :li do
+								render_node(builder, child)
+							end
+						end
+					end
+				end
+			end
+			
+			def render(builder)
+				builder.tag :div, class: 'tree' do
+					builder.tag :ul do
+						builder.inline :li do
+							render_node(builder)
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/debug/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Async
+	module Debug
+		VERSION = "0.1.0"
+	end
+end

data/pages/_heading.xnode

@@ -0,0 +1,2 @@
+<?r document.attributes[:title] ||= content ?>
+<h1><utopia:content/></h1>

data/pages/_page.xnode

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<?r response.cache! ?>
+		
+		<?r if title = self[:title] ?>
+			<title>#{title.gsub(/<.*?>/, "")}</title>
+		<?r else ?>
+			<title>Async Debug</title>
+		<?r end ?>
+		
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		
+		<link rel="icon" type="image/png" href="/_static/icon.png" />
+		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
+		
+		<script src="/_components/jquery/jquery.min.js"></script>
+		<script src="/_components/jquery-syntax/jquery.syntax.min.js"></script>
+		
+		<script src="/_static/links.js"></script>
+		
+		<script src="/_components/morphdom/morphdom-umd.js"></script>
+		<script src="/_components/@socketry/live/live.js"></script>
+		
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+
+	<body>
+		<content:header />
+		
+		<main>
+			<utopia:content/>
+		</main>
+	</body>
+</html>

data/pages/controller.rb

@@ -0,0 +1,21 @@
+
+require 'async/websocket/adapters/rack'
+require_relative '../lib/async/debug/reactor_view'
+
+prepend Actions
+
+RESOLVER = Live::Resolver.allow(Async::Debug::ReactorView)
+
+on 'live' do |request|
+	Console.logger.info("Incoming live connection...")
+	
+	adapter = Async::WebSocket::Adapters::Rack.open(request.env) do |connection|
+		Live::Page.new(RESOLVER).run(connection)
+	end
+	
+	respond?(adapter) or fail!
+end
+
+on 'index' do
+	@tag = Async::Debug::ReactorView.new('reactor-view')
+end

data/pages/errors/exception.xnode

@@ -0,0 +1,5 @@
+<content:page>
+	<content:heading>Exception</content:heading>
+	
+	<p>It seems like something didn't quite work out as expected!</p>
+</content:page>

data/pages/errors/file-not-found.xnode

@@ -0,0 +1,5 @@
+<content:page>
+	<content:heading>File Not Found</content:heading>
+	
+	<p>The file you requested is unfortunately not available at this time!</p>
+</content:page>

data/pages/index.xnode

@@ -0,0 +1,3 @@
+<content:page title="Reactor Overview">
+	#{attributes[:tag].to_html}
+</content:page>

data/pages/links.yaml

@@ -0,0 +1,4 @@
+index:
+  title: Async Debug
+errors:
+  display: false

data/public/_components/@socketry/live/live.js

@@ -0,0 +1,157 @@
+var live = (function () {
+	'use strict';
+
+	class Live {
+		constructor(document, url) {
+			this.document = document;
+			
+			this.url = url;
+			this.events = [];
+			
+			this.failures = 0;
+			
+			// Track visibility state and connect if required:
+			this.document.addEventListener("visibilitychange", () => this.handleVisibilityChange());
+			this.handleVisibilityChange();
+		}
+		
+		connect() {
+			if (this.server) return;
+			
+			let server = this.server = new WebSocket(this.url.href);
+			
+			server.onopen = () => {
+				this.failures = 0;
+				this.attach();
+			};
+			
+			server.onmessage = (message) => {
+				const [name, _arguments] = JSON.parse(message.data);
+				
+				this[name](..._arguments);
+			};
+			
+			server.onerror = () => {
+				this.failures += 1;
+			};
+			
+			// The remote end has disconnected:
+			server.onclose = () => {
+				this.server = null;
+				
+				// We need a minimum delay otherwise this can end up immediately invoking the callback:
+				let delay = 100 * (this.failures + 1) ** 2;
+				setTimeout(() => this.connect(), delay > 60000 ? 60000 : delay);
+			};
+		}
+		
+		disconnect() {
+			if (this.server) {
+				this.server.close();
+				this.server = null;
+			}
+		}
+		
+		createDocumentFragment(html) {
+			return this.document.createRange().createContextualFragment(html);
+		}
+		
+		// These methods are designed for RPC.
+		replace(id, html) {
+			let element = document.getElementById(id);
+			
+			morphdom(element, html);
+		}
+		
+		prepend(id, html) {
+			let element = document.getElementById(id);
+			let fragment = this.createDocumentFragment(html);
+			
+			element.prepend(fragment);
+		}
+		
+		append(id, html) {
+			let element = document.getElementById(id);
+			let fragment = this.createDocumentFragment(html);
+			
+			element.append(fragment);
+		}
+		
+		dispatch(id, type, details) {
+			let element = document.getElementById(id);
+			
+			element.dispatchEvent(
+				new CustomEvent(type, details)
+			);
+		}
+		
+		trigger(id, event) {
+			this.connect();
+			
+			this.send(
+				JSON.stringify({id: id, event: event})
+			);
+		}
+		
+		forward(id, event, details) {
+			this.trigger(id, {type: event.type, details: details});
+		}
+		
+		send(message) {
+			try {
+				this.server.send(message);
+			} catch (error) {
+				this.events.push(message);
+			}
+		}
+		
+		flush() {
+			if (this.events.length === 0) return;
+			
+			let events = this.events;
+			this.events = [];
+			
+			for (var event of events) {
+				this.send(event);
+			}
+		}
+		
+		bind(elements) {
+			for (var element of elements) {
+				this.send(JSON.stringify({bind: element.id, data: element.dataset}));
+			}
+		}
+		
+		bindElementsByClassName(selector = 'live') {
+			this.bind(
+				this.document.getElementsByClassName(selector)
+			);
+			
+			this.flush();
+		}
+		
+		handleVisibilityChange() {
+			if (document.hidden) {
+				this.disconnect();
+			} else {
+				this.connect();
+			}
+		}
+		
+		attach() {
+			if (this.document.readyState === 'loading') {
+				this.document.addEventListener('DOMContentLoaded', () => this.bindElementsByClassName());
+			} else {
+				this.bindElementsByClassName();
+			}
+		}
+	}
+
+	let url = new URL('live', location.href);
+	url.protocol = url.protocol.replace('http', 'ws');
+
+	let live = new Live(document, url);
+
+	return live;
+
+}());