logstash-mixin-plugin_factory_support 1.0.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a19f100a0806291e455d660d61f70f10fc3973219cdf835db16889a556f4163
+  data.tar.gz: 599f15315a561ea8098eeab1785e67740824fa3998e2eea1e0237ffffa536f93
+SHA512:
+  metadata.gz: cccfe54b8e7af003484b58a04b2943f6e9419245dd9892c4e7c04afc88b9f86b0928bc35d7c0b253a725ac8e009426b215eeb069718f9d5b70b618394e411ff3
+  data.tar.gz: d998ce46bb6cc32ffc9ed6c6a92ae562842f196c241e665745674f004038ba8e0e27aea25cf4c55802ab6f5471b01aa03ef3dd5f9532b828688d1f45e85e8348

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+  - Support Mixin for ensuring a plugin has an `plugin_factory` method that returns a `PluginFactory` that can be used to instantiate wrapped plugins that maintain the pipeline execution context [#1](https://github.com/logstash-plugins/logstash-mixin-plugin_factory_support/pull/1)

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,71 @@
+# Plugin Factory Support Mixin
+
+[![Build Status](https://travis-ci.com/logstash-plugins/logstash-mixin-plugin_factory_support.svg?branch=main)](https://travis-ci.com/logstash-plugins/logstash-mixin-plugin_factory_support)
+
+This gem is a support adapter for Logstash plugins that can be used to ensure your plugin
+has access to an api-stable Plugin Factory for instantiating inner plugins, even when run
+on a Logstash version that does not provide a Plugin Factory.
+
+Inner plugins generated by this factory will be fully-contextualized in the pipeline that
+the outer plugin is running in, and when instantiated without an explicit `id` parameter,
+a sensibly-descriptive distinct id will be generated.
+
+## Usage (simple)
+
+1. Add version `~>1.0` of this gem as a runtime dependency of your Logstash plugin's `gemspec`:
+
+    ~~~ ruby
+    Gem::Specification.new do |s|
+      # ...
+
+      s.add_runtime_dependency 'logstash-mixin-plugin_factory_support', '~>1.0'
+    end
+    ~~~
+
+2. In your plugin code, require this library and include it into your plugin class
+   that already inherits `LogStash::Plugin`:
+
+    ~~~ ruby
+    require 'logstash/plugin_mixins/plugin_factory_support'
+
+    class LogStash::Inputs::Foo < Logstash::Inputs::Base
+      include LogStash::PluginMixins::PluginFactorySupport
+
+      # ...
+    end
+    ~~~
+
+3. When instantiating other plugins from inside your plugin, _do not_ send `new`
+   to the plugin class directly. Instead use the `plugin_factory`
+   method to obtain a PluginFactory, and then use one of its `#input`, `#output`,
+   `#codec`, or `#filter` methods with your plugin's name to obtain a proxy for
+   the plugin class, and then send the proxy `#new` with your options as normal.
+   This will ensure that the inner plugin instance is properly bound to the pipeline
+   and execution context from the outer plugin.
+
+    ~~~ ruby
+      def register
+        @internal_grok = plugin_factory.filter('grok').new("match" => {"message" => "^PATTERN"})
+      end
+    ~~~
+
+    Expressed as a diff:
+
+    ~~~ diff
+       def register
+    -    @internal_grok = ::LogStash::Filter::Grok.new("match" => {"message" => "^PATTERN"})
+    +    @internal_grok = plugin_factory.filter('grok').new("match" => {"message" => "^PATTERN"})
+       end
+
+    ~~~
+
+    Note: when instantiating an inner plugin with a plugin factory, managing its lifecycle remains
+    an implementation detail of the _outer_ plugin. Lifecycle events like `LogStash::Plugin#close`,
+    `LogStash::Inputs::Base#stop`, or `LogStash::Codecs::Base#flush` for the outer plugin are not
+    automatically propagated to the inner plugin.
+
+## Development
+
+This gem:
+ - *MUST* remain API-stable at 1.x
+ - *MUST NOT* introduce additional runtime dependencies

data/lib/logstash/plugin_mixins/plugin_factory_support.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+
+require 'java'
+require 'thread'
+
+require 'logstash/namespace'
+require 'logstash/plugin'
+
+module LogStash
+  module PluginMixins
+    ##
+    # This `PluginFactorySupport` can be included in any `LogStash::Plugin`,
+    # and will ensure that the plugin provides an `plugin_factory` method that
+    # returns a factory for instantiating plugins with as much context as possible.
+    #
+    # When included into a Logstash plugin that already has a plugin factory (e.g.,
+    # when run on a Logstash release that provides a plugin factory),
+    # this adapter will _NOT_ override the existing implementation.
+    module PluginFactorySupport
+
+      ##
+      # @api internal (use: `LogStash::Plugin::include`)
+      # @param base [Class]: a class that inherits `LogStash::Plugin`, typically one
+      #                      descending from one of the four plugin base classes
+      #                      (e.g., `LogStash::Inputs::Base`)
+      # @return [void]
+      def self.included(base)
+        fail(ArgumentError, "`#{base}` must inherit LogStash::Plugin") unless base < LogStash::Plugin
+
+        # If our base does not include an `plugin_factory`,
+        # prepend the legacy adapter to ensure it gets defined.
+        base.send(:prepend, LegacyAdapter) unless base.method_defined?(:plugin_factory)
+      end
+
+      ##
+      # This `PluginFactorySupport` cannot be extended into an existing object.
+      # @api private
+      #
+      # @param base [Object]
+      # @raise [ArgumentError]
+      def self.extended(base)
+        fail(ArgumentError, "`#{self}` cannot be extended into an existing object.")
+      end
+
+      ##
+      # Implements `plugin_factory` method, which returns a `PluginFactory`
+      #
+      # @api internal
+      module LegacyAdapter
+
+        ##
+        # pre-initialize the sequence generator for id generation
+        def initialize(*a,&b)
+          @_pf_sequence_generator = SequenceGenerator.new
+
+          super
+        end
+
+        ##
+        # @return [PluginFactory]
+        def plugin_factory
+          PluginFactory.new(self, @_pf_sequence_generator)
+        end
+
+        ##
+        # A PluginFactory provides methods for retrieving plugin
+        # classes that can be initialized with a pre-determined ExecutionContext.
+        class PluginFactory
+
+          def initialize(outer_plugin, sequence_generator)
+            @outer_plugin = outer_plugin
+            @sequence_generator = sequence_generator
+          end
+
+          %i(
+            input
+            output
+            codec
+            filter
+          ).each do |plugin_type|
+            define_method(plugin_type) do |plugin_name|
+              PluginClassProxy.new(self, plugin_type, plugin_name)
+            end
+          end
+
+          def execution_context
+            @outer_plugin.execution_context
+          end
+
+          def outer_plugin_id
+            @outer_plugin.id
+          end
+
+          def next_sequence_id
+            @sequence_generator.next
+          end
+        end
+
+        ##
+        # A PluginClassProxy responds to `new` with a string-keyed params hash,
+        # and is a proxy for the ruby plugin class associated with its type and name.
+        class PluginClassProxy
+
+          include LogStash::Util::Loggable
+
+          def initialize(plugin_factory, plugin_type, plugin_name)
+            @plugin_type = plugin_type
+            @plugin_name = plugin_name
+            @plugin_factory = plugin_factory
+          end
+
+          ##
+          # Creates an instance of the plugin using the provided parameters
+          # that has access to the factory's execution context.
+          #
+          # If an `id` is not explicitly provided, a sensible one will be generated
+          # indicating its relationship to the plugin in which it was instantiated.
+          #
+          # @param params [Hash{String=>Object}]
+          # @return [LogStash::Plugin]
+          def new(params={})
+            params_with_id = params.include?('id') ? params : params.merge('id' => generate_inner_id)
+
+            logger.debug("initializing inner #{@plugin_name} #{@plugin_type}",
+                        :outer_plugin_id => @plugin_factory.outer_plugin_id,
+                        :inner_plugin_id => params_with_id.fetch('id'))
+
+            initialize_contextualized_plugin(params_with_id)
+          end
+
+          private
+
+          # Reach into the logstash-internal Plugin::Contextualizer provided in Logstash 7.10+
+          # to instantiate the inner plugin with the factory's execution context.
+          def initialize_contextualized_plugin(params)
+            ::LogStash::Plugins::Contextualizer.initialize_plugin(@plugin_factory.execution_context, plugin_class, params)
+          end
+
+          # Reach into the logstash-internal Plugin::lookup to find the inner plugin's class
+          # by type and name
+          def plugin_class
+            ::LogStash::Plugin.lookup(@plugin_type, @plugin_name)
+          end
+
+          def generate_inner_id
+            "#{@plugin_factory.outer_plugin_id}/inner-#{@plugin_type}-#{@plugin_name}@#{@plugin_factory.next_sequence_id}"
+          end
+        end
+
+
+        ##
+        # A SequenceGenerator will never generate the same sequence id twice.
+        # The shape of the produced string is an implementation detail.
+        class SequenceGenerator
+          def initialize
+            @last_sequence_id = java.util.concurrent.atomic.AtomicLong.new(0)
+          end
+
+          def next
+            sequence_id = @last_sequence_id.increment_and_get
+            fail("OVERFLOW") if sequence_id.zero?
+
+            "#{sequence_id}"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/logstash/plugin_mixins/plugin_factory_support_spec.rb

@@ -0,0 +1,212 @@
+# encoding: utf-8
+
+require 'rspec/its'
+
+require "logstash-core"
+
+require 'logstash/inputs/base'
+require 'logstash/filters/base'
+require 'logstash/codecs/base'
+require 'logstash/outputs/base'
+
+require 'logstash/codecs/plain' # to init base plugin with default codec
+
+require "logstash/plugin_mixins/plugin_factory_support"
+
+describe LogStash::PluginMixins::PluginFactorySupport do
+  let(:plugin_factory_support) { described_class }
+
+  context 'included into a class' do
+    context 'that does not inherit from `LogStash::Plugin`' do
+      let(:plugin_class) { Class.new }
+      it 'fails with an ArgumentError' do
+        expect do
+          plugin_class.send(:include, plugin_factory_support)
+        end.to raise_error(ArgumentError, /LogStash::Plugin/)
+      end
+    end
+
+    [
+      LogStash::Inputs::Base,
+      LogStash::Filters::Base,
+      LogStash::Codecs::Base,
+      LogStash::Outputs::Base
+    ].each do |base_class|
+      context "that inherits from `#{base_class}`" do
+        native_support_for_plugin_factory = base_class.method_defined?(:plugin_factory)
+
+        let(:plugin_base_class) { base_class }
+
+        subject(:plugin_class) do
+          Class.new(plugin_base_class) do
+            config_name 'test'
+          end
+        end
+
+        context 'the result' do
+          before(:each) do
+            plugin_class.send(:include, plugin_factory_support)
+          end
+
+          it 'defines an `plugin_factory` method' do
+            expect(plugin_class.method_defined?(:plugin_factory)).to be true
+          end
+
+          # depending on which version of Logstash is running, we either expect
+          # to include or to _NOT_ include the legacy adapter.
+          if native_support_for_plugin_factory
+            context 'since base class provides plugin_factory method' do
+              its(:ancestors) { is_expected.to_not include(plugin_factory_support::LegacyAdapter) }
+            end
+          else
+            context 'since base class does not plugin_factory method' do
+              its(:ancestors) { is_expected.to include(plugin_factory_support::LegacyAdapter) }
+            end
+
+            # TODO: Remove once Plugin Factory is included in one or
+            #       more Logstash release branches. This speculative spec is meant
+            #       to prove that this implementation will not override an existing
+            #       implementation.
+            context 'if base class were to include a plugin_factory method' do
+              let(:plugin_base_class) do
+                Class.new(super()) do
+                  def plugin_factory
+                  end
+                end
+              end
+              before(:each) do
+                expect(plugin_base_class.method_defined?(:plugin_factory)).to be true
+              end
+              its(:ancestors) { is_expected.to_not include(plugin_factory_support::LegacyAdapter) }
+            end
+          end
+
+          context 'when intialized' do
+            let(:plugin_options) { Hash.new }
+            subject(:instance) do
+              plugin_class.new(plugin_options).tap do |i|
+                i.execution_context = outer_execution_context
+              end
+            end
+
+            let(:outer_execution_context) do
+              # Logstash's Plugin Contextualizer needs a real-deal
+              # ExecutionContext due to java type-casting.
+              ::LogStash::ExecutionContext.new(nil, nil)
+            end
+
+            describe '#plugin_factory' do
+              it 'returns a plugin factory' do
+                pf = instance.plugin_factory
+
+                aggregate_failures do
+                  expect(pf).to respond_to(:input)
+                  expect(pf).to respond_to(:output)
+                  expect(pf).to respond_to(:codec)
+                  expect(pf).to respond_to(:filter)
+                end
+              end
+
+              context 'PluginFactory' do
+
+                describe '#codec("plain").new' do
+                  let(:plain_codec_proxy) { instance.plugin_factory.codec('plain') }
+                  before(:each) do
+                    allow(plain_codec_proxy).to receive(:logger).and_return(double('Logger').as_null_object)
+                  end
+
+                  let(:inner_params) { Hash.new }
+
+                  subject(:inner_plugin) { plain_codec_proxy.new(inner_params) }
+
+                  shared_examples 'contextualized instance' do
+                    alias_matcher :same_instance_as, :equal
+                    it 'has access to the execution_context' do
+                      expect(inner_plugin).to have_attributes(execution_context: same_instance_as(outer_execution_context))
+                    end
+                    it 'logs a breadcrumb linking the inner plugin to its outer wrapper' do
+                      inner_plugin # eager instantiate
+
+                      expect(plain_codec_proxy.logger).to have_received(:debug).with(a_string_including('initializing inner plain codec'),
+                                                                                     a_hash_including(inner_plugin_id: inner_plugin.id, outer_plugin_id: instance.id))
+                    end
+                  end
+
+                  shared_examples 'params propagation' do
+                    it 'propagates the explicitly-passed parameters' do
+                      expect(inner_plugin).to have_attributes(original_params: a_hash_including(inner_params))
+                    end
+                  end
+
+                  shared_examples 'sensible generated id' do
+                    it 'has a sensible generated id' do
+                      expect(inner_plugin).to have_attributes(id: a_string_starting_with("#{instance.id}/inner-codec-plain@"))
+                    end
+                    context 'when multiple plugin instances are generated from the same factory' do
+                      subject(:inner_plugins) do
+                        instance # eager init outer instance in main thread
+                        10.times.map do
+                          Thread.new(inner_params.dup) do |isolated_inner_params|
+                            100.times.map do
+                              instance.plugin_factory.codec('plain').new(isolated_inner_params)
+                            end
+                          end
+                        end.map(&:value).flatten
+                      end
+                      it 'generates distinct ids' do
+                        expect(inner_plugins.map(&:id)).to_not contain_duplicates
+                      end
+
+                      matcher :contain_duplicates do
+                        match do |actual|
+                          actual.uniq != actual
+                        end
+                        failure_message_when_negated do |actual|
+                          actual_formatted = RSpec::Support::ObjectFormatter.format(actual)
+                          duplicate_counts = actual.each_with_object(Hash.new{0}) { |id,m| m[id] += 1 }
+                                                   .reject {|value, count| count <= 1 }
+                          "expected #{actual_formatted} to not contain duplicates but found #{duplicate_counts}"
+                        end
+                      end
+                    end
+                  end
+
+                  shared_examples 'explicit id propagation' do
+                    let(:explicit_id) { inner_params.fetch("id") }
+                    it 'propagates the explicitly-given id' do
+                      expect(inner_plugin).to have_attributes(id: explicit_id)
+                    end
+                  end
+
+                  context 'with params `"format" => "foo/bar"`' do
+                    let(:inner_params) { super().merge("format" => "foo/bar") }
+
+                    include_examples "contextualized instance"
+                    include_examples "params propagation"
+                    include_examples "sensible generated id"
+
+                    context 'and explicit id' do
+                      let(:inner_params) { super().merge("id" => "explicitly-given-id") }
+
+                      include_examples "contextualized instance"
+                      include_examples "params propagation"
+                      include_examples "explicit id propagation"
+                    end
+                  end
+
+                  context 'with explicit id' do
+                    let(:inner_params) { super().merge("id" => "explicitly-given-id") }
+
+                    include_examples "contextualized instance"
+                    include_examples "params propagation"
+                    include_examples "explicit id propagation"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: logstash-mixin-plugin_factory_support
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: java
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.13.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.13.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: rspec-its
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  name: logstash-codec-plain
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: This gem is meant to be a dependency of any Logstash plugin that wishes
+  to use a Plugin Factory to instantiate inner plugins that are fully-contextualized
+  in the pipeline that the outer plugin is running in
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/logstash/plugin_mixins/plugin_factory_support.rb
+- spec/logstash/plugin_mixins/plugin_factory_support_spec.rb
+homepage: https://github.com/logstash-plugins/logstash-mixin-plugin_factory_support
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: API-stable Plugin Factory support adapter for Logstash plugins
+test_files:
+- spec/logstash/plugin_mixins/plugin_factory_support_spec.rb