How to deal with gems with integrations

Offen
#1,728 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
30/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
tooling

Rechercherichtung

Reproduziere den Bericht aus der Steepfile, indem du steep check mit gem_rbs_collection und den Datadog-Signaturen ausführst. Verfolge, wie Integrationssignaturen, die auf ungenutzte RSpec-, Sidekiq- oder Rails-Entitäten verweisen, geladen und diagnostiziert werden. Die Aufgabe ist abgeschlossen, wenn ein unterstütztes Verhalten für diese ungenutzten Integrationen oder eine dokumentierte Möglichkeit zum Unterdrücken der gemeldeten Fehler festgelegt und getestet wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I'm adding gem_rbs_collection to this library integrating with datadog. All is well, until I run steep check, and I get error messages coming from datadog's signatures:

# example
../../.gem/ruby/3.2.2/gems/datadog-ci-0.6.0/sig/datadog/ci/contrib/rspec/example.rbs:8:12: [error] Cannot find type `::RSpec::Core::Example`
│ Diagnostic ID: RBS::UnknownTypeName
│
└             include ::RSpec::Core::Example
              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

../../.gem/ruby/3.2.2/gems/datadog-ci-0.6.0/sig/datadog/ci/contrib/rspec/example_group.rbs:9:12: [error] Cannot find type `::RSpec::Core::ExampleGroup::ClassMethods`
│ Diagnostic ID: RBS::UnknownTypeName
│
└             include ::RSpec::Core::ExampleGroup::ClassMethods
              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The odd thing here being, I'm not using, nor loading rspec (and same for similar error I see).

The problem seems to be that datadog ships with integrations, which patch other known gems to include its tracing API. Therefore, signatures to those patch modules will include references for the things they're patching (rspec, sidekiq, even rails...), which they can deal with in their own env/CI, but I shouldn't have to, as I'm not using rspec, sidekiq or rais.

Seems that rbs needs to find a way to gracefully ignore signatures for entities which do not exist in a given environment. Either that, or I have to be able to ignore errors such as the one above, as they're not referring by the check call in the Steepfile.

Vorherrschende Sprache
Ruby
Sterne
2.2k
Forks
263
Ø Merge
1 T. 20 Std.
Gemergte PRs (30 T.)
64

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/rbs

Alle Issues in ruby/rbs

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.