Module: Igniter::Extensions::Contracts::CollectionPack

Defined in:
lib/igniter/extensions/contracts/collection_pack.rb

Defined Under Namespace

Modules: LocalInvoker Classes: Invocation

Constant Summary collapse

INTERNAL_SOURCE = 
:__collection_items__

Class Method Summary collapse

Class Method Details

.collection_keyword ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 71

def collection_keyword
  Igniter::Contracts::DslKeyword.new(:collection) do |name, from:, key:, builder:, inputs: {}, window: nil, contract: nil, via: nil, &block|
    compiled_graph = compile_contract(name: name, contract: contract, profile: builder.profile, block: block)
    input_map = normalize_inputs(inputs)
    source_name = from.to_sym

    builder.add_operation(
      kind: :collection,
      name: name,
      from: source_name,
      key_name: key.to_sym,
      depends_on: [source_name, *extract_dependencies(input_map)].uniq,
      inputs: input_map,
      window: window,
      compiled_graph: compiled_graph,
      invoker: via
    )
  end
end

.handle_collection(operation:, state:, profile:) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 153

def handle_collection(operation:, state:, profile:, **)
  items = state.fetch(operation.attributes.fetch(:from))
  invocation = Invocation.new(
    operation: operation,
    items: items,
    inputs: resolve_inputs(operation, state: state),
    compiled_graph: operation.attributes.fetch(:compiled_graph),
    profile: profile,
    key_name: operation.attributes.fetch(:key_name),
    window: operation.attributes[:window]
  )
  invoker = operation.attributes[:invoker] || LocalInvoker
  result = invoker.call(invocation: invocation)
  unless result.is_a?(Igniter::Extensions::Contracts::Dataflow::CollectionResult)
    raise Igniter::Contracts::Error,
          "collection invoker for #{operation.name} must return a CollectionResult"
  end

  result
end

.install_into(kernel) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 59

def install_into(kernel)
  kernel.nodes.register(:collection,
                        Igniter::Contracts::NodeType.new(kind: :collection,
                                                         metadata: { category: :orchestration }))
  kernel.dsl_keywords.register(:collection, collection_keyword)
  kernel.validators.register(:collection_dependencies, method(:validate_collection_dependencies))
  kernel.validators.register(:collection_contracts, method(:validate_collection_contracts))
  kernel.validators.register(:collection_invokers, method(:validate_collection_invokers))
  kernel.runtime_handlers.register(:collection, method(:handle_collection))
  kernel
end

.manifest ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 44

def manifest
  Igniter::Contracts::PackManifest.new(
    name: :extensions_collection,
    node_contracts: [Igniter::Contracts::PackManifest.node(:collection)],
    registry_contracts: [
      Igniter::Contracts::PackManifest.validator(:collection_dependencies),
      Igniter::Contracts::PackManifest.validator(:collection_contracts),
      Igniter::Contracts::PackManifest.validator(:collection_invokers)
    ],
    requires_packs: [DataflowPack, IncrementalPack],
    metadata: { category: :orchestration },
    provides_capabilities: %i[collection keyed_sessions incremental_collection]
  )
end

.validate_collection_contracts(operations:, profile:) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 107

def validate_collection_contracts(operations:, profile:)
  collection_operations = operations.select { |operation| operation.kind == :collection }
  findings = []

  invalid_contracts = collection_operations.reject do |operation|
    operation.attributes[:compiled_graph].is_a?(Igniter::Contracts::CompiledGraph)
  end
  if invalid_contracts.any?
    findings << Igniter::Contracts::ValidationFinding.new(
      code: :invalid_collection_contract,
      message: "collection nodes require a compiled item graph: #{invalid_contracts.map(&:name).join(", ")}",
      subjects: invalid_contracts.map(&:name)
    )
  end

  mismatched = collection_operations.select do |operation|
    compiled_graph = operation.attributes[:compiled_graph]
    compiled_graph.is_a?(Igniter::Contracts::CompiledGraph) &&
      compiled_graph.profile_fingerprint != profile.fingerprint
  end
  if mismatched.any?
    findings << Igniter::Contracts::ValidationFinding.new(
      code: :collection_profile_mismatch,
      message: "collection item graphs were compiled against a different profile: #{mismatched.map(&:name).join(", ")}",
      subjects: mismatched.map(&:name)
    )
  end

  findings
end

.validate_collection_dependencies(operations:, profile: nil) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 91

def validate_collection_dependencies(operations:, profile: nil) # rubocop:disable Lint/UnusedMethodArgument
  available = operations.reject(&:output?).map(&:name)
  missing = operations.select { |operation| operation.kind == :collection }
                      .flat_map { |operation| Array(operation.attributes[:depends_on]) }
                      .map(&:to_sym)
                      .reject { |name| available.include?(name) }
                      .uniq
  return [] if missing.empty?

  [Igniter::Contracts::ValidationFinding.new(
    code: :missing_collection_dependencies,
    message: "collection dependencies are not defined: #{missing.map(&:to_s).join(", ")}",
    subjects: missing
  )]
end

.validate_collection_invokers(operations:, profile: nil) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/igniter/extensions/contracts/collection_pack.rb', line 138

def validate_collection_invokers(operations:, profile: nil) # rubocop:disable Lint/UnusedMethodArgument
  invalid = operations.select { |operation| operation.kind == :collection }
                      .reject do |operation|
    invoker = operation.attributes[:invoker]
    invoker.nil? || invoker.respond_to?(:call)
  end
  return [] if invalid.empty?

  [Igniter::Contracts::ValidationFinding.new(
    code: :invalid_collection_invoker,
    message: "collection via: must be callable: #{invalid.map(&:name).join(", ")}",
    subjects: invalid.map(&:name)
  )]
end