neo4j 8.0.0.alpha.1 → 8.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae62feb1503e7f65d35cbc182034a65a28c9361b
-  data.tar.gz: 5ddeb82fa562a1868c1a6b5d8898c5b0dca80276
+  metadata.gz: 74a57c27a28cfa8eda0a7a71413d428e40d2802a
+  data.tar.gz: 51e4a2ef533ae4fbe85daa56365f8e7244ffa7f3
 SHA512:
-  metadata.gz: 8acc45e1a6fa2cc4c314558f12b737ab2ffa0c30b914244672839da5f7ab9a64ea4194f39d9e4b90cb6f85e7a32b10b2f73c52eedd28c5d4bf072828881d4acc
-  data.tar.gz: 47c95259853558c3637073ef6150d3f53c6af8bf54c9866cee1fcff543561482e48e38bdc723916ba41c6125fa073dfb53f26689a15f497cd211b57deb8109af
+  metadata.gz: 8f0bdf1994b8871a6c5f333661fa6f77d46f3cb7a0c811b1612580509d8829979dac47461a5978758a732fd04fa940489ba53da41bdf78b8d14303545a8c94f7
+  data.tar.gz: 68279d917be513365d828850cd5967c350d574fe9d0bbf0d4b7aff6d7fb767e2720c0a911e9076a7bd89706401e775a6545801a0ca632fd17dc06aa51b51a102

data/CHANGELOG.md

@@ -3,7 +3,20 @@ All notable changes to this project will be documented in this file.
 This file should follow the standards specified on [http://keepachangelog.com/]
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased] Unreleased
+## [8.0.0.alpha.2] 2016-08-05
+
+### Changed
+
+- Improve migration output format / show execution time in migrations
+
+### Fixed
+
+- Caching of model index and constraint checks
+- Error when running schema migrations.  Migrations now give a warning and instructions if a migration fails and cannot be recovered
+- Error when running rake tasks to generate "force" creations of indexes / constraints and there is no migration directory
+- `WARNING` is no longer displayed for constraints defined from `id_property` (either one which is implict or explict)
+
+## [8.0.0.alpha.1] 2016-08-02
 
 ### Changed
 

data/Gemfile

@@ -7,8 +7,10 @@ gemspec
 if branch = ENV['TRAVIS_BRANCH']
   same_branch_exists = `curl --head https://github.com/neo4jrb/neo4j-core/tree/#{branch} | head -1`.match(/200 OK/)
   gem 'neo4j-core', github: 'neo4jrb/neo4j-core', branch: same_branch_exists ? branch : 'master'
+elsif ENV['USE_LOCAL_CORE']
+  gem 'neo4j-core', path: '../neo4j-core'
 else
-  gem 'neo4j-core', github: 'neo4jrb/neo4j-core'
+  gem 'neo4j-core'
 end
 
 # gem 'active_attr', github: 'neo4jrb/active_attr', branch: 'performance'

data/lib/neo4j/active_node.rb

@@ -56,6 +56,12 @@ module Neo4j
       _persisted_obj || fail('Tried to access native neo4j object on a non persisted object')
     end
 
+    LOADED_CLASSES = []
+
+    def self.loaded_classes
+      LOADED_CLASSES
+    end
+
     module ClassMethods
       def nodeify(object)
         if object.is_a?(::Neo4j::ActiveNode) || object.nil?
@@ -68,12 +74,14 @@ module Neo4j
 
     included do
       include Neo4j::Timestamps if Neo4j::Config[:record_timestamps]
+      LOADED_CLASSES << self
 
       def self.inherited?
         !!@inherited
       end
 
       def self.inherited(other)
+        LOADED_CLASSES << other
         other.instance_variable_set('@inherited', true)
         inherit_id_property(other)
         attributes.each_pair do |k, v|

data/lib/neo4j/migrations/base.rb

@@ -11,17 +11,8 @@ module Neo4j
       end
 
       def migrate(method)
-        ensure_schema_migration_constraint
         Benchmark.realtime do
-          ActiveBase.run_transaction(transactions?) do
-            if method == :up
-              up
-              SchemaMigration.create!(migration_id: @migration_id)
-            else
-              down
-              SchemaMigration.find_by!(migration_id: @migration_id).destroy
-            end
-          end
+          method == :up ? migrate_up : migrate_down
         end
       end
 
@@ -35,9 +26,48 @@ module Neo4j
 
       private
 
-      def ensure_schema_migration_constraint
-        SchemaMigration.first
-        Neo4j::Core::Label.wait_for_schema_changes(ActiveBase.current_session)
+      def migrate_up
+        schema = SchemaMigration.create!(migration_id: @migration_id, incomplete: true)
+        begin
+          run_migration(:up)
+        rescue StandardError => e
+          schema.destroy
+          handle_migration_error!(e)
+        end
+        schema.update!(incomplete: nil)
+      end
+
+      def migrate_down
+        schema = SchemaMigration.find_by!(migration_id: @migration_id)
+        schema.update!(incomplete: true)
+        begin
+          run_migration(:down)
+        rescue StandardError => e
+          schema.update!(incomplete: nil)
+          handle_migration_error!(e)
+        end
+        schema.destroy
+      end
+
+      def run_migration(direction)
+        migration_transaction { log_queries { public_send(direction) } }
+      end
+
+      def handle_migration_error!(e)
+        fail e unless e.message =~ /Cannot perform data updates in a transaction that has performed schema updates./
+        fail MigrationError,
+             "#{e.message}. Please add `disable_transactions!` in your migration file."
+      end
+
+      def migration_transaction(&block)
+        ActiveBase.run_transaction(transactions?, &block)
+      end
+
+      def log_queries
+        subscriber = Neo4j::Core::CypherSession::Adaptors::Base.subscribe_to_query(&method(:output))
+        yield
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
       end
     end
   end

data/lib/neo4j/migrations/helpers/schema.rb

@@ -8,9 +8,10 @@ module Neo4j
 
         def add_constraint(label, property, options = {})
           force = options[:force] || false
+          type = options[:type] || :uniqueness
           label_object = ActiveBase.label_object(label)
           fail_duplicate_constraint_or_index!(:constraint, label, property) if !force && label_object.constraint?(property)
-          label_object.create_constraint(property, type: :uniqueness)
+          label_object.create_constraint(property, type: type)
         end
 
         def add_index(label, property, options = {})
@@ -20,14 +21,11 @@ module Neo4j
           label_object.create_index(property)
         end
 
-        def force_add_index(label, property)
-          add_index(label, property)
-        end
-
-        def drop_constraint(label, property)
+        def drop_constraint(label, property, options = {})
+          type = options[:type] || :uniqueness
           label_object = ActiveBase.label_object(label)
           fail_missing_constraint_or_index!(:constraint, label, property) if !label_object.constraint?(property)
-          label_object.drop_constraint(property, type: :uniqueness)
+          label_object.drop_constraint(property, type: type)
         end
 
         def drop_index(label, property)

data/lib/neo4j/migrations/runner.rb

@@ -7,15 +7,18 @@ module Neo4j
       STATUS_TABLE_HEADER = ['Status'.freeze, 'Migration ID'.freeze, 'Migration Name'.freeze].freeze
       UP_MESSAGE = 'up'.freeze
       DOWN_MESSAGE = 'down'.freeze
+      INCOMPLETE_MESSAGE = 'incomplete'.freeze
       MIGRATION_RUNNING = {up: 'running'.freeze, down: 'reverting'.freeze}.freeze
       MIGRATION_DONE = {up: 'migrated'.freeze, down: 'reverted'.freeze}.freeze
 
       def initialize
         SchemaMigration.mapped_label.create_constraint(:migration_id, type: :unique)
-        @up_versions = SortedSet.new(SchemaMigration.all.pluck(:migration_id))
+        @schema_migrations = SchemaMigration.all.to_a
+        @up_versions = SortedSet.new(@schema_migrations.map(&:migration_id))
       end
 
       def all
+        handle_incomplete_states!
         migration_files.each do |migration_file|
           next if up?(migration_file.version)
           migrate(:up, migration_file)
@@ -23,18 +26,21 @@ module Neo4j
       end
 
       def up(version)
+        handle_incomplete_states!
         migration_file = find_by_version!(version)
         return if up?(version)
         migrate(:up, migration_file)
       end
 
       def down(version)
+        handle_incomplete_states!
         migration_file = find_by_version!(version)
         return unless up?(version)
         migrate(:down, migration_file)
       end
 
       def rollback(steps)
+        handle_incomplete_states!
         @up_versions.to_a.reverse.first(steps).each do |version|
           down(version)
         end
@@ -44,15 +50,55 @@ module Neo4j
         output STATUS_TABLE_FORMAT, *STATUS_TABLE_HEADER
         output SEPARATOR
         all_migrations.each do |version|
-          status = up?(version) ? UP_MESSAGE : DOWN_MESSAGE
+          status = migration_status(version)
           migration_file = find_by_version(version)
           migration_name = migration_file ? migration_file.class_name : FILE_MISSING
           output STATUS_TABLE_FORMAT, status, version, migration_name
         end
       end
 
+      def resolve(version)
+        SchemaMigration.find_by!(migration_id: version).update!(incomplete: false)
+        output "Migration #{version} resolved."
+      end
+
+      def reset(version)
+        SchemaMigration.find_by!(migration_id: version).destroy
+        output "Migration #{version} reset."
+      end
+
       private
 
+      def migration_status(version)
+        return DOWN_MESSAGE unless up?(version)
+        incomplete_states.find { |v| v.migration_id == version } ? INCOMPLETE_MESSAGE : UP_MESSAGE
+      end
+
+      def handle_incomplete_states!
+        return unless incomplete_states.any?
+        incomplete_versions = incomplete_states.map(&:migration_id)
+        fail MigrationError, <<-MSG
+There are migrations struck in an incomplete states, that could not be fixed automatically:
+#{incomplete_versions.join('\n')}
+This can happen when there's a critical error inside a migration.
+
+If you think they were was completed correctly, run:
+
+#{task_migration_messages('resolve', incomplete_versions)}
+
+If you want to reset and run the migration again, run:
+
+#{task_migration_messages('reset', incomplete_versions)}
+
+MSG
+      end
+
+      def task_migration_messages(type, versions)
+        versions.map do |version|
+          "rake neo4j:migrate:#{type} VERSION=#{version}"
+        end.join("\n")
+      end
+
       def up?(version)
         @up_versions.include?(version)
       end
@@ -65,15 +111,22 @@ module Neo4j
       end
 
       def migration_message(direction, migration)
-        output "== #{migration.version} #{migration.class_name}: #{MIGRATION_RUNNING[direction]}... ========="
-        yield
-        output "== #{migration.version} #{migration.class_name}: #{MIGRATION_DONE[direction]} ========="
+        output_migration_message "#{migration.version} #{migration.class_name}: #{MIGRATION_RUNNING[direction]}..."
+        time = format('%.4fs', yield)
+        output_migration_message "#{migration.version} #{migration.class_name}: #{MIGRATION_DONE[direction]} (#{time})"
+        output ''
       end
 
       def output(*string_format)
         puts format(*string_format) unless !!ENV['MIGRATIONS_SILENCED']
       end
 
+      def output_migration_message(message)
+        out = "== #{message} "
+        tail = '=' * [0, 80 - out.length].max
+        output "#{out}#{tail}"
+      end
+
       def find_by_version!(version)
         find_by_version(version) || fail(UnknownMigrationVersionError, "No such migration #{version}")
       end
@@ -94,6 +147,10 @@ module Neo4j
         files.map { |file_path| MigrationFile.new(file_path) }
       end
 
+      def incomplete_states
+        @incomplete_states ||= SortedSet.new(@schema_migrations.select(&:incomplete?))
+      end
+
       def files
         Dir[files_path].sort
       end

data/lib/neo4j/migrations/schema_migration.rb

@@ -4,6 +4,11 @@ module Neo4j
       include Neo4j::ActiveNode
       id_property :migration_id
       property :migration_id, type: String
+      property :incomplete, type: Boolean
+
+      def <=>(other)
+        migration_id <=> other.migration_id
+      end
     end
   end
 end

data/lib/neo4j/model_schema.rb

@@ -30,22 +30,26 @@ module Neo4j
       end
 
       def model_constraints
+        return @model_constraints if @model_constraints
+
         constraints = Neo4j::ActiveBase.current_session.constraints.each_with_object({}) do |row, result|
           result[row[:label]] ||= []
           result[row[:label]] << row[:properties]
         end
 
-        schema_elements_list(MODEL_CONSTRAINTS, constraints)
+        @model_constraints = schema_elements_list(MODEL_CONSTRAINTS, constraints)
       end
 
       def model_indexes
+        return @model_indexes if @model_indexes
+
         indexes = Neo4j::ActiveBase.current_session.indexes.each_with_object({}) do |row, result|
           result[row[:label]] ||= []
           result[row[:label]] << row[:properties]
         end
 
-        schema_elements_list(MODEL_INDEXES, indexes) +
-          schema_elements_list(REQUIRED_INDEXES, indexes).reject(&:last)
+        @model_indexes = schema_elements_list(MODEL_INDEXES, indexes) +
+                         schema_elements_list(REQUIRED_INDEXES, indexes).reject(&:last)
         # reject required indexes which are already in the DB
       end
 
@@ -60,12 +64,28 @@ module Neo4j
         end
       end
 
+      def ensure_model_data_state!
+        # If we load a new model, reset everything
+        if @previously_loaded_models_count != Neo4j::ActiveNode.loaded_classes.size
+          # Make sure we've finalized id_property details and have called
+          # add_ constraint/index methods above
+          Neo4j::ActiveNode.loaded_classes.each(&:ensure_id_property_info!)
+          reload_models_data!
+        end
+      end
+
+      def reload_models_data!
+        @previously_loaded_models_count = Neo4j::ActiveNode.loaded_classes.size
+        @model_indexes = @model_constraints = nil
+      end
+
       def validate_model_schema!
+        ensure_model_data_state!
         messages = {index: [], constraint: []}
         [[:constraint, model_constraints], [:index, model_indexes]].each do |type, schema_elements|
           schema_elements.map do |model, label, property_name, exists|
             if exists
-              log_warning!(type, model, property_name)
+              log_warning!(type, model, property_name) if model.id_property_name.to_sym != property_name
             else
               messages[type] << force_add_message(type, label, property_name)
             end
@@ -79,11 +99,13 @@ module Neo4j
 
       def validation_error_message(messages)
         <<MSG
-          Some schema elements were defined by the model (which is no longer support), but they do not exist in the database.  Run the following to create them:
+          Some schema elements were defined by the model (which is no longer supported), but they do not exist in the database.  Run the following to create them:
 
 #{messages[:constraint].join("\n")}
 #{messages[:index].join("\n")}
 
+And then run `rake neo4j:migrate`
+
 (zshell users may need to escape the brackets)
 MSG
       end

data/lib/neo4j/session_manager.rb

@@ -123,7 +123,7 @@ module Neo4j
                 puts
                 return session
               end
-            rescue Faraday::ConnectionFailed => e
+            rescue Neo4j::Core::CypherSession::ConnectionFailedError
               raise e if !wait
 
               putc '.'

data/lib/neo4j/shared/property.rb

@@ -113,7 +113,7 @@ module Neo4j::Shared
 
       def_delegators :declared_properties, :serialized_properties, :serialized_properties=, :serialize, :declared_property_defaults
 
-      VALID_PROPERTY_OPTIONS = %w(type default index constraint serializer typecaster null).map(&:to_sym)
+      VALID_PROPERTY_OPTIONS = %w(type default index constraint serializer typecaster).map(&:to_sym)
       # Defines a property on the class
       #
       # See active_attr gem for allowed options, e.g which type

data/lib/neo4j/tasks/migration.rake

@@ -62,6 +62,20 @@ namespace :neo4j do
       runner = Neo4j::Migrations::Runner.new
       runner.status
     end
+
+    desc 'Resolve an incomplete version state'
+    task resolve: :environment do
+      version = ENV['VERSION'] || fail(ArgumentError, 'VERSION is required')
+      runner = Neo4j::Migrations::Runner.new
+      runner.resolve version
+    end
+
+    desc 'Resolve an incomplete version state'
+    task reset: :environment do
+      version = ENV['VERSION'] || fail(ArgumentError, 'VERSION is required')
+      runner = Neo4j::Migrations::Runner.new
+      runner.reset version
+    end
   end
 
   desc 'Rollbacks migrations given a STEP number'
@@ -84,6 +98,8 @@ namespace :neo4j do
 
     migration_class_name = "ForceCreate#{label.camelize}#{property_name.camelize}#{index_or_constraint.capitalize}"
 
+    require 'fileutils'
+    FileUtils.mkdir_p('db/neo4j/migrate')
     path = File.join('db/neo4j/migrate', "#{DateTime.now.utc.strftime('%Y%m%d%H%M%S')}_#{migration_class_name.underscore}.rb")
 
     content = <<-CONTENT

data/lib/neo4j/version.rb

@@ -1,3 +1,3 @@
 module Neo4j
-  VERSION = '8.0.0.alpha.1'
+  VERSION = '8.0.0.alpha.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j
 version: !ruby/object:Gem::Version
-  version: 8.0.0.alpha.1
+  version: 8.0.0.alpha.2
 platform: ruby
 authors:
 - Andreas Ronge, Brian Underwood, Chris Grigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
@@ -210,8 +210,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.39.0
-description: |
-  A Neo4j OGM (Object-Graph-Mapper) for use in Ruby on Rails and Rack frameworks heavily inspired by ActiveRecord.
+description: 'A Neo4j OGM (Object-Graph-Mapper) for use in Ruby on Rails and Rack
+  frameworks heavily inspired by ActiveRecord.
+
+'
 email: andreas.ronge@gmail.com, brian@brian-underwood.codes, chris@subvertallmedia.com
 executables:
 - neo4j-jars
@@ -358,7 +360,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: neo4j
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A graph database for Ruby