Add multi-user licenses (again)

Gemfile

@@ -20,7 +20,7 @@ gem 'redis', '~> 4.7.1'
 gem 'request_migrations', '~> 1.1'
 
 # API params
-gem 'typed_params', '~> 1.1'
+gem 'typed_params', '~> 1.2.3'
 
 # Serializers
 gem 'json', '~> 2.3.0'
@@ -51,6 +51,7 @@ gem 'kaminari', '~> 1.2.0'
 gem 'active_record_union'
 gem 'active_record_distinct_on', '~> 1.6'
 gem 'activerecord_where_assoc', '~> 1.1.4'
+gem 'ar_lazy_preload', '~> 2.0'
 gem 'strong_migrations'
 
 # Pattern matching
@@ -124,7 +125,7 @@ group :test do
   gem 'cucumber-rails', '~> 2.5', require: false
   gem 'rspec-rails', '~> 6.0.3'
   gem 'rspec-expectations', '~> 3.12.1'
-  gem 'db-query-matchers'
+  gem 'anbt-sql-formatter'
   gem 'factory_bot_rails', '~> 6.2'
   gem 'database_cleaner', '~> 2.0'
   gem 'webmock', '~> 3.14.0'

Gemfile.lock

@@ -97,6 +97,8 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    anbt-sql-formatter (0.1.0)
+    ar_lazy_preload (2.0.0)
     aws-eventstream (1.2.0)
     aws-partitions (1.571.0)
     aws-sdk-core (3.130.0)
@@ -190,9 +192,6 @@ GEM
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
     date (3.3.3)
-    db-query-matchers (0.12.0)
-      activesupport (>= 4.0, < 7.2)
-      rspec (>= 3.0)
     diff-lcs (1.5.0)
     dotenv (2.7.6)
     dotenv-rails (2.7.6)
@@ -406,10 +405,6 @@ GEM
       rack (>= 1.4)
     rexml (3.2.5)
     rotp (6.2.0)
-    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.1)
@@ -494,7 +489,7 @@ GEM
     timecop (0.9.5)
     timeout (0.4.0)
     tracer (0.1.1)
-    typed_params (1.1.0)
+    typed_params (1.2.3)
       rails (>= 6.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -521,6 +516,8 @@ DEPENDENCIES
   active_record_distinct_on (~> 1.6)
   active_record_union
   activerecord_where_assoc (~> 1.1.4)
+  anbt-sql-formatter
+  ar_lazy_preload (~> 2.0)
   aws-sdk-s3 (~> 1)
   barnes
   bcrypt (~> 3.1.7)
@@ -529,7 +526,6 @@ DEPENDENCIES
   cucumber-rails (~> 2.5)
   cuke_modeler (~> 3.19)
   database_cleaner (~> 2.0)
-  db-query-matchers
   dotenv-rails
   ed25519
   elif (~> 0.1.0)
@@ -583,7 +579,7 @@ DEPENDENCIES
   strong_migrations
   timecop (~> 0.9.5)
   tracer
-  typed_params (~> 1.1)
+  typed_params (~> 1.2.3)
   uri (>= 0.12.2)
   webmock (~> 3.14.0)
 

README.md

@@ -132,9 +132,9 @@ bundle exec rails keygen:setup
 
 ### Seeding
 
-To seed the database with sample data, run (optional, takes about an hour):
+To seed the database with sample data, run (optional):
 
-```
+```bash
 bundle exec rails db:seed:development
 ```
 
@@ -152,9 +152,21 @@ To start a worker, run:
 bundle exec sidekiq
 ```
 
+To start a console, run:
+
+```bash
+bundle exec rails console
+```
+
 ### Testing
 
-To run the entire test suite, specs and features, run (takes about 20 mins on a 16-core CPU):
+To setup the test environment, run:
+
+```bash
+bundle exec rake test:setup
+```
+
+To run the entire test suite, specs and features, run (takes ~20 mins on a 16-core CPU):
 
 ```bash
 bundle exec rake test
@@ -164,12 +176,14 @@ To run Cucumber features, run:
 
 ```bash
 bundle exec rake test:cucumber
+bundle exec rake test:cucumber[features/api/v1/licenses/create.feature]
 ```
 
 To run Rspec specs, run:
 
 ```bash
 bundle exec rake test:rspec
+bundle exec rake test:rspec[spec/models/license_spec.rb]
 ```
 
 ## License

app/controllers/api/v1/groups/relationships/licenses_controller.rb

@@ -10,7 +10,7 @@ class LicensesController < Api::V1::BaseController
     authorize :group
 
     def index
-      licenses = apply_pagination(authorized_scope(apply_scopes(group.licenses), with: Groups::LicensePolicy).preload(:role, :user, :policy, :product))
+      licenses = apply_pagination(authorized_scope(apply_scopes(group.licenses), with: Groups::LicensePolicy).preload(:role, :policy, :product, owner: %i[role]))
       authorize! licenses,
         with: Groups::LicensePolicy
 

app/controllers/api/v1/groups/relationships/machines_controller.rb

@@ -10,7 +10,7 @@ class MachinesController < Api::V1::BaseController
     authorize :group
 
     def index
-      machines = apply_pagination(authorized_scope(apply_scopes(group.machines), with: Groups::MachinePolicy).preload(:product, :policy, :license, :user))
+      machines = apply_pagination(authorized_scope(apply_scopes(group.machines), with: Groups::MachinePolicy).preload(:product, :policy, :owner, license: %i[owner]))
       authorize! machines,
         with: Groups::MachinePolicy
 

app/controllers/api/v1/licenses/actions/checkouts_controller.rb

@@ -10,9 +10,15 @@ class CheckoutsController < Api::V1::BaseController
     authorize :license
 
     typed_query {
-      param :include, type: :array, coerce: true, allow_blank: true, optional: true
       param :encrypt, type: :boolean, coerce: true, optional: true
       param :ttl, type: :integer, coerce: true, allow_nil: true, optional: true
+      param :include, type: :array, coerce: true, allow_blank: true, optional: true, transform: -> key, includes {
+        # FIXME(ezekg) For backwards compatibility. Replace user include with
+        #              owner when present.
+        includes.push('owner') if includes.delete('user')
+
+        [key, includes]
+      }
     }
     def show
       kwargs = checkout_query.slice(
@@ -39,15 +45,23 @@ def show
       format :jsonapi
 
       param :meta, type: :hash, optional: true do
-        param :include, type: :array, allow_blank: true, optional: true
         param :encrypt, type: :boolean, optional: true
         param :ttl, type: :integer, coerce: true, allow_nil: true, optional: true
+        param :include, type: :array, allow_blank: true, optional: true, transform: -> key, includes {
+          includes.push('owner') if includes.delete('user')
+
+          [key, includes]
+        }
       end
     }
     typed_query {
-      param :include, type: :array, coerce: true, allow_blank: true, optional: true
       param :encrypt, type: :boolean, coerce: true, optional: true
       param :ttl, type: :integer, coerce: true, allow_nil: true, optional: true
+      param :include, type: :array, coerce: true, allow_blank: true, optional: true, transform: -> key, includes {
+        includes.push('owner') if includes.delete('user')
+
+        [key, includes]
+      }
     }
     def create
       kwargs = checkout_query.merge(checkout_meta)
@@ -73,7 +87,9 @@ def create
     attr_reader :license
 
     def set_license
-      scoped_licenses = authorized_scope(current_account.licenses)
+      scoped_licenses = authorized_scope(current_account.licenses).lazy_preload(
+        users: :role,
+      )
 
       @license = FindByAliasService.call(scoped_licenses, id: params[:id], aliases: :key)
 

app/controllers/api/v1/licenses/relationships/entitlements_controller.rb

@@ -100,7 +100,7 @@ def detach
         invalid_idx             = entitlement_ids.find_index(invalid_entitlement_id)
 
         return render_unprocessable_entity(
-          detail: "entitlement '#{invalid_entitlement_id}' relationship not found",
+          detail: "cannot detach entitlement '#{invalid_entitlement_id}' (entitlement is not attached)",
           source: {
             pointer: "/data/#{invalid_idx}",
           },

app/controllers/api/v1/licenses/relationships/machines_controller.rb

@@ -14,7 +14,7 @@ class MachinesController < Api::V1::BaseController
     authorize :license
 
     def index
-      machines = apply_pagination(authorized_scope(apply_scopes(license.machines)).preload(:product, :policy))
+      machines = apply_pagination(authorized_scope(apply_scopes(license.machines)).preload(:product, :policy, :owner, license: %i[owner]))
       authorize! machines,
         with: Licenses::MachinePolicy
 

app/controllers/api/v1/licenses/relationships/owners_controller.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Api::V1::Licenses::Relationships
+  class OwnersController < Api::V1::BaseController
+    before_action :scope_to_current_account!
+    before_action :require_active_subscription!
+    before_action :authenticate_with_token!
+    before_action :set_license
+
+    authorize :license
+
+    def show
+      owner = license.owner
+      authorize! owner,
+        with: Licenses::OwnerPolicy
+
+      render jsonapi: owner
+    end
+
+    typed_params {
+      format :jsonapi
+
+      param :data, type: :hash, allow_nil: true do
+        param :type, type: :string, inclusion: { in: %w[user users] }
+        param :id, type: :uuid
+      end
+    }
+    def update
+      owner = license.owner
+      authorize! owner,
+        with: Licenses::OwnerPolicy
+
+      license.update!(user_id: owner_params[:id])
+
+      BroadcastEventService.call(
+        event: 'license.owner.updated',
+        account: current_account,
+        resource: license,
+      )
+
+      # FIXME(ezekg) This should be the user
+      render jsonapi: license
+    end
+
+    private
+
+    attr_reader :license
+
+    def set_license
+      scoped_licenses = authorized_scope(current_account.licenses)
+
+      @license = FindByAliasService.call(scoped_licenses, id: params[:license_id], aliases: :key)
+
+      Current.resource = license
+    end
+  end
+end