pboling / rack-insight Goto Github PK

View Code? Open in Web Editor NEW

This project forked from lrdesign/logical-insight

152.0 152.0 22.0 1.26 MB

Debugging toolbar for Rack applications implemented as middleware

Home Page: http://railsbling.com/retired_projects/rack-insight/

License: MIT License

Ruby 82.31% HTML 10.81% JavaScript 4.64% CSS 2.23%

rack-insight's Introduction

Looking for a Rails Developer?

The Rails Foudnation has just launched the Official Job Board for Ruby On Rails!

Here are the latest jobs posted there as of < 60 minutes ago:

Signup now!

I Am Using GitHub Under Protest

Github decided to sponsor me, because they rely on my tools.

In spite of that, I'm (partially) leaving. Why? I certainly do not have the spare-time to move hundreds of projects to a new home... but I'm getting started. I'll enumerate some of the reasons below, but first, where am I, and some of the organizations I control, going?

pboling @ 🧪 GitLab
rubocop-lts @ 🧪 GitLab
oauth-xx @ 🧪 GitLab (chosen amongst all options, including staying at GitHub, by a majority of the dozens of respondents)
pboling @ 🧊 CodeBerg
galtzo @ 🛖 SourceHut

Reasons to Leave GitHub

A recent proposal to extend Github-flavored Markdown (ref)
- Literally breaks regular markdown syntax of links in headings.
- English-only
- Incompatible with Semantic HTML (POSH) (by abusing the blockquote tag; this also raises issues of accessibility)
  - Note: Latest version has switched to a <div> treamtment, which is just as bad because now Markdown's ">" with admonitions is no longer a blockquote, thus breaking Markdown. The number of bugs caused by this uncountable. A new bug is reported nearly daily on the thread.
- Incompatible with existing Markdown standards proposals
- Ignores the community-centered approach to extending Markdown, which, ironically, Github started
- Contributes to vendor lock-in.
- Will force countless volunteer FOSS developers to waste time adding compatibility to their projects that use Markdown and attempt to support GFM.
More than 2 years of ignoring requests to add an important feature (allow-failure) to Github Actions (ref, ref). When not ignoring, Github is completely misunderstanding the feature. How are those building Github Actions so deeply unfamiliar with core features of competing CI platforms?
Latest iteration of Achievements was bad.
Github Copilot. Much has been written about this, and I won't repeat it all here. Making money by abusing the licenses of open source code, without recognition, compensation, or respect to the developers, the craft, or the ideals of open source is nauseating.

What about community?

I am interested in people's thoughts on where to go next. Community involvement matters for open source projects, and I have dozens of them that could be affected, the biggest being oauth and oauth2 Ruby gems.

Regarding fragmentation, hopefully it will be resolved by federation, which is to source forges (like Github) what git was to version control (i.e. makes it distributed, at least in theory).

It looks like Gitea, Codeberg and Hostea will join the fediverse soon, within a year, and there are projects that will integrate Github with the fediverse as well (i.e. federate Github commits, PRs, issues, etc).

I'm interested in your thoughts, leave a comment on the blog post!

Recent Releases

Recent Blog posts

Contributions

🧒 How it started

A cheeky me holding a baby black caiman, Amazon River, Brazil, June 24, 1997, shortly after completing my first programming course - Pascal. The black caiman, a baby specimen of the family Alligatoridae and order Crocodilia, was unharmed, and released back to the water, where it promptly continued following its mother. Full grown they are among the largest alligators and crocodiles in the world.

How it's going

🦷 I'm putting more of my focus on FLOSS efforts (of myself and others)! and from
👷 I build big things and small things out of tiny bits.
✨ Recently created rubocop-lts for library maintainer happiness 👩‍❤️‍👩.
🔭 I’m working on finishing the migration away from TravisCI to modern CI tools.
🌱 I’m learning Svelte & SvelteKit, with Lucia, Drizzle, Zod, Inlang Paraglide, Skeleton, Tailwind, Typescript, and so many more cool tools.
👯 Preparing next release of seed_migrations and oauth gems!
🤔 I’ve moved my suite of Resque plugins to the Resque org!
📫 How to reach me
😄 Pronouns: He/Him
🗨️ I speak 3 languages fluently, and for a 4th I'm learning Bahasa Indonesia!
👷‍♂️ I help refugees and ex-refugees in Ghana🇬🇭 and Liberia🇱🇷, respectively, through Hope For Tomorrow, a Liberian NGO. DM me if interested in knowing more.

🛠️ My Dev Tools:

💼 Career

The list is long, even in summary, see my LinkedIn.

🧻 Current Roles

CTO | Fisecal
Principal Cloud Engineer | Vital Connect
Full Stack Instructor | Michigan State University Bootcamp
FOSS Blogger | RailsBling
FOSS Author | RubyGems
FLOSS Maintainer | Tidelift Enterprise OSS
Researcher | WordTree Foundation
Member-worker | Bed of Roses Club
Advisor | Hope For Tomorrow (Liberian NGO)

rack-insight's People

Contributors

Stargazers

Watchers

rack-insight's Issues

Extreme slowdown

I did installed current rack-insight into a Spree Rails 3.2.9 based project and when the toolbar is enabled the page load is about 15 - 20 times slower so it becomes almost unusable.

Log is flooded with the following messages:
Starting event: ActiveSupport::BufferedLogger instance add
Probe chain for: ActiveSupport::BufferedLogger instance add:
Rack::Insight::LogPanel

Is this a known issue ? When using rails-footnotes f.E., the load/rendering times are only 2 times slower.

Recent Rails 3.x compatibility ?

Hi,

just tried to setup rack-insight in a recent Rails 3.2.17 however it does not appear.
Gem is properly installed, middleware set in config/environments/development.rb, no error in rails log.

"Any environment with Rack::Insight loaded will have a link to "Rack::Insight" added to as the last child of <body> to normal responses."

It simply does not get inserted after a successful page render (ie. 200 response to GET request).

Feature: Support Rails 2.3.X

I installed rack-insight in a Rails 2.3.11 application and put the following in my development.rb config:

config.middleware.use "Rack::Insight::App", :secret_key => "whatever"

When I run my server and try to access an endpoint, I get the following error:

Tue Oct 02 00:02:31 +0000 2012: Read error: #<NoMethodError: undefined method `_probe' for #<Rack::Insight::Instrumentation::ProbeDefinition:0x112632550>>
/Users/ryangreenberg/.rbenv/versions/ree-1.8.7-2010.02/lib/ruby/gems/1.8/gems/rack-insight-0.5.23/lib/rack/insight/panel.rb:122:in `send'
/Users/ryangreenberg/.rbenv/versions/ree-1.8.7-2010.02/lib/ruby/gems/1.8/gems/rack-insight-0.5.23/lib/rack/insight/panel.rb:122:in `initialize'
/Users/ryangreenberg/.rbenv/versions/ree-1.8.7-2010.02/lib/ruby/gems/1.8/gems/rack-insight-0.5.23/lib/rack/insight/instrumentation/package-definition.rb:54:

When I manually specify the panels and remove some of them I am able to get a different error.

bad use of duplicate id on elements

For example using request_id_menu on several select elements does not work in modern browsers. And doing $('#request_id_menu') only selects one of them causing the dropdowns to not function most of the time. IDs on HTML elements are supposed to be unique across the entire page.. If you want multiple elements to be referenced you should use a class. e.g.

$('#rack-insight .request_id_menu')

instead

$('#request_id_menu')

Feature: Disable the overlaid button

I would like to be able to disable the overlaid button, so I can make my own button in the nav bar. Also, the Rack::Bug bookmarklet would be a nice thing to have back. Thanks!

Bug in a gemspec

Rack-insight fails to install because latest commit introduced a bug - calling unexisting .files method on Array instance, an object returned with Dir.[] class method.

https://github.com/pboling/rack-insight/blob/master/rack-insight.gemspec#L18

Undefined method Rails 4...

rails 4.0
ruby 2.0.0-p247
rack-insight 0.5.26

NoMethodError at /
undefined method `any?' for #ActionDispatch::Request::Session:0x007fc6158c7390

lib/rack/insight/panels/request_variables_panel.rb:8

4     def after(env,status,headers,body)
5       sections = {}
6       sections["GET"] = sort(@request.GET) if @request.GET.any?
7       sections["POST"] = sort(@request.POST) if @request.POST.any?
8       sections["Session"] = sort(@request.env["rack.session"]) if @request.env["rack.session"] && @request.env["rack.session"].any?
9       sections["Cookies"] = sort(@request.env["rack.request.cookie_hash"]) if @request.env["rack.request.cookie_hash"] && @request.env["rack.request.cookie_hash"].any?
10      server, rack = split_and_filter_env(@env)
11      sections["SERVER VARIABLES"] = sort(server)
12      sections["Rack ENV"] = sort(rack)

Templates panel does not display template names

I only see times, not the name of the actual templates. See: http://www.evernote.com/shard/s2/sh/20815967-7539-430b-93cc-18ab30165766/184297887ef9f372baf58b129e3b9881

This is under Rails 3.2.8.

Allow toggle via bookmarklet

This was a feature of rack-bug, and is currently non-functional in rack-insight.

JQuery.live deprecation broke the bar.

<Uncaught TypeError: Object [object Object] has no method 'live' insight.js:77
(anonymous function) insight.js:77
fire jquery.js:1038
self.fireWith jquery.js:1149
jQuery.extend.ready jquery.js:434
completed

JQuery.live is deprecated in 1.7 and removed in 1.9 (according to http://api.jquery.com/category/version/1.9/). This issue kills all interactivity with the bar.

JQuery wrote up some of the changes here. http://jquery.com/upgrade-guide/1.9/#live-removed. Apologies if this is the incorrect fork: following who took over this from Rack::Bug is a bit confusing (and thanks for maintaining it!)

SQLite3::IOException disk I/O error - on new install in Rails 4

After installing rack insight and setting up development.rb as per instructions I get this error. I can see that the rack-insight.sqlite is created in my app root. And even after restarting the server twice I still get the above exception on any page load.

I tried providing a different :database_path with out success.

Password is ignored to enable toolbar

Update:
I'm sorry, mistaken secret_key (a hash source) with password option. Forget the report bellow.

Hi,

just figured out although I do have set secret_key in config/environments/development.rb

# Rack-Insight
 config.middleware.use "Rack::Insight::App",
   secret_key: "mypassword"

authorization is completely ignored. If I do invoke secret key dialog I can enter whatever mix of chars or even leave blank but password is accepted and toolbar rendered.

No insight bar showing on rails 4

Nothing is being injected into the html. I add the gem (added master from git after no luck on rubygems) and used the middle ware. Navigating to a page (after restarting server) does not show anything. Thanks for this gem. Hoping to use rack-insight soon!

Support ajax calls

If your page has remote: true, or ajax calls, that information is not shown.

rack-insight fails in Sinatra

Running rack-insight as a Sinatra middleware yields the following error:

undefined method `present?' for body
file: enable-button.rb location: call line: 16

Wondering if I'm doing something wrong or if it's a bug.
Cheers,

Feature: Support Rack apps mounted within other Rack apps

Hi, please consider the situation when you are building Sinatra based app which will be later mounted on some sub-uri, the usual case "/admin". The requests for necessary files will end up in totaly wrong rack app. I think this could be easily solved by analyzing request.script_name as Sinatra does.

Support Asset Pipeline with serve_static_assets = false and asset host not the same as rails host

Rack::Bug runs fine on dev, but I get /__insight__/bookmarklet.js 404 (Not Found) on staging.

This is because of the following settings:

asset pipeline is turned on.
serve_static_assets is turned off.
asset host not the same as rails host.

Feature: Add config option to turn off database use

Hi,

I was wondering if there's a way of turning off the use of the SQLite database. I'll most likely be using this for additional information in an environment which has multiple servers and we won't care about the historical results that are being stored (seems like unnecessary overhead).

Is this possible?

Error in enable-button.rb when body is instance of Rack::BodyProxy (Spree Commerce)

Adding Rack::Insight makes a fresh install of Spree error.

As @phoenixek12 mentioned on 71226db, Rack::BodyProxy does not implement empty?.

undefined method `empty?' for #<ActionDispatch::Response:0x007fd073d6a8a8>
rack (1.5.2) lib/rack/body_proxy.rb:36:in `method_missing'
rack-insight (0.5.30) lib/rack/insight/enable-button.rb:21:in `call'
rack-insight (0.5.30) lib/rack/insight/app.rb:62:in `call'