google-cloud-debugger 0.36.1 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 921f18f01a2f47aceacfc85fc095b82f2328f8124799e5e81c41d8096ec218a2
-  data.tar.gz: 85a3367b71597fb4aadbd60b86a33745c087583b6029b14e885ab21ae6f8a556
+  metadata.gz: 6641a7f5f24131e179ea351efa4aa2e43950f3baa38f86c63b1bf61c50d759fc
+  data.tar.gz: e383ad2653c833c28698717bc767b3cb00041214022881c2665e2e0833dbfa4c
 SHA512:
-  metadata.gz: e07cc48e96607ba0b8d8b154dde85fe2592aad0bbed831243d79d8e34731886ba21ad9009cc9720e1398d357e6065f2219ded59178cd1745ae6d4b8f537b02db
-  data.tar.gz: 5327a356cda4a0ece5fa0114983244300d690227b48746660e09db2b8be70807329d6b5e256696b327ca60bc64e215624c4fee552571121268598b81e3a3a24d
+  metadata.gz: 8db05c08b17b71ac1bac193acaaa6a00b14b5e17dc2ebdbae52a9d4b1a6a942142d211bf55c0b5e4870f631e417b279ae84e70d950e533cfb8f21b337682cbd9
+  data.tar.gz: 0d255e9ed3e4539f98df8b1d9753951bd0f5a5002135afa5ac0177966ad9ade22fe73124146c8070efc2f026bdb66bfe9d1d70caf7ff363f4bd9e1b46b0a906b

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-debugger checks for project ID are:
 1. `DEBUGGER_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-debugger checks for credentials are configured on {Google::Cloud::Debugger::V2::Credentials}:
+The environment variables that google-cloud-debugger checks for credentials are
+configured on `Google::Cloud::Debugger::V2::Debugger::Credentials`:
 
 1. `DEBUGGER_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `DEBUGGER_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 0.42.0 / 2021-03-31
+
+#### Features
+
+* Drop support for Ruby 2.4 and note that Ruby 3.0 is also unsupported
+
+### 0.41.0 / 2020-09-16
+
+#### Features
+
+* quota_project can be set via library configuration
+
+### 0.40.0 / 2020-07-21
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-debugger-v2` gem as a dependency.
+The new dependency is a rewritten low-level client, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-debugger-v2`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Debugger::V2` module,
+please review the docs for the new `google-cloud-debugger-v2` gem. In
+particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 0.36.3 / 2020-07-06
+
+#### Bug Fixes
+
+* Fix segfaults on Ruby 2.7
+
+### 0.36.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
 ### 0.36.1 / 2020-05-19
 
 #### Bug Fixes

data/CONTRIBUTING.md

@@ -24,9 +24,9 @@ be able to accept your pull requests.
 In order to use the google-cloud-debugger console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-debugger requires Ruby 2.4+. You may choose to
-   manage your Ruby and gem installations with [RVM](https://rvm.io/),
-   [rbenv](https://github.com/rbenv/rbenv), or
+1. Install Ruby. google-cloud-debugger requires Ruby 2.5+. It is not currently
+   supported on Ruby 3. You may choose to manage your Ruby and gem installations
+   with [RVM](https://rvm.io/), [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
 
 2. Install [Bundler](http://bundler.io/).
@@ -45,7 +45,7 @@ there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-debugger/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Console

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

data/OVERVIEW.md

@@ -147,12 +147,9 @@ For further information on the Debugger API, see
 ```ruby
 require "google/cloud/debugger/v2"
 
-Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-Debuggee = Google::Devtools::Clouddebugger::V2::Debuggee
-
-controller2_client = Controller2Client.new
-debuggee = Debuggee.new
-response = controller2_client.register_debuggee(debuggee)
+controller_client = Google::Cloud::Debugger::V2::Controller::Client.new
+debuggee = Google::Cloud::Debugger::V2::Debuggee.new
+response = controller_client.register_debuggee debuggee: debuggee
 debuggee_id = response.debuggee.id
 ```
 See [Stackdriver Debugger Debuggee
@@ -163,23 +160,18 @@ Upon successful registration, the response debuggee object will contain a
 debuggee_id that's later needed to interact with the other Stackdriver Debugger
 API.
 
-See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-
 ### List Active Breakpoints
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-controller2_client = Controller2Client.new
+controller_client = Google::Cloud::Debugger::V2::Controller::Client.new
 
 debuggee_id = ''
-response = controller2_client.list_active_breakpoints(debuggee_id)
+response = controller_client.list_active_breakpoints debuggee_id: debuggee_id
 breakpoints = response.breakpoints
 ```
 
-See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-
 ### Update Active Breakpoint
 
 Users can send custom snapshots for active breakpoints using this API.
@@ -187,110 +179,87 @@ Users can send custom snapshots for active breakpoints using this API.
 ```ruby
 require "google/cloud/debugger/v2"
 
-Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
-Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-
-controller2_client = Controller2Client.new
+controller_client = Google::Cloud::Debugger::V2::Controller::Client.new
 debuggee_id = ''
-breakpoint = Breakpoint.new
-response =
-  controller2_client.update_active_breakpoint(debuggee_id, breakpoint)
+breakpoint = Google::Cloud::Debugger::V2::Breakpoint.new
+response = controller_client.update_active_breakpoint(
+  debuggee_id: debuggee_id, breakpoint: breakpoint)
 ```
 
 See [Stackdriver Debugger Breakpoint
 doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Breakpoint)
 for all available fields for breakpoint.
 
-See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-
 ### Set Breakpoint
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
-breakpoint = Breakpoint.new
+breakpoint = Google::Cloud::Debugger::V2::Breakpoint.new
 client_version = ''
-response = debugger2_client.set_breakpoint(
-             debuggee_id, breakpoint, client_version)
+response = debugger_client.set_breakpoint(
+  debuggee_id: debuggee_id, breakpoint: breakpoint,
+  client_version: client_version)
 ```
 
 See [Stackdriver Debugger Breakpoint
 doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Breakpoint)
 for fields needed to specify breakpoint location.
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### Get Breakpoint
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
 breakpoint_id = ''
 client_version = ''
-response = debugger2_client.get_breakpoint(
-             debuggee_id, breakpoint_id, client_version)
+response = debugger_client.get_breakpoint(
+  debuggee_id: debuggee_id, breakpoint_id: breakpoint_id,
+  client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### Delete Breakpoint
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
 breakpoint_id = ''
 client_version = ''
-debugger2_client.delete_breakpoint(
-  debuggee_id, breakpoint_id, client_version)
+debugger_client.delete_breakpoint(
+  debuggee_id: debuggee_id, breakpoint_id: breakpoint_id,
+  client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### List Breakpoints
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
 client_version = ''
-response = debugger2_client.list_breakpoints(debuggee_id, client_version)
+response = debugger_client.list_breakpoints(
+  debuggee_id: debuggee_id, client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### List Debuggees
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 project = ''
 client_version = ''
-response = debugger2_client.list_debuggees(project, client_version)
+response = debugger_client.list_debuggees(
+  project: project, client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ## Additional information
 
 Stackdriver Debugger can be configured to use gRPC's logging. To learn more, see

data/TROUBLESHOOTING.md

@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
 
   - [New issue][gh-ruby]
 
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
 [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+debugger
 
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+debugger%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+[gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+debugger%22
 
-[slack-ruby]: https://gcp-slack.appspot.com/
+[gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new

data/ext/google/cloud/debugger/debugger_c/tracer.c

@@ -208,25 +208,19 @@ line_trace_callback(rb_event_flag_t event, VALUE data, VALUE obj, ID mid, VALUE
 static VALUE
 disable_line_trace_for_thread(VALUE thread)
 {
-    VALUE thread_variables_hash;
     VALUE line_trace_set;
-    ID locals_id;
     ID line_trace_thread_id;
-    VALUE line_trace_thread_flag;
 
-    CONST_ID(locals_id, "locals");
     CONST_ID(line_trace_thread_id, "gcloud_line_trace_set");
-    line_trace_thread_flag = ID2SYM(line_trace_thread_id);
 
     if (!RTEST(thread)) {
         thread = rb_thread_current();
     }
-    thread_variables_hash = rb_ivar_get(thread, locals_id);
-    line_trace_set = rb_hash_aref(thread_variables_hash, line_trace_thread_flag);
+    line_trace_set = rb_ivar_get(thread, line_trace_thread_id);
 
     if (RTEST(line_trace_set)) {
         rb_thread_remove_event_hook(thread, line_trace_callback);
-        rb_hash_aset(thread_variables_hash, line_trace_thread_flag, Qfalse);
+        rb_ivar_set(thread, line_trace_thread_id, Qfalse);
     }
 
     return Qnil;
@@ -241,23 +235,17 @@ static VALUE
 enable_line_trace_for_thread(VALUE self)
 {
     VALUE current_thread;
-    VALUE thread_variables_hash;
     VALUE line_trace_set;
-    ID locals_id;
     ID line_trace_thread_id;
-    VALUE line_trace_thread_flag;
 
-    CONST_ID(locals_id, "locals");
     CONST_ID(line_trace_thread_id, "gcloud_line_trace_set");
-    line_trace_thread_flag = ID2SYM(line_trace_thread_id);
 
     current_thread = rb_thread_current();
-    thread_variables_hash = rb_ivar_get(current_thread, locals_id);
-    line_trace_set = rb_hash_aref(thread_variables_hash, line_trace_thread_flag);
+    line_trace_set = rb_ivar_get(current_thread, line_trace_thread_id);
 
     if (!RTEST(line_trace_set)) {
         rb_thread_add_event_hook(current_thread, line_trace_callback, RUBY_EVENT_LINE, self);
-        rb_hash_aset(thread_variables_hash, line_trace_thread_flag, Qtrue);
+        rb_ivar_set(current_thread, line_trace_thread_id, Qtrue);
     }
 
     return Qnil;
@@ -331,25 +319,19 @@ return_trace_callback(void *data, rb_trace_arg_t *trace_arg)
 static VALUE
 disable_return_trace_for_thread(VALUE thread)
 {
-    VALUE thread_variables_hash;
     VALUE return_trace_set;
-    ID locals_id;
     ID return_trace_thread_id;
-    VALUE return_trace_thread_flag;
 
-    CONST_ID(locals_id, "locals");
     CONST_ID(return_trace_thread_id, "gcloud_return_trace_set");
-    return_trace_thread_flag = ID2SYM(return_trace_thread_id);
 
     if (!RTEST(thread)) {
         thread = rb_thread_current();
     }
-    thread_variables_hash = rb_ivar_get(thread, locals_id);
-    return_trace_set = rb_hash_aref(thread_variables_hash, return_trace_thread_flag);
+    return_trace_set = rb_ivar_get(thread, return_trace_thread_id);
 
     if (RTEST(return_trace_set)) {
         rb_thread_remove_event_hook(thread, (rb_event_hook_func_t)return_trace_callback);
-        rb_hash_aset(thread_variables_hash, return_trace_thread_flag, Qfalse);
+        rb_ivar_set(thread, return_trace_thread_id, Qfalse);
     }
 
     return Qnil;
@@ -364,24 +346,17 @@ static VALUE
 enable_return_trace_for_thread(VALUE self)
 {
     VALUE current_thread;
-    VALUE thread_variables_hash;
     VALUE return_trace_set;
-
-    ID locals_id;
     ID return_trace_thread_id;
-    VALUE return_trace_thread_flag;
 
-    CONST_ID(locals_id, "locals");
     CONST_ID(return_trace_thread_id, "gcloud_return_trace_set");
-    return_trace_thread_flag = ID2SYM(return_trace_thread_id);
 
     current_thread = rb_thread_current();
-    thread_variables_hash = rb_ivar_get(current_thread, locals_id);
-    return_trace_set = rb_hash_aref(thread_variables_hash, return_trace_thread_flag);
+    return_trace_set = rb_ivar_get(current_thread, return_trace_thread_id);
 
     if (!RTEST(return_trace_set)) {
         rb_thread_add_event_hook2(current_thread, (rb_event_hook_func_t)return_trace_callback, RETURN_TRACEPOINT_EVENTS, self, RUBY_EVENT_HOOK_FLAG_RAW_ARG | RUBY_EVENT_HOOK_FLAG_SAFE);
-        rb_hash_aset(thread_variables_hash, return_trace_thread_flag, Qtrue);
+        rb_ivar_set(current_thread, return_trace_thread_id, Qtrue);
     }
 
     return Qnil;

data/lib/google-cloud-debugger.rb

@@ -48,8 +48,6 @@ module Google
     #   * `https://www.googleapis.com/auth/logging.admin`
     #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::Debugger::Project]
     #
@@ -68,14 +66,12 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   debugger = gcloud.debugger scope: platform_scope
     #
-    def debugger service_name: nil, service_version: nil, scope: nil,
-                 timeout: nil, client_config: nil
+    def debugger service_name: nil, service_version: nil, scope: nil, timeout: nil
       Google::Cloud.debugger @project, @keyfile,
                              service_name: service_name,
                              service_version: service_version,
                              scope: scope,
-                             timeout: (timeout || @timeout),
-                             client_config: client_config
+                             timeout: (timeout || @timeout)
     end
 
     ##
@@ -105,8 +101,6 @@ module Google
     #   * `https://www.googleapis.com/auth/logging.admin`
     #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::Debugger::Project]
     #
@@ -118,15 +112,13 @@ module Google
     #   debugger.start
     #
     def self.debugger project_id = nil, credentials = nil, service_name: nil,
-                      service_version: nil, scope: nil, timeout: nil,
-                      client_config: nil
+                      service_version: nil, scope: nil, timeout: nil
       require "google/cloud/debugger"
       Google::Cloud::Debugger.new project_id: project_id,
                                   credentials: credentials,
                                   service_name: service_name,
                                   service_version: service_version,
-                                  scope: scope, timeout: timeout,
-                                  client_config: client_config
+                                  scope: scope, timeout: timeout
     end
   end
 end
@@ -160,6 +152,13 @@ Google::Cloud.configure.add_config! :debugger do |config|
   default_version = Google::Cloud::Config.deferred do
     ENV["DEBUGGER_SERVICE_VERSION"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/cloud_debugger",
+    "https://www.googleapis.com/auth/logging.admin",
+    "https://www.googleapis.com/auth/logging.read",
+    "https://www.googleapis.com/auth/logging.write"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -173,10 +172,10 @@ Google::Cloud.configure.add_config! :debugger do |config|
                     match: String, allow_nil: true
   config.add_field! :app_root, nil, match: String
   config.add_field! :root, nil, match: String
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :endpoint, "clouddebugger.googleapis.com", match: String
   config.add_field! :allow_mutating_methods, false
   config.add_field! :evaluation_time_limit, 0.05, match: Numeric
   config.add_field! :on_error, nil, match: Proc