[👷] Road to v2 🚀 #45

samber · 2023-10-23T02:14:04Z

Hi there 👋,

Over the past 18 months, many of you reported bugs or provided valuable feedback on various aspects of this project, such as error handling, debugging, invocation API, documentation, and more... Thanks for your contributions! 🙌

Work on this library has provided me with significant learning opportunities and now I believe it's time to advance this project further.

Most of the work for v2 has been done already. I'm targeting the end of January for a release. It will depend on additional requirements.

go get -u github.com/samber/do/v2@v2.0.0-beta.7

Scope

This milestone will lead to major improvement: Scope.

A Scope was previously referred to as an Injector and can be viewed as a module of an application, with restricted visibility. I advocate for each project possessing a RootScope for common code, and shifting business logic to dedicated Scopes.

The Scopes are structured with a parent (RootScope or other Scope), numerous Services, and potentially a few children Scopes as well.

RootScope owns options and is the only Scope that supports cloning.

Services from a Scope can invoke Services available locally or in parent Scopes. Therefore, a single Service can be instantiated many times in different branches of the Scope tree, without conflict.

Scope will be almost invisible to developers: services will keep using Injector API without awareness of the underlying implementation, whether it's a RootScope, Scope or VirtualScope.

A chain of Service invocation will instantiate many VirtualScope, in order to track dependency cycles.

A debugging toolchain has been added to illustrate the service dependency chain and Scope tree.

Checklist

The library has been almost entirely recoded, but most of do@v1 API has been preserved (see breaking changes below).

To be challenged

More existing issues might be added to the v2 milestone.

Documentation

Testing

Code coverage has been improved compared to v1. 😍

Reach 80% code coverage
Reach 85% code coverage
Reach 90% code coverage
See // @TODO in xxx_test.go files
More tests on nested scopes (clone, service invocation...)
More tests on virtual scopes

Coverage:

2023-10-23: 83%
2023-12-30: 87%
2024-05-07: 89%

Breaking changes

Injector struct turned into an interface 😕
ListProvidedServices and ListInvokedServices now return 2 do.Edge arrays.
No more panic propagation on Provider error 😛
Service implicit names have been changed. BTW, you should never manipulate it! Eg: *mypkg.MyService -> *github.com/samber/example.MyService.
injector.ShutdownOnSignals and injector.ShutdownOnSIGTERM now return (os.Signal, error)

If you consider the API must be improved, please write a comment on this issue. No breaking change will be done in v2 minor releases. And I hope v2 is going to be the last major version.

samber · 2023-10-23T02:27:12Z

Debugging

Here is the output of do.ExplainService[*MyService](Injector) 👇

Scope ID: scope-id-123
Scope name: scope-child
Service: SERVICE-E
Service type: lazy
Service build time: 1s
Invoked: /home/samber/project/github.com/samber/do/di_explain_test.go:fakeProvider5:38

Dependencies:
* SERVICE-D from scope scope-child
  * SERVICE-C1 from scope scope-child
    * SERVICE-B from scope [root]
      * SERVICE-A1 from scope [root]
      * SERVICE-A2 from scope [root]
  * SERVICE-C2 from scope scope-child
    * SERVICE-B from scope [root]
      * SERVICE-A1 from scope [root]
      * SERVICE-A2 from scope [root]

Dependents:
* SERVICE-F from scope scope-child
  * SERVICE-G from scope scope-child

Here is the output of do.ExplainInjector(Injector) 👇

Scope ID: scope-id-root
Scope name: [root]

DAG:

\_ [root] (ID: scope-id-root)
    * 😴 SERVICE-A1
    * 😴 SERVICE-A2
    * 😴 SERVICE-B
    |
    |
     \_ scope-0 (ID: scope-id-0)
         |
         |
         |\_ scope-1a (ID: scope-id-1a)
         |    * 😴 SERVICE-C1
         |    * 😴 SERVICE-C2
         |    * 😴 SERVICE-D
         |    * 😴 SERVICE-E
         |    * 🔁 SERVICE-EAGER-VALUE
         |    |
         |    |
         |    |\_ scope-2a (ID: scope-id-2a)
         |    |    * 😴 SERVICE-LAZY-HEALTH 🏥
         |    |    * 🏭 SERVICE-TRANSIANT-SIMPLE
         |    |     
         |    |
         |     \_ scope-2b (ID: scope-id-2b)
         |         * 😴 SERVICE-LAZY-SHUTDOWN 🙅
         |          
         |
          \_ scope-1b (ID: scope-id-1b)
              * 😴 SERVICE-F

The emoji prefix indicates the service is either Lazy, Eager, or Transiant. The EOL emoji indicates the service implements do.HealthChecker and/or do.Shutdowner.

codecov-commenter · 2023-10-23T02:33:51Z

Codecov Report

Attention: Patch coverage is 90.10638% with 186 lines in your changes are missing coverage. Please review.

Project coverage is 87.51%. Comparing base (9831445) to head (57826fc).
Report is 12 commits behind head on master.

Files	Patch %	Lines
service_alias.go	63.93%	40 Missing and 4 partials ⚠️
virtual_scope.go	40.47%	25 Missing ⚠️
scope.go	93.44%	17 Missing and 7 partials ⚠️
service_eager.go	75.67%	14 Missing and 4 partials ⚠️
root_scope.go	87.40%	17 Missing ⚠️
invoke.go	94.00%	8 Missing and 4 partials ⚠️
di.go	86.11%	10 Missing ⚠️
stacktrace/stacktrace.go	86.88%	5 Missing and 3 partials ⚠️
service_lazy.go	93.20%	5 Missing and 2 partials ⚠️
di_explain.go	97.73%	5 Missing and 1 partial ⚠️
... and 5 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #45      +/-   ##
==========================================
- Coverage   88.83%   87.51%   -1.32%     
==========================================
  Files           6       23      +17     
  Lines         430     2035    +1605     
==========================================
+ Hits          382     1781    +1399     
- Misses         40      225     +185     
- Partials        8       29      +21

Flag	Coverage Δ
unittests	`87.51% <90.10%> (-1.32%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

GreyXor · 2023-10-25T12:06:26Z

Hello, that's a really great news! Thanks a lot.
I can't use the branch directly atm

go get github.com/samber/do@v2-🚀
go: github.com/samber/do@v2-🚀: invalid version: version "v2-🚀" invalid: disallowed version string

workaround:
go get github.com/samber/do@d722cd623c629ebfaf5b2032f998d3ae1b176009

danilobuerger · 2023-10-26T16:17:22Z

It would be nice to provide context o healthcheck and shutdown.

samber · 2023-10-26T22:41:47Z

@danilobuerger can you elaborate on your use case?

danilobuerger · 2023-10-27T16:24:40Z

@danilobuerger can you elaborate on your use case?

Sure, I want to provide a context to be able to use cancellation.

GreyXor · 2023-11-01T17:49:49Z

My last workaround don't work anymore. I've followed this guide https://github.com/samber/do/blob/v2-%F0%9F%9A%80/MIGRATION-V1-TO-V2.md and also the v2 readme : https://github.com/samber/do/blob/v2-%F0%9F%9A%80/README.md
But I get this error go: github.com/samber/do@v2: no matching versions for query "v2" when I run go get github.com/samber/do@v2

samber · 2023-11-01T19:42:21Z

I renamed the package samber/do to samber/do/v2, so the latest command is: go get github.com/samber/do/v2@a158d2d9f84b4a1973db49e959e476aca996e04a

Adding an emoji in the branch name was definitely a bad idea 😆

GreyXor · 2023-11-02T10:26:56Z

I renamed the package samber/do to samber/do/v2, so the latest command is: go get github.com/samber/do/v2@a158d2d9f84b4a1973db49e959e476aca996e04a

Adding an emoji in the branch name was definitely a bad idea 😆

Not your fault, go get should be UTF-8 ready imho.

GreyXor · 2023-11-02T13:58:14Z

@samber, Since I've designed the ShutdownOnSignals* function to accommodate any signals, we've maintained the *OnSIGTERM for compatibility purposes. However, now that we have the option to revise the API (by breaking it), I believe all the shutdownOnSIGTERMs are unnecessary.

I therefore propose deleting ShutdownOnSIGTERM, ShutdownOnSIGTERMWithContext, ShutdownOnSIGTERMOrInterrupt and ShutdownOnSIGTERMOrInterruptWithContext.

What do you think about ? I feel that they are redundant

danilobuerger · 2023-11-24T09:57:47Z

One thing I noticed is that the pattern of Accept interfaces, return structs doesnt seem possible:

type EngineService interface{}

func NewEngineService(i *do.Injector) (*engineServiceImplem, error) {
    return &engineServiceImplem{}, nil
}

type engineServiceImplem struct {}

Later this fails:

do.Provide[EngineService](injector, NewEngineService)

samber · 2023-11-28T14:01:09Z

@danilobuerger v2 will make it possible to respect this pattern:

do.As[*engineServiceImplem, EngineService](injector)
// or
do.InvokeAs[EngineService](injector)

See the function comments for the full explanation.

v2 initial commit

samber · 2024-05-07T07:36:13Z

We need to push this PR forward.

I created a list of issues that must be addressed before v2 release:

Design:

InvokeAs problems #75
Proposal: do.Shutdown returning shutdown time ? #32
Add support of Value Groups #52 + Invoke multiple services satisfying the interface #29 + Proposal: allow multiple implementation for the same interface and being able to return all them #33

Bugs:

Tasks/Features:

Transform hooks into slices of hooks #71
Proposal: do.Shutdown returning shutdown time ? #32
Add support of Value Groups #52 + Invoke multiple services satisfying the interface #29 + Proposal: allow multiple implementation for the same interface and being able to return all them #33

Doc:

GreyXor · 2024-05-10T08:52:11Z

Hello @samber,

Healthcheck not working properly when calling do.DefaultRootScope.HealthCheck() from Echo router API.
I have this /healthcheck endpoint that should return the healthcheck errors list. I couldn't make an example code with the problem.
I just lose the Step-by-step debugger thread here: https://github.com/samber/do/blob/v2-%F0%9F%9A%80/scope.go#L189.

Seems to work as expected when it's called from my main thread and not from my API (in my main.go for exemple)

but this, not working

func (a API) GetHealthcheck(_ context.Context, _ openapi.GetHealthcheckRequestObject) (openapi.GetHealthcheckResponseObject, error) {
	err := do.DefaultRootScope.HealthCheck()
	// never reached
	return openapi.GetHealthcheck200JSONResponse{}, nil
}

…e from an unexecpted type Fixes #80

Repository owner deleted a comment from codecov-commenter Oct 23, 2023

This was referenced Oct 30, 2023

Is there an equivalent to dig.As() ? #41

Closed

Anonymous Invocation #25

Closed

Detect circular dependency and panic #2

Closed

Improvements on dependency graph #3

Closed

proposal: Add factory provide mode #36

Closed

samber force-pushed the v2- branch from f1f98ab to a158d2d Compare November 1, 2023 04:01

samber mentioned this pull request Nov 1, 2023

External website for documentation (starting v2) #46

Merged

28 tasks

K4L1Ma mentioned this pull request Nov 29, 2023

[👷] Road to v2 🚀 - Refactor DAG Maps to sync.Map and Improve invoke Function Readability #48

Merged

samber added 9 commits December 4, 2023 01:21

feat: adding support for scopes

c4afd1e

v2 initial commit

adding some todo 😩

bea84c8

feat: heathcheck + shutdown with context

492284d

feat: rename package for v2

4342b91

feat: rename package for v2

df993c0

feat: shutdown on signal with context

d9f190b

feat: shutdown on signal with context

a28afba

feat: shutdown on signal with context

05381d9

fix(service registration): fix registration scope

9da24f6

vercel bot deployed to Preview May 7, 2024 07:13 View deployment

doc: add a warning to implicit aliasing

49259a8

vercel bot deployed to Preview May 7, 2024 07:22 View deployment

chore: upgrade go-type-to-string

e447f41

vercel bot deployed to Preview May 9, 2024 19:32 View deployment

samber added 2 commits May 9, 2024 23:36

feat: add support for multple hook handlers

23598a7

feat: add hook at runtime

b0f5021

vercel bot deployed to Preview May 9, 2024 22:38 View deployment

more doc

2f0c70f

vercel bot deployed to Preview May 9, 2024 23:12 View deployment

feat: move hooks to rootscope instead of injectorOpts

6a1325b

vercel bot deployed to Preview May 10, 2024 08:46 View deployment

chore: upgrade go-type-to-string

9a76c0f

vercel bot deployed to Preview May 13, 2024 11:12 View deployment

fix(error handling): add a TypeMismatch error when we invoke a servic…

1998a7a

…e from an unexecpted type Fixes #80

vercel bot deployed to Preview May 13, 2024 12:15 View deployment

oops

a033ac5

vercel bot deployed to Preview May 13, 2024 12:27 View deployment

fix doc

aeec7eb

vercel bot deployed to Preview May 13, 2024 12:37 View deployment

oops

44644bd

vercel bot deployed to Preview May 13, 2024 12:39 View deployment

chore: upgrade go-type-to-string

0067806

vercel bot deployed to Preview May 14, 2024 19:38 View deployment

chore: upgrade go-type-to-string

57826fc

vercel bot deployed to Preview May 16, 2024 10:14 View deployment

feat: InvokeNamed[any] without type check

ec49e08

vercel bot deployed to Preview May 16, 2024 16:52 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[👷] Road to v2 🚀 #45

[👷] Road to v2 🚀 #45

samber commented Oct 23, 2023 •

edited

samber commented Oct 23, 2023 •

edited

codecov-commenter commented Oct 23, 2023 •

edited

GreyXor commented Oct 25, 2023 •

edited

danilobuerger commented Oct 26, 2023

samber commented Oct 26, 2023

danilobuerger commented Oct 27, 2023

GreyXor commented Nov 1, 2023 •

edited

samber commented Nov 1, 2023

GreyXor commented Nov 2, 2023 •

edited

GreyXor commented Nov 2, 2023 •

edited

danilobuerger commented Nov 24, 2023

samber commented Nov 28, 2023

samber commented May 7, 2024 •

edited

GreyXor commented May 10, 2024 •

edited

[👷] Road to v2 🚀 #45

Are you sure you want to change the base?

[👷] Road to v2 🚀 #45

Conversation

samber commented Oct 23, 2023 • edited

Scope

Checklist

To be challenged

Documentation

Testing

Breaking changes

samber commented Oct 23, 2023 • edited

Debugging

codecov-commenter commented Oct 23, 2023 • edited

Codecov Report

GreyXor commented Oct 25, 2023 • edited

danilobuerger commented Oct 26, 2023

samber commented Oct 26, 2023

danilobuerger commented Oct 27, 2023

GreyXor commented Nov 1, 2023 • edited

samber commented Nov 1, 2023

GreyXor commented Nov 2, 2023 • edited

GreyXor commented Nov 2, 2023 • edited

danilobuerger commented Nov 24, 2023

samber commented Nov 28, 2023

samber commented May 7, 2024 • edited

GreyXor commented May 10, 2024 • edited

samber commented Oct 23, 2023 •

edited

samber commented Oct 23, 2023 •

edited

codecov-commenter commented Oct 23, 2023 •

edited

GreyXor commented Oct 25, 2023 •

edited

GreyXor commented Nov 1, 2023 •

edited

GreyXor commented Nov 2, 2023 •

edited

GreyXor commented Nov 2, 2023 •

edited

samber commented May 7, 2024 •

edited

GreyXor commented May 10, 2024 •

edited