database_cleaner-spanner 0.1.0 → 0.1.1

data/scripts/performance_test.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+raise "emulator is enabled" if ENV["SPANNER_EMULATOR_HOST"]
+
+require "base64"
+require "benchmark"
+
+require_relative "../spec/spanner_admin"
+require_relative "../lib/database_cleaner/spanner/deletion"
+
+class BenchmarkRunner
+  def initialize(n = 1)
+    @n = n
+  end
+
+  def run
+    puts "Creating instance..."
+    admin.create_instance
+    puts "Creating database..."
+    admin.create_database
+    puts
+
+    Benchmark.bm(20) do |x|
+      run_test(x, :test_batch_update)
+      run_test(x, :test_delete_each)
+    end
+  ensure
+    puts
+    puts "Dropping database..."
+    admin.drop_database
+  end
+
+  private
+
+  def test_batch_update
+    cleaner = DatabaseCleaner::Spanner::Deletion.new(batch_deletion: true)
+    cleaner.db = db
+    cleaner.clean
+  end
+
+  def test_delete_each
+    cleaner = DatabaseCleaner::Spanner::Deletion.new(batch_deletion: false)
+    cleaner.db = db
+    cleaner.clean
+  end
+
+  def run_test(x, test_name)
+    preprocess
+    x.report(test_name) do
+      @n.times do
+        send(test_name)
+      end
+    end
+  ensure
+    postprocess
+  end
+
+  def preprocess
+    client.insert("Users", [{UserId: "user1"}, {UserId: "user2"}])
+    client.insert("Followings", [{FolloweeId: "user1", FollowerId: "user2"}])
+    client.insert("Posts", [{PostId: "post1", UserId: "user1", Text: "text"}])
+    client.insert("Bookmarks", [{UserId: "user2", PostId: "post1"}])
+    client.insert("Images", [{PostId: "post1", ImageId: "image1", Image: Base64.encode64("")}])
+    client.insert("Replies", [{PostId: "post1", ReplyId: "reply1", UserId: "user2", Text: "text"}])
+    client.insert("Likes", [{PostId: "post1", LikerId: "user2"}])
+    client.insert("ChatRooms", [{ChatRoomId: "chatRoom1", ChatRoomName: "name"}])
+    client.insert("ChatRoomMembers", [{ChatRoomId: "chatRoom1", UserId: "user1"}])
+    client.insert("ChatRoomMessages", [{ChatRoomId: "chatRoom1", ChatRoomMessageId: "chatRoomMessage1", UserId: "user1", Text: "text"}])
+    client.insert("Communities", [{CommunityId: "community1", CommunityName: "name", OwnerId: "user1"}])
+    client.insert("CommunityBelongings", [{UserId: "user1", CommunityId: "community1"}])
+    client.insert("CommunityPosts", [{CommunityId: "community1", PostId: "post1"}])
+  end
+
+  def postprocess
+    %w[
+      Users Followings Posts Bookmarks Images Replies Likes
+      ChatRooms ChatRoomMembers ChatRoomMessages
+      Communities CommunityBelongings CommunityPosts
+    ].each do |table|
+      count = count_rows(table)
+      if count != 0
+        raise "#{table} was not cleaned up"
+      end
+    end
+  end
+
+  def count_rows(table)
+    result = client.execute_query("SELECT COUNT(1) FROM #{table}")
+    result.rows.first[0]
+  end
+
+  def admin
+    @admin ||= SpannerAdmin.new(
+      project_id: project_id,
+      instance_id: instance_id,
+      database_id: database_id,
+      schema_file: File.expand_path("./schema.sql", __dir__)
+    )
+  end
+
+  def client
+    @client ||= Google::Cloud::Spanner.new(project_id: project_id)
+      .client(instance_id, database_id)
+  end
+
+  def project_id
+    @project_id ||= SpannerAdmin.get_project_id
+  end
+
+  def instance_id
+    @instance_id ||= ENV.fetch("SPANNER_INSTANCE_ID")
+  end
+
+  def database_id
+    @database_id ||= "performance-#{Time.now.to_i}"
+  end
+
+  def db
+    @db ||= {
+      project_id: project_id,
+      instance_id: instance_id,
+      database_id: database_id
+    }
+  end
+end
+
+BenchmarkRunner.new(100).run

data/scripts/schema.sql

@@ -0,0 +1,93 @@
+CREATE TABLE Users (
+  UserId STRING(36) NOT NULL,
+) PRIMARY KEY (UserId);
+
+CREATE TABLE Followings (
+  FolloweeId STRING(36) NOT NULL,
+  FollowerId STRING(36) NOT NULL,
+
+  FOREIGN KEY (FolloweeId) REFERENCES Users (UserId),
+  FOREIGN KEY (FollowerId) REFERENCES Users (UserId),
+) PRIMARY KEY (FolloweeId, FollowerId);
+
+CREATE TABLE Posts (
+  PostId STRING(36)  NOT NULL,
+  UserId STRING(36)  NOT NULL,
+  Text   STRING(MAX) NOT NULL,
+
+  FOREIGN KEY (UserId) REFERENCES Users (UserId),
+) PRIMARY KEY (PostId);
+
+CREATE TABLE Bookmarks (
+  UserId STRING(36) NOT NULL,
+  PostId STRING(36) NOT NULL,
+
+  FOREIGN KEY (PostId) REFERENCES Posts (PostId),
+) PRIMARY KEY (UserId, PostId), INTERLEAVE IN PARENT Users;
+
+CREATE TABLE Images (
+  PostId  STRING(36)  NOT NULL,
+  ImageId STRING(36)  NOT NULL,
+  Image   BYTES(1024) NOT NULL,
+) PRIMARY KEY (PostId, ImageId), INTERLEAVE IN PARENT Posts;
+
+CREATE TABLE Replies (
+  PostId  STRING(36)  NOT NULL,
+  ReplyId STRING(36)  NOT NULL,
+  UserId  STRING(36)  NOT NULL,
+  Text    STRING(MAX) NOT NULL,
+
+  FOREIGN KEY (UserId) REFERENCES Users (UserId),
+) PRIMARY KEY (PostId, ReplyId), INTERLEAVE IN PARENT Posts;
+
+CREATE TABLE Likes (
+  PostId  STRING(36) NOT NULL,
+  LikerId STRING(36) NOT NULL,
+
+  FOREIGN KEY (LikerId) REFERENCES Users (UserId),
+) PRIMARY KEY (PostId, LikerId), INTERLEAVE IN PARENT Posts;
+
+CREATE TABLE ChatRooms (
+  ChatRoomId   STRING(36)  NOT NULL,
+  ChatRoomName STRING(128) NOT NULL,
+) PRIMARY KEY (ChatRoomId);
+
+CREATE TABLE ChatRoomMembers (
+  ChatRoomId STRING(36) NOT NULL,
+  UserId     STRING(36) NOT NULL,
+
+  FOREIGN KEY (ChatRoomId) REFERENCES ChatRooms (ChatRoomId),
+  FOREIGN KEY (UserId) REFERENCES Users (UserId),
+) PRIMARY KEY (ChatRoomId, UserId);
+
+CREATE TABLE ChatRoomMessages (
+  ChatRoomId        STRING(36)  NOT NULL,
+  ChatRoomMessageId STRING(36)  NOT NULL,
+  UserId            STRING(36)  NOT NULL,
+  Text              STRING(MAX) NOT NULL,
+
+  FOREIGN KEY (ChatRoomId, UserId) REFERENCES ChatRoomMembers (ChatRoomId, UserId),
+) PRIMARY KEY (ChatRoomId, ChatRoomMessageId), INTERLEAVE IN PARENT ChatRooms;
+
+CREATE TABLE Communities (
+  CommunityId   STRING(36)  NOT NULL,
+  CommunityName STRING(128) NOT NULL,
+  OwnerId       STRING(36)  NOT NULL,
+
+  FOREIGN KEY (OwnerId) REFERENCES Users (UserId),
+) PRIMARY KEY (CommunityId);
+
+CREATE TABLE CommunityBelongings (
+  UserId      STRING(36) NOT NULL,
+  CommunityId STRING(36) NOT NULL,
+
+  FOREIGN KEY (CommunityId) REFERENCES Communities (CommunityId),
+) PRIMARY KEY (UserId, CommunityId), INTERLEAVE IN PARENT Users;
+
+CREATE TABLE CommunityPosts (
+  CommunityId STRING(36) NOT NULL,
+  PostId      STRING(36) NOT NULL,
+
+  FOREIGN KEY (PostId) REFERENCES Posts (PostId),
+) PRIMARY KEY (CommunityId, PostId), INTERLEAVE IN PARENT Communities;
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner-spanner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - nownabe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Strategies for cleaning tables on Cloud Spanner. Can be used to ensure
   a clean state for testing.
 email:
@@ -51,14 +79,109 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - database_cleaner-spanner.gemspec
+- example/rails/.gitattributes
+- example/rails/.gitignore
+- example/rails/.rspec
+- example/rails/.ruby-version
+- example/rails/Gemfile
+- example/rails/README.md
+- example/rails/Rakefile
+- example/rails/app/assets/config/manifest.js
+- example/rails/app/assets/images/.keep
+- example/rails/app/assets/stylesheets/application.css
+- example/rails/app/channels/application_cable/channel.rb
+- example/rails/app/channels/application_cable/connection.rb
+- example/rails/app/controllers/application_controller.rb
+- example/rails/app/controllers/concerns/.keep
+- example/rails/app/helpers/application_helper.rb
+- example/rails/app/javascript/application.js
+- example/rails/app/javascript/controllers/application.js
+- example/rails/app/javascript/controllers/hello_controller.js
+- example/rails/app/javascript/controllers/index.js
+- example/rails/app/jobs/application_job.rb
+- example/rails/app/mailers/application_mailer.rb
+- example/rails/app/models/album.rb
+- example/rails/app/models/application_record.rb
+- example/rails/app/models/concerns/.keep
+- example/rails/app/models/customer.rb
+- example/rails/app/models/order.rb
+- example/rails/app/models/product.rb
+- example/rails/app/models/singer.rb
+- example/rails/app/models/song.rb
+- example/rails/app/views/layouts/application.html.erb
+- example/rails/app/views/layouts/mailer.html.erb
+- example/rails/app/views/layouts/mailer.text.erb
+- example/rails/bin/bundle
+- example/rails/bin/importmap
+- example/rails/bin/rails
+- example/rails/bin/rake
+- example/rails/bin/setup
+- example/rails/config.ru
+- example/rails/config/application.rb
+- example/rails/config/boot.rb
+- example/rails/config/cable.yml
+- example/rails/config/credentials.yml.enc
+- example/rails/config/database.yml
+- example/rails/config/environment.rb
+- example/rails/config/environments/development.rb
+- example/rails/config/environments/production.rb
+- example/rails/config/environments/test.rb
+- example/rails/config/importmap.rb
+- example/rails/config/initializers/assets.rb
+- example/rails/config/initializers/content_security_policy.rb
+- example/rails/config/initializers/filter_parameter_logging.rb
+- example/rails/config/initializers/inflections.rb
+- example/rails/config/initializers/permissions_policy.rb
+- example/rails/config/locales/en.yml
+- example/rails/config/puma.rb
+- example/rails/config/routes.rb
+- example/rails/config/storage.yml
+- example/rails/db/migrate/20221113100815_create_customers.rb
+- example/rails/db/migrate/20221113101016_create_products.rb
+- example/rails/db/migrate/20221113101027_create_orders.rb
+- example/rails/db/migrate/20221113101034_create_singers.rb
+- example/rails/db/migrate/20221113101039_create_albums.rb
+- example/rails/db/migrate/20221113101044_create_songs.rb
+- example/rails/db/schema.rb
+- example/rails/db/seeds.rb
+- example/rails/lib/assets/.keep
+- example/rails/lib/tasks/.keep
+- example/rails/log/.keep
+- example/rails/public/404.html
+- example/rails/public/422.html
+- example/rails/public/500.html
+- example/rails/public/apple-touch-icon-precomposed.png
+- example/rails/public/apple-touch-icon.png
+- example/rails/public/favicon.ico
+- example/rails/public/robots.txt
+- example/rails/spec/factories/factory.rb
+- example/rails/spec/models/album_spec.rb
+- example/rails/spec/models/customer_spec.rb
+- example/rails/spec/models/order_spec.rb
+- example/rails/spec/models/product_spec.rb
+- example/rails/spec/models/singer_spec.rb
+- example/rails/spec/models/song_spec.rb
+- example/rails/spec/rails_helper.rb
+- example/rails/spec/sample_spec.rb
+- example/rails/spec/spec_helper.rb
+- example/rails/spec/support/factory_bot.rb
+- example/rails/storage/.keep
+- example/rails/tmp/.keep
+- example/rails/tmp/pids/.keep
+- example/rails/tmp/storage/.keep
+- example/rails/vendor/.keep
+- example/rails/vendor/javascript/.keep
 - lib/database_cleaner-spanner.rb
 - lib/database_cleaner/spanner.rb
 - lib/database_cleaner/spanner/deletion.rb
 - lib/database_cleaner/spanner/table_dependency.rb
 - lib/database_cleaner/spanner/version.rb
+- scripts/performance_test.rb
+- scripts/schema.sql
 - sig/database_cleaner/spanner.rbs
 homepage: https://github.com/nownabe/database_cleaner-spanner
 licenses: