Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: [PoC] fx.Evaluate #1259

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

WIP: [PoC] fx.Evaluate #1259

wants to merge 1 commit into from

Conversation

abhinav
Copy link
Collaborator

@abhinav abhinav commented Jan 9, 2025

This is just a PoC at this time and not yet ready for review.

Resolves #1132

Details

This change introduces the fx.Evalute option,
which allows for dynamic generation of provides, invokes, decorates,
and other evaluates based on the state of existing dependencies.

It addresses one of the more significant remaining pain points
with usage of Fx in large applications and ecosystems:
the ability to programmatically generate parts of the dependency graph.

Concretely, this makes the following possible:

fx.Evaluate(func(cfg *Config) fx.Option {
    if cfg.Environment == "production" {
        return fx.Provide(func(*sql.DB) Repository {
            return &sqlRepository{db: db}
        }),
    } else {
        return fx.Provide(func() Repository {
            return &memoryRepository{}
        })
    }
}),
fx.Provide(func(...) *sql.DB { ... }),

With fx.Evaluate, the dependency on *sql.DB is present in the graph
only in production environments.
In development environments, the dependency connection is absent,
and therefore the database connection is never established.

(Today, attempting to write an Fx module that switches on the backend
like this will result in the SQL connection being established even in
development environments.)

TODO

  • Decide whether nilling out the slice is the right approach
    for tracking what's been already run
  • fx.Module handling
  • fx.WithLogger handling
  • Testing with every other feature
  • Documentation

@abhinav
Copy link
Collaborator Author

abhinav commented Jan 9, 2025

This change is part of the following stack:

Change managed by git-spice.

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

Attention: Patch coverage is 66.66667% with 29 lines in your changes missing coverage. Please review.

Project coverage is 97.81%. Comparing base (0ad8a04) to head (045ba96).

Files with missing lines Patch % Lines
evaluate.go 61.66% 20 Missing and 3 partials ⚠️
app.go 57.14% 2 Missing and 1 partial ⚠️
module.go 85.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1259      +/-   ##
==========================================
- Coverage   98.62%   97.81%   -0.82%     
==========================================
  Files          35       36       +1     
  Lines        3337     3427      +90     
==========================================
+ Hits         3291     3352      +61     
- Misses         39       63      +24     
- Partials        7       12       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Base automatically changed from refac-rename to master January 9, 2025 17:59
**This is just a PoC at this time and not yet ready for review.**

## Details

This change introduces the `fx.Evalute` option,
which allows for dynamic generation of provides, invokes, decorates,
and other evaluates based on the state of existing dependencies.

It addresses one of the more significant remaining pain points
with usage of Fx in large applications and ecosystems:
the ability to programmatically generate parts of the dependency graph.

Concretely, this makes the following possible:

```
fx.Evaluate(func(cfg *Config) fx.Option {
    if cfg.Environment == "production" {
        return fx.Provide(func(*sql.DB) Repository {
            return &sqlRepository{db: db}
        }),
    } else {
        return fx.Provide(func() Repository {
            return &memoryRepository{}
        })
    }
}),
fx.Provide(func(...) *sql.DB { ... }),
```

With fx.Evaluate, the dependency on `*sql.DB` is present in the graph
only in production environments.
In development environments, the dependency connection is absent,
and therefore the database connection is never established.

(Today, attempting to write an Fx module that switches on the backend
like this will result in the SQL connection being established even in
development environments.)

**TODO**

- [ ] Decide whether nilling out the slice is the right approach
      for tracking what's been already run
- [ ] fx.Module handling
- [ ] fx.WithLogger handling
- [ ] Testing with every other feature
- [ ] Documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

fx.Evaluate: Support dynamic graphs by returning fx.Option from constructors
1 participant