spanner_emulator_toolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 301422fd77428e32cd400aedd54592589af35979bdf101a31e93a8f95980a8e5
+  data.tar.gz: 5a7ef1dda527e64a78b7187164beea42aa95692ffb3d2ac78ca2521c4c2fe5c6
+SHA512:
+  metadata.gz: efbd3eb4f4daaaf31e97970f84e4588b1afab132ac19f543ae2d5e322e7c2605a0509b1ab6798f537c015c5b9b5e8950d2f30c6a57a77cc20130196c8ab512e6
+  data.tar.gz: b4f4fc0b7a46f33ec747cfdbfbe6111db169b562ef28a65a1b9d19abfee0767570b2cdaa18e285cd11d4100b244d3dcb234e004aebcd6463bf41c94dbee4b8e8

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+require:
+  - standard
+  - standard-custom
+  - standard-performance
+  - rubocop-performance
+
+inherit_gem:
+  standard: config/base.yml
+  standard-custom: config/base.yml
+  standard-performance: config/base.yml
+
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.1.0]
+
+Initial release.
+
+- Global configuration with `SpannerEmulatorToolkit.configure { |config| ... }` or ENV vars
+- Google::Cloud::Spanner client methods: `create_instance`, `create_database`, `drop_instance`, `drop_database`
+- `reset_session!` to reset transactions all instances and databases of the configured project and emulator

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at abachman@recurly.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spanner_emulator_toolkit.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.28", require: false
+gem "rbs", "~> 3.3"
+gem "debug", "~> 1.8"

data/Gemfile.lock

@@ -0,0 +1,175 @@
+PATH
+  remote: .
+  specs:
+    spanner_emulator_toolkit (0.1.0)
+      concurrent-ruby (~> 1.2)
+      google-cloud-spanner (~> 2.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abbrev (0.1.1)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    concurrent-ruby (1.2.2)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    faraday (2.7.12)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-retry (2.2.0)
+      faraday (~> 2.0)
+    gapic-common (0.20.0)
+      faraday (>= 1.9, < 3.a)
+      faraday-retry (>= 1.0, < 3.a)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.12, < 2.a)
+      googleapis-common-protos-types (>= 1.3.1, < 2.a)
+      googleauth (~> 1.0)
+      grpc (~> 1.36)
+    google-cloud-core (1.6.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.6.0)
+      faraday (>= 0.17.3, < 3.0)
+    google-cloud-errors (1.3.1)
+    google-cloud-spanner (2.18.1)
+      concurrent-ruby (~> 1.0)
+      google-cloud-core (~> 1.5)
+      google-cloud-spanner-admin-database-v1 (~> 0.1)
+      google-cloud-spanner-admin-instance-v1 (~> 0.1)
+      google-cloud-spanner-v1 (~> 0.2)
+    google-cloud-spanner-admin-database-v1 (0.15.0)
+      gapic-common (>= 0.20.0, < 2.a)
+      google-cloud-errors (~> 1.0)
+      grpc-google-iam-v1 (~> 1.1)
+    google-cloud-spanner-admin-instance-v1 (0.12.0)
+      gapic-common (>= 0.20.0, < 2.a)
+      google-cloud-errors (~> 1.0)
+      grpc-google-iam-v1 (~> 1.1)
+    google-cloud-spanner-v1 (0.19.0)
+      gapic-common (>= 0.20.0, < 2.a)
+      google-cloud-errors (~> 1.0)
+    google-protobuf (3.25.1-arm64-darwin)
+    google-protobuf (3.25.1-x86_64-linux)
+    googleapis-common-protos (1.4.0)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (~> 1.2)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.11.0)
+      google-protobuf (~> 3.18)
+    googleauth (1.8.1)
+      faraday (>= 0.17.3, < 3.a)
+      jwt (>= 1.4, < 3.0)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (>= 0.16, < 2.a)
+    grpc (1.60.0-arm64-darwin)
+      google-protobuf (~> 3.25)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.60.0-x86_64-linux)
+      google-protobuf (~> 3.25)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-google-iam-v1 (1.4.0)
+      google-protobuf (~> 3.18)
+      googleapis-common-protos (~> 1.4)
+      grpc (~> 1.41)
+    io-console (0.6.0)
+    irb (1.10.1)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.7.1)
+    jwt (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    multi_json (1.15.0)
+    os (1.1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.1.1)
+      stringio
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rbs (3.3.2)
+      abbrev
+    rdoc (6.6.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    signet (0.18.0)
+      addressable (~> 2.8)
+      faraday (>= 0.17.5, < 3.a)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    standard (1.32.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.57.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    stringio (3.1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.8)
+  rake (~> 13.0)
+  rbs (~> 3.3)
+  rspec (~> 3.0)
+  spanner_emulator_toolkit!
+  standard (~> 1.28)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Adam Bachman
+
+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.

data/README.md

@@ -0,0 +1,203 @@
+# SpannerEmulatorToolkit
+
+Peform some simple or otherwise impossible tasks with [the Cloud Spanner Emulator][emulator], with specific focus on resetting all session transactions for a given Emulator.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```console
+$ bundle add spanner_emulator_toolkit
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```console
+$ gem install spanner_emulator_toolkit
+```
+
+## Usage
+
+### Configuration
+
+All functionality require configuration first. All required settings have reasonably safe defaults and can be set through environment variables.
+
+| Option | Description | Default | Required | Env |
+| --- | --- | --- | --- | --- |
+| `project_id` | The project ID to use. | `"example-project"` | **Yes** | `SPANNER_PROJECT_ID` |
+| `instance_id` | The instance ID to use. | `"example-instance"` | no | `SPANNER_PROJECT_ID` |
+| `project_id` | The database ID to use. | `"example-database"` | no | `SPANNER_DATABASE_ID` |
+| `emulator_host` | Local hostname for the [cloud-spanner-emulator][emulator]. | `"localhost:9010"` | **Yes** | `SPANNER_EMULATOR_HOST` |
+| `logger` | A Ruby Logger instance. | `Logger.new(STDOUT)` | no | |
+| `log_level` | The log level to use for the logger. | `Logger::FATAL` | no | |
+| `schema` | A raw SQL schema to use when creating the database. | `nil` | no | |
+
+```ruby
+# if all you're doing is resetting sessions
+SpannEmulatorToolkit.configure do |config|
+  config.project_id = "test-project"
+  config.emulator_host = "localhost:9010"
+end
+
+# if you're creating a specific instance and database
+SpannEmulatorToolkit.configure do |config|
+  config.project_id = "test-project"
+  config.instance_id = "test-instance"
+  config.database_id = "test-database"
+  config.emulator_host = "localhost:9010"
+end
+
+# If you want to use an existing logger. Nothing too interesting is produced by
+# the library, just debug logging.
+SpannEmulatorToolkit.configure do |config|
+  config.logger = Rails.logger
+end
+
+# if you want to see debug logs on STDOUT
+SpannEmulatorToolkit.configure do |config|
+  config.log_level = Logger::DEBUG
+end
+
+# to create a database with a schema
+SpannEmulatorToolkit.configure do |config|
+  config.schema = <<~SQL
+    CREATE TABLE users (
+      id INT64 NOT NULL,
+      username STRING(255) NOT NULL,
+      name STRING(255) NOT NULL
+    ) PRIMARY KEY (id)
+  SQL
+end
+```
+
+### Client methods
+
+#### Instance and Database Management
+
+Helper methods to work with Spanner instances and databases in the emulator.
+
+Creating:
+
+```ruby
+# create the configured instance
+SpannerEmulatorToolkit.create_instance
+
+# create the configured instance and database
+SpannerEmulatorToolkit.create_database
+```
+
+And dropping:
+
+```ruby
+# drop the configured instance and all its databases
+SpannerEmulatorToolkit.drop_instance
+
+# just drop the configured database
+SpannerEmulatorToolkit.drop_database
+```
+
+#### Getting a Google::Cloud::Spanner::Client
+
+The toolkit provides a simple wrapper around Spanner client initialization. It is not intended to be a complete replacement for the client, just a wrapper around some common patterns in prototyping.
+
+[Google's documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-spanner/latest/index.html) for the Spanner client is a good place to start.
+
+```ruby
+# Google::Cloud::Spanner::Client
+client = SpannerEmulatorToolkit.client
+
+client.commit do |c|
+  c.update "users", [{ id: 1, username: "charlie94", name: "Charlie" }]
+  c.insert "users", [{ id: 2, username: "harvey00", name: "Harvey" }]
+end
+
+results = client.read "users", [:id, :name], keys: 1..5
+results.rows.each do |row|
+  puts "User #{row[:id]} is #{row[:name]}"
+end
+```
+
+Or more specific classes from the [google-cloud-spanner](https://github.com/googleapis/ruby-spanner/) gem:
+
+```ruby
+# Google::Cloud::Spanner::Project
+SpannerEmulatorToolkit.project
+
+# Google::Cloud::Spanner::Database
+SpannerEmulatorToolkit.database
+SpannerEmulatorToolkit.database_exists?
+SpannerEmulatorToolkit.database_path # the full "projects/.../instances/.../databases/..." path
+
+# Google::Cloud::Spanner::Instance
+SpannerEmulatorToolkit.instance
+SpannerEmulatorToolkit.instance_exists?
+```
+
+### Reset all session transactions
+
+Why this gem exists in the first place: to reset all sessions on all databases in all instances for the configured project in the emulator.
+
+```ruby
+SpannerEmulatorToolkit.reset_sessions!
+```
+
+**Background**: [GoogleCloudPlatform/cloud-spanner-emulator#137](https://github.com/GoogleCloudPlatform/cloud-spanner-emulator/issues/137)
+
+The Spanner Local Emulator has a known failure mode in which transactions left open by a process that has crashed are not cleaned up. This will cause the emulator to reject all future transactions.
+
+This can be fixed by restarting the emulator, but that drops all your databases and data which can be a huge pain in a large project.
+
+This tool will reset all open transactions in the emulator so you can continue working.
+
+Useful for development and any environment where you're killing processes (like test suites) which may have a pending transaction open when they are killed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Run `rake rubocop` to run the linter before committing changes.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Running the examples
+
+Before running an example, you'll need to [start the emulator][emulator]. The easiest way to do that is [with the pre-built Docker image](https://github.com/GoogleCloudPlatform/cloud-spanner-emulator#via-pre-built-docker-image).
+
+```console
+$ docker pull gcr.io/cloud-spanner-emulator/emulator
+$ docker run -p 9010:9010 -p 9020:9020 gcr.io/cloud-spanner-emulator/emulator
+```
+
+Or through docker compose:
+
+```yaml
+services:
+  google-cloud-spanner:
+    image: gcr.io/cloud-spanner-emulator/emulator:latest
+    ports:
+      - "9010:9010"
+      - "9020:9020"
+
+# docker compose up google-cloud-spanner
+```
+
+There are some examples in the `examples` directory. These are not run as part of the test suite, but can be run manually.
+
+```console
+$ bundle exec ruby examples/create_instance.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abachman/spanner_emulator_toolkit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/abachman/spanner_emulator_toolkit/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SpannerEmulatorToolkit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abachman/spanner_emulator_toolkit/blob/main/CODE_OF_CONDUCT.md).
+
+
+[emulator]: https://github.com/GoogleCloudPlatform/cloud-spanner-emulator

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+
+services:
+  google-cloud-spanner:
+    image: gcr.io/cloud-spanner-emulator/emulator:latest
+    ports:
+      - "9010:9010"
+      - "9020:9020"

data/examples/create.rb

@@ -0,0 +1,10 @@
+$: << File.expand_path("../lib", __FILE__)
+
+require "spanner_emulator_toolkit"
+
+SpannerEmulatorToolkit.configure do |config|
+  config.schema = File.read File.expand_path("../spec/schema.sql", __dir__)
+  config.log_level = Logger::DEBUG
+end
+
+SpannerEmulatorToolkit.create_database

data/examples/drop.rb

@@ -0,0 +1,9 @@
+$: << File.expand_path("../lib", __FILE__)
+
+require "spanner_emulator_toolkit"
+
+SpannerEmulatorToolkit.configure do |config|
+  config.log_level = Logger::DEBUG
+end
+
+SpannerEmulatorToolkit.drop_instance

data/examples/force_transaction_error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+##
+# Force a stale-open transaction on the Spanner Emulator by running this script
+# and then killing it with Ctrl-C.
+#
+# Rerunning the script will result in a hung process followed by the "one
+# transaction at a time" error.
+#
+##
+require "google/cloud/spanner"
+
+PROJECT_ID = "example-project"
+INSTANCE_ID = "example-instance"
+DATABASE_ID = "example-database"
+EMULATOR_HOST = "localhost:9010"
+
+project = Google::Cloud::Spanner.new(
+  project_id: PROJECT_ID,
+  emulator_host: EMULATOR_HOST
+)
+unless project.instance(INSTANCE_ID)
+  project.create_instance(INSTANCE_ID, name: INSTANCE_ID, nodes: 1).wait_until_done!
+end
+unless project.instance(INSTANCE_ID).database(DATABASE_ID)
+  schema = "CREATE TABLE Customers (Id STRING(36) NOT NULL) PRIMARY KEY (Id)"
+  project.instance(INSTANCE_ID).create_database(DATABASE_ID, statements: [schema]).wait_until_done!
+end
+client = project.client(INSTANCE_ID, DATABASE_ID)
+puts
+puts "| starting transactions on #{client.database.path}"
+puts "| press \e[1mCtrl-C\e[0m to interrupt, rerun until you get a 'one transaction at a time' error"
+puts "| then run examples/session_reset.rb to clear the hung transaction"
+puts
+loop do
+  client.transaction(deadline: 5) do |tx|
+    tx.execute "INSERT INTO Customers (Id) VALUES ('#{SecureRandom.hex(6)}')"
+    sleep 0.5
+    print "."
+    tx.execute "INSERT INTO Customers (Id) VALUES ('#{SecureRandom.hex(6)}-2')"
+  end
+end

data/examples/session_reset.rb

@@ -0,0 +1,9 @@
+$: << File.expand_path("../lib", __FILE__)
+
+require "spanner_emulator_toolkit"
+
+SpannerEmulatorToolkit.configure do |config|
+  config.log_level = Logger::DEBUG
+end
+
+SpannerEmulatorToolkit.reset_sessions!

data/lib/spanner_emulator_toolkit/client.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "google/cloud/spanner"
+require "concurrent"
+
+module SpannerEmulatorToolkit
+  class << self
+    # raises error unless database already exists
+    def client
+      configuration.validate!
+
+      thread_local_client
+    end
+
+    # Resets the client instance.
+    def reset_client
+      @client = nil
+      self
+    end
+
+    def project
+      configuration.validate!
+
+      thread_local_project
+    end
+
+    # returns nil unless instance already exists
+    def instance
+      project.instance(configuration.instance_id)
+    end
+
+    def database
+      instance&.database(configuration.database_id)
+    end
+
+    def instance_exists?
+      !instance.nil?
+    end
+
+    def database_exists?
+      !instance&.database(configuration.database_id).nil?
+    end
+
+    # no-op if instance already exists
+    def create_instance
+      return if instance_exists?
+
+      logger.debug "creating instance: #{configuration.instance_id}"
+      project.create_instance(
+        configuration.instance_id, name: configuration.instance_id
+      ).wait_until_done!
+    end
+
+    def drop_instance
+      return unless instance_exists?
+
+      logger.debug "dropping instance: #{configuration.instance_id}"
+      instance.delete
+    end
+
+    # no-op if database already exists
+    def create_database
+      return if database_exists?
+
+      create_instance
+
+      logger.debug "creating database: #{configuration.database_id}"
+      instance.create_database(
+        configuration.database_id,
+        statements: configuration.schema_statements
+      ).wait_until_done!
+    end
+
+    def drop_database
+      return unless database_exists?
+
+      logger.debug "dropping database: #{configuration.database_id}"
+      client.database.drop
+    end
+
+    def database_path
+      client.database.path
+    end
+
+    private
+
+    # ensure that multiple threads do not share the same client instance
+    def thread_local_client
+      @client ||= Concurrent::ThreadLocalVar.new(nil)
+      @client.value ||= project.client(configuration.instance_id, configuration.database_id)
+      @client.value
+    end
+
+    # ensure that multiple threads do not share the same project connection instance
+    def thread_local_project
+      @project ||= Concurrent::ThreadLocalVar.new(nil)
+      @project.value ||= Google::Cloud::Spanner.new(
+        project_id: configuration.project_id,
+        emulator_host: configuration.emulator_host
+      )
+      @project.value
+    end
+  end
+end

data/lib/spanner_emulator_toolkit/configuration.rb

@@ -0,0 +1,72 @@
+module SpannerEmulatorToolkit
+  class Configuration
+    # Spanner settings
+    attr_accessor :project_id, :instance_id, :database_id, :emulator_host, :schema
+
+    # Generic settings
+    attr_accessor :logger, :log_level
+
+    def initialize
+      @project_id = "example-project"
+      @instance_id = "example-instance"
+      @database_id = "example-database"
+      @emulator_host = "localhost:9010"
+    end
+
+    def validate!
+      load_from_env
+      prepare_logger
+
+      %w[project_id instance_id database_id emulator_host].each do |attr|
+        raise "configuration.#{attr} must be set" unless send(attr)
+      end
+    end
+
+    def schema_statements
+      return [] unless schema
+
+      schema.split(";").map(&:strip).reject(&:empty?)
+    end
+
+    private
+
+    def load_from_env
+      %w[project_id instance_id database_id emulator_host].each do |attr|
+        env_key = "SPANNER_#{attr.upcase}"
+        if ENV[env_key] && !send(attr)
+          send("#{attr}=", ENV[env_key])
+        end
+      end
+    end
+
+    def colorized(text, logger_severity)
+      case logger_severity
+      when "ERROR"
+        "\e[31;1m#{text}\e[0m"
+      when "DEBUG"
+        "\e[32;1m#{text}\e[0m"
+      when "WARN"
+        "\e[33;1m#{text}\e[0m"
+      when "INFO"
+        "\e[34;1m#{text}\e[0m"
+      else
+        text
+      end
+    end
+
+    def prepare_logger
+      if logger.nil?
+        self.logger = Logger.new($stdout)
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          [
+            "[SpannerEmulatorToolkit #{datetime.strftime("%Y-%m-%d %H:%M:%S")}]",
+            colorized(severity, severity),
+            msg
+          ].join(" ") + "\n"
+        end
+      end
+
+      logger.level = (log_level || Logger::ERROR)
+    end
+  end
+end

data/lib/spanner_emulator_toolkit/google_cloud_spanner_ext/service.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Google
+  module Cloud
+    module Spanner
+      class Service
+        # add a missing list_sessions method
+        # @param database [String] in the form of a full Spanner identifier like
+        #                          "project/.../instance/.../database/..."
+        def list_sessions(database:, call_options: nil, token: nil, max: nil)
+          opts = default_options call_options: call_options
+          request = {
+            database: database,
+            page_size: max,
+            page_token: token
+          }
+          paged_enum = service.list_sessions request, opts
+          paged_enum.response
+        end
+      end
+    end
+  end
+end

data/lib/spanner_emulator_toolkit/reset_sessions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "google/cloud/spanner"
+
+module SpannerEmulatorToolkit
+  class << self
+    # reset all sessions on all databases on all instances for the configured emulator project
+    def reset_sessions!
+      configuration.validate!
+
+      logger.debug "resetting sessions"
+      project.instances.all do |instance|
+        logger.debug "instance: #{instance.path}"
+        instance.databases.all do |database|
+          logger.debug "  database: #{database.path}"
+          each_session_for_database(database) do |session|
+            logger.debug "    session: #{session.path}"
+            tx = session.create_empty_transaction
+            session.rollback tx.transaction_id
+          rescue => e
+            logger.debug "    error resetting session: #{e.details}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def each_session_for_database(database)
+      # patched method, paginated
+      session_result = database.service.list_sessions(database: database.path)
+      next_page_token = session_result.next_page_token
+
+      loop do
+        session_result.sessions.each do |grpc_session|
+          yield Google::Cloud::Spanner::Session.new(grpc_session, database.service)
+        end
+
+        break if next_page_token.empty?
+
+        session_result = database.service.list_sessions(database: database.path, token: next_page_token)
+        next_page_token = session_result.next_page_token
+      end
+    end
+  end
+end

data/lib/spanner_emulator_toolkit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SpannerEmulatorToolkit
+  VERSION = "0.1.0"
+end

data/lib/spanner_emulator_toolkit.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "spanner_emulator_toolkit/version"
+require_relative "spanner_emulator_toolkit/configuration"
+require_relative "spanner_emulator_toolkit/client"
+require_relative "spanner_emulator_toolkit/reset_sessions"
+require_relative "spanner_emulator_toolkit/google_cloud_spanner_ext/service"
+
+module SpannerEmulatorToolkit
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def logger
+      configuration.logger
+    end
+  end
+end

data/sig/spanner_emulator_toolkit.rbs

@@ -0,0 +1,27 @@
+module SpannerEmulatorToolkit
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  # configuration.rb
+  def self.configure: () { (SpannerEmulatorToolkit::Configuration) -> void } -> void
+  def self.logger: () -> Logger
+
+  # client.rb
+  def self.project: () -> Google::Cloud::Spanner::Project
+  def self.client: () -> Google::Cloud::Spanner::Client
+  def self.instance: () -> Google::Cloud::Spanner::Instance
+  def self.database: () -> Google::Cloud::Spanner::Database
+
+  def self.instance_exists?: () -> bool
+  def self.database_exists?: () -> bool
+
+  def self.create_instance: () -> void
+  def self.drop_instance: () -> void
+  def self.create_database: () -> void
+  def self.drop_database: () -> void
+
+  def self.database_path: () -> String
+
+  # reset_sessions.rb
+  def self.reset_sessions!: () -> void
+end

data/spanner_emulator_toolkit.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/spanner_emulator_toolkit/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "spanner_emulator_toolkit"
+  spec.version = SpannerEmulatorToolkit::VERSION
+  spec.authors = ["Adam Bachman"]
+  spec.email = ["adam.bachman@gmail.com"]
+
+  spec.summary = "Google Cloud Spanner emulator toolkit"
+  spec.description = "Helpers for working with the Google Cloud Spanner emulator."
+  spec.homepage = "https://github.com/abachman/spanner_emulator_toolkit"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/abachman/spanner_emulator_toolkit/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "google-cloud-spanner", "~> 2.10"
+  spec.add_dependency "concurrent-ruby", "~> 1.2"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: spanner_emulator_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Bachman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-spanner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Helpers for working with the Google Cloud Spanner emulator.
+email:
+- adam.bachman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker-compose.yml
+- examples/create.rb
+- examples/drop.rb
+- examples/force_transaction_error.rb
+- examples/session_reset.rb
+- lib/spanner_emulator_toolkit.rb
+- lib/spanner_emulator_toolkit/client.rb
+- lib/spanner_emulator_toolkit/configuration.rb
+- lib/spanner_emulator_toolkit/google_cloud_spanner_ext/service.rb
+- lib/spanner_emulator_toolkit/reset_sessions.rb
+- lib/spanner_emulator_toolkit/version.rb
+- sig/spanner_emulator_toolkit.rbs
+- spanner_emulator_toolkit.gemspec
+homepage: https://github.com/abachman/spanner_emulator_toolkit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/abachman/spanner_emulator_toolkit
+  source_code_uri: https://github.com/abachman/spanner_emulator_toolkit
+  changelog_uri: https://github.com/abachman/spanner_emulator_toolkit/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Google Cloud Spanner emulator toolkit
+test_files: []