Class: Steep::Drivers::Check

Inherits:
Object
  • Object
show all
Includes:
Utils::DriverHelper
Defined in:
lib/steep/drivers/check.rb

Constant Summary collapse

LSP = 
LanguageServer::Protocol

Instance Attribute Summary collapse

Attributes included from Utils::DriverHelper

#disable_install_collection, #steepfile

Instance Method Summary collapse

Methods included from Utils::DriverHelper

#install_collection, #keep_diagnostic?, #load_config, #request_id, #shutdown_exit, #wait_for_message, #wait_for_response_id

Constructor Details

#initialize(stdout:, stderr:) ⇒ Check

Returns a new instance of Check.



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/steep/drivers/check.rb', line 22

def initialize(stdout:, stderr:)
  @stdout = stdout
  @stderr = stderr
  @command_line_patterns = []
  @severity_level = :warning
  @jobs_option = Utils::JobsOption.new()
  @active_group_names = []
  @type_check_code = true
  @validate_group_signatures = true
  @validate_project_signatures = false
  @validate_library_signatures = false
end

Instance Attribute Details

#active_group_names ⇒ Object (readonly)

Returns the value of attribute active_group_names.



14
15
16
 
# File 'lib/steep/drivers/check.rb', line 14

def active_group_names
  @active_group_names
end

#command_line_patterns ⇒ Object (readonly)

Returns the value of attribute command_line_patterns.



8
9
10
 
# File 'lib/steep/drivers/check.rb', line 8

def command_line_patterns
  @command_line_patterns
end

#jobs_option ⇒ Object (readonly)

Returns the value of attribute jobs_option.



12
13
14
 
# File 'lib/steep/drivers/check.rb', line 12

def jobs_option
  @jobs_option
end

#save_expectations_path ⇒ Object

Returns the value of attribute save_expectations_path.



10
11
12
 
# File 'lib/steep/drivers/check.rb', line 10

def save_expectations_path
  @save_expectations_path
end

#severity_level ⇒ Object

Returns the value of attribute severity_level.



11
12
13
 
# File 'lib/steep/drivers/check.rb', line 11

def severity_level
  @severity_level
end

#stderr ⇒ Object (readonly)

Returns the value of attribute stderr.



7
8
9
 
# File 'lib/steep/drivers/check.rb', line 7

def stderr
  @stderr
end

#stdout ⇒ Object (readonly)

Returns the value of attribute stdout.



6
7
8
 
# File 'lib/steep/drivers/check.rb', line 6

def stdout
  @stdout
end

#targets ⇒ Object (readonly)

Returns the value of attribute targets.



13
14
15
 
# File 'lib/steep/drivers/check.rb', line 13

def targets
  @targets
end

#type_check_code ⇒ Object

Returns the value of attribute type_check_code.



15
16
17
 
# File 'lib/steep/drivers/check.rb', line 15

def type_check_code
  @type_check_code
end

#validate_group_signatures ⇒ Object

Returns the value of attribute validate_group_signatures.



16
17
18
 
# File 'lib/steep/drivers/check.rb', line 16

def validate_group_signatures
  @validate_group_signatures
end

#validate_library_signatures ⇒ Object

Returns the value of attribute validate_library_signatures.



18
19
20
 
# File 'lib/steep/drivers/check.rb', line 18

def validate_library_signatures
  @validate_library_signatures
end

#validate_project_signatures ⇒ Object

Returns the value of attribute validate_project_signatures.



17
18
19
 
# File 'lib/steep/drivers/check.rb', line 17

def validate_project_signatures
  @validate_project_signatures
end

#with_expectations_path ⇒ Object

Returns the value of attribute with_expectations_path.



9
10
11
 
# File 'lib/steep/drivers/check.rb', line 9

def with_expectations_path
  @with_expectations_path
end

Instance Method Details

#active_group?(group) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/steep/drivers/check.rb', line 35

def active_group?(group)
  return true if active_group_names.empty?

  case group
  when Project::Target
    active_group_names.any? {|target_name, group_name|
      target_name == group.name && (group_name == nil || group_name == true)
    }
  when Project::Group
    active_group_names.any? {|target_name, group_name|
      target_name == group.target.name &&
        (group_name == group.name || group_name == true)
    }
  end
end

#load_files(files, target, group, params:) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/steep/drivers/check.rb', line 207

def load_files(files, target, group, params:)
  if type_check_code
    files.each_group_source_path(group, true) do |path|
      params[:code_paths] << [target.name.to_s, target.project.absolute_path(path).to_s]
    end
  end
  if validate_group_signatures
    files.each_group_signature_path(group) do |path|
      params[:signature_paths] << [target.name.to_s, target.project.absolute_path(path).to_s]
    end
  end
  if validate_project_signatures
    files.each_project_signature_path(target) do |path|
      if path_target = files.signature_path_target(path)
        params[:signature_paths] << [path_target.name.to_s, target.project.absolute_path(path).to_s]
      end
    end
    if group.is_a?(Project::Group)
      files.each_target_signature_path(target, group) do |path|
        params[:signature_paths] << [target.name.to_s, target.project.absolute_path(path).to_s]
      end
    end
  end
  if validate_library_signatures
    files.each_library_path(target) do |path|
      params[:library_paths] << [target.name.to_s, path.to_s]
    end
  end
end

#print_expectations(project:, all_files:, expectations_path:, notifications:) ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/steep/drivers/check.rb', line 237

def print_expectations(project:, all_files:, expectations_path:, notifications:)
  expectations = Expectations.load(path: expectations_path, content: expectations_path.read)

  expected_count = 0
  unexpected_count = 0
  missing_count = 0

  ns = notifications.each.with_object({}) do |notification, hash| #$ Hash[Pathname, Array[Expectations::Diagnostic]]
    path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]) || raise)
    hash[path] = notification[:diagnostics].map do |diagnostic|
      Expectations::Diagnostic.from_lsp(diagnostic)
    end
  end

  all_files.sort.each do |path|
    test = expectations.test(path: path, diagnostics: ns[path] || [])

    buffer = RBS::Buffer.new(name: path, content: path.read)
    printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout)

    test.each_diagnostics.each do |type, diag|
      case type
      when :expected
        expected_count += 1
      when :unexpected
        unexpected_count += 1
        printer.print(diag.to_lsp, prefix: Rainbow("+ ").green)
      when :missing
        missing_count += 1
        printer.print(diag.to_lsp, prefix: Rainbow("- ").red, source: false)
      end
    end
  end

  if unexpected_count > 0 || missing_count > 0
    stdout.puts

    stdout.puts Rainbow("Expectations unsatisfied:").bold.red
    stdout.puts "  #{expected_count} expected #{"diagnostic".pluralize(expected_count)}"
    stdout.puts Rainbow("  + #{unexpected_count} unexpected #{"diagnostic".pluralize(unexpected_count)}").green
    stdout.puts Rainbow("  - #{missing_count} missing #{"diagnostic".pluralize(missing_count)}").red
    1
  else
    stdout.puts Rainbow("Expectations satisfied:").bold.green
    stdout.puts "  #{expected_count} expected #{"diagnostic".pluralize(expected_count)}"
    0
  end
end

#print_result(project:, notifications:) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/steep/drivers/check.rb', line 313

def print_result(project:, notifications:)
  if notifications.all? {|notification| notification[:diagnostics].empty? }
    emoji = %w(🫖 🫖 🫖 🫖 🫖 🫖 🫖 🫖 🍵 🧋 🧉).sample
    stdout.puts Rainbow("No type error detected. #{emoji}").green.bold
    0
  else
    errors = notifications.reject {|notification| notification[:diagnostics].empty? }
    total = errors.sum {|notification| notification[:diagnostics].size }

    errors.each do |notification|
      path = Steep::PathHelper.to_pathname(notification[:uri]) or raise
      buffer = RBS::Buffer.new(name: project.relative_path(path), content: path.read)
      printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout)

      notification[:diagnostics].each do |diag|
        printer.print(diag)
        stdout.puts
      end
    end

    stdout.puts Rainbow("Detected #{total} #{"problem".pluralize(total)} from #{errors.size} #{"file".pluralize(errors.size)}").red.bold
    1
  end
end

#run ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/steep/drivers/check.rb', line 51

def run
  project = load_config()

  stdout.puts Rainbow("# Type checking files:").bold
  stdout.puts

  client_read, server_write = IO.pipe
  server_read, client_write = IO.pipe

  client_reader = LSP::Transport::Io::Reader.new(client_read)
  client_writer = LSP::Transport::Io::Writer.new(client_write)

  server_reader = LSP::Transport::Io::Reader.new(server_read)
  server_writer = LSP::Transport::Io::Writer.new(server_write)

  typecheck_workers = Server::WorkerProcess.start_typecheck_workers(
    steepfile: project.steepfile_path,
    args: command_line_patterns,
    delay_shutdown: true,
    steep_command: jobs_option.steep_command,
    count: jobs_option.jobs_count_value
  )

  master = Server::Master.new(
    project: project,
    reader: server_reader,
    writer: server_writer,
    interaction_worker: nil,
    typecheck_workers: typecheck_workers
  )
  master.typecheck_automatically = false
  master.commandline_args.push(*command_line_patterns)

  main_thread = Thread.start do
    Thread.current.abort_on_exception = true
    master.start()
  end

  Steep.logger.info { "Initializing server" }
  initialize_id = request_id()
  client_writer.write({ method: :initialize, id: initialize_id, params: DEFAULT_CLI_LSP_INITIALIZE_PARAMS })
  wait_for_response_id(reader: client_reader, id: initialize_id)

  params = { library_paths: [], signature_paths: [], code_paths: [] } #: Server::CustomMethods::TypeCheck::params

  if command_line_patterns.empty?
    files = Server::TargetGroupFiles.new(project)
    loader = Services::FileLoader.new(base_dir: project.base_dir)

    project.targets.each do |target|
      target.new_env_loader.each_dir do |_, dir|
        RBS::FileFinder.each_file(dir, skip_hidden: true) do |path|
          files.add_library_path(target, path)
        end
      end

      loader.each_path_in_target(target) do |path|
        files.add_path(path)
      end
    end

    project.targets.each do |target|
      target.groups.each do |group|
        if active_group?(group)
          load_files(files, group.target, group, params: params)
        end
      end
      if active_group?(target)
        load_files(files, target, target, params: params)
      end
    end
  else
    command_line_patterns.each do |pattern|
      path = Pathname(pattern)
      path = project.absolute_path(path)
      next unless path.file?
      if target = project.target_for_source_path(path)
        params[:code_paths] << [target.name.to_s, path.to_s]
      end
      if target = project.target_for_signature_path(path)
        params[:signature_paths] << [target.name.to_s, path.to_s]
      end
    end
  end

  Steep.logger.info { "Starting type check with #{params[:code_paths].size} Ruby files and #{params[:signature_paths].size} RBS signatures..." }
  Steep.logger.debug { params.inspect }

  request_guid = SecureRandom.uuid
  Steep.logger.info { "Starting type checking: #{request_guid}" }
  client_writer.write(Server::CustomMethods::TypeCheck.request(request_guid, params))

  diagnostic_notifications = [] #: Array[LanguageServer::Protocol::Interface::PublishDiagnosticsParams]
  error_messages = [] #: Array[String]

  response = wait_for_response_id(reader: client_reader, id: request_guid) do |message|
    case
    when message[:method] == "textDocument/publishDiagnostics"
      ds = message[:params][:diagnostics]
      ds.select! {|d| keep_diagnostic?(d, severity_level: severity_level) }
      if ds.empty?
        stdout.print "."
      else
        stdout.print "F"
      end
      diagnostic_notifications << message[:params]
      stdout.flush
    when message[:method] == "window/showMessage"
      # Assuming ERROR message means unrecoverable error.
      message = message[:params]
      if message[:type] == LSP::Constant::MessageType::ERROR
        error_messages << message[:message]
      end
    end
  end

  Steep.logger.info { "Finished type checking: #{response.inspect}" }

  Steep.logger.info { "Shutting down..." }

  shutdown_exit(reader: client_reader, writer: client_writer)
  main_thread.join()

  stdout.puts
  stdout.puts

  if error_messages.empty?
    loader = Services::FileLoader.new(base_dir: project.base_dir)
    all_files = project.targets.each.with_object(Set[]) do |target, set|
      set.merge(loader.load_changes(target.source_pattern, command_line_patterns, changes: {}).each_key)
      set.merge(loader.load_changes(target.signature_pattern, changes: {}).each_key)
    end.to_a

    case
    when with_expectations_path
      print_expectations(project: project,
                         all_files: all_files,
                         expectations_path: with_expectations_path,
                         notifications: diagnostic_notifications)
    when save_expectations_path
      save_expectations(project: project,
                        all_files: all_files,
                        expectations_path: save_expectations_path,
                        notifications: diagnostic_notifications)
    else
      print_result(project: project, notifications: diagnostic_notifications)
    end
  else
    stdout.puts Rainbow("Unexpected error reported. 🚨").red.bold
    1
  end
rescue Errno::EPIPE => error
  stdout.puts Rainbow("Steep shutdown with an error: #{error.inspect}").red.bold
  return 1
end

#save_expectations(project:, all_files:, expectations_path:, notifications:) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/steep/drivers/check.rb', line 286

def save_expectations(project:, all_files:, expectations_path:, notifications:)
  expectations = if expectations_path.file?
                   Expectations.load(path: expectations_path, content: expectations_path.read)
                 else
                   Expectations.empty()
                 end

  ns = notifications.each.with_object({}) do |notification, hash| #$ Hash[Pathname, Array[Expectations::Diagnostic]]
    path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]) || raise)
    hash[path] = notification[:diagnostics].map {|diagnostic| Expectations::Diagnostic.from_lsp(diagnostic) }
  end

  all_files.sort.each do |path|
    ds = ns[path] || []

    if ds.empty?
      expectations.diagnostics.delete(path)
    else
      expectations.diagnostics[path] = ds
    end
  end

  expectations_path.write(expectations.to_yaml)
  stdout.puts Rainbow("Saved expectations in #{expectations_path}...").bold
  0
end