slk 0.13.0 → 0.15.0

data/lib/slk/services/huddle_fetch.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Slk
+  module Services
+    # Loads active huddles for one or more workspaces.
+    #
+    # A roster scan is a large download. Workspaces do not share a rate-limit
+    # bucket, and one HTTP connection can only read one of them at a time, so
+    # more than one workspace is fetched concurrently, each on its own client.
+    class HuddleFetch
+      def initialize(runner:, output:)
+        @runner = runner
+        @output = output
+        @counts = {}
+        @mutex = Mutex.new
+      end
+
+      def call(workspaces)
+        @parallel = workspaces.size > 1 && @runner.api_client.respond_to?(:isolated)
+        fetched = WorkspaceFanout.call(workspaces, parallel: @parallel) do |workspace|
+          [workspace, fetch(workspace)]
+        end
+        fetched.map { |workspace, huddles| report(workspace, huddles) }
+      ensure
+        @output.clear_progress
+      end
+
+      private
+
+      def fetch(workspace)
+        client = scan_client
+        users = Api::Users.new(client, workspace, on_debug: debug_logger)
+        HuddleScanner.group(collect(workspace, users))
+      ensure
+        close_client(client)
+      end
+
+      def collect(workspace, users)
+        kept = []
+        users.list_each do |page, total|
+          kept.concat(HuddleScanner.keep(page))
+          note(workspace.name, total)
+        end
+        kept
+      end
+
+      def report(workspace, huddles)
+        labeled = huddles.map { |huddle| huddle.with(channel: labeler.label(workspace, huddle.channel_id)) }
+        Models::WorkspaceHuddles.new(workspace: workspace.name, huddles: labeled)
+      end
+
+      def scan_client
+        return @runner.api_client.isolated if @parallel
+
+        @runner.api_client
+      end
+
+      # The shared client belongs to the rest of the command. An isolated one
+      # exists only for this scan and should not keep its socket open.
+      def close_client(client)
+        return if client.nil? || client.equal?(@runner.api_client)
+
+        client.close if client.respond_to?(:close)
+      end
+
+      def note(name, total)
+        @mutex.synchronize do
+          @counts[name] = total
+          @output.progress(progress_line)
+        end
+      end
+
+      def progress_line
+        return "#{@counts.keys.first}: #{@counts.values.first} members" if @counts.one?
+
+        @counts.map { |name, total| "#{name}: #{total}" }.join(' · ')
+      end
+
+      def labeler
+        @labeler ||= HuddleChannelLabel.new(
+          runner: @runner, cache_store: @runner.cache_store, on_debug: debug_logger
+        )
+      end
+
+      def debug_logger
+        @debug_logger ||= ->(message) { @output.debug(message) }
+      end
+    end
+  end
+end

data/lib/slk/services/huddle_scanner.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Slk
+  module Services
+    # Groups a users.list roster into active huddles.
+    #
+    # Slack has no list-huddles method. A profile's huddle_state is
+    # `in_a_huddle` while they are in one, and huddle_state_call_id is the
+    # shared key. A missing call id is not evidence two people share a call,
+    # so those profiles stay separate. Disagreeing channel ids are dropped
+    # rather than labeling the call with one of them.
+    class HuddleScanner
+      IN_HUDDLE = 'in_a_huddle'
+
+      def self.group(members)
+        new(members).group
+      end
+
+      # People who are not in a huddle are useless to the scan and expensive
+      # to keep. Drop them as each page arrives.
+      def self.keep(members)
+        members.select { |member| in_huddle?(member) && member['id'] }
+      end
+
+      def self.in_huddle?(member)
+        member.dig('profile', 'huddle_state') == IN_HUDDLE
+      end
+
+      def initialize(members)
+        @members = members
+      end
+
+      def group
+        huddles.sort_by { |huddle| sort_key(huddle) }
+      end
+
+      private
+
+      def huddles
+        active.group_by { |member| group_key(member) }.map { |key, people| build(key, people) }
+      end
+
+      def active
+        self.class.keep(@members)
+      end
+
+      def group_key(member)
+        call_id(member) || [:solo, member['id']]
+      end
+
+      def build(key, people)
+        Models::Huddle.new(
+          call_id: call_id_for(key),
+          channel_id: shared_channel_id(people),
+          channel: nil,
+          participants: sorted_participants(people)
+        )
+      end
+
+      def call_id_for(key)
+        key.is_a?(Array) ? nil : key
+      end
+
+      def shared_channel_id(people)
+        ids = people.filter_map { |member| channel_id(member) }.uniq
+        ids.first if ids.one?
+      end
+
+      def sorted_participants(people)
+        people.map { |member| participant(member) }.sort_by { |person| [person.name.downcase, person.id] }
+      end
+
+      def participant(member)
+        Models::HuddleParticipant.new(id: member['id'], name: participant_name(member))
+      end
+
+      def participant_name(member)
+        profile = member['profile'] || {}
+        names = [profile['display_name'], profile['real_name'], member['real_name'], member['name'], member['id']]
+        names.find { |value| !value.to_s.empty? }.to_s
+      end
+
+      def call_id(member)
+        present(member.dig('profile', 'huddle_state_call_id'))
+      end
+
+      def channel_id(member)
+        present(member.dig('profile', 'huddle_state_channel_id'))
+      end
+
+      def present(value)
+        text = value.to_s
+        text.empty? ? nil : text
+      end
+
+      def sort_key(huddle)
+        [-huddle.participants.size, huddle.participants.first.name.downcase, huddle.call_id.to_s]
+      end
+    end
+  end
+end

data/lib/slk/services/huddle_state.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Slk
+  module Services
+    # Huddle fields from a profile hash, or from a live users.info.
+    #
+    # users.info and users.profile.get are cached for an hour. Huddle state
+    # changes in minutes, so a card must not trust the cached copy.
+    module HuddleState
+      EMPTY = { huddle_state: nil, huddle_channel_id: nil, huddle_call_id: nil }.freeze
+
+      module_function
+
+      def from(profile_data)
+        data = profile_data || {}
+        {
+          huddle_state: blank_to_nil(data['huddle_state']),
+          huddle_channel_id: blank_to_nil(data['huddle_state_channel_id']),
+          huddle_call_id: blank_to_nil(data['huddle_state_call_id']),
+          huddle_channel: nil
+        }
+      end
+
+      def apply(profile, users_api, user_id, on_debug: nil)
+        Models::Profile.new(**profile.to_h, **read(users_api, user_id, on_debug: on_debug))
+      end
+
+      def read(users_api, user_id, on_debug: nil)
+        from(users_api.info(user_id).dig('user', 'profile'))
+      rescue ApiError => e
+        on_debug&.call("huddle state for #{user_id} failed: #{e.message}")
+        EMPTY.merge(huddle_channel: nil)
+      end
+
+      def blank_to_nil(value)
+        text = value.to_s
+        text.empty? ? nil : text
+      end
+    end
+  end
+end

data/lib/slk/services/profile_builder.rb

@@ -17,6 +17,7 @@ module Slk
         Models::Profile.new(
           **identity(profile_data, info_data),
           **status(profile_data),
+          **HuddleState.from(profile_data),
           **tz(info_data),
           **flags(info_data, team_id, workspace_team_id),
           team_id: team_id,

data/lib/slk/services/profile_resolver.rb

@@ -93,7 +93,7 @@ module Slk
       end
 
       def attach_extras(profile, user_id)
-        profile = attach_home_team_name(profile)
+        profile = HuddleState.apply(attach_home_team_name(profile), @users_api, user_id, on_debug: @on_debug)
         presence = fetch_presence(user_id)
         presence ? Models::Profile.new(**profile.to_h, presence: presence) : profile
       end

data/lib/slk/services/sent_channel_label.rb

@@ -5,6 +5,7 @@ module Slk
     # Resolves sent-conversation destinations while retaining raw channel IDs
     # and names in JSON. Group DMs need member lookup: their Slack name is an
     # opaque mpdm-* slug, not a user ID that MentionReplacer can resolve.
+    # Named group DMs ("named chats") skip that and show as #name.
     class SentChannelLabel
       USER_ID_PATTERN = /\A[UW][A-Z0-9]+\z/
 
@@ -28,6 +29,9 @@ module Slk
       private
 
       def group_label(workspace, channel_id, name, self_user_id, self_username)
+        named = Support::GroupDmName.label(name)
+        return named if named
+
         names = group_member_names(workspace, channel_id, self_user_id)
         return "@#{names.join(', ')}" if names.any?
 

data/lib/slk/services/target_resolver.rb

@@ -66,19 +66,8 @@ module Slk
       end
 
       def resolve_channel(workspace, name)
-        cached = @cache.get_channel_id(workspace.name, name)
-        return cached if cached
-
-        fetch_and_cache_channel(workspace, name)
-      end
-
-      def fetch_and_cache_channel(workspace, name)
-        channels = @runner.conversations_api(workspace.name).list['channels'] || []
-        channel = channels.find { |c| c['name'] == name }
-        raise ConfigError, "Channel not found: ##{name}" unless channel
-
-        @cache.set_channel(workspace.name, name, channel['id'])
-        channel['id']
+        ChannelLookup.new(runner: @runner, cache_store: @cache).find_id(workspace, name) ||
+          raise(ConfigError, "Channel not found: ##{name}")
       end
 
       def resolve_dm(workspace, username)

data/lib/slk/services/unread_marker.rb

@@ -14,13 +14,15 @@ module Slk
 
       # Mark all unreads in a workspace, return counts
       # @param options [Hash] :muted - include muted channels
-      # @return [Hash] { dms: count, channels: count, threads: count }
+      # @return [Hash] { dms: count, group_dms: count, channels: count, threads: count }
       def mark_all(options: {})
         counts = @client.counts
+        muted_ids = options[:muted] ? [] : @users.muted_channels
 
         {
           dms: mark_dms(counts['ims'] || []),
-          channels: mark_channels(counts['channels'] || [], muted: options[:muted]),
+          group_dms: mark_channels(counts['mpims'] || [], muted_ids),
+          channels: mark_channels(counts['channels'] || [], muted_ids),
           threads: mark_threads
         }
       end
@@ -44,13 +46,14 @@ module Slk
         count
       end
 
-      def mark_channels(channels, muted: false)
-        muted_ids = muted ? [] : @users.muted_channels
+      # Channels and group DMs (client.counts `mpims`): a muted group DM is
+      # skipped the same way a muted channel is.
+      def mark_channels(channels, muted_ids)
         count = 0
 
         channels.each do |channel|
           next unless channel['has_unreads']
-          next if !muted && muted_ids.include?(channel['id'])
+          next if muted_ids.include?(channel['id'])
 
           count += 1 if mark_conversation(channel['id'])
         end

data/lib/slk/services/workspace_fanout.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Slk
+  module Services
+    # Runs one block per item. With parallel, the blocks overlap and the
+    # results come back in the original order. A failure waits for the other
+    # threads to finish, then raises, so an in-flight request is not abandoned
+    # mid-read.
+    module WorkspaceFanout
+      module_function
+
+      def call(items, parallel: false, &block)
+        return items.map(&block) unless parallel && items.size > 1
+
+        threads = items.map { |item| start(item, &block) }
+        threads.map(&:value)
+      ensure
+        Array(threads).each(&:join)
+      end
+
+      # The caller raises the thread's exception. Leaving the default on
+      # prints a second traceback for a failure the command already reports.
+      def start(item, &block)
+        Thread.new { block.call(item) }.tap { |thread| thread.report_on_exception = false }
+      end
+    end
+  end
+end

data/lib/slk/support/group_dm_name.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Slk
+  module Support
+    # Group DMs can be given a name in Slack ("named chats"). They are still
+    # mpims, but `name` holds what the user typed ("ifams review") rather
+    # than the generated mpdm-alice--bob-1 slug. conversations.info flags them
+    # with properties.has_custom_mpdm_name; search.messages sends no
+    # properties, so a name that isn't an mpdm-* slug counts as custom too.
+    module GroupDmName
+      SLUG = /\Ampdm-/
+
+      module_function
+
+      # @param channel [Hash] conversation payload from Slack
+      # @return [String, nil] the custom name, or nil for anything else
+      def custom(channel)
+        return nil unless channel.is_a?(Hash) && channel['is_mpim']
+
+        name = channel['name'].to_s
+        return nil if name.empty?
+        return name if channel.dig('properties', 'has_custom_mpdm_name')
+
+        custom_name?(name) ? name : nil
+      end
+
+      # @param name [String, nil] a group DM's Slack name
+      # @return [Boolean] true when the name was set by a person
+      def custom_name?(name)
+        !name.to_s.empty? && !name.to_s.match?(SLUG)
+      end
+
+      # @return [String, nil] "#name" for a named group DM, else nil
+      def label(name)
+        "##{name}" if custom_name?(name)
+      end
+    end
+  end
+end

data/lib/slk/support/user_resolver.rb

@@ -68,6 +68,8 @@ module Slk
       public
 
       # Resolves a channel ID to a formatted label (@username or #channel)
+      # Group DMs get "#name" when named, else "@other, members", never the
+      # mpdm-* slug that other lookups may have put in the channel cache.
       # @param workspace [Models::Workspace] The workspace to look up in
       # @param channel_id [String] The channel ID
       # @return [String] Formatted label like "@username" or "#channel"
@@ -97,8 +99,11 @@ module Slk
       end
 
       def resolve_channel_label(workspace, channel_id)
+        known = group_dm_label.known(workspace, channel_id)
+        return known if known
+
         cached_name = cache_store.get_channel_name(workspace.name, channel_id)
-        return "##{cached_name}" if cached_name
+        return "##{cached_name}" if cached_name && !cached_name.match?(Support::GroupDmName::SLUG)
 
         fetch_channel_label(workspace, channel_id)
       end
@@ -108,16 +113,27 @@ module Slk
         response = conversations.info(channel: channel_id)
         return "##{channel_id}" unless response['ok'] && response['channel']
 
-        name = response['channel']['name']
-        return "##{channel_id}" unless name
+        channel = response['channel']
+        return group_dm_label.label_from(workspace, channel_id, channel) if channel['is_mpim']
 
-        cache_store.set_channel(workspace.name, name, channel_id)
-        "##{name}"
+        named_channel_label(workspace, channel_id, channel['name'])
       rescue ApiError => e
         debug("Channel info lookup failed for #{channel_id}: #{e.message}")
         "##{channel_id}"
       end
 
+      def named_channel_label(workspace, channel_id, name)
+        return "##{channel_id}" unless name
+
+        cache_store.set_channel(workspace.name, name, channel_id)
+        "##{name}"
+      end
+
+      # One per command run, so a group DM is looked up once for all headers.
+      def group_dm_label
+        @group_dm_label ||= Services::GroupDmLabel.new(runner: runner, on_debug: ->(msg) { debug(msg) })
+      end
+
       def name_from_user_profile(msg)
         return nil unless msg['user_profile']
 

data/lib/slk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slk
-  VERSION = '0.13.0'
+  VERSION = '0.15.0'
 end

data/lib/slk.rb

@@ -79,6 +79,9 @@ module Slk
     autoload :Tenure, 'slk/models/tenure'
     autoload :SearchResult, 'slk/models/search_result'
     autoload :SavedItem, 'slk/models/saved_item'
+    autoload :Huddle, 'slk/models/huddle'
+    autoload :HuddleParticipant, 'slk/models/huddle'
+    autoload :WorkspaceHuddles, 'slk/models/huddle'
     autoload :Profile, 'slk/models/profile'
     autoload :ProfileField, 'slk/models/profile_field'
   end
@@ -117,6 +120,13 @@ module Slk
     autoload :SentConversations, 'slk/services/sent_conversations'
     autoload :SentChanges, 'slk/services/sent_changes'
     autoload :SentChannelLabel, 'slk/services/sent_channel_label'
+    autoload :HuddleScanner, 'slk/services/huddle_scanner'
+    autoload :HuddleFetch, 'slk/services/huddle_fetch'
+    autoload :HuddleState, 'slk/services/huddle_state'
+    autoload :WorkspaceFanout, 'slk/services/workspace_fanout'
+    autoload :HuddleChannelLabel, 'slk/services/huddle_channel_label'
+    autoload :GroupDmLabel, 'slk/services/group_dm_label'
+    autoload :ChannelLookup, 'slk/services/channel_lookup'
     autoload :ThreadSubscription, 'slk/services/thread_subscription'
   end
 
@@ -141,6 +151,7 @@ module Slk
     autoload :ProfileFormatter, 'slk/formatters/profile_formatter'
     autoload :ProfileFieldRenderer, 'slk/formatters/profile_field_renderer'
     autoload :ProfileRows, 'slk/formatters/profile_rows'
+    autoload :HuddleFormatter, 'slk/formatters/huddle_formatter'
     autoload :DeactivationFormatter, 'slk/formatters/deactivation_formatter'
     autoload :DeactivationCsv, 'slk/formatters/deactivation_csv'
     autoload :CsvWriter, 'slk/formatters/csv_writer'
@@ -168,6 +179,7 @@ module Slk
     autoload :Later, 'slk/commands/later'
     autoload :Debug, 'slk/commands/debug'
     autoload :Who, 'slk/commands/who'
+    autoload :Huddles, 'slk/commands/huddles'
     autoload :Org, 'slk/commands/org'
     autoload :Deactivations, 'slk/commands/deactivations'
   end
@@ -199,6 +211,7 @@ module Slk
     autoload :HelpFormatter, 'slk/support/help_formatter'
     autoload :ErrorLogger, 'slk/support/error_logger'
     autoload :UserResolver, 'slk/support/user_resolver'
+    autoload :GroupDmName, 'slk/support/group_dm_name'
     autoload :TextWrapper, 'slk/support/text_wrapper'
     autoload :InteractivePrompt, 'slk/support/interactive_prompt'
     autoload :DateParser, 'slk/support/date_parser'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slk
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Eric Boehs
@@ -50,6 +50,7 @@ files:
 - lib/slk/commands/dnd.rb
 - lib/slk/commands/emoji.rb
 - lib/slk/commands/help.rb
+- lib/slk/commands/huddles.rb
 - lib/slk/commands/later.rb
 - lib/slk/commands/messages.rb
 - lib/slk/commands/org.rb
@@ -71,6 +72,7 @@ files:
 - lib/slk/formatters/deactivation_formatter.rb
 - lib/slk/formatters/duration_formatter.rb
 - lib/slk/formatters/emoji_replacer.rb
+- lib/slk/formatters/huddle_formatter.rb
 - lib/slk/formatters/json_message_formatter.rb
 - lib/slk/formatters/json_status_formatter.rb
 - lib/slk/formatters/markdown_output.rb
@@ -89,6 +91,7 @@ files:
 - lib/slk/models/deactivation.rb
 - lib/slk/models/dnd_state.rb
 - lib/slk/models/duration.rb
+- lib/slk/models/huddle.rb
 - lib/slk/models/message.rb
 - lib/slk/models/preset.rb
 - lib/slk/models/profile.rb
@@ -106,6 +109,7 @@ files:
 - lib/slk/services/activity_enricher.rb
 - lib/slk/services/api_client.rb
 - lib/slk/services/cache_store.rb
+- lib/slk/services/channel_lookup.rb
 - lib/slk/services/configuration.rb
 - lib/slk/services/deactivation_scanner.rb
 - lib/slk/services/emoji_downloader.rb
@@ -113,6 +117,11 @@ files:
 - lib/slk/services/encryption.rb
 - lib/slk/services/file_downloader.rb
 - lib/slk/services/gemoji_sync.rb
+- lib/slk/services/group_dm_label.rb
+- lib/slk/services/huddle_channel_label.rb
+- lib/slk/services/huddle_fetch.rb
+- lib/slk/services/huddle_scanner.rb
+- lib/slk/services/huddle_state.rb
 - lib/slk/services/message_resolver.rb
 - lib/slk/services/meta_cache.rb
 - lib/slk/services/preset_store.rb
@@ -136,11 +145,13 @@ files:
 - lib/slk/services/user_matcher.rb
 - lib/slk/services/user_picker.rb
 - lib/slk/services/who_target_resolver.rb
+- lib/slk/services/workspace_fanout.rb
 - lib/slk/support/attachment_fetching.rb
 - lib/slk/support/check_in_time.rb
 - lib/slk/support/date_parser.rb
 - lib/slk/support/decimal_timestamp.rb
 - lib/slk/support/error_logger.rb
+- lib/slk/support/group_dm_name.rb
 - lib/slk/support/help_formatter.rb
 - lib/slk/support/image_preview.rb
 - lib/slk/support/inline_images.rb