plan_my_stuff 0.22.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d44fbaa2722319a0d586bf8f947222aa76f74462b5516f516f34b87b89ff6211
-  data.tar.gz: 05eaab50eaca5856a19cd68f796b1b4170cb750a6bb8c78566c003a576707122
+  metadata.gz: '0853fca62201cdc20425d04f36c026ac6c774f25c66fc50c8af03153351ec3c9'
+  data.tar.gz: bb2fcbc5a0c73e63a855171c59bea381276e2d6dc3644c46a86cf0c45b5ca0a9
 SHA512:
-  metadata.gz: afbbeca592468025940d1b98eae3c93da09ca79a5406afe5d500f93e8d1803c59d8ced137c81b1e05297678de17920681756983cd0b2a4c253900897f4d5d9b5
-  data.tar.gz: 95ca844953334f3d514c1b530cac5837307b3b735975c18256ab09ad408e1e4aea1f964de8d43ffe4c6b74bdf17284f93d8f114f7e47c4ecb37484023278b28e
+  metadata.gz: 2289f6bfac960098c6c5a9c8fdc90f66a1078f75fb4aea86620f2b65cfdcef201e12c4b48eabd52d5d7bebf8b488051550597544f98433bc2529c44eae4d8a11
+  data.tar.gz: f9c66f66762f229bf9023ac85e6b636740cc74020dbe011f046b6dd391304b2e5d1416abe72bc8a7c9c8c2018c28f8fd393d370a44649fe1767f1c7d96a05fb3

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 0.23.1
+
+### Added
+
+- `PlanMyStuff::UserResolver.from_github_login(login)` - inverse of `config.github_login_for`. Returns the
+  resolved user object whose configured GitHub login matches `login`, or `nil` when `login` is blank or
+  unmapped.
+
+### Changed
+
+- `Webhooks::GithubController` now forwards the actor through to `Pipeline.take!`'s `user:` kwarg from
+  `handle_issue_assigned` (using `assignee.login`) and `handle_draft_opened` (using the PR author). The
+  resolved user lands on the `pipeline_started.plan_my_stuff` notification payload.
+- `Issues::TakesController#create` now forwards `pms_current_user` to `Pipeline.take!`'s `user:` kwarg.
+
+## 0.23.0
+
+### Added
+
+- `PlanMyStuff::Pipeline.take!` and `PlanMyStuff::Pipeline.request_testing!` now accept a `user:` kwarg
+  that is forwarded onto the `pipeline_started.plan_my_stuff` / `pipeline_testing.plan_my_stuff`
+  `ActiveSupport::Notifications` payload. Defaults to `nil`, falling back to
+  `config.current_user` via `PlanMyStuff::Notifications.resolve_current_user`.
+
 ## 0.22.0
 
 ### Added

data/app/controllers/plan_my_stuff/issues/takes_controller.rb

@@ -17,7 +17,7 @@ module PlanMyStuff
         project_item = PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue.number)
         project_item ||= add_to_pipeline(issue)
 
-        PlanMyStuff::Pipeline.take!(project_item)
+        PlanMyStuff::Pipeline.take!(project_item, user: pms_current_user)
         assign_current_user(project_item)
 
         yield(project_item) if block_given?

data/app/controllers/plan_my_stuff/webhooks/github_controller.rb

@@ -119,7 +119,7 @@ module PlanMyStuff
 
           number = PlanMyStuff::Pipeline.resolve_pipeline_project_number!
           project_item = PlanMyStuff::ProjectItem.create!(issue, project_number: number)
-          PlanMyStuff::Pipeline.take!(project_item)
+          PlanMyStuff::Pipeline.take!(project_item, user: PlanMyStuff::UserResolver.from_github_login(assignee_login))
         end
 
         # Removes the issue from the pipeline project when the LAST assignee is removed. If any assignees remain,
@@ -253,7 +253,7 @@ module PlanMyStuff
             issue = PlanMyStuff::Issue.find(issue_number, repo: repo)
 
             if PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue_number).nil?
-              ensure_in_pipeline_at_started(issue)
+              ensure_in_pipeline_at_started(issue, pr_author)
             end
 
             assign_pr_author(issue, pr_author) if pr_author.present? && issue.assignees.empty?
@@ -271,10 +271,11 @@ module PlanMyStuff
         # (Pipeline.take!'s guard would otherwise leave an orphan project item behind).
         #
         # @param issue [PlanMyStuff::Issue]
+        # @param actor_login [String, nil] GitHub login of the webhook actor, mapped to a user via +github_login_for+
         #
         # @return [void]
         #
-        def ensure_in_pipeline_at_started(issue)
+        def ensure_in_pipeline_at_started(issue, actor_login = nil)
           if issue.approvals_required? && !issue.fully_approved?
             Rails.logger.info("[PlanMyStuff] Issue ##{issue.number} has pending approvals, skipping pipeline add")
             return
@@ -282,7 +283,7 @@ module PlanMyStuff
 
           number = PlanMyStuff::Pipeline.resolve_pipeline_project_number!
           project_item = PlanMyStuff::ProjectItem.create!(issue, project_number: number)
-          PlanMyStuff::Pipeline.take!(project_item)
+          PlanMyStuff::Pipeline.take!(project_item, user: PlanMyStuff::UserResolver.from_github_login(actor_login))
         end
 
         # @param issue [PlanMyStuff::Issue]

data/lib/plan_my_stuff/pipeline.rb

@@ -153,15 +153,16 @@ module PlanMyStuff
     # Moves a project item to "Started".
     #
     # @param project_item [PlanMyStuff::ProjectItem]
+    # @param user [Object, nil] actor forwarded to the +pipeline_started.plan_my_stuff+ payload
     #
     # @return [Hash] mutation result
     #
-    def take!(project_item)
+    def take!(project_item, user: nil)
       guard_approvals!(project_item&.issue)
       status = resolve_status_name(PlanMyStuff::Pipeline::Status::STARTED)
       result = project_item.move_to!(status)
 
-      instrument(PlanMyStuff::Pipeline::Status::STARTED, project_item)
+      instrument(PlanMyStuff::Pipeline::Status::STARTED, project_item, user: user)
       result
     end
 
@@ -184,16 +185,17 @@ module PlanMyStuff
     # NOT change the item's +Status+ -- testing runs orthogonally to +In Review+.
     #
     # @param project_item [PlanMyStuff::ProjectItem]
+    # @param user [Object, nil] actor forwarded to the +pipeline_testing.plan_my_stuff+ payload
     #
     # @return [Hash] mutation result
     #
-    def request_testing!(project_item)
+    def request_testing!(project_item, user: nil)
       guard_approvals!(project_item&.issue)
       field_name = PlanMyStuff.configuration.pipeline_testing_field_name
       value = PlanMyStuff.configuration.pipeline_testing_values.fetch(:active)
       result = project_item.update_single_select_field!(field_name, value)
 
-      instrument('testing', project_item, field_name: field_name, value: value)
+      instrument('testing', project_item, field_name: field_name, value: value, user: user)
 
       result
     end

data/lib/plan_my_stuff/test_helpers.rb

@@ -618,12 +618,13 @@ module PlanMyStuff
           take! mark_in_review! request_testing! mark_ready_for_release! start_deployment! complete_deployment!
         ].each { |m| save_original(pipeline_mod, m) }
 
-        pipeline_mod.define_singleton_method(:take!) do |project_item|
+        pipeline_mod.define_singleton_method(:take!) do |project_item, user: nil|
           PlanMyStuff::TestHelpers.recorded_actions << {
             type: :pipeline_started,
             params: {
               item_id: project_item.respond_to?(:id) ? project_item.id : nil,
               issue_number: project_item.respond_to?(:number) ? project_item.number : nil,
+              user: user,
             },
           }
 
@@ -642,7 +643,7 @@ module PlanMyStuff
           nil
         end
 
-        pipeline_mod.define_singleton_method(:request_testing!) do |project_item|
+        pipeline_mod.define_singleton_method(:request_testing!) do |project_item, user: nil|
           field_name = PlanMyStuff.configuration.pipeline_testing_field_name
           value = PlanMyStuff.configuration.pipeline_testing_values.fetch(:active)
 
@@ -653,6 +654,7 @@ module PlanMyStuff
               issue_number: project_item.respond_to?(:number) ? project_item.number : nil,
               field_name: field_name,
               value: value,
+              user: user,
             },
           }
 

data/lib/plan_my_stuff/user_resolver.rb

@@ -43,6 +43,22 @@ module PlanMyStuff
         user.public_send(PlanMyStuff.configuration.user_id_method)
       end
 
+      # Inverse lookup of +config.github_login_for+. Returns the user object whose configured GitHub login matches
+      # +login+, or +nil+ if +login+ is blank or unmapped.
+      #
+      # @param login [String, nil] GitHub login (e.g. from a webhook payload)
+      #
+      # @return [Object, nil]
+      #
+      def from_github_login(login)
+        return if login.blank?
+
+        user_id, _login = PlanMyStuff.configuration.github_login_for.key(login)
+        return if user_id.nil?
+
+        resolve(user_id)
+      end
+
       # Checks whether a user is support staff.
       # Anonymous users (nil) are never support.
       #

data/lib/plan_my_stuff/version.rb

@@ -3,8 +3,8 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 22
-    TINY = 0
+    MINOR = 23
+    TINY = 1
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)
     PRE = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Brands Insurance