Skip to content

refactor(api): narrow otel instrumentor typing#33853

Open
wangji0923 wants to merge 3 commits intolanggenius:mainfrom
wangji0923:fix/32599-otel-instrumentor-typing
Open

refactor(api): narrow otel instrumentor typing#33853
wangji0923 wants to merge 3 commits intolanggenius:mainfrom
wangji0923:fix/32599-otel-instrumentor-typing

Conversation

@wangji0923
Copy link

@wangji0923 wangji0923 commented Mar 21, 2026

Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Screenshots

Before After
N/A (backend-only change) N/A

Verification

  • uv run --project api --group dev --no-default-groups pyrefly check api/extensions/otel/instrumentation.py
  • uv run --project api --group dev --no-default-groups ruff check api/extensions/otel/instrumentation.py

Notes

  • This is a typing-only change, so no runtime behavior change or new pytest coverage was added.
  • I did not run the broader backend test suite for this PR.

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran make lint and make type-check (backend) and cd web && npx lint-staged (frontend) to appease the lint gods

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. refactor labels Mar 21, 2026
@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Mar 21, 2026

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the OpenTelemetry instrumentation setup by introducing explicit type narrowing for instrumentor instances. The primary goal is to resolve pyrefly incorrectly inferring NoneType for these instances, thereby improving static analysis without impacting the application's runtime behavior or observability.

Highlights

  • Type Narrowing: Narrowed the typing of OpenTelemetry instrumentor instances to improve pyrefly's type inference and prevent NoneType inference.
  • Typing-Only Change: Implemented changes solely for typing purposes, ensuring no alteration to runtime instrumentation behavior.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Mar 21, 2026
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the OpenTelemetry instrumentation setup to use more specific types for instrumentor instances, addressing an issue with pyrefly type inference. The changes introduce Protocol-based types and factory functions to wrap instrumentor creation, successfully narrowing the types without altering runtime behavior. The implementation is clean and effective. I have a couple of suggestions to make the new type definitions even more precise, further improving type safety.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 21, 2026

Pyrefly Diff

base → PR 
--- /tmp/pyrefly_base.txt	2026-03-21 22:34:52.954972379 +0000
+++ /tmp/pyrefly_pr.txt	2026-03-21 22:34:43.274925984 +0000
@@ -491,16 +491,6 @@
   --> dify_graph/nodes/variable_assigner/v1/node.py:98:100
 ERROR `income_value` may be uninitialized [unbound-name]
    --> dify_graph/nodes/variable_assigner/v1/node.py:102:26
-ERROR Object of class `NoneType` has no attribute `instrument_app` [missing-attribute]
-   --> extensions/otel/instrumentation.py:103:5
-ERROR Object of class `NoneType` has no attribute `instrument` [missing-attribute]
-   --> extensions/otel/instrumentation.py:109:9
-ERROR Object of class `NoneType` has no attribute `instrument` [missing-attribute]
-   --> extensions/otel/instrumentation.py:113:5
-ERROR Object of class `NoneType` has no attribute `instrument` [missing-attribute]
-   --> extensions/otel/instrumentation.py:117:5
-ERROR Object of class `NoneType` has no attribute `instrument` [missing-attribute]
-   --> extensions/otel/instrumentation.py:123:9
 ERROR Object of class `NoneType` has no attribute `instrument` [missing-attribute]
   --> extensions/otel/runtime.py:96:9
 ERROR Pyrefly detected conflicting types while breaking a dependency cycle: `Path | None` is not assignable to `None`. Adding explicit type annotations might possibly help. [bad-assignment]

This was referenced Mar 22, 2026
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@QuantumGhost QuantumGhost Awaiting requested review from QuantumGhost QuantumGhost is a code owner

1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

refactor size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Refactor/Chore] ERROR Object of class NoneType has no attribute

2 participants

@wangji0923 @asukaminato0721