google-cloud-debugger 0.36.2 → 0.42.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c6fdba2f188ed5e9eebd6f70800a3fb2c309eff8a413cbef41c50819a6e270a
-  data.tar.gz: b14634126ba9ce25bf73decc35542dc44e6d186b52dd298a9779ad7201df156e
+  metadata.gz: 538aafa3b8ea1fadaef4a81651207de8ff2044ac8edeb5e31dfa7dc9d1b04293
+  data.tar.gz: 7ceec9bc919b53b965d855958d1fc71ef8a0b1d959c53d02345ade43d4d258f0
 SHA512:
-  metadata.gz: 18b9857fe5a8a4ad2eb7883c132e6d7b72548800f562c82471f30093c7d84193b5d6d2d8b700c85291fef6157ba5af0dc9844a1751004618f0d72bf708f4a3b2
-  data.tar.gz: 9fa5a8acb902ef5d93be54e66a4dfedde25d562e8103b6f77d849abe33bb45ec3dc0619e921e4ea3d3aa6e44a338a40c41639ac027a027153b7886b4d315cd46
+  metadata.gz: cfac793f4d80491da98f423aa28d013e127cdc6f3b2bedd441caedd8a11aaaee4e946c117741dc589c5850af77354564ffdf8efa0592591029b0467c351d4b73
+  data.tar.gz: ade965963e90484abe885c6f1ab2ef7b90267e510ae11ea7a26ae270045a454a7d7c5f5bac8a3a43d72f9589ee004ce628a39d4ccee4f897404bb4b8e0ccb6a7

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
@@ -95,7 +96,8 @@ client = Google::Cloud::Debugger.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/debugger"

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 0.42.1 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
+### 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

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
@@ -119,7 +119,7 @@ If you alter an example's title, you may encounter breaking tests.
 ### Debugger Acceptance Tests
 
 The Debugger acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
 the Debugger API. Occasionally, some API features may not yet be generally
 available, making it difficult for some contributors to successfully run the
 entire acceptance test suite. However, please ensure that you do successfully
@@ -184,5 +184,4 @@ $ bundle exec rake rubocop
 ## Code of Conduct
 
 Please note that this project is released with a Contributor Code of Conduct. By
-participating in this project you agree to abide by its terms. See
-{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
+participating in this project you agree to abide by its terms. See {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

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/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