vernier 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73ae72f3ced0043f71cc0fd1f8b5c829b57d6d4c7c39536a6564c8bcb654dfbd
-  data.tar.gz: c392fff41de6efe80ed825087ed92760493345aa04a18b288bae8d5afa166b88
+  metadata.gz: faf587f758e0b9a68adc377bf27c0f35eb0605703b088e3e122f969f513c864d
+  data.tar.gz: 6cbefbfa78fb3ef1e92c7cfdd5ba0dd43f59b1f63cce6583fe18f4e667fd61db
 SHA512:
-  metadata.gz: e8c95c63b4836d7a160003a7ad2be68c54d135ba34ad663246b563f4e2f5954351a0e8c1e47ee4392b27a980cba8d395b607b1093487305abbcb21dd5467d5f1
-  data.tar.gz: 3a516ab9a0f52dfeaeecf8332c92cd63e160c9e51478ac6e8f30b846e1319d16b5132a8e7a6007ca582c46f3d6bdd8d96a88b9c686fb208de97779646f070a38
+  metadata.gz: 402ce92fbe0f408906fe368e0e2edc637dd68f08476a690877166cb1628068fd6bbfd11878d625276e8f3f785c20adc49ef19494d9e81162d201930b4c64c81f
+  data.tar.gz: 8b7d6c687873ed991b23a508231471b445d6960b47bac2045f1f9eee9f5d82584490a0278f2344d0001e3f5367fffcdfc29fbc284bed448c4155e4381aa26292

data/README.md

@@ -30,7 +30,7 @@ gem "vernier", "~> 1.0"
 
 ## Usage
 
-The output can be viewed in the web app at https://vernier.prof, locally using the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (both lightly customized versions of the firefox profiler frontend, which profiles are also compatible with) or by using the `verrnier view` command in the CLI.
+The output can be viewed in the web app at https://vernier.prof, locally using the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (both lightly customized versions of the firefox profiler frontend, which profiles are also compatible with) or by using the `vernier view` command in the CLI.
 
 - **Flame Graph**: Shows proportionally how much time is spent within particular stack frames. Frames are grouped together, which means that x-axis / left-to-right order is not meaningful.
 - **Stack Chart**: Shows the stack at each sample with the x-axis representing time and can be read left-to-right.

data/ext/vernier/vernier.cc

@@ -30,6 +30,7 @@
 #include "vernier.hh"
 
 #include "ruby/ruby.h"
+#include "ruby/encoding.h"
 #include "ruby/debug.h"
 #include "ruby/thread.h"
 
@@ -746,7 +747,20 @@ StackTable::stack_table_func_name(VALUE self, VALUE idxval) {
     } else {
         const auto &func_info = table[idx];
         const std::string &label = func_info.label;
-        return rb_interned_str(label.c_str(), label.length());
+
+        // Ruby constants are in an arbitrary (ASCII compatible) encoding and
+        // method names are in an arbitrary (ASCII compatible) encoding. These
+        // can be mixed in the same program.
+        //
+        // However, by this point we've lost the chain of what the correct
+        // encoding should be. Oops!
+        //
+        // Instead we'll just guess at UTF-8 which should satisfy most. It won't
+        // necessarily be valid but that can be scrubbed on the Ruby side.
+        //
+        // In the future we might keep class and method name separate for
+        // longer, preserve encodings, and defer formatting to the Ruby side.
+        return rb_enc_interned_str(label.c_str(), label.length(), rb_utf8_encoding());
     }
 }
 
@@ -761,7 +775,11 @@ StackTable::stack_table_func_filename(VALUE self, VALUE idxval) {
     } else {
         const auto &func_info = table[idx];
         const std::string &filename = func_info.file;
-        return rb_interned_str(filename.c_str(), filename.length());
+
+        // Technically filesystems are binary and then Ruby interprets that as
+        // default_external encoding. But to keep things simple for now we are
+        // going to assume UTF-8.
+        return rb_enc_interned_str(filename.c_str(), filename.length(), rb_utf8_encoding());
     }
 }
 
@@ -1397,11 +1415,13 @@ class CustomCollector : public BaseCollector {
         VALUE threads = rb_hash_new();
         rb_ivar_set(result, rb_intern("@threads"), threads);
 
-	VALUE thread_hash = rb_hash_new();
-	samples.write_result(thread_hash);
+        VALUE thread_hash = rb_hash_new();
+        samples.write_result(thread_hash);
 
-	rb_hash_aset(threads, ULL2NUM(0), thread_hash);
-	rb_hash_aset(thread_hash, sym("tid"), ULL2NUM(0));
+        rb_hash_aset(threads, ULL2NUM(0), thread_hash);
+        rb_hash_aset(thread_hash, sym("tid"), ULL2NUM(0));
+        rb_hash_aset(thread_hash, sym("name"), rb_str_new_cstr("custom"));
+        rb_hash_aset(thread_hash, sym("started_at"), ULL2NUM(started_at.nanoseconds()));
 
         return result;
     }
@@ -2001,6 +2021,7 @@ static const rb_data_type_t rb_collector_type = {
         //.dmemsize = rb_collector_memsize,
         .dmark = collector_mark,
         .dfree = collector_free,
+        .dsize = NULL,
         .dcompact = collector_compact,
     },
 };

data/lib/vernier/output/firefox.rb

@@ -525,7 +525,23 @@ module Vernier
         end
 
         def string_table
-          @strings.keys
+          @strings.keys.map do |string|
+            if string.ascii_only?
+              string
+            elsif string.encoding == Encoding::UTF_8
+              if string.valid_encoding?
+                string
+              else
+                string.scrub
+              end
+            elsif string.encoding == Encoding::BINARY
+              # TODO: We might want to guess UTF-8 and escape the binary more explicitly
+              string.dup.force_encoding("UTF-8").scrub
+            else
+              # TODO: ideally we should attempt to properly re-encode here, but right now I think this is dead code
+              string.dup.force_encoding("UTF-8").scrub
+            end
+          end
         end
 
         private

data/lib/vernier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vernier
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vernier
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: A next generation CRuby profiler