mongoid 7.1.0.rc0 → 7.1.0

data/lib/mongoid/tasks/database.rake

@@ -5,27 +5,32 @@ namespace :db do
     task :load_models do
     end
 
-    desc "Create the indexes defined on your mongoid models"
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.create_indexes
     end
 
-    desc "Remove indexes that exist in the database but aren't specified on the models"
+    desc "Remove indexes that exist in the database but are not specified in Mongoid models"
     task :remove_undefined_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_undefined_indexes
     end
 
-    desc "Remove the indexes defined on your mongoid models without questions!"
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_indexes
     end
 
-    desc "Drops the default client database"
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.shard_collections
+    end
+
+    desc "Drop the database of the default Mongoid client"
     task :drop => :environment do
       ::Mongoid::Clients.default.database.drop
     end
 
-    desc "Drop all collections except the system collections"
+    desc "Drop all non-system collections"
     task :purge => :environment do
       ::Mongoid.purge!
     end

data/lib/mongoid/tasks/database.rb

@@ -108,6 +108,54 @@ module Mongoid
         end.compact
       end
 
+      # Shard collections for models that declare shard keys.
+      #
+      # Returns the model classes that have had their collections sharded,
+      # including model classes whose collections had already been sharded
+      # prior to the invocation of this method.
+      #
+      # @example Shard all collections
+      #   Mongoid::Tasks::Database.shard_collections
+      #
+      # @return [ Array<Class> ] The sharded models
+      def shard_collections(models = ::Mongoid.models)
+        models.map do |model|
+          next if model.shard_config.nil?
+
+          if model.embedded? && !model.cyclic?
+            logger.warn("MONGOID: #{model} has shard config but is emdedded")
+            next
+          end
+
+          unless model.collection.cluster.sharded?
+            logger.warn("MONGOID: #{model} has shard config but is not persisted in a sharded cluster: #{model.collection.cluster.summary}")
+            next
+          end
+
+          # Database must exist in order to run collStats
+          model.collection.create
+
+          stats = model.collection.database.command(collStats: model.collection.name).first
+          if stats[:sharded]
+            logger.info("MONGOID: #{model.collection.namespace} is already sharded for #{model}")
+            next model
+          end
+
+          admin_db = model.collection.client.use(:admin).database
+          admin_db.command(enableSharding: model.collection.database.name)
+          begin
+            admin_db.command(shardCollection: model.collection.namespace, **model.shard_config)
+          rescue Mongo::Error::OperationFailure => e
+            logger.error("MONGOID: Failed to shard collection #{model.collection.namespace} for #{model}: #{e.class}: #{e}")
+            next
+          end
+
+          logger.info("MONGOID: Sharded collection #{model.collection.namespace} for #{model}")
+
+          model
+        end.compact
+      end
+
       private
 
       def logger

data/lib/mongoid/timestamps/timeless.rb

@@ -44,11 +44,13 @@ module Mongoid
       end
 
       class << self
+        extend Forwardable
 
         def timeless_table
           Thread.current['[mongoid]:timeless'] ||= Hash.new
         end
-        delegate :[]=, :[], to: :timeless_table
+
+        def_delegators :timeless_table, :[]=, :[]
       end
 
       private

data/lib/mongoid/version.rb

@@ -2,5 +2,5 @@
 # encoding: utf-8
 
 module Mongoid
-  VERSION = "7.1.0.rc0"
+  VERSION = "7.1.0"
 end

data/spec/integration/shardable_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+require_relative '../mongoid/shardable_models'
+
+describe 'Sharding helpers' do
+  require_topology :sharded
+
+  describe 'shard_collection rake task' do
+    let(:shard_collections) do
+      Mongoid::Tasks::Database.shard_collections([model_cls])
+    end
+
+    let(:create_indexes) do
+      Mongoid::Tasks::Database.create_indexes([model_cls])
+    end
+
+    shared_examples_for 'shards collection' do
+      it 'returns the model class' do
+        shard_collections.should == [model_cls]
+      end
+
+      it 'shards collection' do
+        shard_collections
+
+        stats = model_cls.collection.database.command(collStats: model_cls.collection.name).first
+        stats[:sharded].should be true
+      end
+    end
+
+    context 'simple model' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        SmMovie.collection.drop
+      end
+
+      it_behaves_like 'shards collection'
+
+      it 'makes inserts work' do
+        shard_collections
+        create_indexes
+
+        SmMovie.create!(year: 2020)
+      end
+    end
+
+    context 'when database does not exist' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        SmMovie.collection.database.drop
+      end
+
+      it_behaves_like 'shards collection'
+    end
+
+    context 'when database exists but collection does not exist' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        SmMovie.collection.database.drop
+        SmMovie.collection.create
+        SmMovie.collection.drop
+      end
+
+      it_behaves_like 'shards collection'
+    end
+
+    context 'when collection is already sharded' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        Mongoid::Tasks::Database.shard_collections([model_cls])
+      end
+
+      it_behaves_like 'shards collection'
+    end
+
+    context 'when hashed shard key is given' do
+      let(:model_cls) { SmAssistant }
+
+      before do
+        SmAssistant.collection.drop
+      end
+
+      it_behaves_like 'shards collection'
+
+      it 'makes inserts work' do
+        shard_collections
+        create_indexes
+
+        SmAssistant.create!(gender: 'm')
+      end
+    end
+
+    context 'when shard configuration is invalid' do
+      let(:model_cls) { SmActor }
+
+      it 'returns empty array' do
+        shard_collections.should == []
+      end
+
+      it 'does not shards collection' do
+        shard_collections
+
+        stats = model_cls.collection.database.command(collStats: model_cls.collection.name).first
+        stats[:sharded].should be false
+      end
+
+    end
+
+    context 'when models have no sharded configuration' do
+      let(:model_cls) { SmNotSharded }
+
+      before do
+        model_cls.shard_config.should be nil
+      end
+
+      it 'returns empty array' do
+        shard_collections.should == []
+      end
+
+      it 'does not shards collection' do
+        shard_collections
+
+        stats = model_cls.collection.database.command(collStats: model_cls.collection.name).first
+        stats[:sharded].should be false
+      end
+    end
+  end
+end

data/spec/lite_spec_helper.rb

@@ -15,6 +15,7 @@ require "mongo"
 require 'pp'
 
 require 'support/spec_config'
+require 'support/lite_constraints'
 
 unless SpecConfig.instance.ci?
   begin
@@ -58,6 +59,8 @@ RSpec.configure do |config|
       end
     end
   end
+
+  config.extend(LiteConstraints)
 end
 
 # require all shared examples

data/spec/mongoid/association/referenced/has_many/enumerable_spec.rb

@@ -782,11 +782,7 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
     end
   end
 
-  shared_examples 'first or one' do
-
-    subject do
-      enumerable.public_send(subject_method)
-    end
+  describe "#first" do
 
     let(:person) do
       Person.create
@@ -810,8 +806,12 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
             Post.create(person_id: person.id)
           end
 
+          let(:first) do
+            enumerable.first
+          end
+
           it "returns the first unloaded doc" do
-            expect(subject).to eq(post)
+            expect(first).to eq(post)
           end
 
           it "does not load the enumerable" do
@@ -820,7 +820,7 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
 
           it "receives query only once" do
             expect(criteria).to receive(:first).once
-            subject
+            first
           end
         end
 
@@ -838,10 +838,14 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
             enumerable << post_two
           end
 
+          let(:first) do
+            enumerable.first
+          end
+
           context "when a perviously persisted unloaded doc exists" do
 
             it "returns the first added doc" do
-              expect(subject).to eq(post)
+              expect(first).to eq(post)
             end
 
             it "does not load the enumerable" do
@@ -861,8 +865,12 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
           enumerable << post
         end
 
+        let(:first) do
+          enumerable.first
+        end
+
         it "returns the first loaded doc" do
-          expect(subject).to eq(post)
+          expect(first).to eq(post)
         end
 
         it "does not load the enumerable" do
@@ -872,8 +880,12 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
 
       context "when unloaded and added are empty" do
 
+        let(:first) do
+          enumerable.first
+        end
+
         it "returns nil" do
-          expect(subject).to be_nil
+          expect(first).to be_nil
         end
 
         it "does not load the enumerable" do
@@ -894,8 +906,12 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
           described_class.new([ post ])
         end
 
+        let(:first) do
+          enumerable.first
+        end
+
         it "returns the first loaded doc" do
-          expect(subject).to eq(post)
+          expect(first).to eq(post)
         end
       end
 
@@ -913,8 +929,12 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
           enumerable << post
         end
 
+        let(:first) do
+          enumerable.first
+        end
+
         it "returns the first added doc" do
-          expect(subject).to eq(post)
+          expect(first).to eq(post)
         end
       end
 
@@ -924,8 +944,12 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
           described_class.new([])
         end
 
+        let(:first) do
+          enumerable.first
+        end
+
         it "returns nil" do
-          expect(subject).to be_nil
+          expect(first).to be_nil
         end
       end
     end
@@ -953,21 +977,9 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
       end
 
       it 'does not use the sort on id' do
-        expect(enumerable.send(subject_method, id_sort: :none)).to eq(first_post)
+        expect(enumerable.first(id_sort: :none)).to eq(first_post)
       end
     end
-  end
-
-  describe "#first" do
-    let(:subject_method) do
-      :first
-    end
-
-    it_behaves_like 'first or one'
-
-    subject do
-      enumerable.public_send(subject_method)
-    end
 
     context 'when the id_sort option is not provided' do
 
@@ -984,54 +996,15 @@ describe Mongoid::Association::Referenced::HasMany::Targets::Enumerable do
       end
 
       let!(:first_post) do
-        person.posts.create(id: 'one', title: "One")
+        person.posts.create(title: "One")
       end
 
       let!(:second_post) do
-        person.posts.create(id: 'atwo', title: "Two")
+        person.posts.create(title: "Two")
       end
 
       it 'uses the sort on id' do
-        expect(subject).to eq(second_post)
-      end
-    end
-  end
-
-  describe "#one" do
-    let(:subject_method) do
-      :one
-    end
-
-    it_behaves_like 'first or one'
-
-    subject do
-      enumerable.public_send(subject_method)
-    end
-
-    context 'when the id_sort option is not provided' do
-
-      let(:person) do
-        Person.create
-      end
-
-      let(:criteria) do
-        Post.where(person_id: person.id)
-      end
-
-      let(:enumerable) do
-        described_class.new(criteria)
-      end
-
-      let!(:first_post) do
-        person.posts.create(id: 'one', title: "One")
-      end
-
-      let!(:second_post) do
-        person.posts.create(id: 'atwo', title: "Two")
-      end
-
-      it 'does not use the sort on id' do
-        expect(subject).to eq(first_post)
+        expect(enumerable.first).to eq(first_post)
       end
     end
   end